@gmb/bitmark-parser-generator 5.34.0 → 5.35.0

package/dist/index.d.cts

@@ -258,6 +258,7 @@ declare const BitType: {
     readonly extractorPageNumberCollapsible: "extractor-page-number-collapsible";
     readonly extractorPageWithBlocks: "extractor-page-with-blocks";
     readonly extractorPageWithBlocksCollapsible: "extractor-page-with-blocks-collapsible";
+    readonly extractorReconcile: "extractor-reconcile";
     readonly extractorRepeatedText: "extractor-repeated-text";
     readonly extractorRule: "extractor-rule";
     readonly extractorTheme: "extractor-theme";
@@ -989,6 +990,7 @@ declare const ConfigKey: {
     readonly property_revealSolutions: "@revealSolutions";
     readonly property_reviewTag: "@reviewTag";
     readonly property_reviewerTag: "@reviewerTag";
+    readonly property_rightsPolicy: "@rightsPolicy";
     readonly property_sampleSolution: "@sampleSolution";
     readonly property_scormSource: "@scormSource";
     readonly property_search: "@search";
@@ -1708,6 +1710,9 @@ interface BitJson {
     padletId: string;
     jupyterId: string;
     jupyterExecutionCount: number;
+    copyright: string;
+    license: string;
+    rightsPolicy: string[];
     sourceRL: string;
     isPublic: boolean;
     isTemplate: boolean;
@@ -2330,6 +2335,9 @@ interface Bit {
     padletId?: Property;
     jupyterId?: Property;
     jupyterExecutionCount?: Property;
+    copyright?: Property;
+    license?: Property;
+    rightsPolicy?: Property;
     sourceRL?: Property;
     isPublic?: Property;
     isTemplate?: Property;
@@ -3236,6 +3244,8 @@ declare const NodeType: {
     readonly reviewTagValue: "reviewTagValue";
     readonly reviewerTag: "reviewerTag";
     readonly reviewerTagValue: "reviewerTagValue";
+    readonly rightsPolicy: "rightsPolicy";
+    readonly rightsPolicyValue: "rightsPolicyValue";
     readonly root: "root";
     readonly rows: "rows";
     readonly rowsValue: "rowsValue";
@@ -4338,6 +4348,9 @@ declare class Builder extends BaseBuilder {
         padletId?: string;
         jupyterId?: string;
         jupyterExecutionCount?: number;
+        copyright?: string;
+        license?: string;
+        rightsPolicy?: string | string[];
         sourceRL?: string;
         isPublic?: boolean;
         isTemplate?: boolean;

package/dist/index.d.ts

@@ -258,6 +258,7 @@ declare const BitType: {
     readonly extractorPageNumberCollapsible: "extractor-page-number-collapsible";
     readonly extractorPageWithBlocks: "extractor-page-with-blocks";
     readonly extractorPageWithBlocksCollapsible: "extractor-page-with-blocks-collapsible";
+    readonly extractorReconcile: "extractor-reconcile";
     readonly extractorRepeatedText: "extractor-repeated-text";
     readonly extractorRule: "extractor-rule";
     readonly extractorTheme: "extractor-theme";
@@ -989,6 +990,7 @@ declare const ConfigKey: {
     readonly property_revealSolutions: "@revealSolutions";
     readonly property_reviewTag: "@reviewTag";
     readonly property_reviewerTag: "@reviewerTag";
+    readonly property_rightsPolicy: "@rightsPolicy";
     readonly property_sampleSolution: "@sampleSolution";
     readonly property_scormSource: "@scormSource";
     readonly property_search: "@search";
@@ -1708,6 +1710,9 @@ interface BitJson {
     padletId: string;
     jupyterId: string;
     jupyterExecutionCount: number;
+    copyright: string;
+    license: string;
+    rightsPolicy: string[];
     sourceRL: string;
     isPublic: boolean;
     isTemplate: boolean;
@@ -2330,6 +2335,9 @@ interface Bit {
     padletId?: Property;
     jupyterId?: Property;
     jupyterExecutionCount?: Property;
+    copyright?: Property;
+    license?: Property;
+    rightsPolicy?: Property;
     sourceRL?: Property;
     isPublic?: Property;
     isTemplate?: Property;
@@ -3236,6 +3244,8 @@ declare const NodeType: {
     readonly reviewTagValue: "reviewTagValue";
     readonly reviewerTag: "reviewerTag";
     readonly reviewerTagValue: "reviewerTagValue";
+    readonly rightsPolicy: "rightsPolicy";
+    readonly rightsPolicyValue: "rightsPolicyValue";
     readonly root: "root";
     readonly rows: "rows";
     readonly rowsValue: "rowsValue";
@@ -4338,6 +4348,9 @@ declare class Builder extends BaseBuilder {
         padletId?: string;
         jupyterId?: string;
         jupyterExecutionCount?: number;
+        copyright?: string;
+        license?: string;
+        rightsPolicy?: string | string[];
         sourceRL?: string;
         isPublic?: boolean;
         isTemplate?: boolean;

package/dist/index.js

@@ -267,6 +267,7 @@ var BitType = {
   extractorPageNumberCollapsible: "extractor-page-number-collapsible",
   extractorPageWithBlocks: "extractor-page-with-blocks",
   extractorPageWithBlocksCollapsible: "extractor-page-with-blocks-collapsible",
+  extractorReconcile: "extractor-reconcile",
   extractorRepeatedText: "extractor-repeated-text",
   extractorRule: "extractor-rule",
   extractorTheme: "extractor-theme",
@@ -1505,6 +1506,7 @@ var propertyKeys = {
   property_revealSolutions: "@revealSolutions",
   property_reviewTag: "@reviewTag",
   property_reviewerTag: "@reviewerTag",
+  property_rightsPolicy: "@rightsPolicy",
   property_sampleSolution: "@sampleSolution",
   property_scormSource: "@scormSource",
   property_search: "@search",
@@ -2514,6 +2516,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the definition.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forKeys",
                 exportJsonKey: { "@bit": { heading: { forKeys: "$" } } }
               },
@@ -2554,6 +2557,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the definition.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forValues",
                 exportJsonKey: { "@bit": { heading: { forValues: "$" } } }
               },
@@ -2632,6 +2636,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the definition.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forKeys",
                 exportJsonKey: { "@bit": { heading: { forKeys: "$" } } }
               },
@@ -2673,6 +2678,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the definition.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forValues",
                 exportJsonKey: { "@bit": { heading: { forValues: "$" } } }
               },
@@ -2786,6 +2792,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the match pair.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forKeys",
                 exportJsonKey: { "@bit": { heading: { forKeys: "$" } } }
               },
@@ -2915,6 +2922,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the match pair.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forValues",
                 exportJsonKey: { "@bit": { heading: { forValues: "$" } } }
               },
@@ -2961,6 +2969,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the audio match pair.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forKeys",
                 exportJsonKey: { "@bit": { heading: { forKeys: "$" } } }
               },
@@ -2992,6 +3001,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the audio match pair.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forValues",
                 exportJsonKey: { "@bit": { heading: { forValues: "$" } } }
               },
@@ -3029,6 +3039,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the image match pair.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forKeys",
                 exportJsonKey: { "@bit": { heading: { forKeys: "$" } } }
               },
@@ -3060,6 +3071,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the image match pair.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forValues",
                 exportJsonKey: { "@bit": { heading: { forValues: "$" } } }
               },
@@ -3135,6 +3147,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the match matrix.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forKeys",
                 exportJsonKey: { "@bit": { heading: { forKeys: "$" } } }
               },
@@ -3247,6 +3260,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the match matrix.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forValues",
                 exportJsonKey: [
                   { "@keyonly": { "@bit": { heading: { forValues: [""] } } } },
@@ -3529,6 +3543,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the feedback.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forKeys",
                 exportJsonKey: { "@bit": { heading: { forKeys: "$" } } }
               }
@@ -3611,6 +3626,7 @@ var CARDSETS = {
                 key: ConfigKey.tag_title,
                 description: "Title of the feedback.",
                 format: TagFormat.plainText,
+                nullable: true,
                 jsonKey: "^heading.forValues",
                 exportJsonKey: { "@bit": { heading: { forValues: "$" } } }
               }
@@ -4398,6 +4414,22 @@ var GROUPS = {
         description: "The original location of the information in the original source material",
         format: TagFormat.plainText
       },
+      {
+        key: ConfigKey.property_copyright,
+        description: "The copyright information for the bit",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_license,
+        description: "The license for the bit",
+        format: TagFormat.plainText
+      },
+      {
+        key: ConfigKey.property_rightsPolicy,
+        description: "The rights policy or policies for the bit",
+        format: TagFormat.plainText,
+        maxCount: Count.infinity
+      },
       {
         key: ConfigKey.property_isTemplate,
         description: "If true, the bit is a template",
@@ -4424,7 +4456,8 @@ var GROUPS = {
       {
         key: ConfigKey.property_aiGenerated,
         description: "If true, the bit is AI-generated",
-        format: TagFormat.boolean
+        format: TagFormat.boolean,
+        nullable: true
       },
       {
         key: ConfigKey.property_machineTranslated,
@@ -4439,7 +4472,8 @@ var GROUPS = {
       {
         key: ConfigKey.property_spansPageBreak,
         description: "If true, the bit spans a page break",
-        format: TagFormat.boolean
+        format: TagFormat.boolean,
+        nullable: true
       },
       {
         key: ConfigKey.property_searchIndex,
@@ -4542,6 +4576,7 @@ var GROUPS = {
         key: ConfigKey.property_theme,
         description: "The theme(s) for the bit",
         format: TagFormat.plainText,
+        nullable: true,
         maxCount: Count.infinity
       },
       {
@@ -4560,6 +4595,7 @@ var GROUPS = {
         key: ConfigKey.property_tag,
         description: "The tag(s) for the bit",
         format: TagFormat.plainText,
+        nullable: true,
         maxCount: Count.infinity
       },
       {
@@ -4579,6 +4615,7 @@ var GROUPS = {
             exportJsonKey: { tags: ["$"] },
             description: "The tag(s) for the group",
             format: TagFormat.plainText,
+            nullable: true,
             maxCount: Count.infinity
           }
         ]
@@ -4696,6 +4733,20 @@ var GROUPS = {
         description: "The layer role(s) for the bit",
         format: TagFormat.plainText,
         maxCount: Count.infinity
+      },
+      {
+        // Universal @internalComment — declares in config what Config.ts also
+        // injects programmatically into every bit (its push runs last and wins
+        // the keyed merge, so runtime behaviour is unchanged). Declared here so
+        // the config export (ConfigBuilder → assets/config → configurator →
+        // bitmark.json) carries the tag for downstream parsers. Empty
+        // exportJsonKey: consumed but never emitted to the bit JSON (the value
+        // is routed to parser.internalComments).
+        key: ConfigKey.property_internalComment,
+        description: "Internal comment for the bit.",
+        format: TagFormat.plainText,
+        maxCount: Count.infinity,
+        exportJsonKey: {}
       }
     ]
   },
@@ -4852,7 +4903,8 @@ var GROUPS = {
           {
             key: ConfigKey.property_size,
             description: "The size of the image",
-            format: TagFormat.number
+            format: TagFormat.number,
+            nullable: true
           },
           {
             key: ConfigKey.property_format,
@@ -5755,6 +5807,7 @@ var GROUPS = {
         key: ConfigKey.property_coverImage,
         description: "The cover image(s) of the book",
         format: TagFormat.plainText,
+        nullable: true,
         maxCount: Count.infinity
       },
       {
@@ -6071,7 +6124,8 @@ var GROUPS = {
       {
         key: ConfigKey.property_platformNeedsShadow,
         description: "If true, the platform needs shadow",
-        format: TagFormat.boolean
+        format: TagFormat.boolean,
+        nullable: true
       }
     ]
   },
@@ -6082,7 +6136,8 @@ var GROUPS = {
       {
         key: ConfigKey.property_revealSolutions,
         description: "If true, the quiz solutions are revealed",
-        format: TagFormat.boolean
+        format: TagFormat.boolean,
+        nullable: true
         // defaultValue: 'false',
       },
       {
@@ -6229,12 +6284,14 @@ var GROUPS = {
       {
         key: ConfigKey.property_width,
         description: "The width of the image",
-        format: TagFormat.number
+        format: TagFormat.number,
+        nullable: true
       },
       {
         key: ConfigKey.property_height,
         description: "The height of the image",
-        format: TagFormat.number
+        format: TagFormat.number,
+        nullable: true
       },
       {
         key: ConfigKey.property_alt,
@@ -6279,12 +6336,14 @@ var GROUPS = {
       {
         key: ConfigKey.property_width,
         description: "The width of the image",
-        format: TagFormat.number
+        format: TagFormat.number,
+        nullable: true
       },
       {
         key: ConfigKey.property_height,
         description: "The height of the image",
-        format: TagFormat.number
+        format: TagFormat.number,
+        nullable: true
       },
       {
         key: ConfigKey.property_alt,
@@ -6336,12 +6395,14 @@ var GROUPS = {
       {
         key: ConfigKey.property_width,
         description: "The width of the video",
-        format: TagFormat.number
+        format: TagFormat.number,
+        nullable: true
       },
       {
         key: ConfigKey.property_height,
         description: "The height of the video",
-        format: TagFormat.number
+        format: TagFormat.number,
+        nullable: true
       },
       {
         key: ConfigKey.property_duration,
@@ -7426,7 +7487,8 @@ var BITS = {
       {
         key: ConfigKey.property_coverImage,
         description: "Cover image of the catalog item",
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        nullable: true
       },
       {
         key: ConfigKey.resource_coverImage,
@@ -7590,7 +7652,8 @@ var BITS = {
       {
         key: ConfigKey.property_coverImage,
         description: "Cover image of the catalog item",
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        nullable: true
       },
       {
         key: ConfigKey.resource_coverImage,
@@ -7754,7 +7817,8 @@ var BITS = {
       {
         key: ConfigKey.property_coverImage,
         description: "Cover image of the catalog item",
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        nullable: true
       },
       {
         key: ConfigKey.property_content2Buy,
@@ -8540,12 +8604,14 @@ var BITS = {
       {
         key: ConfigKey.property_quizCountItems,
         description: "The number of items in the cloze quiz",
-        format: TagFormat.boolean
+        format: TagFormat.boolean,
+        nullable: true
       },
       {
         key: ConfigKey.property_quizStrikethroughSolutions,
         description: "If the cloze solutions should be strikethrough",
-        format: TagFormat.boolean
+        format: TagFormat.boolean,
+        nullable: true
       },
       {
         key: ConfigKey.group_gap,
@@ -10241,6 +10307,12 @@ var BITS = {
     description: "Extractor theme bit, used to store design/theme JSON extracted from documents",
     textFormatDefault: TextFormat.json
   },
+  [BitType.extractorReconcile]: {
+    since: "5.35.0",
+    baseBitType: BitType._standard,
+    description: "Extractor reconcile bit, used to store PDF-compare reconciliation decisions (config and issues) in JSON",
+    textFormatDefault: TextFormat.json
+  },
   [BitType.extractorAiChat]: {
     since: "3.19.0",
     baseBitType: BitType._standard,
@@ -10264,12 +10336,14 @@ var BITS = {
       {
         key: ConfigKey.property_x,
         description: "X-coordinate for the block, used to position the block on the page",
-        format: TagFormat.number
+        format: TagFormat.number,
+        nullable: true
       },
       {
         key: ConfigKey.property_y,
         description: "Y-coordinate for the block, used to position the block on the page",
-        format: TagFormat.number
+        format: TagFormat.number,
+        nullable: true
       },
       {
         key: ConfigKey.property_width,
@@ -12027,7 +12101,8 @@ var BITS = {
       {
         key: ConfigKey.property_product,
         description: "Product reference for the product page, used to link to the product",
-        format: TagFormat.plainText
+        format: TagFormat.plainText,
+        nullable: true
       }
     ]
   },
@@ -12046,6 +12121,7 @@ var BITS = {
         key: ConfigKey.property_product,
         description: "Product reference for the product list, used to link to the product",
         format: TagFormat.plainText,
+        nullable: true,
         maxCount: Count.infinity
       }
       // {
@@ -12607,7 +12683,8 @@ var BITS = {
       {
         key: ConfigKey.property_ratingLevelSelected,
         description: "Selected level for the rating survey, used to define the default rating",
-        format: TagFormat.number
+        format: TagFormat.number,
+        nullable: true
       },
       {
         key: ConfigKey.property_buttonCaption,
@@ -13939,7 +14016,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "5.34.0",
+  "version": "5.35.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -14864,6 +14941,8 @@ var NodeType = {
   reviewTagValue: "reviewTagValue",
   reviewerTag: "reviewerTag",
   reviewerTagValue: "reviewerTagValue",
+  rightsPolicy: "rightsPolicy",
+  rightsPolicyValue: "rightsPolicyValue",
   root: "root",
   // bit type (root)
   rows: "rows",
@@ -28233,6 +28312,14 @@ var Builder = class extends BaseBuilder {
         data.jupyterExecutionCount,
         options
       ),
+      copyright: this.toAstProperty(bitType, ConfigKey.property_copyright, data.copyright, options),
+      license: this.toAstProperty(bitType, ConfigKey.property_license, data.license, options),
+      rightsPolicy: this.toAstProperty(
+        bitType,
+        ConfigKey.property_rightsPolicy,
+        data.rightsPolicy,
+        options
+      ),
       sourceRL: this.toAstProperty(bitType, ConfigKey.property_sourceRL, data.sourceRL, options),
       isPublic: this.toAstProperty(bitType, ConfigKey.property_isPublic, data.isPublic, options),
       isTemplate: this.toAstProperty(