@gmb/bitmark-parser-generator 1.35.0 → 2.0.0

package/dist/esm/ast/BaseBuilder.js

@@ -1,79 +1,56 @@
 import { Breakscape } from '../breakscaping/Breakscape';
 import { Config } from '../config/Config';
 import { PropertyFormat } from '../model/enum/PropertyFormat';
+import { TextFormat } from '../model/enum/TextFormat';
+import { TextParser } from '../parser/text/TextParser';
 import { ArrayUtils } from '../utils/ArrayUtils';
 import { BooleanUtils } from '../utils/BooleanUtils';
 import { NumberUtils } from '../utils/NumberUtils';
 import { StringUtils } from '../utils/StringUtils';
 class BaseBuilder {
+    constructor() {
+        this.textParser = new TextParser();
+    }
     /**
      * 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.
+     * - 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 __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
+     * @returns example/__isDefaultExample resolved to an Example object
      */
-    toExample(isDefaultExample, example) {
+    toExample(__isDefaultExample, example, defaultExample) {
         // Example
         if (example != undefined) {
-            // Convert to boolean to BreakscapedText
-            if (example === true)
-                example = Breakscape.breakscape('true');
-            if (example === false)
-                example = Breakscape.breakscape('false');
-            return {
-                isDefaultExample: false,
-                isExample: true,
-                example,
-            };
-        }
-        // Default example
-        if (isDefaultExample) {
-            return {
-                isDefaultExample: true,
-                isExample: true,
-            };
-        }
-        // Not an example
-        return {
-            isDefaultExample: false,
-            isExample: false,
-        };
-    }
-    /**
-     * Convert example to an Example, only allowing boolean values.
-     * - If example is set, then the isExample will be true and example with be example as a boolean.
-     * - 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 (string, boolean) or undefined if none / default
-     * @returns example/isDefaultExample resolved to an Example object
-     */
-    toExampleBoolean(isDefaultExample, example) {
-        const isExampleButNotBoolean = example != undefined && !BooleanUtils.isBooleanString(example);
-        // Example
-        if (example != undefined && !isExampleButNotBoolean) {
+            let exampleValue;
+            // If the default example is a boolean, then the example should be a boolean
+            if (BooleanUtils.isBoolean(defaultExample)) {
+                exampleValue = BooleanUtils.toBoolean(example);
+            }
+            else {
+                exampleValue = example;
+            }
             return {
-                isDefaultExample: false,
                 isExample: true,
-                example: BooleanUtils.toBoolean(example),
+                example: exampleValue,
+                __defaultExample: defaultExample !== null && defaultExample !== void 0 ? defaultExample : null,
             };
         }
         // Default example
-        if (isDefaultExample || isExampleButNotBoolean) {
+        if (__isDefaultExample) {
             return {
-                isDefaultExample: true,
                 isExample: true,
+                example: defaultExample !== null && defaultExample !== void 0 ? defaultExample : null,
+                __defaultExample: defaultExample !== null && defaultExample !== void 0 ? defaultExample : null,
             };
         }
         // Not an example
         return {
-            isDefaultExample: false,
             isExample: false,
+            example: null,
+            __defaultExample: defaultExample !== null && defaultExample !== void 0 ? defaultExample : null,
         };
     }
     /**
@@ -94,12 +71,11 @@ class BaseBuilder {
             if (v == null)
                 return undefined;
             switch (propertyConfig.format) {
-                case PropertyFormat.string: {
-                    // Convert number to string
-                    if (NumberUtils.asNumber(v) != null)
-                        v = `${v}`;
-                    return StringUtils.isString(v) ? StringUtils.string(v) : undefined;
-                }
+                // case PropertyFormat.string: {
+                //   // Convert number to string
+                //   if (NumberUtils.asNumber(v) != null) v = `${v}`;
+                //   return StringUtils.isString(v) ? StringUtils.string(v) : undefined;
+                // }
                 case PropertyFormat.trimmedString:
                     // Convert number to string
                     if (NumberUtils.asNumber(v) != null)
@@ -125,6 +101,67 @@ class BaseBuilder {
         }
         return ArrayUtils.asArray(value);
     }
+    /**
+     * 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 breakscaped string or TextAst or breakscaped string[] or TextAst[]
+     * @param textFormat format of TextAst
+     * @param inBody true if the text is in the body
+     * @returns Breakscaped string or breakscaped string[]
+     */
+    handleJsonText(text, textFormat) {
+        let res;
+        if (!textFormat)
+            textFormat = TextFormat.bitmarkMinusMinus;
+        if (text == null) {
+            res = [];
+        }
+        else {
+            if (this.textParser.isAst(text)) {
+                // Use the text generator to convert the TextAst to breakscaped string
+                // this.ast.printTree(text, NodeType.textAst);
+                res = text;
+            }
+            else if (Array.isArray(text)) {
+                const strArray = [];
+                for (let i = 0, len = text.length; i < len; i++) {
+                    const t = text[i];
+                    if (this.textParser.isAst(t)) {
+                        // Use the text generator to convert the TextAst to breakscaped string
+                        // this.ast.printTree(text, NodeType.textAst);
+                        strArray[i] = t;
+                    }
+                    else {
+                        strArray[i] = this.textParser.toAst(Breakscape.breakscape(t, {
+                            textFormat,
+                        }));
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                        strArray[i].__tag = 'text';
+                    }
+                }
+                // Return the array of TextAst texts
+                return strArray;
+            }
+            else {
+                res = this.textParser.toAst(Breakscape.breakscape(text, {
+                    textFormat,
+                }));
+            }
+        }
+        // Add the __tag property to indicate this is a text item
+        // This is somewhat ugly, but otherwise we would need an AST structure that is not so similar to the JSON
+        // resulting in a lot more conversion code
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        res.__tag = 'text';
+        return res;
+    }
 }
 export { BaseBuilder };
 //# sourceMappingURL=BaseBuilder.js.map

package/dist/esm/ast/BaseBuilder.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseBuilder.js","sourceRoot":"","sources":["../../../src/ast/BaseBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAI1C,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAQnD,MAAM,WAAW;IACf;;;;;;;;;OASG;IACO,SAAS,CACjB,gBAAqC,EACrC,OAAgD;QAEhD,UAAU;QACV,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;YACzB,wCAAwC;YACxC,IAAI,OAAO,KAAK,IAAI;gBAAE,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC9D,IAAI,OAAO,KAAK,KAAK;gBAAE,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAEhE,OAAO;gBACL,gBAAgB,EAAE,KAAK;gBACvB,SAAS,EAAE,IAAI;gBACf,OAAO;aACR,CAAC;QACJ,CAAC;QAED,kBAAkB;QAClB,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO;gBACL,gBAAgB,EAAE,IAAI;gBACtB,SAAS,EAAE,IAAI;aAChB,CAAC;QACJ,CAAC;QAED,iBAAiB;QACjB,OAAO;YACL,gBAAgB,EAAE,KAAK;YACvB,SAAS,EAAE,KAAK;SACjB,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACO,gBAAgB,CACxB,gBAAqC,EACrC,OAAqC;QAErC,MAAM,sBAAsB,GAAG,OAAO,IAAI,SAAS,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAE9F,UAAU;QACV,IAAI,OAAO,IAAI,SAAS,IAAI,CAAC,sBAAsB,EAAE,CAAC;YACpD,OAAO;gBACL,gBAAgB,EAAE,KAAK;gBACvB,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC;aACzC,CAAC;QACJ,CAAC;QAED,kBAAkB;QAClB,IAAI,gBAAgB,IAAI,sBAAsB,EAAE,CAAC;YAC/C,OAAO;gBACL,gBAAgB,EAAE,IAAI;gBACtB,SAAS,EAAE,IAAI;aAChB,CAAC;QACJ,CAAC;QAED,iBAAiB;QACjB,OAAO;YACL,gBAAgB,EAAE,KAAK;YACvB,SAAS,EAAE,KAAK;SACjB,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,aAAa,CAAC,GAAkB,EAAE,KAAsC;QAChF,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO,SAAS,CAAC;QAEpC,MAAM,gBAAgB,GAAG,MAAM,CAAC,sBAAsB,EAAE,CAAC;QACzD,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAE7C,oCAAoC;QAEpC,6BAA6B;QAC7B,MAAM,YAAY,GAAG,CAAC,CAAU,EAAE,EAAE;YAClC,IAAI,CAAC,IAAI,IAAI;gBAAE,OAAO,SAAS,CAAC;YAChC,QAAQ,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC9B,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;oBAC3B,2BAA2B;oBAC3B,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI;wBAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC;oBAEhD,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBACrE,CAAC;gBACD,KAAK,cAAc,CAAC,aAAa;oBAC/B,2BAA2B;oBAC3B,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI;wBAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC;oBAEhD,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAE5E,KAAK,cAAc,CAAC,MAAM;oBACxB,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAEjC,KAAK,cAAc,CAAC,OAAO;oBACzB,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBAEzC,KAAK,cAAc,CAAC,eAAe;oBACjC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC5C,CAAC;YACD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,UAAU,GAAG,KAAkB,CAAC;YACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtD,UAAU,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;CACF;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"BaseBuilder.js","sourceRoot":"","sources":["../../../src/ast/BaseBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAI1C,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAkB,MAAM,0BAA0B,CAAC;AAEtE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAQnD,MAAM,WAAW;IAGf;QACE,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;IACrC,CAAC;IAED;;;;;;;;;OASG;IACO,SAAS,CACjB,kBAAuC,EACvC,OAAsD,EACtD,cAA8D;QAE9D,UAAU;QACV,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;YACzB,IAAI,YAAuC,CAAC;YAE5C,4EAA4E;YAC5E,IAAI,YAAY,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC3C,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACjD,CAAC;iBAAM,CAAC;gBACN,YAAY,GAAG,OAAO,CAAC;YACzB,CAAC;YAED,OAAO;gBACL,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,YAAY;gBACrB,gBAAgB,EAAE,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,IAAI;aACzC,CAAC;QACJ,CAAC;QAED,kBAAkB;QAClB,IAAI,kBAAkB,EAAE,CAAC;YACvB,OAAO;gBACL,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,IAAI;gBAC/B,gBAAgB,EAAE,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,IAAI;aACzC,CAAC;QACJ,CAAC;QAED,iBAAiB;QACjB,OAAO;YACL,SAAS,EAAE,KAAK;YAChB,OAAO,EAAE,IAAI;YACb,gBAAgB,EAAE,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,IAAI;SACzC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACO,aAAa,CAAC,GAAkB,EAAE,KAAsC;QAChF,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO,SAAS,CAAC;QAEpC,MAAM,gBAAgB,GAAG,MAAM,CAAC,sBAAsB,EAAE,CAAC;QACzD,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAE7C,oCAAoC;QAEpC,6BAA6B;QAC7B,MAAM,YAAY,GAAG,CAAC,CAAU,EAAE,EAAE;YAClC,IAAI,CAAC,IAAI,IAAI;gBAAE,OAAO,SAAS,CAAC;YAChC,QAAQ,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC9B,gCAAgC;gBAChC,gCAAgC;gBAChC,qDAAqD;gBAErD,wEAAwE;gBACxE,IAAI;gBACJ,KAAK,cAAc,CAAC,aAAa;oBAC/B,2BAA2B;oBAC3B,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI;wBAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC;oBAEhD,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAE5E,KAAK,cAAc,CAAC,MAAM;oBACxB,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAEjC,KAAK,cAAc,CAAC,OAAO;oBACzB,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBAEzC,KAAK,cAAc,CAAC,eAAe;oBACjC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC5C,CAAC;YACD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,UAAU,GAAG,KAAkB,CAAC;YACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtD,UAAU,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACO,cAAc,CACtB,IAAO,EACP,UAA2B;QAE3B,IAAI,GAAM,CAAC;QAEX,IAAI,CAAC,UAAU;YAAE,UAAU,GAAG,UAAU,CAAC,iBAAiB,CAAC;QAE3D,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;YACjB,GAAG,GAAG,EAAO,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChC,sEAAsE;gBACtE,8CAA8C;gBAE9C,GAAG,GAAG,IAAS,CAAC;YAClB,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,MAAM,QAAQ,GAAc,EAAE,CAAC;gBAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;oBAChD,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;oBAElB,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC7B,sEAAsE;wBACtE,8CAA8C;wBAC9C,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAY,CAAC;oBAC7B,CAAC;yBAAM,CAAC;wBACN,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CACjC,UAAU,CAAC,UAAU,CAAC,CAAW,EAAE;4BACjC,UAAU;yBACX,CAAC,CACH,CAAC;wBACF,8DAA8D;wBAC7D,QAAQ,CAAC,CAAC,CAAS,CAAC,KAAK,GAAG,MAAM,CAAC;oBACtC,CAAC;gBACH,CAAC;gBACD,oCAAoC;gBACpC,OAAO,QAAa,CAAC;YACvB,CAAC;iBAAM,CAAC;gBACN,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CACzB,UAAU,CAAC,UAAU,CAAC,IAAc,EAAE;oBACpC,UAAU;iBACX,CAAC,CACE,CAAC;YACT,CAAC;QACH,CAAC;QAED,yDAAyD;QACzD,yGAAyG;QACzG,0CAA0C;QAC1C,8DAA8D;QAC7D,GAAW,CAAC,KAAK,GAAG,MAAM,CAAC;QAE5B,OAAO,GAAG,CAAC;IACb,CAAC;CAiBF;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}