@gmb/bitmark-parser-generator 1.35.0 → 2.1.0

package/dist/types/ast/Builder.d.ts

@@ -1,22 +1,26 @@
-import { BreakscapedString } from '../model/ast/BreakscapedString';
+import { Bit, BitmarkAst, Body, CardBit, Footer } from '../model/ast/Nodes';
+import { JsonText } from '../model/ast/TextNodes';
 import { BitTypeType } from '../model/enum/BitType';
 import { ResourceTagType } from '../model/enum/ResourceTag';
 import { TextFormatType } from '../model/enum/TextFormat';
+import { ImageResourceWrapperJson, ResourceJson } from '../model/json/ResourceJson';
 import { ParserError } from '../model/parser/ParserError';
 import { ParserInfo } from '../model/parser/ParserInfo';
 import { BaseBuilder } from './BaseBuilder';
-import { Bit, BitmarkAst, Resource, Body, Statement, Response, Quiz, Heading, Pair, Matrix, Choice, Question, AudioResource, ImageResource, MatrixCell, Gap, SelectOption, Select, HighlightText, Highlight, BotResponse, Person, BodyText, BodyPart, Mark, MarkConfig, Example, Flashcard, ImageSource, CardBit, Ingredient, TechnicalTerm, Table, Servings, RatingLevelStartEnd, CaptionDefinition, CaptionDefinitionList, Footer, FooterText, DefinitionListItem } from '../model/ast/Nodes';
+import { BookJson, BotResponseJson, CaptionDefinitionJson, CaptionDefinitionListJson, ChoiceJson, DefinitionListItemJson, ExampleJson, FlashcardJson, HeadingJson, ImageSourceJson, IngredientJson, MarkConfigJson, MatrixCellJson, MatrixJson, PairJson, PersonJson, QuestionJson, QuizJson, RatingLevelStartEndJson, ResponseJson, ServingsJson, StatementJson, TableJson, TechnicalTermJson } from '../model/json/BitJson';
+import { GapJson, HighlightJson, HighlightTextJson, MarkJson, SelectJson, SelectOptionJson } from '../model/json/BodyBitJson';
 /**
  * Builder to build bitmark AST node programmatically
  */
 declare class Builder extends BaseBuilder {
+    private resourceBuilder;
     /**
      * Build bitmark node
      *
      * @param data - data for the node
      * @returns
      */
-    bitmark(data: {
+    buildBitmark(data: {
         bits?: Bit[];
         errors?: ParserError[];
     }): BitmarkAst;
@@ -26,74 +30,74 @@ declare class Builder extends BaseBuilder {
      * @param data - data for the node
      * @returns
      */
-    bit(data: {
+    buildBit(data: {
         bitType: BitTypeType;
         bitLevel: number;
         textFormat?: TextFormatType;
         resourceType?: ResourceTagType;
         isCommented?: boolean;
-        id?: BreakscapedString | BreakscapedString[];
-        internalComment?: BreakscapedString | BreakscapedString[];
-        externalId?: BreakscapedString | BreakscapedString[];
-        spaceId?: BreakscapedString | BreakscapedString[];
-        padletId?: BreakscapedString;
-        jupyterId?: BreakscapedString;
+        id?: string | string[];
+        internalComment?: string | string[];
+        externalId?: string | string[];
+        spaceId?: string | string[];
+        padletId?: string;
+        jupyterId?: string;
         jupyterExecutionCount?: number;
         isPublic?: boolean;
         aiGenerated?: boolean;
-        machineTranslated?: BreakscapedString;
-        analyticsTag?: BreakscapedString | BreakscapedString[];
-        feedbackEngine?: BreakscapedString;
-        feedbackType?: BreakscapedString;
+        machineTranslated?: string;
+        analyticsTag?: string | string[];
+        feedbackEngine?: string;
+        feedbackType?: string;
         disableFeedback?: boolean;
-        releaseVersion?: BreakscapedString;
-        releaseKind?: BreakscapedString;
-        releaseDate?: BreakscapedString;
+        releaseVersion?: string;
+        releaseKind?: string;
+        releaseDate?: string;
         ageRange?: number | number[];
-        lang?: BreakscapedString;
-        language?: BreakscapedString | BreakscapedString[];
-        publisher?: BreakscapedString | BreakscapedString[];
-        publisherName?: BreakscapedString;
-        theme?: BreakscapedString | BreakscapedString[];
-        computerLanguage?: BreakscapedString;
-        target?: BreakscapedString | BreakscapedString[];
-        slug?: BreakscapedString;
-        tag?: BreakscapedString | BreakscapedString[];
-        reductionTag?: BreakscapedString | BreakscapedString[];
-        bubbleTag?: BreakscapedString | BreakscapedString[];
-        levelCEFRp?: BreakscapedString | BreakscapedString[];
-        levelCEFR?: BreakscapedString | BreakscapedString[];
-        levelILR?: BreakscapedString | BreakscapedString[];
-        levelACTFL?: BreakscapedString | BreakscapedString[];
-        icon?: BreakscapedString;
-        iconTag?: BreakscapedString;
-        colorTag?: BreakscapedString | BreakscapedString[];
-        flashcardSet?: BreakscapedString | BreakscapedString[];
-        subtype?: BreakscapedString;
-        bookAlias?: BreakscapedString | BreakscapedString[];
-        coverImage?: BreakscapedString | BreakscapedString[];
-        coverColor?: BreakscapedString;
-        publications?: BreakscapedString | BreakscapedString[];
-        author?: BreakscapedString | BreakscapedString[];
-        subject?: BreakscapedString | BreakscapedString[];
-        date?: BreakscapedString;
-        dateEnd?: BreakscapedString;
-        location?: BreakscapedString;
-        kind?: BreakscapedString;
+        lang?: string;
+        language?: string | string[];
+        publisher?: string | string[];
+        publisherName?: string;
+        theme?: string | string[];
+        computerLanguage?: string;
+        target?: string | string[];
+        slug?: string;
+        tag?: string | string[];
+        reductionTag?: string | string[];
+        bubbleTag?: string | string[];
+        levelCEFRp?: string | string[];
+        levelCEFR?: string | string[];
+        levelILR?: string | string[];
+        levelACTFL?: string | string[];
+        icon?: string;
+        iconTag?: string;
+        colorTag?: string | string[];
+        flashcardSet?: string | string[];
+        subtype?: string;
+        bookAlias?: string | string[];
+        coverImage?: string | string[];
+        coverColor?: string;
+        publications?: string | string[];
+        author?: string | string[];
+        subject?: string | string[];
+        date?: string;
+        dateEnd?: string;
+        location?: string;
+        kind?: string;
         hasMarkAsDone?: boolean;
         processHandIn?: boolean;
-        action?: BreakscapedString;
+        action?: string;
         showInIndex?: boolean;
-        blockId?: BreakscapedString;
+        blockId?: string;
         pageNo?: number;
         x?: number;
         y?: number;
         width?: string;
         height?: string;
         index?: number;
-        classification?: BreakscapedString;
-        availableClassifications?: BreakscapedString | BreakscapedString[];
-        allowedBit?: BreakscapedString | BreakscapedString[];
+        classification?: string;
+        availableClassifications?: string | string[];
+        allowedBit?: string | string[];
         tableFixedHeader?: boolean;
         tableSearch?: boolean;
         tableSort?: boolean;
@@ -103,615 +107,463 @@ declare class Builder extends BaseBuilder {
         tableWhitespaceNoWrap?: boolean;
         tableAutoWidth?: boolean;
         tableResizableColumns?: boolean;
+        tableColumnMinWidth?: number;
         quizCountItems?: boolean;
         quizStrikethroughSolutions?: boolean;
         codeLineNumbers?: boolean;
         codeMinimap?: boolean;
-        stripePricingTableId?: BreakscapedString;
-        stripePublishableKey?: BreakscapedString;
-        thumbImage?: BreakscapedString;
-        scormSource?: BreakscapedString;
-        posterImage?: BreakscapedString;
+        stripePricingTableId?: string;
+        stripePublishableKey?: string;
+        thumbImage?: string;
+        scormSource?: string;
+        posterImage?: string;
         focusX?: number;
         focusY?: number;
-        pointerLeft?: BreakscapedString;
-        pointerTop?: BreakscapedString;
+        pointerLeft?: string;
+        pointerTop?: string;
         listItemIndent?: number;
-        backgroundWallpaper?: BreakscapedString;
+        backgroundWallpaper?: string;
         hasBookNavigation?: boolean;
-        duration?: BreakscapedString;
-        referenceProperty?: BreakscapedString | BreakscapedString[];
-        deeplink?: BreakscapedString | BreakscapedString[];
-        externalLink?: BreakscapedString;
-        externalLinkText?: BreakscapedString;
-        videoCallLink?: BreakscapedString;
-        vendorUrl?: BreakscapedString;
-        search?: BreakscapedString;
-        bot?: BreakscapedString | BreakscapedString[];
-        list?: BreakscapedString | BreakscapedString[];
-        textReference?: BreakscapedString;
+        duration?: string;
+        referenceProperty?: string | string[];
+        deeplink?: string | string[];
+        externalLink?: string;
+        externalLinkText?: string;
+        videoCallLink?: string;
+        vendorUrl?: string;
+        search?: string;
+        bot?: string | string[];
+        list?: string | string[];
+        textReference?: string;
         isTracked?: boolean;
         isInfoOnly?: boolean;
         imageFirst?: boolean;
-        activityType?: BreakscapedString;
-        labelTrue?: BreakscapedString;
-        labelFalse?: BreakscapedString;
-        content2Buy?: BreakscapedString;
-        mailingList?: BreakscapedString;
-        buttonCaption?: BreakscapedString;
-        callToActionUrl?: BreakscapedString;
-        caption?: BreakscapedString;
-        quotedPerson?: BreakscapedString;
+        activityType?: string;
+        labelTrue?: string;
+        labelFalse?: string;
+        content2Buy?: string;
+        mailingList?: string;
+        buttonCaption?: string;
+        callToActionUrl?: string;
+        caption?: JsonText;
+        quotedPerson?: string;
         reasonableNumOfChars?: number;
         resolved?: boolean;
-        resolvedDate?: BreakscapedString;
-        resolvedBy?: BreakscapedString;
+        resolvedDate?: string;
+        resolvedBy?: string;
         maxCreatedBits?: number;
         maxDisplayLevel?: number;
-        page?: BreakscapedString | BreakscapedString[];
-        productId?: BreakscapedString | BreakscapedString[];
-        product?: BreakscapedString | BreakscapedString[];
-        productList?: BreakscapedString | BreakscapedString[];
-        productVideo?: BreakscapedString | BreakscapedString[];
-        productVideoList?: BreakscapedString | BreakscapedString[];
-        productFolder?: BreakscapedString;
-        technicalTerm?: TechnicalTerm;
-        servings?: Servings;
-        ratingLevelStart?: RatingLevelStartEnd;
-        ratingLevelEnd?: RatingLevelStartEnd;
+        page?: string | string[];
+        productId?: string | string[];
+        product?: string | string[];
+        productList?: string | string[];
+        productVideo?: string | string[];
+        productVideoList?: string | string[];
+        productFolder?: string;
+        technicalTerm?: Partial<TechnicalTermJson>;
+        servings?: Partial<ServingsJson>;
+        ratingLevelStart?: Partial<RatingLevelStartEndJson>;
+        ratingLevelEnd?: Partial<RatingLevelStartEndJson>;
         ratingLevelSelected?: number;
-        partialAnswer?: BreakscapedString;
-        book?: BreakscapedString;
-        title?: BreakscapedString;
-        subtitle?: BreakscapedString;
-        level?: number | BreakscapedString;
+        partialAnswer?: string;
+        book?: string | BookJson[];
+        title?: JsonText;
+        subtitle?: JsonText;
+        level?: number | string;
         toc?: boolean;
         progress?: boolean;
-        anchor?: BreakscapedString;
-        reference?: BreakscapedString;
-        referenceEnd?: BreakscapedString;
+        anchor?: string;
+        reference?: string;
+        referenceEnd?: string;
         isCaseSensitive?: boolean;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-        imageSource?: ImageSource;
-        person?: Person;
+        item?: JsonText;
+        lead?: JsonText;
+        pageNumber?: JsonText;
+        marginNumber?: JsonText;
+        hint?: JsonText;
+        instruction?: JsonText;
+        example?: Partial<ExampleJson>;
+        imageSource?: Partial<ImageSourceJson>;
+        person?: Partial<PersonJson>;
         extraProperties?: {
             [key: string]: unknown | unknown[];
         };
-        markConfig?: MarkConfig[];
-        imagePlaceholder?: ImageResource;
-        resources?: Resource | Resource[];
-        body?: Body;
-        sampleSolution?: BreakscapedString;
-        additionalSolutions?: BreakscapedString | BreakscapedString[];
-        elements?: BreakscapedString[];
-        flashcards?: Flashcard[];
-        definitions?: DefinitionListItem[];
-        statement?: Statement;
-        statements?: Statement[];
-        responses?: Response[];
-        quizzes?: Quiz[];
-        heading?: Heading;
-        pairs?: Pair[];
-        matrix?: Matrix[];
-        table?: Table;
-        choices?: Choice[];
-        questions?: Question[];
-        botResponses?: BotResponse[];
-        ingredients?: Ingredient[];
-        captionDefinitionList?: CaptionDefinitionList;
-        cardBits?: CardBit[];
-        footer?: Footer;
+        markConfig?: Partial<MarkConfigJson>[];
+        imagePlaceholder?: Partial<ImageResourceWrapperJson>;
+        resources?: Partial<ResourceJson> | Partial<ResourceJson>[];
+        body?: Partial<Body>;
+        sampleSolution?: string;
+        additionalSolutions?: string | string[];
+        elements?: string[];
+        flashcards?: Partial<FlashcardJson>[];
+        definitions?: Partial<DefinitionListItemJson>[];
+        statement?: Partial<StatementJson>;
+        statements?: Partial<StatementJson>[];
+        responses?: Partial<ResponseJson>[];
+        quizzes?: Partial<QuizJson>[];
+        heading?: Partial<HeadingJson>;
+        pairs?: Partial<PairJson>[];
+        matrix?: Partial<MatrixJson>[];
+        table?: Partial<TableJson>;
+        choices?: Partial<ChoiceJson>[];
+        questions?: Partial<QuestionJson>[];
+        botResponses?: Partial<BotResponseJson>[];
+        ingredients?: Partial<IngredientJson>[];
+        captionDefinitionList?: Partial<CaptionDefinitionListJson>;
+        cardBits?: Partial<CardBit>[];
+        footer?: Partial<Footer>;
         markup?: string;
         parser?: ParserInfo;
+        __isDefaultExample?: boolean;
     }): Bit | undefined;
+    /**
+     * Build books[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildBooks(data: Partial<BookJson>[] | string | undefined): BookJson[] | string | undefined;
     /**
      * Build choice node
      *
      * @param data - data for the node
      * @returns
      */
-    choice(data: {
-        text: BreakscapedString;
-        isCorrect: boolean;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): Choice;
+    protected buildBook(data: Partial<BookJson> | undefined): BookJson | undefined;
+    /**
+     * Build choice[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildChoices(data: Partial<ChoiceJson>[] | undefined): ChoiceJson[] | undefined;
+    /**
+     * Build choice node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildChoice(data: Partial<ChoiceJson> | undefined): ChoiceJson | undefined;
+    /**
+     * Build response[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildResponses(data: Partial<ResponseJson>[] | undefined): ResponseJson[] | undefined;
     /**
      * Build response node
      *
      * @param data - data for the node
      * @returns
      */
-    response(data: {
-        text: BreakscapedString;
-        isCorrect: boolean;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): Response;
+    protected buildResponse(data: Partial<ResponseJson> | undefined): ResponseJson | undefined;
+    /**
+     * Build bot response[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildBotResponses(data: Partial<BotResponseJson>[] | undefined): BotResponseJson[] | undefined;
     /**
      * Build bot response node
      *
      * @param data - data for the node
      * @returns
      */
-    botResponse(data: {
-        response: BreakscapedString;
-        reaction: BreakscapedString;
-        feedback: BreakscapedString;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-    }): BotResponse;
+    protected botResponse(data: Partial<BotResponseJson> | undefined): BotResponseJson | undefined;
+    /**
+     * Build quiz[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildQuizzes(data: Partial<QuizJson>[] | undefined): QuizJson[] | undefined;
     /**
      * Build quiz node
      *
      * @param data - data for the node
      * @returns
      */
-    quiz(data: {
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-        choices?: Choice[];
-        responses?: Response[];
-    }): Quiz;
+    protected buildQuiz(data: Partial<QuizJson> | undefined): QuizJson | undefined;
     /**
      * Build heading node
      *
      * @param data - data for the node
      * @returns
      */
-    heading(data: {
-        forKeys: BreakscapedString;
-        forValues: BreakscapedString | BreakscapedString[];
-    }): Heading | undefined;
+    protected buildHeading(data: Partial<HeadingJson> | undefined): HeadingJson | undefined;
+    /**
+     * Build pair[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildPairs(bitType: BitTypeType, data: Partial<PairJson>[] | undefined): PairJson[] | undefined;
     /**
      * Build pair node
      *
      * @param data - data for the node
      * @returns
      */
-    pair(data: {
-        key?: BreakscapedString;
-        keyAudio?: AudioResource;
-        keyImage?: ImageResource;
-        values: BreakscapedString[];
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isCaseSensitive?: boolean;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): Pair;
+    protected buildPair(bitType: BitTypeType, data: Partial<PairJson> | undefined): PairJson | undefined;
+    /**
+     * Build matrix[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildMatricies(data: Partial<MatrixJson>[] | undefined): MatrixJson[] | undefined;
     /**
      * Build matrix node
      *
      * @param data - data for the node
      * @returns
      */
-    matrix(data: {
-        key: BreakscapedString;
-        cells: MatrixCell[];
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-    }): Matrix;
+    protected buildMatrix(data: Partial<MatrixJson> | undefined): MatrixJson | undefined;
     /**
      * Build matrixCell node
      *
      * @param data - data for the node
      * @returns
      */
-    matrixCell(data: {
-        values: BreakscapedString[];
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        hint?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isCaseSensitive?: boolean;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): MatrixCell;
+    protected buildMatrixCell(data: Partial<MatrixCellJson> | undefined): MatrixCellJson | undefined;
     /**
      * Build table node
      *
      * @param data - data for the node
      * @returns
      */
-    table(data: {
-        columns: BreakscapedString[];
-        rows: BreakscapedString[][];
-    }): Table;
+    protected buildTable(dataIn: Partial<TableJson> | undefined): TableJson | undefined;
     /**
-     * Build question node
+     * Build question[] node
      *
      * @param data - data for the node
      * @returns
      */
-    question(data: {
-        question: BreakscapedString;
-        partialAnswer?: BreakscapedString;
-        sampleSolution?: BreakscapedString;
-        additionalSolutions?: BreakscapedString[];
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        reasonableNumOfChars?: number;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): Question;
+    protected buildQuestions(data: Partial<QuestionJson>[] | undefined): QuestionJson[] | undefined;
     /**
-     * Build ingredient node
+     * Build question node
      *
      * @param data - data for the node
      * @returns
      */
-    ingredient(data: {
-        title?: BreakscapedString;
-        checked?: boolean;
-        item?: BreakscapedString;
-        quantity?: number;
-        unit?: BreakscapedString;
-        unitAbbr?: BreakscapedString;
-        decimalPlaces?: number;
-        disableCalculation?: boolean;
-    }): Ingredient;
+    protected buildQuestion(data: Partial<QuestionJson> | undefined): QuestionJson | undefined;
     /**
-     * Build body node
+     * Build ingredient[] node
      *
      * @param data - data for the node
      * @returns
      */
-    body(data: {
-        bodyParts?: BodyPart[];
-        bodyJson?: unknown;
-    }): Body;
+    protected buildIngredients(data: Partial<IngredientJson>[] | undefined): IngredientJson[] | undefined;
     /**
-     * Build bodyPartText node
+     * Build ingredient node
      *
      * @param data - data for the node
-     * @param isPlain - true if plain text, otherwise false
      * @returns
      */
-    bodyText(data: {
-        text: BreakscapedString;
-    }, isPlain: boolean): BodyText;
+    protected buildIngredient(data: Partial<IngredientJson> | undefined): IngredientJson | undefined;
     /**
-     * Build footer node
+     * Build body node
+     * - Handles JSON, Bitmark text, and plain text
+     *   - body: set to either string, TextAst, or JSON
+     *   - bodyBits: set to array of BodyBitJson (will be validated and merged into body if it is a string)
+     *   - placeholders: set to placeholders from v2 JSON when body is a v2 JSON string
+     *   - bodyString: set to the original string if body is a string (only used for card body)
      *
      * @param data - data for the node
      * @returns
      */
-    footer(data: {
-        footerParts?: FooterText[];
-    }): Footer;
+    protected buildBody(textFormat: TextFormatType, data: Partial<Body> | undefined): Body | undefined;
     /**
      * Build footer node
      *
      * @param data - data for the node
      * @returns
      */
-    footerText(data: {
-        text: BreakscapedString;
-    }, isPlain: boolean): FooterText;
+    protected buildFooter(data: Partial<Footer> | undefined): Footer | undefined;
     /**
      * Build gap node
      *
      * @param data - data for the node
      * @returns
      */
-    gap(data: {
-        solutions: BreakscapedString[];
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isCaseSensitive?: boolean;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): Gap;
+    protected buildGap(data: Partial<GapJson> | undefined): GapJson | undefined;
+    /**
+     * Build mark configs node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildMarkConfigs(data: Partial<MarkConfigJson>[] | undefined): MarkConfigJson[] | undefined;
     /**
      * Build mark config node
      *
      * @param data - data for the node
      * @returns
      */
-    markConfig(data: {
-        mark: BreakscapedString;
-        color?: BreakscapedString;
-        emphasis?: BreakscapedString;
-    }): MarkConfig;
+    protected buildMarkConfig(data: Partial<MarkConfigJson> | undefined): MarkConfigJson | undefined;
     /**
      * Build mark node
      *
      * @param data - data for the node
      * @returns
      */
-    mark(data: {
-        solution: BreakscapedString;
-        mark?: BreakscapedString;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: BreakscapedString | boolean;
-    }): Mark;
+    protected buildMark(data: Partial<MarkJson> | undefined): MarkJson | undefined;
     /**
      * Build select node
      *
      * @param data - data for the node
      * @returns
      */
-    select(data: {
-        options: SelectOption[];
-        prefix?: BreakscapedString;
-        postfix?: BreakscapedString;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-    }): Select;
+    protected buildSelect(data: Partial<SelectJson> | undefined): SelectJson | undefined;
+    /**
+     * Build selectOption[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildSelectOptions(data: Partial<SelectOptionJson>[] | undefined): SelectOptionJson[] | undefined;
     /**
      * Build selectOption node
      *
      * @param data - data for the node
      * @returns
      */
-    selectOption(data: {
-        text: BreakscapedString;
-        isCorrect: boolean;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): SelectOption;
+    protected buildSelectOption(data: Partial<SelectOptionJson> | undefined): SelectOptionJson | undefined;
     /**
      * Build highlight node
      *
      * @param data - data for the node
      * @returns
      */
-    highlight(data: {
-        texts: HighlightText[];
-        prefix?: BreakscapedString;
-        postfix?: BreakscapedString;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-    }): Highlight;
+    buildHighlight(data: Partial<HighlightJson> | undefined): HighlightJson | undefined;
+    /**
+     * Build highlightText[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildHighlightTexts(data: Partial<HighlightTextJson>[] | undefined): HighlightTextJson[] | undefined;
     /**
      * Build highlightText node
      *
      * @param data - data for the node
      * @returns
      */
-    highlightText(data: {
-        text: BreakscapedString;
-        isCorrect: boolean;
-        isHighlighted: boolean;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): HighlightText;
+    protected buildHighlightText(data: Partial<HighlightTextJson> | undefined): HighlightTextJson | undefined;
+    /**
+     * Build flashcards node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildFlashcards(data: Partial<FlashcardJson>[] | undefined): FlashcardJson[] | undefined;
     /**
      * Build flashcard node
      *
      * @param data - data for the node
      * @returns
      */
-    flashcard(data: {
-        question: BreakscapedString;
-        answer?: BreakscapedString;
-        alternativeAnswers?: BreakscapedString[];
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): Flashcard;
+    protected buildFlashcard(data: Partial<FlashcardJson> | undefined): FlashcardJson | undefined;
+    /**
+     * Build definitionListItem[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildDefinitionList(data: Partial<DefinitionListItemJson>[] | undefined): DefinitionListItemJson[] | undefined;
     /**
      * Build definitionListItem node
      *
      * @param data - data for the node
      * @returns
      */
-    definitionListItem(data: {
-        term: BreakscapedString;
-        description?: BreakscapedString;
-        alternativeDefinitions?: BreakscapedString[];
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): DefinitionListItem;
+    protected buildDefinitionListItem(data: Partial<DefinitionListItemJson> | undefined): DefinitionListItemJson | undefined;
+    /**
+     * Build statement[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildStatements(data: Partial<StatementJson>[] | undefined): StatementJson[] | undefined;
     /**
      * Build statement node
      *
      * @param data - data for the node
      * @returns
      */
-    statement(data: {
-        text: BreakscapedString;
-        isCorrect: boolean;
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-    }): Statement;
+    protected buildStatement(data: Partial<StatementJson> | undefined): StatementJson | undefined;
     /**
      * Build (image-on-device) imageSource node
      *
      * @param data - data for the node
      * @returns
      */
-    imageSource(data: {
-        url: BreakscapedString;
-        mockupId: BreakscapedString;
-        size?: number;
-        format?: BreakscapedString;
-        trim?: boolean;
-    }): ImageSource;
+    protected buildImageSource(data: Partial<ImageSourceJson> | undefined): ImageSourceJson | undefined;
     /**
      * Build (chat) person node
      *
      * @param data - data for the node
      * @returns
      */
-    person(data: {
-        name: BreakscapedString;
-        title?: BreakscapedString;
-        avatarImage?: ImageResource;
-    }): Person;
+    protected buildPerson(bitType: BitTypeType, data: Partial<PersonJson> | undefined): PersonJson | undefined;
     /**
      * Build (cook-ingredients) technicalTerm node
      *
      * @param data - data for the node
      * @returns
      */
-    technicalTerm(data: {
-        technicalTerm: BreakscapedString;
-        lang?: BreakscapedString;
-    }): TechnicalTerm;
+    protected buildTechnicalTerm(data: Partial<TechnicalTermJson> | undefined): TechnicalTermJson | undefined;
     /**
      * Build (cook-ingredients) servings node
      *
      * @param data - data for the node
      * @returns
      */
-    servings(data: {
-        servings: number;
-        unit?: BreakscapedString;
-        unitAbbr?: BreakscapedString;
-        decimalPlaces?: number;
-        disableCalculation?: boolean;
-        hint?: BreakscapedString;
-    }): Servings;
+    protected buildServings(data: Partial<ServingsJson> | undefined): ServingsJson | undefined;
     /**
      * Build (survey-rating) ratingLevelStart / ratingLevelEnd node
      *
      * @param data - data for the node
      * @returns
      */
-    ratingLevelStartEnd(data: {
-        level: number;
-        label?: BreakscapedString;
-    }): RatingLevelStartEnd;
+    protected buildRatingLevelStartEnd(data: Partial<RatingLevelStartEndJson> | undefined): RatingLevelStartEndJson | undefined;
     /**
      * Build captionDefinition node
      *
      * @param data - data for the node
      * @returns
      */
-    captionDefinition(data: {
-        term: BreakscapedString;
-        description: BreakscapedString;
-    }): CaptionDefinition;
+    protected buildCaptionDefinition(data: Partial<CaptionDefinitionJson> | undefined): CaptionDefinitionJson | undefined;
     /**
      * Build captionDefinitionList node
      *
      * @param data - data for the node
      * @returns
      */
-    captionDefinitionList(data: {
-        columns: BreakscapedString[];
-        definitions: CaptionDefinition[];
-    }): CaptionDefinitionList;
-    private itemLead;
+    protected buildCaptionDefinitionList(data: Partial<CaptionDefinitionListJson> | undefined): CaptionDefinitionListJson | undefined;
+    /**
+     * Build card bit[] node
+     *
+     * @param data - data for the node
+     * @returns
+     */
+    protected buildCardBits(textFormat: TextFormatType, data: Partial<CardBit>[] | undefined): CardBit[] | undefined;
     /**
      * Build card bit node
      *
      * @param data - data for the node
      * @returns
      */
-    cardBit(data: {
-        item?: BreakscapedString;
-        lead?: BreakscapedString;
-        pageNumber?: BreakscapedString;
-        marginNumber?: BreakscapedString;
-        hint?: BreakscapedString;
-        instruction?: BreakscapedString;
-        isDefaultExample?: boolean;
-        example?: Example;
-        extraProperties?: {
-            [key: string]: unknown | unknown[];
-        };
-        body?: Body;
-    }): CardBit | undefined;
-    private cardNode;
+    protected buildCardBit(textFormat: TextFormatType, data: Partial<CardBit> | undefined): CardBit | undefined;
+    private buildCardNode;
     /**
      * Set examples down the tree
      *
      * @param body
      * @param cardNode
-     * @param isDefaultExample
+     * @param __isDefaultExample
      * @param example
      * @returns true if any of the answers has an example, otherwise undefined
      */
@@ -719,7 +571,7 @@ declare class Builder extends BaseBuilder {
     /**
      * Set examples for boolean nodes
      *
-     * @param isDefaultExample
+     * @param __isDefaultExample
      * @param example
      * @param onlyCorrect
      * @param nodes
@@ -729,7 +581,7 @@ declare class Builder extends BaseBuilder {
     /**
      * Set examples for string nodes
      *
-     * @param isDefaultExample
+     * @param __isDefaultExample
      * @param example
      * @param nodes
      * @returns true if any of the answers has an example, otherwise undefined
@@ -741,7 +593,7 @@ declare class Builder extends BaseBuilder {
      *
      * This function is not type safe and should be used with care
      *
-     * @param body set if the value should be passed down the body to the body bits
+     * @param body/body[] set if the value should be passed down the body to the body bits / card body bits
      * @param bodyBitTypes body bit types to push the value down to
      * @param cardNode set if the value should be passed down the card node
      * @param path path for the value