@gmb/bitmark-parser-generator 4.14.1 → 4.15.0

package/dist/index.cjs

@@ -181,6 +181,9 @@ var BitType = (0, import_superenum.superenum)({
   bugAlt: "bug-alt",
   bugCollapsible: "bug-collapsible",
   buttonCopyText: "button-copy-text",
+  catalogItemBook: "catalog-item-book",
+  catalogItemExternalBook: "catalog-item-external-book",
+  catalogItemProduct: "catalog-item-product",
   callToAction: "call-to-action",
   callToActionBookNow: "call-to-action-book-now",
   callToActionContact: "call-to-action-contact",
@@ -302,8 +305,8 @@ var BitType = (0, import_superenum.superenum)({
   extractorAiChat: "extractor-ai-chat",
   extractorBlock: "extractor-block",
   extractorConfiguration: "extractor-configuration",
-  extractorImage: "extractor-image",
-  extractorImageCollapsible: "extractor-image-collapsible",
+  extractorImages: "extractor-images",
+  extractorImagesCollapsible: "extractor-images-collapsible",
   extractorInformation: "extractor-information",
   extractorPage: "extractor-page",
   extractorPageCollapsible: "extractor-page-collapsible",
@@ -1208,6 +1211,9 @@ var propertyKeys = {
   property_colorTag: "@colorTag",
   property_computerLanguage: "@computerLanguage",
   property_content2Buy: "@content2Buy",
+  property_listPrice: "@listPrice",
+  property_customerProductId: "@customerProductId",
+  property_customerProductShopLink: "@customerProductShopLink",
   property_copyright: "@copyright",
   property_coverColor: "@coverColor",
   property_coverImage: "@coverImage",
@@ -1281,6 +1287,7 @@ var propertyKeys = {
   property_listItemIndent: "@listItemIndent",
   property_location: "@location",
   property_machineTranslated: "@machineTranslated",
+  property_spansPageBreak: "@spansPageBreak",
   property_mailingList: "@mailingList",
   property_mark: "@mark",
   property_maxCreatedBits: "@maxCreatedBits",
@@ -2750,6 +2757,11 @@ var GROUPS = {
         description: "If true, the bit is machine-translated",
         format: TagFormat.plainText
       },
+      {
+        key: ConfigKey.property_spansPageBreak,
+        description: "If true, the bit spans a page break",
+        format: TagFormat.boolean
+      },
       {
         key: ConfigKey.property_searchIndex,
         description: "The search index(es) for the bit",
@@ -4559,6 +4571,120 @@ var BITS = {
       }
     ]
   },
+  [BitType.catalogItemBook]: {
+    since: "4.15.0",
+    baseBitType: BitType._standard,
+    description: "Catalog item book bit, used to represent a book product in a catalog with cover and description",
+    tags: [
+      {
+        key: ConfigKey.tag_title,
+        description: "Title and subtitle of the catalog item",
+        maxCount: 2
+      },
+      {
+        key: ConfigKey.property_coverImage,
+        description: "Cover image of the catalog item",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_content2Buy,
+        description: "Content to buy identifier",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_listPrice,
+        description: "List price of the catalog item",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_buttonCaption,
+        description: "Caption for the buy button",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_customerProductId,
+        description: "Customer-specific product identifier",
+        format: TagFormat.plainText
+      }
+    ],
+    rootExampleType: ExampleType.string
+  },
+  [BitType.catalogItemExternalBook]: {
+    since: "4.15.0",
+    baseBitType: BitType._standard,
+    description: "Catalog item external book bit, used to represent an external book product in a catalog with link to external shop",
+    tags: [
+      {
+        key: ConfigKey.tag_title,
+        description: "Title and subtitle of the catalog item",
+        maxCount: 2
+      },
+      {
+        key: ConfigKey.property_coverImage,
+        description: "Cover image of the catalog item",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_customerProductShopLink,
+        description: "Link to external shop for the product",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_listPrice,
+        description: "List price of the catalog item",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_buttonCaption,
+        description: "Caption for the buy button",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_customerProductId,
+        description: "Customer-specific product identifier",
+        format: TagFormat.plainText
+      }
+    ],
+    rootExampleType: ExampleType.string
+  },
+  [BitType.catalogItemProduct]: {
+    since: "4.15.0",
+    baseBitType: BitType._standard,
+    description: "Catalog item product bit, used to represent a general product in a catalog with cover and description",
+    tags: [
+      {
+        key: ConfigKey.tag_title,
+        description: "Title and subtitle of the catalog item",
+        maxCount: 2
+      },
+      {
+        key: ConfigKey.property_coverImage,
+        description: "Cover image of the catalog item",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_content2Buy,
+        description: "Content to buy identifier",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_listPrice,
+        description: "List price of the catalog item",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_buttonCaption,
+        description: "Caption for the buy button",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_customerProductId,
+        description: "Customer-specific product identifier",
+        format: TagFormat.plainText
+      }
+    ],
+    rootExampleType: ExampleType.string
+  },
   [BitType.callToAction]: {
     since: "1.15.0",
     baseBitType: BitType._standard,
@@ -6642,17 +6768,30 @@ var BITS = {
     description: "Extractor configuration bit, used to configure extractors in articles or books",
     textFormatDefault: TextFormat.plainText
   },
-  [BitType.extractorImage]: {
+  [BitType.extractorImages]: {
     since: "4.3.0",
-    baseBitType: BitType.image,
-    description: "Extractor embedded image bit, used for embedded images extracted from PDFs",
+    baseBitType: BitType._standard,
+    description: "Extractor images bit, used for images extracted from PDFs",
+    tags: [
+      {
+        key: ConfigKey.group_resourceBitTags,
+        description: "Resource bit tags for logo grave images, used to define additional properties"
+      },
+      {
+        // Image resource
+        key: ConfigKey.group_resourceImage,
+        description: "Resource image tags for logo grave images, used to attach images",
+        minCount: 1,
+        maxCount: Count.infinity
+      }
+    ],
+    resourceAttachmentAllowed: false,
     textFormatDefault: TextFormat.plainText
   },
-  [BitType.extractorImageCollapsible]: {
+  [BitType.extractorImagesCollapsible]: {
     since: "4.3.0",
-    baseBitType: BitType.extractorImage,
-    description: "Collapsible extractor embedded image bit, used for embedded images extracted from PDFs",
-    textFormatDefault: TextFormat.plainText
+    baseBitType: BitType.extractorImages,
+    description: "Collapsible extractor images bit, used for  images extracted from PDFs"
   },
   [BitType.extractorInformation]: {
     since: "3.8.0",
@@ -9619,7 +9758,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "4.14.1",
+  "version": "4.15.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -10086,6 +10225,8 @@ var NodeType = (0, import_superenum20.superenum)({
   customerExternalId: "customerExternalId",
   customerId: "customerId",
   customerIdValue: "customerIdValue",
+  customerProductId: "customerProductId",
+  customerProductShopLink: "customerProductShopLink",
   data: "data",
   dataValue: "dataValue",
   dataValueValue: "dataValueValue",
@@ -10267,11 +10408,14 @@ var NodeType = (0, import_superenum20.superenum)({
   list: "list",
   listItemIndent: "listItemIndent",
   listItemIndentValue: "listItemIndentValue",
+  listPrice: "listPrice",
   listValue: "listValue",
   location: "location",
   locationValue: "locationValue",
   machineTranslated: "machineTranslated",
   machineTranslatedValue: "machineTranslatedValue",
+  spansPageBreak: "spansPageBreak",
+  spansPageBreakValue: "spansPageBreakValue",
   mailingList: "mailingList",
   marginNumber: "marginNumber",
   marginNumberValue: "marginNumberValue",
@@ -11052,22 +11196,22 @@ var DeprecatedTextFormat = (0, import_superenum23.superenum)({
 // src/parser/json/TableUtils.ts
 function isTableBasicFormat(table) {
   const t = table;
-  return !!(t.columns || t.data) && !(t.head || t.body || t.foot);
+  return !!(t.columns || t.data) && !(t.header || t.body || t.footer);
 }
 function isTableExtendedFormat(table) {
   const t = table;
-  return !!(t.head || t.body || t.foot);
+  return !!(t.header || t.body || t.footer);
 }
 function isMixedTableFormat(table) {
   const t = table;
   const hasOld = !!(t.columns || t.data);
-  const hasNew = !!(t.head || t.body || t.foot);
+  const hasNew = !!(t.header || t.body || t.footer);
   return hasOld && hasNew;
 }
 function convertBasicToExtendedTableFormat(table) {
   const tableExtended = {};
   if (table.columns && table.columns.length > 0) {
-    tableExtended.head = {
+    tableExtended.header = {
       rows: [
         {
           cells: table.columns.map((col) => ({
@@ -11098,7 +11242,7 @@ function convertExtendedToBasicTableFormat(tableExtended) {
     return row.cells.map((cell) => cell?.content).filter((content) => content !== void 0);
   };
   const dataRows = [];
-  const headRows = tableExtended.head?.rows ?? [];
+  const headRows = tableExtended.header?.rows ?? [];
   if (headRows.length > 0) {
     const primaryHeader = extractRowCells(headRows[0]);
     if (primaryHeader.length > 0) {
@@ -11124,7 +11268,7 @@ function convertExtendedToBasicTableFormat(tableExtended) {
     });
   };
   appendSectionRows(tableExtended.body);
-  appendSectionRows(tableExtended.foot);
+  appendSectionRows(tableExtended.footer);
   if (dataRows.length > 0) {
     table.data = dataRows;
   }
@@ -22084,7 +22228,8 @@ var ResourceBuilder = class extends BaseBuilder {
       BitType.imageSeparator,
       BitType.pageBanner,
       BitType.imagesLogoGrave,
-      BitType.prototypeImages
+      BitType.prototypeImages,
+      BitType.extractorImages
     ])) {
       zoomDisabledDefault = true;
     }
@@ -23035,6 +23180,12 @@ var Builder = class extends BaseBuilder {
         data.machineTranslated,
         options
       ),
+      spansPageBreak: this.toAstProperty(
+        bitType,
+        ConfigKey.property_spansPageBreak,
+        data.spansPageBreak,
+        options
+      ),
       searchIndex: this.toAstProperty(
         bitType,
         ConfigKey.property_searchIndex,
@@ -23503,6 +23654,19 @@ var Builder = class extends BaseBuilder {
         data.content2Buy,
         options
       ),
+      listPrice: this.toAstProperty(bitType, ConfigKey.property_listPrice, data.listPrice, options),
+      customerProductId: this.toAstProperty(
+        bitType,
+        ConfigKey.property_customerProductId,
+        data.customerProductId,
+        options
+      ),
+      customerProductShopLink: this.toAstProperty(
+        bitType,
+        ConfigKey.property_customerProductShopLink,
+        data.customerProductShopLink,
+        options
+      ),
       mailingList: this.toAstProperty(
         bitType,
         ConfigKey.property_mailingList,
@@ -24424,12 +24588,12 @@ var Builder = class extends BaseBuilder {
         rows
       };
     };
-    const head = buildSection(nodeTableExtended.head);
-    if (head && head.rows?.length > 0) nodeTableExtended.head = head;
+    const header = buildSection(nodeTableExtended.header);
+    if (header && header.rows?.length > 0) nodeTableExtended.header = header;
     const body = buildSection(nodeTableExtended.body);
     if (body && body.rows?.length > 0) nodeTableExtended.body = body;
-    const foot = buildSection(nodeTableExtended.foot);
-    if (foot && foot.rows?.length > 0) nodeTableExtended.foot = foot;
+    const footer = buildSection(nodeTableExtended.footer);
+    if (footer && footer.rows?.length > 0) nodeTableExtended.footer = footer;
     return node;
   }
   /**
@@ -26624,9 +26788,9 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   writeAdvancedTable(table) {
     const normalized = normalizeTableFormat(BitType.tableExtended, table);
     const sections = [
-      { key: "thead", qualifier: "thead", section: normalized.head },
-      { key: "tbody", qualifier: void 0, section: normalized.body },
-      { key: "tfoot", qualifier: "tfoot", section: normalized.foot }
+      { key: "header", qualifier: "table-header", section: normalized.header },
+      { key: "body", qualifier: void 0, section: normalized.body },
+      { key: "footer", qualifier: "table-footer", section: normalized.footer }
     ];
     let rowCount = 0;
     for (const { key, qualifier, section } of sections) {
@@ -26654,7 +26818,7 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     }
   }
   writeTableCell(cell, section) {
-    const defaultCellType = section === "tbody" ? "td" : "th";
+    const defaultCellType = section === "body" ? "td" : "th";
     const cellType = cell.title ? "th" : "td";
     if (cellType !== defaultCellType) {
       this.writeTableCellProperty("tableCellType", cellType);
@@ -27357,7 +27521,8 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
       BitType.imageSeparator,
       BitType.pageBanner,
       BitType.imagesLogoGrave,
-      BitType.prototypeImages
+      BitType.prototypeImages,
+      BitType.extractorImages
     ])) {
       this.writeProperty("zoomDisabled", node.value, route, {
         format: TagFormat.boolean,
@@ -28565,7 +28730,11 @@ var JsonGenerator = class extends AstWalkerGenerator {
         }
         resourceJson = wrapper;
       }
-    } else if (instance2.isOfBitType(bitType, [BitType.imagesLogoGrave, BitType.prototypeImages])) {
+    } else if (instance2.isOfBitType(bitType, [
+      BitType.imagesLogoGrave,
+      BitType.prototypeImages,
+      BitType.extractorImages
+    ])) {
       const images = [];
       for (const r of resources) {
         if (r.type === ResourceType.image) {
@@ -29142,7 +29311,11 @@ var JsonGenerator = class extends AstWalkerGenerator {
         if (bitJson.resolvedDate == null) bitJson.resolvedDate = "";
         if (bitJson.resolvedBy == null) bitJson.resolvedBy = "";
       }
-      if (instance2.isOfBitType(bitType, [BitType.imagesLogoGrave, BitType.prototypeImages])) {
+      if (instance2.isOfBitType(bitType, [
+        BitType.imagesLogoGrave,
+        BitType.prototypeImages,
+        BitType.extractorImages
+      ])) {
         if (bitType === BitType.imagesLogoGrave) {
           if (bitJson.logos == null) {
             bitJson.logos = [];
@@ -29570,7 +29743,7 @@ var JsonParser = class {
   processResources(bitType, resource, images, logos) {
     const nodes = [];
     if (resource) nodes.push(resource);
-    if (instance2.isOfBitType(bitType, [BitType.prototypeImages])) {
+    if (instance2.isOfBitType(bitType, [BitType.prototypeImages, BitType.extractorImages])) {
       if (Array.isArray(images)) {
         for (const image of images) {
           if (image) nodes.push(image);
@@ -31780,17 +31953,17 @@ function parsePronunciationTable(_context, _bitType, cardSet) {
 }
 function parseTable(context, _bitType, cardSet) {
   const sectionRows = {
-    thead: [],
-    tbody: [],
-    tfoot: []
+    header: [],
+    body: [],
+    footer: []
   };
   const getNormalizedQualifier = (rawQualifier) => {
     if (!rawQualifier) return void 0;
     const normalized = rawQualifier.trim().toLowerCase();
-    if (normalized === "thead" || normalized === "tbody" || normalized === "tfoot") {
-      return normalized;
-    }
-    context.addWarning(`Unknown table section qualifier '${rawQualifier}', defaulting to tbody.`);
+    if (normalized === "table-header") return "header";
+    if (normalized === "table-body") return "body";
+    if (normalized === "table-footer") return "footer";
+    context.addWarning(`Unknown table section qualifier '${rawQualifier}', defaulting to body.`);
     return void 0;
   };
   const isLegacyHeadingRow = (card, cardIndex) => {
@@ -31827,7 +32000,7 @@ function parseTable(context, _bitType, cardSet) {
         `Invalid table cell type '${raw}', using default for section '${section}'.`
       );
     }
-    return section === "tbody" ? "td" : "th";
+    return section === "body" ? "td" : "th";
   };
   const normalizeSpan = (raw, kind) => {
     if (raw == null) return 1;
@@ -31895,7 +32068,7 @@ function parseTable(context, _bitType, cardSet) {
   for (let cardIdx = 0; cardIdx < cardSet.cards.length; cardIdx++) {
     const card = cardSet.cards[cardIdx];
     const qualifier = resolveSectionQualifier(card);
-    const section = qualifier ? qualifier : isLegacyHeadingRow(card, cardIdx) ? "thead" : "tbody";
+    const section = qualifier ? qualifier : isLegacyHeadingRow(card, cardIdx) ? "header" : "body";
     const cells = [];
     for (const side of card.sides) {
       for (const variant of side.variants) {
@@ -31907,28 +32080,28 @@ function parseTable(context, _bitType, cardSet) {
     });
   }
   const table = {};
-  const hasHeadRows = sectionRows.thead.length > 0;
-  const hasBodyRows = sectionRows.tbody.length > 0;
-  const hasFootRows = sectionRows.tfoot.length > 0;
+  const hasHeadRows = sectionRows.header.length > 0;
+  const hasBodyRows = sectionRows.body.length > 0;
+  const hasFootRows = sectionRows.footer.length > 0;
   if (hasHeadRows) {
-    table.head = {
-      rows: sectionRows.thead
+    table.header = {
+      rows: sectionRows.header
     };
   }
   if (hasBodyRows) {
     table.body = {
-      rows: sectionRows.tbody
+      rows: sectionRows.body
     };
   }
   if (hasFootRows) {
-    table.foot = {
-      rows: sectionRows.tfoot
+    table.footer = {
+      rows: sectionRows.footer
     };
   }
   if (!hasHeadRows && !hasBodyRows && !hasFootRows) {
-    table.head = { rows: [] };
+    table.header = { rows: [] };
     table.body = { rows: [] };
-    table.foot = { rows: [] };
+    table.footer = { rows: [] };
   }
   return { table };
 }