@gmb/bitmark-parser-generator 5.26.0 → 5.28.0

package/dist/index.d.ts

@@ -536,6 +536,14 @@ declare const BitType: {
     readonly smartStandardRemarkNonNormativeCollapsible: "smart-standard-remark-non-normative-collapsible";
     readonly smartStandardRemarkNormative: "smart-standard-remark-normative";
     readonly smartStandardRemarkNormativeCollapsible: "smart-standard-remark-normative-collapsible";
+    readonly smartStandardRemarkTableExtendedImageNonNormative: "smart-standard-remark-table-extended-image-non-normative";
+    readonly smartStandardRemarkTableExtendedImageNonNormativeCollapsible: "smart-standard-remark-table-extended-image-non-normative-collapsible";
+    readonly smartStandardRemarkTableExtendedImageNormative: "smart-standard-remark-table-extended-image-normative";
+    readonly smartStandardRemarkTableExtendedImageNormativeCollapsible: "smart-standard-remark-table-extended-image-normative-collapsible";
+    readonly smartStandardRemarkTableExtendedNonNormative: "smart-standard-remark-table-extended-non-normative";
+    readonly smartStandardRemarkTableExtendedNonNormativeCollapsible: "smart-standard-remark-table-extended-non-normative-collapsible";
+    readonly smartStandardRemarkTableExtendedNormative: "smart-standard-remark-table-extended-normative";
+    readonly smartStandardRemarkTableExtendedNormativeCollapsible: "smart-standard-remark-table-extended-normative-collapsible";
     readonly smartStandardRemarkTableImageNonNormative: "smart-standard-remark-table-image-non-normative";
     readonly smartStandardRemarkTableImageNonNormativeCollapsible: "smart-standard-remark-table-image-non-normative-collapsible";
     readonly smartStandardRemarkTableImageNormative: "smart-standard-remark-table-image-normative";
@@ -544,6 +552,14 @@ declare const BitType: {
     readonly smartStandardRemarkTableNonNormativeCollapsible: "smart-standard-remark-table-non-normative-collapsible";
     readonly smartStandardRemarkTableNormative: "smart-standard-remark-table-normative";
     readonly smartStandardRemarkTableNormativeCollapsible: "smart-standard-remark-table-normative-collapsible";
+    readonly smartStandardTableExtendedImageNonNormative: "smart-standard-table-extended-image-non-normative";
+    readonly smartStandardTableExtendedImageNonNormativeCollapsible: "smart-standard-table-extended-image-non-normative-collapsible";
+    readonly smartStandardTableExtendedImageNormative: "smart-standard-table-extended-image-normative";
+    readonly smartStandardTableExtendedImageNormativeCollapsible: "smart-standard-table-extended-image-normative-collapsible";
+    readonly smartStandardTableExtendedNonNormative: "smart-standard-table-extended-non-normative";
+    readonly smartStandardTableExtendedNonNormativeCollapsible: "smart-standard-table-extended-non-normative-collapsible";
+    readonly smartStandardTableExtendedNormative: "smart-standard-table-extended-normative";
+    readonly smartStandardTableExtendedNormativeCollapsible: "smart-standard-table-extended-normative-collapsible";
     readonly smartStandardTableImageNonNormative: "smart-standard-table-image-non-normative";
     readonly smartStandardTableImageNonNormativeCollapsible: "smart-standard-table-image-non-normative-collapsible";
     readonly smartStandardTableImageNormative: "smart-standard-table-image-normative";
@@ -566,10 +582,18 @@ declare const BitType: {
     readonly standardNoteNormative: "standard-note-normative";
     readonly standardRemarkNonNormative: "standard-remark-non-normative";
     readonly standardRemarkNormative: "standard-remark-normative";
+    readonly standardRemarkTableExtendedImageNonNormative: "standard-remark-table-extended-image-non-normative";
+    readonly standardRemarkTableExtendedImageNormative: "standard-remark-table-extended-image-normative";
+    readonly standardRemarkTableExtendedNonNormative: "standard-remark-table-extended-non-normative";
+    readonly standardRemarkTableExtendedNormative: "standard-remark-table-extended-normative";
     readonly standardRemarkTableImageNonNormative: "standard-remark-table-image-non-normative";
     readonly standardRemarkTableImageNormative: "standard-remark-table-image-normative";
     readonly standardRemarkTableNonNormative: "standard-remark-table-non-normative";
     readonly standardRemarkTableNormative: "standard-remark-table-normative";
+    readonly standardTableExtendedImageNonNormative: "standard-table-extended-image-non-normative";
+    readonly standardTableExtendedImageNormative: "standard-table-extended-image-normative";
+    readonly standardTableExtendedNonNormative: "standard-table-extended-non-normative";
+    readonly standardTableExtendedNormative: "standard-table-extended-normative";
     readonly standardTableImageNonNormative: "standard-table-image-non-normative";
     readonly standardTableImageNormative: "standard-table-image-normative";
     readonly standardTableNonNormative: "standard-table-non-normative";
@@ -826,6 +850,8 @@ declare const ConfigKey: {
     readonly property_externalLinkText: "@externalLinkText";
     readonly property_feedbackEngine: "@feedbackEngine";
     readonly property_feedbackType: "@feedbackType";
+    readonly property_userFeedbackTranslationUrl: "@userFeedbackTranslationUrl";
+    readonly property_userFeedbackContentUrl: "@userFeedbackContentUrl";
     readonly property_flashcardSet: "@flashcardSet";
     readonly property_focusX: "@focusX";
     readonly property_focusY: "@focusY";
@@ -1736,6 +1762,8 @@ interface BitJson {
     publisherName: string;
     publications: string | string[];
     relatedBook: string | string[];
+    userFeedbackTranslationUrl: string;
+    userFeedbackContentUrl: string;
     author: string | string[];
     subject: string | string[];
     date: string;
@@ -2357,6 +2385,8 @@ interface Bit {
     publications?: Property;
     relatedBook?: Property;
     translationOfBook?: Property;
+    userFeedbackTranslationUrl?: Property;
+    userFeedbackContentUrl?: Property;
     author?: Property;
     subject?: Property;
     date?: Property;
@@ -3162,6 +3192,10 @@ declare const NodeType: {
     readonly relatedBookValue: "relatedBookValue";
     readonly translationOfBook: "translationOfBook";
     readonly translationOfBookValue: "translationOfBookValue";
+    readonly userFeedbackTranslationUrl: "userFeedbackTranslationUrl";
+    readonly userFeedbackTranslationUrlValue: "userFeedbackTranslationUrlValue";
+    readonly userFeedbackContentUrl: "userFeedbackContentUrl";
+    readonly userFeedbackContentUrlValue: "userFeedbackContentUrlValue";
     readonly releaseDate: "releaseDate";
     readonly releaseDateValue: "releaseDateValue";
     readonly releaseKind: "releaseKind";
@@ -3878,6 +3912,20 @@ type CardSetConfigKeyType = EnumType<typeof CardSetConfigKey>;
 type ExportJsonKey = null | boolean | number | string | ExportJsonKey[] | {
     [k: string]: ExportJsonKey;
 };
+/**
+ * Key-pattern value for the HTML backend of the key-pattern language.
+ * See crates/lib/jsonkey_parser/doc/HTML.md (design: PLAN-109).
+ *
+ * Structurally identical to {@link ExportJsonKey} (a recursive JSON value) — the
+ * pattern grammar, sigils, and predicates are shared; only the leaf node model
+ * (and HTML-specific reserved keys such as `@el` / `@attr` / `@children` /
+ * `@text`) differ, and those are validated by the new parser's compiler, not
+ * here. Stored verbatim in the raw configs and emitted under the field name
+ * `htmlKey` when writing assets/config/**\/*.jsonc. Omit when absent.
+ */
+type HtmlKey = null | boolean | number | string | HtmlKey[] | {
+    [k: string]: HtmlKey;
+};
 
 declare abstract class AbstractTagConfig {
     readonly type: BitTagConfigKeyTypeType;
@@ -3889,6 +3937,8 @@ declare abstract class AbstractTagConfig {
     readonly jsonKey?: string;
     readonly exportJsonKey?: ExportJsonKey;
     readonly hasExportJsonKey: boolean;
+    readonly htmlKey?: HtmlKey;
+    readonly hasHtmlKey: boolean;
     readonly deprecated?: string;
     constructor(params: {
         type: BitTagConfigKeyTypeType;
@@ -3900,6 +3950,8 @@ declare abstract class AbstractTagConfig {
         jsonKey: string | undefined;
         exportJsonKey: ExportJsonKey | undefined;
         hasExportJsonKey: boolean;
+        htmlKey: HtmlKey | undefined;
+        hasHtmlKey: boolean;
         deprecated: string | undefined;
     });
 }
@@ -3919,6 +3971,8 @@ declare class MarkupTagConfig extends AbstractTagConfig {
         jsonKey: string | undefined;
         exportJsonKey: ExportJsonKey | undefined;
         hasExportJsonKey: boolean;
+        htmlKey: HtmlKey | undefined;
+        hasHtmlKey: boolean;
         deprecated: string | undefined;
     });
     toString(options?: ToStringOptions$6): string;
@@ -3943,6 +3997,8 @@ declare class PropertyTagConfig extends AbstractTagConfig {
         jsonKey: string | undefined;
         exportJsonKey: ExportJsonKey | undefined;
         hasExportJsonKey: boolean;
+        htmlKey: HtmlKey | undefined;
+        hasHtmlKey: boolean;
         format: TagFormatType | undefined;
         values: string[] | undefined;
         defaultValue: string | undefined;
@@ -3966,6 +4022,8 @@ declare class ResourceTagConfig extends AbstractTagConfig {
         jsonKey: string | undefined;
         exportJsonKey: ExportJsonKey | undefined;
         hasExportJsonKey: boolean;
+        htmlKey: HtmlKey | undefined;
+        hasHtmlKey: boolean;
         deprecated: string | undefined;
     });
     toString(options?: ToStringOptions$4): string;
@@ -3989,8 +4047,10 @@ declare class CardVariantConfig {
     readonly jsonKey?: string | null;
     readonly exportJsonKey?: ExportJsonKey;
     readonly hasExportJsonKey: boolean;
+    readonly htmlKey?: HtmlKey;
+    readonly hasHtmlKey: boolean;
     readonly format?: TextFormatType;
-    constructor(tags: TagsConfig, bodyAllowed?: boolean, bodyRequired?: boolean, repeatCount?: CountType, jsonKey?: string | null, exportJsonKey?: ExportJsonKey, hasExportJsonKey?: boolean, format?: TextFormatType);
+    constructor(tags: TagsConfig, bodyAllowed?: boolean, bodyRequired?: boolean, repeatCount?: CountType, jsonKey?: string | null, exportJsonKey?: ExportJsonKey, hasExportJsonKey?: boolean, format?: TextFormatType, htmlKey?: HtmlKey, hasHtmlKey?: boolean);
     toString(options?: ToStringOptions$3): string;
 }
 
@@ -4004,8 +4064,10 @@ declare class CardSideConfig {
     readonly jsonKey: string | null | undefined;
     readonly exportJsonKey?: ExportJsonKey;
     readonly hasExportJsonKey: boolean;
+    readonly htmlKey?: HtmlKey;
+    readonly hasHtmlKey: boolean;
     readonly variants: CardVariantConfig[];
-    constructor(name: string, repeat: boolean, variants: CardVariantConfig[], jsonKey?: string | null, exportJsonKey?: ExportJsonKey, hasExportJsonKey?: boolean);
+    constructor(name: string, repeat: boolean, variants: CardVariantConfig[], jsonKey?: string | null, exportJsonKey?: ExportJsonKey, hasExportJsonKey?: boolean, htmlKey?: HtmlKey, hasHtmlKey?: boolean);
     toString(options?: ToStringOptions$2): string;
 }
 
@@ -4017,10 +4079,14 @@ interface CardSetSection {
     jsonKey: string;
     exportJsonKey?: ExportJsonKey;
     hasExportJsonKey?: boolean;
+    htmlKey?: HtmlKey;
+    hasHtmlKey?: boolean;
     isDefault?: boolean;
     sideJsonKey?: string;
     sideExportJsonKey?: ExportJsonKey;
     hasSideExportJsonKey?: boolean;
+    sideHtmlKey?: HtmlKey;
+    hasSideHtmlKey?: boolean;
     minCount?: number;
     maxCount?: number;
 }
@@ -4029,10 +4095,12 @@ declare class CardSetConfig {
     readonly jsonKey: string | null;
     readonly exportJsonKey?: ExportJsonKey;
     readonly hasExportJsonKey: boolean;
+    readonly htmlKey?: HtmlKey;
+    readonly hasHtmlKey: boolean;
     readonly sections: Record<string, CardSetSection> | undefined;
     readonly sides: CardSideConfig[];
     get variants(): CardVariantConfig[][];
-    constructor(configKey: CardSetConfigKeyType, jsonKey: string | null, exportJsonKey: ExportJsonKey | undefined, hasExportJsonKey: boolean, sections: Record<string, CardSetSection> | undefined, sides: CardSideConfig[]);
+    constructor(configKey: CardSetConfigKeyType, jsonKey: string | null, exportJsonKey: ExportJsonKey | undefined, hasExportJsonKey: boolean, sections: Record<string, CardSetSection> | undefined, sides: CardSideConfig[], htmlKey?: HtmlKey | undefined, hasHtmlKey?: boolean);
     toString(options?: ToStringOptions$1): string;
 }
 
@@ -4295,6 +4363,8 @@ declare class Builder extends BaseBuilder {
         publications?: string | string[];
         relatedBook?: string | string[];
         translationOfBook?: string;
+        userFeedbackTranslationUrl?: string;
+        userFeedbackContentUrl?: string;
         author?: string | string[];
         subject?: string | string[];
         date?: string;
@@ -5537,6 +5607,10 @@ interface BitmarkOptions {
      * Generate debug information in the output.
      */
     debugGenerationInline?: boolean;
+    /**
+     * Generate table cell content without breakscaping text.
+     */
+    noBreakscaping?: boolean;
 }
 /**
  * Bitmark generator options
@@ -6066,7 +6140,7 @@ declare class JsonGenerator extends AstWalkerGenerator<BitmarkAst, void> {
     protected enter_caption(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_width(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_height(node: NodeInfo, route: NodeInfo[]): boolean;
-    protected enter_extraProperties(node: NodeInfo, _route: NodeInfo[]): void;
+    protected enter_extraProperties(node: NodeInfo, _route: NodeInfo[]): boolean;
     protected enter_cardBitsValue(node: NodeInfo, route: NodeInfo[]): void;
     protected exit_cardBitsValue(_node: NodeInfo, _route: NodeInfo[]): void;
     protected enter_body(node: NodeInfo, route: NodeInfo[]): boolean;
@@ -6376,6 +6450,71 @@ declare class BitmarkParser {
     toAst(bitmark: string, _options?: BitmarkParserOptions): BitmarkAst;
 }
 
+/**
+ * Extract HTML tables and convert them into bitmark table bit-JSON.
+ *
+ * Produces an array of bare `BitJson`-shaped objects (`type` = `table-extended` or `table`) that
+ * can be fed directly into the existing JSON → AST → output pipeline. Cell content is built as
+ * `TextAst` (rich text nodes) directly; the downstream generators handle serialisation and
+ * breakscaping.
+ *
+ * See PLAN-013 for the full specification.
+ */
+
+type HtmlTableFormat = 'table' | 'table-extended';
+interface HtmlTableParseOptions {
+    /** Output bit type. Default `table-extended` (lossless). `table` is lossy. */
+    tableFormat?: HtmlTableFormat;
+    /** Keep unmappable tags as literal text instead of unwrapping them. Default false. */
+    keepUnknownTags?: boolean;
+    /** Called with a human-readable message when information is lost (e.g. lossy `table` output). */
+    onWarning?: (message: string) => void;
+}
+/** Loosely-typed table bit JSON (matches a subset of BitJson). */
+interface TableBitJson {
+    type: HtmlTableFormat;
+    format: 'bitmark++';
+    caption?: TextAst;
+    table: TableJson | TableExtendedJson;
+}
+declare class HtmlTableParser {
+    private keepUnknownTags;
+    /**
+     * Parse an HTML string and return one table bit per top-level `<table>`.
+     */
+    parse(html: string, options?: HtmlTableParseOptions): TableBitJson[];
+    /** Collect every `<table>` element, NOT descending into nested tables. */
+    private collectTopLevelTables;
+    private tableToBit;
+    private rowToCells;
+    private cellToJson;
+    private widthFromCell;
+    private isLossyAsBasic;
+    /**
+     * Convert a cell/li's child nodes into block-level TextAst nodes (paragraphs, lists, images).
+     */
+    private blockNodes;
+    /** Convert child nodes to a flat list of inline TextNodes, applying the given marks. */
+    private inlineNodes;
+    private inlineFromElement;
+    private inlineText;
+    private serializeOpenTag;
+    private isListTag;
+    private listNode;
+    private listType;
+    private listItemNode;
+    private taskItemNode;
+    private imageNode;
+    private isMathTag;
+    private latexNode;
+    private latexFromMath;
+    private findLatexAnnotation;
+    private textContent;
+    private localName;
+    /** Trim leading/trailing whitespace from inline content (edges only). */
+    private trimInline;
+}
+
 /**
  * Writer to write to a stream.
  */
@@ -6437,65 +6576,6 @@ declare class FileWriter extends StreamWriter {
     close(): Promise<void>;
 }
 
-/**
- * Extract HTML tables and convert them into bitmark table bit-JSON.
- *
- * Produces an array of bare `BitJson`-shaped objects (`type` = `table-extended` or `table`) that
- * can be fed directly into the existing JSON → AST → output pipeline. Cell content is built as
- * `TextAst` (rich text nodes) directly; the downstream generators handle serialisation and
- * breakscaping.
- *
- * See PLAN-013 for the full specification.
- */
-
-type HtmlTableFormat = 'table' | 'table-extended';
-interface HtmlTableParseOptions {
-    /** Output bit type. Default `table-extended` (lossless). `table` is lossy. */
-    tableFormat?: HtmlTableFormat;
-    /** Keep unmappable tags as literal text instead of unwrapping them. Default false. */
-    keepUnknownTags?: boolean;
-    /** Called with a human-readable message when information is lost (e.g. lossy `table` output). */
-    onWarning?: (message: string) => void;
-}
-/** Loosely-typed table bit JSON (matches a subset of BitJson). */
-interface TableBitJson {
-    type: HtmlTableFormat;
-    format: 'bitmark++';
-    caption?: TextAst;
-    table: TableJson | TableExtendedJson;
-}
-declare class HtmlTableParser {
-    private keepUnknownTags;
-    /**
-     * Parse an HTML string and return one table bit per top-level `<table>`.
-     */
-    parse(html: string, options?: HtmlTableParseOptions): TableBitJson[];
-    /** Collect every `<table>` element, NOT descending into nested tables. */
-    private collectTopLevelTables;
-    private tableToBit;
-    private rowToCells;
-    private cellToJson;
-    private widthFromCell;
-    private isLossyAsBasic;
-    /**
-     * Convert a cell/li's child nodes into block-level TextAst nodes (paragraphs, lists, images).
-     */
-    private blockNodes;
-    /** Convert child nodes to a flat list of inline TextNodes, applying the given marks. */
-    private inlineNodes;
-    private inlineFromElement;
-    private inlineText;
-    private serializeOpenTag;
-    private isListTag;
-    private listNode;
-    private listType;
-    private listItemNode;
-    private taskItemNode;
-    private imageNode;
-    /** Trim leading/trailing whitespace from inline content (edges only). */
-    private trimInline;
-}
-
 /**
  * Info options for the parser
  */
@@ -6696,6 +6776,11 @@ interface ConvertHtmlTableOptions {
      * Keep unmappable HTML tags as literal text instead of unwrapping them (HTML -> bits only).
      */
     keepUnknownTags?: boolean;
+    /**
+     * Disable breakscaping when generating bitmark table cell content from HTML.
+     * Useful when cells already contain raw bitmark that should pass through untouched.
+     */
+    noBreakscaping?: boolean;
     /**
      * Specify a file to write the output to
      */
@@ -7284,6 +7369,9 @@ declare class HtmlTableGenerator {
     private listTag;
     private listItemToHtml;
     private imageToHtml;
+    private textToHtml;
+    private inlineImageTokenToHtml;
+    private latexToHtml;
     private escapeText;
     private escapeAttr;
 }