@gmb/bitmark-parser-generator 5.13.0 → 5.15.0

package/dist/browser/cjs/index.d.cts

@@ -38,6 +38,8 @@ declare const BitType: {
     readonly appFlashcardsQuiz: "app-flashcards-quiz";
     readonly appGetScreenshot: "app-get-screenshot";
     readonly appLink: "app-link";
+    readonly appRag: "app-rag";
+    readonly appSearch: "app-search";
     readonly article: "article";
     readonly articleAi: "article-ai";
     readonly articleAlt: "article-alt";
@@ -735,6 +737,7 @@ declare const ConfigKey: {
     readonly property_availableClassifications: "@availableClassifications";
     readonly property_brandColor: "@brandColor";
     readonly property_brandColorName: "@brandColorName";
+    readonly property_backgroundImage: "@backgroundImage";
     readonly property_blockId: "@blockId";
     readonly property_book: "@book";
     readonly property_bookAlias: "@bookAlias";
@@ -1025,6 +1028,7 @@ declare const ConfigKey: {
     readonly resource_previewImage: "&previewImage";
     readonly resource_previewVideo: "&previewVideo";
     readonly resource_coverImage: "&coverImage";
+    readonly resource_backgroundImage: "&backgroundImage";
     readonly tag_title: "#";
     readonly tag_anchor: "▼";
     readonly tag_reference: "►";
@@ -1077,6 +1081,7 @@ declare const ResourceType: {
     readonly previewImage: "previewImage";
     readonly previewVideo: "previewVideo";
     readonly coverImage: "coverImage";
+    readonly backgroundImage: "backgroundImage";
 };
 type ResourceTypeType = EnumType<typeof ResourceType>;
 
@@ -1686,6 +1691,7 @@ interface BitJson {
     bookDiff: string;
     coverImage: string | string[];
     coverColor: string;
+    backgroundImage: string | string[];
     publisher: string | string[];
     publisherName: string;
     publications: string | string[];
@@ -2298,6 +2304,7 @@ interface Bit {
     bookDiff?: Property;
     coverImage?: Property | ImageResourceWrapperJson;
     coverColor?: Property;
+    backgroundImage?: Property | ImageResourceWrapperJson;
     publications?: Property;
     relatedBook?: Property;
     translationOfBook?: Property;
@@ -2617,6 +2624,8 @@ declare const NodeType: {
     readonly avatarImage: "avatarImage";
     readonly backgroundWallpaper: "backgroundWallpaper";
     readonly backgroundWallpaperValue: "backgroundWallpaperValue";
+    readonly backgroundImage: "backgroundImage";
+    readonly backgroundImageValue: "backgroundImageValue";
     readonly bitLevel: "bitLevel";
     readonly bitmarkAst: "bitmarkAst";
     readonly bitmarkVersion: "bitmarkVersion";
@@ -4163,6 +4172,7 @@ declare class Builder extends BaseBuilder {
         bookDiff?: string;
         coverImage?: string | string[] | Partial<ImageResourceWrapperJson>;
         coverColor?: string;
+        backgroundImage?: string | string[] | Partial<ImageResourceWrapperJson>;
         publications?: string | string[];
         relatedBook?: string | string[];
         translationOfBook?: string;
@@ -5589,6 +5599,8 @@ declare class BitmarkGenerator extends AstWalkerGenerator<BitmarkAst, void> {
     protected enter_platformBackgroundImage(node: NodeInfo, _route: NodeInfo[]): boolean;
     protected enter_coverImage(node: NodeInfo, route: NodeInfo[]): boolean;
     protected leaf_coverImage(node: NodeInfo, route: NodeInfo[]): void;
+    protected enter_backgroundImage(node: NodeInfo, route: NodeInfo[]): boolean;
+    protected leaf_backgroundImage(node: NodeInfo, route: NodeInfo[]): void;
     protected exit_imagePlaceholder(_node: NodeInfo, _route: NodeInfo[]): void;
     protected enter_posterImage(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_thumbnails(node: NodeInfo, route: NodeInfo[]): boolean;
@@ -5971,6 +5983,7 @@ declare class JsonGenerator extends AstWalkerGenerator<BitmarkAst, void> {
     protected enter_platformLogo(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_platformBackgroundImage(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_coverImage(node: NodeInfo, route: NodeInfo[]): boolean;
+    protected enter_backgroundImage(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_resources(node: NodeInfo, route: NodeInfo[]): boolean;
     protected leaf_level(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_book(node: NodeInfo, route: NodeInfo[]): boolean;

package/dist/browser/esm/index.d.ts

@@ -38,6 +38,8 @@ declare const BitType: {
     readonly appFlashcardsQuiz: "app-flashcards-quiz";
     readonly appGetScreenshot: "app-get-screenshot";
     readonly appLink: "app-link";
+    readonly appRag: "app-rag";
+    readonly appSearch: "app-search";
     readonly article: "article";
     readonly articleAi: "article-ai";
     readonly articleAlt: "article-alt";
@@ -735,6 +737,7 @@ declare const ConfigKey: {
     readonly property_availableClassifications: "@availableClassifications";
     readonly property_brandColor: "@brandColor";
     readonly property_brandColorName: "@brandColorName";
+    readonly property_backgroundImage: "@backgroundImage";
     readonly property_blockId: "@blockId";
     readonly property_book: "@book";
     readonly property_bookAlias: "@bookAlias";
@@ -1025,6 +1028,7 @@ declare const ConfigKey: {
     readonly resource_previewImage: "&previewImage";
     readonly resource_previewVideo: "&previewVideo";
     readonly resource_coverImage: "&coverImage";
+    readonly resource_backgroundImage: "&backgroundImage";
     readonly tag_title: "#";
     readonly tag_anchor: "▼";
     readonly tag_reference: "►";
@@ -1077,6 +1081,7 @@ declare const ResourceType: {
     readonly previewImage: "previewImage";
     readonly previewVideo: "previewVideo";
     readonly coverImage: "coverImage";
+    readonly backgroundImage: "backgroundImage";
 };
 type ResourceTypeType = EnumType<typeof ResourceType>;
 
@@ -1686,6 +1691,7 @@ interface BitJson {
     bookDiff: string;
     coverImage: string | string[];
     coverColor: string;
+    backgroundImage: string | string[];
     publisher: string | string[];
     publisherName: string;
     publications: string | string[];
@@ -2298,6 +2304,7 @@ interface Bit {
     bookDiff?: Property;
     coverImage?: Property | ImageResourceWrapperJson;
     coverColor?: Property;
+    backgroundImage?: Property | ImageResourceWrapperJson;
     publications?: Property;
     relatedBook?: Property;
     translationOfBook?: Property;
@@ -2617,6 +2624,8 @@ declare const NodeType: {
     readonly avatarImage: "avatarImage";
     readonly backgroundWallpaper: "backgroundWallpaper";
     readonly backgroundWallpaperValue: "backgroundWallpaperValue";
+    readonly backgroundImage: "backgroundImage";
+    readonly backgroundImageValue: "backgroundImageValue";
     readonly bitLevel: "bitLevel";
     readonly bitmarkAst: "bitmarkAst";
     readonly bitmarkVersion: "bitmarkVersion";
@@ -4163,6 +4172,7 @@ declare class Builder extends BaseBuilder {
         bookDiff?: string;
         coverImage?: string | string[] | Partial<ImageResourceWrapperJson>;
         coverColor?: string;
+        backgroundImage?: string | string[] | Partial<ImageResourceWrapperJson>;
         publications?: string | string[];
         relatedBook?: string | string[];
         translationOfBook?: string;
@@ -5589,6 +5599,8 @@ declare class BitmarkGenerator extends AstWalkerGenerator<BitmarkAst, void> {
     protected enter_platformBackgroundImage(node: NodeInfo, _route: NodeInfo[]): boolean;
     protected enter_coverImage(node: NodeInfo, route: NodeInfo[]): boolean;
     protected leaf_coverImage(node: NodeInfo, route: NodeInfo[]): void;
+    protected enter_backgroundImage(node: NodeInfo, route: NodeInfo[]): boolean;
+    protected leaf_backgroundImage(node: NodeInfo, route: NodeInfo[]): void;
     protected exit_imagePlaceholder(_node: NodeInfo, _route: NodeInfo[]): void;
     protected enter_posterImage(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_thumbnails(node: NodeInfo, route: NodeInfo[]): boolean;
@@ -5971,6 +5983,7 @@ declare class JsonGenerator extends AstWalkerGenerator<BitmarkAst, void> {
     protected enter_platformLogo(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_platformBackgroundImage(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_coverImage(node: NodeInfo, route: NodeInfo[]): boolean;
+    protected enter_backgroundImage(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_resources(node: NodeInfo, route: NodeInfo[]): boolean;
     protected leaf_level(node: NodeInfo, route: NodeInfo[]): boolean;
     protected enter_book(node: NodeInfo, route: NodeInfo[]): boolean;

package/dist/browser/esm/index.js

@@ -47,6 +47,8 @@ var BitType = {
   appFlashcardsQuiz: "app-flashcards-quiz",
   appGetScreenshot: "app-get-screenshot",
   appLink: "app-link",
+  appRag: "app-rag",
+  appSearch: "app-search",
   article: "article",
   articleAi: "article-ai",
   articleAlt: "article-alt",
@@ -1209,6 +1211,7 @@ var propertyKeys = {
   property_availableClassifications: "@availableClassifications",
   property_brandColor: "@brandColor",
   property_brandColorName: "@brandColorName",
+  property_backgroundImage: "@backgroundImage",
   property_blockId: "@blockId",
   property_book: "@book",
   property_bookAlias: "@bookAlias",
@@ -1505,7 +1508,8 @@ var resourceKeys = {
   resource_imagePlaceholder: "&imagePlaceholder",
   resource_previewImage: "&previewImage",
   resource_previewVideo: "&previewVideo",
-  resource_coverImage: "&coverImage"
+  resource_coverImage: "&coverImage",
+  resource_backgroundImage: "&backgroundImage"
 };
 
 // src/model/enum/ResourceType.ts
@@ -1735,7 +1739,8 @@ var ResourceType = {
   platformBackgroundImage: "platformBackgroundImage",
   previewImage: "previewImage",
   previewVideo: "previewVideo",
-  coverImage: "coverImage"
+  coverImage: "coverImage",
+  backgroundImage: "backgroundImage"
 };
 function resourceTypeToConfigKey(type) {
   return `&${stringUtils.kebabToCamel(type)}`;
@@ -3777,6 +3782,22 @@ var GROUPS = {
           }
         ]
       },
+      {
+        key: ConfigKey.property_backgroundImage,
+        description: "The background image(s) of the book",
+        format: TagFormat.plainText,
+        maxCount: Count.infinity
+      },
+      {
+        key: ConfigKey.resource_backgroundImage,
+        description: "The background image of the book",
+        chain: [
+          {
+            key: ConfigKey.group_resourceImageCommon,
+            description: "Common image properties for the background image resource"
+          }
+        ]
+      },
       {
         key: ConfigKey.property_coverColor,
         description: "The cover color of the book",
@@ -4998,6 +5019,16 @@ var BITS = {
     ],
     resourceAttachmentAllowed: false
   },
+  [BitType.appRag]: {
+    since: "5.14.0",
+    baseBitType: BitType.article,
+    description: "App RAG (Retrieval-Augmented Generation) bit, equal to article"
+  },
+  [BitType.appSearch]: {
+    since: "5.14.0",
+    baseBitType: BitType.article,
+    description: "App search bit, equal to article"
+  },
   [BitType.author]: {
     since: "4.2.0",
     baseBitType: BitType._standard,
@@ -10889,7 +10920,7 @@ var instance2 = new Config();
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser-generator",
-  "version": "5.13.0",
+  "version": "5.15.0",
   "author": "Get More Brain Ltd",
   "license": "ISC",
   "description": "A bitmark parser and generator using Peggy.js"
@@ -11279,6 +11310,8 @@ var NodeType = {
   avatarImage: "avatarImage",
   backgroundWallpaper: "backgroundWallpaper",
   backgroundWallpaperValue: "backgroundWallpaperValue",
+  backgroundImage: "backgroundImage",
+  backgroundImageValue: "backgroundImageValue",
   bitLevel: "bitLevel",
   // bit level
   bitmarkAst: "bitmarkAst",
@@ -23583,6 +23616,7 @@ var ResourceBuilder = class extends BaseBuilder {
       case ResourceType.platformBackgroundImage:
       case ResourceType.previewImage:
       case ResourceType.coverImage:
+      case ResourceType.backgroundImage:
         node = this.imageResource(context, finalData, type);
         break;
       // case ResourceType.imageResponsive: {
@@ -24862,6 +24896,12 @@ var Builder = class extends BaseBuilder {
         data.coverColor,
         options
       ),
+      backgroundImage: typeof data.backgroundImage === "string" || Array.isArray(data.backgroundImage) ? this.toAstProperty(
+        bitType,
+        ConfigKey.property_backgroundImage,
+        instance4.asArray(data.backgroundImage),
+        options
+      ) : this.toImageResource(context, data.backgroundImage),
       publications: this.toAstProperty(
         bitType,
         ConfigKey.property_publications,
@@ -28935,6 +28975,62 @@ var BitmarkGenerator = class extends AstWalkerGenerator {
       ignoreTrue: propertyConfig.defaultValue === "true"
     });
   }
+  // bitmarkAst -> bits -> bitsValue -> backgroundImage (when it's a resource object or property array)
+  enter_backgroundImage(node, route) {
+    const value = node.value;
+    if (value && typeof value === "object" && !Array.isArray(value) && "type" in value) {
+      const resource = value;
+      this.writeNL();
+      this.writePropertyStyleResource(node.key, resource);
+      return true;
+    }
+    if (Array.isArray(value)) {
+      if (value == null) return true;
+      const parent = this.getParentNode(route);
+      if (parent?.key !== NodeType.bitsValue) return true;
+      const bitType = this.getBitType(route);
+      if (!bitType) return true;
+      const config = instance2.getBitConfig(bitType);
+      const propertyConfig = instance2.getTagConfigForTag(
+        config.tags,
+        ConfigKey.property_backgroundImage
+      );
+      if (!propertyConfig) return true;
+      this.writeNL_IfNotChain(route);
+      this.writeProperty(propertyConfig.tag, value, route, {
+        format: propertyConfig.format ?? TagFormat.plainText,
+        array: propertyConfig.array ?? false,
+        writeEmpty: true,
+        ignoreFalse: propertyConfig.defaultValue === "false",
+        ignoreTrue: propertyConfig.defaultValue === "true"
+      });
+    }
+    return true;
+  }
+  // bitmarkAst -> bits -> bitsValue -> backgroundImage (when it's a property string)
+  // This is called when backgroundImage is a simple string value
+  leaf_backgroundImage(node, route) {
+    const value = node.value;
+    if (value == null) return;
+    const parent = this.getParentNode(route);
+    if (parent?.key !== NodeType.bitsValue) return;
+    const bitType = this.getBitType(route);
+    if (!bitType) return;
+    const config = instance2.getBitConfig(bitType);
+    const propertyConfig = instance2.getTagConfigForTag(
+      config.tags,
+      ConfigKey.property_backgroundImage
+    );
+    if (!propertyConfig) return;
+    this.writeNL_IfNotChain(route);
+    this.writeProperty(propertyConfig.tag, node.value, route, {
+      format: propertyConfig.format ?? TagFormat.plainText,
+      array: propertyConfig.array ?? false,
+      writeEmpty: true,
+      ignoreFalse: propertyConfig.defaultValue === "false",
+      ignoreTrue: propertyConfig.defaultValue === "true"
+    });
+  }
   exit_imagePlaceholder(_node, _route) {
   }
   // bitmarkAst -> bits -> bitsValue -> posterImage
@@ -30548,6 +30644,12 @@ var JsonGenerator = class extends AstWalkerGenerator {
       array: Array.isArray(node.value)
     });
   }
+  // bitmarkAst -> bits -> bitsValue -> backgroundImage
+  enter_backgroundImage(node, route) {
+    return this.standardHandler(node, route, NodeType.bitsValue, {
+      array: Array.isArray(node.value)
+    });
+  }
   // bitmarkAst -> bits -> bitsValue -> resources
   enter_resources(node, route) {
     const resources = node.value;
@@ -34998,7 +35100,7 @@ function resourceContentProcessor(context, _contentDepth, tagsConfig, content, t
     ...tags2
   });
   if (resource) {
-    if (configKey === ConfigKey.resource_backgroundWallpaper || configKey === ConfigKey.resource_imagePlaceholder || configKey === ConfigKey.resource_platformIcon || configKey === ConfigKey.resource_platformLogo || configKey === ConfigKey.resource_platformBackgroundImage || configKey === ConfigKey.resource_previewImage || configKey === ConfigKey.resource_previewVideo || configKey === ConfigKey.resource_coverImage) {
+    if (configKey === ConfigKey.resource_backgroundWallpaper || configKey === ConfigKey.resource_imagePlaceholder || configKey === ConfigKey.resource_platformIcon || configKey === ConfigKey.resource_platformLogo || configKey === ConfigKey.resource_platformBackgroundImage || configKey === ConfigKey.resource_previewImage || configKey === ConfigKey.resource_previewVideo || configKey === ConfigKey.resource_coverImage || configKey === ConfigKey.resource_backgroundImage) {
       if (target.propertyStyleResources) {
         if (target.propertyStyleResources[resourceType]) {
           if (!Array.isArray(target.propertyStyleResources[resourceType])) {