@gmb/bitmark-parser-generator 1.0.16 → 1.1.0

package/dist/esm/ast/Builder.js

@@ -37,84 +37,55 @@ class Builder extends BaseBuilder {
      */
     bit(data) {
         var _a;
-        const { bitType, textFormat, resourceType, id, externalId, spaceId, padletId, aiGenerated, releaseVersion, ageRange, language, computerLanguage, subtype, coverImage, publisher, publications, author, subject, date, location, theme, kind, action, thumbImage, focusX, focusY, duration, referenceProperty, deeplink, externalLink, externalLinkText, videoCallLink, bot, list, textReference, isTracked, isInfoOnly, labelTrue, labelFalse, book, quotedPerson, partialAnswer, levelProperty, title, subtitle, level, toc, progress, anchor, reference, referenceEnd, item, lead, hint, instruction, example, partner, extraProperties, resource, body, sampleSolution, statement, responses, choices, footer, markup, parser, } = data;
+        const { bitType, textFormat, resourceType, id, externalId, spaceId, padletId, aiGenerated, releaseVersion, ageRange, language, computerLanguage, subtype, coverImage, publisher, publications, author, subject, date, location, theme, kind, action, thumbImage, focusX, focusY, duration, referenceProperty, deeplink, externalLink, externalLinkText, videoCallLink, bot, list, textReference, isTracked, isInfoOnly, labelTrue, labelFalse, book, quotedPerson, partialAnswer, levelProperty, title, subtitle, level, toc, progress, anchor, reference, referenceEnd, item, lead, hint, instruction, isDefaultExample, example, partner, extraProperties, resource, body, sampleSolution, footer, markup, parser, } = data;
+        // Set the card node data
+        const cardNode = this.cardNode(data);
         // NOTE: Node order is important and is defined here
-        const node = {
-            bitType,
-            textFormat: (_a = TextFormat.fromValue(textFormat)) !== null && _a !== void 0 ? _a : TextFormat.bitmarkMinusMinus,
-            resourceType: BitUtils.calculateValidResourceType(bitType, resourceType, resource),
-            id: this.toAstProperty(PropertyKey.id, id),
-            externalId: this.toAstProperty(PropertyKey.externalId, externalId),
-            spaceId: this.toAstProperty(PropertyKey.spaceId, spaceId),
-            padletId: this.toAstProperty(PropertyKey.padletId, padletId),
-            aiGenerated: this.toAstProperty(PropertyKey.aiGenerated, aiGenerated),
-            releaseVersion: this.toAstProperty(PropertyKey.releaseVersion, releaseVersion),
-            book,
-            ageRange: this.toAstProperty(PropertyKey.ageRange, ageRange),
-            language: this.toAstProperty(PropertyKey.language, language),
-            computerLanguage: this.toAstProperty(PropertyKey.computerLanguage, computerLanguage),
-            subtype: this.toAstProperty(PropertyKey.subtype, subtype),
-            coverImage: this.toAstProperty(PropertyKey.coverImage, coverImage),
-            publisher: this.toAstProperty(PropertyKey.publisher, publisher),
-            publications: this.toAstProperty(PropertyKey.publications, publications),
-            author: this.toAstProperty(PropertyKey.author, author),
-            subject: this.toAstProperty(PropertyKey.subject, subject),
-            date: this.toAstProperty(PropertyKey.date, date),
-            location: this.toAstProperty(PropertyKey.location, location),
-            theme: this.toAstProperty(PropertyKey.theme, theme),
-            kind: this.toAstProperty(PropertyKey.kind, kind),
-            action: this.toAstProperty(PropertyKey.action, action),
-            thumbImage: this.toAstProperty(PropertyKey.thumbImage, thumbImage),
-            focusX: this.toAstProperty(PropertyKey.focusX, focusX),
-            focusY: this.toAstProperty(PropertyKey.focusY, focusY),
-            deeplink: this.toAstProperty(PropertyKey.deeplink, deeplink),
-            externalLink: this.toAstProperty(PropertyKey.externalLink, externalLink),
-            externalLinkText: this.toAstProperty(PropertyKey.externalLinkText, externalLinkText),
-            videoCallLink: this.toAstProperty(PropertyKey.videoCallLink, videoCallLink),
-            bot: this.toAstProperty(PropertyKey.bot, bot),
-            duration: this.toAstProperty(PropertyKey.duration, duration),
-            referenceProperty: this.toAstProperty(PropertyKey.reference, referenceProperty),
-            list: this.toAstProperty(PropertyKey.list, list),
-            textReference: this.toAstProperty(PropertyKey.textReference, textReference),
-            isTracked: this.toAstProperty(PropertyKey.isTracked, isTracked),
-            isInfoOnly: this.toAstProperty(PropertyKey.isInfoOnly, isInfoOnly),
-            labelTrue: this.toAstProperty(PropertyKey.labelTrue, labelTrue),
-            labelFalse: this.toAstProperty(PropertyKey.labelFalse, labelFalse),
-            quotedPerson: this.toAstProperty(PropertyKey.quotedPerson, quotedPerson),
-            partialAnswer: this.toAstProperty(PropertyKey.partialAnswer, partialAnswer),
-            levelProperty: this.toAstProperty(PropertyKey.level, levelProperty),
-            title,
-            subtitle,
-            level: NumberUtils.asNumber(level),
-            toc: this.toAstProperty(PropertyKey.toc, toc),
-            progress: this.toAstProperty(PropertyKey.progress, progress),
-            anchor,
+        const node = Object.assign(Object.assign({ bitType, textFormat: (_a = TextFormat.fromValue(textFormat)) !== null && _a !== void 0 ? _a : TextFormat.bitmarkMinusMinus, resourceType: BitUtils.calculateValidResourceType(bitType, resourceType, resource), id: this.toAstProperty(PropertyKey.id, id), externalId: this.toAstProperty(PropertyKey.externalId, externalId), spaceId: this.toAstProperty(PropertyKey.spaceId, spaceId), padletId: this.toAstProperty(PropertyKey.padletId, padletId), aiGenerated: this.toAstProperty(PropertyKey.aiGenerated, aiGenerated), releaseVersion: this.toAstProperty(PropertyKey.releaseVersion, releaseVersion), book, ageRange: this.toAstProperty(PropertyKey.ageRange, ageRange), language: this.toAstProperty(PropertyKey.language, language), computerLanguage: this.toAstProperty(PropertyKey.computerLanguage, computerLanguage), subtype: this.toAstProperty(PropertyKey.subtype, subtype), coverImage: this.toAstProperty(PropertyKey.coverImage, coverImage), publisher: this.toAstProperty(PropertyKey.publisher, publisher), publications: this.toAstProperty(PropertyKey.publications, publications), author: this.toAstProperty(PropertyKey.author, author), subject: this.toAstProperty(PropertyKey.subject, subject), date: this.toAstProperty(PropertyKey.date, date), location: this.toAstProperty(PropertyKey.location, location), theme: this.toAstProperty(PropertyKey.theme, theme), kind: this.toAstProperty(PropertyKey.kind, kind), action: this.toAstProperty(PropertyKey.action, action), thumbImage: this.toAstProperty(PropertyKey.thumbImage, thumbImage), focusX: this.toAstProperty(PropertyKey.focusX, focusX), focusY: this.toAstProperty(PropertyKey.focusY, focusY), deeplink: this.toAstProperty(PropertyKey.deeplink, deeplink), externalLink: this.toAstProperty(PropertyKey.externalLink, externalLink), externalLinkText: this.toAstProperty(PropertyKey.externalLinkText, externalLinkText), videoCallLink: this.toAstProperty(PropertyKey.videoCallLink, videoCallLink), bot: this.toAstProperty(PropertyKey.bot, bot), duration: this.toAstProperty(PropertyKey.duration, duration), referenceProperty: this.toAstProperty(PropertyKey.reference, referenceProperty), list: this.toAstProperty(PropertyKey.list, list), textReference: this.toAstProperty(PropertyKey.textReference, textReference), isTracked: this.toAstProperty(PropertyKey.isTracked, isTracked), isInfoOnly: this.toAstProperty(PropertyKey.isInfoOnly, isInfoOnly), labelTrue: this.toAstProperty(PropertyKey.labelTrue, labelTrue), labelFalse: this.toAstProperty(PropertyKey.labelFalse, labelFalse), quotedPerson: this.toAstProperty(PropertyKey.quotedPerson, quotedPerson), partialAnswer: this.toAstProperty(PropertyKey.partialAnswer, partialAnswer), levelProperty: this.toAstProperty(PropertyKey.level, levelProperty), title,
+            subtitle, level: NumberUtils.asNumber(level), toc: this.toAstProperty(PropertyKey.toc, toc), progress: this.toAstProperty(PropertyKey.progress, progress), anchor,
             reference,
-            referenceEnd,
-            itemLead: this.itemLead(item, lead),
-            hint,
-            instruction,
-            example: this.toExample(example),
-            partner,
+            referenceEnd, itemLead: this.itemLead(item, lead), hint,
+            instruction }, this.toExample(isDefaultExample, example)), { partner,
             resource,
-            body,
-            sampleSolution: ArrayUtils.asArray(sampleSolution),
-            statement,
-            responses,
-            choices,
-            cardNode: this.cardNode(data),
+            body, sampleSolution: ArrayUtils.asArray(sampleSolution), cardNode,
             footer,
             markup,
-            parser,
+            parser, 
             // Must always be last in the AST so key clashes are avoided correctly with other properties
-            extraProperties: this.parseExtraProperties(extraProperties),
-        };
+            extraProperties: this.parseExtraProperties(extraProperties) });
+        // If isDefaultExample is set at the bit level, push the default example down the tree to the relevant nodes
+        if (isDefaultExample) {
+            if (cardNode) {
+                this.setDefaultExamplesFlags(true, cardNode.choices);
+                this.setDefaultExamplesFlags(false, cardNode.responses, cardNode.statements, cardNode.statement, cardNode.pairs);
+                if (cardNode.quizzes) {
+                    for (const quiz of cardNode.quizzes) {
+                        this.setDefaultExamplesFlags(true, quiz.choices);
+                        this.setDefaultExamplesFlags(false, quiz.responses);
+                    }
+                }
+                if (cardNode.matrix) {
+                    for (const m of cardNode.matrix) {
+                        this.setDefaultExamplesFlags(false, m.cells);
+                    }
+                }
+            }
+            if (body) {
+                this.setDefaultExamplesBodyBits(body);
+            }
+            // this.setDefaultExampleBit(bitType, node);
+        }
         // Set default values
         this.setDefaultBitValues(node);
+        // Set the 'isExample' flags
+        this.setIsExampleFlags(node);
         // Add the version to the parser info
         this.addVersionToParserInfo(node);
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+            ignoreEmptyString: ['example'],
+        });
         // Validate and correct invalid bits as much as possible
         return NodeValidator.validateBit(node);
     }
@@ -125,19 +96,14 @@ class Builder extends BaseBuilder {
      * @returns
      */
     choice(data) {
-        const { text, isCorrect, item, lead, hint, instruction, example, isCaseSensitive } = data;
+        const { text, isCorrect, item, lead, hint, instruction, isCaseSensitive, isDefaultExample, example } = data;
         // NOTE: Node order is important and is defined here
-        const node = {
-            text,
-            isCorrect,
-            itemLead: this.itemLead(item, lead),
-            hint,
-            instruction,
-            example: this.toExample(example),
-            isCaseSensitive,
-        };
+        const node = Object.assign(Object.assign({ text, isCorrect: !!isCorrect, itemLead: this.itemLead(item, lead), hint,
+            instruction }, this.toExampleBoolean(isDefaultExample, example)), { isCaseSensitive });
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -147,19 +113,14 @@ class Builder extends BaseBuilder {
      * @returns
      */
     response(data) {
-        const { text, isCorrect, item, lead, hint, instruction, example, isCaseSensitive } = data;
+        const { text, isCorrect, item, lead, hint, instruction, isCaseSensitive, isDefaultExample, example } = data;
         // NOTE: Node order is important and is defined here
-        const node = {
-            text,
-            isCorrect,
-            itemLead: this.itemLead(item, lead),
-            hint,
-            instruction,
-            example: this.toExample(example),
-            isCaseSensitive,
-        };
+        const node = Object.assign(Object.assign({ text, isCorrect: !!isCorrect, itemLead: this.itemLead(item, lead), hint,
+            instruction }, this.toExampleBoolean(isDefaultExample, example)), { isCaseSensitive });
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -191,13 +152,16 @@ class Builder extends BaseBuilder {
      * @returns
      */
     quiz(data) {
-        const { choices, responses, item, lead, hint, instruction, example } = data;
+        const { choices, responses, item, lead, hint, instruction, isDefaultExample } = data;
+        if (isDefaultExample) {
+            this.setDefaultExamplesFlags(true, choices);
+            this.setDefaultExamplesFlags(false, responses);
+        }
         // NOTE: Node order is important and is defined here
         const node = {
             itemLead: this.itemLead(item, lead),
             hint,
             instruction,
-            example: this.toExample(example),
             choices,
             responses,
         };
@@ -232,22 +196,18 @@ class Builder extends BaseBuilder {
      * @returns
      */
     pair(data) {
-        const { key, keyAudio, keyImage, values, item, lead, hint, instruction, example, isCaseSensitive, isShortAnswer } = data;
+        const { key, keyAudio, keyImage, values, item, lead, hint, instruction, isCaseSensitive, isShortAnswer, isDefaultExample, example, } = data;
         // NOTE: Node order is important and is defined here
-        const node = {
-            key,
+        const node = Object.assign(Object.assign({ key,
             keyAudio,
-            keyImage,
-            itemLead: this.itemLead(item, lead),
-            hint,
-            instruction,
-            example: this.toExample(example),
-            isCaseSensitive,
+            keyImage, itemLead: this.itemLead(item, lead), hint,
+            instruction }, this.toExample(isDefaultExample, example)), { isCaseSensitive,
             isShortAnswer,
-            values,
-        };
+            values });
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -257,20 +217,31 @@ class Builder extends BaseBuilder {
      * @returns
      */
     matrix(data) {
-        const { key, cells, item, lead, hint, instruction, example, isCaseSensitive, isShortAnswer } = data;
+        const { key, cells, item, lead, hint, instruction, isCaseSensitive, isShortAnswer, isDefaultExample } = data;
+        let isExample = false;
+        // Set isExample for matrix based on isExample for cells
+        for (const c of cells !== null && cells !== void 0 ? cells : []) {
+            if (isDefaultExample && !c.isExample) {
+                c.isDefaultExample = true;
+                c.isExample = true;
+            }
+            isExample = c.isExample ? true : isExample;
+        }
         // NOTE: Node order is important and is defined here
         const node = {
             key,
             itemLead: this.itemLead(item, lead),
             hint,
             instruction,
-            example: this.toExample(example),
             isCaseSensitive,
             isShortAnswer,
+            isExample,
             cells,
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -280,17 +251,14 @@ class Builder extends BaseBuilder {
      * @returns
      */
     matrixCell(data) {
-        const { values, item, lead, hint, instruction, example } = data;
+        const { values, item, lead, hint, instruction, isDefaultExample, example } = data;
         // NOTE: Node order is important and is defined here
-        const node = {
-            values,
-            itemLead: this.itemLead(item, lead),
-            hint,
-            instruction,
-            example: this.toExample(example),
-        };
+        const node = Object.assign({ values, itemLead: this.itemLead(item, lead), hint,
+            instruction }, this.toExample(isDefaultExample, example));
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -300,21 +268,19 @@ class Builder extends BaseBuilder {
      * @returns
      */
     question(data) {
-        const { question, partialAnswer, item, lead, hint, instruction, example, isCaseSensitive, isShortAnswer, sampleSolution, } = data;
+        const { question, partialAnswer, item, lead, hint, instruction, isCaseSensitive, isShortAnswer, sampleSolution, isDefaultExample, example, } = data;
         // NOTE: Node order is important and is defined here
-        const node = {
-            itemLead: this.itemLead(item, lead),
-            question,
+        const node = Object.assign(Object.assign({ itemLead: this.itemLead(item, lead), question,
             partialAnswer,
             hint,
-            instruction,
-            example: this.toExample(example),
-            isCaseSensitive,
+            instruction }, this.toExample(isDefaultExample, example)), { isCaseSensitive,
             isShortAnswer,
-            sampleSolution,
-        };
+            sampleSolution });
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node, { ignoreEmptyString: ['question'], ignoreFalse: ['isShortAnswer'] });
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreEmptyString: ['question'],
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -368,21 +334,18 @@ class Builder extends BaseBuilder {
      * @returns
      */
     gap(data) {
-        const { solutions, item, lead, hint, instruction, example, isCaseSensitive } = data;
+        const { solutions, item, lead, hint, instruction, isCaseSensitive, isDefaultExample, example } = data;
+        // const defaultExample = Array.isArray(solutions) && solutions.length === 1 ? solutions[0] : null;
         // NOTE: Node order is important and is defined here
         const node = {
             type: BodyBitType.gap,
-            data: {
-                solutions,
-                itemLead: this.itemLead(item, lead),
-                hint,
-                instruction,
-                example: this.toExample(example),
-                isCaseSensitive,
-            },
+            data: Object.assign(Object.assign({ solutions, itemLead: this.itemLead(item, lead), hint,
+                instruction }, this.toExample(isDefaultExample, example)), { isCaseSensitive }),
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -392,7 +355,7 @@ class Builder extends BaseBuilder {
      * @returns
      */
     select(data) {
-        const { options, prefix, postfix, item, lead, hint, instruction, example, isCaseSensitive } = data;
+        const { options, prefix, postfix, item, lead, hint, instruction, isCaseSensitive } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: BodyBitType.select,
@@ -403,12 +366,13 @@ class Builder extends BaseBuilder {
                 itemLead: this.itemLead(item, lead),
                 hint,
                 instruction,
-                example: this.toExample(example),
                 isCaseSensitive,
             },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -418,19 +382,14 @@ class Builder extends BaseBuilder {
      * @returns
      */
     selectOption(data) {
-        const { text, isCorrect, item, lead, hint, instruction, example, isCaseSensitive } = data;
+        const { text, isCorrect, item, lead, hint, instruction, isCaseSensitive, isDefaultExample, example } = data;
         // NOTE: Node order is important and is defined here
-        const node = {
-            text,
-            isCorrect,
-            itemLead: this.itemLead(item, lead),
-            hint,
-            instruction,
-            example: this.toExample(example),
-            isCaseSensitive,
-        };
+        const node = Object.assign(Object.assign({ text, isCorrect: !!isCorrect, itemLead: this.itemLead(item, lead), hint,
+            instruction }, this.toExample(isDefaultExample, example)), { isCaseSensitive });
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -440,7 +399,7 @@ class Builder extends BaseBuilder {
      * @returns
      */
     highlight(data) {
-        const { texts, prefix, postfix, item, lead, hint, instruction, example, isCaseSensitive } = data;
+        const { texts, prefix, postfix, item, lead, hint, instruction, isCaseSensitive } = data;
         // NOTE: Node order is important and is defined here
         const node = {
             type: BodyBitType.highlight,
@@ -451,12 +410,13 @@ class Builder extends BaseBuilder {
                 itemLead: this.itemLead(item, lead),
                 hint,
                 instruction,
-                example: this.toExample(example),
                 isCaseSensitive,
             },
         };
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -466,20 +426,14 @@ class Builder extends BaseBuilder {
      * @returns
      */
     highlightText(data) {
-        const { text, isCorrect, isHighlighted, item, lead, hint, instruction, example, isCaseSensitive } = data;
+        const { text, isCorrect, isHighlighted, item, lead, hint, instruction, isCaseSensitive, isDefaultExample, example, } = data;
         // NOTE: Node order is important and is defined here
-        const node = {
-            text,
-            isCorrect,
-            isHighlighted,
-            itemLead: this.itemLead(item, lead),
-            hint,
-            instruction,
-            example: this.toExample(example),
-            isCaseSensitive,
-        };
+        const node = Object.assign(Object.assign({ text, isCorrect: !!isCorrect, isHighlighted: !!isHighlighted, itemLead: this.itemLead(item, lead), hint,
+            instruction }, this.toExample(isDefaultExample, example)), { isCaseSensitive });
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -489,19 +443,14 @@ class Builder extends BaseBuilder {
      * @returns
      */
     statement(data) {
-        const { text, isCorrect, item, lead, hint, instruction, example, isCaseSensitive } = data;
+        const { text, isCorrect, item, lead, hint, instruction, isCaseSensitive, isDefaultExample, example } = data;
         // NOTE: Node order is important and is defined here
-        const node = {
-            text,
-            isCorrect,
-            itemLead: this.itemLead(item, lead),
-            hint,
-            instruction,
-            example: this.toExample(example),
-            isCaseSensitive,
-        };
+        const node = Object.assign(Object.assign({ text, isCorrect: !!isCorrect, itemLead: this.itemLead(item, lead), hint,
+            instruction }, this.toExampleBoolean(isDefaultExample, example)), { isCaseSensitive });
         // Remove Unset Optionals
-        ObjectUtils.removeUnwantedProperties(node);
+        ObjectUtils.removeUnwantedProperties(node, {
+            ignoreAllFalse: true,
+        });
         return node;
     }
     /**
@@ -554,14 +503,27 @@ class Builder extends BaseBuilder {
     }
     cardNode(data) {
         let node;
-        const { heading, elements, questions, statements, quizzes, pairs, matrix, botResponses } = data;
-        if (heading || elements || questions || statements || quizzes || pairs || matrix || botResponses) {
+        const { questions, elements, statement, statements, choices, responses, quizzes, heading, pairs, matrix, botResponses, } = data;
+        if (questions ||
+            elements ||
+            statement ||
+            statements ||
+            choices ||
+            responses ||
+            quizzes ||
+            heading ||
+            pairs ||
+            matrix ||
+            botResponses) {
             node = {
-                heading,
-                elements,
                 questions,
+                elements,
+                statement,
                 statements,
+                choices,
+                responses,
                 quizzes,
+                heading,
                 pairs,
                 matrix,
                 botResponses,
@@ -571,6 +533,90 @@ class Builder extends BaseBuilder {
         }
         return node;
     }
+    /**
+     * Set every correct answer as an example for Decision node(s)
+     *
+     * @param answers - array of answers
+     * @returns true if any of the answers has an example, otherwise undefined
+     */
+    setDefaultExamplesFlags(onlyCorrect, ...nodes) {
+        if (Array.isArray(nodes)) {
+            for (const ds of nodes) {
+                if (Array.isArray(ds)) {
+                    for (const d of ds) {
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                        if (!d.isExample && (!onlyCorrect || d.isCorrect)) {
+                            d.isDefaultExample = true;
+                            d.isExample = true;
+                        }
+                    }
+                }
+                else if (ds) {
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    if (!ds.isExample && (!onlyCorrect || ds.isCorrect)) {
+                        ds.isDefaultExample = true;
+                        ds.isExample = true;
+                    }
+                }
+            }
+        }
+    }
+    setDefaultExamplesBodyBits(body) {
+        if (!body || !body.bodyParts || body.bodyParts.length === 0)
+            return;
+        for (const part of body.bodyParts) {
+            if (part) {
+                switch (part.type) {
+                    case BodyBitType.gap: {
+                        const gap = part;
+                        if (!gap.data.isExample) {
+                            gap.data.isDefaultExample = true;
+                            gap.data.isExample = true;
+                        }
+                        break;
+                    }
+                    case BodyBitType.select: {
+                        const select = part;
+                        for (const option of select.data.options) {
+                            if (!option.isExample && option.isCorrect) {
+                                option.isDefaultExample = true;
+                                option.isExample = true;
+                            }
+                        }
+                        break;
+                    }
+                    case BodyBitType.highlight: {
+                        const highlight = part;
+                        for (const text of highlight.data.texts) {
+                            if (!text.isExample && text.isCorrect) {
+                                text.isDefaultExample = true;
+                                text.isExample = true;
+                            }
+                        }
+                        break;
+                    }
+                }
+            }
+        }
+    }
+    // private setDefaultExampleBit(bitType: BitTypeType, node: Bit): void {
+    //   const { example: exampleIn } = node;
+    //   const meta = BitType.getMetadata<BitTypeMetadata>(bitType);
+    //   if (!meta) return;
+    //   if (exampleIn === null) {
+    //     // Set the default for the specific bit
+    //     switch (meta.exampleType) {
+    //       case ExampleType.boolean:
+    //         node.example = true;
+    //         break;
+    //       case ExampleType.string:
+    //         node.example = '';
+    //         break;
+    //       default:
+    //       // Ignore at this level
+    //     }
+    //   }
+    // }
     parseExtraProperties(extraProperties) {
         if (!extraProperties)
             return undefined;
@@ -583,6 +629,126 @@ class Builder extends BaseBuilder {
         }
         return res;
     }
+    /**
+     * Set the 'isExample' flags on the bit
+     *
+     * The flag is set if the bit has an example. The flag is set at each branch level up the tree from
+     * where the 'example' exists.
+     *
+     * @param bit
+     */
+    setIsExampleFlags(bit) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        bit.isExample = false;
+        const checkIsExample = (example) => {
+            if (!example)
+                return false;
+            if (example.isDefaultExample || example.example != undefined) {
+                example.isExample = true;
+                bit.isExample = true;
+            }
+            else {
+                if (example === bit) {
+                    example.isExample = !!bit.isExample;
+                }
+                else {
+                    example.isExample = false;
+                }
+            }
+            return example.isExample;
+        };
+        const { body, cardNode } = bit;
+        // Body bit level
+        if (body && body.bodyParts) {
+            for (const bodyPart of body.bodyParts) {
+                switch (bodyPart.type) {
+                    case BodyBitType.gap: {
+                        checkIsExample(bodyPart.data);
+                        break;
+                    }
+                    case BodyBitType.select: {
+                        const select = bodyPart;
+                        let hasExample = false;
+                        for (const option of select.data.options) {
+                            hasExample = checkIsExample(option) ? true : hasExample;
+                        }
+                        select.data.isExample = hasExample;
+                        break;
+                    }
+                    case BodyBitType.highlight: {
+                        const highlight = bodyPart;
+                        let hasExample = false;
+                        for (const text of highlight.data.texts) {
+                            hasExample = checkIsExample(text) ? true : hasExample;
+                        }
+                        highlight.data.isExample = hasExample;
+                        break;
+                    }
+                }
+            }
+        }
+        // Card level
+        if (cardNode) {
+            // pairs
+            for (const v of (_a = cardNode.pairs) !== null && _a !== void 0 ? _a : []) {
+                checkIsExample(v);
+            }
+            // matrix
+            for (const mx of (_b = cardNode.matrix) !== null && _b !== void 0 ? _b : []) {
+                let hasExample = false;
+                // matrix cell
+                for (const v of (_c = mx.cells) !== null && _c !== void 0 ? _c : []) {
+                    hasExample = checkIsExample(v) ? true : hasExample;
+                }
+                mx.isExample = hasExample;
+            }
+            // quizzes
+            for (const quiz of (_d = cardNode.quizzes) !== null && _d !== void 0 ? _d : []) {
+                let hasExample = false;
+                // responses
+                for (const v of (_e = quiz.responses) !== null && _e !== void 0 ? _e : []) {
+                    hasExample = checkIsExample(v) ? true : hasExample;
+                }
+                // choices
+                for (const v of (_f = quiz.choices) !== null && _f !== void 0 ? _f : []) {
+                    hasExample = checkIsExample(v) ? true : hasExample;
+                }
+                quiz.isExample = hasExample;
+            }
+            // responses
+            for (const v of (_g = cardNode.responses) !== null && _g !== void 0 ? _g : []) {
+                checkIsExample(v);
+            }
+            // choices
+            for (const v of (_h = cardNode.choices) !== null && _h !== void 0 ? _h : []) {
+                checkIsExample(v);
+            }
+            // statements
+            for (const v of (_j = cardNode.statements) !== null && _j !== void 0 ? _j : []) {
+                checkIsExample(v);
+            }
+            // statement
+            checkIsExample(cardNode.statement);
+            // NO: elements
+            // questions
+            for (const v of (_k = cardNode.questions) !== null && _k !== void 0 ? _k : []) {
+                checkIsExample(v);
+            }
+        }
+        // Bit level
+        // statement
+        checkIsExample(bit.statement);
+        // responses
+        for (const v of (_l = bit.responses) !== null && _l !== void 0 ? _l : []) {
+            checkIsExample(v);
+        }
+        // choices
+        for (const v of (_m = bit.choices) !== null && _m !== void 0 ? _m : []) {
+            checkIsExample(v);
+        }
+        // Bit itself
+        checkIsExample(bit);
+    }
     setDefaultBitValues(bit) {
         // Set AIGenerated == true for all AI generated bits
         switch (bit.bitType) {