@gmb/bitmark-parser-generator 4.3.0 → 4.6.0

package/dist/browser/cjs/index.d.cts

@@ -8,6 +8,7 @@ declare const BitType: Readonly<{
     _standard: "_standard";
     advertising: "advertising";
     advertisingAdvertorial: "advertising-advertorial";
+    advertisingAdvertorialPage: "advertising-advertorial-page";
     advertisingCallToAction: "advertising-call-to-action";
     advertisingCallToActionMeeting: "advertising-call-to-action-meeting";
     advertisingBanner: "advertising-banner";
@@ -235,8 +236,8 @@ declare const BitType: Readonly<{
     extractorAiChat: "extractor-ai-chat";
     extractorBlock: "extractor-block";
     extractorConfiguration: "extractor-configuration";
-    extractorEmbeddedImage: "extractor-embedded-image";
-    extractorEmbeddedImageCollapsible: "extractor-embedded-image-collapsible";
+    extractorImage: "extractor-image";
+    extractorImageCollapsible: "extractor-image-collapsible";
     extractorInformation: "extractor-information";
     extractorPage: "extractor-page";
     extractorPageCollapsible: "extractor-page-collapsible";
@@ -600,6 +601,7 @@ declare const BitType: Readonly<{
     _standard: "_standard";
     advertising: "advertising";
     advertisingAdvertorial: "advertising-advertorial";
+    advertisingAdvertorialPage: "advertising-advertorial-page";
     advertisingCallToAction: "advertising-call-to-action";
     advertisingCallToActionMeeting: "advertising-call-to-action-meeting";
     advertisingBanner: "advertising-banner";
@@ -827,8 +829,8 @@ declare const BitType: Readonly<{
     extractorAiChat: "extractor-ai-chat";
     extractorBlock: "extractor-block";
     extractorConfiguration: "extractor-configuration";
-    extractorEmbeddedImage: "extractor-embedded-image";
-    extractorEmbeddedImageCollapsible: "extractor-embedded-image-collapsible";
+    extractorImage: "extractor-image";
+    extractorImageCollapsible: "extractor-image-collapsible";
     extractorInformation: "extractor-information";
     extractorPage: "extractor-page";
     extractorPageCollapsible: "extractor-page-collapsible";
@@ -2230,6 +2232,7 @@ interface ResourceWrapperJson {
     __typeAlias: ResourceTypeType;
     __configKey: ConfigKeyType;
     __invalid?: boolean;
+    __excessResource?: boolean;
 }
 interface ImageResourceWrapperJson extends ResourceWrapperJson {
     type: 'image';
@@ -2976,7 +2979,6 @@ interface ParserInfo {
     version?: string;
     bitmarkVersion?: string;
     textParserVersion?: string;
-    excessResources?: unknown[];
     warnings?: ParserError[];
     errors?: ParserError[];
 }
@@ -7139,7 +7141,6 @@ interface ParserJson {
     bitmarkVersion?: string;
     commentedBitType?: string;
     internalComments?: string[];
-    excessResources?: ResourceJson[];
     warnings?: ParserError[];
     errors?: ParserError[];
 }

package/dist/browser/esm/index.d.ts

@@ -8,6 +8,7 @@ declare const BitType: Readonly<{
     _standard: "_standard";
     advertising: "advertising";
     advertisingAdvertorial: "advertising-advertorial";
+    advertisingAdvertorialPage: "advertising-advertorial-page";
     advertisingCallToAction: "advertising-call-to-action";
     advertisingCallToActionMeeting: "advertising-call-to-action-meeting";
     advertisingBanner: "advertising-banner";
@@ -235,8 +236,8 @@ declare const BitType: Readonly<{
     extractorAiChat: "extractor-ai-chat";
     extractorBlock: "extractor-block";
     extractorConfiguration: "extractor-configuration";
-    extractorEmbeddedImage: "extractor-embedded-image";
-    extractorEmbeddedImageCollapsible: "extractor-embedded-image-collapsible";
+    extractorImage: "extractor-image";
+    extractorImageCollapsible: "extractor-image-collapsible";
     extractorInformation: "extractor-information";
     extractorPage: "extractor-page";
     extractorPageCollapsible: "extractor-page-collapsible";
@@ -600,6 +601,7 @@ declare const BitType: Readonly<{
     _standard: "_standard";
     advertising: "advertising";
     advertisingAdvertorial: "advertising-advertorial";
+    advertisingAdvertorialPage: "advertising-advertorial-page";
     advertisingCallToAction: "advertising-call-to-action";
     advertisingCallToActionMeeting: "advertising-call-to-action-meeting";
     advertisingBanner: "advertising-banner";
@@ -827,8 +829,8 @@ declare const BitType: Readonly<{
     extractorAiChat: "extractor-ai-chat";
     extractorBlock: "extractor-block";
     extractorConfiguration: "extractor-configuration";
-    extractorEmbeddedImage: "extractor-embedded-image";
-    extractorEmbeddedImageCollapsible: "extractor-embedded-image-collapsible";
+    extractorImage: "extractor-image";
+    extractorImageCollapsible: "extractor-image-collapsible";
     extractorInformation: "extractor-information";
     extractorPage: "extractor-page";
     extractorPageCollapsible: "extractor-page-collapsible";
@@ -2230,6 +2232,7 @@ interface ResourceWrapperJson {
     __typeAlias: ResourceTypeType;
     __configKey: ConfigKeyType;
     __invalid?: boolean;
+    __excessResource?: boolean;
 }
 interface ImageResourceWrapperJson extends ResourceWrapperJson {
     type: 'image';
@@ -2976,7 +2979,6 @@ interface ParserInfo {
     version?: string;
     bitmarkVersion?: string;
     textParserVersion?: string;
-    excessResources?: unknown[];
     warnings?: ParserError[];
     errors?: ParserError[];
 }
@@ -7139,7 +7141,6 @@ interface ParserJson {
     bitmarkVersion?: string;
     commentedBitType?: string;
     internalComments?: string[];
-    excessResources?: ResourceJson[];
     warnings?: ParserError[];
     errors?: ParserError[];
 }

package/dist/browser/esm/index.js

@@ -13,6 +13,7 @@ var BitType = superenum({
   // Not to be used as a bit, but as a base for other bit types
   advertising: "advertising",
   advertisingAdvertorial: "advertising-advertorial",
+  advertisingAdvertorialPage: "advertising-advertorial-page",
   advertisingCallToAction: "advertising-call-to-action",
   advertisingCallToActionMeeting: "advertising-call-to-action-meeting",
   advertisingBanner: "advertising-banner",
@@ -240,8 +241,8 @@ var BitType = superenum({
   extractorAiChat: "extractor-ai-chat",
   extractorBlock: "extractor-block",
   extractorConfiguration: "extractor-configuration",
-  extractorEmbeddedImage: "extractor-embedded-image",
-  extractorEmbeddedImageCollapsible: "extractor-embedded-image-collapsible",
+  extractorImage: "extractor-image",
+  extractorImageCollapsible: "extractor-image-collapsible",
   extractorInformation: "extractor-information",
   extractorPage: "extractor-page",
   extractorPageCollapsible: "extractor-page-collapsible",
@@ -3274,6 +3275,12 @@ var GROUPS = {
         description: "If true, the quiz solutions are revealed",
         format: TagFormat.boolean
         // defaultValue: 'false',
+      },
+      {
+        key: ConfigKey.property_additionalSolutions,
+        description: "Additional solutions",
+        format: TagFormat.plainText,
+        maxCount: Count.infinity
       }
     ]
   },
@@ -4892,12 +4899,6 @@ var BITS = {
         description: "If the cloze solutions should be strikethrough",
         format: TagFormat.boolean
       },
-      {
-        key: ConfigKey.property_additionalSolutions,
-        description: "Additional solutions for the cloze quiz",
-        format: TagFormat.plainText,
-        maxCount: Count.infinity
-      },
       {
         key: ConfigKey.group_gap,
         description: "Tags for gaps in cloze bits"
@@ -5425,12 +5426,6 @@ var BITS = {
         description: "Sample solution for the essay, used as a reference answer",
         format: TagFormat.plainText
       },
-      {
-        key: ConfigKey.property_additionalSolutions,
-        description: "Additional solutions for the essay, used for alternative answers",
-        format: TagFormat.plainText,
-        maxCount: Count.infinity
-      },
       {
         key: ConfigKey.property_partialAnswer,
         description: "Partial answer for the essay, used to indicate incomplete answers",
@@ -6262,15 +6257,15 @@ var BITS = {
     description: "Extractor configuration bit, used to configure extractors in articles or books",
     textFormatDefault: TextFormat2.plainText
   },
-  [BitType.extractorEmbeddedImage]: {
+  [BitType.extractorImage]: {
     since: "4.3.0",
     baseBitType: BitType.image,
     description: "Extractor embedded image bit, used for embedded images extracted from PDFs",
     textFormatDefault: TextFormat2.plainText
   },
-  [BitType.extractorEmbeddedImageCollapsible]: {
+  [BitType.extractorImageCollapsible]: {
     since: "4.3.0",
-    baseBitType: BitType.extractorEmbeddedImage,
+    baseBitType: BitType.extractorImage,
     description: "Collapsible extractor embedded image bit, used for embedded images extracted from PDFs",
     textFormatDefault: TextFormat2.plainText
   },
@@ -7510,6 +7505,11 @@ var BITS = {
     baseBitType: BitType.page,
     description: "Page cover image bit, used to create cover images for pages"
   },
+  [BitType.advertisingAdvertorialPage]: {
+    since: "4.5.0",
+    baseBitType: BitType.page,
+    description: "Advertorial Page bit, used to create advertorial pages"
+  },
   [BitType.pageBuyButton]: {
     since: "1.4.3",
     baseBitType: BitType._standard,
@@ -9057,7 +9057,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "4.3.0",
+  "version": "4.6.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -10464,14 +10464,17 @@ var ArrayUtils = class {
    */
   removeDuplicates(arr, keyFunc) {
     const seen = /* @__PURE__ */ new Set();
-    for (const item of arr) {
+    let write = 0;
+    for (let read = 0; read < arr.length; read++) {
+      const item = arr[read];
       const k = keyFunc ? keyFunc(item) : item;
-      if (seen.has(k)) {
-        const index = arr.lastIndexOf(item);
-        if (index !== -1) arr.splice(index, 1);
+      if (!seen.has(k)) {
+        seen.add(k);
+        if (write !== read) arr[write] = item;
+        write++;
       }
-      seen.add(k);
     }
+    if (write < arr.length) arr.length = write;
     return arr;
   }
 };
@@ -27403,22 +27406,9 @@ var JsonGenerator = class extends AstWalkerGenerator {
     const bitType = this.getBitType(route);
     const parent = this.getParentNode(route);
     if (parser2 && bitType) {
-      const {
-        version,
-        excessResources: parserExcessResources,
-        warnings,
-        errors,
-        ...parserRest
-      } = parser2;
+      const { version, warnings, errors, ...parserRest } = parser2;
       const bitmarkVersion = `${this.bitmarkVersion}`;
       const textParserVersion = this.textParserVersion;
-      let excessResources;
-      if (Array.isArray(parserExcessResources) && parserExcessResources.length > 0) {
-        excessResources = [];
-        for (const r of parserExcessResources) {
-          excessResources.push(r);
-        }
-      }
       const internalComments = this.getInternalComments(route);
       if (parent?.key === NodeType.bitsValue) {
         this.bitWrapperJson.parser = {
@@ -27428,8 +27418,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
           internalComments,
           ...parserRest,
           warnings,
-          errors,
-          excessResources
+          errors
         };
         if (!this.options.enableWarnings) {
           delete this.bitWrapperJson.parser.warnings;
@@ -29413,7 +29402,10 @@ var BitmarkPegParserValidator = class {
       if (warning.invalid || warning.excessResource) {
         warningStr = `${keyStr} is not valid here (incorrectly chained?).${ignoredStr}`;
       } else if (warning.tooMany != null) {
-        warningStr = `${keyStr} is included more than ${warning.tooMany} time(s).`;
+        warningStr = `${keyStr} is included more than the required ${warning.tooMany} time(s).`;
+        if (warning.tooMany === 0 && typeKey === TypeKey.Resource) {
+          warningStr += ` Did you forget the '${key}' in the bit header?`;
+        }
         if (warning.tooMany > 0) warningStr += " The earlier ones will be ignored";
       } else if (warning.extraProperty) {
         warningStr = `${keyStr} is an unknown property. It can be excluded from the output using the 'excludeUnknownProperties' flag`;
@@ -31186,7 +31178,6 @@ function extractAvatarImage(context, resources) {
     }
   }
   if (excessResources.length > 0) {
-    context.parser.excessResources = excessResources;
     context.addWarning(
       `${excessResources.length} excess resource(s) present in the [@person] chain.`
     );
@@ -31459,9 +31450,10 @@ function buildResources(context, resourceTypeAttachment, resources) {
       `Resource type [&${resourceTypeAttachment}] is specified in the bit header, but no such resource is present`
     );
   }
-  if (excessResources.length > 0) {
-    context.parser.excessResources = excessResources;
-  }
+  excessResources.forEach((r) => {
+    r.__excessResource = true;
+    filteredResources.push(r);
+  });
   return filteredResources;
 }
 function resourceContentProcessor(context, _contentDepth, tagsConfig, content, target) {