@gmb/bitmark-parser-generator 4.10.0 → 4.12.0

package/dist/index.cjs

@@ -1115,6 +1115,7 @@ var groupKeys = {
   group_mark: "group_mark",
   group_bookCommon: "group_bookCommon",
   group_learningPathCommon: "group_learningPathCommon",
+  group_advertisingCommon: "group_advertisingCommon",
   group_quizCommon: "group_quizCommon",
   group_resourceBitTags: "group_resourceBitTags",
   group_resourceCommon: "group_resourceCommon",
@@ -1158,6 +1159,7 @@ var propertyKeys = {
   property_action: "@action",
   property_activityType: "@activityType",
   property_additionalSolutions: "@additionalSolutions",
+  property_advertisingClickUrl: "@advertisingClickUrl",
   property_ageRange: "@ageRange",
   property_aiGenerated: "@aiGenerated",
   property_allowedBit: "@allowedBit",
@@ -1322,6 +1324,7 @@ var propertyKeys = {
   property_siteName: "@siteName",
   property_size: "@size",
   property_slug: "@slug",
+  property_sourceDocument: "@sourceDocument",
   property_spaceId: "@spaceId",
   property_src1x: "@src1x",
   property_src2x: "@src2x",
@@ -2874,7 +2877,7 @@ var GROUPS = {
   },
   [ConfigKey.group_standardItemLeadInstructionHint]: {
     type: GroupConfigType.standard,
-    description: "Standard group for item, lead, page number, margin number, instruction and hint tags",
+    description: "Standard group for item, lead, page number, source page number, margin number, instruction and hint tags",
     tags: [
       {
         key: ConfigKey.tag_item,
@@ -2882,8 +2885,8 @@ var GROUPS = {
         chain: [
           {
             key: ConfigKey.tag_item,
-            description: "The lead, page number, and margin number for the bit",
-            maxCount: 3
+            description: "The lead, page number, source page number, and margin number for the bit",
+            maxCount: 4
           }
         ]
       },
@@ -3278,6 +3281,11 @@ var GROUPS = {
         key: ConfigKey.property_maxTocChapterLevel,
         description: "The maximum table of contents chapter level",
         format: TagFormat.number
+      },
+      {
+        key: ConfigKey.property_sourceDocument,
+        description: "Url of the source document for the book (for example, a PDF file)",
+        format: TagFormat.plainText
       }
     ]
   },
@@ -3356,6 +3364,17 @@ var GROUPS = {
       }
     ]
   },
+  [ConfigKey.group_advertisingCommon]: {
+    type: GroupConfigType.standard,
+    description: "Common advertising tags",
+    tags: [
+      {
+        key: ConfigKey.property_advertisingClickUrl,
+        description: "The URL to which the advertisement should link",
+        format: TagFormat.plainText
+      }
+    ]
+  },
   [ConfigKey.group_quizCommon]: {
     type: GroupConfigType.standard,
     description: "Common quiz tags",
@@ -5268,67 +5287,145 @@ var BITS = {
   [BitType.advertising]: {
     since: "4.2.0",
     baseBitType: BitType.article,
-    description: "General advertising content bit"
+    description: "General advertising content bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingAdvertorial]: {
     since: "4.2.0",
     baseBitType: BitType.article,
-    description: "Advertorial content bit (sponsored article)"
+    description: "Advertorial content bit (sponsored article)",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingCallToAction]: {
     since: "4.2.0",
     baseBitType: BitType.callToAction,
-    description: "Call-to-action for advertising"
+    description: "Call-to-action for advertising",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingCallToActionMeeting]: {
     since: "4.2.0",
     baseBitType: BitType.callToAction,
-    description: "Call-to-action for meeting or appointment"
+    description: "Call-to-action for meeting or appointment",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingBanner]: {
     since: "4.2.0",
     baseBitType: BitType.image,
-    description: "Banner advertisement bit"
+    description: "Banner advertisement bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingSkyscraper]: {
     since: "4.2.0",
     baseBitType: BitType.image,
-    description: "Skyscraper (vertical) advertisement bit"
+    description: "Skyscraper (vertical) advertisement bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingRectangle]: {
     since: "4.2.0",
     baseBitType: BitType.image,
-    description: "Rectangle advertisement bit"
+    description: "Rectangle advertisement bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingFullPage]: {
     since: "4.2.0",
     baseBitType: BitType.image,
-    description: "Full-page advertisement bit"
+    description: "Full-page advertisement bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingHalfPage]: {
     since: "4.2.0",
     baseBitType: BitType.image,
-    description: "Half-page advertisement bit"
+    description: "Half-page advertisement bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingQuarterPage]: {
     since: "4.2.0",
     baseBitType: BitType.image,
-    description: "Quarter-page advertisement bit"
+    description: "Quarter-page advertisement bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingClassifiedPage]: {
     since: "4.2.0",
     baseBitType: BitType.image,
-    description: "Classifieds advertisement page bit"
+    description: "Classifieds advertisement page bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingLandscape]: {
     since: "4.2.0",
     baseBitType: BitType.image,
-    description: "Landscape format advertisement bit"
+    description: "Landscape format advertisement bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.advertisingPortrait]: {
     since: "4.2.0",
     baseBitType: BitType.image,
-    description: "Portrait format advertisement bit"
+    description: "Portrait format advertisement bit",
+    tags: [
+      {
+        key: ConfigKey.group_advertisingCommon,
+        description: "Common advertising tags"
+      }
+    ]
   },
   [BitType.cookPreparation]: {
     since: "1.3.0",
@@ -9185,7 +9282,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "4.10.0",
+  "version": "4.12.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -9527,6 +9624,8 @@ var NodeType = (0, import_superenum20.superenum)({
   activityTypeValue: "activityTypeValue",
   additionalSolutions: "additionalSolutions",
   additionalSolutionsValue: "additionalSolutionsValue",
+  advertisingClickUrl: "advertisingClickUrl",
+  advertisingClickUrlValue: "advertisingClickUrlValue",
   ageRange: "ageRange",
   ageRangeValue: "ageRangeValue",
   aiGenerated: "aiGenerated",
@@ -9593,8 +9692,6 @@ var NodeType = (0, import_superenum20.superenum)({
   botValue: "botValue",
   bubbleTag: "bubbleTag",
   bubbleTagValue: "bubbleTagValue",
-  extractorTag: "extractorTag",
-  extractorTagValue: "extractorTagValue",
   buttonCaption: "buttonCaption",
   buttonCaptionValue: "buttonCaptionValue",
   callToActionUrl: "callToActionUrl",
@@ -9692,6 +9789,8 @@ var NodeType = (0, import_superenum20.superenum)({
   externalIdValue: "externalIdValue",
   externalLink: "externalLink",
   externalLinkText: "externalLinkText",
+  extractorTag: "extractorTag",
+  extractorTagValue: "extractorTagValue",
   extraProperties: "extraProperties",
   feedback: "feedback",
   feedbackEngine: "feedbackEngine",
@@ -9976,15 +10075,18 @@ var NodeType = (0, import_superenum20.superenum)({
   solution: "solution",
   solutions: "solutions",
   solutionsValue: "solutionsValue",
+  sourceDocument: "sourceDocument",
+  sourceDocumentValue: "sourceDocumentValue",
+  sourcePageNumber: "sourcePageNumber",
   spaceId: "spaceId",
   spaceIdValue: "spaceIdValue",
   src: "src",
-  srcAlt: "srcAlt",
-  srcAltValue: "srcAltValue",
   src1x: "src1x",
   src2x: "src2x",
   src3x: "src3x",
   src4x: "src4x",
+  srcAlt: "srcAlt",
+  srcAltValue: "srcAltValue",
   start: "start",
   statement: "statement",
   statements: "statements",
@@ -22927,6 +23029,12 @@ var Builder = class extends BaseBuilder {
         data.callToActionUrl,
         options
       ),
+      advertisingClickUrl: this.toAstProperty(
+        bitType,
+        ConfigKey.property_advertisingClickUrl,
+        data.advertisingClickUrl,
+        options
+      ),
       caption: this.handleJsonText(context, TextLocation.tag, data.caption),
       quotedPerson: this.toAstProperty(
         bitType,
@@ -22984,6 +23092,12 @@ var Builder = class extends BaseBuilder {
         data.maxTocChapterLevel,
         options
       ),
+      sourceDocument: this.toAstProperty(
+        bitType,
+        ConfigKey.property_sourceDocument,
+        data.sourceDocument,
+        options
+      ),
       tocResource: this.toAstProperty(
         bitType,
         ConfigKey.property_tocResource,
@@ -23068,6 +23182,7 @@ var Builder = class extends BaseBuilder {
       item: this.handleJsonText(context, TextLocation.tag, data.item),
       lead: this.handleJsonText(context, TextLocation.tag, data.lead),
       pageNumber: this.handleJsonText(context, TextLocation.tag, data.pageNumber),
+      sourcePageNumber: this.handleJsonText(context, TextLocation.tag, data.sourcePageNumber),
       marginNumber: this.handleJsonText(context, TextLocation.tag, data.marginNumber),
       hint: this.handleJsonText(context, TextLocation.tag, data.hint),
       instruction: this.handleJsonText(context, TextLocation.tag, data.instruction),
@@ -23170,7 +23285,15 @@ var Builder = class extends BaseBuilder {
     objectUtils.removeUnwantedProperties(node, {
       ignoreAllFalse: true,
       ignoreUndefined: ["example"],
-      ignoreEmptyArrays: ["item", "lead", "pageNumber", "marginNumber", "hint", "instruction"]
+      ignoreEmptyArrays: [
+        "item",
+        "lead",
+        "pageNumber",
+        "sourcePageNumber",
+        "marginNumber",
+        "hint",
+        "instruction"
+      ]
     });
     return nodeValidator.validateBit(node);
   }
@@ -25483,6 +25606,7 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     if (this.isEmptyText(item)) return false;
     if (!this.isEmptyText(parent?.value?.lead)) return true;
     if (!this.isEmptyText(parent?.value?.pageNumber)) return true;
+    if (!this.isEmptyText(parent?.value?.sourcePageNumber)) return true;
     if (!this.isEmptyText(parent?.value?.marginNumber)) return true;
     this.writeNL_IfNotChain(route);
     this.writeOPC();
@@ -25496,6 +25620,7 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     const parent = this.getParentNode(route);
     if (this.isEmptyText(lead)) return false;
     if (!this.isEmptyText(parent?.value?.pageNumber)) return true;
+    if (!this.isEmptyText(parent?.value?.sourcePageNumber)) return true;
     if (!this.isEmptyText(parent?.value?.marginNumber)) return true;
     this.writeNL_IfNotChain(route);
     this.writeOPC();
@@ -25511,6 +25636,7 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     const pageNumber = node.value;
     const parent = this.getParentNode(route);
     if (this.isEmptyText(pageNumber)) return false;
+    if (!this.isEmptyText(parent?.value?.sourcePageNumber)) return true;
     if (!this.isEmptyText(parent?.value?.marginNumber)) return true;
     this.writeNL_IfNotChain(route);
     this.writeOPC();
@@ -25524,6 +25650,31 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     this.writeCL();
     return true;
   }
+  // bitmarkAst -> bits -> bitsValue -> sourcePageNumber
+  enter_sourcePageNumber(node, route) {
+    const sourcePageNumber = node.value;
+    const parent = this.getParentNode(route);
+    if (this.isEmptyText(sourcePageNumber)) return false;
+    if (!this.isEmptyText(parent?.value?.marginNumber)) return true;
+    this.writeNL_IfNotChain(route);
+    this.writeOPC();
+    this.writeTextOrValue(parent?.value?.item ?? "", TextFormat.bitmarkText, TextLocation.tag);
+    this.writeCL();
+    this.writeOPC();
+    this.writeTextOrValue(parent?.value?.lead ?? "", TextFormat.bitmarkText, TextLocation.tag);
+    this.writeCL();
+    this.writeOPC();
+    this.writeTextOrValue(
+      parent?.value?.pageNumber ?? "",
+      TextFormat.bitmarkText,
+      TextLocation.tag
+    );
+    this.writeCL();
+    this.writeOPC();
+    this.writeTextOrValue(sourcePageNumber ?? "", TextFormat.bitmarkText, TextLocation.tag);
+    this.writeCL();
+    return true;
+  }
   // bitmarkAst -> bits -> bitsValue -> marginNumber
   enter_marginNumber(node, route) {
     const marginNumber = node.value;
@@ -25544,6 +25695,13 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     );
     this.writeCL();
     this.writeOPC();
+    this.writeTextOrValue(
+      parent?.value?.sourcePageNumber ?? "",
+      TextFormat.bitmarkText,
+      TextLocation.tag
+    );
+    this.writeCL();
+    this.writeOPC();
     this.writeTextOrValue(marginNumber, TextFormat.bitmarkText, TextLocation.tag);
     this.writeCL();
     return true;
@@ -27368,6 +27526,10 @@ var JsonGenerator = class extends AstWalkerGenerator {
   enter_pageNumber(node, route) {
     return this.standardHandler(node, route, NodeType.bitsValue, { array: true });
   }
+  // bitmarkAst -> bits -> bitsValue -> sourcePageNumber
+  enter_sourcePageNumber(node, route) {
+    return this.standardHandler(node, route, NodeType.bitsValue, { array: true });
+  }
   // bitmarkAst -> bits -> bitsValue -> marginNumber
   enter_marginNumber(node, route) {
     return this.standardHandler(node, route, NodeType.bitsValue, { array: true });
@@ -28090,6 +28252,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
       delete bitJson.item;
       delete bitJson.lead;
       delete bitJson.pageNumber;
+      delete bitJson.sourcePageNumber;
       delete bitJson.marginNumber;
       delete bitJson.hint;
       delete bitJson.instruction;
@@ -28101,6 +28264,8 @@ var JsonGenerator = class extends AstWalkerGenerator {
         if (bitJson.lead == null || bitJson.lead?.length === 0) delete bitJson.lead;
         if (bitJson.pageNumber == null || bitJson.pageNumber?.length === 0)
           delete bitJson.pageNumber;
+        if (bitJson.sourcePageNumber == null || bitJson.sourcePageNumber?.length === 0)
+          delete bitJson.sourcePageNumber;
         if (bitJson.marginNumber == null || bitJson.marginNumber?.length === 0)
           delete bitJson.marginNumber;
         if (bitJson.hint == null || bitJson.hint?.length === 0) delete bitJson.hint;
@@ -28112,6 +28277,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
         if (bitJson.hint == null) bitJson.hint = this.textDefault;
         if (bitJson.instruction == null) bitJson.instruction = this.textDefault;
         if (bitJson.pageNumber == null) bitJson.pageNumber = this.textDefault;
+        if (bitJson.sourcePageNumber == null) bitJson.sourcePageNumber = this.textDefault;
         if (bitJson.marginNumber == null) bitJson.marginNumber = this.textDefault;
       }
       if (bitJson.body == null) bitJson.body = this.bodyDefault;
@@ -32573,7 +32739,8 @@ var BitmarkPegParserProcessor = class {
       if (l > 0) result.item = result.itemLead[0];
       if (l > 1) result.lead = result.itemLead[1];
       if (l > 2) result.pageNumber = result.itemLead[2];
-      if (l > 3) result.marginNumber = result.itemLead[l - 1];
+      if (l > 3) result.sourcePageNumber = result.itemLead[3];
+      if (l > 4) result.marginNumber = result.itemLead[l - 1];
     }
     if (inBit) {
       result.body = instance11.process(