angular-html-parser/dist/compiler/src/i18n/i18n_ast.d.mts

A HTML parser extracted from Angular with some modifications

import { ParseSourceSpan } from "../parse_util.mjs";

//#region ../compiler/src/i18n/i18n_ast.d.ts
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.dev/license
*/
/**
 * Describes the text contents of a placeholder as it appears in an ICU expression, including its
 * source span information.
 */
interface MessagePlaceholder {
  /** The text contents of the placeholder */
  text: string;
  /** The source span of the placeholder */
  sourceSpan: ParseSourceSpan;
}
declare class Message {
  nodes: Node[];
  placeholders: {
    [phName: string]: MessagePlaceholder;
  };
  placeholderToMessage: {
    [phName: string]: Message;
  };
  meaning: string;
  description: string;
  customId: string;
  sources: MessageSpan[];
  id: string;
  /** The ids to use if there are no custom id and if `i18nLegacyMessageIdFormat` is not empty */
  legacyIds: string[];
  messageString: string;
  /**
       * @param nodes message AST
       * @param placeholders maps placeholder names to static content and their source spans
       * @param placeholderToMessage maps placeholder names to messages (used for nested ICU messages)
       * @param meaning
       * @param description
       * @param customId
       */
  constructor(nodes: Node[], placeholders: {
    [phName: string]: MessagePlaceholder;
  }, placeholderToMessage: {
    [phName: string]: Message;
  }, meaning: string, description: string, customId: string);
}
interface MessageSpan {
  filePath: string;
  startLine: number;
  startCol: number;
  endLine: number;
  endCol: number;
}
interface Node {
  sourceSpan: ParseSourceSpan;
  visit(visitor: Visitor, context?: any): any;
}
declare class Text implements Node {
  value: string;
  sourceSpan: ParseSourceSpan;
  constructor(value: string, sourceSpan: ParseSourceSpan);
  visit(visitor: Visitor, context?: any): any;
}
declare class Container implements Node {
  children: Node[];
  sourceSpan: ParseSourceSpan;
  constructor(children: Node[], sourceSpan: ParseSourceSpan);
  visit(visitor: Visitor, context?: any): any;
}
declare class Icu implements Node {
  expression: string;
  type: string;
  cases: {
    [k: string]: Node;
  };
  sourceSpan: ParseSourceSpan;
  expressionPlaceholder?: string;
  constructor(expression: string, type: string, cases: {
    [k: string]: Node;
  }, sourceSpan: ParseSourceSpan, expressionPlaceholder?: string);
  visit(visitor: Visitor, context?: any): any;
}
declare class TagPlaceholder implements Node {
  tag: string;
  attrs: {
    [k: string]: string;
  };
  startName: string;
  closeName: string;
  children: Node[];
  isVoid: boolean;
  sourceSpan: ParseSourceSpan;
  startSourceSpan: ParseSourceSpan | null;
  endSourceSpan: ParseSourceSpan | null;
  constructor(tag: string, attrs: {
    [k: string]: string;
  }, startName: string, closeName: string, children: Node[], isVoid: boolean, sourceSpan: ParseSourceSpan, startSourceSpan: ParseSourceSpan | null, endSourceSpan: ParseSourceSpan | null);
  visit(visitor: Visitor, context?: any): any;
}
declare class Placeholder implements Node {
  value: string;
  name: string;
  sourceSpan: ParseSourceSpan;
  constructor(value: string, name: string, sourceSpan: ParseSourceSpan);
  visit(visitor: Visitor, context?: any): any;
}
declare class IcuPlaceholder implements Node {
  value: Icu;
  name: string;
  sourceSpan: ParseSourceSpan;
  /** Used to capture a message computed from a previous processing pass (see `setI18nRefs()`). */
  previousMessage?: Message;
  constructor(value: Icu, name: string, sourceSpan: ParseSourceSpan);
  visit(visitor: Visitor, context?: any): any;
}
declare class BlockPlaceholder implements Node {
  name: string;
  parameters: string[];
  startName: string;
  closeName: string;
  children: Node[];
  sourceSpan: ParseSourceSpan;
  startSourceSpan: ParseSourceSpan | null;
  endSourceSpan: ParseSourceSpan | null;
  constructor(name: string, parameters: string[], startName: string, closeName: string, children: Node[], sourceSpan: ParseSourceSpan, startSourceSpan: ParseSourceSpan | null, endSourceSpan: ParseSourceSpan | null);
  visit(visitor: Visitor, context?: any): any;
}
/**
 * Each HTML node that is affect by an i18n tag will also have an `i18n` property that is of type
 * `I18nMeta`.
 * This information is either a `Message`, which indicates it is the root of an i18n message, or a
 * `Node`, which indicates is it part of a containing `Message`.
 */
type I18nMeta = Message | Node;
interface Visitor {
  visitText(text: Text, context?: any): any;
  visitContainer(container: Container, context?: any): any;
  visitIcu(icu: Icu, context?: any): any;
  visitTagPlaceholder(ph: TagPlaceholder, context?: any): any;
  visitPlaceholder(ph: Placeholder, context?: any): any;
  visitIcuPlaceholder(ph: IcuPlaceholder, context?: any): any;
  visitBlockPlaceholder(ph: BlockPlaceholder, context?: any): any;
}
//#endregion
export { I18nMeta };