@gmb/bitmark-parser-generator 5.37.0 → 5.38.0

package/dist/index.cjs

@@ -1277,6 +1277,7 @@ var import_superenum14 = require("@ncoderz/superenum");
 // src/model/enum/GroupKey.ts
 var import_superenum10 = require("@ncoderz/superenum");
 var groupKeys = {
+  group_accessibilityDecorative: "group_accessibilityDecorative",
   group_standardAllBits: "group_standardAllBits",
   group_standardItemLead: "group_standardItemLead",
   group_standardItemLeadInstructionHint: "group_standardItemLeadInstructionHint",
@@ -1342,6 +1343,8 @@ var groupKeys = {
 // src/model/enum/PropertyKey.ts
 var import_superenum11 = require("@ncoderz/superenum");
 var propertyKeys = {
+  property_accessibilityGroupTag: "@accessibilityGroupTag",
+  property_accessibilityTag: "@accessibilityTag",
   property_action: "@action",
   property_activityType: "@activityType",
   property_additionalSolutions: "@additionalSolutions",
@@ -4532,6 +4535,7 @@ var CARDSETS = {
 };
 
 // src/config/raw/groups.ts
+var ACCESSIBILITY_TAG_VALUES = ["complex", "functional", "decorative", "standard"];
 var GROUPS = {
   [ConfigKey.group_standardAllBits]: {
     name: "Standard",
@@ -4638,7 +4642,8 @@ var GROUPS = {
       {
         key: ConfigKey.property_isCollapsible,
         description: "If true, the bit is collapsible",
-        format: TagFormat.boolean
+        format: TagFormat.boolean,
+        nullable: true
       },
       {
         key: ConfigKey.property_spansPageBreak,
@@ -4803,6 +4808,36 @@ var GROUPS = {
           }
         ]
       },
+      {
+        key: ConfigKey.property_accessibilityTag,
+        description: "The accessibility classification(s) for the bit",
+        format: TagFormat.enumeration,
+        values: ACCESSIBILITY_TAG_VALUES,
+        nullable: true,
+        maxCount: Count.infinity
+      },
+      {
+        key: ConfigKey.property_accessibilityGroupTag,
+        jsonKey: "accessibilityGroupTag.name",
+        // Entity-merge semantics, as for `@groupTag`: repeated
+        // `[@accessibilityGroupTag: name]` occurrences with the same value fold
+        // into one entry; chained `@accessibilityTag` children's arrays merge as sets.
+        exportJsonKey: { accessibilityGroupTag: [{ "@id": "name", name: "$" }] },
+        description: "The accessibility group tag(s) for the bit",
+        format: TagFormat.plainText,
+        maxCount: Count.infinity,
+        chain: [
+          {
+            key: ConfigKey.property_accessibilityTag,
+            exportJsonKey: { tags: ["$"] },
+            description: "The accessibility classification(s) for the group",
+            format: TagFormat.enumeration,
+            values: ACCESSIBILITY_TAG_VALUES,
+            nullable: true,
+            maxCount: Count.infinity
+          }
+        ]
+      },
       {
         key: ConfigKey.property_reviewTag,
         description: "The review tag(s) for the bit",
@@ -4933,6 +4968,37 @@ var GROUPS = {
       }
     ]
   },
+  [ConfigKey.group_accessibilityDecorative]: {
+    name: "Accessibility (decorative)",
+    description: "Accessibility tags defaulting to a decorative image, for bits that are decorative by definition",
+    type: GroupConfigType.standard,
+    // Re-declares `@accessibilityGroupTag` (in full — tag hydration is last-wins
+    // per config key, it does not merge) with the decorative defaults. The
+    // standalone `@accessibilityTag` is deliberately NOT re-declared: the default
+    // belongs to the group structure only.
+    tags: [
+      {
+        key: ConfigKey.property_accessibilityGroupTag,
+        jsonKey: "accessibilityGroupTag.name",
+        exportJsonKey: { accessibilityGroupTag: [{ "@id": "name", name: "$" }] },
+        description: "The accessibility group tag(s) for the bit",
+        format: TagFormat.plainText,
+        defaultValue: "image",
+        maxCount: Count.infinity,
+        chain: [
+          {
+            key: ConfigKey.property_accessibilityTag,
+            exportJsonKey: { tags: ["$"] },
+            description: "The accessibility classification(s) for the group",
+            format: TagFormat.enumeration,
+            values: ACCESSIBILITY_TAG_VALUES,
+            defaultValue: "decorative",
+            maxCount: Count.infinity
+          }
+        ]
+      }
+    ]
+  },
   [ConfigKey.group_standardItemLead]: {
     type: GroupConfigType.standard,
     description: "Standard group for item, lead, page number, and margin number tags",
@@ -8836,6 +8902,12 @@ var BITS = {
         description: "The progress of the chapter, used for tracking reading progress",
         format: TagFormat.boolean,
         defaultValue: "true"
+      },
+      {
+        key: ConfigKey.property_isCollapsible,
+        description: "If true, the chapter is collapsible (always emitted; defaults false)",
+        format: TagFormat.boolean,
+        defaultValue: "false"
       }
     ]
   },
@@ -10245,7 +10317,9 @@ var BITS = {
   },
   [BitType.printPageBreak]: {
     since: "5.4.0",
-    baseBitType: BitType.separator,
+    // Based on `article`, not `separator`: `separator` adds nothing over `article`,
+    // and basing on it would inherit the decorative accessibility defaults.
+    baseBitType: BitType.article,
     description: "Print page break bit, used to create page breaks for printing in articles or books"
   },
   [BitType.releaseNotesSummary]: {
@@ -10331,12 +10405,24 @@ var BITS = {
   [BitType.separator]: {
     since: "1.4.15",
     baseBitType: BitType.article,
-    description: "Separator bit, used to create visual separators in articles or books"
+    description: "Separator bit, used to create visual separators in articles or books",
+    tags: [
+      {
+        key: ConfigKey.group_accessibilityDecorative,
+        description: "Accessibility tags, defaulting to a decorative image"
+      }
+    ]
   },
   [BitType.separatorAlt]: {
     since: "1.16.0",
     baseBitType: BitType.separator,
-    description: "Alternative separator bit, used to create visual separators in articles or books with alternative styling"
+    description: "Alternative separator bit, used to create visual separators in articles or books with alternative styling",
+    tags: [
+      {
+        key: ConfigKey.group_accessibilityDecorative,
+        description: "Accessibility tags, defaulting to a decorative image"
+      }
+    ]
   },
   [BitType.sticker]: {
     since: "1.5.28",
@@ -11572,7 +11658,13 @@ var BITS = {
   [BitType.imageMood]: {
     since: "1.3.0",
     baseBitType: BitType.image,
-    description: "Image mood bit, used to create mood images in articles or books"
+    description: "Image mood bit, used to create mood images in articles or books",
+    tags: [
+      {
+        key: ConfigKey.group_accessibilityDecorative,
+        description: "Accessibility tags, defaulting to a decorative image"
+      }
+    ]
   },
   [BitType.imagePortrait]: {
     since: "1.3.0",
@@ -11592,6 +11684,10 @@ var BITS = {
       {
         key: ConfigKey.group_imageNoZoom,
         description: "Image no zoom tags for images, used to define whether images should have zoom functionality"
+      },
+      {
+        key: ConfigKey.group_accessibilityDecorative,
+        description: "Accessibility tags, defaulting to a decorative image"
       }
     ],
     resourceAttachmentAllowed: false
@@ -11599,7 +11695,13 @@ var BITS = {
   [BitType.imageSeparatorAlt]: {
     since: "1.16.0",
     baseBitType: BitType.imageSeparator,
-    description: "Alternative image separator bit, used to create alternative separators in articles or books"
+    description: "Alternative image separator bit, used to create alternative separators in articles or books",
+    tags: [
+      {
+        key: ConfigKey.group_accessibilityDecorative,
+        description: "Accessibility tags, defaulting to a decorative image"
+      }
+    ]
   },
   [BitType.imageScreenshot]: {
     since: "1.3.0",
@@ -14878,7 +14980,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "5.37.0",
+  "version": "5.38.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -15232,6 +15334,10 @@ var NodeType = {
   // unknown
   __isDefaultExample: "__isDefaultExample",
   __typeAlias: "__typeAlias",
+  accessibilityGroupTag: "accessibilityGroupTag",
+  accessibilityGroupTagValue: "accessibilityGroupTagValue",
+  accessibilityTag: "accessibilityTag",
+  accessibilityTagValue: "accessibilityTagValue",
   action: "action",
   actionValue: "actionValue",
   activityType: "activityType",
@@ -27556,6 +27662,12 @@ var BaseBuilder = class {
         case TagFormat.plainText:
           if (instance6.asNumber(v) != null) v = `${v}`;
           return stringUtils.isString(v) ? stringUtils.trimmedString(v) : void 0;
+        case TagFormat.enumeration: {
+          if (instance6.asNumber(v) != null) v = `${v}`;
+          const enumValue = stringUtils.isString(v) ? stringUtils.trimmedString(v) : void 0;
+          if (enumValue == null || enumValue === "") return propertyConfig?.defaultValue ?? "";
+          return enumValue;
+        }
         case TagFormat.number:
           return instance6.asNumber(v);
         case TagFormat.boolean:
@@ -29122,6 +29234,10 @@ var Builder = class extends BaseBuilder {
     const bitType = data.bitType;
     const bitConfig = instance2.getBitConfig(bitType);
     const isCollapsibleDefaultsTrue = bitConfig.tags[ConfigKey.property_isCollapsible]?.defaultValue === "true";
+    const accessibilityGroupTag = this.resolveAccessibilityGroupTag(
+      bitConfig,
+      data.accessibilityGroupTag
+    );
     const deprecatedTextFormat = (0, import_superenum30.Enum)(DeprecatedTextFormat).fromValue(data.textFormat);
     let textFormat = (0, import_superenum30.Enum)(TextFormat).fromValue(data.textFormat) ?? bitConfig.textFormatDefault;
     if (deprecatedTextFormat === DeprecatedTextFormat.bitmarkMinusMinus) {
@@ -29357,6 +29473,13 @@ var Builder = class extends BaseBuilder {
       slug: this.toAstProperty(bitType, ConfigKey.property_slug, data.slug, options),
       tag: this.toAstProperty(bitType, ConfigKey.property_tag, data.tag, options),
       groupTag: this.buildGroupTags(context, data.groupTag),
+      accessibilityTag: this.toAstProperty(
+        bitType,
+        ConfigKey.property_accessibilityTag,
+        data.accessibilityTag,
+        options
+      ),
+      accessibilityGroupTag: this.buildGroupTags(context, accessibilityGroupTag),
       reviewTag: this.toAstProperty(bitType, ConfigKey.property_reviewTag, data.reviewTag, options),
       reviewerTag: this.toAstProperty(
         bitType,
@@ -30409,6 +30532,26 @@ var Builder = class extends BaseBuilder {
     });
     return node;
   }
+  /**
+   * Resolve the accessibilityGroupTag data, materialising the bit type's default when absent.
+   *
+   * PLAN-019: `group_accessibilityDecorative` re-declares `@accessibilityGroupTag` with a
+   * `defaultValue`, and its chained `@accessibilityTag` likewise. When the bit carries no
+   * authored value, synthesize the default group so it reaches both generators. An authored
+   * value always wins.
+   *
+   * @param bitConfig - the resolved config for the bit
+   * @param data - authored data for the node, if any
+   * @returns
+   */
+  resolveAccessibilityGroupTag(bitConfig, data) {
+    if (data != null && (!Array.isArray(data) || data.length > 0)) return data;
+    const groupConfig = bitConfig.tags[ConfigKey.property_accessibilityGroupTag];
+    const name = groupConfig?.defaultValue;
+    if (name == null) return data;
+    const tag = groupConfig?.chain?.[ConfigKey.property_accessibilityTag]?.defaultValue;
+    return [{ name, tags: tag != null ? [tag] : [] }];
+  }
   /**
    * Build groupTag[] node
    *
@@ -32491,6 +32634,29 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
     }
     return false;
   }
+  // bitmarkAst -> bits -> bitsValue -> accessibilityGroupTag
+  enter_accessibilityGroupTag(node, route) {
+    const accessibilityGroupTag = node.value;
+    const parent = this.getParentNode(route);
+    if (parent?.key !== NodeType.bitsValue) return true;
+    for (const gt of accessibilityGroupTag) {
+      const { name, tags: tags2 } = gt;
+      this.writeProperty("accessibilityGroupTag", name, route, {
+        format: TagFormat.plainText,
+        writeEmpty: true
+      });
+      if (tags2 && tags2.length > 0) {
+        for (const t of tags2) {
+          this.writeProperty("accessibilityTag", t, route, {
+            format: TagFormat.plainText,
+            writeEmpty: true,
+            forceChain: true
+          });
+        }
+      }
+    }
+    return false;
+  }
   // bitmarkAst -> bits -> bitsValue -> labelTrue / labelFalse
   leaf_labelTrue(node, route) {
     const value = node.value;
@@ -35249,10 +35415,14 @@ var JsonGenerator = class extends AstWalkerGenerator {
   }
   // bitmarkAst -> bits -> bitsValue -> isCollapsible
   /**
-   * PLAN-016: `isCollapsible` is emitted only when true. `false` is the implied
-   * default for every bit, so it is never written to the JSON — an absent key
-   * means the bit's configured default (`true` for the deprecated
-   * `*-collapsible` bit types, `false` everywhere else).
+   * `isCollapsible` is emitted only when explicitly set on the bit — an explicit
+   * `true`/`false` in the source is emitted as-is, and an absent tag yields no
+   * JSON key (the tag is nullable in the config: no default, unset when absent).
+   *
+   * Two exceptions always carry a value: chapter bits default to `false`
+   * (`defaultValue: 'false'` in the bit config, applied in `cleanBitJson()`),
+   * and the deprecated `*-collapsible` bit types default to `true` (materialised
+   * into the AST by the Builder).
    *
    * Defining these handlers suppresses the generic property handlers that
    * `generatePropertyHandlers()` would otherwise install for this tag.
@@ -35260,7 +35430,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
   leaf_isCollapsible(node, route) {
     const parent = this.getParentNode(route);
     if (parent?.key !== NodeType.bitsValue) return false;
-    if (node.value === true) this.bitJson.isCollapsible = true;
+    if (node.value != null) this.bitJson.isCollapsible = node.value === true;
     return false;
   }
   enter_isCollapsible(node, route) {
@@ -36139,6 +36309,7 @@ var JsonGenerator = class extends AstWalkerGenerator {
       if (instance2.isOfBitType(bitType, BitType.chapter)) {
         if (bitJson.toc == null) bitJson.toc = true;
         if (bitJson.progress == null) bitJson.progress = true;
+        if (bitJson.isCollapsible == null) bitJson.isCollapsible = false;
         if (bitJson.level == null) bitJson.level = 1;
         if (bitJson.body == null) bitJson.body = this.bodyDefault;
       }
@@ -39653,19 +39824,25 @@ function handleStandardStringExample(context, _content, example, target) {
 }
 
 // src/parser/bitmark/peg/contentProcessors/GroupTagChainContentProcessor.ts
-function groupTagChainContentProcessor(context, _contentDepth, tagsConfig, content, target) {
+var GROUP_TAG = { groupKey: "groupTag", memberKey: "tag" };
+var ACCESSIBILITY_GROUP_TAG = {
+  groupKey: "accessibilityGroupTag",
+  memberKey: "accessibilityTag"
+};
+function groupTagChainContentProcessor(context, _contentDepth, tagsConfig, content, target, keys = GROUP_TAG) {
   const { value } = content;
-  if (context.DEBUG_CHAIN_CONTENT) context.debugPrint("groupTag content", content);
+  const { groupKey, memberKey } = keys;
+  if (context.DEBUG_CHAIN_CONTENT) context.debugPrint(`${groupKey} content`, content);
   const tags2 = context.bitContentProcessor(ContentDepth.Chain, tagsConfig, content.chain);
-  if (context.DEBUG_CHAIN_TAGS) context.debugPrint("groupTag TAGS", tags2);
-  const { tag } = tags2;
+  if (context.DEBUG_CHAIN_TAGS) context.debugPrint(`${groupKey} TAGS`, tags2);
+  const memberTags = tags2[memberKey];
   const name = stringUtils.trimmedString(value) ?? "";
   const node = {
     name,
-    tags: tag ?? []
+    tags: memberTags ?? []
   };
-  if (!Array.isArray(target.groupTag)) target.groupTag = [];
-  target.groupTag.push(node);
+  if (!Array.isArray(target[groupKey])) target[groupKey] = [];
+  target[groupKey].push(node);
 }
 
 // src/parser/bitmark/peg/contentProcessors/ImageSourceChainContentProcessor.ts
@@ -39885,6 +40062,16 @@ function propertyContentProcessor(context, contentDepth, tagsConfig, content, ta
     } else if (configKey === ConfigKey.property_groupTag) {
       groupTagChainContentProcessor(context, contentDepth, propertyConfig.chain, content, target);
       return;
+    } else if (configKey === ConfigKey.property_accessibilityGroupTag) {
+      groupTagChainContentProcessor(
+        context,
+        contentDepth,
+        propertyConfig.chain,
+        content,
+        target,
+        ACCESSIBILITY_GROUP_TAG
+      );
+      return;
     } else if (configKey === ConfigKey.property_ratingLevelStart || configKey === ConfigKey.property_ratingLevelEnd) {
       ratingLevelChainContentProcessor(
         context,
@@ -39937,6 +40124,23 @@ function propertyContentProcessor(context, contentDepth, tagsConfig, content, ta
                 location: TextLocation.tag
               }
             );
+          case TagFormat.enumeration: {
+            const enumValue = instance3.unbreakscape(
+              stringUtils.isString(v2) ? stringUtils.trimmedString(v2) : void 0,
+              {
+                format: TextFormat.plainText,
+                location: TextLocation.tag
+              }
+            );
+            if (enumValue == null || enumValue === "") return c.defaultValue ?? "";
+            if (c.values && !c.values.includes(enumValue)) {
+              context.addWarning(
+                `Invalid value '${enumValue}' for property [@${tag}]. Valid values: ${c.values.join(" | ")}`,
+                content
+              );
+            }
+            return enumValue;
+          }
           case TagFormat.number:
             return instance6.asNumber(
               instance3.unbreakscape(v2, {
@@ -45663,6 +45867,8 @@ var ConfigBuilder = class {
           format = "number";
         } else if (tag.format === TagFormat.coordinates) {
           format = "coordinates";
+        } else if (tag.format === TagFormat.enumeration) {
+          format = "enum";
         }
       } else if (tagType === BitTagConfigKeyType.resource) {
         format = "string";
@@ -45727,6 +45933,7 @@ var ConfigBuilder = class {
           { value: tag.htmlKey, present: hasHtml }
         ),
         ...format && format !== "string" ? { format } : {},
+        ...tag.values != null ? { values: tag.values } : {},
         ...tag.defaultValue != null ? { default: tag.defaultValue } : {},
         ...tag.nullable ? { nullable: true } : {},
         ...tag.minCount != null && tag.minCount !== 0 ? { min: tag.minCount } : {},