@gmb/bitmark-parser-generator 3.34.0 → 3.36.0

package/dist/types/BitmarkParserGenerator.d.ts

@@ -1,478 +0,0 @@
-import { EnumType } from '@ncoderz/superenum';
-import { Ast } from './ast/Ast';
-import { BitmarkOptions } from './generator/bitmark/BitmarkGenerator';
-import { JsonOptions } from './generator/json/JsonGenerator';
-import { BitmarkAst } from './model/ast/Nodes';
-import { BitmarkParserTypeType } from './model/enum/BitmarkParserType';
-import { BitmarkParser } from './parser/bitmark/BitmarkParser';
-import { JsonParser } from './parser/json/JsonParser';
-import { BitmarkVersionType } from './model/enum/BitmarkVersion';
-import { InfoTypeType } from './model/info/enum/InfoType';
-import { InfoFormatType } from './model/info/enum/InfoFormat';
-import { TextGenerator } from './generator/text/TextGenerator';
-import { TextParser } from './parser/text/TextParser';
-import * as fs from 'fs-extra';
-import { FileOptions } from './ast/writer/FileWriter';
-import { TextLocationType } from './model/enum/TextLocation';
-import { BodyTextFormatType } from './model/enum/BodyTextFormat';
-/**
- * Info options for the parser
- */
-export interface InfoOptions {
-    /**
-     * Specify the type of information to return, overriding the default (list)
-     * - list: list of supported bits
-     * - deprecated: list of deprecated bits
-     * - all: list of supported bits and deprecated bits
-     * - bit: configuration for a specific bit, or all bits
-     */
-    type?: InfoTypeType;
-    /**
-     * Specify the bit type to return, overriding the default (all)
-     */
-    bit?: string;
-    /**
-     * Specify the output format, overriding the default (text)
-     */
-    outputFormat?: InfoFormatType;
-    /**
-     * Prettify the JSON.
-     *
-     * If not set or false, JSON will not be prettified.
-     * If true, JSON will be prettified with an indent of 2.
-     * If a positive integer, JSON will be prettified with an indent of this number.
-     *
-     * If prettify is set, a string will be returned if possible.
-     */
-    prettify?: boolean | number;
-}
-/**
- * Conversion options for bitmark / JSON conversion
- */
-export interface ConvertOptions {
-    /**
-     * The version of bitmark to output.
-     * If not specified, the version will be 3.
-     *
-     * Specifying the version will set defaults for other options.
-     * - Bitmark v2:
-     *   - bitmarkOptions.cardSetVersion: 1
-     *   - jsonOptions.textAsPlainText: true
-     * - Bitmark v3:
-     *   - bitmarkOptions.cardSetVersion: 2
-     *   - jsonOptions.textAsPlainText: false
-     *
-     */
-    bitmarkVersion?: BitmarkVersionType;
-    /**
-     * Specify the bitmark parser to use, overriding the default
-     */
-    bitmarkParserType?: BitmarkParserTypeType;
-    /**
-     * Set to force input to be interpreted as a particular format, overriding the auto-detection
-     * Auto-detection can fail or open unwanted files for strings that look like paths
-     */
-    inputFormat?: InputType;
-    /**
-     * Specify the output format, overriding the default
-     */
-    outputFormat?: OutputType;
-    /**
-     * Specify a file to write the output to
-     */
-    outputFile?: fs.PathLike;
-    /**
-     * Options for the output file
-     */
-    fileOptions?: FileOptions;
-    /**
-     * Options for bitmark generation
-     */
-    bitmarkOptions?: BitmarkOptions;
-    /**
-     * Options for JSON generation
-     */
-    jsonOptions?: JsonOptions;
-}
-/**
- * Prettify options for bitmark / JSON prettify / validate
- */
-export interface UpgradeOptions {
-    /**
-     * The version of bitmark to output.
-     * If not specified, the version will be 3.
-     *
-     * Specifying the version will set defaults for other options.
-     * - Bitmark v2:
-     *   - bitmarkOptions.cardSetVersion: 1
-     *   - jsonOptions.textAsPlainText: true
-     * - Bitmark v3:
-     *   - bitmarkOptions.cardSetVersion: 2
-     *   - jsonOptions.textAsPlainText: false
-     *
-     */
-    bitmarkVersion?: BitmarkVersionType;
-    /**
-     * Specify the bitmark parser to use, overriding the default
-     */
-    bitmarkParserType?: BitmarkParserTypeType;
-    /**
-     * Set to force input to be interpreted as a particular format, overriding the auto-detection
-     * Auto-detection can fail or open unwanted files for strings that look like paths
-     */
-    inputFormat?: InputType;
-    /**
-     * Specify a file to write the output to
-     */
-    outputFile?: fs.PathLike;
-    /**
-     * Options for the output file
-     */
-    fileOptions?: FileOptions;
-    /**
-     * Options for bitmark generation
-     */
-    bitmarkOptions?: BitmarkOptions;
-    /**
-     * Options for JSON generation
-     */
-    jsonOptions?: JsonOptions;
-}
-/**
- * Conversion options for bitmark text / JSON conversion
- */
-export interface ConvertTextOptions {
-    /**
-     * Specify the text format (default: bitmark++)
-     */
-    textFormat?: BodyTextFormatType;
-    /**
-     * Specify the text location (default: body)
-     */
-    textLocation?: TextLocationType;
-    /**
-     * Set to force input to be interpreted as a particular format, overriding the auto-detection
-     * Auto-detection can fail or open unwanted files for strings that look like paths
-     */
-    inputFormat?: InputType;
-    /**
-     * Specify a file to write the output to
-     */
-    outputFile?: fs.PathLike;
-    /**
-     * Options for the output file
-     */
-    fileOptions?: FileOptions;
-    /**
-     * Options for JSON generation
-     */
-    jsonOptions?: TextJsonOptions;
-}
-/**
- * Create AST options
- */
-export interface CreateAstOptions {
-    /**
-     * Set to force input to be interpreted as a particular format, overriding the auto-detection
-     * Auto-detection can fail or open unwanted files for strings that look like paths
-     */
-    inputFormat?: InputType;
-}
-/**
- * Breakscape options
- */
-export interface BreakscapeOptions {
-    /**
-     * Set to force input to be interpreted as a particular format, overriding the auto-detection
-     * Auto-detection can fail or open unwanted files for strings that look like paths
-     */
-    inputFormat?: InputType;
-    /**
-     * Specify a file to write the output to
-     */
-    outputFile?: fs.PathLike;
-    /**
-     * Options for the output file
-     */
-    fileOptions?: FileOptions;
-    /**
-     * Specify the text format (default:  bitmark++)
-     */
-    textFormat?: BodyTextFormatType;
-    /**
-     * Specify the text location (default: body)
-     */
-    textLocation?: TextLocationType;
-}
-/**
- * Unbreakscape options
- */
-export interface UnbreakscapeOptions {
-    /**
-     * Set to force input to be interpreted as a particular format, overriding the auto-detection
-     * Auto-detection can fail or open unwanted files for strings that look like paths
-     */
-    inputFormat?: InputType;
-    /**
-     * Specify a file to write the output to
-     */
-    outputFile?: fs.PathLike;
-    /**
-     * Options for the output file
-     */
-    fileOptions?: FileOptions;
-    /**
-     * Specify the text format (default: bitmark++)
-     */
-    textFormat?: BodyTextFormatType;
-    /**
-     * Specify the text location (default: body)
-     */
-    textLocation?: TextLocationType;
-}
-/**
- * Input type enumeration
- */
-declare const Input: Readonly<{
-    /**
-     * Input is as a string
-     */
-    string: "string";
-    /**
-     * Input is as a file path
-     */
-    file: "file";
-}> & import("@ncoderz/superenum").EnumExtensions<EnumType<{
-    /**
-     * Input is as a string
-     */
-    string: "string";
-    /**
-     * Input is as a file path
-     */
-    file: "file";
-}>>;
-export type InputType = EnumType<typeof Input>;
-/**
- * Output type enumeration
- */
-declare const Output: Readonly<{
-    /**
-     * Output bitmark string
-     */
-    bitmark: "bitmark";
-    /**
-     * Output JSON as a plain JS object, or a file
-     */
-    json: "json";
-    /**
-     * Output AST as a plain JS object, or a file
-     */
-    ast: "ast";
-}> & import("@ncoderz/superenum").EnumExtensions<EnumType<{
-    /**
-     * Output bitmark string
-     */
-    bitmark: "bitmark";
-    /**
-     * Output JSON as a plain JS object, or a file
-     */
-    json: "json";
-    /**
-     * Output AST as a plain JS object, or a file
-     */
-    ast: "ast";
-}>>;
-export type OutputType = EnumType<typeof Output>;
-/**
- * Options for bitmark text JSON generation
- */
-export interface TextJsonOptions {
-    /**
-     * Prettify the JSON.
-     *
-     * If not set or false, JSON will not be prettified.
-     * If true, JSON will be prettified with an indent of 2.
-     * If a positive integer, JSON will be prettified with an indent of this number.
-     *
-     * If prettify is set, a string will be returned if possible.
-     */
-    prettify?: boolean | number;
-    /**
-     * Stringify the JSON.
-     *
-     * If not set or false, JSON will be returned as a plain JS object.
-     * It true, JSON will be stringified.
-     *
-     * If prettify is set, it will override this setting.
-     */
-    stringify?: boolean;
-    /**
-     * [development only]
-     * Generate debug information in the output.
-     */
-    debugGenerationInline?: boolean;
-}
-/**
- * Bitmark tool for manipulating bitmark in all its formats.
- *
- */
-declare class BitmarkParserGenerator {
-    protected ast: Ast;
-    protected jsonParser: JsonParser;
-    protected bitmarkParser: BitmarkParser;
-    protected textParser: TextParser;
-    protected textGenerator: TextGenerator;
-    /**
-     * Get the version of the bitmark-parser-generator library
-     */
-    version(): string;
-    /**
-     * Get information about the bitmark-parser-generator library
-     */
-    info(options?: InfoOptions): unknown;
-    /**
-     * Convert bitmark from bitmark to JSON, or JSON to bitmark.
-     *
-     * Input type is detected automatically and may be:
-     * - string: bitmark, JSON, or AST
-     * - object: JSON or AST
-     * - file: bitmark, JSON, or AST
-     *
-     * Output type is selected automatically based on input type detection:
-     * - input(JSON/AST) ==> output(bitmark)
-     * - input(bitmark)  ==> output(JSON)
-     *
-     * By default, the result is returned as a string for bitmark, or a plain JS object for JSON/AST.
-     *
-     * The options can be used to write the output to a file and to set conversion options or override defaults.
-     *
-     * If both the input and output formats are the same, the input will be validated and rewritten.
-     * This feature be used to upgrade bitmark or JSON to the latest version.
-     *
-     * @param input - bitmark or JSON or AST as a string, JSON or AST as plain JS object, or path to a file containing
-     * bitmark, JSON, or AST.
-     * @param options - the conversion options
-     * @returns Promise that resolves to string if converting to bitmark, a plain JS object if converting to JSON, or
-     * void if writing to a file
-     * @throws Error if any error occurs
-     */
-    convert(input: string | fs.PathLike | unknown, options?: ConvertOptions): Promise<string | unknown | void>;
-    /**
-     * Upgrade bitmark or JSON, upgrading to the latest supported syntax, removing unrecognised data in the process.
-     *
-     * THIS FEATURE SHOULD BE USED WITH CAUTION. IT WILL POTENTIALLY DELETE DATA.
-     *
-     * Input type is detected automatically and may be:
-     * - string: bitmark, JSON
-     * - object: JSON
-     * - file: bitmark, JSON
-     *
-     * Output type is the same as the detected input type
-     *
-     * By default, the result is returned as a string for bitmark, or a plain JS object for JSON.
-     *
-     * The options can be used to write the output to a file and to set conversion options or override defaults.
-     *
-     * If both the input and output formats are the same, the input will be validated and rewritten.
-     *
-     * @param input - bitmark or JSON or AST as a string, JSON or AST as plain JS object, or path to a file containing
-     * bitmark, JSON, or AST.
-     * @param options - the conversion options
-     * @returns Promise that resolves to string if upgrading to bitmark, a plain JS object if converting to JSON, or
-     * void if writing to a file
-     * @throws Error if any error occurs
-     */
-    upgrade(input: string | fs.PathLike | unknown, options?: UpgradeOptions): Promise<string | unknown | void>;
-    /**
-     * Create a bitmark AST (Abstract Syntax Tree) from bitmark or JSON or AST
-     *
-     * Input type is detected automatically and may be string, object (JSON or AST), or file
-     *
-     * @param input the JSON or bitmark to convert to a bitmark AST
-     * @param options - the create AST options
-     * @returns bitmark AST
-     * @throws Error if any error occurs
-     */
-    createAst(input: unknown, options?: CreateAstOptions): BitmarkAst;
-    /**
-     * Convert bitmark text from JSON, or JSON to bitmark text.
-     *
-     * Input type is detected automatically and may be:
-     * - string: bitmark text or JSON
-     * - object: JSON
-     * - file: bitmark text or JSON
-     *
-     * Output type is selected automatically based on input type detection:
-     * - input(JSON) ==> output(bitmark text)
-     * - input(bitmark text)  ==> output(JSON)
-     *
-     * By default, the result is returned as a string for bitmark text, or a plain JS object for JSON.
-     *
-     * The options can be used to write the output to a file and to set conversion options or override defaults.
-     *
-     * @param input - bitmark text or JSON as a string, JSON as plain JS object, or path to a file containing
-     * bitmark text or JSON.
-     * @param options - the conversion options
-     * @returns Promise that resolves to string if converting to bitmark text, a plain JS object if converting to JSON, or
-     * void if writing to a file
-     * @throws Error if any error occurs
-     */
-    convertText(input: string | fs.PathLike | unknown, options?: ConvertTextOptions): Promise<string | unknown | void>;
-    /**
-     * Breakscape bitmark text.
-     *
-     * Input type is detected automatically and may be:
-     * - string: text
-     * - file: path to a file containing text
-     *
-     * By default, the result is returned as a string.
-     * By default, the text is breakscaped as if it was bitmark text in the body.
-     * Use the options to change this behaviour.
-     *
-     * The options can be used to write the output to a file.
-     *
-     * @param input - text, or path to a file containing text.
-     * @param options - the conversion options
-     * @returns breakscaped string, or void if writing to a file
-     * @throws Error if any error occurs
-     */
-    breakscapeText(input: string, options?: BreakscapeOptions): string | void;
-    /**
-     * Unescape (unbreakscape) bitmark text
-     *
-     * Input type is detected automatically and may be:
-     * - string: text
-     * - file: path to a file containing text
-     *
-     * By default, the result is returned as a string.
-     * By default, the text is unbreakscaped as if it was bitmark text in the body.
-     * Use the options to change this behaviour.
-     *
-     * The options can be used to write the output to a file.
-     *
-     * @param input - text, or path to a file containing text.
-     * @param options - the conversion options
-     * @returns unbreakscaped string, or void if writing to a file
-     * @throws Error if any error occurs
-     */
-    unbreakscapeText(input: string, options?: UnbreakscapeOptions): string | void;
-    /**
-     * Stringify / prettify a plain JS object to a JSON string, depending on the JSON options
-     *
-     * @param json
-     * @param options
-     * @param forceStringify
-     * @returns
-     */
-    private jsonStringifyPrettify;
-    /**
-     * Get the supported bits as a formatted strings
-     *
-     * @param supportedBits
-     * @returns
-     */
-    private supportedBitsAsString;
-}
-export { BitmarkParserGenerator, Input, Output };
-//# sourceMappingURL=BitmarkParserGenerator.d.ts.map

package/dist/types/BitmarkParserGenerator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BitmarkParserGenerator.d.ts","sourceRoot":"","sources":["../../src/BitmarkParserGenerator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAa,MAAM,oBAAoB,CAAC;AAEzD,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAEtE,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAqB,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC1F,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEjE,OAAO,EAAY,YAAY,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAc,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAG1E,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAiBtD,OAAO,KAAK,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAKtD,OAAO,EAAgB,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAMjE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;IAEpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;IAE9B;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAE1C;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;IAEpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAE1C;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;CACjC;AAED;;GAEG;AACH,QAAA,MAAM,KAAK;IACT;;OAEG;;IAGH;;OAEG;;;IAPH;;OAEG;;IAGH;;OAEG;;GAEH,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,KAAK,CAAC,CAAC;AAE/C;;GAEG;AACH,QAAA,MAAM,MAAM;IACV;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IAZH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;GAEH,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,MAAM,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE5B;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;GAGG;AACH,cAAM,sBAAsB;IAC1B,SAAS,CAAC,GAAG,MAAa;IAC1B,SAAS,CAAC,UAAU,aAAoB;IACxC,SAAS,CAAC,aAAa,gBAAuB;IAC9C,SAAS,CAAC,UAAU,aAAoB;IACxC,SAAS,CAAC,aAAa,gBAAuB;IAE9C;;OAEG;IACI,OAAO,IAAI,MAAM;IAIxB;;OAEG;IACI,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO;IAwD3C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,OAAO,CAClB,KAAK,EAAE,MAAM,GAAG,EAAE,CAAC,QAAQ,GAAG,OAAO,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAyLnC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,OAAO,CAClB,KAAK,EAAE,MAAM,GAAG,EAAE,CAAC,QAAQ,GAAG,OAAO,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAmFnC;;;;;;;;;OASG;IACI,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,UAAU;IAsCxE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,WAAW,CACtB,KAAK,EAAE,MAAM,GAAG,EAAE,CAAC,QAAQ,GAAG,OAAO,EACrC,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAgEnC;;;;;;;;;;;;;;;;;OAiBG;IACI,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,MAAM,GAAG,IAAI;IA8ChF;;;;;;;;;;;;;;;;;OAiBG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM,GAAG,IAAI;IAgDpF;;;;;;;OAOG;IACH,OAAO,CAAC,qBAAqB,CAQ3B;IAEF;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;CAW9B;AAED,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC"}

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

@@ -1,137 +0,0 @@
-import { NodeTypeType } from '../model/ast/NodeType';
-import { BitmarkAst, Node } from '../model/ast/Nodes';
-/**
- * AST tree node information
- */
-export interface NodeInfo {
-    /**
-     * Child index of the node
-     */
-    index: number;
-    /**
-     * Node key
-     */
-    key: NodeTypeType;
-    /**
-     * Node value (if any)
-     */
-    value?: any;
-}
-/**
- * Callbacks for walking the AST
- */
-export interface AstWalkCallbacks<C = undefined> {
-    /**
-     * Called when a branch node is entered
-     *
-     * @param node - this node info
-     * @param route - route to this node from the root
-     * @returns
-     */
-    enter?: (node: NodeInfo, route: NodeInfo[], context: C) => void | boolean;
-    /**
-     * Called when between child nodes
-     *
-     * @param node - this node info (the parent of the children in leftNode / rightNode)
-     * @param leftNode - the left (previous) child node info
-     * @param rightNode - the right (next) child node info
-     * @param route
-     * @returns
-     */
-    between?: (node: NodeInfo, leftNode: NodeInfo, rightNode: NodeInfo, route: NodeInfo[], context: C) => void | boolean;
-    /**
-     * Called when a branch node is exited
-     * @param node - this node info
-     * @param route - route to this node from the root
-     * @returns
-     */
-    exit?: (node: NodeInfo, route: NodeInfo[], context: C) => void;
-    /**
-     * Called when a leaf node is entered
-     * @param node - this node info
-     * @param route - route to this node from the root
-     * @returns
-     */
-    leaf?: (node: NodeInfo, route: NodeInfo[], context: C) => void;
-}
-/**
- * An AST (Abstract Syntax Tree) implementation for the bitmark language
- */
-declare class Ast {
-    constructor();
-    /**
-     * Walk bitmark AST, decending each branch and calling callbacks when entering, leaving, and when in between child
-     * nodes.
-     *
-     * Walking the tree can be used to convert it to another format (e.g. bitmark markup or JSON or text) or for analysis.
-     *
-     * The tree is navigated from root to leaf, decending each branch greedily.
-     *
-     * e.g. for the tree:
-     * ```
-     * A
-     * |__B1
-     * |  |__C1
-     * |  |__C2
-     * |__B2
-     *    |__C3
-     *
-     * Enter A1
-     * Enter B1
-     * Leaf  C1
-     * Betwe B1 (C1, C2)
-     * Leaf  C2
-     * Exit  B1
-     * Betwe A1 (B1, B2)
-     * Enter B2
-     * Leaf  C3
-     * Exit  B2
-     * Exit  A1
-     * ```
-     *
-     * @param context - context object to pass to callbacks
-     * @param ast - bitmark / text AST
-     * @param type - type of AST to walk (i.e. NodeType.bitmarkAst, NodeType.textAst)
-     * @param callbacks - set of callbacks to call while walking the tree
-     */
-    walk<C>(ast: Node, type: NodeTypeType, callbacks: AstWalkCallbacks<C>, context: C): void;
-    /**
-     * Convert a route to a unique key that describes that route.
-     *
-     * For the route A1 -> B4 -> C2 the route key would be A1_B4_C2
-     *
-     * @param route - the tree path from the root to the curent node
-     * @returns
-     */
-    getRouteKey(route: NodeInfo[]): string;
-    /**
-     * Print an AST to the console.
-     * Useful for debug / development purposes
-     *
-     * @param ast - AST
-     * @param rootKey - root node key
-     */
-    printTree(ast: Node, rootKey?: NodeTypeType): void;
-    /**
-     * Preprocess bitmark AST into a standard format (BitmarkAst object) from bitmark AST either as a string
-     * or a plain JS object
-     *
-     * @param ast - bitmark AST as a string or a plain JS object
-     * @returns bitmark AST in a standard format (BitmarkAst object)
-     */
-    preprocessAst(ast: string | unknown): BitmarkAst | undefined;
-    /**
-     * Check if a plain JS object is valid AST
-     *
-     * @param ast - a plain JS object that might be AST
-     * @returns true if AST, otherwise false
-     */
-    isAst(ast: unknown): boolean;
-    private walkRecursive;
-    private getAstKey;
-    private isArray;
-    private isObject;
-    private isValue;
-}
-export { Ast };
-//# sourceMappingURL=Ast.d.ts.map

package/dist/types/ast/Ast.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Ast.d.ts","sourceRoot":"","sources":["../../../src/ast/Ast.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAY,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAGtD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,GAAG,EAAE,YAAY,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,SAAS;IAC7C;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC;IAE1E;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC;IAErH;;;;;OAKG;IACH,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,KAAK,IAAI,CAAC;IAE/D;;;;;OAKG;IACH,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,KAAK,IAAI,CAAC;CAChE;AAED;;GAEG;AACH,cAAM,GAAG;;IAMP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI;IAIxF;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM;IAYtC;;;;;;OAMG;IACH,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,GAAE,YAAkC,GAAG,IAAI;IA2BvE;;;;;;OAMG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS;IAiB5D;;;;;OAKG;IACH,KAAK,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO;IAQ5B,OAAO,CAAC,aAAa;IAoErB,OAAO,CAAC,SAAS;IAYjB,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,OAAO;CAGhB;AAED,OAAO,EAAE,GAAG,EAAE,CAAC"}

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

@@ -1,64 +0,0 @@
-import { TextGenerator } from '../generator/text/TextGenerator';
-import { Property } from '../model/ast/Nodes';
-import { JsonText, TextAst } from '../model/ast/TextNodes';
-import { BitConfig } from '../model/config/BitConfig';
-import { ConfigKeyType } from '../model/config/enum/ConfigKey';
-import { BitTypeType } from '../model/enum/BitType';
-import { TextFormatType } from '../model/enum/TextFormat';
-import { TextLocationType } from '../model/enum/TextLocation';
-import { ExampleJson } from '../model/json/BitJson';
-import { TextParser } from '../parser/text/TextParser';
-export interface WithExampleJson {
-    isExample: boolean;
-    example: ExampleJson;
-    __defaultExample?: ExampleJson;
-}
-export interface BuildContext {
-    bitConfig: BitConfig;
-    bitType: BitTypeType;
-    textFormat: TextFormatType;
-}
-declare class BaseBuilder {
-    protected textParser: TextParser;
-    protected textGenerator: TextGenerator;
-    constructor();
-    /**
-     * Convert example to an Example.
-     * - If example is set, then the isExample will be true and example with be example as a BreakscapedText.
-     * - Else if __isDefaultExample is true, then __isDefaultExample / isExample will both be true.
-     * - Else __isDefaultExample / isExample will both be false.
-     *
-     * @param __isDefaultExample - true if the example is the default value
-     * @param example - the example to convert (BreakscapedText, boolean) or undefined if none / default
-     * @returns example/__isDefaultExample resolved to an Example object
-     */
-    protected toExample(__isDefaultExample: boolean | undefined, example: TextAst | string | boolean | undefined | null, defaultExample?: TextAst | string | boolean | undefined | null): WithExampleJson;
-    /**
-     * Convert a raw bitmark property to an AST property.
-     *
-     * @param key
-     * @param value
-     * @returns
-     */
-    protected toAstProperty(key: ConfigKeyType, value: unknown | unknown[] | undefined): Property | undefined;
-    protected getEmptyTextAst(context: BuildContext): TextAst;
-    /**
-     * Convert the JsonText from the JSON to the AST format:
-     * Input:
-     *  - Bitmark v2: breakscaped string
-     *  - Bitmark v3: bitmark text JSON (TextAst)
-     * Output:
-     *  - bitmark text JSON (TextAst) with __tag property to indicate item is text
-     *
-     * In the case of Bitmark v2 type texts, there is nothing to do but cast the type.
-     *
-     * @param context BuildContext
-     * @param textFormat format of TextAst
-     * @param textLocation location of the text (body, tag, etc.)
-     * @param text JsonText or JsonText[] to convert
-     * @returns Breakscaped string or breakscaped string[]
-     */
-    protected handleJsonText<T extends JsonText | JsonText[] | undefined, R = T extends JsonText[] ? TextAst[] : TextAst>(context: BuildContext, textLocation: TextLocationType, text: T): R;
-}
-export { BaseBuilder };
-//# sourceMappingURL=BaseBuilder.d.ts.map