@traqula/core 0.0.16 → 0.0.18

package/README.md

@@ -51,9 +51,9 @@ Creating a builder is as easy as:
 const sparql11Tokens = LexerBuilder.create(<const> [select, describe]);
 ```
 
-A new lexer can be created from an existing one by calling:
+A new lexer can be created from an existing one, and altered by calling:
 ```typescript
-const sparql11AdjustTokens = sparql11Tokens.addBefore(select, BuiltInAdjust);
+const sparql11AdjustTokens = LexerBuilder.create(sparql11Tokens).addBefore(select, BuiltInAdjust);
 ```
 
 ### Parser Builder
@@ -96,6 +96,22 @@ Rules can be [parameterized](https://chevrotain.io/docs/features/parameterized_r
 Personally I create a function that can be used to create multiple `ParserRule` objects.
 The result of a rule should match the type provided in the `ParserRule` definition, and is the result of a call of `SUBRULE` with that rule.
 
+##### Testing the correctness of your parser
+By default, the parser builder will construct a parser that does not perform validation (to be more speedy).
+When creating a parser, you best enable the validation by passing a context to the parser builder like:
+```typescript
+const context = {
+  tokenVocabulary: myLexerVoc,
+    lexerConfig: {
+    skipValidations: false,
+      ensureOptimizations: true,
+  },
+  parserConfig: {
+    skipValidations: false,
+  },
+}
+```
+
 #### Patching rules
 
 When a rule definition calls to a subrule using `SUBRULE(mySub)`, the implementation itself is not necessarily called.
@@ -133,6 +149,38 @@ The idea is that GeneratorRules and ParserRules can be tied together in the same
  */
 export const iri: GeneratorRule<'iri', IriTerm> = <const> {
     name: 'iri',
-    gImpl: () => ast => ast.value,
+    gImpl: ({ PRINT }) => ast => { PRINT(ast.value) },
   };
 ```
+
+While implementing a generator, you can easily support pretty print indentation manipulating `traqulaIndentation` context item.
+The key for this context item can be accessed like:
+```typescript
+import { traqulaIndentation } from '@traqula/core';
+C[traqulaIndentation] += 2;
+```
+
+### A word on round tripping:
+
+The generator builder can significantly help you with creating a round tripping parser.
+Basically what that allows you to do is to keep information that the AST finds 'unimportant' within the generated string.
+Take for example capitalization and spaces in the sparql spec.
+Both are ignored in the AST, but if you want to generate the same string out of your AST, yuo need to store them somewhere.
+Traqula helps you store this information using it's `Node` `Localization`.
+
+Localization basically allows you to remember what _portion of the original string_ a node represents.
+Take for example the `SENTENCE`: `I Love      Traqula`, If we ignore spaces and caps in the ast, a valid representation would be:
+```
+SENTENCE-node{ words: [ WORD-node{ value: "i" }, WORD-node{ value: "love" }, WORD-node{ value: "traqula" } ] }
+```
+If we generated we would loe the capitalisation and get: `i love traqula` for example.
+Round tripping will add a `source localization` for each node,
+we therefore register that our SENTENCE starts at 0 and ends at 19, while our words have ranges 0-1, 2-6, 12-19.
+Using this information our generator can reconstruct the original string (given the original string).
+The magic happens when we start manipulating the words, so imagine we want to lowercase the word 'Love',
+we would simply annotate in the `localization` that the node should be generated (and not reconstructed),
+and we can generate the sentence: `I love      Traqula`.
+
+To support this feature, the generator requires that your AST follows a tree structure with respect to the ranges.
+That means that a node cannot start later, or end earlier than its children.
+In our example: A sentence cannot start after the first word start, nor can it end before the last word ends.

package/lib/Transformers.d.ts

@@ -3,35 +3,68 @@ type Safeness = 'safe' | 'unsafe';
 type SafeWrap<Safe extends Safeness, obj extends object> = Safe extends 'safe' ? {
     [key in keyof obj]: unknown;
 } : obj;
+export interface VisitContext {
+    shortcut?: boolean;
+    continue?: boolean;
+}
+export interface SelectiveTraversalContext<Nodes> {
+    next?: Nodes[];
+    shortcut?: boolean;
+}
 export declare class TransformerType<Nodes extends Pick<Node, 'type'>> {
+    protected clone<T>(obj: T): T;
     protected safeObjectVisit(value: unknown, mapper: (some: object) => any): unknown;
-    transformNode<Safe extends 'safe' | 'unsafe' = 'safe'>(curObject: object, nodeCallBacks: {
+    /**
+     * Recursively transforms all objects that are not arrays. Mapper is called on deeper objects first.
+     * @param startObject object to start iterating from
+     * @param mapper mapper to transform the various objects - argument is a copy of the original
+     * @param preVisitor callback that is evaluated before iterating deeper.
+     *   If continues is false, we do not iterate deeper, current object is still mapped. - default: true
+     *   If shortcut is true, we do not iterate deeper, nor do we branch out, this mapper will be the last one called.
+     *    - Default false
+     */
+    transformObject(startObject: object, mapper: (some: object) => any, preVisitor?: (some: object) => VisitContext): unknown;
+    /**
+     * Visitor that visits all objects. Visits deeper objects first.
+     */
+    visitObject(startObject: object, visitor: (some: object) => void, preVisitor?: (some: object) => VisitContext): void;
+    transformNode<Safe extends 'safe' | 'unsafe' = 'safe'>(startObject: object, nodeCallBacks: {
         [T in Nodes['type']]?: {
             transform?: (op: SafeWrap<Safe, Extract<Nodes, {
                 type: T;
             }>>) => any;
-            continue?: (op: Extract<Nodes, {
+            preVisitor?: (op: Extract<Nodes, {
                 type: T;
-            }>) => boolean;
+            }>) => VisitContext;
         };
     }): any;
-    visitNode(curObject: object, nodeCallBacks: {
+    visitNode(startObject: object, nodeCallBacks: {
+        [T in Nodes['type']]?: {
+            visitor?: (op: Extract<Nodes, {
+                type: T;
+            }>) => void;
+            preVisitor?: (op: Extract<Nodes, {
+                type: T;
+            }>) => VisitContext;
+        };
+    }): void;
+    traverseNodes(currentNode: Nodes, traverse: {
         [T in Nodes['type']]?: (op: Extract<Nodes, {
             type: T;
-        }>) => boolean;
+        }>) => SelectiveTraversalContext<Nodes>;
     }): void;
 }
 export declare class TransformerSubType<Nodes extends Pick<Node, 'type' | 'subType'>> extends TransformerType<Nodes> {
-    transformNodeSpecific<Safe extends 'safe' | 'unsafe' = 'safe'>(curObject: object, nodeCallBacks: {
+    transformNodeSpecific<Safe extends 'safe' | 'unsafe' = 'safe'>(startObject: object, nodeCallBacks: {
         [T in Nodes['type']]?: {
             transform?: (op: SafeWrap<Safe, Extract<Nodes, {
                 type: T;
             }>>) => any;
-            continue?: (op: Extract<Nodes, {
+            preVisitor?: (op: Extract<Nodes, {
                 type: T;
-            }>) => boolean;
+            }>) => VisitContext;
         };
-    }, nodeSpecificCallBacks?: {
+    }, nodeSpecificCallBacks: {
         [Type in Nodes['type']]?: {
             [SubType in Extract<Nodes, {
                 type: Type;
@@ -41,21 +74,47 @@ export declare class TransformerSubType<Nodes extends Pick<Node, 'type' | 'subTy
                     type: Type;
                     subType: SubType;
                 }>>) => any;
-                continue?: (op: Extract<Nodes, {
+                preVisitor?: (op: Extract<Nodes, {
                     type: Type;
                     subType: SubType;
-                }>) => boolean;
+                }>) => VisitContext;
             };
         };
     }): any;
     /**
      * When both nodeCallBack and NodeSpecific callBack are matched, will only look at nodeSpecifCallback
      */
-    visitNodeSpecific(curObject: object, nodeCallBacks: {
-        [T in Nodes['type']]?: (op: Extract<Nodes, {
-            type: T;
-        }>) => boolean | void;
-    }, nodeSpecificCallBacks?: {
+    visitNodeSpecific(startObject: object, nodeCallBacks: {
+        [T in Nodes['type']]?: {
+            visitor?: (op: Extract<Nodes, {
+                type: T;
+            }>) => void;
+            preVisitor?: (op: Extract<Nodes, {
+                type: T;
+            }>) => VisitContext;
+        };
+    }, nodeSpecificCallBacks: {
+        [Type in Nodes['type']]?: {
+            [Subtype in Extract<Nodes, {
+                type: Type;
+                subType: string;
+            }>['subType']]?: {
+                visitor?: (op: Extract<Nodes, {
+                    type: Type;
+                    subType: Subtype;
+                }>) => void;
+                preVisitor?: (op: Extract<Nodes, {
+                    type: Type;
+                    subType: Subtype;
+                }>) => VisitContext;
+            };
+        };
+    }): void;
+    traverseSubNodes(currentNode: Nodes, traverseNode: {
+        [Type in Nodes['type']]?: (op: Extract<Nodes, {
+            type: Type;
+        }>) => SelectiveTraversalContext<Nodes>;
+    }, traverseSubNode: {
         [Type in Nodes['type']]?: {
             [Subtype in Extract<Nodes, {
                 type: Type;
@@ -63,7 +122,7 @@ export declare class TransformerSubType<Nodes extends Pick<Node, 'type' | 'subTy
             }>['subType']]?: (op: Extract<Nodes, {
                 type: Type;
                 subType: Subtype;
-            }>) => boolean | void;
+            }>) => SelectiveTraversalContext<Nodes>;
         };
     }): void;
 }

package/lib/Transformers.js

@@ -1,7 +1,11 @@
 export class TransformerType {
+    clone(obj) {
+        const newObj = Object.create(Object.getPrototypeOf(obj));
+        Object.defineProperties(newObj, Object.getOwnPropertyDescriptors(obj));
+        return newObj;
+    }
     safeObjectVisit(value, mapper) {
         if (value && typeof value === 'object') {
-            // If you wonder why this is all so hard, this is the reason. We cannot lose the methods of our Array objects
             if (Array.isArray(value)) {
                 return value.map(x => this.safeObjectVisit(x, mapper));
             }
@@ -9,106 +13,214 @@ export class TransformerType {
         }
         return value;
     }
-    transformNode(curObject, nodeCallBacks) {
-        let continueCheck;
-        let transformation;
-        const casted = curObject;
-        if (casted.type) {
-            continueCheck = nodeCallBacks[casted.type]?.continue;
-            transformation = nodeCallBacks[casted.type]?.transform;
-        }
-        let shouldContinue = true;
-        if (continueCheck) {
-            shouldContinue = continueCheck(curObject);
-        }
-        if (!shouldContinue) {
+    /**
+     * Recursively transforms all objects that are not arrays. Mapper is called on deeper objects first.
+     * @param startObject object to start iterating from
+     * @param mapper mapper to transform the various objects - argument is a copy of the original
+     * @param preVisitor callback that is evaluated before iterating deeper.
+     *   If continues is false, we do not iterate deeper, current object is still mapped. - default: true
+     *   If shortcut is true, we do not iterate deeper, nor do we branch out, this mapper will be the last one called.
+     *    - Default false
+     */
+    transformObject(startObject, mapper, preVisitor = () => ({})) {
+        let didShortCut = false;
+        const recurse = (curObject) => {
+            const copy = this.clone(curObject);
+            const context = preVisitor(copy);
+            didShortCut = context.shortcut ?? false;
+            const continues = context.continue ?? true;
+            if (continues && !didShortCut) {
+                for (const [key, value] of Object.entries(copy)) {
+                    if (didShortCut) {
+                        return copy;
+                    }
+                    copy[key] =
+                        this.safeObjectVisit(value, obj => recurse(obj));
+                }
+            }
+            return mapper(copy);
+        };
+        return recurse(startObject);
+    }
+    /**
+     * Visitor that visits all objects. Visits deeper objects first.
+     */
+    visitObject(startObject, visitor, preVisitor = () => ({})) {
+        let didShortCut = false;
+        const recurse = (curObject) => {
+            const context = preVisitor(curObject);
+            didShortCut = context.shortcut ?? false;
+            const continues = context.continue ?? true;
+            if (continues && !didShortCut) {
+                for (const value of Object.values(curObject)) {
+                    if (didShortCut) {
+                        return;
+                    }
+                    this.safeObjectVisit(value, obj => recurse(obj));
+                }
+            }
+            visitor(curObject);
+        };
+        recurse(startObject);
+    }
+    transformNode(startObject, nodeCallBacks) {
+        const transformWrapper = (curObject) => {
+            const casted = curObject;
+            if (casted.type) {
+                const ogFunc = nodeCallBacks[casted.type]?.transform;
+                if (ogFunc) {
+                    return ogFunc(casted);
+                }
+            }
             return curObject;
-        }
-        const copy = { ...curObject };
-        for (const [key, value] of Object.entries(copy)) {
-            copy[key] =
-                this.safeObjectVisit(value, obj => this.transformNode(obj, nodeCallBacks));
-        }
-        if (transformation) {
-            return transformation(copy);
-        }
-        return copy;
+        };
+        const preTransformWrapper = (curObject) => {
+            const casted = curObject;
+            if (casted.type) {
+                const ogFunc = nodeCallBacks[casted.type]?.preVisitor;
+                if (ogFunc) {
+                    return ogFunc(casted);
+                }
+            }
+            return {};
+        };
+        return this.transformObject(startObject, transformWrapper, preTransformWrapper);
     }
-    visitNode(curObject, nodeCallBacks) {
-        let callback;
-        const casted = curObject;
-        if (casted.type) {
-            callback = nodeCallBacks[casted.type];
-        }
-        let shouldIterate = true;
-        if (callback) {
-            shouldIterate = callback(curObject);
-        }
-        if (shouldIterate) {
-            for (const value of Object.values(curObject)) {
-                this.safeObjectVisit(value, obj => this.visitNode(obj, nodeCallBacks));
+    visitNode(startObject, nodeCallBacks) {
+        const visitWrapper = (curObject) => {
+            const casted = curObject;
+            if (casted.type) {
+                const ogFunc = nodeCallBacks[casted.type]?.visitor;
+                if (ogFunc) {
+                    ogFunc(casted);
+                }
             }
-        }
+        };
+        const preVisitWrapper = (curObject) => {
+            const casted = curObject;
+            if (casted.type) {
+                const ogFunc = nodeCallBacks[casted.type]?.preVisitor;
+                if (ogFunc) {
+                    return ogFunc(casted);
+                }
+            }
+            return {};
+        };
+        this.visitObject(startObject, visitWrapper, preVisitWrapper);
+    }
+    traverseNodes(currentNode, traverse) {
+        let didShortCut = false;
+        const recurse = (curNode) => {
+            const traverser = traverse[curNode.type];
+            if (traverser) {
+                const { next, shortcut } = traverser(curNode);
+                didShortCut = shortcut ?? false;
+                if (!didShortCut) {
+                    for (const node of next ?? []) {
+                        if (didShortCut) {
+                            return;
+                        }
+                        recurse(node);
+                    }
+                }
+            }
+        };
+        recurse(currentNode);
     }
 }
 export class TransformerSubType extends TransformerType {
-    // Public visitObjects(curObject: object, visitor: (current: object) => void): void {
-    //   for (const value of Object.values(curObject)) {
-    //     this.safeObjectVisit(value, obj => this.visitObjects(obj, visitor));
-    //   }
-    // }
-    transformNodeSpecific(curObject, nodeCallBacks, nodeSpecificCallBacks = {}) {
-        let continueCheck;
-        let transformation;
-        const casted = curObject;
-        if (casted.type && casted.subType) {
-            const specific = nodeSpecificCallBacks[casted.type];
-            if (specific) {
-                continueCheck = specific[casted.subType]?.continue;
-                transformation = specific[casted.subType]?.transform;
+    transformNodeSpecific(startObject, nodeCallBacks, nodeSpecificCallBacks) {
+        const transformWrapper = (curObject) => {
+            let ogTransform;
+            const casted = curObject;
+            if (casted.type && casted.subType) {
+                const specific = nodeSpecificCallBacks[casted.type];
+                if (specific) {
+                    ogTransform = specific[casted.subType]?.transform;
+                }
+                if (!ogTransform) {
+                    ogTransform = nodeCallBacks[casted.type]?.transform;
+                }
             }
-        }
-        let shouldContinue = true;
-        if (continueCheck) {
-            shouldContinue = continueCheck(curObject);
-        }
-        if (!shouldContinue) {
-            return curObject;
-        }
-        const copy = { ...curObject };
-        for (const [key, value] of Object.entries(copy)) {
-            copy[key] =
-                this.safeObjectVisit(value, obj => this.transformNodeSpecific(obj, nodeCallBacks, nodeSpecificCallBacks));
-        }
-        if (transformation) {
-            return transformation(copy);
-        }
-        return copy;
+            return ogTransform ? ogTransform(casted) : curObject;
+        };
+        const preVisitWrapper = (curObject) => {
+            let ogPreVisit;
+            const casted = curObject;
+            if (casted.type && casted.subType) {
+                const specific = nodeSpecificCallBacks[casted.type];
+                if (specific) {
+                    ogPreVisit = specific[casted.subType]?.preVisitor;
+                }
+                if (!ogPreVisit) {
+                    ogPreVisit = nodeCallBacks[casted.type]?.preVisitor;
+                }
+            }
+            return ogPreVisit ? ogPreVisit(casted) : curObject;
+        };
+        return this.transformObject(startObject, transformWrapper, preVisitWrapper);
     }
     /**
      * When both nodeCallBack and NodeSpecific callBack are matched, will only look at nodeSpecifCallback
      */
-    visitNodeSpecific(curObject, nodeCallBacks, nodeSpecificCallBacks = {}) {
-        let callback;
-        const casted = curObject;
-        if (casted.type && casted.subType) {
-            const specific = nodeSpecificCallBacks[casted.type];
-            if (specific) {
-                callback = specific[casted.subType];
+    visitNodeSpecific(startObject, nodeCallBacks, nodeSpecificCallBacks) {
+        const visitWrapper = (curObject) => {
+            let ogTransform;
+            const casted = curObject;
+            if (casted.type && casted.subType) {
+                const specific = nodeSpecificCallBacks[casted.type];
+                if (specific) {
+                    ogTransform = specific[casted.subType]?.visitor;
+                }
+                if (!ogTransform) {
+                    ogTransform = nodeCallBacks[casted.type]?.visitor;
+                }
             }
-        }
-        if (!callback && casted.type) {
-            callback = nodeCallBacks[curObject.type];
-        }
-        let shouldIterate = true;
-        if (callback) {
-            shouldIterate = callback(curObject) ?? true;
-        }
-        if (shouldIterate) {
-            for (const value of Object.values(curObject)) {
-                this.safeObjectVisit(value, obj => this.visitNodeSpecific(obj, nodeCallBacks, nodeSpecificCallBacks));
+            if (ogTransform) {
+                ogTransform(casted);
             }
-        }
+        };
+        const preVisitWrapper = (curObject) => {
+            let ogPreVisit;
+            const casted = curObject;
+            if (casted.type && casted.subType) {
+                const specific = nodeSpecificCallBacks[casted.type];
+                if (specific) {
+                    ogPreVisit = specific[casted.subType]?.preVisitor;
+                }
+                if (!ogPreVisit) {
+                    ogPreVisit = nodeCallBacks[casted.type]?.preVisitor;
+                }
+            }
+            return ogPreVisit ? ogPreVisit(casted) : curObject;
+        };
+        this.visitObject(startObject, visitWrapper, preVisitWrapper);
+    }
+    traverseSubNodes(currentNode, traverseNode, traverseSubNode) {
+        let didShortCut = false;
+        const recurse = (curNode) => {
+            let traverser;
+            const subObj = traverseSubNode[curNode.type];
+            if (subObj) {
+                traverser = subObj[curNode.subType];
+            }
+            if (!traverser) {
+                traverser = traverseNode[curNode.type];
+            }
+            if (traverser) {
+                const { next, shortcut } = traverser(curNode);
+                didShortCut = shortcut ?? false;
+                if (!didShortCut) {
+                    for (const node of next ?? []) {
+                        if (didShortCut) {
+                            return;
+                        }
+                        recurse(node);
+                    }
+                }
+            }
+        };
+        recurse(currentNode);
     }
 }
 //# sourceMappingURL=Transformers.js.map

package/lib/Transformers.js.map

@@ -1 +1 @@
-{"version":3,"file":"Transformers.js","sourceRoot":"","sources":["Transformers.ts"],"names":[],"mappings":"AAKA,MAAM,OAAO,eAAe;IAChB,eAAe,CAAC,KAAc,EAAE,MAA6B;QACrE,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvC,6GAA6G;YAC7G,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,aAAa,CAClB,SAAiB,EACjB,aAGE;QAEF,IAAI,aAAmD,CAAC;QACxD,IAAI,cAAoD,CAAC;QACzD,MAAM,MAAM,GAA6B,SAAS,CAAC;QACnD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;YACrD,cAAc,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;QACzD,CAAC;QACD,IAAI,cAAc,GAAG,IAAI,CAAC;QAC1B,IAAI,aAAa,EAAE,CAAC;YAClB,cAAc,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,IAAI,GAAuB,EAAE,GAAG,SAAS,EAAE,CAAC;QAClD,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,IAAK,CAAC,GAAG,CAAC;gBACnC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC;QAC/E,CAAC;QACD,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,SAAS,CACd,SAAiB,EACjB,aAAqF;QAErF,IAAI,QAA8C,CAAC;QACnD,MAAM,MAAM,GAA6B,SAAS,CAAC;QACnD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,aAAa,GAAG,IAAI,CAAC;QACzB,IAAI,QAAQ,EAAE,CAAC;YACb,aAAa,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,kBAAiE,SAAQ,eAAsB;IAC1G,qFAAqF;IACrF,oDAAoD;IACpD,2EAA2E;IAC3E,MAAM;IACN,IAAI;IAEG,qBAAqB,CAC1B,SAAiB,EACjB,aAGE,EACF,wBAIQ,EAAE;QAEV,IAAI,aAAmD,CAAC;QACxD,IAAI,cAAoD,CAAC;QACzD,MAAM,MAAM,GAA+C,SAAS,CAAC;QACrE,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACpD,IAAI,QAAQ,EAAE,CAAC;gBACb,aAAa,GAAG,QAAQ,CAAyB,MAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;gBAC3E,cAAc,GAAG,QAAQ,CAAyB,MAAM,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;YAC/E,CAAC;QACH,CAAC;QACD,IAAI,cAAc,GAAG,IAAI,CAAC;QAC1B,IAAI,aAAa,EAAE,CAAC;YAClB,cAAc,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,IAAI,GAAuB,EAAE,GAAG,SAAS,EAAE,CAAC;QAClD,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,IAAK,CAAC,GAAG,CAAC;gBACnC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,aAAa,EAAE,qBAAqB,CAAC,CAAC,CAAC;QAC9G,CAAC;QACD,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,iBAAiB,CACtB,SAAiB,EACjB,aAA4F,EAC5F,wBAEkF,EAAE;QAEpF,IAAI,QAAqD,CAAC;QAC1D,MAAM,MAAM,GAAgD,SAAS,CAAC;QACtE,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACpD,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,GAAG,QAAQ,CAAwB,MAAM,CAAC,OAAO,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QACD,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAC7B,QAAQ,GAAG,aAAa,CAA4B,SAAU,CAAC,IAAI,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,aAAa,GAAG,IAAI,CAAC;QACzB,IAAI,QAAQ,EAAE,CAAC;YACb,aAAa,GAAG,QAAQ,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;QAC9C,CAAC;QACD,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,aAAa,EAAE,qBAAqB,CAAC,CAAC,CAAC;YACxG,CAAC;QACH,CAAC;IACH,CAAC;CACF","sourcesContent":["import type { Node } from './nodeTypings.js';\n\ntype Safeness = 'safe' | 'unsafe';\ntype SafeWrap<Safe extends Safeness, obj extends object> = Safe extends 'safe' ? {[key in keyof obj]: unknown } : obj;\n\nexport class TransformerType<Nodes extends Pick<Node, 'type'>> {\n  protected safeObjectVisit(value: unknown, mapper: (some: object) => any): unknown {\n    if (value && typeof value === 'object') {\n      // If you wonder why this is all so hard, this is the reason. We cannot lose the methods of our Array objects\n      if (Array.isArray(value)) {\n        return value.map(x => this.safeObjectVisit(x, mapper));\n      }\n      return mapper(value);\n    }\n    return value;\n  }\n\n  public transformNode<Safe extends 'safe' | 'unsafe' = 'safe'>(\n    curObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      transform?: (op: SafeWrap<Safe, Extract<Nodes, { type: T }>>) => any;\n      continue?: (op: Extract<Nodes, { type: T }>) => boolean;\n    }},\n  ): any {\n    let continueCheck: ((node: any) => boolean) | undefined;\n    let transformation: ((node: any) => unknown) | undefined;\n    const casted = <{ type?: Nodes['type'] }>curObject;\n    if (casted.type) {\n      continueCheck = nodeCallBacks[casted.type]?.continue;\n      transformation = nodeCallBacks[casted.type]?.transform;\n    }\n    let shouldContinue = true;\n    if (continueCheck) {\n      shouldContinue = continueCheck(curObject);\n    }\n    if (!shouldContinue) {\n      return curObject;\n    }\n    const copy: { type?: unknown } = { ...curObject };\n    for (const [ key, value ] of Object.entries(copy)) {\n      (<Record<string, unknown>> copy)[key] =\n        this.safeObjectVisit(value, obj => this.transformNode(obj, nodeCallBacks));\n    }\n    if (transformation) {\n      return transformation(copy);\n    }\n    return copy;\n  }\n\n  public visitNode(\n    curObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: (op: Extract<Nodes, { type: T }>) => boolean },\n  ): void {\n    let callback: ((node: any) => boolean) | undefined;\n    const casted = <{ type?: Nodes['type'] }>curObject;\n    if (casted.type) {\n      callback = nodeCallBacks[casted.type];\n    }\n    let shouldIterate = true;\n    if (callback) {\n      shouldIterate = callback(curObject);\n    }\n    if (shouldIterate) {\n      for (const value of Object.values(curObject)) {\n        this.safeObjectVisit(value, obj => this.visitNode(obj, nodeCallBacks));\n      }\n    }\n  }\n}\n\nexport class TransformerSubType<Nodes extends Pick<Node, 'type' | 'subType'>> extends TransformerType<Nodes> {\n  // Public visitObjects(curObject: object, visitor: (current: object) => void): void {\n  //   for (const value of Object.values(curObject)) {\n  //     this.safeObjectVisit(value, obj => this.visitObjects(obj, visitor));\n  //   }\n  // }\n\n  public transformNodeSpecific<Safe extends 'safe' | 'unsafe' = 'safe'>(\n    curObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      transform?: (op: SafeWrap<Safe, Extract<Nodes, { type: T }>>) => any;\n      continue?: (op: Extract<Nodes, { type: T }>) => boolean;\n    }},\n    nodeSpecificCallBacks: {[Type in Nodes['type']]?: {\n      [SubType in Extract<Nodes, { type: Type; subType: string }>['subType']]?: {\n        transform?: (op: SafeWrap<Safe, Extract<Nodes, { type: Type; subType: SubType }>>) => any;\n        continue?: (op: Extract<Nodes, { type: Type; subType: SubType }>) => boolean;\n      }}} = {},\n  ): any {\n    let continueCheck: ((node: any) => boolean) | undefined;\n    let transformation: ((node: any) => unknown) | undefined;\n    const casted = <{ type?: Nodes['type']; subType?: string }>curObject;\n    if (casted.type && casted.subType) {\n      const specific = nodeSpecificCallBacks[casted.type];\n      if (specific) {\n        continueCheck = specific[<keyof typeof specific> casted.subType]?.continue;\n        transformation = specific[<keyof typeof specific> casted.subType]?.transform;\n      }\n    }\n    let shouldContinue = true;\n    if (continueCheck) {\n      shouldContinue = continueCheck(curObject);\n    }\n    if (!shouldContinue) {\n      return curObject;\n    }\n    const copy: { type?: unknown } = { ...curObject };\n    for (const [ key, value ] of Object.entries(copy)) {\n      (<Record<string, unknown>> copy)[key] =\n        this.safeObjectVisit(value, obj => this.transformNodeSpecific(obj, nodeCallBacks, nodeSpecificCallBacks));\n    }\n    if (transformation) {\n      return transformation(copy);\n    }\n    return copy;\n  }\n\n  /**\n   * When both nodeCallBack and NodeSpecific callBack are matched, will only look at nodeSpecifCallback\n   */\n  public visitNodeSpecific(\n    curObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: (op: Extract<Nodes, { type: T }>) => boolean | void },\n    nodeSpecificCallBacks: {[Type in Nodes['type']]?:\n      {[Subtype in Extract<Nodes, { type: Type; subType: string }>['subType']]?:\n        (op: Extract<Nodes, { type: Type; subType: Subtype }>) => boolean | void }} = {},\n  ): void {\n    let callback: ((node: any) => boolean | void) | undefined;\n    const casted = <{ type?: Nodes['type']; subType?: string }> curObject;\n    if (casted.type && casted.subType) {\n      const specific = nodeSpecificCallBacks[casted.type];\n      if (specific) {\n        callback = specific[<keyof typeof specific>casted.subType];\n      }\n    }\n    if (!callback && casted.type) {\n      callback = nodeCallBacks[(<{ type: Nodes['type'] }> curObject).type];\n    }\n    let shouldIterate = true;\n    if (callback) {\n      shouldIterate = callback(curObject) ?? true;\n    }\n    if (shouldIterate) {\n      for (const value of Object.values(curObject)) {\n        this.safeObjectVisit(value, obj => this.visitNodeSpecific(obj, nodeCallBacks, nodeSpecificCallBacks));\n      }\n    }\n  }\n}\n"]}
+{"version":3,"file":"Transformers.js","sourceRoot":"","sources":["Transformers.ts"],"names":[],"mappings":"AAeA,MAAM,OAAO,eAAe;IAChB,KAAK,CAAI,GAAM;QACvB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;QACzD,MAAM,CAAC,gBAAgB,CACrB,MAAM,EACN,MAAM,CAAC,yBAAyB,CAAC,GAAG,CAAC,CACtC,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,eAAe,CAAC,KAAc,EAAE,MAA6B;QACrE,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CACpB,WAAmB,EACnB,MAA6B,EAC7B,aAA6C,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAEvD,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,MAAM,OAAO,GAAG,CAAC,SAAiB,EAAW,EAAE;YAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACnC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YACjC,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC;YACxC,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;YAC3C,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC9B,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAClD,IAAI,WAAW,EAAE,CAAC;wBAChB,OAAO,IAAI,CAAC;oBACd,CAAC;oBAC0B,IAAK,CAAC,GAAG,CAAC;wBACnC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;gBACrD,CAAC;YACH,CAAC;YACD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC;QAEF,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,WAAW,CAChB,WAAmB,EACnB,OAA+B,EAC/B,aAA6C,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAEvD,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,MAAM,OAAO,GAAG,CAAC,SAAiB,EAAQ,EAAE;YAC1C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;YACtC,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC;YACxC,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;YAC3C,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC9B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7C,IAAI,WAAW,EAAE,CAAC;wBAChB,OAAO;oBACT,CAAC;oBACD,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;YACD,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC,CAAC;QACF,OAAO,CAAC,WAAW,CAAC,CAAC;IACvB,CAAC;IAEM,aAAa,CAClB,WAAmB,EACnB,aAGE;QAEF,MAAM,gBAAgB,GAAG,CAAC,SAAiB,EAAW,EAAE;YACtD,MAAM,MAAM,GAA6B,SAAS,CAAC;YACnD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,MAAM,MAAM,GAAyC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;gBAC3F,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QACF,MAAM,mBAAmB,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC9D,MAAM,MAAM,GAA6B,SAAS,CAAC;YACnD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,MAAM,MAAM,GAA8C,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;gBACjG,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;IAClF,CAAC;IAEM,SAAS,CACd,WAAmB,EACnB,aAGE;QAEF,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAQ,EAAE;YAC/C,MAAM,MAAM,GAA6B,SAAS,CAAC;YACnD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,MAAM,MAAM,GAAyC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;gBACzF,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,CAAC,MAAM,CAAC,CAAC;gBACjB,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QACF,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC1D,MAAM,MAAM,GAA6B,SAAS,CAAC;YACnD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,MAAM,MAAM,GAA8C,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;gBACjG,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;IAC/D,CAAC;IAEM,aAAa,CAClB,WAAkB,EAClB,QAAyG;QAEzG,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,MAAM,OAAO,GAAG,CAAC,OAAc,EAAQ,EAAE;YACvC,MAAM,SAAS,GAAG,QAAQ,CAAgB,OAAO,CAAC,IAAI,CAAC,CAAC;YACxD,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAM,OAAO,CAAC,CAAC;gBACnD,WAAW,GAAG,QAAQ,IAAI,KAAK,CAAC;gBAChC,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,KAAK,MAAM,IAAI,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;wBAC9B,IAAI,WAAW,EAAE,CAAC;4BAChB,OAAO;wBACT,CAAC;wBACD,OAAO,CAAC,IAAI,CAAC,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF,OAAO,CAAC,WAAW,CAAC,CAAC;IACvB,CAAC;CACF;AAED,MAAM,OAAO,kBAAiE,SAAQ,eAAsB;IACnG,qBAAqB,CAC1B,WAAmB,EACnB,aAGE,EACF,qBAIK;QAEL,MAAM,gBAAgB,GAAG,CAAC,SAAiB,EAAW,EAAE;YACtD,IAAI,WAAiD,CAAC;YACtD,MAAM,MAAM,GAA+C,SAAS,CAAC;YACrE,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBAClC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACpD,IAAI,QAAQ,EAAE,CAAC;oBACb,WAAW,GAAG,QAAQ,CAAyB,MAAM,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;gBAC5E,CAAC;gBACD,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;gBACtD,CAAC;YACH,CAAC;YACD,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACvD,CAAC,CAAC;QACF,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC1D,IAAI,UAAqD,CAAC;YAC1D,MAAM,MAAM,GAA+C,SAAS,CAAC;YACrE,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBAClC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACpD,IAAI,QAAQ,EAAE,CAAC;oBACb,UAAU,GAAG,QAAQ,CAAyB,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;gBAC5E,CAAC;gBACD,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;gBACtD,CAAC;YACH,CAAC;YACD,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrD,CAAC,CAAC;QACF,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACI,iBAAiB,CACtB,WAAmB,EACnB,aAGE,EACF,qBAIK;QAEL,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAQ,EAAE;YAC/C,IAAI,WAA8C,CAAC;YACnD,MAAM,MAAM,GAA+C,SAAS,CAAC;YACrE,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBAClC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACpD,IAAI,QAAQ,EAAE,CAAC;oBACb,WAAW,GAAG,QAAQ,CAAyB,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;gBAC1E,CAAC;gBACD,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;gBACpD,CAAC;YACH,CAAC;YACD,IAAI,WAAW,EAAE,CAAC;gBAChB,WAAW,CAAC,MAAM,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,CAAC;QACF,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC1D,IAAI,UAAqD,CAAC;YAC1D,MAAM,MAAM,GAA+C,SAAS,CAAC;YACrE,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBAClC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACpD,IAAI,QAAQ,EAAE,CAAC;oBACb,UAAU,GAAG,QAAQ,CAAyB,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;gBAC5E,CAAC;gBACD,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;gBACtD,CAAC;YACH,CAAC;YACD,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrD,CAAC,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;IAC/D,CAAC;IAEM,gBAAgB,CACrB,WAAkB,EAClB,YAC4E,EAC5E,eAEiG;QAEjG,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,MAAM,OAAO,GAAG,CAAC,OAAc,EAAQ,EAAE;YACvC,IAAI,SAAwE,CAAC;YAC7E,MAAM,MAAM,GAAG,eAAe,CAAgB,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5D,IAAI,MAAM,EAAE,CAAC;gBACX,SAAS,GAAG,MAAM,CAAsB,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3D,CAAC;YACD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,SAAS,GAAG,YAAY,CAAgB,OAAO,CAAC,IAAI,CAAC,CAAC;YACxD,CAAC;YACD,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAM,OAAO,CAAC,CAAC;gBACnD,WAAW,GAAG,QAAQ,IAAI,KAAK,CAAC;gBAChC,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,KAAK,MAAM,IAAI,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;wBAC9B,IAAI,WAAW,EAAE,CAAC;4BAChB,OAAO;wBACT,CAAC;wBACD,OAAO,CAAC,IAAI,CAAC,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF,OAAO,CAAC,WAAW,CAAC,CAAC;IACvB,CAAC;CACF","sourcesContent":["import type { Node } from './nodeTypings.js';\n\ntype Safeness = 'safe' | 'unsafe';\ntype SafeWrap<Safe extends Safeness, obj extends object> = Safe extends 'safe' ? {[key in keyof obj]: unknown } : obj;\n\nexport interface VisitContext {\n  shortcut?: boolean;\n  continue?: boolean;\n}\n\nexport interface SelectiveTraversalContext<Nodes> {\n  next?: Nodes[];\n  shortcut?: boolean;\n}\n\nexport class TransformerType<Nodes extends Pick<Node, 'type'>> {\n  protected clone<T>(obj: T): T {\n    const newObj = Object.create(Object.getPrototypeOf(obj));\n    Object.defineProperties(\n      newObj,\n      Object.getOwnPropertyDescriptors(obj),\n    );\n    return newObj;\n  }\n\n  protected safeObjectVisit(value: unknown, mapper: (some: object) => any): unknown {\n    if (value && typeof value === 'object') {\n      if (Array.isArray(value)) {\n        return value.map(x => this.safeObjectVisit(x, mapper));\n      }\n      return mapper(value);\n    }\n    return value;\n  }\n\n  /**\n   * Recursively transforms all objects that are not arrays. Mapper is called on deeper objects first.\n   * @param startObject object to start iterating from\n   * @param mapper mapper to transform the various objects - argument is a copy of the original\n   * @param preVisitor callback that is evaluated before iterating deeper.\n   *   If continues is false, we do not iterate deeper, current object is still mapped. - default: true\n   *   If shortcut is true, we do not iterate deeper, nor do we branch out, this mapper will be the last one called.\n   *    - Default false\n   */\n  public transformObject(\n    startObject: object,\n    mapper: (some: object) => any,\n    preVisitor: (some: object) => VisitContext = () => ({}),\n  ): unknown {\n    let didShortCut = false;\n    const recurse = (curObject: object): unknown => {\n      const copy = this.clone(curObject);\n      const context = preVisitor(copy);\n      didShortCut = context.shortcut ?? false;\n      const continues = context.continue ?? true;\n      if (continues && !didShortCut) {\n        for (const [ key, value ] of Object.entries(copy)) {\n          if (didShortCut) {\n            return copy;\n          }\n          (<Record<string, unknown>> copy)[key] =\n            this.safeObjectVisit(value, obj => recurse(obj));\n        }\n      }\n      return mapper(copy);\n    };\n\n    return recurse(startObject);\n  }\n\n  /**\n   * Visitor that visits all objects. Visits deeper objects first.\n   */\n  public visitObject(\n    startObject: object,\n    visitor: (some: object) => void,\n    preVisitor: (some: object) => VisitContext = () => ({}),\n  ): void {\n    let didShortCut = false;\n\n    const recurse = (curObject: object): void => {\n      const context = preVisitor(curObject);\n      didShortCut = context.shortcut ?? false;\n      const continues = context.continue ?? true;\n      if (continues && !didShortCut) {\n        for (const value of Object.values(curObject)) {\n          if (didShortCut) {\n            return;\n          }\n          this.safeObjectVisit(value, obj => recurse(obj));\n        }\n      }\n      visitor(curObject);\n    };\n    recurse(startObject);\n  }\n\n  public transformNode<Safe extends 'safe' | 'unsafe' = 'safe'>(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      transform?: (op: SafeWrap<Safe, Extract<Nodes, { type: T }>>) => any;\n      preVisitor?: (op: Extract<Nodes, { type: T }>) => VisitContext;\n    }},\n  ): any {\n    const transformWrapper = (curObject: object): unknown => {\n      const casted = <{ type?: Nodes['type'] }>curObject;\n      if (casted.type) {\n        const ogFunc: ((node: any) => unknown) | undefined = nodeCallBacks[casted.type]?.transform;\n        if (ogFunc) {\n          return ogFunc(casted);\n        }\n      }\n      return curObject;\n    };\n    const preTransformWrapper = (curObject: object): VisitContext => {\n      const casted = <{ type?: Nodes['type'] }>curObject;\n      if (casted.type) {\n        const ogFunc: ((node: any) => VisitContext) | undefined = nodeCallBacks[casted.type]?.preVisitor;\n        if (ogFunc) {\n          return ogFunc(casted);\n        }\n      }\n      return {};\n    };\n    return this.transformObject(startObject, transformWrapper, preTransformWrapper);\n  }\n\n  public visitNode(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      visitor?: (op: Extract<Nodes, { type: T }>) => void;\n      preVisitor?: (op: Extract<Nodes, { type: T }>) => VisitContext;\n    }},\n  ): void {\n    const visitWrapper = (curObject: object): void => {\n      const casted = <{ type?: Nodes['type'] }>curObject;\n      if (casted.type) {\n        const ogFunc: ((node: any) => unknown) | undefined = nodeCallBacks[casted.type]?.visitor;\n        if (ogFunc) {\n          ogFunc(casted);\n        }\n      }\n    };\n    const preVisitWrapper = (curObject: object): VisitContext => {\n      const casted = <{ type?: Nodes['type'] }>curObject;\n      if (casted.type) {\n        const ogFunc: ((node: any) => VisitContext) | undefined = nodeCallBacks[casted.type]?.preVisitor;\n        if (ogFunc) {\n          return ogFunc(casted);\n        }\n      }\n      return {};\n    };\n    this.visitObject(startObject, visitWrapper, preVisitWrapper);\n  }\n\n  public traverseNodes(\n    currentNode: Nodes,\n    traverse: {[T in Nodes['type']]?: (op: Extract<Nodes, { type: T }>) => SelectiveTraversalContext<Nodes> },\n  ): void {\n    let didShortCut = false;\n\n    const recurse = (curNode: Nodes): void => {\n      const traverser = traverse[<Nodes['type']>curNode.type];\n      if (traverser) {\n        const { next, shortcut } = traverser(<any>curNode);\n        didShortCut = shortcut ?? false;\n        if (!didShortCut) {\n          for (const node of next ?? []) {\n            if (didShortCut) {\n              return;\n            }\n            recurse(node);\n          }\n        }\n      }\n    };\n\n    recurse(currentNode);\n  }\n}\n\nexport class TransformerSubType<Nodes extends Pick<Node, 'type' | 'subType'>> extends TransformerType<Nodes> {\n  public transformNodeSpecific<Safe extends 'safe' | 'unsafe' = 'safe'>(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      transform?: (op: SafeWrap<Safe, Extract<Nodes, { type: T }>>) => any;\n      preVisitor?: (op: Extract<Nodes, { type: T }>) => VisitContext;\n    }},\n    nodeSpecificCallBacks: {[Type in Nodes['type']]?: {\n      [SubType in Extract<Nodes, { type: Type; subType: string }>['subType']]?: {\n        transform?: (op: SafeWrap<Safe, Extract<Nodes, { type: Type; subType: SubType }>>) => any;\n        preVisitor?: (op: Extract<Nodes, { type: Type; subType: SubType }>) => VisitContext;\n      }}},\n  ): any {\n    const transformWrapper = (curObject: object): unknown => {\n      let ogTransform: ((node: any) => unknown) | undefined;\n      const casted = <{ type?: Nodes['type']; subType?: string }>curObject;\n      if (casted.type && casted.subType) {\n        const specific = nodeSpecificCallBacks[casted.type];\n        if (specific) {\n          ogTransform = specific[<keyof typeof specific> casted.subType]?.transform;\n        }\n        if (!ogTransform) {\n          ogTransform = nodeCallBacks[casted.type]?.transform;\n        }\n      }\n      return ogTransform ? ogTransform(casted) : curObject;\n    };\n    const preVisitWrapper = (curObject: object): VisitContext => {\n      let ogPreVisit: ((node: any) => VisitContext) | undefined;\n      const casted = <{ type?: Nodes['type']; subType?: string }>curObject;\n      if (casted.type && casted.subType) {\n        const specific = nodeSpecificCallBacks[casted.type];\n        if (specific) {\n          ogPreVisit = specific[<keyof typeof specific> casted.subType]?.preVisitor;\n        }\n        if (!ogPreVisit) {\n          ogPreVisit = nodeCallBacks[casted.type]?.preVisitor;\n        }\n      }\n      return ogPreVisit ? ogPreVisit(casted) : curObject;\n    };\n    return this.transformObject(startObject, transformWrapper, preVisitWrapper);\n  }\n\n  /**\n   * When both nodeCallBack and NodeSpecific callBack are matched, will only look at nodeSpecifCallback\n   */\n  public visitNodeSpecific(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      visitor?: (op: Extract<Nodes, { type: T }>) => void;\n      preVisitor?: (op: Extract<Nodes, { type: T }>) => VisitContext;\n    }},\n    nodeSpecificCallBacks: {[Type in Nodes['type']]?:\n      {[Subtype in Extract<Nodes, { type: Type; subType: string }>['subType']]?: {\n        visitor?: (op: Extract<Nodes, { type: Type; subType: Subtype }>) => void;\n        preVisitor?: (op: Extract<Nodes, { type: Type; subType: Subtype }>) => VisitContext;\n      }}},\n  ): void {\n    const visitWrapper = (curObject: object): void => {\n      let ogTransform: ((node: any) => void) | undefined;\n      const casted = <{ type?: Nodes['type']; subType?: string }>curObject;\n      if (casted.type && casted.subType) {\n        const specific = nodeSpecificCallBacks[casted.type];\n        if (specific) {\n          ogTransform = specific[<keyof typeof specific> casted.subType]?.visitor;\n        }\n        if (!ogTransform) {\n          ogTransform = nodeCallBacks[casted.type]?.visitor;\n        }\n      }\n      if (ogTransform) {\n        ogTransform(casted);\n      }\n    };\n    const preVisitWrapper = (curObject: object): VisitContext => {\n      let ogPreVisit: ((node: any) => VisitContext) | undefined;\n      const casted = <{ type?: Nodes['type']; subType?: string }>curObject;\n      if (casted.type && casted.subType) {\n        const specific = nodeSpecificCallBacks[casted.type];\n        if (specific) {\n          ogPreVisit = specific[<keyof typeof specific> casted.subType]?.preVisitor;\n        }\n        if (!ogPreVisit) {\n          ogPreVisit = nodeCallBacks[casted.type]?.preVisitor;\n        }\n      }\n      return ogPreVisit ? ogPreVisit(casted) : curObject;\n    };\n    this.visitObject(startObject, visitWrapper, preVisitWrapper);\n  }\n\n  public traverseSubNodes(\n    currentNode: Nodes,\n    traverseNode: {[Type in Nodes['type']]?:\n      (op: Extract<Nodes, { type: Type }>) => SelectiveTraversalContext<Nodes> },\n    traverseSubNode: {[Type in Nodes['type']]?:\n      {[Subtype in Extract<Nodes, { type: Type; subType: string }>['subType']]?:\n        (op: Extract<Nodes, { type: Type; subType: Subtype }>) => SelectiveTraversalContext<Nodes> }},\n  ): void {\n    let didShortCut = false;\n\n    const recurse = (curNode: Nodes): void => {\n      let traverser: ((call: any) => SelectiveTraversalContext<Nodes>) | undefined;\n      const subObj = traverseSubNode[<Nodes['type']>curNode.type];\n      if (subObj) {\n        traverser = subObj[<keyof typeof subObj>curNode.subType];\n      }\n      if (!traverser) {\n        traverser = traverseNode[<Nodes['type']>curNode.type];\n      }\n      if (traverser) {\n        const { next, shortcut } = traverser(<any>curNode);\n        didShortCut = shortcut ?? false;\n        if (!didShortCut) {\n          for (const node of next ?? []) {\n            if (didShortCut) {\n              return;\n            }\n            recurse(node);\n          }\n        }\n      }\n    };\n\n    recurse(currentNode);\n  }\n}\n"]}

package/lib/generator-builder/generatorTypes.d.ts

@@ -26,12 +26,58 @@ ParamType extends any[] = any[]> = {
     gImpl: (def: RuleDefArg) => (ast: AstType, context: Context, ...params: ParamType) => void;
 };
 export interface RuleDefArg {
-    SUBRULE: <T, U extends any[]>(cstDef: GeneratorRule<any, any, T, U>, input: T, ...arg: U) => void;
+    /**
+     * Call another generator rule so it can generate its string representation.
+     * @param rule the rule to be called
+     * @param input the ast input to work on
+     * @param arg the remaining parameters required by this rule.
+     * @constructor
+     */
+    SUBRULE: <T, U extends any[]>(rule: GeneratorRule<any, any, T, U>, input: T, ...arg: U) => void;
+    /**
+     * Print the characters to the output string
+     * @param args arguments to be printed
+     * @constructor
+     */
     PRINT: (...args: string[]) => void;
+    /**
+     * Print the character  to the output stream ensuring there is a space to the left oif what you print.
+     * If a space was printed right before this, it will not print a space.
+     * @param args
+     * @constructor
+     */
     PRINT_SPACE_LEFT: (...args: string[]) => void;
+    /**
+     * Prints all arguments as one word, ensuring it has a space before and behind each word
+     * @param args
+     * @constructor
+     */
     PRINT_WORD: (...args: string[]) => void;
+    /**
+     * Prints all arguments as words, ensuring they all have a space before and behind them.
+     * @param args
+     * @constructor
+     */
     PRINT_WORDS: (...args: string[]) => void;
+    /**
+     * Ensures that what you print is on a newline with the indentation equal to the indentation currently setup.
+     * @param args
+     * @constructor
+     */
     PRINT_ON_EMPTY: (...args: string[]) => void;
+    /**
+     * Handles the location of a node as if it was generated using a SUBRULE.
+     * Can be used to generate many nodes within a single subrule call while still having correct localization handling.
+     * @param loc
+     * @param nodeHandle
+     * @constructor
+     */
     HANDLE_LOC: <T>(loc: Localized, nodeHandle: () => T) => T | undefined;
+    /**
+     * Catchup the string until a given length,
+     * printing everything from the current catchup location until the index you provide.
+     * @param until
+     * @constructor
+     */
     CATCHUP: (until: number) => void;
 }