@gmb/bitmark-parser-generator 5.2.0 → 5.3.1

package/dist/index.d.cts

@@ -261,6 +261,7 @@ declare const BitType: {
     readonly flashcard1: "flashcard-1";
     readonly focusImage: "focus-image";
     readonly footNote: "foot-note";
+    readonly formFreeText: "form-free-text";
     readonly formula: "formula";
     readonly gapText: "gap-text";
     readonly gapTextInstructionGrouped: "gap-text-instruction-grouped";
@@ -273,6 +274,8 @@ declare const BitType: {
     readonly handInFeedbackExpert: "hand-in-feedback-expert";
     readonly handInFeedbackSelf: "hand-in-feedback-self";
     readonly handInFile: "hand-in-file";
+    readonly handInFreeText: "hand-in-free-text";
+    readonly handInFreeTextExpert: "hand-in-free-text-expert";
     readonly handInLocation: "hand-in-location";
     readonly handInPhoto: "hand-in-photo";
     readonly handInScan: "hand-in-scan";
@@ -868,6 +871,7 @@ declare const ConfigKey: {
     readonly property_platformMargin: "@platformMargin";
     readonly property_platformBorderRadius: "@platformBorderRadius";
     readonly property_platformSelectionBorderRadius: "@platformSelectionBorderRadius";
+    readonly property_platformLogoMaxHeight: "@platformLogoMaxHeight";
     readonly property_platformNeedsShadow: "@platformNeedsShadow";
     readonly property_platformSeparatorColor: "@platformSeparatorColor";
     readonly property_platformTextSelectionColor: "@platformTextSelectionColor";
@@ -1795,6 +1799,7 @@ interface BitJson {
     platformName: string;
     platformIcon: ImageResourceWrapperJson;
     platformLogo: ImageResourceWrapperJson;
+    platformLogoMaxHeight: number;
     platformPrimaryColor: string;
     platformSecondaryColor: string;
     platformBackgroundColor: string;
@@ -2407,6 +2412,7 @@ interface Bit {
     platformName?: Property;
     platformIcon?: ImageResourceWrapperJson;
     platformLogo?: ImageResourceWrapperJson;
+    platformLogoMaxHeight?: Property;
     platformPrimaryColor?: Property;
     platformSecondaryColor?: Property;
     platformBackgroundColor?: Property;
@@ -2925,6 +2931,8 @@ declare const NodeType: {
     readonly platformIconValue: "platformIconValue";
     readonly platformLogo: "platformLogo";
     readonly platformLogoValue: "platformLogoValue";
+    readonly platformLogoMaxHeight: "platformLogoMaxHeight";
+    readonly platformLogoMaxHeightValue: "platformLogoMaxHeightValue";
     readonly platformPrimaryColor: "platformPrimaryColor";
     readonly platformPrimaryColorValue: "platformPrimaryColorValue";
     readonly platformSecondaryColor: "platformSecondaryColor";
@@ -4210,6 +4218,7 @@ declare class Builder extends BaseBuilder {
         platformName?: string;
         platformIcon?: Partial<ImageResourceWrapperJson>;
         platformLogo?: Partial<ImageResourceWrapperJson>;
+        platformLogoMaxHeight?: number;
         platformPrimaryColor?: string;
         platformSecondaryColor?: string;
         platformBackgroundColor?: string;

package/dist/index.d.ts

@@ -261,6 +261,7 @@ declare const BitType: {
     readonly flashcard1: "flashcard-1";
     readonly focusImage: "focus-image";
     readonly footNote: "foot-note";
+    readonly formFreeText: "form-free-text";
     readonly formula: "formula";
     readonly gapText: "gap-text";
     readonly gapTextInstructionGrouped: "gap-text-instruction-grouped";
@@ -273,6 +274,8 @@ declare const BitType: {
     readonly handInFeedbackExpert: "hand-in-feedback-expert";
     readonly handInFeedbackSelf: "hand-in-feedback-self";
     readonly handInFile: "hand-in-file";
+    readonly handInFreeText: "hand-in-free-text";
+    readonly handInFreeTextExpert: "hand-in-free-text-expert";
     readonly handInLocation: "hand-in-location";
     readonly handInPhoto: "hand-in-photo";
     readonly handInScan: "hand-in-scan";
@@ -868,6 +871,7 @@ declare const ConfigKey: {
     readonly property_platformMargin: "@platformMargin";
     readonly property_platformBorderRadius: "@platformBorderRadius";
     readonly property_platformSelectionBorderRadius: "@platformSelectionBorderRadius";
+    readonly property_platformLogoMaxHeight: "@platformLogoMaxHeight";
     readonly property_platformNeedsShadow: "@platformNeedsShadow";
     readonly property_platformSeparatorColor: "@platformSeparatorColor";
     readonly property_platformTextSelectionColor: "@platformTextSelectionColor";
@@ -1795,6 +1799,7 @@ interface BitJson {
     platformName: string;
     platformIcon: ImageResourceWrapperJson;
     platformLogo: ImageResourceWrapperJson;
+    platformLogoMaxHeight: number;
     platformPrimaryColor: string;
     platformSecondaryColor: string;
     platformBackgroundColor: string;
@@ -2407,6 +2412,7 @@ interface Bit {
     platformName?: Property;
     platformIcon?: ImageResourceWrapperJson;
     platformLogo?: ImageResourceWrapperJson;
+    platformLogoMaxHeight?: Property;
     platformPrimaryColor?: Property;
     platformSecondaryColor?: Property;
     platformBackgroundColor?: Property;
@@ -2925,6 +2931,8 @@ declare const NodeType: {
     readonly platformIconValue: "platformIconValue";
     readonly platformLogo: "platformLogo";
     readonly platformLogoValue: "platformLogoValue";
+    readonly platformLogoMaxHeight: "platformLogoMaxHeight";
+    readonly platformLogoMaxHeightValue: "platformLogoMaxHeightValue";
     readonly platformPrimaryColor: "platformPrimaryColor";
     readonly platformPrimaryColorValue: "platformPrimaryColorValue";
     readonly platformSecondaryColor: "platformSecondaryColor";
@@ -4210,6 +4218,7 @@ declare class Builder extends BaseBuilder {
         platformName?: string;
         platformIcon?: Partial<ImageResourceWrapperJson>;
         platformLogo?: Partial<ImageResourceWrapperJson>;
+        platformLogoMaxHeight?: number;
         platformPrimaryColor?: string;
         platformSecondaryColor?: string;
         platformBackgroundColor?: string;

package/dist/index.js

@@ -270,6 +270,7 @@ var BitType = {
   flashcard1: "flashcard-1",
   focusImage: "focus-image",
   footNote: "foot-note",
+  formFreeText: "form-free-text",
   formula: "formula",
   gapText: "gap-text",
   gapTextInstructionGrouped: "gap-text-instruction-grouped",
@@ -282,6 +283,8 @@ var BitType = {
   handInFeedbackExpert: "hand-in-feedback-expert",
   handInFeedbackSelf: "hand-in-feedback-self",
   handInFile: "hand-in-file",
+  handInFreeText: "hand-in-free-text",
+  handInFreeTextExpert: "hand-in-free-text-expert",
   handInLocation: "hand-in-location",
   handInPhoto: "hand-in-photo",
   handInScan: "hand-in-scan",
@@ -1294,6 +1297,7 @@ var propertyKeys = {
   property_platformMargin: "@platformMargin",
   property_platformBorderRadius: "@platformBorderRadius",
   property_platformSelectionBorderRadius: "@platformSelectionBorderRadius",
+  property_platformLogoMaxHeight: "@platformLogoMaxHeight",
   property_platformNeedsShadow: "@platformNeedsShadow",
   property_platformSeparatorColor: "@platformSeparatorColor",
   property_platformTextSelectionColor: "@platformTextSelectionColor",
@@ -8736,6 +8740,11 @@ var BITS = {
         ],
         maxCount: 1
       },
+      {
+        key: ConfigKey.property_platformLogoMaxHeight,
+        description: "Maximum height for the platform logo",
+        format: TagFormat.number
+      },
       {
         key: ConfigKey.group_platformStylesCommon,
         description: "Common platform styles"
@@ -9430,6 +9439,11 @@ var BITS = {
     baseBitType: BitType._standard,
     description: "Footnote bit, used to create footnotes in articles or books"
   },
+  [BitType.formFreeText]: {
+    since: "5.3.0",
+    baseBitType: BitType.interview,
+    description: "Form free text bit, used to create free text forms in articles or books"
+  },
   [BitType.groupBorn]: {
     since: "1.3.0",
     baseBitType: BitType._standard,
@@ -9489,6 +9503,16 @@ var BITS = {
       }
     ]
   },
+  [BitType.handInFreeText]: {
+    since: "5.3.0",
+    baseBitType: BitType.interview,
+    description: "Hand in free text bit, used to create free text submission sections in articles or books"
+  },
+  [BitType.handInFreeTextExpert]: {
+    since: "5.3.0",
+    baseBitType: BitType.interview,
+    description: "Hand in free text expert bit, used to create free text expert submission sections in articles or books"
+  },
   [BitType.handInLocation]: {
     since: "1.5.15",
     baseBitType: BitType._standard,
@@ -10232,7 +10256,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "5.2.0",
+  "version": "5.3.1",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -10974,6 +10998,8 @@ var NodeType = {
   platformIconValue: "platformIconValue",
   platformLogo: "platformLogo",
   platformLogoValue: "platformLogoValue",
+  platformLogoMaxHeight: "platformLogoMaxHeight",
+  platformLogoMaxHeightValue: "platformLogoMaxHeightValue",
   platformPrimaryColor: "platformPrimaryColor",
   platformPrimaryColorValue: "platformPrimaryColorValue",
   platformSecondaryColor: "platformSecondaryColor",
@@ -24762,6 +24788,12 @@ var Builder = class extends BaseBuilder {
       ),
       platformIcon: this.toImageResource(context, data.platformIcon),
       platformLogo: this.toImageResource(context, data.platformLogo),
+      platformLogoMaxHeight: this.toAstProperty(
+        bitType,
+        ConfigKey.property_platformLogoMaxHeight,
+        data.platformLogoMaxHeight,
+        options
+      ),
       platformPrimaryColor: this.toAstProperty(
         bitType,
         ConfigKey.property_platformPrimaryColor,
@@ -30516,6 +30548,9 @@ var JsonGenerator = class extends AstWalkerGenerator {
       if (instance2.isOfBitType(bitType, BitType.platformBrandTarget)) {
         if (bitJson.platformBrandTarget == null) bitJson.platformBrandTarget = "none";
       }
+      if (instance2.isOfBitType(bitType, BitType.platformHeader)) {
+        if (bitJson.platformLogoMaxHeight == null) bitJson.platformLogoMaxHeight = 40;
+      }
       if (isTopLevelExample) {
         if (bitJson.isExample == null) bitJson.isExample = false;
       } else {
@@ -32803,6 +32838,9 @@ function parseFeedback(_context, _bitType, cardSet) {
               const choice = {
                 choice: tfTags.choice,
                 requireReason: tfTags.isCorrect,
+                item: tfTags.item,
+                lead: tfTags.lead,
+                instruction: tfTags.instruction,
                 __isDefaultExample,
                 example
               };
@@ -38903,8 +38941,20 @@ var ConfigBuilder = class {
     this.buildFlat(opts);
     const bitConfigs = [];
     const groupConfigs = [];
-    const bitGroupConfigKeys = [];
+    const bitGroupConfigKeys = /* @__PURE__ */ new Set();
     const bitGroupConfigs = [];
+    for (const bt of Enum22(BitType).values()) {
+      const bitType = instance2.getBitType(bt);
+      const _bitConfig = BITS[bitType];
+      if (_bitConfig?.baseBitType) {
+        let currentBitType = _bitConfig.baseBitType;
+        while (currentBitType) {
+          bitGroupConfigKeys.add(currentBitType);
+          const parentConfig = BITS[currentBitType];
+          currentBitType = parentConfig?.baseBitType;
+        }
+      }
+    }
     for (const bt of Enum22(BitType).values()) {
       const bitType = instance2.getBitType(bt);
       const _bitConfig = BITS[bitType];
@@ -38927,7 +38977,22 @@ var ConfigBuilder = class {
     const outputFolderGroups = path3.join(outputFolder, "partials");
     fs3.ensureDirSync(outputFolderBits);
     fs3.ensureDirSync(outputFolderGroups);
+    const bitsFiles = fs3.readdirSync(outputFolderBits).filter((f) => f.endsWith(".jsonc"));
+    for (const file of bitsFiles) {
+      fs3.removeSync(path3.join(outputFolderBits, file));
+    }
+    const partialsFiles = fs3.readdirSync(outputFolderGroups).filter((f) => f.endsWith(".jsonc"));
+    for (const file of partialsFiles) {
+      fs3.removeSync(path3.join(outputFolderGroups, file));
+    }
     const fileWrites = [];
+    const resolveGroupReferences = (groupKey) => {
+      if (squashedGroups.has(groupKey)) {
+        const replacements = squashedGroups.get(groupKey);
+        return replacements.flatMap((r) => resolveGroupReferences(r));
+      }
+      return [groupKey];
+    };
     const keyToJsonKey = (key, tagNameChain) => {
       let jsonKey = key;
       if (key === "%") {
@@ -38991,10 +39056,13 @@ var ConfigBuilder = class {
         if (k.startsWith("group_")) k = k.substring(6);
         k = /*'_' +*/
         stringUtils.camelToKebab(k);
-        tags2.push({
-          type: "group",
-          key: k
-        });
+        const resolvedGroups = resolveGroupReferences(k);
+        for (const groupKey of resolvedGroups) {
+          tags2.push({
+            type: "group",
+            key: groupKey
+          });
+        }
         return tags2;
       }
       if (Array.isArray(tag.chain) && tag.chain.length > 0) {
@@ -39022,7 +39090,37 @@ var ConfigBuilder = class {
       tags2.push(t);
       return tags2;
     };
+    for (const bt of bitGroupConfigKeys) {
+      const bitType = instance2.getBitType(bt);
+      const _bitConfig = BITS[bitType];
+      if (_bitConfig) {
+        _bitConfig.bitType = bitType;
+        if (!bitGroupConfigs.some((c) => c.bitType === bitType)) {
+          bitGroupConfigs.push(_bitConfig);
+        }
+      }
+    }
+    const squashedGroups = /* @__PURE__ */ new Map();
+    for (const b of bitGroupConfigs) {
+      const groupKey = `group-${b.bitType}`;
+      const processedTags = [];
+      for (const [, tag] of Object.entries(b.tags ?? [])) {
+        processedTags.push(...processTagEntries(tag, []));
+      }
+      const allAreGroups = processedTags.every((t) => t.type === "group");
+      if (allAreGroups && processedTags.length > 0) {
+        const replacements = [];
+        if (b.baseBitType) {
+          replacements.push(`group-${b.baseBitType}`);
+        }
+        for (const t of processedTags) {
+          replacements.push(t.key);
+        }
+        squashedGroups.set(groupKey, replacements);
+      }
+    }
     for (const b of bitConfigs) {
+      const resolvedBitConfig = instance2.getBitConfig(b.bitType);
       const tags2 = [];
       const tagEntriesTypeOrder = [
         BitTagConfigKeyType.tag,
@@ -39039,47 +39137,52 @@ var ConfigBuilder = class {
         const typeOrder = tagEntriesTypeOrder.indexOf(typeA) - tagEntriesTypeOrder.indexOf(typeB);
         return typeOrder;
       });
-      if (b.baseBitType) {
-        tags2.push({
-          type: "group",
-          key: `group-${b.baseBitType}`
-        });
-        bitGroupConfigKeys.push(b.baseBitType);
-      }
-      for (const [_tagKey, tag] of tagEntries) {
-        tags2.push(...processTagEntries(tag, []));
+      const isInheritedFrom = bitGroupConfigKeys.has(b.bitType);
+      if (isInheritedFrom) {
+        const resolvedGroups = resolveGroupReferences(`group-${b.bitType}`);
+        for (const groupKey of resolvedGroups) {
+          tags2.push({
+            type: "group",
+            key: groupKey
+          });
+        }
+      } else {
+        if (b.baseBitType) {
+          const resolvedGroups = resolveGroupReferences(`group-${b.baseBitType}`);
+          for (const groupKey of resolvedGroups) {
+            tags2.push({
+              type: "group",
+              key: groupKey
+            });
+          }
+        }
+        for (const [_tagKey, tag] of tagEntries) {
+          tags2.push(...processTagEntries(tag, []));
+        }
       }
       const bitJson = {
         name: b.bitType,
         description: b.description ?? "",
-        since: b.since,
-        deprecated: b.deprecated,
+        since: resolvedBitConfig.since,
+        deprecated: resolvedBitConfig.deprecated,
         history: [
           {
-            version: b.since,
+            version: resolvedBitConfig.since,
             changes: ["Initial version"]
           }
         ],
-        format: b.textFormatDefault ?? "bitmark--",
-        bodyAllowed: b.bodyAllowed ?? true,
-        bodyRequired: b.bodyRequired ?? false,
-        footerAllowed: b.footerAllowed ?? true,
-        footerRequired: b.footerRequired ?? false,
-        resourceAttachmentAllowed: b.resourceAttachmentAllowed ?? true,
+        format: resolvedBitConfig.textFormatDefault ?? "bitmark--",
+        bodyAllowed: resolvedBitConfig.bodyAllowed ?? true,
+        bodyRequired: resolvedBitConfig.bodyRequired ?? false,
+        footerAllowed: resolvedBitConfig.footerAllowed ?? true,
+        footerRequired: resolvedBitConfig.footerRequired ?? false,
+        resourceAttachmentAllowed: resolvedBitConfig.resourceAttachmentAllowed ?? true,
         tags: tags2
       };
       const output = path3.join(outputFolderBits, `${b.bitType}.jsonc`);
       const str = JSON.stringify(bitJson, null, 2);
       fileWrites.push(fs3.writeFile(output, str));
     }
-    for (const bt of bitGroupConfigKeys) {
-      const bitType = instance2.getBitType(bt);
-      const _bitConfig = BITS[bitType];
-      if (_bitConfig) {
-        _bitConfig.bitType = bitType;
-        bitGroupConfigs.push(_bitConfig);
-      }
-    }
     const writeGroupConfigs = (groupConfigs2) => {
       for (const g of groupConfigs2) {
         const tags2 = [];
@@ -39144,7 +39247,19 @@ var ConfigBuilder = class {
     const writeBitsAsGroupConfigs = (bitsAsGroupConfigs) => {
       for (const b of bitsAsGroupConfigs) {
         const groupKey = `group-${b.bitType}`;
+        if (squashedGroups.has(groupKey)) {
+          continue;
+        }
         const tags2 = [];
+        if (b.baseBitType) {
+          const resolvedGroups = resolveGroupReferences(`group-${b.baseBitType}`);
+          for (const gk of resolvedGroups) {
+            tags2.push({
+              type: "group",
+              key: gk
+            });
+          }
+        }
         const tagEntriesTypeOrder = [
           BitTagConfigKeyType.tag,
           BitTagConfigKeyType.property,
@@ -39182,6 +39297,84 @@ var ConfigBuilder = class {
       }
     };
     writeBitsAsGroupConfigs(bitGroupConfigs);
+    Promise.all(fileWrites).then(() => {
+      const validationErrors = this.validateConfigTree(outputFolder);
+      if (validationErrors.length > 0) {
+        console.error("\n\u26A0\uFE0F  Config tree validation errors:");
+        for (const error of validationErrors) {
+          console.error(`  - ${error}`);
+        }
+        throw new Error(`Config tree validation failed with ${validationErrors.length} error(s)`);
+      } else {
+        console.log("\u2705 Config tree validation passed");
+      }
+    }).catch((err) => {
+      console.error("Error during config build or validation:", err);
+      throw err;
+    });
+  }
+  /**
+   * Validate the config tree for missing group references
+   * @param outputFolder - The folder containing the config files
+   * @returns Array of validation errors, empty if valid
+   */
+  validateConfigTree(outputFolder) {
+    const errors = [];
+    const outputFolderBits = path3.join(outputFolder, "bits");
+    const outputFolderGroups = path3.join(outputFolder, "partials");
+    const availableGroups = /* @__PURE__ */ new Set();
+    if (fs3.existsSync(outputFolderGroups)) {
+      const groupFiles = fs3.readdirSync(outputFolderGroups).filter((f) => f.endsWith(".jsonc"));
+      for (const file of groupFiles) {
+        const groupName = file.replace(".jsonc", "");
+        availableGroups.add(groupName);
+      }
+    }
+    const checkTags = (tags2, filePath, lineOffset) => {
+      for (let i = 0; i < tags2.length; i++) {
+        const tag = tags2[i];
+        if (tag.type === "group") {
+          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)) {
+          checkTags(tag.tags, filePath, lineOffset + i + 1);
+        }
+      }
+    };
+    if (fs3.existsSync(outputFolderBits)) {
+      const bitFiles = fs3.readdirSync(outputFolderBits).filter((f) => f.endsWith(".jsonc"));
+      for (const file of bitFiles) {
+        const filePath = path3.join(outputFolderBits, file);
+        try {
+          const content = fs3.readFileSync(filePath, "utf-8");
+          const config = JSON.parse(content);
+          if (config.tags && Array.isArray(config.tags)) {
+            checkTags(config.tags, `bits/${file}`, 15);
+          }
+        } catch (err) {
+          errors.push(`Failed to parse ${file}: ${err}`);
+        }
+      }
+    }
+    if (fs3.existsSync(outputFolderGroups)) {
+      const groupFiles = fs3.readdirSync(outputFolderGroups).filter((f) => f.endsWith(".jsonc"));
+      for (const file of groupFiles) {
+        const filePath = path3.join(outputFolderGroups, file);
+        try {
+          const content = fs3.readFileSync(filePath, "utf-8");
+          const config = JSON.parse(content);
+          if (config.tags && Array.isArray(config.tags)) {
+            checkTags(config.tags, `partials/${file}`, 15);
+          }
+        } catch (err) {
+          errors.push(`Failed to parse ${file}: ${err}`);
+        }
+      }
+    }
+    return errors;
   }
   // Build flat bit configs
   buildFlat(options) {
@@ -39195,6 +39388,10 @@ var ConfigBuilder = class {
     const outputFolder = opts.outputDir ?? "assets/config";
     const outputFolderBits = path3.join(outputFolder, "bits_flat");
     fs3.ensureDirSync(outputFolderBits);
+    const existingFiles = fs3.readdirSync(outputFolderBits).filter((f) => f.endsWith(".jsonc"));
+    for (const file of existingFiles) {
+      fs3.removeSync(path3.join(outputFolderBits, file));
+    }
     const processTagEntries = (tag) => {
       const tags2 = [];
       let tagName = tag.key;