@gmb/bitmark-parser-generator 5.3.2 → 5.5.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";
@@ -447,6 +448,9 @@ declare const BitType: {
     readonly platformSectionInput: "platform-section-input";
     readonly platformSystemIcon: "platform-system-icon";
     readonly preparationNote: "preparation-note";
+    readonly printThisBook: "print-this-book";
+    readonly printThisChapter: "print-this-chapter";
+    readonly printPageBreak: "print-page-break";
     readonly pronunciationTable: "pronunciation-table";
     readonly prototypeImages: "prototype-images";
     readonly qAndA: "q-and-a";
@@ -813,6 +817,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";
@@ -850,6 +855,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";
@@ -1788,10 +1794,12 @@ interface BitJson {
     maxCreatedBits: number;
     maxDisplayLevel: number;
     maxTocChapterLevel: number;
+    printParentChapterLevel: number;
     sourceDocument: string;
     internalPrintPdf: string;
     hasPrintRestriction: boolean;
     enforceUpdateOverUserInput: boolean;
+    extractorExtractionTimestamp: string[];
     tocResource: string | string[];
     tocContent: string | string[];
     page: string;
@@ -2405,9 +2413,11 @@ interface Bit {
     internalPrintPdf?: Property;
     hasPrintRestriction?: Property;
     enforceUpdateOverUserInput?: Property;
+    extractorExtractionTimestamp?: Property;
     tocResource?: Property;
     tocContent?: Property;
     page?: Property;
+    printParentChapterLevel?: Property;
     platformBrandTarget?: Property;
     platformName?: Property;
     platformIcon?: ImageResourceWrapperJson;
@@ -2813,6 +2823,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";
@@ -2915,6 +2927,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";
@@ -4211,9 +4225,11 @@ declare class Builder extends BaseBuilder {
         internalPrintPdf?: string;
         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";
@@ -447,6 +448,9 @@ declare const BitType: {
     readonly platformSectionInput: "platform-section-input";
     readonly platformSystemIcon: "platform-system-icon";
     readonly preparationNote: "preparation-note";
+    readonly printThisBook: "print-this-book";
+    readonly printThisChapter: "print-this-chapter";
+    readonly printPageBreak: "print-page-break";
     readonly pronunciationTable: "pronunciation-table";
     readonly prototypeImages: "prototype-images";
     readonly qAndA: "q-and-a";
@@ -813,6 +817,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";
@@ -850,6 +855,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";
@@ -1788,10 +1794,12 @@ interface BitJson {
     maxCreatedBits: number;
     maxDisplayLevel: number;
     maxTocChapterLevel: number;
+    printParentChapterLevel: number;
     sourceDocument: string;
     internalPrintPdf: string;
     hasPrintRestriction: boolean;
     enforceUpdateOverUserInput: boolean;
+    extractorExtractionTimestamp: string[];
     tocResource: string | string[];
     tocContent: string | string[];
     page: string;
@@ -2405,9 +2413,11 @@ interface Bit {
     internalPrintPdf?: Property;
     hasPrintRestriction?: Property;
     enforceUpdateOverUserInput?: Property;
+    extractorExtractionTimestamp?: Property;
     tocResource?: Property;
     tocContent?: Property;
     page?: Property;
+    printParentChapterLevel?: Property;
     platformBrandTarget?: Property;
     platformName?: Property;
     platformIcon?: ImageResourceWrapperJson;
@@ -2813,6 +2823,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";
@@ -2915,6 +2927,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";
@@ -4211,9 +4225,11 @@ declare class Builder extends BaseBuilder {
         internalPrintPdf?: string;
         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",
@@ -456,6 +457,9 @@ var BitType = {
   platformSectionInput: "platform-section-input",
   platformSystemIcon: "platform-system-icon",
   preparationNote: "preparation-note",
+  printThisBook: "print-this-book",
+  printThisChapter: "print-this-chapter",
+  printPageBreak: "print-page-break",
   pronunciationTable: "pronunciation-table",
   prototypeImages: "prototype-images",
   qAndA: "q-and-a",
@@ -1238,6 +1242,7 @@ var propertyKeys = {
   property_internalPrintPdf: "@internalPrintPdf",
   property_hasPrintRestriction: "@hasPrintRestriction",
   property_enforceUpdateOverUserInput: "@enforceUpdateOverUserInput",
+  property_extractorExtractionTimestamp: "@extractorExtractionTimestamp",
   property_isCaseSensitive: "@isCaseSensitive",
   property_isInfoOnly: "@isInfoOnly",
   property_isPublic: "@isPublic",
@@ -1275,6 +1280,7 @@ var propertyKeys = {
   property_mute: "@mute",
   property_padletId: "@padletId",
   property_page: "@page",
+  property_printParentChapterLevel: "@printParentChapterLevel",
   property_pageNo: "@pageNo",
   property_partialAnswer: "@partialAnswer",
   property_partner: "@partner",
@@ -3414,6 +3420,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
       }
     ]
   },
@@ -6789,6 +6801,41 @@ var BITS = {
     baseBitType: BitType.article,
     description: "Preparation note bit, used to provide preparation notes in articles or books"
   },
+  [BitType.printThisBook]: {
+    since: "5.4.0",
+    baseBitType: BitType._standard,
+    description: "Print this book bit, used to create a button that prints the entire book",
+    tags: [
+      {
+        key: ConfigKey.property_buttonCaption,
+        description: "The caption of the print button",
+        format: TagFormat.plainText
+      }
+    ]
+  },
+  [BitType.printThisChapter]: {
+    since: "5.4.0",
+    baseBitType: BitType._standard,
+    description: "Print this chapter bit, used to create a button that prints the current chapter",
+    tags: [
+      {
+        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"
+      }
+    ]
+  },
+  [BitType.printPageBreak]: {
+    since: "5.4.0",
+    baseBitType: BitType.separator,
+    description: "Print page break bit, used to create page breaks for printing in articles or books"
+  },
   [BitType.releaseNotesSummary]: {
     since: "1.3.0",
     baseBitType: BitType.article,
@@ -7361,6 +7408,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,
@@ -10256,7 +10336,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "5.3.2",
+  "version": "5.5.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -10879,6 +10959,8 @@ var NodeType = {
   hasPrintRestrictionValue: "hasPrintRestrictionValue",
   enforceUpdateOverUserInput: "enforceUpdateOverUserInput",
   enforceUpdateOverUserInputValue: "enforceUpdateOverUserInputValue",
+  extractorExtractionTimestamp: "extractorExtractionTimestamp",
+  extractorExtractionTimestampValue: "extractorExtractionTimestampValue",
   isCaseSensitive: "isCaseSensitive",
   isCommented: "isCommented",
   isCorrect: "isCorrect",
@@ -10982,6 +11064,8 @@ var NodeType = {
   pageNumber: "pageNumber",
   pageNumberValue: "pageNumberValue",
   pageValue: "pageValue",
+  printParentChapterLevel: "printParentChapterLevel",
+  printParentChapterLevelValue: "printParentChapterLevelValue",
   pairs: "pairs",
   pairsValue: "pairsValue",
   parent: "parent",
@@ -24761,6 +24845,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,
@@ -24774,6 +24864,12 @@ var Builder = class extends BaseBuilder {
         options
       ),
       page: this.toAstProperty(bitType, ConfigKey.property_page, data.page, options),
+      printParentChapterLevel: this.toAstProperty(
+        bitType,
+        ConfigKey.property_printParentChapterLevel,
+        data.printParentChapterLevel,
+        options
+      ),
       platformBrandTarget: this.toAstProperty(
         bitType,
         ConfigKey.property_platformBrandTarget,
@@ -30444,6 +30540,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
         BitType.pageFooter,
         BitType.pageOpenBook,
         BitType.pagePerson,
+        BitType.printBook,
         BitType.pageProduct,
         BitType.pageProductList,
         BitType.pageProductVideo,
@@ -30464,6 +30561,9 @@ 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.hasPrintRestriction == null) bitJson.hasPrintRestriction = true;