@gmb/bitmark-parser-generator 5.3.2 → 5.5.0

package/dist/index.cjs

@@ -489,6 +489,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",
@@ -517,6 +518,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",
@@ -1299,6 +1303,7 @@ var propertyKeys = {
   property_internalPrintPdf: "@internalPrintPdf",
   property_hasPrintRestriction: "@hasPrintRestriction",
   property_enforceUpdateOverUserInput: "@enforceUpdateOverUserInput",
+  property_extractorExtractionTimestamp: "@extractorExtractionTimestamp",
   property_isCaseSensitive: "@isCaseSensitive",
   property_isInfoOnly: "@isInfoOnly",
   property_isPublic: "@isPublic",
@@ -1336,6 +1341,7 @@ var propertyKeys = {
   property_mute: "@mute",
   property_padletId: "@padletId",
   property_page: "@page",
+  property_printParentChapterLevel: "@printParentChapterLevel",
   property_pageNo: "@pageNo",
   property_partialAnswer: "@partialAnswer",
   property_partner: "@partner",
@@ -3475,6 +3481,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
       }
     ]
   },
@@ -6850,6 +6862,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,
@@ -7422,6 +7469,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,
@@ -10317,7 +10397,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"
@@ -10940,6 +11020,8 @@ var NodeType = {
   hasPrintRestrictionValue: "hasPrintRestrictionValue",
   enforceUpdateOverUserInput: "enforceUpdateOverUserInput",
   enforceUpdateOverUserInputValue: "enforceUpdateOverUserInputValue",
+  extractorExtractionTimestamp: "extractorExtractionTimestamp",
+  extractorExtractionTimestampValue: "extractorExtractionTimestampValue",
   isCaseSensitive: "isCaseSensitive",
   isCommented: "isCommented",
   isCorrect: "isCorrect",
@@ -11043,6 +11125,8 @@ var NodeType = {
   pageNumber: "pageNumber",
   pageNumberValue: "pageNumberValue",
   pageValue: "pageValue",
+  printParentChapterLevel: "printParentChapterLevel",
+  printParentChapterLevelValue: "printParentChapterLevelValue",
   pairs: "pairs",
   pairsValue: "pairsValue",
   parent: "parent",
@@ -24822,6 +24906,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,
@@ -24835,6 +24925,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,
@@ -30505,6 +30601,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
         BitType.pageFooter,
         BitType.pageOpenBook,
         BitType.pagePerson,
+        BitType.printBook,
         BitType.pageProduct,
         BitType.pageProductList,
         BitType.pageProductVideo,
@@ -30525,6 +30622,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;
@@ -38996,6 +39096,7 @@ var JsonFileGenerator = class {
 var import_node_path3 = __toESM(require("path"), 1);
 var import_superenum50 = require("@ncoderz/superenum");
 var import_fs_extra3 = __toESM(require("fs-extra"), 1);
+var normalizeCardKey = (cardSetKey) => stringUtils.camelToKebab(cardSetKey);
 var ConfigBuilder = class {
   build(options) {
     const opts = Object.assign({}, options);
@@ -39036,8 +39137,10 @@ var ConfigBuilder = class {
     const outputFolder = opts.outputDir ?? "assets/config";
     const outputFolderBits = import_node_path3.default.join(outputFolder, "bits");
     const outputFolderGroups = import_node_path3.default.join(outputFolder, "partials");
+    const outputFolderCards = import_node_path3.default.join(outputFolder, "cards");
     import_fs_extra3.default.ensureDirSync(outputFolderBits);
     import_fs_extra3.default.ensureDirSync(outputFolderGroups);
+    import_fs_extra3.default.ensureDirSync(outputFolderCards);
     const bitsFiles = import_fs_extra3.default.readdirSync(outputFolderBits).filter((f) => f.endsWith(".jsonc"));
     for (const file of bitsFiles) {
       import_fs_extra3.default.removeSync(import_node_path3.default.join(outputFolderBits, file));
@@ -39046,7 +39149,18 @@ var ConfigBuilder = class {
     for (const file of partialsFiles) {
       import_fs_extra3.default.removeSync(import_node_path3.default.join(outputFolderGroups, file));
     }
+    const cardsFiles = import_fs_extra3.default.readdirSync(outputFolderCards).filter((f) => f.endsWith(".jsonc"));
+    for (const file of cardsFiles) {
+      import_fs_extra3.default.removeSync(import_node_path3.default.join(outputFolderCards, file));
+    }
     const fileWrites = [];
+    const tagEntriesTypeOrder = [
+      BitTagConfigKeyType.tag,
+      BitTagConfigKeyType.property,
+      BitTagConfigKeyType.resource,
+      BitTagConfigKeyType.group,
+      BitTagConfigKeyType.unknown
+    ];
     const resolveGroupReferences = (groupKey) => {
       if (squashedGroups.has(groupKey)) {
         const replacements = squashedGroups.get(groupKey);
@@ -39151,6 +39265,38 @@ var ConfigBuilder = class {
       tags2.push(t);
       return tags2;
     };
+    const serializeCardSet = (cardSetKey) => {
+      const cardSetConfig = CARDSETS[cardSetKey];
+      if (!cardSetConfig) return void 0;
+      const normalizedKey = normalizeCardKey(cardSetKey);
+      const sides = cardSetConfig.variants.map((variantList) => {
+        const variants = variantList.map((variant) => {
+          const variantTags = [];
+          const variantTagEntries = Object.entries(variant.tags ?? []).sort((a, b) => {
+            const tagA = a[1];
+            const tagB = b[1];
+            const typeA = typeFromConfigKey(tagA.key);
+            const typeB = typeFromConfigKey(tagB.key);
+            const typeOrder = tagEntriesTypeOrder.indexOf(typeA) - tagEntriesTypeOrder.indexOf(typeB);
+            return typeOrder;
+          });
+          for (const [, variantTag] of variantTagEntries) {
+            variantTags.push(...processTagEntries(variantTag, []));
+          }
+          return {
+            tags: variantTags,
+            repeatCount: variant.repeatCount ?? 1,
+            bodyAllowed: variant.bodyAllowed ?? true,
+            bodyRequired: variant.bodyRequired ?? false
+          };
+        });
+        return { variants };
+      });
+      return {
+        key: normalizedKey,
+        sides
+      };
+    };
     for (const bt of bitGroupConfigKeys) {
       const bitType = instance2.getBitType(bt);
       const _bitConfig = BITS[bitType];
@@ -39183,13 +39329,6 @@ var ConfigBuilder = class {
     for (const b of bitConfigs) {
       const resolvedBitConfig = instance2.getBitConfig(b.bitType);
       const tags2 = [];
-      const tagEntriesTypeOrder = [
-        BitTagConfigKeyType.tag,
-        BitTagConfigKeyType.property,
-        BitTagConfigKeyType.resource,
-        BitTagConfigKeyType.group,
-        BitTagConfigKeyType.unknown
-      ];
       const tagEntries = Object.entries(b.tags ?? []).sort((a, b2) => {
         const tagA = a[1];
         const tagB = b2[1];
@@ -39221,6 +39360,10 @@ var ConfigBuilder = class {
           tags2.push(...processTagEntries(tag, []));
         }
       }
+      let cardRef;
+      if (b.cardSet && CARDSETS[b.cardSet]) {
+        cardRef = normalizeCardKey(b.cardSet);
+      }
       const bitJson = {
         name: b.bitType,
         description: b.description ?? "",
@@ -39238,7 +39381,8 @@ var ConfigBuilder = class {
         footerAllowed: resolvedBitConfig.footerAllowed ?? true,
         footerRequired: resolvedBitConfig.footerRequired ?? false,
         resourceAttachmentAllowed: resolvedBitConfig.resourceAttachmentAllowed ?? true,
-        tags: tags2
+        tags: tags2,
+        ...cardRef ? { card: cardRef } : {}
       };
       const output = import_node_path3.default.join(outputFolderBits, `${b.bitType}.jsonc`);
       const str = JSON.stringify(bitJson, null, 2);
@@ -39248,7 +39392,7 @@ var ConfigBuilder = class {
       for (const g of groupConfigs2) {
         const tags2 = [];
         const groupKey = stringUtils.camelToKebab(g.key);
-        const tagEntriesTypeOrder = [
+        const tagEntriesTypeOrder2 = [
           BitTagConfigKeyType.tag,
           BitTagConfigKeyType.property,
           BitTagConfigKeyType.resource,
@@ -39257,7 +39401,7 @@ var ConfigBuilder = class {
         const tagEntries = Object.entries(g.tags ?? []).sort((a, b) => {
           const tagA = a[1];
           const tagB = b[1];
-          const typeOrder = tagEntriesTypeOrder.indexOf(tagA.type) - tagEntriesTypeOrder.indexOf(tagB.type);
+          const typeOrder = tagEntriesTypeOrder2.indexOf(tagA.type) - tagEntriesTypeOrder2.indexOf(tagB.type);
           return typeOrder;
         });
         for (const [_tagKey, tag] of tagEntries) {
@@ -39305,6 +39449,15 @@ var ConfigBuilder = class {
       }
     };
     writeGroupConfigs(groupConfigs);
+    const writeCardConfigs = () => {
+      for (const cardSetKey of Object.keys(CARDSETS)) {
+        const cardJson = serializeCardSet(cardSetKey);
+        if (!cardJson) continue;
+        const output = import_node_path3.default.join(outputFolderCards, `${cardJson.key}.jsonc`);
+        const str = JSON.stringify(cardJson, null, 2);
+        fileWrites.push(import_fs_extra3.default.writeFile(output, str));
+      }
+    };
     const writeBitsAsGroupConfigs = (bitsAsGroupConfigs) => {
       for (const b of bitsAsGroupConfigs) {
         const groupKey = `group-${b.bitType}`;
@@ -39321,13 +39474,6 @@ var ConfigBuilder = class {
             });
           }
         }
-        const tagEntriesTypeOrder = [
-          BitTagConfigKeyType.tag,
-          BitTagConfigKeyType.property,
-          BitTagConfigKeyType.resource,
-          BitTagConfigKeyType.group,
-          BitTagConfigKeyType.unknown
-        ];
         const tagEntries = Object.entries(b.tags ?? []).sort((a, b2) => {
           const tagA = a[1];
           const tagB = b2[1];
@@ -39358,6 +39504,7 @@ var ConfigBuilder = class {
       }
     };
     writeBitsAsGroupConfigs(bitGroupConfigs);
+    writeCardConfigs();
     Promise.all(fileWrites).then(() => {
       const validationErrors = this.validateConfigTree(outputFolder);
       if (validationErrors.length > 0) {
@@ -39383,6 +39530,7 @@ var ConfigBuilder = class {
     const errors = [];
     const outputFolderBits = import_node_path3.default.join(outputFolder, "bits");
     const outputFolderGroups = import_node_path3.default.join(outputFolder, "partials");
+    const outputFolderCards = import_node_path3.default.join(outputFolder, "cards");
     const availableGroups = /* @__PURE__ */ new Set();
     if (import_fs_extra3.default.existsSync(outputFolderGroups)) {
       const groupFiles = import_fs_extra3.default.readdirSync(outputFolderGroups).filter((f) => f.endsWith(".jsonc"));
@@ -39391,16 +39539,22 @@ var ConfigBuilder = class {
         availableGroups.add(groupName);
       }
     }
+    const availableCards = /* @__PURE__ */ new Set();
+    const cardFiles = import_fs_extra3.default.existsSync(outputFolderCards) ? import_fs_extra3.default.readdirSync(outputFolderCards).filter((f) => f.endsWith(".jsonc")) : [];
+    for (const file of cardFiles) {
+      const cardName = file.replace(".jsonc", "");
+      availableCards.add(cardName);
+    }
     const checkTags = (tags2, filePath, lineOffset) => {
       for (let i = 0; i < tags2.length; i++) {
         const tag = tags2[i];
-        if (tag.type === "group") {
+        if (tag?.type === "group" && tag.key) {
           if (!availableGroups.has(tag.key)) {
             const line = lineOffset + i + 1;
             errors.push(`Missing group reference '${tag.key}' in ${filePath}:${line}`);
           }
         }
-        if (tag.tags && Array.isArray(tag.tags)) {
+        if (Array.isArray(tag?.tags)) {
           checkTags(tag.tags, filePath, lineOffset + i + 1);
         }
       }
@@ -39415,6 +39569,27 @@ var ConfigBuilder = class {
           if (config.tags && Array.isArray(config.tags)) {
             checkTags(config.tags, `bits/${file}`, 15);
           }
+          if (typeof config.card === "string") {
+            if (!availableCards.has(config.card)) {
+              errors.push(`Missing card file '${config.card}' referenced in bits/${file}`);
+            }
+          } else if (config.card?.sides && Array.isArray(config.card.sides)) {
+            config.card.sides.forEach((side, sideIdx) => {
+              const variants = side.variants;
+              if (Array.isArray(variants)) {
+                variants.forEach((variant, variantIdx) => {
+                  const variantTags = variant.tags;
+                  if (Array.isArray(variantTags)) {
+                    checkTags(
+                      variantTags,
+                      `bits/${file} (card side ${sideIdx}, variant ${variantIdx})`,
+                      15
+                    );
+                  }
+                });
+              }
+            });
+          }
         } catch (err) {
           errors.push(`Failed to parse ${file}: ${err}`);
         }
@@ -39435,6 +39610,38 @@ var ConfigBuilder = class {
         }
       }
     }
+    if (cardFiles.length > 0) {
+      for (const file of cardFiles) {
+        const filePath = import_node_path3.default.join(outputFolderCards, file);
+        try {
+          const content = import_fs_extra3.default.readFileSync(filePath, "utf-8");
+          const config = JSON.parse(content);
+          const expectedKey = file.replace(".jsonc", "");
+          if (config.key && config.key !== expectedKey) {
+            errors.push(`Card key mismatch in cards/${file}: expected '${expectedKey}'`);
+          }
+          if (Array.isArray(config.sides)) {
+            config.sides.forEach((side, sideIdx) => {
+              const variants = side.variants;
+              if (Array.isArray(variants)) {
+                variants.forEach((variant, variantIdx) => {
+                  const variantTags = variant.tags;
+                  if (Array.isArray(variantTags)) {
+                    checkTags(
+                      variantTags,
+                      `cards/${file} (side ${sideIdx}, variant ${variantIdx})`,
+                      10
+                    );
+                  }
+                });
+              }
+            });
+          }
+        } catch (err) {
+          errors.push(`Failed to parse cards/${file}: ${err}`);
+        }
+      }
+    }
     return errors;
   }
   // Build flat bit configs
@@ -39529,6 +39736,11 @@ var ConfigBuilder = class {
       for (const [_tagKey, tag] of tagEntries) {
         tags2.push(...processTagEntries(tag));
       }
+      let cardRef;
+      const cardSetKey = b.cardSet?.configKey;
+      if (cardSetKey && CARDSETS[cardSetKey]) {
+        cardRef = normalizeCardKey(cardSetKey);
+      }
       const bitJson = {
         name: b.bitType,
         description: "",
@@ -39546,7 +39758,8 @@ var ConfigBuilder = class {
         footerAllowed: b.footerAllowed ?? true,
         footerRequired: b.footerRequired ?? false,
         resourceAttachmentAllowed: b.resourceAttachmentAllowed ?? true,
-        tags: tags2
+        tags: tags2,
+        ...cardRef ? { card: cardRef } : {}
       };
       const output = import_node_path3.default.join(outputFolderBits, `${b.bitType}.jsonc`);
       const str = JSON.stringify(bitJson, null, 2);