@gmb/bitmark-parser-generator 1.5.11 → 1.5.13

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

@@ -38,15 +38,16 @@ const ArrayUtils_1 = require("../../utils/ArrayUtils");
 const BooleanUtils_1 = require("../../utils/BooleanUtils");
 const StringUtils_1 = require("../../utils/StringUtils");
 const UrlUtils_1 = require("../../utils/UrlUtils");
+const AstWalkerGenerator_1 = require("../AstWalkerGenerator");
 const DEFAULT_OPTIONS = {
 // debugGenerationInline: true,
 };
 /**
  * Generate bitmark JSON from a bitmark AST
  *
- * TODO: NOT IMPLEMENTED!
+ *
  */
-class JsonGenerator {
+class JsonGenerator extends AstWalkerGenerator_1.AstWalkerGenerator {
     /**
      * Generate bitmark JSON from a bitmark AST
      *
@@ -54,7 +55,8 @@ class JsonGenerator {
      * @param options - JSON generation options
      */
     constructor(writer, options) {
-        var _a;
+        var _a, _b;
+        super();
         this.ast = new Ast_1.Ast();
         this.textParser = new TextParser_1.TextParser();
         // State
@@ -65,10 +67,9 @@ class JsonGenerator {
         this.bodyDefault = Breakscape_1.Breakscape.EMPTY_STRING;
         this.bodyJson = this.bodyDefault;
         this.startPlaceholderIndex = 0;
-        // Debug
-        this.printed = false;
         this.bitmarkVersion = (_a = BitmarkVersion_1.BitmarkVersion.fromValue(options === null || options === void 0 ? void 0 : options.bitmarkVersion)) !== null && _a !== void 0 ? _a : BitmarkVersion_1.DEFAULT_BITMARK_VERSION;
         this.options = Object.assign(Object.assign({}, DEFAULT_OPTIONS), options === null || options === void 0 ? void 0 : options.jsonOptions);
+        this.debugGenerationInline = (_b = this.options.debugGenerationInline) !== null && _b !== void 0 ? _b : false;
         this.jsonPrettifySpace = this.options.prettify === true ? 2 : this.options.prettify || undefined;
         // Set defaults according to bitmark version
         if (this.bitmarkVersion === BitmarkVersion_1.BitmarkVersion.v2) {
@@ -136,55 +137,6 @@ class JsonGenerator {
         // Walk the bitmark AST
         this.ast.walk(ast, NodeType_1.NodeType.bitmarkAst, this, undefined);
     }
-    enter(node, parent, route) {
-        let res = void 0;
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const gen = this;
-        const funcName = `enter_${node.key}`;
-        if (!this.printed) {
-            this.printed = true;
-        }
-        if (this.options.debugGenerationInline)
-            this.writeInlineDebug(node.key, { open: true });
-        if (typeof gen[funcName] === 'function') {
-            res = gen[funcName](node, parent, route);
-        }
-        return res;
-    }
-    between(node, left, right, parent, route) {
-        let res = void 0;
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const gen = this;
-        const funcName = `between_${node.key}`;
-        if (this.options.debugGenerationInline)
-            this.writeInlineDebug(node.key, { single: true });
-        if (typeof gen[funcName] === 'function') {
-            res = gen[funcName](node, left, right, parent, route);
-        }
-        return res;
-    }
-    exit(node, parent, route) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const gen = this;
-        const funcName = `exit_${node.key}`;
-        if (this.options.debugGenerationInline)
-            this.writeInlineDebug(node.key, { close: true });
-        if (typeof gen[funcName] === 'function') {
-            gen[funcName](node, parent, route);
-        }
-    }
-    leaf(node, parent, route) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const gen = this;
-        const funcName = `leaf_${node.key}`;
-        if (this.options.debugGenerationInline)
-            this.writeInlineDebug(node.key, { open: true });
-        if (typeof gen[funcName] === 'function') {
-            gen[funcName](node, parent, route);
-        }
-        if (this.options.debugGenerationInline)
-            this.writeInlineDebug(node.key, { close: true });
-    }
     //
     // NODE HANDLERS
     //
@@ -192,13 +144,13 @@ class JsonGenerator {
     // Non-Terminal nodes (branches)
     //
     // bitmark
-    enter_bitmarkAst(_node, _parent, _route) {
+    enter_bitmarkAst(_node, _route) {
         // Reset the JSON
         this.json = [];
     }
     // bitmarkAst -> bits
     // bitmarkAst -> bits -> bitsValue
-    enter_bitsValue(node, _parent, _route) {
+    enter_bitsValue(node, _route) {
         var _a, _b, _c;
         const bit = node.value;
         // Reset
@@ -242,14 +194,15 @@ class JsonGenerator {
             this.bitJson.isExample = true;
         }
     }
-    exit_bitsValue(_node, _parent, _route) {
+    exit_bitsValue(_node, _route) {
         // Clean up the bit JSON, removing any unwanted values
         this.cleanAndSetDefaultsForBitJson(this.bitJson);
     }
     // bitmarkAst -> bits -> bitsValue -> imageSource
-    enter_imageSource(node, parent, _route) {
+    enter_imageSource(node, route) {
         const imageSource = node.value;
         // Ignore values that are not at the bit level as they might be handled elsewhere
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.bitsValue)
             return;
         const { url, mockupId, size, format, trim } = imageSource;
@@ -262,10 +215,11 @@ class JsonGenerator {
         this.bitJson.imageSource = imageSourceJson;
     }
     // bitmarkAst -> bits -> bitsValue -> partner
-    enter_partner(node, parent, route) {
+    enter_partner(node, 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
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.bitsValue || !bitType)
             return;
         const { name, avatarImage } = partner;
@@ -280,9 +234,10 @@ class JsonGenerator {
         this.bitJson.partner = partnerJson;
     }
     // bitmarkAst -> bits -> bitsValue -> markConfig -> markConfigValue
-    enter_markConfigValue(node, parent, _route) {
+    enter_markConfigValue(node, route) {
         const markConfig = node.value;
         // Ignore example that is not at the correct level
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.markConfig)
             return;
         const { mark, color, emphasis } = markConfig;
@@ -297,18 +252,20 @@ class JsonGenerator {
         this.bitJson.marks.push(markJson);
     }
     // bitmarkAst -> bits -> bitsValue -> sampleSolution
-    leaf_sampleSolution(node, parent, _route) {
+    leaf_sampleSolution(node, route) {
         // Ignore example that is not at the correct level
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.bitsValue)
             return;
         if (node.value != null)
             this.addProperty(this.bitJson, 'sampleSolution', node.value, true);
     }
     // bitmarkAst -> bits -> bitsValue -> itemLead
-    enter_itemLead(node, parent, _route) {
+    enter_itemLead(node, route) {
         const itemLead = node.value;
         const { item, lead, pageNumber, marginNumber } = itemLead;
         // Ignore item / lead that are not at the bit level as they are handled elsewhere
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.bitsValue)
             return;
         if (item != null) {
@@ -325,7 +282,7 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> extraProperties
-    enter_extraProperties(node, _parent, _route) {
+    enter_extraProperties(node, _route) {
         const extraProperties = node.value;
         if (!this.options.excludeUnknownProperties && extraProperties) {
             for (const [key, values] of Object.entries(extraProperties)) {
@@ -338,7 +295,7 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> cardBits -> cardBitsValue
-    enter_cardBitsValue(node, _parent, route) {
+    enter_cardBitsValue(node, route) {
         // How cardBits are handled depends on the bit type
         const bitType = this.getBitType(route);
         if (!bitType)
@@ -366,14 +323,15 @@ class JsonGenerator {
             delete li.marginNumber;
         listItems.push(this.listItem);
     }
-    exit_cardBitsValue(_node, _parent, _route) {
+    exit_cardBitsValue(_node, _route) {
         this.listItem = undefined;
     }
     // bitmarkAst -> bits -> bitsValue -> body
-    enter_body(_node, _parent, _route) {
+    enter_body(_node, _route) {
         this.bodyJson = this.bodyDefault;
     }
-    exit_body(_node, parent, _route) {
+    exit_body(_node, route) {
+        const parent = this.getParentNode(route);
         if (!parent)
             return;
         if (parent.key === NodeType_1.NodeType.bitsValue) {
@@ -387,7 +345,7 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> * -> bodyParts (body, cardBody (e.g. cloze-list, page-footer))
-    enter_bodyParts(node, _parent, route) {
+    enter_bodyParts(node, route) {
         const bodyParts = node.value;
         const plainText = this.options.textAsPlainText;
         const textFormat = this.getTextFormat(route);
@@ -489,7 +447,7 @@ class JsonGenerator {
         return false;
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> elements
-    enter_elements(node, _parent, _route) {
+    enter_elements(node, _route) {
         const elements = node.value;
         // Ignore elements that are not at the bit level as they are handled elsewhere as quizzes
         // if (parent?.key !== NodeType.bitsValue) return;
@@ -498,10 +456,11 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> flashcards -> flashcardsValue
-    enter_flashcards(node, parent, _route) {
+    enter_flashcards(node, route) {
         var _a, _b, _c, _d, _e, _f;
         const flashcards = node.value;
         // Ignore responses that are not at the correct level as they are potentially handled elsewhere
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.cardNode)
             return;
         const flashcardsJson = [];
@@ -527,10 +486,11 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> statement
-    enter_statement(node, parent, _route) {
+    enter_statement(node, route) {
         var _a, _b;
         const statement = node.value;
         // Ignore statement that is not at the cardNode level as it is handled elsewhere
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.cardNode)
             return;
         if (statement) {
@@ -539,10 +499,11 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> statements -> statementsValue
-    enter_statements(node, parent, _route) {
+    enter_statements(node, route) {
         var _a, _b, _c, _d, _e;
         const statements = node.value;
         // Ignore statements that are not at the card node level as they are handled elsewhere
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.cardNode)
             return;
         const statementsJson = [];
@@ -575,10 +536,11 @@ class JsonGenerator {
     }
     // bitmarkAst -> bits -> bitsValue -> choices
     // X bitmarkAst -> bits -> bitsValue -> cardNode -> quizzes -> quizzesValue -> choices
-    enter_choices(node, parent, _route) {
+    enter_choices(node, route) {
         var _a, _b, _c, _d, _e;
         const choices = node.value;
         // Ignore choices that are not at the bit level as they are handled elsewhere as quizzes
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.cardNode)
             return;
         const choicesJson = [];
@@ -605,10 +567,11 @@ class JsonGenerator {
     }
     // bitmarkAst -> bits -> bitsValue -> responses
     // X bitmarkAst -> bits -> bitsValue -> cardNode -> quizzes -> quizzesValue -> responses
-    enter_responses(node, parent, _route) {
+    enter_responses(node, route) {
         var _a, _b, _c, _d, _e;
         const responses = node.value;
         // Ignore responses that are not at the correct level as they are handled elsewhere as quizzes
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.cardNode)
             return;
         const responsesJson = [];
@@ -634,7 +597,7 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> quizzes
-    enter_quizzes(node, _parent, _route) {
+    enter_quizzes(node, _route) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
         const quizzes = node.value;
         const quizzesJson = [];
@@ -695,39 +658,38 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> heading
-    enter_heading(node, _parent, _route) {
-        var _a, _b;
+    enter_heading(node, _route) {
+        var _a;
         const heading = node.value;
-        // Ensure the heading is valid for writing out (it will be valid, but if it is empty, it should not be written)
-        let valid = false;
-        if (heading && heading.forKeys /*&& heading.forValues && heading.forValues.length > 0*/) {
-            valid = true;
-        }
-        if (!valid)
-            return false;
+        // Check if the heading is for a match or a match matrix
+        const bitType = this.getBitType(_route);
+        const isMatrix = Config_1.Config.isOfBitType(bitType, BitType_1.BitType.matchMatrix);
         // Create the heading
         const headingJson = {
             forKeys: (_a = Breakscape_1.Breakscape.unbreakscape(heading.forKeys)) !== null && _a !== void 0 ? _a : '',
         };
-        // TODO: Should probably check wether bit is a match or a matrix and add a string for match and array for matrix
-        if (Array.isArray(heading.forValues)) {
-            if (heading.forValues.length > 1) {
-                headingJson.forValues = Breakscape_1.Breakscape.unbreakscape(heading.forValues);
-            }
-            else if (heading.forValues.length === 1) {
-                headingJson.forValues = Breakscape_1.Breakscape.unbreakscape(heading.forValues[0]);
-            }
-            else {
-                headingJson.forValues = Breakscape_1.Breakscape.unbreakscape(heading.forValues);
+        if (isMatrix) {
+            // Matrix match, forValues is an array
+            headingJson.forValues = [];
+            if (Array.isArray(heading.forValues)) {
+                if (heading.forValues.length >= 1) {
+                    headingJson.forValues = Breakscape_1.Breakscape.unbreakscape(heading.forValues);
+                }
             }
         }
         else {
-            headingJson.forValues = (_b = Breakscape_1.Breakscape.unbreakscape(heading.forValues)) !== null && _b !== void 0 ? _b : '';
+            // Standard match, forValues is a string
+            headingJson.forValues = '';
+            if (Array.isArray(heading.forValues)) {
+                if (heading.forValues.length >= 1) {
+                    headingJson.forValues = Breakscape_1.Breakscape.unbreakscape(heading.forValues[heading.forValues.length - 1]);
+                }
+            }
         }
         this.bitJson.heading = headingJson;
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> pairs
-    enter_pairs(node, _parent, route) {
+    enter_pairs(node, route) {
         var _a, _b, _c, _d, _e, _f;
         const pairs = node.value;
         const pairsJson = [];
@@ -768,7 +730,7 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> matrix
-    enter_matrix(node, _parent, _route) {
+    enter_matrix(node, _route) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         const matrix = node.value;
         const matrixJsonArray = [];
@@ -818,7 +780,7 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> questions
-    enter_questions(node, _parent, _route) {
+    enter_questions(node, _route) {
         var _a, _b, _c, _d, _e, _f;
         const questions = node.value;
         const questionsJson = [];
@@ -844,10 +806,11 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> botResponses
-    enter_botResponses(node, parent, _route) {
+    enter_botResponses(node, route) {
         var _a, _b, _c, _d, _e, _f;
         const botResponses = node.value;
         // Ignore responses that are not at the cardNode level as they are handled elsewhere
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.cardNode)
             return;
         const responsesJson = [];
@@ -874,7 +837,7 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> bits -> bitsValue -> resources
-    enter_resources(node, _parent, route) {
+    enter_resources(node, route) {
         var _a;
         const resources = node.value;
         const bitType = this.getBitType(route);
@@ -940,71 +903,74 @@ class JsonGenerator {
     // Terminal nodes (leaves)
     //
     // bitmarkAst -> bits -> bitsValue -> title
-    leaf_title(node, _parent, _route) {
+    leaf_title(node, _route) {
         this.bitJson.title = this.convertBreakscapedStringToJsonText(node.value, TextFormat_1.TextFormat.bitmarkMinusMinus);
     }
     //  bitmarkAst -> bits -> bitsValue -> subtitle
-    leaf_subtitle(node, _parent, _route) {
+    leaf_subtitle(node, _route) {
         this.bitJson.subtitle = this.convertBreakscapedStringToJsonText(node.value, TextFormat_1.TextFormat.bitmarkMinusMinus);
     }
     // //  bitmarkAst -> bits -> bitsValue -> level
-    leaf_level(node, _parent, _route) {
+    leaf_level(node, _route) {
         var _a;
         if (node.value != null)
             this.addProperty(this.bitJson, 'level', (_a = node.value) !== null && _a !== void 0 ? _a : 1, true);
     }
     // bitmarkAst -> bits -> bitsValue -> book
-    leaf_book(node, _parent, _route) {
+    leaf_book(node, _route) {
         if (node.value != null)
             this.addProperty(this.bitJson, 'book', node.value, true);
     }
     //  bitmarkAst -> bits -> bitsValue -> anchor
-    leaf_anchor(node, _parent, _route) {
+    leaf_anchor(node, _route) {
         if (node.value != null)
             this.addProperty(this.bitJson, 'anchor', node.value, true);
     }
     //  bitmarkAst -> bits -> bitsValue -> reference
-    leaf_reference(node, _parent, _route) {
+    leaf_reference(node, _route) {
         if (node.value != null)
             this.addProperty(this.bitJson, 'reference', node.value, true);
     }
     //  bitmarkAst -> bits -> bitsValue -> referenceEnd
-    leaf_referenceEnd(node, _parent, _route) {
+    leaf_referenceEnd(node, _route) {
         if (node.value != null)
             this.addProperty(this.bitJson, 'referenceEnd', node.value, true);
     }
     //  bitmarkAst -> bits -> bitsValue ->  * -> hint
-    leaf_hint(node, parent, _route) {
+    leaf_hint(node, route) {
         const hint = node.value;
         // Ignore hint that is not at the bit level as it are handled elsewhere
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.bitsValue)
             return;
         this.bitJson.hint = this.convertBreakscapedStringToJsonText(hint, TextFormat_1.TextFormat.bitmarkMinusMinus);
     }
     // bitmarkAst -> bits -> bitsValue ->  * -> instruction
-    leaf_instruction(node, parent, _route) {
+    leaf_instruction(node, route) {
         const instruction = node.value;
         // Ignore instruction that is not at the bit level as it are handled elsewhere
+        const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.bitsValue)
             return;
         this.bitJson.instruction = this.convertBreakscapedStringToJsonText(instruction, TextFormat_1.TextFormat.bitmarkMinusMinus);
     }
     // bitmarkAst -> bits -> footer -> footerText
-    leaf_footerText(node, _parent, _route) {
+    leaf_footerText(node, _route) {
         const footer = node.value;
         this.bitJson.footer = this.convertBreakscapedStringToJsonText(footer, TextFormat_1.TextFormat.bitmarkMinusMinus);
     }
     // bitmarkAst -> bits -> bitsValue -> markup
-    leaf_markup(node, _parent, _route) {
+    leaf_markup(node, _route) {
         const bitmark = node.value;
         if (bitmark)
             this.bitWrapperJson.bitmark = bitmark;
     }
     // bitmarkAst -> bits -> bitsValue -> parser
     // bitmarkAst -> bits -> bitsValue -> * -> internalComment
-    enter_parser(node, parent, route) {
+    enter_parser(node, route) {
         const parser = node.value;
         const bitType = this.getBitType(route);
+        const parent = this.getParentNode(route);
         if (parser && bitType) {
             const { version, excessResources: parserExcessResources, warnings, errors } = parser, parserRest = __rest(parser, ["version", "excessResources", "warnings", "errors"]);
             const bitmarkVersion = `${this.bitmarkVersion}`;
@@ -1042,7 +1008,7 @@ class JsonGenerator {
         }
     }
     // bitmarkAst -> errors
-    // protected enter_errors(node: NodeInfo, parent: NodeInfo | undefined, _route: NodeInfo[],
+    // protected enter_errors(node: NodeInfo, _route: NodeInfo[],
     // context: Context): void {
     //   const errors = node.value as ParserError[] | undefined;
     //   if (errors && errors.length > 0) {
@@ -1077,13 +1043,14 @@ class JsonGenerator {
                 continue;
             const funcName = `enter_${astKey}`;
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            this[funcName] = (node, parent, _route) => {
+            this[funcName] = (node, route) => {
                 var _a;
                 const value = node.value;
                 if (value == null)
                     return;
                 // if (key === 'progress') debugger;
                 // Ignore any property that is not at the bit level as that will be handled by a different handler
+                const parent = this.getParentNode(route);
                 if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType_1.NodeType.bitsValue)
                     return;
                 // Convert key as needed
@@ -1751,6 +1718,9 @@ class JsonGenerator {
             // }
         }
     }
+    //
+    // Helper functions
+    //
     /**
      * Get the value for the zoomDisabled property, setting the appropriate default value if no value is set.
      *