@gmb/bitmark-parser-generator 5.27.0 → 5.28.0

package/dist/index.d.cts

@@ -850,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";
@@ -1760,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;
@@ -2381,6 +2385,8 @@ interface Bit {
     publications?: Property;
     relatedBook?: Property;
     translationOfBook?: Property;
+    userFeedbackTranslationUrl?: Property;
+    userFeedbackContentUrl?: Property;
     author?: Property;
     subject?: Property;
     date?: Property;
@@ -3186,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";
@@ -4353,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;
@@ -5595,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
@@ -6124,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;
@@ -6489,6 +6505,12 @@ declare class HtmlTableParser {
     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;
 }
@@ -6754,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
      */
@@ -7342,6 +7369,9 @@ declare class HtmlTableGenerator {
     private listTag;
     private listItemToHtml;
     private imageToHtml;
+    private textToHtml;
+    private inlineImageTokenToHtml;
+    private latexToHtml;
     private escapeText;
     private escapeAttr;
 }

package/dist/index.d.ts

@@ -850,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";
@@ -1760,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;
@@ -2381,6 +2385,8 @@ interface Bit {
     publications?: Property;
     relatedBook?: Property;
     translationOfBook?: Property;
+    userFeedbackTranslationUrl?: Property;
+    userFeedbackContentUrl?: Property;
     author?: Property;
     subject?: Property;
     date?: Property;
@@ -3186,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";
@@ -4353,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;
@@ -5595,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
@@ -6124,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;
@@ -6489,6 +6505,12 @@ declare class HtmlTableParser {
     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;
 }
@@ -6754,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
      */
@@ -7342,6 +7369,9 @@ declare class HtmlTableGenerator {
     private listTag;
     private listItemToHtml;
     private imageToHtml;
+    private textToHtml;
+    private inlineImageTokenToHtml;
+    private latexToHtml;
     private escapeText;
     private escapeAttr;
 }

package/dist/index.js

@@ -1365,6 +1365,8 @@ var propertyKeys = {
   property_externalLinkText: "@externalLinkText",
   property_feedbackEngine: "@feedbackEngine",
   property_feedbackType: "@feedbackType",
+  property_userFeedbackTranslationUrl: "@userFeedbackTranslationUrl",
+  property_userFeedbackContentUrl: "@userFeedbackContentUrl",
   property_flashcardSet: "@flashcardSet",
   property_focusX: "@focusX",
   property_focusY: "@focusY",
@@ -3829,16 +3831,25 @@ var CARDSETS = {
               },
               {
                 key: ConfigKey.property_tableRowSpan,
+                // HTML-C2: contribute a `rowspan` attribute onto the enclosing
+                // cell element (`<th>`/`<td>`).
+                htmlKey: { "@el": { "@attr": { rowspan: "$" } } },
                 description: "Number of rows the cell spans.",
                 format: TagFormat.number
               },
               {
                 key: ConfigKey.property_tableColSpan,
+                // HTML-C2: contribute a `colspan` attribute onto the enclosing
+                // cell element (`<th>`/`<td>`).
+                htmlKey: { "@el": { "@attr": { colspan: "$" } } },
                 description: "Number of columns the cell spans.",
                 format: TagFormat.number
               },
               {
                 key: ConfigKey.property_tableScope,
+                // HTML-C2: contribute a `scope` attribute onto the enclosing
+                // cell element (`<th>`/`<td>`).
+                htmlKey: { "@el": { "@attr": { scope: "$" } } },
                 description: "Scope attribute for header cells.",
                 format: TagFormat.plainText
               },
@@ -3956,6 +3967,9 @@ var CARDSETS = {
                 key: ConfigKey.property_tableRowSpan,
                 jsonKey: "rowspan",
                 exportJsonKey: { rowspan: "$" },
+                // HTML-C2: contribute a `rowspan` attribute onto the enclosing
+                // cell element (`<th>`/`<td>`).
+                htmlKey: { "@el": { "@attr": { rowspan: "$" } } },
                 description: "Number of rows the cell spans.",
                 format: TagFormat.number
               },
@@ -3963,6 +3977,9 @@ var CARDSETS = {
                 key: ConfigKey.property_tableColSpan,
                 jsonKey: "colspan",
                 exportJsonKey: { colspan: "$" },
+                // HTML-C2: contribute a `colspan` attribute onto the enclosing
+                // cell element (`<th>`/`<td>`).
+                htmlKey: { "@el": { "@attr": { colspan: "$" } } },
                 description: "Number of columns the cell spans.",
                 format: TagFormat.number
               },
@@ -3970,6 +3987,9 @@ var CARDSETS = {
                 key: ConfigKey.property_tableScope,
                 jsonKey: "scope",
                 exportJsonKey: { scope: "$" },
+                // HTML-C2: contribute a `scope` attribute onto the enclosing
+                // cell element (`<th>`/`<td>`).
+                htmlKey: { "@el": { "@attr": { scope: "$" } } },
                 description: "Scope attribute for header cells.",
                 format: TagFormat.plainText
               },
@@ -5780,6 +5800,16 @@ var GROUPS = {
         description: "External Id of the translated book",
         format: TagFormat.plainText
       },
+      {
+        key: ConfigKey.property_userFeedbackTranslationUrl,
+        description: "URL to an external feedback form for book translation feedback",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_userFeedbackContentUrl,
+        description: "URL to an external feedback form for book content feedback",
+        format: TagFormat.plainText
+      },
       {
         key: ConfigKey.property_duration,
         description: "The duration of the book",
@@ -10882,7 +10912,9 @@ var BITS = {
       {
         key: ConfigKey.property_caption,
         description: "Caption for the table image, used to provide a description for the image",
-        format: TagFormat.bitmarkText
+        format: TagFormat.bitmarkText,
+        // HTML-10 / HTML-C2: render as the table's `<caption>` (see table bit).
+        htmlKey: { "@el": "caption", "@children": "$" }
       },
       {
         key: ConfigKey.group_backgroundWallpaper,
@@ -12573,7 +12605,12 @@ var BITS = {
       {
         key: ConfigKey.property_caption,
         description: "Caption for the table, used to define the title of the table",
-        format: TagFormat.bitmarkText
+        format: TagFormat.bitmarkText,
+        // HTML-10 / HTML-C2: a bit-level caption renders as the table's
+        // `<caption>` — placed inside the idiomatic `<table>` container as
+        // its first child. Outside a table context it falls back to the
+        // residual carrier.
+        htmlKey: { "@el": "caption", "@children": "$" }
       },
       {
         key: ConfigKey.property_tableFixedHeader,
@@ -12658,7 +12695,9 @@ var BITS = {
       {
         key: ConfigKey.property_caption,
         description: "Caption for the table image, used to provide a description for the image",
-        format: TagFormat.bitmarkText
+        format: TagFormat.bitmarkText,
+        // HTML-10 / HTML-C2: render as the table's `<caption>` (see table bit).
+        htmlKey: { "@el": "caption", "@children": "$" }
       },
       {
         key: ConfigKey.group_backgroundWallpaper,
@@ -13848,7 +13887,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "5.27.0",
+  "version": "5.28.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -14738,6 +14777,10 @@ var NodeType = {
   relatedBookValue: "relatedBookValue",
   translationOfBook: "translationOfBook",
   translationOfBookValue: "translationOfBookValue",
+  userFeedbackTranslationUrl: "userFeedbackTranslationUrl",
+  userFeedbackTranslationUrlValue: "userFeedbackTranslationUrlValue",
+  userFeedbackContentUrl: "userFeedbackContentUrl",
+  userFeedbackContentUrlValue: "userFeedbackContentUrlValue",
   releaseDate: "releaseDate",
   releaseDateValue: "releaseDateValue",
   releaseKind: "releaseKind",
@@ -27947,6 +27990,18 @@ var Builder = class extends BaseBuilder {
         data.translationOfBook,
         options
       ),
+      userFeedbackTranslationUrl: this.toAstProperty(
+        bitType,
+        ConfigKey.property_userFeedbackTranslationUrl,
+        data.userFeedbackTranslationUrl,
+        options
+      ),
+      userFeedbackContentUrl: this.toAstProperty(
+        bitType,
+        ConfigKey.property_userFeedbackContentUrl,
+        data.userFeedbackContentUrl,
+        options
+      ),
       author: this.toAstProperty(bitType, ConfigKey.property_author, data.author, options),
       subject: this.toAstProperty(bitType, ConfigKey.property_subject, data.subject, options),
       date: this.toAstProperty(bitType, ConfigKey.property_date, data.date, options),
@@ -31738,7 +31793,8 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
       this.writeNL();
     }
     const content = cell.content ?? instance3.EMPTY_STRING;
-    this.writeTextOrValue(content, this.textFormat, TextLocation.body);
+    const options = this.options.noBreakscaping ? { noBreakscaping: true } : void 0;
+    this.writeTextOrValue(content, this.textFormat, TextLocation.body, options);
   }
   writeTableCellProperty(name, value) {
     this.writeOPA();
@@ -33217,6 +33273,8 @@ var MARK_TO_TAG = {
   highlight: "mark",
   code: "code"
 };
+var INLINE_IMAGE_RE = /==([^=]*(?:=(?!=)[^=]*)*)==\|imageInline:([^|\s]+)((?:\|(?:@?[A-Za-z][A-Za-z0-9_-]*:[^|\s]+|#[^|\s]*))*)\|?/g;
+var MAX_IMAGE_DIMENSION = 9999;
 var HtmlTableGenerator = class {
   constructor() {
     __publicField(this, "indentUnit", "  ");
@@ -33335,6 +33393,8 @@ var HtmlTableGenerator = class {
       case "image":
       case "imageInline":
         return this.imageToHtml(node);
+      case "latex":
+        return this.latexToHtml(node);
       default:
         return this.inlineToHtml([node]);
     }
@@ -33345,8 +33405,9 @@ var HtmlTableGenerator = class {
   inlineNodeToHtml(node) {
     if (node.type === "hardBreak") return "<br>";
     if (node.type === "image" || node.type === "imageInline") return this.imageToHtml(node);
+    if (node.type === "latex") return this.latexToHtml(node);
     if (node.type === "text") {
-      return this.wrapMarks(this.escapeText(node.text ?? ""), node.marks);
+      return this.wrapMarks(this.textToHtml(node.text ?? ""), node.marks);
     }
     if (node.content) return this.inlineToHtml(node.content);
     return this.escapeText(node.text ?? "");
@@ -33424,6 +33485,44 @@ var HtmlTableGenerator = class {
     }
     return `<img ${parts.join(" ")}>`;
   }
+  textToHtml(text) {
+    let html = "";
+    let lastIndex = 0;
+    for (const match of text.matchAll(INLINE_IMAGE_RE)) {
+      const index = match.index ?? 0;
+      html += this.escapeText(text.slice(lastIndex, index));
+      html += this.inlineImageTokenToHtml(match);
+      lastIndex = index + match[0].length;
+    }
+    html += this.escapeText(text.slice(lastIndex));
+    return html;
+  }
+  inlineImageTokenToHtml(match) {
+    const attrs = {
+      alt: match[1],
+      src: match[2]
+    };
+    const rawAttrs = match[3] ?? "";
+    for (const attr of rawAttrs.split("|")) {
+      if (!attr || attr.startsWith("#")) continue;
+      const colon = attr.indexOf(":");
+      if (colon < 1) continue;
+      const key = attr.slice(0, colon).replace(/^@/, "");
+      const value = attr.slice(colon + 1);
+      if (key === "width" || key === "height") {
+        const n = Number.parseInt(value, 10);
+        if (!Number.isNaN(n) && n > 0 && n <= MAX_IMAGE_DIMENSION) attrs[key] = n;
+      } else if (key === "class" || key === "title") {
+        attrs[key] = value;
+      }
+    }
+    return this.imageToHtml({ type: "imageInline", attrs });
+  }
+  // --- formulas -------------------------------------------------------------
+  latexToHtml(node) {
+    const formula = node.attrs?.formula ?? "";
+    return `<math alttext="${this.escapeAttr(formula)}"></math>`;
+  }
   // --- escaping -------------------------------------------------------------
   escapeText(text) {
     return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
@@ -33735,6 +33834,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
         this.addProperty(this.bitJson, k, values, { array: true });
       }
     }
+    return false;
   }
   // bitmarkAst -> bits -> bitsValue -> cardNode -> cardBits -> cardBitsValue
   enter_cardBitsValue(node, route) {
@@ -42805,7 +42905,7 @@ var IMPLIED_CLOSE = {
   p: /* @__PURE__ */ new Set(["p"]),
   option: /* @__PURE__ */ new Set(["option"])
 };
-var TAG_RE = /<(\/)?([a-zA-Z][a-zA-Z0-9-]*)((?:\s+(?:"[^"]*"|'[^']*'|[^<>"'])*)?)(\/)?>/g;
+var TAG_RE = /<(\/)?([a-zA-Z][a-zA-Z0-9:-]*)((?:\s+(?:"[^"]*"|'[^']*'|[^<>"'])*)?)(\/)?>/g;
 var ATTR_RE = /([a-zA-Z_:][a-zA-Z0-9:._-]*)(?:\s*=\s*("[^"]*"|'[^']*'|[^\s"'>]+))?/g;
 function parseAttrs(raw) {
   const attrs = {};
@@ -43136,6 +43236,9 @@ var HtmlTableParser = class {
     if (name === "img") {
       return [this.imageNode(el, true)];
     }
+    if (this.isMathTag(name)) {
+      return [this.latexNode(el)];
+    }
     const markType = MARK_TAGS[name];
     if (markType) {
       return this.inlineNodes(el.children, [...marks, { type: markType }]);
@@ -43252,6 +43355,43 @@ var HtmlTableParser = class {
     if (el.attrs.class) attrs.class = el.attrs.class;
     return { type: inline ? "imageInline" : "image", attrs };
   }
+  // --- formulas -------------------------------------------------------------
+  isMathTag(name) {
+    return this.localName(name) === "math";
+  }
+  latexNode(el) {
+    return {
+      type: "latex",
+      attrs: {
+        formula: this.latexFromMath(el)
+      }
+    };
+  }
+  latexFromMath(el) {
+    const alt = el.attrs.alttext ?? el.attrs.alt ?? el.attrs.title;
+    if (alt != null) return decodeEntities(alt);
+    const annotation = this.findLatexAnnotation(el);
+    if (annotation) return this.textContent(annotation).trim();
+    return this.textContent(el).trim();
+  }
+  findLatexAnnotation(el) {
+    for (const child of el.children) {
+      if (!isElement(child)) continue;
+      const lowerEncoding = (child.attrs.encoding ?? "").toLowerCase();
+      if (this.localName(child.name) === "annotation" && (/\btex\b/.test(lowerEncoding) || /\blatex\b/.test(lowerEncoding))) {
+        return child;
+      }
+      const nested = this.findLatexAnnotation(child);
+      if (nested) return nested;
+    }
+    return void 0;
+  }
+  textContent(el) {
+    return el.children.map((child) => isElement(child) ? this.textContent(child) : decodeEntities(child.value)).join("").replace(/\s+/g, " ");
+  }
+  localName(name) {
+    return name.includes(":") ? name.slice(name.indexOf(":") + 1) : name;
+  }
   // --- whitespace -----------------------------------------------------------
   /** Trim leading/trailing whitespace from inline content (edges only). */
   trimInline(nodes) {
@@ -45202,7 +45342,10 @@ var BitmarkParserGenerator = class {
         outputFile: opts.outputFile,
         fileOptions: opts.fileOptions,
         jsonOptions: opts.jsonOptions,
-        bitmarkOptions: opts.bitmarkOptions
+        bitmarkOptions: {
+          ...opts.bitmarkOptions,
+          ...opts.noBreakscaping ? { noBreakscaping: true } : {}
+        }
       });
     }
     const outputFormat = opts.outputFormat ?? "html";