@gmb/bitmark-parser-generator 5.9.0 → 5.10.0

package/dist/index.cjs

@@ -752,8 +752,10 @@ var TagFormat = {
   // If the value is treated as a number
   boolean: "boolean",
   // If the value is treated as a boolean
-  invertedBoolean: "invertedBoolean"
+  invertedBoolean: "invertedBoolean",
   // If the value is treated as a boolean with the value inverted (e.g. isLongAnswer ==> isShortAnswer = false)
+  enumeration: "enumeration"
+  // If the value is treated as an enumeration (the value is a string that must be one of a predefined set of values)
 };
 
 // src/model/enum/TextFormat.ts
@@ -897,9 +899,12 @@ var PropertyTagConfig = class extends AbstractTagConfig {
     // If the property is treated as an array rather than a single value
     __publicField(this, "format");
     // How the property is formatted
+    __publicField(this, "values");
+    // If the format is an enumeration, the possible values of the property
     __publicField(this, "defaultValue");
     this.array = params.maxCount === Count.infinity || params.maxCount > 1;
     this.format = params.format;
+    this.values = params.values;
     this.defaultValue = params.defaultValue;
   }
   toString(options) {
@@ -911,6 +916,7 @@ var PropertyTagConfig = class extends AbstractTagConfig {
       if (this.minCount != null) s += `, min=${this.minCount}`;
       if (this.array != null) s += `, arr=${this.array}`;
       if (this.format != null) s += `, fmt=${this.format}`;
+      if (this.values != null) s += `, vals=[${this.values.join(",")}]`;
       if (this.defaultValue != null) s += `, def=${this.defaultValue}`;
       if (this.jsonKey != null) s += `, json=${this.jsonKey}`;
     }
@@ -1204,7 +1210,6 @@ var propertyKeys = {
   property_aiGenerated: "@aiGenerated",
   property_allowedBit: "@allowedBit",
   property_allowPrint: "@allowPrint",
-  property_allowPrintEnforceSpaceConfiguration: "@allowPrintEnforceSpaceConfiguration",
   property_allowSubtitles: "@allowSubtitles",
   property_alt: "@alt",
   property_altLangTag: "@altLangTag",
@@ -2524,27 +2529,6 @@ var CARDSETS = {
     ]
   },
   [CardSetConfigKey.table]: {
-    variants: [
-      // Side 1
-      [
-        // Variant 1..N
-        {
-          tags: [
-            {
-              key: ConfigKey.group_standardItemLeadInstructionHint,
-              description: "Standard tags for lead, instruction, and hint."
-            },
-            {
-              key: ConfigKey.tag_title,
-              description: "Title of the table."
-            }
-          ],
-          repeatCount: Count.infinity
-        }
-      ]
-    ]
-  },
-  [CardSetConfigKey.tableExtended]: {
     variants: [
       // Side 1
       [
@@ -3506,14 +3490,9 @@ var GROUPS = {
       {
         key: ConfigKey.property_allowPrint,
         description: "If true, the book allows printing",
-        format: TagFormat.boolean,
-        defaultValue: "false"
-      },
-      {
-        key: ConfigKey.property_allowPrintEnforceSpaceConfiguration,
-        description: "If true, enforces space configuration for printing regardless of the allowPrint setting",
-        format: TagFormat.boolean,
-        defaultValue: "false"
+        format: TagFormat.enumeration,
+        values: ["enforceFalse", "enforceTrue", "useSpaceConfiguration"],
+        defaultValue: "enforceFalse"
       },
       {
         key: ConfigKey.property_hasPrintRestriction,
@@ -4489,6 +4468,7 @@ var ConfigHydrator = class {
       chain: _chain,
       deprecated,
       format,
+      values,
       defaultValue,
       jsonKey
     } = _tag;
@@ -4507,6 +4487,7 @@ var ConfigHydrator = class {
       chain,
       jsonKey,
       format,
+      values,
       defaultValue,
       deprecated
     });
@@ -7910,15 +7891,35 @@ var BITS = {
   },
   [BitType.tableImage]: {
     since: "1.5.15",
-    baseBitType: BitType.image,
+    baseBitType: BitType.table,
     description: "Table image bit, used to create images in tables in articles or books",
     tags: [
       {
         key: ConfigKey.property_caption,
         description: "Caption for the table image, used to provide a description for the image",
         format: TagFormat.bitmarkText
+      },
+      {
+        key: ConfigKey.resource_backgroundWallpaper,
+        description: "Background wallpaper for the image, used to set a background for the image",
+        chain: [
+          {
+            key: ConfigKey.group_resourceImageCommon,
+            description: "Common resource image tags for images"
+          }
+        ]
+      },
+      {
+        key: ConfigKey.group_resourceBitTags,
+        description: "Resource bit tags for images, used to define additional properties for images"
+      },
+      {
+        key: ConfigKey.group_resourceImage,
+        description: "Resource image tags for images, used to attach images to the bit",
+        minCount: 1
       }
-    ]
+    ],
+    resourceAttachmentAllowed: false
   },
   [BitType.tableImageAlt]: {
     since: "1.16.0",
@@ -9438,8 +9439,7 @@ var BITS = {
   [BitType.tableExtended]: {
     since: "4.14.0",
     baseBitType: BitType.table,
-    description: "Extended table bit, used to create complex tables with all HTML table features",
-    cardSet: CardSetConfigKey.tableExtended
+    description: "Extended table bit, used to create complex tables with all HTML table features"
   },
   [BitType.tableAlt]: {
     since: "1.16.0",
@@ -10463,7 +10463,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "5.9.0",
+  "version": "5.10.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -11084,6 +11084,8 @@ var NodeType = {
   indexValue: "indexValue",
   ingredients: "ingredients",
   ingredientsValue: "ingredientsValue",
+  ingredient: "ingredient",
+  ingredientValue: "ingredientValue",
   instruction: "instruction",
   instructionValue: "instructionValue",
   internalComment: "internalComment",
@@ -11396,6 +11398,7 @@ var NodeType = {
   srcAltValue: "srcAltValue",
   start: "start",
   statement: "statement",
+  statementValue: "statementValue",
   statements: "statements",
   statementsValue: "statementsValue",
   statementText: "statementText",
@@ -12062,7 +12065,7 @@ function normalizeTableFormat(bitType, table) {
     delete t.columns;
     delete t.data;
   }
-  const isExtended = instance2.isOfBitType(bitType, BitType.tableExtended);
+  const isExtended = instance2.isOfBitType(bitType, BitType.tableExtended) || instance2.isOfBitType(bitType, BitType.tableImage);
   if (isExtended && isTableBasicFormat(table)) {
     return convertBasicToExtendedTableFormat(table);
   }
@@ -25026,12 +25029,6 @@ var Builder = class extends BaseBuilder {
         data.allowPrint,
         options
       ),
-      allowPrintEnforceSpaceConfiguration: this.toAstProperty(
-        bitType,
-        ConfigKey.property_allowPrintEnforceSpaceConfiguration,
-        data.allowPrintEnforceSpaceConfiguration,
-        options
-      ),
       printParentChapterLevel: this.toAstProperty(
         bitType,
         ConfigKey.property_printParentChapterLevel,
@@ -27404,7 +27401,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     if (parent?.key !== NodeType.bitsValue) return true;
     for (const gt of groupTag) {
       const { name, tags: tags2 } = gt;
-      this.writeNL();
       this.writeProperty("groupTag", name, route, {
         format: TagFormat.plainText,
         writeEmpty: true
@@ -27413,7 +27409,8 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
         for (const t of tags2) {
           this.writeProperty("tag", t, route, {
             format: TagFormat.plainText,
-            writeEmpty: true
+            writeEmpty: true,
+            forceChain: true
           });
         }
       }
@@ -27421,7 +27418,7 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     return false;
   }
   // bitmarkAst -> bits -> bitsValue -> labelTrue / labelFalse
-  enter_labelTrue(node, route) {
+  leaf_labelTrue(node, route) {
     const value = node.value;
     const parent = this.getParentNode(route);
     if (parent?.key !== NodeType.bitsValue) return true;
@@ -27434,16 +27431,18 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
       }
       if (haveTrue)
         this.writeProperty("labelTrue", value, route, {
-          format: TagFormat.plainText
+          format: TagFormat.plainText,
+          forceChain: true
         });
       if (haveFalse)
         this.writeProperty("labelFalse", bit.labelFalse, route, {
-          format: TagFormat.plainText
+          format: TagFormat.plainText,
+          forceChain: true
         });
     }
     return false;
   }
-  enter_labelFalse(_node, _route) {
+  leaf_labelFalse(_node, _route) {
     return true;
   }
   // bitmarkAst -> bits -> bitsValue -> imageSource
@@ -27452,26 +27451,29 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     const parent = this.getParentNode(route);
     if (parent?.key !== NodeType.bitsValue) return true;
     const { url, mockupId, size, format, trim } = imageSource;
-    this.writeNL();
     this.writeProperty("imageSource", url, route, {
       format: TagFormat.plainText
     });
     if (url) {
       if (mockupId)
         this.writeProperty("mockupId", mockupId, route, {
-          format: TagFormat.plainText
+          format: TagFormat.plainText,
+          forceChain: true
         });
       if (size)
         this.writeProperty("size", size, route, {
-          format: TagFormat.plainText
+          format: TagFormat.plainText,
+          forceChain: true
         });
       if (format)
         this.writeProperty("format", format, route, {
-          format: TagFormat.plainText
+          format: TagFormat.plainText,
+          forceChain: true
         });
       if (instance5.isBoolean(trim))
         this.writeProperty("trim", trim, route, {
-          format: TagFormat.plainText
+          format: TagFormat.plainText,
+          forceChain: true
         });
     }
     return false;
@@ -27482,13 +27484,13 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     const parent = this.getParentNode(route);
     if (parent?.key !== NodeType.bitsValue) return true;
     const { technicalTerm, lang } = nodeValue;
-    this.writeNL();
     this.writeProperty("technicalTerm", technicalTerm, route, {
       format: TagFormat.plainText
     });
     if (lang != null) {
       this.writeProperty("lang", lang, route, {
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        forceChain: true
       });
     }
     return false;
@@ -27499,28 +27501,31 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     const parent = this.getParentNode(route);
     if (parent?.key !== NodeType.bitsValue) return true;
     const { servings, unit, unitAbbr, decimalPlaces, disableCalculation, hint } = nodeValue;
-    this.writeNL();
     this.writeProperty("servings", servings, route, {
       format: TagFormat.plainText
     });
     if (unit != null) {
       this.writeProperty("unit", unit, route, {
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        forceChain: true
       });
     }
     if (unitAbbr != null) {
       this.writeProperty("unitAbbr", unitAbbr, route, {
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        forceChain: true
       });
     }
     if (decimalPlaces != null) {
       this.writeProperty("decimalPlaces", decimalPlaces, route, {
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        forceChain: true
       });
     }
     if (disableCalculation != null) {
       this.writeProperty("disableCalculation", disableCalculation, route, {
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        forceChain: true
       });
     }
     if (hint != null) {
@@ -27536,13 +27541,13 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     const parent = this.getParentNode(route);
     if (parent?.key !== NodeType.bitsValue) return true;
     const { name, title, avatarImage } = person;
-    this.writeNL();
     this.writeProperty("person", name, route, {
       format: TagFormat.plainText
     });
     if (title) {
       this.writeProperty("title", title, route, {
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        forceChain: true
       });
     }
     if (avatarImage) {
@@ -27590,7 +27595,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     if (parent.key !== NodeType.term && parent.key !== NodeType.definition && parent.key !== NodeType.alternativeDefinitionsValue && parent.key !== NodeType.question && parent.key !== NodeType.answer && parent.key !== NodeType.alternativeAnswersValue) {
       return true;
     }
-    this.writeNL();
     this.writeResource(ResourceType.icon, resource.image.src);
     return true;
   }
@@ -27618,13 +27622,13 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     if (parent?.key !== NodeType.bitsValue) return true;
     const { level, label } = n;
     const levelKey = node.key === NodeType.ratingLevelStart ? "ratingLevelStart" : "ratingLevelEnd";
-    this.writeNL();
     this.writeProperty(levelKey, level, route, {
       format: TagFormat.plainText
     });
     if (label) {
       this.writeProperty("label", label, route, {
-        format: TagFormat.bitmarkText
+        format: TagFormat.bitmarkText,
+        forceChain: true
       });
     }
     return false;
@@ -27646,12 +27650,14 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
       });
       if (color) {
         this.writeProperty("color", color, route, {
-          format: TagFormat.plainText
+          format: TagFormat.plainText,
+          forceChain: true
         });
       }
       if (emphasis) {
         this.writeProperty("emphasis", emphasis, route, {
-          format: TagFormat.plainText
+          format: TagFormat.plainText,
+          forceChain: true
         });
       }
     }
@@ -27660,7 +27666,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue -> partialAnswer
   enter_partialAnswer(node, route) {
     if (node.value) {
-      this.writeNL();
       this.writeProperty("partialAnswer", node.value, route, {
         format: TagFormat.plainText
       });
@@ -27670,7 +27675,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue -> questions -> questionsValue -> partialAnswer
   leaf_partialAnswer(node, route) {
     if (node.value) {
-      this.writeNL();
       this.writeProperty("partialAnswer", node.value, route, {
         format: TagFormat.plainText
       });
@@ -27681,7 +27685,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue -> questions -> questionsValue -> sampleSolution
   enter_sampleSolution(node, route) {
     if (node.value) {
-      this.writeNL();
       this.writeProperty("sampleSolution", node.value, route, {
         format: TagFormat.plainText
       });
@@ -27690,7 +27693,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   }
   leaf_sampleSolution(node, route) {
     if (node.value) {
-      this.writeNL();
       this.writeProperty("sampleSolution", node.value, route, {
         format: TagFormat.plainText
       });
@@ -27700,7 +27702,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue -> reasonableNumOfChars
   // bitmarkAst -> bits -> bitsValue -> questions -> questionsValue -> reasonableNumOfChars
   leaf_reasonableNumOfChars(node, route) {
-    this.writeNL();
     this.writeProperty("reasonableNumOfChars", node.value, route, {
       format: TagFormat.plainText
     });
@@ -28707,7 +28708,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue ->  * -> lang
   leaf_lang(node, route) {
     if (!node.value) return;
-    this.writeNL();
     this.writeProperty("lang", node.value, route, {
       format: TagFormat.boolean
     });
@@ -28715,7 +28715,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue ->  * -> refAuthor
   enter_refAuthor(node, route) {
     if (!node.value) return;
-    this.writeNL();
     this.writeProperty("refAuthor", node.value, route, {
       format: TagFormat.plainText,
       array: true
@@ -28724,7 +28723,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue ->  * -> refBookTitle
   leaf_refBookTitle(node, route) {
     if (!node.value) return;
-    this.writeNL();
     this.writeProperty("refBookTitle", node.value, route, {
       format: TagFormat.plainText,
       array: true
@@ -28733,7 +28731,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue ->  * -> refPublisher
   enter_refPublisher(node, route) {
     if (!node.value) return;
-    this.writeNL();
     this.writeProperty("refPublisher", node.value, route, {
       format: TagFormat.plainText,
       array: true
@@ -28742,7 +28739,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue ->  * -> refPublicationYear
   leaf_refPublicationYear(node, route) {
     if (!node.value) return;
-    this.writeNL();
     this.writeProperty("refPublicationYear", node.value, route, {
       format: TagFormat.plainText
     });
@@ -28750,7 +28746,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
   // bitmarkAst -> bits -> bitsValue ->  * -> citationStyle
   leaf_citationStyle(node, route) {
     if (!node.value) return;
-    this.writeNL();
     this.writeProperty("citationStyle", node.value, route, {
       format: TagFormat.plainText
     });
@@ -29082,7 +29077,6 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
           const config = instance2.getBitConfig(bitType);
           const propertyConfig = instance2.getTagConfigForTag(config.tags, propertyConfigKey);
           if (!propertyConfig) return;
-          this.writeNL_IfNotChain(route);
           this.writeProperty(propertyConfig.tag, node.value, route, {
             format: propertyConfig.format ?? TagFormat.plainText,
             array: propertyConfig.array ?? false,
@@ -29466,7 +29460,7 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
               if (options.ignoreFalse && val === false) continue;
               if (options.ignoreTrue && val === true) continue;
               if (!options.writeEmpty && val === "") continue;
-              if (propertyIndex > 0) this.writeNL_IfNotChain(route);
+              if (!options.forceChain && propertyIndex === 0) this.writeNL_IfNotChain(route);
               this.writeOPA();
               this.writeTagKey(name);
               this.writeColon();
@@ -30679,7 +30673,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
         if (bitJson.isTracked == null) bitJson.isTracked = true;
         if (bitJson.isInfoOnly == null) bitJson.isInfoOnly = false;
       }
-      if (instance2.isOfBitType(bitType, BitType.table)) {
+      if (instance2.isOfBitType(bitType, BitType.table) && !instance2.isOfBitType(bitType, BitType.tableImage)) {
         if (bitJson.tableFixedHeader == null) bitJson.tableFixedHeader = false;
         if (bitJson.tableHeaderWhitespaceNoWrap == null) {
           bitJson.tableHeaderWhitespaceNoWrap = false;
@@ -30694,6 +30688,11 @@ var JsonGenerator = class extends AstWalkerGenerator {
         if (bitJson.tableResizableColumns == null) bitJson.tableResizableColumns = false;
         if (bitJson.tableColumnMinWidth == null) bitJson.tableColumnMinWidth = 0;
       }
+      if (instance2.isOfBitType(bitType, BitType.tableImage)) {
+        if (this.tableIsEmpty(bitJson.table)) {
+          delete bitJson.table;
+        }
+      }
       if (instance2.isOfBitType(bitType, BitType.bookReference)) {
         if (bitJson.refAuthor == null) bitJson.refAuthor = [];
         if (bitJson.refBookTitle == null) bitJson.refBookTitle = "";
@@ -30734,7 +30733,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
       }
       if (instance2.isOfBitType(bitType, BitType.book)) {
         if (bitJson.maxTocChapterLevel == null) bitJson.maxTocChapterLevel = -1;
-        if (bitJson.allowPrint == null) bitJson.allowPrint = false;
+        if (bitJson.allowPrint == null) bitJson.allowPrint = "enforceFalse";
         if (bitJson.hasPrintRestriction == null) bitJson.hasPrintRestriction = true;
         if (bitJson.enforceUpdateOverUserInput == null) bitJson.enforceUpdateOverUserInput = false;
         if (bitJson.hasMarkAsDone == null) bitJson.hasMarkAsDone = false;
@@ -30834,6 +30833,19 @@ var JsonGenerator = class extends AstWalkerGenerator {
     }
     return bitJson;
   }
+  tableIsEmpty(table) {
+    if (!table) return true;
+    if (Object.keys(table).length === 0) return true;
+    const tableStandard = table;
+    if (tableStandard.columns?.length === 0 && tableStandard.data?.length) {
+      return true;
+    }
+    const tableExtended = table;
+    if (tableExtended.header?.rows.length === 0 && tableExtended.body?.rows.length === 0 && tableExtended.footer?.rows.length === 0) {
+      return true;
+    }
+    return false;
+  }
   /**
    * Convert any bitmark texts to strings.
    */
@@ -34463,6 +34475,7 @@ function propertyContentProcessor(context, contentDepth, tagsConfig, content, ta
         chain: void 0,
         jsonKey: void 0,
         format: TagFormat.bitmarkText,
+        values: void 0,
         defaultValue: void 0,
         deprecated: void 0
       })