@gmb/bitmark-parser-generator 1.4.14 → 1.4.16

package/dist/esm/generator/json/JsonGenerator.js

@@ -259,16 +259,17 @@ class JsonGenerator {
         this.bitJson.imageSource = imageSourceJson;
     }
     // bitmarkAst -> bits -> bitsValue -> partner
-    enter_partner(node, parent, _route) {
+    enter_partner(node, parent, route) {
         const partner = node.value;
+        const bitType = this.getBitType(route);
         // Ignore values that are not at the bit level as they might be handled elsewhere
-        if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.bitsValue)
+        if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.bitsValue || !bitType)
             return;
         const { name, avatarImage } = partner;
         const partnerJson = {};
         this.addProperty(partnerJson, 'name', name !== null && name !== void 0 ? name : '', true);
         if (avatarImage) {
-            const res = this.parseResourceToJson(avatarImage);
+            const res = this.parseResourceToJson(bitType, avatarImage);
             if (res && res.type === ResourceTag.image) {
                 partnerJson.avatarImage = res.image;
             }
@@ -682,16 +683,17 @@ class JsonGenerator {
         this.bitJson.heading = headingJson;
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> pairs
-    enter_pairs(node, _parent, _route) {
+    enter_pairs(node, _parent, route) {
         var _a, _b, _c, _d;
         const pairs = node.value;
         const pairsJson = [];
-        if (pairs) {
+        const bitType = this.getBitType(route);
+        if (pairs && bitType) {
             for (const p of pairs) {
                 // Get default example
                 const defaultExample = Array.isArray(p.values) && p.values.length > 0 && p.values[0];
                 // Create the question
-                const pairJson = Object.assign(Object.assign(Object.assign({ key: (_a = Breakscape.unbreakscape(p.key)) !== null && _a !== void 0 ? _a : '', keyAudio: p.keyAudio ? this.addAudioResource(p.keyAudio) : undefined, keyImage: p.keyImage ? this.addImageResource(p.keyImage) : undefined, values: (_b = Breakscape.unbreakscape(p.values)) !== null && _b !== void 0 ? _b : [] }, this.toItemLeadHintInstruction(p)), { isCaseSensitive: (_c = p.isCaseSensitive) !== null && _c !== void 0 ? _c : true }), this.toExample(p, {
+                const pairJson = Object.assign(Object.assign(Object.assign({ key: (_a = Breakscape.unbreakscape(p.key)) !== null && _a !== void 0 ? _a : '', keyAudio: p.keyAudio ? this.addAudioResource(bitType, p.keyAudio) : undefined, keyImage: p.keyImage ? this.addImageResource(bitType, p.keyImage) : undefined, values: (_b = Breakscape.unbreakscape(p.values)) !== null && _b !== void 0 ? _b : [] }, this.toItemLeadHintInstruction(p)), { isCaseSensitive: (_c = p.isCaseSensitive) !== null && _c !== void 0 ? _c : true }), this.toExample(p, {
                     defaultExample,
                     isBoolean: false,
                 }));
@@ -836,7 +838,7 @@ class JsonGenerator {
                     if (r) {
                         const tagConfig = Config.getTagConfigForTag(bitConfig.tags, r.typeAlias);
                         const key = (_a = tagConfig === null || tagConfig === void 0 ? void 0 : tagConfig.jsonKey) !== null && _a !== void 0 ? _a : r.typeAlias;
-                        const json = this.parseResourceToJson(r);
+                        const json = this.parseResourceToJson(bitType, r);
                         if (json) {
                             for (const [k, v] of Object.entries(json)) {
                                 if (k !== 'type') {
@@ -854,7 +856,7 @@ class JsonGenerator {
             // This is a standard resource. If there is more than one resource, use the first one.
             // There should not be more than one because of validation
             if (resources.length >= 1) {
-                resourceJson = this.parseResourceToJson(resources[0]);
+                resourceJson = this.parseResourceToJson(bitType, resources[0]);
             }
         }
         this.bitJson.resource = resourceJson;
@@ -924,9 +926,11 @@ class JsonGenerator {
             this.bitWrapperJson.bitmark = bitmark;
     }
     // bitmarkAst -> bits -> bitsValue -> parser
-    enter_parser(node, parent, _route) {
+    // bitmarkAst -> bits -> bitsValue -> * -> internalComment
+    enter_parser(node, parent, route) {
         const parser = node.value;
-        if (parser) {
+        const bitType = this.getBitType(route);
+        if (parser && bitType) {
             const { version, excessResources: parserExcessResources, warnings, errors } = parser, parserRest = __rest(parser, ["version", "excessResources", "warnings", "errors"]);
             const bitmarkVersion = `${this.bitmarkVersion}`;
             // Parse resources to JSON from AST
@@ -934,15 +938,18 @@ class JsonGenerator {
             if (Array.isArray(parserExcessResources) && parserExcessResources.length > 0) {
                 excessResources = [];
                 for (const r of parserExcessResources) {
-                    const rJson = this.parseResourceToJson(r);
+                    const rJson = this.parseResourceToJson(bitType, r);
                     if (rJson)
                         excessResources.push(rJson);
                 }
             }
+            // Extract comments from the AST and add to the parser
+            const comments = Breakscape.unbreakscape(this.getInternalComments(route));
             if ((parent === null || parent === void 0 ? void 0 : parent.key) === NodeType.bitsValue) {
                 // Bit level parser information
                 this.bitWrapperJson.parser = Object.assign(Object.assign({ version,
-                    bitmarkVersion }, parserRest), { warnings,
+                    bitmarkVersion,
+                    comments }, parserRest), { warnings,
                     errors,
                     excessResources });
                 if (!this.options.enableWarnings) {
@@ -983,6 +990,8 @@ class JsonGenerator {
         for (const propertyConfig of Object.values(propertiesConfig)) {
             const astKey = (_a = propertyConfig.astKey) !== null && _a !== void 0 ? _a : propertyConfig.tag;
             // Special cases (handled outside of the automatically generated handlers)
+            if (astKey === PropertyTag.internalComment)
+                continue;
             if (astKey === PropertyTag.example)
                 continue;
             if (astKey === PropertyTag.imageSource)
@@ -1094,7 +1103,7 @@ class JsonGenerator {
             delete highlightJson.lead;
         return highlightJson;
     }
-    parseResourceToJson(resource) {
+    parseResourceToJson(bitType, resource) {
         if (!resource)
             return undefined;
         // All resources should now be valid as they are validated in the AST
@@ -1112,111 +1121,111 @@ class JsonGenerator {
             case ResourceTag.image:
                 resourceJson = {
                     type: ResourceTag.image,
-                    image: this.addImageResource(resource),
+                    image: this.addImageResource(bitType, resource),
                 };
                 break;
             case ResourceTag.imageLink:
                 resourceJson = {
                     type: ResourceTag.imageLink,
-                    imageLink: this.addImageLinkResource(resource),
+                    imageLink: this.addImageLinkResource(bitType, resource),
                 };
                 break;
             case ResourceTag.audio:
                 resourceJson = {
                     type: ResourceTag.audio,
-                    audio: this.addAudioResource(resource),
+                    audio: this.addAudioResource(bitType, resource),
                 };
                 break;
             case ResourceTag.audioEmbed:
                 resourceJson = {
                     type: ResourceTag.audioEmbed,
-                    audioEmbed: this.addAudioEmbedResource(resource),
+                    audioEmbed: this.addAudioEmbedResource(bitType, resource),
                 };
                 break;
             case ResourceTag.audioLink:
                 resourceJson = {
                     type: ResourceTag.audioLink,
-                    audioLink: this.addAudioLinkResource(resource),
+                    audioLink: this.addAudioLinkResource(bitType, resource),
                 };
                 break;
             case ResourceTag.video:
                 resourceJson = {
                     type: ResourceTag.video,
-                    video: this.addVideoResource(resource),
+                    video: this.addVideoResource(bitType, resource),
                 };
                 break;
             case ResourceTag.videoEmbed:
                 resourceJson = {
                     type: ResourceTag.videoEmbed,
-                    videoEmbed: this.addVideoEmbedResource(resource),
+                    videoEmbed: this.addVideoEmbedResource(bitType, resource),
                 };
-                resourceJson.videoEmbed = this.addVideoLinkResource(resource);
+                resourceJson.videoEmbed = this.addVideoLinkResource(bitType, resource);
                 break;
             case ResourceTag.videoLink:
                 resourceJson = {
                     type: ResourceTag.videoLink,
-                    videoLink: this.addVideoLinkResource(resource),
+                    videoLink: this.addVideoLinkResource(bitType, resource),
                 };
                 break;
             case ResourceTag.stillImageFilmEmbed:
                 resourceJson = {
                     type: ResourceTag.stillImageFilmEmbed,
-                    stillImageFilmEmbed: this.addStillImageFilmEmbedResource(resource),
+                    stillImageFilmEmbed: this.addStillImageFilmEmbedResource(bitType, resource),
                 };
                 break;
             case ResourceTag.stillImageFilmLink:
                 resourceJson = {
                     type: ResourceTag.stillImageFilmLink,
-                    stillImageFilmLink: this.addStillImageFilmLinkResource(resource),
+                    stillImageFilmLink: this.addStillImageFilmLinkResource(bitType, resource),
                 };
                 break;
             case ResourceTag.article:
                 resourceJson = {
                     type: ResourceTag.article,
-                    article: this.addArticleResource(resource),
+                    article: this.addArticleResource(bitType, resource),
                 };
                 break;
             case ResourceTag.document:
                 resourceJson = {
                     type: ResourceTag.document,
-                    document: this.addDocumentResource(resource),
+                    document: this.addDocumentResource(bitType, resource),
                 };
                 break;
             case ResourceTag.documentEmbed:
                 resourceJson = {
                     type: ResourceTag.documentEmbed,
-                    documentEmbed: this.addDocumentEmbedResource(resource),
+                    documentEmbed: this.addDocumentEmbedResource(bitType, resource),
                 };
                 break;
             case ResourceTag.documentLink:
                 resourceJson = {
                     type: ResourceTag.documentLink,
-                    documentLink: this.addDocumentLinkResource(resource),
+                    documentLink: this.addDocumentLinkResource(bitType, resource),
                 };
                 break;
             case ResourceTag.documentDownload:
                 resourceJson = {
                     type: ResourceTag.documentDownload,
-                    documentDownload: this.addDocumentDownloadResource(resource),
+                    documentDownload: this.addDocumentDownloadResource(bitType, resource),
                 };
                 break;
             case ResourceTag.appLink:
                 resourceJson = {
                     type: ResourceTag.appLink,
-                    appLink: this.addAppLinkResource(resource),
+                    appLink: this.addAppLinkResource(bitType, resource),
                 };
                 break;
             case ResourceTag.websiteLink:
                 resourceJson = {
                     type: ResourceTag.websiteLink,
-                    websiteLink: this.addWebsiteLinkResource(resource),
+                    websiteLink: this.addWebsiteLinkResource(bitType, resource),
                 };
                 break;
             default:
         }
         return resourceJson;
     }
-    addImageResource(resource) {
+    addImageResource(bitType, resource) {
         var _a, _b, _c;
         const resourceJson = {};
         if (StringUtils.isString(resource)) {
@@ -1247,10 +1256,11 @@ class JsonGenerator {
         resourceJson.width = (_a = resource.width) !== null && _a !== void 0 ? _a : null;
         resourceJson.height = (_b = resource.height) !== null && _b !== void 0 ? _b : null;
         resourceJson.alt = (_c = Breakscape.unbreakscape(resource.alt)) !== null && _c !== void 0 ? _c : '';
-        this.addGenericResourceProperties(resource, resourceJson);
+        resourceJson.zoomDisabled = this.getZoomDisabled(bitType, resource.zoomDisabled);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addImageLinkResource(resource) {
+    addImageLinkResource(bitType, resource) {
         var _a, _b, _c;
         const resourceJson = {};
         if (StringUtils.isString(resource)) {
@@ -1281,10 +1291,11 @@ class JsonGenerator {
         resourceJson.width = (_a = resource.width) !== null && _a !== void 0 ? _a : null;
         resourceJson.height = (_b = resource.height) !== null && _b !== void 0 ? _b : null;
         resourceJson.alt = (_c = Breakscape.unbreakscape(resource.alt)) !== null && _c !== void 0 ? _c : '';
-        this.addGenericResourceProperties(resource, resourceJson);
+        resourceJson.zoomDisabled = this.getZoomDisabled(bitType, resource.zoomDisabled);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addAudioResource(resource) {
+    addAudioResource(bitType, resource) {
         const resourceJson = {};
         if (resource.format != null)
             resourceJson.format = Breakscape.unbreakscape(resource.format);
@@ -1298,10 +1309,10 @@ class JsonGenerator {
             resourceJson.mute = resource.mute;
         if (resource.autoplay != null)
             resourceJson.autoplay = resource.autoplay;
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addAudioEmbedResource(resource) {
+    addAudioEmbedResource(bitType, resource) {
         const resourceJson = {};
         if (resource.format != null)
             resourceJson.format = Breakscape.unbreakscape(resource.format);
@@ -1315,10 +1326,10 @@ class JsonGenerator {
             resourceJson.mute = resource.mute;
         if (resource.autoplay != null)
             resourceJson.autoplay = resource.autoplay;
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addAudioLinkResource(resource) {
+    addAudioLinkResource(bitType, resource) {
         const resourceJson = {};
         if (resource.format != null)
             resourceJson.format = Breakscape.unbreakscape(resource.format);
@@ -1332,10 +1343,10 @@ class JsonGenerator {
             resourceJson.mute = resource.mute;
         if (resource.autoplay != null)
             resourceJson.autoplay = resource.autoplay;
-        this.addGenericResourceProperties(resource, resourceJson, true);
+        this.addGenericResourceProperties(bitType, resource, resourceJson, true);
         return resourceJson;
     }
-    addVideoResource(resource) {
+    addVideoResource(bitType, resource) {
         var _a, _b;
         const resourceJson = {};
         if (resource.format != null)
@@ -1359,17 +1370,17 @@ class JsonGenerator {
         if (resource.alt != null)
             resourceJson.alt = Breakscape.unbreakscape(resource.alt);
         if (resource.posterImage != null)
-            resourceJson.posterImage = this.addImageResource(resource.posterImage);
+            resourceJson.posterImage = this.addImageResource(bitType, resource.posterImage);
         if (resource.thumbnails != null && resource.thumbnails.length > 0) {
             resourceJson.thumbnails = [];
             for (const thumbnail of resource.thumbnails) {
-                resourceJson.thumbnails.push(this.addImageResource(thumbnail));
+                resourceJson.thumbnails.push(this.addImageResource(bitType, thumbnail));
             }
         }
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addVideoEmbedResource(resource) {
+    addVideoEmbedResource(bitType, resource) {
         var _a, _b;
         const resourceJson = {};
         if (resource.format != null)
@@ -1393,17 +1404,17 @@ class JsonGenerator {
         if (resource.alt != null)
             resourceJson.alt = Breakscape.unbreakscape(resource.alt);
         if (resource.posterImage != null)
-            resourceJson.posterImage = this.addImageResource(resource.posterImage);
+            resourceJson.posterImage = this.addImageResource(bitType, resource.posterImage);
         if (resource.thumbnails != null && resource.thumbnails.length > 0) {
             resourceJson.thumbnails = [];
             for (const thumbnail of resource.thumbnails) {
-                resourceJson.thumbnails.push(this.addImageResource(thumbnail));
+                resourceJson.thumbnails.push(this.addImageResource(bitType, thumbnail));
             }
         }
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addVideoLinkResource(resource) {
+    addVideoLinkResource(bitType, resource) {
         var _a, _b;
         const resourceJson = {};
         if (resource.format != null)
@@ -1427,17 +1438,17 @@ class JsonGenerator {
         if (resource.alt != null)
             resourceJson.alt = Breakscape.unbreakscape(resource.alt);
         if (resource.posterImage != null)
-            resourceJson.posterImage = this.addImageResource(resource.posterImage);
+            resourceJson.posterImage = this.addImageResource(bitType, resource.posterImage);
         if (resource.thumbnails != null && resource.thumbnails.length > 0) {
             resourceJson.thumbnails = [];
             for (const thumbnail of resource.thumbnails) {
-                resourceJson.thumbnails.push(this.addImageResource(thumbnail));
+                resourceJson.thumbnails.push(this.addImageResource(bitType, thumbnail));
             }
         }
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addStillImageFilmEmbedResource(resource) {
+    addStillImageFilmEmbedResource(bitType, resource) {
         var _a, _b;
         const resourceJson = {};
         if (resource.format != null)
@@ -1461,17 +1472,17 @@ class JsonGenerator {
         if (resource.alt != null)
             resourceJson.alt = Breakscape.unbreakscape(resource.alt);
         if (resource.posterImage != null)
-            resourceJson.posterImage = this.addImageResource(resource.posterImage);
+            resourceJson.posterImage = this.addImageResource(bitType, resource.posterImage);
         if (resource.thumbnails != null && resource.thumbnails.length > 0) {
             resourceJson.thumbnails = [];
             for (const thumbnail of resource.thumbnails) {
-                resourceJson.thumbnails.push(this.addImageResource(thumbnail));
+                resourceJson.thumbnails.push(this.addImageResource(bitType, thumbnail));
             }
         }
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addStillImageFilmLinkResource(resource) {
+    addStillImageFilmLinkResource(bitType, resource) {
         var _a, _b;
         const resourceJson = {};
         if (resource.format != null)
@@ -1495,17 +1506,17 @@ class JsonGenerator {
         if (resource.alt != null)
             resourceJson.alt = Breakscape.unbreakscape(resource.alt);
         if (resource.posterImage != null)
-            resourceJson.posterImage = this.addImageResource(resource.posterImage);
+            resourceJson.posterImage = this.addImageResource(bitType, resource.posterImage);
         if (resource.thumbnails != null && resource.thumbnails.length > 0) {
             resourceJson.thumbnails = [];
             for (const thumbnail of resource.thumbnails) {
-                resourceJson.thumbnails.push(this.addImageResource(thumbnail));
+                resourceJson.thumbnails.push(this.addImageResource(bitType, thumbnail));
             }
         }
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addArticleResource(resource) {
+    addArticleResource(bitType, resource) {
         const resourceJson = {};
         if (resource.format != null)
             resourceJson.format = Breakscape.unbreakscape(resource.format);
@@ -1514,10 +1525,10 @@ class JsonGenerator {
         if (resource.value != null)
             resourceJson.body = Breakscape.unbreakscape(resource.value);
         // if (resource.href != null) resourceJson.href = BreakscapeUtils.unbreakscape(resource.href); // It is never used (and doesn't exist in the AST model)
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addDocumentResource(resource) {
+    addDocumentResource(bitType, resource) {
         const resourceJson = {};
         if (resource.format != null)
             resourceJson.format = Breakscape.unbreakscape(resource.format);
@@ -1526,10 +1537,10 @@ class JsonGenerator {
         if (resource.value != null)
             resourceJson.url = Breakscape.unbreakscape(resource.value);
         // if (resource.href != null) resourceJson.href = BreakscapeUtils.unbreakscape(resource.href); // It is never used (and doesn't exist in the AST model)
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addDocumentEmbedResource(resource) {
+    addDocumentEmbedResource(bitType, resource) {
         const resourceJson = {};
         if (resource.format != null)
             resourceJson.format = Breakscape.unbreakscape(resource.format);
@@ -1538,10 +1549,10 @@ class JsonGenerator {
         if (resource.value != null)
             resourceJson.url = Breakscape.unbreakscape(resource.value);
         // if (resource.href != null) resourceJson.href = BreakscapeUtils.unbreakscape(resource.href); // It is never used (and doesn't exist in the AST model)
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addDocumentLinkResource(resource) {
+    addDocumentLinkResource(bitType, resource) {
         const resourceJson = {};
         if (resource.format != null)
             resourceJson.format = Breakscape.unbreakscape(resource.format);
@@ -1550,10 +1561,10 @@ class JsonGenerator {
         if (resource.value != null)
             resourceJson.url = Breakscape.unbreakscape(resource.value);
         // if (resource.href != null) resourceJson.href = BreakscapeUtils.unbreakscape(resource.href); // It is never used (and doesn't exist in the AST model)
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addDocumentDownloadResource(resource) {
+    addDocumentDownloadResource(bitType, resource) {
         const resourceJson = {};
         if (resource.format != null)
             resourceJson.format = Breakscape.unbreakscape(resource.format);
@@ -1562,28 +1573,28 @@ class JsonGenerator {
         if (resource.value != null)
             resourceJson.url = Breakscape.unbreakscape(resource.value);
         // if (resource.href != null) resourceJson.href = resource.href; // It is never used (and doesn't exist in the AST model)
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addAppLinkResource(resource) {
+    addAppLinkResource(bitType, resource) {
         const resourceJson = {};
         // if (resource.format != null) resourceJson.format = BreakscapeUtils.unbreakscape(resource.format);
         if (resource.value != null)
             resourceJson.url = Breakscape.unbreakscape(resource.value);
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addWebsiteLinkResource(resource) {
+    addWebsiteLinkResource(bitType, resource) {
         const resourceJson = {};
         // if (resource.format != null) resourceJson.format = BreakscapeUtils.unbreakscape(resource.format);
         if (resource.value != null)
             resourceJson.url = Breakscape.unbreakscape(resource.value);
         if (resource.siteName != null)
             resourceJson.siteName = Breakscape.unbreakscape(resource.siteName);
-        this.addGenericResourceProperties(resource, resourceJson);
+        this.addGenericResourceProperties(bitType, resource, resourceJson);
         return resourceJson;
     }
-    addGenericResourceProperties(resource, resourceJson, noDefaults) {
+    addGenericResourceProperties(_bitType, resource, resourceJson, noDefaults) {
         var _a, _b, _c, _d, _e, _f, _g, _h;
         if (noDefaults) {
             if (resource.license != null)
@@ -1663,10 +1674,29 @@ class JsonGenerator {
             // }
         }
     }
+    /**
+     * Get the value for the zoomDisabled property, setting the appropriate default value if no value is set.
+     *
+     * @param bitType
+     * @param zoomDisabled
+     * @returns
+     */
+    getZoomDisabled(bitType, zoomDisabled) {
+        if (zoomDisabled != null)
+            return zoomDisabled;
+        // The default value in the JSON is hardcoded, because there is currently no good way to set a different
+        // default per bit in the BitConfig.
+        switch (bitType.alias) {
+            case AliasBitType.imageSeparator:
+            case AliasBitType.pageBanner:
+                return true;
+        }
+        return false;
+    }
     /**
      * Get the bit type from any node
      *
-     * @param route the route to the node
+     * @param route the route to the current node
      * @returns the bit type
      */
     getBitType(route) {
@@ -1681,7 +1711,7 @@ class JsonGenerator {
     /**
      * Get the text format from any node
      *
-     * @param route the route to the node
+     * @param route the route to the current node
      * @returns the text format
      */
     getTextFormat(route) {
@@ -1701,7 +1731,7 @@ class JsonGenerator {
     /**
      * Get the bit resourceType atttachment from any node
      *
-     * @param route the route to the node
+     * @param route the route to the current node
      * @returns the bit type
      */
     getResourceType(route) {
@@ -1713,6 +1743,24 @@ class JsonGenerator {
         }
         return undefined;
     }
+    /**
+     * Get the internal comments from any node
+     *
+     * @param route the route to the current node
+     * @returns the text format
+     */
+    getInternalComments(route) {
+        const bitType = this.getBitType(route);
+        if (bitType) {
+            for (const node of route) {
+                if (node.key === NodeType.bitsValue) {
+                    const n = node.value;
+                    return n.internalComment;
+                }
+            }
+        }
+        return undefined;
+    }
     /**
      * Convert the text from the AST to the JSON format:
      * Input:
@@ -1807,6 +1855,7 @@ class JsonGenerator {
             format: bit.textFormat,
             // Properties
             id: undefined,
+            internalComment: undefined,
             externalId: undefined,
             spaceId: undefined,
             padletId: undefined,
@@ -2142,6 +2191,8 @@ class JsonGenerator {
         // Properties
         if (bitJson.id == null)
             delete bitJson.id;
+        if (bitJson.internalComment == null)
+            delete bitJson.internalComment;
         if (bitJson.externalId == null)
             delete bitJson.externalId;
         if (bitJson.spaceId == null)