@gmb/bitmark-parser-generator 5.4.0 → 5.6.0

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

@@ -419,6 +419,7 @@ declare const BitType: {
     readonly pageHero: "page-hero";
     readonly pageOpenBook: "page-open-book";
     readonly pageOpenBookList: "page-open-book-list";
+    readonly printBook: "print-book";
     readonly openBookChapter: "open-book-chapter";
     readonly pagePerson: "page-person";
     readonly pageProduct: "page-product";
@@ -712,6 +713,7 @@ declare const ConfigKey: {
     readonly property_ageRange: "@ageRange";
     readonly property_aiGenerated: "@aiGenerated";
     readonly property_allowedBit: "@allowedBit";
+    readonly property_allowPrint: "@allowPrint";
     readonly property_allowSubtitles: "@allowSubtitles";
     readonly property_alt: "@alt";
     readonly property_altLangTag: "@altLangTag";
@@ -816,6 +818,7 @@ declare const ConfigKey: {
     readonly property_internalPrintPdf: "@internalPrintPdf";
     readonly property_hasPrintRestriction: "@hasPrintRestriction";
     readonly property_enforceUpdateOverUserInput: "@enforceUpdateOverUserInput";
+    readonly property_extractorExtractionTimestamp: "@extractorExtractionTimestamp";
     readonly property_isCaseSensitive: "@isCaseSensitive";
     readonly property_isInfoOnly: "@isInfoOnly";
     readonly property_isPublic: "@isPublic";
@@ -853,6 +856,7 @@ declare const ConfigKey: {
     readonly property_mute: "@mute";
     readonly property_padletId: "@padletId";
     readonly property_page: "@page";
+    readonly property_printParentChapterLevel: "@printParentChapterLevel";
     readonly property_pageNo: "@pageNo";
     readonly property_partialAnswer: "@partialAnswer";
     readonly property_partner: "@partner";
@@ -1791,10 +1795,13 @@ interface BitJson {
     maxCreatedBits: number;
     maxDisplayLevel: number;
     maxTocChapterLevel: number;
+    allowPrint: boolean;
+    printParentChapterLevel: number;
     sourceDocument: string;
     internalPrintPdf: string;
     hasPrintRestriction: boolean;
     enforceUpdateOverUserInput: boolean;
+    extractorExtractionTimestamp: string[];
     tocResource: string | string[];
     tocContent: string | string[];
     page: string;
@@ -2408,9 +2415,13 @@ interface Bit {
     internalPrintPdf?: Property;
     hasPrintRestriction?: Property;
     enforceUpdateOverUserInput?: Property;
+    extractorExtractionTimestamp?: Property;
     tocResource?: Property;
     tocContent?: Property;
     page?: Property;
+    allowPrint?: Property;
+    allowPrintValue?: Property;
+    printParentChapterLevel?: Property;
     platformBrandTarget?: Property;
     platformName?: Property;
     platformIcon?: ImageResourceWrapperJson;
@@ -2559,6 +2570,8 @@ declare const NodeType: {
     readonly alignment: "alignment";
     readonly allowedBit: "allowedBit";
     readonly allowedBitValue: "allowedBitValue";
+    readonly allowPrint: "allowPrint";
+    readonly allowPrintValue: "allowPrintValue";
     readonly alt: "alt";
     readonly alternativeAnswers: "alternativeAnswers";
     readonly alternativeAnswersValue: "alternativeAnswersValue";
@@ -2816,6 +2829,8 @@ declare const NodeType: {
     readonly hasPrintRestrictionValue: "hasPrintRestrictionValue";
     readonly enforceUpdateOverUserInput: "enforceUpdateOverUserInput";
     readonly enforceUpdateOverUserInputValue: "enforceUpdateOverUserInputValue";
+    readonly extractorExtractionTimestamp: "extractorExtractionTimestamp";
+    readonly extractorExtractionTimestampValue: "extractorExtractionTimestampValue";
     readonly isCaseSensitive: "isCaseSensitive";
     readonly isCommented: "isCommented";
     readonly isCorrect: "isCorrect";
@@ -2918,6 +2933,8 @@ declare const NodeType: {
     readonly pageNumber: "pageNumber";
     readonly pageNumberValue: "pageNumberValue";
     readonly pageValue: "pageValue";
+    readonly printParentChapterLevel: "printParentChapterLevel";
+    readonly printParentChapterLevelValue: "printParentChapterLevelValue";
     readonly pairs: "pairs";
     readonly pairsValue: "pairsValue";
     readonly parent: "parent";
@@ -4212,11 +4229,14 @@ declare class Builder extends BaseBuilder {
         maxTocChapterLevel?: number;
         sourceDocument?: string;
         internalPrintPdf?: string;
+        allowPrint?: boolean;
         hasPrintRestriction?: boolean;
         enforceUpdateOverUserInput?: boolean;
+        extractorExtractionTimestamp?: string[];
         tocResource?: string | string[];
         tocContent?: string | string[];
         page?: string | string[];
+        printParentChapterLevel?: number;
         platformBrandTarget?: string;
         platformName?: string;
         platformIcon?: Partial<ImageResourceWrapperJson>;

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

@@ -419,6 +419,7 @@ declare const BitType: {
     readonly pageHero: "page-hero";
     readonly pageOpenBook: "page-open-book";
     readonly pageOpenBookList: "page-open-book-list";
+    readonly printBook: "print-book";
     readonly openBookChapter: "open-book-chapter";
     readonly pagePerson: "page-person";
     readonly pageProduct: "page-product";
@@ -712,6 +713,7 @@ declare const ConfigKey: {
     readonly property_ageRange: "@ageRange";
     readonly property_aiGenerated: "@aiGenerated";
     readonly property_allowedBit: "@allowedBit";
+    readonly property_allowPrint: "@allowPrint";
     readonly property_allowSubtitles: "@allowSubtitles";
     readonly property_alt: "@alt";
     readonly property_altLangTag: "@altLangTag";
@@ -816,6 +818,7 @@ declare const ConfigKey: {
     readonly property_internalPrintPdf: "@internalPrintPdf";
     readonly property_hasPrintRestriction: "@hasPrintRestriction";
     readonly property_enforceUpdateOverUserInput: "@enforceUpdateOverUserInput";
+    readonly property_extractorExtractionTimestamp: "@extractorExtractionTimestamp";
     readonly property_isCaseSensitive: "@isCaseSensitive";
     readonly property_isInfoOnly: "@isInfoOnly";
     readonly property_isPublic: "@isPublic";
@@ -853,6 +856,7 @@ declare const ConfigKey: {
     readonly property_mute: "@mute";
     readonly property_padletId: "@padletId";
     readonly property_page: "@page";
+    readonly property_printParentChapterLevel: "@printParentChapterLevel";
     readonly property_pageNo: "@pageNo";
     readonly property_partialAnswer: "@partialAnswer";
     readonly property_partner: "@partner";
@@ -1791,10 +1795,13 @@ interface BitJson {
     maxCreatedBits: number;
     maxDisplayLevel: number;
     maxTocChapterLevel: number;
+    allowPrint: boolean;
+    printParentChapterLevel: number;
     sourceDocument: string;
     internalPrintPdf: string;
     hasPrintRestriction: boolean;
     enforceUpdateOverUserInput: boolean;
+    extractorExtractionTimestamp: string[];
     tocResource: string | string[];
     tocContent: string | string[];
     page: string;
@@ -2408,9 +2415,13 @@ interface Bit {
     internalPrintPdf?: Property;
     hasPrintRestriction?: Property;
     enforceUpdateOverUserInput?: Property;
+    extractorExtractionTimestamp?: Property;
     tocResource?: Property;
     tocContent?: Property;
     page?: Property;
+    allowPrint?: Property;
+    allowPrintValue?: Property;
+    printParentChapterLevel?: Property;
     platformBrandTarget?: Property;
     platformName?: Property;
     platformIcon?: ImageResourceWrapperJson;
@@ -2559,6 +2570,8 @@ declare const NodeType: {
     readonly alignment: "alignment";
     readonly allowedBit: "allowedBit";
     readonly allowedBitValue: "allowedBitValue";
+    readonly allowPrint: "allowPrint";
+    readonly allowPrintValue: "allowPrintValue";
     readonly alt: "alt";
     readonly alternativeAnswers: "alternativeAnswers";
     readonly alternativeAnswersValue: "alternativeAnswersValue";
@@ -2816,6 +2829,8 @@ declare const NodeType: {
     readonly hasPrintRestrictionValue: "hasPrintRestrictionValue";
     readonly enforceUpdateOverUserInput: "enforceUpdateOverUserInput";
     readonly enforceUpdateOverUserInputValue: "enforceUpdateOverUserInputValue";
+    readonly extractorExtractionTimestamp: "extractorExtractionTimestamp";
+    readonly extractorExtractionTimestampValue: "extractorExtractionTimestampValue";
     readonly isCaseSensitive: "isCaseSensitive";
     readonly isCommented: "isCommented";
     readonly isCorrect: "isCorrect";
@@ -2918,6 +2933,8 @@ declare const NodeType: {
     readonly pageNumber: "pageNumber";
     readonly pageNumberValue: "pageNumberValue";
     readonly pageValue: "pageValue";
+    readonly printParentChapterLevel: "printParentChapterLevel";
+    readonly printParentChapterLevelValue: "printParentChapterLevelValue";
     readonly pairs: "pairs";
     readonly pairsValue: "pairsValue";
     readonly parent: "parent";
@@ -4212,11 +4229,14 @@ declare class Builder extends BaseBuilder {
         maxTocChapterLevel?: number;
         sourceDocument?: string;
         internalPrintPdf?: string;
+        allowPrint?: boolean;
         hasPrintRestriction?: boolean;
         enforceUpdateOverUserInput?: boolean;
+        extractorExtractionTimestamp?: string[];
         tocResource?: string | string[];
         tocContent?: string | string[];
         page?: string | string[];
+        printParentChapterLevel?: number;
         platformBrandTarget?: string;
         platformName?: string;
         platformIcon?: Partial<ImageResourceWrapperJson>;

package/dist/browser/esm/index.js

@@ -428,6 +428,7 @@ var BitType = {
   pageHero: "page-hero",
   pageOpenBook: "page-open-book",
   pageOpenBookList: "page-open-book-list",
+  printBook: "print-book",
   openBookChapter: "open-book-chapter",
   pagePerson: "page-person",
   pageProduct: "page-product",
@@ -1137,6 +1138,7 @@ var propertyKeys = {
   property_ageRange: "@ageRange",
   property_aiGenerated: "@aiGenerated",
   property_allowedBit: "@allowedBit",
+  property_allowPrint: "@allowPrint",
   property_allowSubtitles: "@allowSubtitles",
   property_alt: "@alt",
   property_altLangTag: "@altLangTag",
@@ -1241,6 +1243,7 @@ var propertyKeys = {
   property_internalPrintPdf: "@internalPrintPdf",
   property_hasPrintRestriction: "@hasPrintRestriction",
   property_enforceUpdateOverUserInput: "@enforceUpdateOverUserInput",
+  property_extractorExtractionTimestamp: "@extractorExtractionTimestamp",
   property_isCaseSensitive: "@isCaseSensitive",
   property_isInfoOnly: "@isInfoOnly",
   property_isPublic: "@isPublic",
@@ -1278,6 +1281,7 @@ var propertyKeys = {
   property_mute: "@mute",
   property_padletId: "@padletId",
   property_page: "@page",
+  property_printParentChapterLevel: "@printParentChapterLevel",
   property_pageNo: "@pageNo",
   property_partialAnswer: "@partialAnswer",
   property_partner: "@partner",
@@ -3406,6 +3410,12 @@ var GROUPS = {
         description: "Url of the internal print PDF for the book",
         format: TagFormat.plainText
       },
+      {
+        key: ConfigKey.property_allowPrint,
+        description: "If true, the book allows printing",
+        format: TagFormat.boolean,
+        defaultValue: "false"
+      },
       {
         key: ConfigKey.property_hasPrintRestriction,
         description: "If true, the book has print restrictions",
@@ -3417,6 +3427,12 @@ var GROUPS = {
         description: "If true, prioritize new content over legacy content from the instance API",
         format: TagFormat.boolean,
         defaultValue: "false"
+      },
+      {
+        key: ConfigKey.property_extractorExtractionTimestamp,
+        description: "Extraction timestamps for book conversion",
+        format: TagFormat.plainText,
+        maxCount: Count.infinity
       }
     ]
   },
@@ -6813,6 +6829,12 @@ var BITS = {
         key: ConfigKey.property_buttonCaption,
         description: "The caption of the print button",
         format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_printParentChapterLevel,
+        description: "The parent chapter level to print",
+        format: TagFormat.number,
+        defaultValue: "-1"
       }
     ]
   },
@@ -7393,6 +7415,39 @@ var BITS = {
       }
     ]
   },
+  [BitType.printBook]: {
+    since: "5.5.0",
+    baseBitType: BitType.article,
+    description: "Print book bit, used to create pages that open books without author information in articles or books",
+    tags: [
+      {
+        key: ConfigKey.property_slug,
+        description: "Slug for the book, used to identify the book in the system",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_book,
+        description: "Book reference for the page, used to link to a specific book",
+        format: TagFormat.plainText,
+        chain: [
+          {
+            key: ConfigKey.tag_reference,
+            description: "Reference tag for the book, used to link to the book in the system",
+            maxCount: 2
+          }
+        ]
+      },
+      {
+        /* Allow incorrectly chained reference tag */
+        key: ConfigKey.tag_reference,
+        description: "Reference tag for the book, used to link to the book in the system"
+      },
+      {
+        key: ConfigKey.property_buttonCaption,
+        description: "Caption for the button, used to define the text displayed on the button"
+      }
+    ]
+  },
   [BitType.openBookChapter]: {
     since: "4.16.0",
     baseBitType: BitType.pageOpenBook,
@@ -10288,7 +10343,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "5.4.0",
+  "version": "5.6.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -10649,6 +10704,8 @@ var NodeType = {
   alignment: "alignment",
   allowedBit: "allowedBit",
   allowedBitValue: "allowedBitValue",
+  allowPrint: "allowPrint",
+  allowPrintValue: "allowPrintValue",
   alt: "alt",
   alternativeAnswers: "alternativeAnswers",
   alternativeAnswersValue: "alternativeAnswersValue",
@@ -10911,6 +10968,8 @@ var NodeType = {
   hasPrintRestrictionValue: "hasPrintRestrictionValue",
   enforceUpdateOverUserInput: "enforceUpdateOverUserInput",
   enforceUpdateOverUserInputValue: "enforceUpdateOverUserInputValue",
+  extractorExtractionTimestamp: "extractorExtractionTimestamp",
+  extractorExtractionTimestampValue: "extractorExtractionTimestampValue",
   isCaseSensitive: "isCaseSensitive",
   isCommented: "isCommented",
   isCorrect: "isCorrect",
@@ -11014,6 +11073,8 @@ var NodeType = {
   pageNumber: "pageNumber",
   pageNumberValue: "pageNumberValue",
   pageValue: "pageValue",
+  printParentChapterLevel: "printParentChapterLevel",
+  printParentChapterLevelValue: "printParentChapterLevelValue",
   pairs: "pairs",
   pairsValue: "pairsValue",
   parent: "parent",
@@ -24793,6 +24854,12 @@ var Builder = class extends BaseBuilder {
         data.enforceUpdateOverUserInput,
         options
       ),
+      extractorExtractionTimestamp: this.toAstProperty(
+        bitType,
+        ConfigKey.property_extractorExtractionTimestamp,
+        data.extractorExtractionTimestamp,
+        options
+      ),
       tocResource: this.toAstProperty(
         bitType,
         ConfigKey.property_tocResource,
@@ -24806,6 +24873,18 @@ var Builder = class extends BaseBuilder {
         options
       ),
       page: this.toAstProperty(bitType, ConfigKey.property_page, data.page, options),
+      allowPrint: this.toAstProperty(
+        bitType,
+        ConfigKey.property_allowPrint,
+        data.allowPrint,
+        options
+      ),
+      printParentChapterLevel: this.toAstProperty(
+        bitType,
+        ConfigKey.property_printParentChapterLevel,
+        data.printParentChapterLevel,
+        options
+      ),
       platformBrandTarget: this.toAstProperty(
         bitType,
         ConfigKey.property_platformBrandTarget,
@@ -30476,6 +30555,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
         BitType.pageFooter,
         BitType.pageOpenBook,
         BitType.pagePerson,
+        BitType.printBook,
         BitType.pageProduct,
         BitType.pageProductList,
         BitType.pageProductVideo,
@@ -30496,8 +30576,12 @@ var JsonGenerator = class extends AstWalkerGenerator {
       if (instance2.isOfBitType(bitType, BitType.tocContent)) {
         if (bitJson.tocContent == null) bitJson.tocContent = [];
       }
+      if (instance2.isOfBitType(bitType, BitType.printThisChapter)) {
+        if (bitJson.printParentChapterLevel == null) bitJson.printParentChapterLevel = -1;
+      }
       if (instance2.isOfBitType(bitType, BitType.book)) {
         if (bitJson.maxTocChapterLevel == null) bitJson.maxTocChapterLevel = -1;
+        if (bitJson.allowPrint == null) bitJson.allowPrint = false;
         if (bitJson.hasPrintRestriction == null) bitJson.hasPrintRestriction = true;
         if (bitJson.enforceUpdateOverUserInput == null) bitJson.enforceUpdateOverUserInput = false;
         if (bitJson.hasMarkAsDone == null) bitJson.hasMarkAsDone = false;