@gmb/bitmark-parser-generator 1.1.1 → 1.2.1

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

@@ -20,7 +20,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 import { Ast } from '../../ast/Ast';
 import { NodeType } from '../../model/ast/NodeType';
-import { BitType } from '../../model/enum/BitType';
+import { AliasBitType, RootBitType, BitTypeUtils } 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';
@@ -202,7 +202,7 @@ class JsonGenerator {
         // There is same logic here to select the correct default value of the example is the default is
         // required, and this is bit depenedent.
         // This is ugly, but it is even uglier if the defaults at set in the AST.
-        const meta = BitType.getMetadata(bit.bitType);
+        const meta = RootBitType.getMetadata(bit.bitType.root);
         const hasRootExample = !!(meta === null || meta === void 0 ? void 0 : meta.rootExampleType);
         const isBoolean = (meta === null || meta === void 0 ? void 0 : meta.rootExampleType) === ExampleType.boolean;
         if (hasRootExample) {
@@ -211,7 +211,7 @@ class JsonGenerator {
             if (isBoolean) {
                 // Boolean example
                 defaultExample = true;
-                if (bit.bitType === BitType.trueFalse1) {
+                if (bit.bitType.root === RootBitType.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;
                     }
@@ -253,6 +253,23 @@ class JsonGenerator {
         }
         this.bitJson.partner = partnerJson;
     }
+    // bitmarkAst -> bits -> bitsValue -> markConfig -> markConfigValue
+    enter_markConfigValue(node, parent, _route) {
+        const markConfig = node.value;
+        // Ignore example that is not at the correct level
+        if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.markConfig)
+            return;
+        const { mark, color, emphasis } = markConfig;
+        const markJson = {};
+        this.addProperty(markJson, 'mark', mark !== null && mark !== void 0 ? mark : 'unknown', true);
+        if (color)
+            this.addProperty(markJson, 'color', color !== null && color !== void 0 ? color : '', true);
+        if (emphasis)
+            this.addProperty(markJson, 'emphasis', emphasis !== null && emphasis !== void 0 ? emphasis : '', true);
+        if (!this.bitJson.marks)
+            this.bitJson.marks = [];
+        this.bitJson.marks.push(markJson);
+    }
     // bitmarkAst -> bits -> bitsValue -> sampleSolution
     enter_sampleSolution(node, _parent, _route) {
         if (node.value != null)
@@ -353,6 +370,11 @@ class JsonGenerator {
                     bodyBitJson = this.createGapJson(gap);
                     break;
                 }
+                case BodyBitType.mark: {
+                    const mark = bodyBit;
+                    bodyBitJson = this.createMarkJson(mark);
+                    break;
+                }
                 case BodyBitType.select: {
                     const select = bodyBit;
                     bodyBitJson = this.createSelectJson(select);
@@ -392,6 +414,31 @@ class JsonGenerator {
             this.bitJson.elements = elements;
         }
     }
+    // bitmarkAst -> bits -> bitsValue -> cardNode -> flashcards -> flashcardsValue
+    enter_flashcards(node, parent, _route) {
+        var _a, _b, _c, _d;
+        const flashcards = node.value;
+        // Ignore responses that are not at the correct level as they are potentially handled elsewhere
+        if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.cardNode)
+            return;
+        const flashcardsJson = [];
+        if (flashcards) {
+            for (const c of flashcards) {
+                // Create the flashcard
+                const flashcardJson = Object.assign(Object.assign({ question: (_a = c.question) !== null && _a !== void 0 ? _a : '', answer: (_b = c.answer) !== null && _b !== void 0 ? _b : '', alternativeAnswers: (_c = c.alternativeAnswers) !== null && _c !== void 0 ? _c : [] }, this.toItemLeadHintInstruction(c)), this.toExample(c, {
+                    defaultExample: c.isDefaultExample,
+                    isBoolean: true,
+                }));
+                // Delete unwanted properties
+                if (((_d = c.itemLead) === null || _d === void 0 ? void 0 : _d.lead) == null)
+                    delete flashcardJson.lead;
+                flashcardsJson.push(flashcardJson);
+            }
+        }
+        if (flashcardsJson.length > 0) {
+            this.bitJson.cards = flashcardsJson;
+        }
+    }
     // bitmarkAst -> bits -> bitsValue -> statement
     enter_statement(node, parent, _route) {
         var _a, _b;
@@ -575,10 +622,12 @@ class JsonGenerator {
         const pairsJson = [];
         if (pairs) {
             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 = 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 = p.values) !== null && _b !== void 0 ? _b : [] }, this.toItemLeadHintInstruction(p)), { isCaseSensitive: (_c = p.isCaseSensitive) !== null && _c !== void 0 ? _c : true, isLongAnswer: (_d = !p.isShortAnswer) !== null && _d !== void 0 ? _d : false }), this.toExample(p, {
-                    defaultExample: true,
-                    isBoolean: true,
+                    defaultExample,
+                    isBoolean: false,
                 }));
                 // Delete unwanted properties
                 if (((_e = p.itemLead) === null || _e === void 0 ? void 0 : _e.lead) == null)
@@ -613,10 +662,12 @@ class JsonGenerator {
                 const matrixCellsJson = [];
                 if (m.cells) {
                     for (const c of m.cells) {
+                        // Get default example
+                        const defaultExample = Array.isArray(c.values) && c.values.length > 0 && c.values[0];
                         // Create the choice
                         const matrixCellJson = Object.assign(Object.assign({ values: (_a = c.values) !== null && _a !== void 0 ? _a : [] }, this.toItemLeadHintInstruction(c)), this.toExample(c, {
-                            defaultExample: true,
-                            isBoolean: true,
+                            defaultExample,
+                            isBoolean: false,
                         }));
                         // Delete unwanted properties
                         if (((_b = c.itemLead) === null || _b === void 0 ? void 0 : _b.lead) == null)
@@ -867,6 +918,18 @@ class JsonGenerator {
             delete gapJson.lead;
         return gapJson;
     }
+    createMarkJson(mark) {
+        const data = mark.data;
+        // Create the mark
+        const markJson = Object.assign(Object.assign({ type: 'mark', solution: data.solution, mark: data.mark }, this.toItemLeadHintInstruction(data)), this.toExample(data, {
+            defaultExample: true,
+            isBoolean: true,
+        }));
+        // Remove unwanted properties
+        if (!markJson.lead)
+            delete markJson.lead;
+        return markJson;
+    }
     createSelectJson(select) {
         var _a, _b, _c, _d;
         const data = select.data;
@@ -1504,7 +1567,7 @@ class JsonGenerator {
         for (const node of route) {
             if (node.key === NodeType.bitsValue) {
                 const n = node.value;
-                return BitType.fromValue(n === null || n === void 0 ? void 0 : n.bitType);
+                return n === null || n === void 0 ? void 0 : n.bitType;
             }
         }
         return undefined;
@@ -1606,7 +1669,7 @@ class JsonGenerator {
      */
     createBitJson(bit) {
         const bitJson = {
-            type: bit.bitType,
+            type: bit.bitType.alias,
             format: bit.textFormat,
             // Properties
             id: undefined,
@@ -1619,6 +1682,11 @@ class JsonGenerator {
             ageRange: undefined,
             language: undefined,
             computerLanguage: undefined,
+            target: undefined,
+            tag: undefined,
+            icon: undefined,
+            iconTag: undefined,
+            colorTag: undefined,
             subtype: undefined,
             coverImage: undefined,
             publisher: undefined,
@@ -1665,6 +1733,8 @@ class JsonGenerator {
             example: undefined,
             // Partner .conversion-xxx only
             partner: undefined,
+            // Marks (config)
+            marks: undefined,
             // Extra Properties
             extraProperties: undefined,
             // Body
@@ -1708,6 +1778,7 @@ class JsonGenerator {
      * @returns
      */
     cleanAndSetDefaultsForBitJson(bitJson) {
+        const bitType = BitTypeUtils.getBitType(bitJson.type);
         const plainText = this.options.textAsPlainText;
         // Clear 'item' which may be an empty string if 'lead' was set but item not
         // Only necessary because '.article' does not include a default value for 'item'
@@ -1717,14 +1788,11 @@ class JsonGenerator {
         // Add default properties to the bit.
         // NOTE: Not all bits have the same default properties.
         //       The properties used in the antlr parser are a bit random sometimes?
-        switch (bitJson.type) {
-            case BitType._error:
+        switch (bitType.root) {
+            case RootBitType._error:
                 break;
-            case BitType.article:
-            case BitType.message:
-            case BitType.sampleSolution:
-            case BitType.page:
-            case BitType.statement:
+            case RootBitType.article:
+            case RootBitType.sampleSolution:
                 if (bitJson.body == null)
                     bitJson.body = this.bodyDefault;
                 break;
@@ -1739,17 +1807,24 @@ class JsonGenerator {
                     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;
+                }
                 break;
             // Default, but with no 'example' at the bit level.
-            case BitType.cloze:
-            case BitType.clozeInstructionGrouped:
-            case BitType.clozeSolutionGrouped:
-            case BitType.multipleChoice1:
-            case BitType.multipleResponse1:
-            case BitType.multipleChoiceText:
-            case BitType.highlightText:
-            case BitType.clozeAndMultipleChoiceText:
-            case BitType.sequence:
+            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)
@@ -1762,8 +1837,8 @@ class JsonGenerator {
                     bitJson.body = this.bodyDefault;
                 break;
             // Default with a card (and hence a footer possibility)
-            case BitType.multipleChoice:
-            case BitType.multipleResponse:
+            case RootBitType.multipleChoice:
+            case RootBitType.multipleResponse:
                 if (bitJson.item == null)
                     bitJson.item = this.textDefault;
                 if (bitJson.hint == null)
@@ -1777,7 +1852,7 @@ class JsonGenerator {
                 if (bitJson.footer == null)
                     bitJson.footer = this.textDefault;
                 break;
-            case BitType.essay:
+            case RootBitType.essay:
                 if (bitJson.item == null)
                     bitJson.item = this.textDefault;
                 if (bitJson.hint == null)
@@ -1794,7 +1869,7 @@ class JsonGenerator {
                     bitJson.partialAnswer = '';
                 // if (bitJson.sampleSolution == null) bitJson.sampleSolution = '';
                 break;
-            case BitType.trueFalse1:
+            case RootBitType.trueFalse1:
                 if (bitJson.item == null)
                     bitJson.item = this.textDefault;
                 if (bitJson.lead == null)
@@ -1812,7 +1887,7 @@ class JsonGenerator {
                 if (bitJson.body == null)
                     bitJson.body = this.bodyDefault;
                 break;
-            case BitType.trueFalse:
+            case RootBitType.trueFalse:
                 if (bitJson.item == null)
                     bitJson.item = this.textDefault;
                 if (bitJson.lead == null)
@@ -1830,7 +1905,7 @@ class JsonGenerator {
                 if (bitJson.body == null)
                     bitJson.body = this.bodyDefault;
                 break;
-            case BitType.chapter:
+            case RootBitType.chapter:
                 if (bitJson.item == null)
                     bitJson.item = this.textDefault;
                 if (bitJson.hint == null)
@@ -1848,8 +1923,7 @@ class JsonGenerator {
                 if (bitJson.body == null)
                     bitJson.body = this.bodyDefault;
                 break;
-            case BitType.interview:
-            case BitType.interviewInstructionGrouped:
+            case RootBitType.interview:
                 if (bitJson.item == null)
                     bitJson.item = this.textDefault;
                 if (bitJson.hint == null)
@@ -1865,11 +1939,7 @@ class JsonGenerator {
                 if (bitJson.questions == null)
                     bitJson.questions = [];
                 break;
-            case BitType.match:
-            case BitType.matchReverse:
-            case BitType.matchSolutionGrouped:
-            case BitType.matchAll:
-            case BitType.matchAllReverse:
+            case RootBitType.match:
                 if (bitJson.item == null)
                     bitJson.item = this.textDefault;
                 if (bitJson.heading == null)
@@ -1877,24 +1947,15 @@ class JsonGenerator {
                 if (bitJson.body == null)
                     bitJson.body = this.bodyDefault;
                 break;
-            case BitType.matchMatrix:
+            case RootBitType.matchMatrix:
                 if (bitJson.item == null)
                     bitJson.item = this.textDefault;
                 if (bitJson.body == null)
                     bitJson.body = this.bodyDefault;
                 break;
-            case BitType.learningPathBook:
-            case BitType.learningPathBotTraining:
-            case BitType.learningPathClassroomEvent:
-            case BitType.learningPathClassroomTraining:
-            case BitType.learningPathClosing:
-            case BitType.learningPathExternalLink:
-            case BitType.learningPathFeedback:
-            case BitType.learningPathLearningGoal:
-            case BitType.learningPathLti:
-            case BitType.learningPathSign:
-            case BitType.learningPathStep:
-            case BitType.learningPathVideoCall:
+            case RootBitType.learningPathBook:
+            case RootBitType.learningPathExternalLink:
+            case RootBitType.learningPathVideoCall:
                 if (bitJson.item == null)
                     bitJson.item = this.textDefault;
                 if (bitJson.hint == null)
@@ -1910,22 +1971,6 @@ class JsonGenerator {
                 if (bitJson.body == null)
                     bitJson.body = this.bodyDefault;
                 break;
-            case BitType.articleAi:
-            case BitType.noteAi:
-            case BitType.summaryAi:
-                if (bitJson.AIGenerated == null)
-                    bitJson.AIGenerated = true;
-                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;
-                break;
         }
         // Remove unwanted properties
         // Properties
@@ -1949,6 +1994,16 @@ class JsonGenerator {
             delete bitJson.language;
         if (bitJson.computerLanguage == null)
             delete bitJson.computerLanguage;
+        if (bitJson.target == null)
+            delete bitJson.target;
+        if (bitJson.tag == null)
+            delete bitJson.tag;
+        if (bitJson.icon == null)
+            delete bitJson.icon;
+        if (bitJson.iconTag == null)
+            delete bitJson.iconTag;
+        if (bitJson.colorTag == null)
+            delete bitJson.colorTag;
         if (bitJson.subtype == null)
             delete bitJson.subtype;
         if (bitJson.coverImage == null)
@@ -2028,6 +2083,9 @@ class JsonGenerator {
             delete bitJson.example;
         if (bitJson.isExample == null)
             delete bitJson.isExample;
+        // Mark
+        if (bitJson.marks == null)
+            delete bitJson.marks;
         // Extra Properties
         if (bitJson.extraProperties == null)
             delete bitJson.extraProperties;