@gmb/bitmark-parser-generator 1.4.16 → 1.4.18

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

@@ -22,7 +22,7 @@ import { Ast } from '../../ast/Ast';
 import { Breakscape } from '../../breakscaping/Breakscape';
 import { Config } from '../../config/Config';
 import { NodeType } from '../../model/ast/NodeType';
-import { AliasBitType, RootBitType } from '../../model/enum/BitType';
+import { BitType } from '../../model/enum/BitType';
 import { BitmarkVersion, DEFAULT_BITMARK_VERSION } from '../../model/enum/BitmarkVersion';
 import { BodyBitType } from '../../model/enum/BodyBitType';
 import { ExampleType } from '../../model/enum/ExampleType';
@@ -218,7 +218,7 @@ class JsonGenerator {
             if (isBoolean) {
                 // Boolean example
                 defaultExample = true;
-                if (bit.bitType.root === RootBitType.trueFalse1) {
+                if (Config.isOfBitType(bit.bitType, BitType.trueFalse1)) {
                     if (((_b = (_a = bit.cardNode) === null || _a === void 0 ? void 0 : _a.statement) === null || _b === void 0 ? void 0 : _b.isCorrect) !== undefined) {
                         defaultExample = bit.cardNode.statement.isCorrect;
                     }
@@ -336,7 +336,7 @@ class JsonGenerator {
             return;
         // Create the listItems / sections if not already created
         let listItems;
-        if (bitType.alias === AliasBitType.pageFooter) {
+        if (bitType === BitType.pageFooter) {
             if (!this.bitJson.sections)
                 this.bitJson.sections = [];
             listItems = this.bitJson.sections;
@@ -943,13 +943,13 @@ class JsonGenerator {
                         excessResources.push(rJson);
                 }
             }
-            // Extract comments from the AST and add to the parser
-            const comments = Breakscape.unbreakscape(this.getInternalComments(route));
+            // Extract internal comments from the AST and add to the parser
+            const internalComments = 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,
-                    comments }, parserRest), { warnings,
+                    internalComments }, parserRest), { warnings,
                     errors,
                     excessResources });
                 if (!this.options.enableWarnings) {
@@ -1686,9 +1686,9 @@ class JsonGenerator {
             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:
+        switch (bitType) {
+            case BitType.imageSeparator:
+            case BitType.pageBanner:
                 return true;
         }
         return false;
@@ -1851,7 +1851,7 @@ class JsonGenerator {
      */
     createBitJson(bit) {
         const bitJson = {
-            type: bit.bitType.alias,
+            type: bit.bitType,
             format: bit.textFormat,
             // Properties
             id: undefined,
@@ -1889,6 +1889,8 @@ class JsonGenerator {
             thumbImage: undefined,
             focusX: undefined,
             focusY: undefined,
+            pointerLeft: undefined,
+            pointerTop: undefined,
             deeplink: undefined,
             externalLink: undefined,
             externalLinkText: undefined,
@@ -1907,6 +1909,9 @@ class JsonGenerator {
             resolvedDate: undefined,
             resolvedBy: undefined,
             maxCreatedBits: undefined,
+            product: undefined,
+            productVideo: undefined,
+            productFolder: undefined,
             // Book data
             title: undefined,
             subtitle: undefined,
@@ -1985,207 +1990,224 @@ class JsonGenerator {
         // NOTE: Not all bits have the same default properties.
         //       The properties used are a bit random sometimes?
         //       It would be better if this functionality was generated from the bit config
-        switch (bitType.root) {
-            case RootBitType._error:
-            case RootBitType._comment:
-                delete bitJson.format;
-                break;
-            case RootBitType.article:
-            case RootBitType.sampleSolution:
-            case RootBitType.page:
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                break;
-            default: // Most bits have these defaults, but there are special cases (not sure if that is by error or design)
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.hint == null)
-                    bitJson.hint = this.textDefault;
-                if (bitJson.isExample == null)
-                    bitJson.isExample = false;
-                if (bitJson.example == null)
-                    bitJson.example = null;
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                // Special case for 'ai' bits
-                if (bitType.alias === AliasBitType.articleAi ||
-                    bitType.alias === AliasBitType.noteAi ||
-                    bitType.alias === AliasBitType.summaryAi) {
-                    if (bitJson.AIGenerated == null)
-                        bitJson.AIGenerated = true;
-                }
-                // Special case for 'review-...' bits
-                if (bitType.root === RootBitType.reviewNote) {
-                    if (bitJson.resolved == null)
-                        bitJson.resolved = false;
-                    if (bitJson.resolvedDate == null)
-                        bitJson.resolvedDate = '';
-                    if (bitJson.resolvedBy == null)
-                        bitJson.resolvedBy = '';
-                }
-                break;
+        if (Config.isOfBitType(bitType, [BitType._error, BitType._comment])) {
+            //
+            delete bitJson.format;
+            //
+        }
+        else if (Config.isOfBitType(bitType, [BitType.article, BitType.sampleSolution, BitType.page])) {
+            //
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            //
+        }
+        else if (Config.isOfBitType(bitType, [
+            BitType.cloze,
+            BitType.multipleChoice1,
+            BitType.multipleResponse1,
+            BitType.multipleChoiceText,
+            BitType.highlightText,
+            BitType.clozeAndMultipleChoiceText,
+            BitType.sequence,
+            BitType.mark,
+            BitType.flashcard,
+        ])) {
             // Default, but with no 'example' at the bit level.
-            case RootBitType.cloze:
-            case RootBitType.multipleChoice1:
-            case RootBitType.multipleResponse1:
-            case RootBitType.multipleChoiceText:
-            case RootBitType.highlightText:
-            case RootBitType.clozeAndMultipleChoiceText:
-            case RootBitType.sequence:
-            case RootBitType.mark:
-            case RootBitType.flashcard:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.hint == null)
-                    bitJson.hint = this.textDefault;
-                if (bitJson.instruction == null)
-                    bitJson.instruction = this.textDefault;
-                if (bitJson.isExample == null)
-                    bitJson.isExample = false;
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                break;
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.hint == null)
+                bitJson.hint = this.textDefault;
+            if (bitJson.instruction == null)
+                bitJson.instruction = this.textDefault;
+            if (bitJson.isExample == null)
+                bitJson.isExample = false;
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            //
+        }
+        else if (Config.isOfBitType(bitType, [BitType.multipleChoice, BitType.multipleResponse])) {
             // Default with a card (and hence a footer possibility)
-            case RootBitType.multipleChoice:
-            case RootBitType.multipleResponse:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.hint == null)
-                    bitJson.hint = this.textDefault;
-                if (bitJson.instruction == null)
-                    bitJson.instruction = this.textDefault;
-                if (bitJson.isExample == null)
-                    bitJson.isExample = false;
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                if (bitJson.footer == null)
-                    bitJson.footer = this.textDefault;
-                break;
-            case RootBitType.essay:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.hint == null)
-                    bitJson.hint = this.textDefault;
-                if (bitJson.instruction == null)
-                    bitJson.instruction = this.textDefault;
-                if (bitJson.isExample == null)
-                    bitJson.isExample = false;
-                if (bitJson.example == null)
-                    bitJson.example = null;
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                if (bitJson.partialAnswer == null)
-                    bitJson.partialAnswer = '';
-                // if (bitJson.sampleSolution == null) bitJson.sampleSolution = '';
-                break;
-            case RootBitType.trueFalse1:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.lead == null)
-                    bitJson.lead = this.textDefault;
-                if (bitJson.hint == null)
-                    bitJson.hint = this.textDefault;
-                if (bitJson.instruction == null)
-                    bitJson.instruction = this.textDefault;
-                if (bitJson.isExample == null)
-                    bitJson.isExample = false;
-                if (bitJson.example == null)
-                    bitJson.example = null;
-                if (bitJson.isCorrect == null)
-                    bitJson.isCorrect = false;
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                break;
-            case RootBitType.trueFalse:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.lead == null)
-                    bitJson.lead = this.textDefault;
-                if (bitJson.hint == null)
-                    bitJson.hint = this.textDefault;
-                if (bitJson.instruction == null)
-                    bitJson.instruction = this.textDefault;
-                if (bitJson.isExample == null)
-                    bitJson.isExample = false;
-                if (bitJson.labelFalse == null)
-                    bitJson.labelFalse = '';
-                if (bitJson.labelTrue == null)
-                    bitJson.labelTrue = '';
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                break;
-            case RootBitType.chapter:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.hint == null)
-                    bitJson.hint = this.textDefault;
-                if (bitJson.isExample == null)
-                    bitJson.isExample = false;
-                if (bitJson.example == null)
-                    bitJson.example = null;
-                if (bitJson.toc == null)
-                    bitJson.toc = true; // Always set on chapter bits?
-                if (bitJson.progress == null)
-                    bitJson.progress = true; // Always set on chapter bits
-                if (bitJson.level == null)
-                    bitJson.level = 1; // Set level 1 if none set (makes no sense, but in ANTLR parser)
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                break;
-            case RootBitType.interview:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.hint == null)
-                    bitJson.hint = this.textDefault;
-                if (bitJson.instruction == null)
-                    bitJson.instruction = this.textDefault;
-                if (bitJson.isExample == null)
-                    bitJson.isExample = false;
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                if (bitJson.footer == null)
-                    bitJson.footer = this.textDefault;
-                if (bitJson.questions == null)
-                    bitJson.questions = [];
-                break;
-            case RootBitType.match:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.heading == null)
-                    bitJson.heading = {};
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                break;
-            case RootBitType.matchMatrix:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                break;
-            case RootBitType.learningPathBook:
-            case RootBitType.learningPathExternalLink:
-            case RootBitType.learningPathVideoCall:
-                if (bitJson.item == null)
-                    bitJson.item = this.textDefault;
-                if (bitJson.hint == null)
-                    bitJson.hint = this.textDefault;
-                if (bitJson.isExample == null)
-                    bitJson.isExample = false;
-                if (bitJson.example == null)
-                    bitJson.example = null;
-                if (bitJson.isTracked == null)
-                    bitJson.isTracked = true;
-                if (bitJson.isInfoOnly == null)
-                    bitJson.isInfoOnly = false;
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                break;
-            case RootBitType.pageBuyButton:
-                if (bitJson.content2Buy == null)
-                    bitJson.content2Buy = '';
-                if (bitJson.body == null)
-                    bitJson.body = this.bodyDefault;
-                break;
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.hint == null)
+                bitJson.hint = this.textDefault;
+            if (bitJson.instruction == null)
+                bitJson.instruction = this.textDefault;
+            if (bitJson.isExample == null)
+                bitJson.isExample = false;
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            if (bitJson.footer == null)
+                bitJson.footer = this.textDefault;
+            //
+        }
+        else if (Config.isOfBitType(bitType, BitType.essay)) {
+            //
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.hint == null)
+                bitJson.hint = this.textDefault;
+            if (bitJson.instruction == null)
+                bitJson.instruction = this.textDefault;
+            if (bitJson.isExample == null)
+                bitJson.isExample = false;
+            if (bitJson.example == null)
+                bitJson.example = null;
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            if (bitJson.partialAnswer == null)
+                bitJson.partialAnswer = '';
+            // if (bitJson.sampleSolution == null) bitJson.sampleSolution = '';
+            //
+        }
+        else if (Config.isOfBitType(bitType, BitType.trueFalse1)) {
+            //
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.lead == null)
+                bitJson.lead = this.textDefault;
+            if (bitJson.hint == null)
+                bitJson.hint = this.textDefault;
+            if (bitJson.instruction == null)
+                bitJson.instruction = this.textDefault;
+            if (bitJson.isExample == null)
+                bitJson.isExample = false;
+            if (bitJson.example == null)
+                bitJson.example = null;
+            if (bitJson.isCorrect == null)
+                bitJson.isCorrect = false;
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            //
+        }
+        else if (Config.isOfBitType(bitType, BitType.trueFalse)) {
+            //
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.lead == null)
+                bitJson.lead = this.textDefault;
+            if (bitJson.hint == null)
+                bitJson.hint = this.textDefault;
+            if (bitJson.instruction == null)
+                bitJson.instruction = this.textDefault;
+            if (bitJson.isExample == null)
+                bitJson.isExample = false;
+            if (bitJson.labelFalse == null)
+                bitJson.labelFalse = '';
+            if (bitJson.labelTrue == null)
+                bitJson.labelTrue = '';
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            //
+        }
+        else if (Config.isOfBitType(bitType, BitType.chapter)) {
+            //
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.hint == null)
+                bitJson.hint = this.textDefault;
+            if (bitJson.isExample == null)
+                bitJson.isExample = false;
+            if (bitJson.example == null)
+                bitJson.example = null;
+            if (bitJson.toc == null)
+                bitJson.toc = true; // Always set on chapter bits?
+            if (bitJson.progress == null)
+                bitJson.progress = true; // Always set on chapter bits
+            if (bitJson.level == null)
+                bitJson.level = 1; // Set level 1 if none set (makes no sense, but in ANTLR parser)
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            //
+        }
+        else if (Config.isOfBitType(bitType, BitType.interview)) {
+            //
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.hint == null)
+                bitJson.hint = this.textDefault;
+            if (bitJson.instruction == null)
+                bitJson.instruction = this.textDefault;
+            if (bitJson.isExample == null)
+                bitJson.isExample = false;
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            if (bitJson.footer == null)
+                bitJson.footer = this.textDefault;
+            if (bitJson.questions == null)
+                bitJson.questions = [];
+            //
+        }
+        else if (bitType === BitType.matchMatrix) {
+            //
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            //
+        }
+        else if (Config.isOfBitType(bitType, BitType.match)) {
+            //
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.heading == null)
+                bitJson.heading = {};
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            //
+        }
+        else if (Config.isOfBitType(bitType, BitType.learningPathBook)) {
+            //
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.hint == null)
+                bitJson.hint = this.textDefault;
+            if (bitJson.isExample == null)
+                bitJson.isExample = false;
+            if (bitJson.example == null)
+                bitJson.example = null;
+            if (bitJson.isTracked == null)
+                bitJson.isTracked = true;
+            if (bitJson.isInfoOnly == null)
+                bitJson.isInfoOnly = false;
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            //
+        }
+        else if (Config.isOfBitType(bitType, BitType.pageBuyButton)) {
+            //
+            if (bitJson.content2Buy == null)
+                bitJson.content2Buy = '';
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            //
+        }
+        else {
+            // Most bits have these defaults, but there are special cases (not sure if that is by error or design)
+            if (bitJson.item == null)
+                bitJson.item = this.textDefault;
+            if (bitJson.hint == null)
+                bitJson.hint = this.textDefault;
+            if (bitJson.isExample == null)
+                bitJson.isExample = false;
+            if (bitJson.example == null)
+                bitJson.example = null;
+            if (bitJson.body == null)
+                bitJson.body = this.bodyDefault;
+            // Special case for 'ai' bits
+            if (bitType === BitType.articleAi || bitType === BitType.noteAi || bitType === BitType.summaryAi) {
+                if (bitJson.AIGenerated == null)
+                    bitJson.AIGenerated = true;
+            }
+            // Special case for 'review-...' bits
+            if (Config.isOfBitType(bitType, BitType.reviewNote)) {
+                if (bitJson.resolved == null)
+                    bitJson.resolved = false;
+                if (bitJson.resolvedDate == null)
+                    bitJson.resolvedDate = '';
+                if (bitJson.resolvedBy == null)
+                    bitJson.resolvedBy = '';
+            }
         }
         // Remove unwanted properties
         // Properties
@@ -2289,6 +2311,12 @@ class JsonGenerator {
             delete bitJson.resolvedBy;
         if (bitJson.maxCreatedBits == null)
             delete bitJson.maxCreatedBits;
+        if (bitJson.product == null)
+            delete bitJson.product;
+        if (bitJson.productVideo == null)
+            delete bitJson.productVideo;
+        if (bitJson.productFolder == null)
+            delete bitJson.productFolder;
         // Book data
         if (bitJson.title == null)
             delete bitJson.title;