@traqula/core 0.0.24 → 0.0.25

package/dist/cjs/lib/transformers/TransformerSubTyped.js

@@ -11,12 +11,20 @@ class TransformerSubTyped extends TransformerTyped_js_1.TransformerTyped {
         return new TransformerSubTyped({ ...this.defaultContext, ...newDefaultContext }, { ...this.defaultNodePreVisitor, ...newDefaultNodePreVisitor });
     }
     /**
-     * Shares the functionality and first two arguments with {@link this.transformNode}.
-     * The third argument allows you to also transform based on the subType of objects.
-     * Note that when a callback for the subtype is provided, the callback for the general type is **NOT** executed.
-     * @param startObject
-     * @param nodeCallBacks
-     * @param nodeSpecificCallBacks
+     * Transform a single node ({@link Typed}).
+     * Similar to {@link this.transformNode} but also allowing you to target the subTypes.
+     * @param startObject the object from which we will start the transformation,
+     *   potentially visiting and transforming its descendants along the way.
+     * @param nodeCallBacks a dictionary mapping the various operation types to objects optionally
+     *    containing preVisitor and transformer.
+     *    The preVisitor allows you to provide {@link TransformContext} for the current object,
+     *    altering how it will be transformed.
+     *    The transformer allows you to manipulate the copy of the current object,
+     *    and expects you to return the value that should take the current objects place.
+     * @param nodeSpecificCallBacks Same as nodeCallBacks but using an additional level of indirection to
+     *     indicate the subType.
+     * @return the result of transforming the requested descendant operations (based on the preVisitor)
+     * using a transformer that works its way back up from the descendant to the startObject.
      */
     transformNodeSpecific(startObject, nodeCallBacks, nodeSpecificCallBacks) {
         const transformWrapper = (copy, orig) => {
@@ -50,8 +58,22 @@ class TransformerSubTyped extends TransformerTyped_js_1.TransformerTyped {
         return this.transformObject(startObject, transformWrapper, preVisitWrapper);
     }
     /**
-     * Similar to {@link this.visitNode} but also allows you to match based on the subtype of objects.
-     * When both nodeCallBack and NodeSpecific callBack are matched, will only visit nodeSpecifCallback
+     * Visit a selected subTree given a startObject, steering the visits based on {@link Typed} nodes.
+     * Similar to {@link this.visitNode}, but also allowing you to target subTypes.
+     * Will call the preVisitor on the outer distinct, then the visitor of the special distinct,
+     * followed by the visiting the outer distinct, printing '231'.
+     * The pre-visitor visits starting from the root, going deeper, while the actual visitor goes in reverse.
+     * @param startObject the object from which we will start visiting,
+     *   potentially visiting its descendants along the way.
+     * @param nodeCallBacks a dictionary mapping the various operation types to objects optionally
+     *    containing preVisitor and visitor.
+     *    The preVisitor allows you to provide {@link VisitContext} for the current object,
+     *    altering how it will be visited.
+     *    The visitor allows you to visit the object from deepest to the outermost object.
+     *    This is useful if you for example want to manipulate the objects you visit during your visits,
+     *    similar to {@link mapOperation}.
+     * @param nodeSpecificCallBacks Same as nodeCallBacks but using an additional level of indirection to
+     *     indicate the subType.
      */
     visitNodeSpecific(startObject, nodeCallBacks, nodeSpecificCallBacks) {
         const visitWrapper = (curObject) => {
@@ -86,38 +108,6 @@ class TransformerSubTyped extends TransformerTyped_js_1.TransformerTyped {
         };
         this.visitObject(startObject, visitWrapper, preVisitWrapper);
     }
-    /**
-     * Similar to {@link this.traverseNodes} but also allows you to match based on the subtype of objects.
-     * @param currentNode
-     * @param traverseNode
-     * @param traverseSubNode
-     */
-    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);
-    }
 }
 exports.TransformerSubTyped = TransformerSubTyped;
 //# sourceMappingURL=TransformerSubTyped.js.map

package/dist/cjs/lib/transformers/TransformerSubTyped.js.map

@@ -1 +1 @@
-{"version":3,"file":"TransformerSubTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerSubTyped.ts"],"names":[],"mappings":";;;AAOA,+DAAyD;AAEzD,MAAa,mBAAyC,SAAQ,sCAAuB;IACnF,YACE,iBAAmC,EAAE,EACrC,wBAAsD,EAAE;QAExD,KAAK,CAAC,cAAc,EAAE,qBAAqB,CAAC,CAAC;IAC/C,CAAC;IAAA,CAAC;IAEc,KAAK,CACnB,oBAAsC,EAAE,EACxC,2BAAyD,EAAE;QAE3D,OAAO,IAAI,mBAAmB,CAC5B,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,iBAAiB,EAAE,EAChD,EAAE,GAAG,IAAI,CAAC,qBAAqB,EAAE,GAAG,wBAAwB,EAAE,CAC/D,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,qBAAqB,CAC1B,WAAmB,EACnB,aAGE,EACF,qBAIK;QAEL,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAW,EAAE;YAC/D,IAAI,WAA4D,CAAC;YACjE,MAAM,MAAM,GAA4B,IAAI,CAAC;YAC7C,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,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,CAAC,CAAC;QACF,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC1D,IAAI,UAAqD,CAAC;YAC1D,MAAM,MAAM,GAA4B,SAAS,CAAC;YAClD,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,EAAE,CAAC;QAC9C,CAAC,CAAC;QACF,OAAa,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC;IACpF,CAAC;IAED;;;OAGG;IACI,iBAAiB,CACtB,WAAmB,EACnB,aAGE,EACF,qBAIK;QAEL,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAQ,EAAE;YAC/C,IAAI,WAA8C,CAAC;YACnD,MAAM,MAAM,GAA4B,SAAS,CAAC;YAClD,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,GAA4B,SAAS,CAAC;YAClD,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,EAAE,CAAC;QAC9C,CAAC,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CACrB,WAAkB,EAClB,YACyE,EACzE,eAEwF;QAExF,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;AA/JD,kDA+JC","sourcesContent":["import type { SubTyped, Typed } from '../types.js';\nimport type {\n  SelectiveTraversalContext,\n  TransformContext,\n  VisitContext,\n} from './TransformerObject.js';\nimport type { DefaultNodePreVisitor, Safeness, SafeWrap } from './TransformerTyped.js';\nimport { TransformerTyped } from './TransformerTyped.js';\n\nexport class TransformerSubTyped<Nodes extends Typed> extends TransformerTyped<Nodes> {\n  public constructor(\n    defaultContext: TransformContext = {},\n    defaultNodePreVisitor: DefaultNodePreVisitor<Nodes> = {},\n  ) {\n    super(defaultContext, defaultNodePreVisitor);\n  };\n\n  public override clone(\n    newDefaultContext: TransformContext = {},\n    newDefaultNodePreVisitor: DefaultNodePreVisitor<Nodes> = {},\n  ): TransformerSubTyped<Nodes> {\n    return new TransformerSubTyped(\n      { ...this.defaultContext, ...newDefaultContext },\n      { ...this.defaultNodePreVisitor, ...newDefaultNodePreVisitor },\n    );\n  }\n\n  /**\n   * Shares the functionality and first two arguments with {@link this.transformNode}.\n   * The third argument allows you to also transform based on the subType of objects.\n   * Note that when a callback for the subtype is provided, the callback for the general type is **NOT** executed.\n   * @param startObject\n   * @param nodeCallBacks\n   * @param nodeSpecificCallBacks\n   */\n  public transformNodeSpecific<Safe extends Safeness = 'safe', OutType = unknown>(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      transform?: (copy: SafeWrap<Safe, Extract<Nodes, Typed<T>>>, orig: Extract<Nodes, Typed<T>>) => unknown;\n      preVisitor?: (orig: Extract<Nodes, Typed<T>>) => TransformContext;\n    }},\n    nodeSpecificCallBacks: {[Type in Nodes['type']]?: {\n      [SubType in Extract<Nodes, SubTyped<Type>>['subType']]?: {\n        transform?: (op: SafeWrap<Safe, Extract<Nodes, SubTyped<Type, SubType>>>) => unknown;\n        preVisitor?: (op: Extract<Nodes, SubTyped<Type, SubType>>) => TransformContext;\n      }}},\n  ): Safe extends 'unsafe' ? OutType : unknown {\n    const transformWrapper = (copy: object, orig: object): unknown => {\n      let ogTransform: ((copy: any, orig: any) => unknown) | undefined;\n      const casted = <SubTyped<Nodes['type']>>copy;\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, orig) : copy;\n    };\n    const preVisitWrapper = (curObject: object): VisitContext => {\n      let ogPreVisit: ((node: any) => VisitContext) | undefined;\n      const casted = <SubTyped<Nodes['type']>>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) : {};\n    };\n    return <any> this.transformObject(startObject, transformWrapper, preVisitWrapper);\n  }\n\n  /**\n   * Similar to {@link this.visitNode} but also allows you to match based on the subtype of objects.\n   * When both nodeCallBack and NodeSpecific callBack are matched, will only visit nodeSpecifCallback\n   */\n  public visitNodeSpecific(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      visitor?: (op: Extract<Nodes, Typed<T>>) => void;\n      preVisitor?: (op: Extract<Nodes, Typed<T>>) => VisitContext;\n    }},\n    nodeSpecificCallBacks: {[Type in Nodes['type']]?:\n      {[Subtype in Extract<Nodes, SubTyped<Type>>['subType']]?: {\n        visitor?: (op: Extract<Nodes, SubTyped<Type, Subtype>>) => void;\n        preVisitor?: (op: Extract<Nodes, SubTyped<Type, Subtype>>) => VisitContext;\n      }}},\n  ): void {\n    const visitWrapper = (curObject: object): void => {\n      let ogTransform: ((node: any) => void) | undefined;\n      const casted = <SubTyped<Nodes['type']>>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 = <SubTyped<Nodes['type']>>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) : {};\n    };\n    this.visitObject(startObject, visitWrapper, preVisitWrapper);\n  }\n\n  /**\n   * Similar to {@link this.traverseNodes} but also allows you to match based on the subtype of objects.\n   * @param currentNode\n   * @param traverseNode\n   * @param traverseSubNode\n   */\n  public traverseSubNodes(\n    currentNode: Nodes,\n    traverseNode: {[Type in Nodes['type']]?:\n      (op: Extract<Nodes, Typed<Type>>) => SelectiveTraversalContext<Nodes> },\n    traverseSubNode: {[Type in Nodes['type']]?:\n      {[Subtype in Extract<Nodes, SubTyped<Type>>['subType']]?:\n        (op: Extract<Nodes, SubTyped<Type, 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"]}
+{"version":3,"file":"TransformerSubTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerSubTyped.ts"],"names":[],"mappings":";;;AAMA,+DAAyD;AAEzD,MAAa,mBAAyC,SAAQ,sCAAuB;IACnF,YACE,iBAAmC,EAAE,EACrC,wBAAsD,EAAE;QAExD,KAAK,CAAC,cAAc,EAAE,qBAAqB,CAAC,CAAC;IAC/C,CAAC;IAAA,CAAC;IAEc,KAAK,CACnB,oBAAsC,EAAE,EACxC,2BAAyD,EAAE;QAE3D,OAAO,IAAI,mBAAmB,CAC5B,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,iBAAiB,EAAE,EAChD,EAAE,GAAG,IAAI,CAAC,qBAAqB,EAAE,GAAG,wBAAwB,EAAE,CAC/D,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,qBAAqB,CAC1B,WAAmB,EACnB,aAGE,EACF,qBAIK;QAEL,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAW,EAAE;YAC/D,IAAI,WAA4D,CAAC;YACjE,MAAM,MAAM,GAA4B,IAAI,CAAC;YAC7C,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,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,CAAC,CAAC;QACF,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC1D,IAAI,UAAqD,CAAC;YAC1D,MAAM,MAAM,GAA4B,SAAS,CAAC;YAClD,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,EAAE,CAAC;QAC9C,CAAC,CAAC;QACF,OAAa,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,iBAAiB,CACtB,WAAmB,EACnB,aAGE,EACF,qBAIK;QAEL,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAQ,EAAE;YAC/C,IAAI,WAA8C,CAAC;YACnD,MAAM,MAAM,GAA4B,SAAS,CAAC;YAClD,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,GAA4B,SAAS,CAAC;YAClD,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,EAAE,CAAC;QAC9C,CAAC,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;IAC/D,CAAC;CACF;AA3ID,kDA2IC","sourcesContent":["import type { SubTyped, Typed } from '../types.js';\nimport type {\n  TransformContext,\n  VisitContext,\n} from './TransformerObject.js';\nimport type { DefaultNodePreVisitor, Safeness, SafeWrap } from './TransformerTyped.js';\nimport { TransformerTyped } from './TransformerTyped.js';\n\nexport class TransformerSubTyped<Nodes extends Typed> extends TransformerTyped<Nodes> {\n  public constructor(\n    defaultContext: TransformContext = {},\n    defaultNodePreVisitor: DefaultNodePreVisitor<Nodes> = {},\n  ) {\n    super(defaultContext, defaultNodePreVisitor);\n  };\n\n  public override clone(\n    newDefaultContext: TransformContext = {},\n    newDefaultNodePreVisitor: DefaultNodePreVisitor<Nodes> = {},\n  ): TransformerSubTyped<Nodes> {\n    return new TransformerSubTyped(\n      { ...this.defaultContext, ...newDefaultContext },\n      { ...this.defaultNodePreVisitor, ...newDefaultNodePreVisitor },\n    );\n  }\n\n  /**\n   * Transform a single node ({@link Typed}).\n   * Similar to {@link this.transformNode} but also allowing you to target the subTypes.\n   * @param startObject the object from which we will start the transformation,\n   *   potentially visiting and transforming its descendants along the way.\n   * @param nodeCallBacks a dictionary mapping the various operation types to objects optionally\n   *    containing preVisitor and transformer.\n   *    The preVisitor allows you to provide {@link TransformContext} for the current object,\n   *    altering how it will be transformed.\n   *    The transformer allows you to manipulate the copy of the current object,\n   *    and expects you to return the value that should take the current objects place.\n   * @param nodeSpecificCallBacks Same as nodeCallBacks but using an additional level of indirection to\n   *     indicate the subType.\n   * @return the result of transforming the requested descendant operations (based on the preVisitor)\n   * using a transformer that works its way back up from the descendant to the startObject.\n   */\n  public transformNodeSpecific<Safe extends Safeness = 'safe', OutType = unknown>(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      transform?: (copy: SafeWrap<Safe, Extract<Nodes, Typed<T>>>, orig: Extract<Nodes, Typed<T>>) => unknown;\n      preVisitor?: (orig: Extract<Nodes, Typed<T>>) => TransformContext;\n    }},\n    nodeSpecificCallBacks: {[Type in Nodes['type']]?: {\n      [SubType in Extract<Nodes, SubTyped<Type>>['subType']]?: {\n        transform?: (op: SafeWrap<Safe, Extract<Nodes, SubTyped<Type, SubType>>>) => unknown;\n        preVisitor?: (op: Extract<Nodes, SubTyped<Type, SubType>>) => TransformContext;\n      }}},\n  ): Safe extends 'unsafe' ? OutType : unknown {\n    const transformWrapper = (copy: object, orig: object): unknown => {\n      let ogTransform: ((copy: any, orig: any) => unknown) | undefined;\n      const casted = <SubTyped<Nodes['type']>>copy;\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, orig) : copy;\n    };\n    const preVisitWrapper = (curObject: object): VisitContext => {\n      let ogPreVisit: ((node: any) => VisitContext) | undefined;\n      const casted = <SubTyped<Nodes['type']>>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) : {};\n    };\n    return <any> this.transformObject(startObject, transformWrapper, preVisitWrapper);\n  }\n\n  /**\n   * Visit a selected subTree given a startObject, steering the visits based on {@link Typed} nodes.\n   * Similar to {@link this.visitNode}, but also allowing you to target subTypes.\n   * Will call the preVisitor on the outer distinct, then the visitor of the special distinct,\n   * followed by the visiting the outer distinct, printing '231'.\n   * The pre-visitor visits starting from the root, going deeper, while the actual visitor goes in reverse.\n   * @param startObject the object from which we will start visiting,\n   *   potentially visiting its descendants along the way.\n   * @param nodeCallBacks a dictionary mapping the various operation types to objects optionally\n   *    containing preVisitor and visitor.\n   *    The preVisitor allows you to provide {@link VisitContext} for the current object,\n   *    altering how it will be visited.\n   *    The visitor allows you to visit the object from deepest to the outermost object.\n   *    This is useful if you for example want to manipulate the objects you visit during your visits,\n   *    similar to {@link mapOperation}.\n   * @param nodeSpecificCallBacks Same as nodeCallBacks but using an additional level of indirection to\n   *     indicate the subType.\n   */\n  public visitNodeSpecific(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      visitor?: (op: Extract<Nodes, Typed<T>>) => void;\n      preVisitor?: (op: Extract<Nodes, Typed<T>>) => VisitContext;\n    }},\n    nodeSpecificCallBacks: {[Type in Nodes['type']]?:\n      {[Subtype in Extract<Nodes, SubTyped<Type>>['subType']]?: {\n        visitor?: (op: Extract<Nodes, SubTyped<Type, Subtype>>) => void;\n        preVisitor?: (op: Extract<Nodes, SubTyped<Type, Subtype>>) => VisitContext;\n      }}},\n  ): void {\n    const visitWrapper = (curObject: object): void => {\n      let ogTransform: ((node: any) => void) | undefined;\n      const casted = <SubTyped<Nodes['type']>>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 = <SubTyped<Nodes['type']>>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) : {};\n    };\n    this.visitObject(startObject, visitWrapper, preVisitWrapper);\n  }\n}\n"]}

package/dist/cjs/lib/transformers/TransformerTyped.js

@@ -13,14 +13,17 @@ class TransformerTyped extends TransformerObject_js_1.TransformerObject {
         return new TransformerTyped({ ...this.defaultContext, ...newDefaultContext }, { ...this.defaultNodePreVisitor, ...newDefaultNodePreVisitor });
     }
     /**
-     * Transform a single node.
-     * The transformation calls the preVisitor from starting from the startObject.
-     * The preVisitor can dictate whether transformation should be stopped.
-     * Note that stopping the transformation also prevets further copying.
-     * The transformer itself transforms object starting with the deepest one that can be visited.
-     * The transformer callback is performed on a copy of the original.
-     * @param startObject
-     * @param nodeCallBacks
+     * Transform a single node ({@link Typed}).
+     * @param startObject the object from which we will start the transformation,
+     *   potentially visiting and transforming its descendants along the way.
+     * @param nodeCallBacks a dictionary mapping the various node types to objects optionally
+     *    containing preVisitor and transformer.
+     *    The preVisitor allows you to provide {@link TransformContext} for the current object,
+     *    altering how it will be transformed.
+     *    The transformer allows you to manipulate the copy of the current object,
+     *    and expects you to return the value that should take the current objects place.
+     * @return the result of transforming the requested descendant operations (based on the preVisitor)
+     * using a transformer that works its way back up from the descendant to the startObject.
      */
     transformNode(startObject, nodeCallBacks) {
         const transformWrapper = (copy, orig) => {
@@ -45,10 +48,19 @@ class TransformerTyped extends TransformerObject_js_1.TransformerObject {
         return this.transformObject(startObject, transformWrapper, preVisitWrapper);
     }
     /**
-     * Similar to {@link this.transformNode}, but without copying the startObject.
+     * Visit a selected subTree given a startObject, steering the visits based on {@link Typed} nodes.
+     * Will first call the preVisitor on the project and notice it should not iterate on its descendants.
+     * It then visits the project, and the outermost distinct, printing '21'.
      * The pre-visitor visits starting from the root, going deeper, while the actual visitor goes in reverse.
-     * @param startObject
-     * @param nodeCallBacks
+     * @param startObject the object from which we will start visiting,
+     *   potentially visiting its descendants along the way.
+     * @param nodeCallBacks a dictionary mapping the various operation types to objects optionally
+     *    containing preVisitor and visitor.
+     *    The preVisitor allows you to provide {@link VisitContext} for the current object,
+     *    altering how it will be visited.
+     *    The visitor allows you to visit the object from deepest to the outermost object.
+     *    This is useful if you for example want to manipulate the objects you visit during your visits,
+     *    similar to {@link this.transformNode}.
      */
     visitNode(startObject, nodeCallBacks) {
         const visitorWrapper = (curObject) => {
@@ -73,30 +85,6 @@ class TransformerTyped extends TransformerObject_js_1.TransformerObject {
         };
         return this.visitObject(startObject, visitorWrapper, preVisitWrapper);
     }
-    /**
-     * Traverses only selected nodes as returned by the function.
-     * @param currentNode
-     * @param traverse
-     */
-    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);
-    }
 }
 exports.TransformerTyped = TransformerTyped;
 //# sourceMappingURL=TransformerTyped.js.map

package/dist/cjs/lib/transformers/TransformerTyped.js.map

@@ -1 +1 @@
-{"version":3,"file":"TransformerTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerTyped.ts"],"names":[],"mappings":";;;AAEA,iEAA2D;AAQ3D,MAAa,gBAAsC,SAAQ,wCAAiB;IAG9D;IAFZ,YACE,iBAAmC,EAAE,EAC3B,wBAAsD,EAAE;QAElE,KAAK,CAAC,cAAc,CAAC,CAAC;QAFZ,0BAAqB,GAArB,qBAAqB,CAAmC;IAGpE,CAAC;IAAA,CAAC;IAEc,KAAK,CACnB,oBAAsC,EAAE,EACxC,2BAAyD,EAAE;QAE3D,OAAO,IAAI,gBAAgB,CACzB,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,iBAAiB,EAAE,EAChD,EAAE,GAAG,IAAI,CAAC,qBAAqB,EAAE,GAAG,wBAAwB,EAAE,CAC/D,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,aAAa,CAClB,WAAmB,EACnB,aAGE;QAEF,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAW,EAAE;YAC/D,IAAI,WAA4D,CAAC;YACjE,MAAM,MAAM,GAAyB,IAAI,CAAC;YAC1C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;YACtD,CAAC;YACD,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,CAAC,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAChD,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC1D,IAAI,UAAqD,CAAC;YAC1D,IAAI,WAAW,GAAiB,EAAE,CAAC;YACnC,MAAM,MAAM,GAAyB,SAAS,CAAC;YAC/C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;gBACpD,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC;YACzD,CAAC;YACD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QAC9E,CAAC,CAAC;QACF,OAAa,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC;IACpF,CAAC;IAED;;;;;OAKG;IACI,SAAS,CACd,WAAmB,EACnB,aAGE;QAEF,MAAM,cAAc,GAAG,CAAC,SAAiB,EAAQ,EAAE;YACjD,MAAM,MAAM,GAAyB,SAAS,CAAC;YAC/C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;gBACxD,IAAI,WAAW,EAAE,CAAC;oBAChB,WAAW,CAAO,MAAM,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAChD,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC1D,IAAI,UAAqD,CAAC;YAC1D,IAAI,WAAW,GAAiB,EAAE,CAAC;YACnC,MAAM,MAAM,GAAyB,SAAS,CAAC;YAC/C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;gBACpD,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC;YACzD,CAAC;YACD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QAC9E,CAAC,CAAC;QACF,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACI,aAAa,CAClB,WAAkB,EAClB,QAAsG;QAEtG,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;AA1HD,4CA0HC","sourcesContent":["import type { Typed } from '../types.js';\nimport type { SelectiveTraversalContext, TransformContext, VisitContext } from './TransformerObject.js';\nimport { TransformerObject } from './TransformerObject.js';\n\nexport type Safeness = 'safe' | 'unsafe';\nexport type SafeWrap<Safe extends Safeness, obj extends object> =\n  Safe extends 'safe' ? {[key in keyof obj]: unknown } : obj;\n\nexport type DefaultNodePreVisitor<Nodes extends Typed> = {[T in Nodes['type']]?: TransformContext };\n\nexport class TransformerTyped<Nodes extends Typed> extends TransformerObject {\n  public constructor(\n    defaultContext: TransformContext = {},\n    protected defaultNodePreVisitor: DefaultNodePreVisitor<Nodes> = {},\n  ) {\n    super(defaultContext);\n  };\n\n  public override clone(\n    newDefaultContext: TransformContext = {},\n    newDefaultNodePreVisitor: DefaultNodePreVisitor<Nodes> = {},\n  ): TransformerTyped<Nodes> {\n    return new TransformerTyped(\n      { ...this.defaultContext, ...newDefaultContext },\n      { ...this.defaultNodePreVisitor, ...newDefaultNodePreVisitor },\n    );\n  }\n\n  /**\n   * Transform a single node.\n   * The transformation calls the preVisitor from starting from the startObject.\n   * The preVisitor can dictate whether transformation should be stopped.\n   * Note that stopping the transformation also prevets further copying.\n   * The transformer itself transforms object starting with the deepest one that can be visited.\n   * The transformer callback is performed on a copy of the original.\n   * @param startObject\n   * @param nodeCallBacks\n   */\n  public transformNode<Safe extends Safeness = 'safe', OutType = unknown>(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      transform?: (copy: SafeWrap<Safe, Extract<Nodes, Typed<T>>>, orig: Extract<Nodes, Typed<T>>) => unknown;\n      preVisitor?: (orig: Extract<Nodes, Typed<T>>) => TransformContext;\n    }},\n  ): Safe extends 'unsafe' ? OutType : unknown {\n    const transformWrapper = (copy: object, orig: object): unknown => {\n      let ogTransform: ((copy: any, orig: any) => unknown) | undefined;\n      const casted = <Typed<Nodes['type']>>copy;\n      if (casted.type) {\n        ogTransform = nodeCallBacks[casted.type]?.transform;\n      }\n      return ogTransform ? ogTransform(casted, orig) : copy;\n    };\n    const nodeDefaults = this.defaultNodePreVisitor;\n    const preVisitWrapper = (curObject: object): VisitContext => {\n      let ogPreVisit: ((node: any) => VisitContext) | undefined;\n      let nodeContext: VisitContext = {};\n      const casted = <Typed<Nodes['type']>>curObject;\n      if (casted.type) {\n        ogPreVisit = nodeCallBacks[casted.type]?.preVisitor;\n        nodeContext = nodeDefaults[casted.type] ?? nodeContext;\n      }\n      return ogPreVisit ? { ...nodeContext, ...ogPreVisit(casted) } : nodeContext;\n    };\n    return <any> this.transformObject(startObject, transformWrapper, preVisitWrapper);\n  }\n\n  /**\n   * Similar to {@link this.transformNode}, but without copying the startObject.\n   * The pre-visitor visits starting from the root, going deeper, while the actual visitor goes in reverse.\n   * @param startObject\n   * @param nodeCallBacks\n   */\n  public visitNode(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      visitor?: (op: Extract<Nodes, Typed<T>>) => void;\n      preVisitor?: (op: Extract<Nodes, Typed<T>>) => VisitContext;\n    }},\n  ): void {\n    const visitorWrapper = (curObject: object): void => {\n      const casted = <Typed<Nodes['type']>>curObject;\n      if (casted.type) {\n        const ogTransform = nodeCallBacks[casted.type]?.visitor;\n        if (ogTransform) {\n          ogTransform(<any> casted);\n        }\n      }\n    };\n    const nodeDefaults = this.defaultNodePreVisitor;\n    const preVisitWrapper = (curObject: object): VisitContext => {\n      let ogPreVisit: ((node: any) => VisitContext) | undefined;\n      let nodeContext: VisitContext = {};\n      const casted = <Typed<Nodes['type']>>curObject;\n      if (casted.type) {\n        ogPreVisit = nodeCallBacks[casted.type]?.preVisitor;\n        nodeContext = nodeDefaults[casted.type] ?? nodeContext;\n      }\n      return ogPreVisit ? { ...nodeContext, ...ogPreVisit(casted) } : nodeContext;\n    };\n    return this.visitObject(startObject, visitorWrapper, preVisitWrapper);\n  }\n\n  /**\n   * Traverses only selected nodes as returned by the function.\n   * @param currentNode\n   * @param traverse\n   */\n  public traverseNodes(\n    currentNode: Nodes,\n    traverse: {[T in Nodes['type']]?: (op: Extract<Nodes, Typed<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"]}
+{"version":3,"file":"TransformerTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerTyped.ts"],"names":[],"mappings":";;;AAEA,iEAA2D;AAQ3D,MAAa,gBAAsC,SAAQ,wCAAiB;IAG9D;IAFZ,YACE,iBAAmC,EAAE,EAC3B,wBAAsD,EAAE;QAElE,KAAK,CAAC,cAAc,CAAC,CAAC;QAFZ,0BAAqB,GAArB,qBAAqB,CAAmC;IAGpE,CAAC;IAAA,CAAC;IAEc,KAAK,CACnB,oBAAsC,EAAE,EACxC,2BAAyD,EAAE;QAE3D,OAAO,IAAI,gBAAgB,CACzB,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,iBAAiB,EAAE,EAChD,EAAE,GAAG,IAAI,CAAC,qBAAqB,EAAE,GAAG,wBAAwB,EAAE,CAC/D,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,aAAa,CAClB,WAAmB,EACnB,aAGE;QAEF,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAW,EAAE;YAC/D,IAAI,WAA4D,CAAC;YACjE,MAAM,MAAM,GAAyB,IAAI,CAAC;YAC1C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;YACtD,CAAC;YACD,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,CAAC,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAChD,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC1D,IAAI,UAAqD,CAAC;YAC1D,IAAI,WAAW,GAAiB,EAAE,CAAC;YACnC,MAAM,MAAM,GAAyB,SAAS,CAAC;YAC/C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;gBACpD,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC;YACzD,CAAC;YACD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QAC9E,CAAC,CAAC;QACF,OAAa,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,SAAS,CACd,WAAmB,EACnB,aAGE;QAEF,MAAM,cAAc,GAAG,CAAC,SAAiB,EAAQ,EAAE;YACjD,MAAM,MAAM,GAAyB,SAAS,CAAC;YAC/C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;gBACxD,IAAI,WAAW,EAAE,CAAC;oBAChB,WAAW,CAAO,MAAM,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAChD,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAgB,EAAE;YAC1D,IAAI,UAAqD,CAAC;YAC1D,IAAI,WAAW,GAAiB,EAAE,CAAC;YACnC,MAAM,MAAM,GAAyB,SAAS,CAAC;YAC/C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;gBACpD,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC;YACzD,CAAC;YACD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QAC9E,CAAC,CAAC;QACF,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;IACxE,CAAC;CACF;AAxGD,4CAwGC","sourcesContent":["import type { Typed } from '../types.js';\nimport type { TransformContext, VisitContext } from './TransformerObject.js';\nimport { TransformerObject } from './TransformerObject.js';\n\nexport type Safeness = 'safe' | 'unsafe';\nexport type SafeWrap<Safe extends Safeness, obj extends object> =\n  Safe extends 'safe' ? {[key in keyof obj]: unknown } : obj;\n\nexport type DefaultNodePreVisitor<Nodes extends Typed> = {[T in Nodes['type']]?: TransformContext };\n\nexport class TransformerTyped<Nodes extends Typed> extends TransformerObject {\n  public constructor(\n    defaultContext: TransformContext = {},\n    protected defaultNodePreVisitor: DefaultNodePreVisitor<Nodes> = {},\n  ) {\n    super(defaultContext);\n  };\n\n  public override clone(\n    newDefaultContext: TransformContext = {},\n    newDefaultNodePreVisitor: DefaultNodePreVisitor<Nodes> = {},\n  ): TransformerTyped<Nodes> {\n    return new TransformerTyped(\n      { ...this.defaultContext, ...newDefaultContext },\n      { ...this.defaultNodePreVisitor, ...newDefaultNodePreVisitor },\n    );\n  }\n\n  /**\n   * Transform a single node ({@link Typed}).\n   * @param startObject the object from which we will start the transformation,\n   *   potentially visiting and transforming its descendants along the way.\n   * @param nodeCallBacks a dictionary mapping the various node types to objects optionally\n   *    containing preVisitor and transformer.\n   *    The preVisitor allows you to provide {@link TransformContext} for the current object,\n   *    altering how it will be transformed.\n   *    The transformer allows you to manipulate the copy of the current object,\n   *    and expects you to return the value that should take the current objects place.\n   * @return the result of transforming the requested descendant operations (based on the preVisitor)\n   * using a transformer that works its way back up from the descendant to the startObject.\n   */\n  public transformNode<Safe extends Safeness = 'safe', OutType = unknown>(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      transform?: (copy: SafeWrap<Safe, Extract<Nodes, Typed<T>>>, orig: Extract<Nodes, Typed<T>>) => unknown;\n      preVisitor?: (orig: Extract<Nodes, Typed<T>>) => TransformContext;\n    }},\n  ): Safe extends 'unsafe' ? OutType : unknown {\n    const transformWrapper = (copy: object, orig: object): unknown => {\n      let ogTransform: ((copy: any, orig: any) => unknown) | undefined;\n      const casted = <Typed<Nodes['type']>>copy;\n      if (casted.type) {\n        ogTransform = nodeCallBacks[casted.type]?.transform;\n      }\n      return ogTransform ? ogTransform(casted, orig) : copy;\n    };\n    const nodeDefaults = this.defaultNodePreVisitor;\n    const preVisitWrapper = (curObject: object): VisitContext => {\n      let ogPreVisit: ((node: any) => VisitContext) | undefined;\n      let nodeContext: VisitContext = {};\n      const casted = <Typed<Nodes['type']>>curObject;\n      if (casted.type) {\n        ogPreVisit = nodeCallBacks[casted.type]?.preVisitor;\n        nodeContext = nodeDefaults[casted.type] ?? nodeContext;\n      }\n      return ogPreVisit ? { ...nodeContext, ...ogPreVisit(casted) } : nodeContext;\n    };\n    return <any> this.transformObject(startObject, transformWrapper, preVisitWrapper);\n  }\n\n  /**\n   * Visit a selected subTree given a startObject, steering the visits based on {@link Typed} nodes.\n   * Will first call the preVisitor on the project and notice it should not iterate on its descendants.\n   * It then visits the project, and the outermost distinct, printing '21'.\n   * The pre-visitor visits starting from the root, going deeper, while the actual visitor goes in reverse.\n   * @param startObject the object from which we will start visiting,\n   *   potentially visiting its descendants along the way.\n   * @param nodeCallBacks a dictionary mapping the various operation types to objects optionally\n   *    containing preVisitor and visitor.\n   *    The preVisitor allows you to provide {@link VisitContext} for the current object,\n   *    altering how it will be visited.\n   *    The visitor allows you to visit the object from deepest to the outermost object.\n   *    This is useful if you for example want to manipulate the objects you visit during your visits,\n   *    similar to {@link this.transformNode}.\n   */\n  public visitNode(\n    startObject: object,\n    nodeCallBacks: {[T in Nodes['type']]?: {\n      visitor?: (op: Extract<Nodes, Typed<T>>) => void;\n      preVisitor?: (op: Extract<Nodes, Typed<T>>) => VisitContext;\n    }},\n  ): void {\n    const visitorWrapper = (curObject: object): void => {\n      const casted = <Typed<Nodes['type']>>curObject;\n      if (casted.type) {\n        const ogTransform = nodeCallBacks[casted.type]?.visitor;\n        if (ogTransform) {\n          ogTransform(<any> casted);\n        }\n      }\n    };\n    const nodeDefaults = this.defaultNodePreVisitor;\n    const preVisitWrapper = (curObject: object): VisitContext => {\n      let ogPreVisit: ((node: any) => VisitContext) | undefined;\n      let nodeContext: VisitContext = {};\n      const casted = <Typed<Nodes['type']>>curObject;\n      if (casted.type) {\n        ogPreVisit = nodeCallBacks[casted.type]?.preVisitor;\n        nodeContext = nodeDefaults[casted.type] ?? nodeContext;\n      }\n      return ogPreVisit ? { ...nodeContext, ...ogPreVisit(casted) } : nodeContext;\n    };\n    return this.visitObject(startObject, visitorWrapper, preVisitWrapper);\n  }\n}\n"]}

package/dist/cjs/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../lib/types.ts"],"names":[],"mappings":"","sourcesContent":["export interface Typed<Type extends string = string> {\n  type: Type;\n  subType?: string;\n}\n\nexport interface SubTyped<Type extends string = string, SubType extends string = string> extends Typed<Type> {\n  subType: SubType;\n}\n\nexport interface Localized {\n  /**\n   * Location undefined means the node does have a string representation, but it was not clarified.\n   * This happens when an AST node is patched by a client of the lib.\n   */\n  loc: SourceLocation;\n}\n\nexport interface Wrap<T> extends Localized {\n  val: T;\n}\n\n/**\n * A AST node. Nodes are indexable by their types.\n * When generating, the SUBRULES called should be located within the current location range.\n */\nexport interface Node extends Localized, Typed {}\n\nexport interface SourceLocationBase {\n  sourceLocationType: string;\n}\n\nexport interface SourceLocationSource extends SourceLocationBase {\n  sourceLocationType: 'source';\n  start: number;\n  end: number;\n}\n\n/**\n * NoStringManifestation means the node does not have a string representation.\n * For example the literal '5' has an integer type (which is an AST node),\n * but the type does not have an associated string representation.\n * When set to true, the node will not be printed, start and end are meaningless in this case.\n */\nexport interface SourceLocationNoMaterialize extends SourceLocationBase {\n  sourceLocationType: 'noMaterialize';\n}\n\nexport interface SourceLocationStringReplace extends SourceLocationBase {\n  sourceLocationType: 'stringReplace';\n  newSource: string;\n  start: number;\n  end: number;\n}\n\nexport interface SourceLocationNodeReplace extends SourceLocationBase {\n  sourceLocationType: 'nodeReplace';\n  start: number;\n  end: number;\n}\n/**\n * Must have an ancestor of type {@link SourceLocationNodeReplace}\n */\nexport interface SourceLocationNodeAutoGenerate extends SourceLocationBase {\n  sourceLocationType: 'autoGenerate';\n}\n\nexport type SourceLocation =\n  | SourceLocationSource\n  | SourceLocationNoMaterialize\n  | SourceLocationStringReplace\n  | SourceLocationNodeReplace\n  | SourceLocationNodeAutoGenerate;\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../lib/types.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Type that is used by the Traqula core package to type raw objects/ Data Transfer Objects (DTO).\n * Enforces the presence of a type string, and that in case the subType key is present, it also be a string.\n */\nexport interface Typed<Type extends string = string> {\n  type: Type;\n  subType?: string;\n}\n\n/**\n * A {@link Typed} object that is sure to have a subType\n */\nexport interface SubTyped<Type extends string = string, SubType extends string = string> extends Typed<Type> {\n  subType: SubType;\n}\n\n/**\n * Type used by the parser and generator builders of the core Traqula package to annotate\n * the relation between AST objects and the source string.\n */\nexport interface Localized {\n  loc: SourceLocation;\n}\n\n/**\n * Wrapper type for localization,\n * can be used to state localization information about any other type (including primitive types)\n */\nexport interface Wrap<T> extends Localized {\n  val: T;\n}\n\n/**\n * A AST node. Nodes are indexable by their types.\n * When generating, the SUBRULES called should be located within the current location range.\n */\nexport interface Node extends Localized, Typed {}\n\nexport interface SourceLocationBase {\n  sourceLocationType: string;\n}\n\n/**\n * SourceLocation type that annotates that the node represents the AST representation of\n * the given range in the source string.\n */\nexport interface SourceLocationSource extends SourceLocationBase {\n  sourceLocationType: 'source';\n  start: number;\n  end: number;\n}\n\n/**\n * Similar to {@link SourceLocationSource} but also carrying the source it related too.\n * All sourceLocation nodes that are descends of this one, relate themselves to this source.\n */\nexport interface SourceLocationInlinedSource extends SourceLocationBase, Localized {\n  sourceLocationType: 'inlinedSource';\n  /**\n   * The string that will be used as the source for this node and the descends of this node.\n   * Note that the generator will print the characters from newSource[0] until start. Likewise for the suffix.\n   */\n  newSource: string;\n  /**\n   * Behavior of the current loc, after replacing the source string.\n   */\n  loc: SourceLocation;\n  /**\n   * The range that this node replaces in the context of the original source.\n   */\n  start: number;\n  end: number;\n  startOnNew: number;\n  endOnNew: number;\n}\n\n/**\n * NoStringManifestation means the node does not have a string representation.\n * For example the literal '5' has an integer type (which is an AST node),\n * but the type does not have an associated string representation.\n * When set to true, the node will not be printed, start and end are meaningless in this case.\n */\nexport interface SourceLocationNoMaterialize extends SourceLocationBase {\n  sourceLocationType: 'noMaterialize';\n}\n\n/**\n * SourceLocation type that annotates that the node has been replaced\n *   in relation to the original string by a new string.\n * It means that this node should be generated, and that the source string from start to end has been changed.\n */\nexport interface SourceLocationStringReplace extends SourceLocationBase {\n  sourceLocationType: 'stringReplace';\n  /**\n   * The string that will replace the given range in the original source.\n   */\n  newSource: string;\n  /**\n   * The start of the region in the original source string that this node replaces.\n   */\n  start: number;\n  /**\n   * The end of the region in the original source string that this node replaces.\n   */\n  end: number;\n}\n\n/**\n * SourceLocation type that annotates that the node has been replaced in relation to the original string.\n * It means that this node should be generated, and that the source string from start to end has been changed.\n */\nexport interface SourceLocationNodeReplace extends SourceLocationBase {\n  sourceLocationType: 'nodeReplace';\n  /**\n   * The start of the region in the original source string that this node replaces.\n   */\n  start: number;\n  /**\n   * The end of the region in the original source string that this node replaces.\n   */\n  end: number;\n}\n/**\n * Must have an ancestor of type {@link SourceLocationNodeReplace}\n */\nexport interface SourceLocationNodeAutoGenerate extends SourceLocationBase {\n  sourceLocationType: 'autoGenerate';\n}\n\nexport type SourceLocation =\n  // Relate yourself to the source\n  | SourceLocationSource\n  // Add a new source\n  | SourceLocationInlinedSource\n  // No not generate anything for the current node and descendants\n  | SourceLocationNoMaterialize\n  // Replace some range by a string\n  | SourceLocationStringReplace\n  // Replace this node by some autogen\n  | SourceLocationNodeReplace\n  // Auto gen current node.\n  | SourceLocationNodeAutoGenerate;\n"]}

package/dist/cjs/lib/utils.js

@@ -4,9 +4,16 @@ exports.traqulaIndentation = void 0;
 exports.unCapitalize = unCapitalize;
 exports.createToken = createToken;
 const chevrotain_1 = require("@traqula/chevrotain");
+/**
+ * Lowercase the first letter of a given string.
+ * @param str
+ */
 function unCapitalize(str) {
     return (str.charAt(0).toLowerCase() + str.slice(1));
 }
+/**
+ * Create a token in a typesafe way necessary by the traqula core builders.
+ */
 function createToken(config) {
     return (0, chevrotain_1.createToken)(config);
 }

package/dist/cjs/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../lib/utils.ts"],"names":[],"mappings":";;;AAQA,oCAEC;AAID,kCAEC;AAfD,oDAA4D;AAO5D,SAAgB,YAAY,CAAmB,GAAM;IACnD,OAAyB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACxE,CAAC;AAID,SAAgB,WAAW,CAAsB,MAAqC;IACpF,OAAoC,IAAA,wBAAM,EAAC,MAAM,CAAC,CAAC;AACrD,CAAC;AAKD;;;GAGG;AACU,QAAA,kBAAkB,GAC7B,wFAAwF,CAAC","sourcesContent":["import type { ITokenConfig, TokenType } from '@traqula/chevrotain';\nimport { createToken as chevcT } from '@traqula/chevrotain';\n\n/**\n * Check whether the first two types overlap, if no, return the 3th argument, else the 4th.\n */\nexport type CheckOverlap<T, U, V, W = never> = T & U extends never ? V : W;\n\nexport function unCapitalize<T extends string>(str: T): Uncapitalize<T> {\n  return <Uncapitalize<T>> (str.charAt(0).toLowerCase() + str.slice(1));\n}\n\nexport type NamedToken<Name extends string = string> = TokenType & { name: Name };\n\nexport function createToken<Name extends string>(config: ITokenConfig & { name: Name }): NamedToken<Name> {\n  return <TokenType & { name: Name }> chevcT(config);\n}\n\nexport type Patch<T extends object, Patch extends {[Key in keyof T ]?: unknown }> =\n  {[Key in keyof T]: Key extends keyof Patch ? Patch[Key] : T[Key] };\n\n/**\n * Key that allows you to set the space based indentation of your query when generating newlines using the NEW_LINE.\n * A value of -1 disables the generation of newlines from the NEW_LINE function\n */\nexport const traqulaIndentation =\n  'When you use this string, you expect traqula to handle indentation after every newline';\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../lib/utils.ts"],"names":[],"mappings":";;;AAYA,oCAEC;AAOD,kCAEC;AAtBD,oDAA4D;AAO5D;;;GAGG;AACH,SAAgB,YAAY,CAAmB,GAAM;IACnD,OAAyB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACxE,CAAC;AAID;;GAEG;AACH,SAAgB,WAAW,CAAsB,MAAqC;IACpF,OAAoC,IAAA,wBAAM,EAAC,MAAM,CAAC,CAAC;AACrD,CAAC;AAQD;;;GAGG;AACU,QAAA,kBAAkB,GAC7B,wFAAwF,CAAC","sourcesContent":["import type { ITokenConfig, TokenType } from '@traqula/chevrotain';\nimport { createToken as chevcT } from '@traqula/chevrotain';\n\n/**\n * Check whether the first two types overlap, if no, return the 3th argument, else the 4th.\n */\nexport type CheckOverlap<T, U, V, W = never> = T & U extends never ? V : W;\n\n/**\n * Lowercase the first letter of a given string.\n * @param str\n */\nexport function unCapitalize<T extends string>(str: T): Uncapitalize<T> {\n  return <Uncapitalize<T>> (str.charAt(0).toLowerCase() + str.slice(1));\n}\n\nexport type NamedToken<Name extends string = string> = TokenType & { name: Name };\n\n/**\n * Create a token in a typesafe way necessary by the traqula core builders.\n */\nexport function createToken<Name extends string>(config: ITokenConfig & { name: Name }): NamedToken<Name> {\n  return <TokenType & { name: Name }> chevcT(config);\n}\n\n/**\n * Patch a given type by changing the value-type of a specific key in the given object type.\n */\nexport type Patch<T extends object, Patch extends {[Key in keyof T ]?: unknown }> =\n  {[Key in keyof T]: Key extends keyof Patch ? Patch[Key] : T[Key] };\n\n/**\n * Key that allows you to set the space based indentation of your query when generating newlines using the NEW_LINE.\n * A value of -1 disables the generation of newlines from the NEW_LINE function\n */\nexport const traqulaIndentation =\n  'When you use this string, you expect traqula to handle indentation after every newline';\n"]}

package/dist/esm/lib/AstCoreFactory.d.ts

@@ -1,30 +1,42 @@
 import type { IToken } from '@traqula/chevrotain';
-import type { SourceLocation, SourceLocationNodeAutoGenerate, SourceLocationNodeReplace, SourceLocationNoMaterialize, SourceLocationSource, SourceLocationStringReplace, Node, Localized, Wrap, Typed, SubTyped } from './types.js';
-export declare class AstCoreFactory {
+import type { SourceLocation, SourceLocationNodeAutoGenerate, SourceLocationNodeReplace, SourceLocationNoMaterialize, SourceLocationSource, SourceLocationStringReplace, Node, Localized, Wrap, Typed, SubTyped, SourceLocationInlinedSource } from './types.js';
+export interface AstCoreFactoryArgs {
+    /**
+     * Whether the AstFactory can track sources, if not, the sourceLocation function returns autoGen. Default true
+     */
+    tracksSourceLocation: boolean;
+}
+export declare class AstCoreFactory implements AstCoreFactoryArgs {
+    tracksSourceLocation: boolean;
+    constructor(args?: Partial<AstCoreFactoryArgs>);
     wrap<T>(val: T, loc: SourceLocation): Wrap<T>;
     isLocalized(obj: unknown): obj is Localized;
     sourceLocation(...elements: (undefined | IToken | Localized)[]): SourceLocation;
-    sourceLocationNoMaterialize(): SourceLocationNoMaterialize;
+    sourceLocationNoMaterialize(): SourceLocation;
     /**
      * Returns a copy of the argument that is not materialized
      */
-    dematerialized<T extends Node>(arg: T): T & {
-        loc: SourceLocationNoMaterialize;
-    };
+    dematerialized<T extends Node>(arg: T): T;
     safeObjectTransform(value: unknown, mapper: (some: object) => any): any;
     forcedAutoGenTree<T extends object>(obj: T): T;
     forceMaterialized<T extends Node>(arg: T): T;
     isSourceLocation(loc: object): loc is SourceLocation;
     sourceLocationSource(start: number, end: number): SourceLocationSource;
+    /**
+     * {@inheritDoc SourceLocationInlinedSource}
+     */
+    sourceLocationInlinedSource(newSource: string, subLoc: SourceLocation, start: number, end: number, startOnNew?: number, endOnNew?: number): SourceLocation;
+    isSourceLocationInlinedSource(loc: object): loc is SourceLocationInlinedSource;
     gen(): SourceLocationNodeAutoGenerate;
     isSourceLocationSource(loc: object): loc is SourceLocationSource;
+    sourceLocationStringReplace(newSource: string, start: number, end: number): SourceLocation;
     isSourceLocationStringReplace(loc: object): loc is SourceLocationStringReplace;
     sourceLocationNodeReplaceUnsafe(loc: SourceLocation): SourceLocationNodeReplace;
     sourceLocationNodeReplace(location: SourceLocationSource): SourceLocationNodeReplace;
     sourceLocationNodeReplace(start: number, end: number): SourceLocationNodeReplace;
     isSourceLocationNodeReplace(loc: object): loc is SourceLocationNodeReplace;
     isSourceLocationNodeAutoGenerate(loc: object): loc is SourceLocationNodeAutoGenerate;
-    nodeShouldPrint(node: Localized): boolean;
+    isPrintingLoc(loc: SourceLocation): boolean;
     printFilter(node: Localized, callback: () => void): void;
     isSourceLocationNoMaterialize(loc: object): loc is SourceLocationNoMaterialize;
     isOfType<Type extends string>(obj: object, type: Type): obj is Typed<Type>;

package/dist/esm/lib/AstCoreFactory.js

@@ -1,4 +1,8 @@
 export class AstCoreFactory {
+    tracksSourceLocation;
+    constructor(args = {}) {
+        this.tracksSourceLocation = args.tracksSourceLocation ?? true;
+    }
     wrap(val, loc) {
         return { val, loc };
     }
@@ -7,6 +11,9 @@ export class AstCoreFactory {
             typeof obj.loc === 'object' && obj.loc !== null && 'sourceLocationType' in obj.loc;
     }
     sourceLocation(...elements) {
+        if (!this.tracksSourceLocation) {
+            return this.gen();
+        }
         const pureElements = elements.filter(x => x !== undefined);
         if (pureElements.length === 0) {
             return this.sourceLocationNoMaterialize();
@@ -29,6 +36,9 @@ export class AstCoreFactory {
         };
     }
     sourceLocationNoMaterialize() {
+        if (!this.tracksSourceLocation) {
+            return this.gen();
+        }
         return { sourceLocationType: 'noMaterialize' };
     }
     /**
@@ -73,12 +83,43 @@ export class AstCoreFactory {
             end,
         };
     }
+    /**
+     * {@inheritDoc SourceLocationInlinedSource}
+     */
+    sourceLocationInlinedSource(newSource, subLoc, start, end, startOnNew = 0, endOnNew = newSource.length) {
+        if (!this.tracksSourceLocation) {
+            return this.gen();
+        }
+        if (this.isSourceLocationSource(subLoc)) {
+            startOnNew = subLoc.start;
+            endOnNew = subLoc.end;
+        }
+        return {
+            sourceLocationType: 'inlinedSource',
+            newSource,
+            start,
+            end,
+            loc: subLoc,
+            startOnNew,
+            endOnNew,
+        };
+    }
+    ;
+    isSourceLocationInlinedSource(loc) {
+        return this.isSourceLocation(loc) && loc.sourceLocationType === 'inlinedSource';
+    }
     gen() {
         return { sourceLocationType: 'autoGenerate' };
     }
     isSourceLocationSource(loc) {
         return this.isSourceLocation(loc) && loc.sourceLocationType === 'source';
     }
+    sourceLocationStringReplace(newSource, start, end) {
+        if (!this.tracksSourceLocation) {
+            return this.gen();
+        }
+        return { sourceLocationType: 'stringReplace', newSource, start, end };
+    }
     isSourceLocationStringReplace(loc) {
         return this.isSourceLocation(loc) && loc.sourceLocationType === 'stringReplace';
     }
@@ -86,7 +127,10 @@ export class AstCoreFactory {
         if (this.isSourceLocationSource(loc)) {
             return this.sourceLocationNodeReplace(loc);
         }
-        throw new Error('not possible');
+        if (this.isSourceLocationInlinedSource(loc)) {
+            return this.sourceLocationNodeReplaceUnsafe(loc.loc);
+        }
+        throw new Error(`Cannot convert SourceLocation of type ${loc.sourceLocationType} to SourceLocationNodeReplace`);
     }
     sourceLocationNodeReplace(startOrLoc, end) {
         let starting;
@@ -111,12 +155,13 @@ export class AstCoreFactory {
     isSourceLocationNodeAutoGenerate(loc) {
         return this.isSourceLocation(loc) && loc.sourceLocationType === 'autoGenerate';
     }
-    nodeShouldPrint(node) {
-        return this.isSourceLocationNodeReplace(node.loc) ||
-            this.isSourceLocationNodeAutoGenerate(node.loc);
+    isPrintingLoc(loc) {
+        return this.isSourceLocationNodeReplace(loc) ||
+            this.isSourceLocationNodeAutoGenerate(loc) ||
+            (this.isSourceLocationInlinedSource(loc) && this.isPrintingLoc(loc.loc));
     }
     printFilter(node, callback) {
-        if (this.nodeShouldPrint(node)) {
+        if (this.isPrintingLoc(node.loc)) {
             callback();
         }
     }

package/dist/esm/lib/AstCoreFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"AstCoreFactory.js","sourceRoot":"","sources":["../../../lib/AstCoreFactory.ts"],"names":[],"mappings":"AAgBA,MAAM,OAAO,cAAc;IAClB,IAAI,CAAI,GAAM,EAAE,GAAmB;QACxC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,CAAC;IAEM,WAAW,CAAC,GAAY;QAC7B,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,KAAK,IAAI,GAAG;YAC5D,OAAO,GAAG,CAAC,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,IAAI,oBAAoB,IAAI,GAAG,CAAC,GAAG,CAAC;IACvF,CAAC;IAEM,cAAc,CAAC,GAAG,QAA4C;QACnE,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QAC3D,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,2BAA2B,EAAE,CAAC;QAC5C,CAAC;QACD,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAC7C,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,CAAC;YACtE,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACpG,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;QACpB,CAAC;QACD,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC;QAC9B,OAAO;YACL,kBAAkB,EAAE,QAAQ;YAC5B,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC0B,KAAK,CAAC,GAAI,CAAC,KAAK,CAAC,CAAC;gBAC1E,KAAK,CAAC,WAAW;YACnB,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC6B,IAAI,CAAC,GAAI,CAAC,GAAG,CAAC,CAAC;gBACrE,CAAC,IAAI,CAAC,SAAU,GAAG,CAAC,CAAC;SAC1B,CAAC;IACJ,CAAC;IAEM,2BAA2B;QAChC,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,cAAc,CAAiB,GAAM;QAC1C,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,2BAA2B,EAAE,EAAE,CAAC;IAC7D,CAAC;IAEM,mBAAmB,CAAC,KAAc,EAAE,MAA6B;QACtE,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,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAC7D,CAAC;YACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,iBAAiB,CAAmB,GAAM;QAC/C,MAAM,IAAI,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,IAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7G,CAAC;QACD,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,iBAAiB,CAAiB,GAAM;QAC7C,IAAI,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;IACpB,CAAC;IAEM,gBAAgB,CAAC,GAAW;QACjC,OAAO,oBAAoB,IAAI,GAAG,CAAC;IACrC,CAAC;IAEM,oBAAoB,CAAC,KAAa,EAAE,GAAW;QACpD,OAAO;YACL,kBAAkB,EAAE,QAAQ;YAC5B,KAAK;YACL,GAAG;SACJ,CAAC;IACJ,CAAC;IAEM,GAAG;QACR,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC;IAChD,CAAC;IAEM,sBAAsB,CAAC,GAAW;QACvC,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,QAAQ,CAAC;IAC3E,CAAC;IAEM,6BAA6B,CAAC,GAAW;QAC9C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,eAAe,CAAC;IAClF,CAAC;IAEM,+BAA+B,CAAC,GAAmB;QACxD,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAIM,yBAAyB,CAAC,UAAyC,EAAE,GAAY;QACtF,IAAI,QAAQ,CAAC;QACb,IAAI,MAAM,CAAC;QACX,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACnC,QAAQ,GAAG,UAAU,CAAC;YACtB,MAAM,GAAG,GAAI,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC;YAC5B,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC;QAC1B,CAAC;QACD,OAAO;YACL,kBAAkB,EAAE,aAAa;YACjC,KAAK,EAAE,QAAQ;YACf,GAAG,EAAE,MAAM;SACZ,CAAC;IACJ,CAAC;IAEM,2BAA2B,CAAC,GAAW;QAC5C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,aAAa,CAAC;IAChF,CAAC;IAEM,gCAAgC,CAAC,GAAW;QACjD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,cAAc,CAAC;IACjF,CAAC;IAEM,eAAe,CAAC,IAAe;QACpC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC;YAC/C,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAEM,WAAW,CAAC,IAAe,EAAE,QAAoB;QACtD,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,QAAQ,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAEM,6BAA6B,CAAC,GAAW;QAC9C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,eAAe,CAAC;IAClF,CAAC;IAEM,QAAQ,CAAsB,GAAW,EAAE,IAAU;QAC1D,MAAM,MAAM,GAAmB,GAAG,CAAC;QACnC,OAAO,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC;IAC9B,CAAC;IAEM,WAAW,CAA8C,GAAW,EAAE,IAAU,EAAE,OAAgB;QAEvG,MAAM,IAAI,GAA0C,GAAG,CAAC;QACxD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC;IACxD,CAAC;CACF","sourcesContent":["import type { IToken } from '@traqula/chevrotain';\n\nimport type {\n  SourceLocation,\n  SourceLocationNodeAutoGenerate,\n  SourceLocationNodeReplace,\n  SourceLocationNoMaterialize,\n  SourceLocationSource,\n  SourceLocationStringReplace,\n  Node,\n  Localized,\n  Wrap,\n  Typed,\n  SubTyped,\n} from './types.js';\n\nexport class AstCoreFactory {\n  public wrap<T>(val: T, loc: SourceLocation): Wrap<T> {\n    return { val, loc };\n  }\n\n  public isLocalized(obj: unknown): obj is Localized {\n    return typeof obj === 'object' && obj !== null && 'loc' in obj &&\n      typeof obj.loc === 'object' && obj.loc !== null && 'sourceLocationType' in obj.loc;\n  }\n\n  public sourceLocation(...elements: (undefined | IToken | Localized)[]): SourceLocation {\n    const pureElements = elements.filter(x => x !== undefined);\n    if (pureElements.length === 0) {\n      return this.sourceLocationNoMaterialize();\n    }\n    const filtered = pureElements.filter(element =>\n      !this.isLocalized(element) || this.isSourceLocationSource(element.loc) ||\n      this.isSourceLocationStringReplace(element.loc) || this.isSourceLocationNodeReplace(element.loc));\n    if (filtered.length === 0) {\n      return this.gen();\n    }\n    const first = filtered.at(0)!;\n    const last = filtered.at(-1)!;\n    return {\n      sourceLocationType: 'source',\n      start: this.isLocalized(first) ?\n          (<SourceLocationSource | SourceLocationStringReplace> first.loc).start :\n        first.startOffset,\n      end: this.isLocalized(last) ?\n          (<SourceLocationSource | SourceLocationStringReplace> last.loc).end :\n          (last.endOffset! + 1),\n    };\n  }\n\n  public sourceLocationNoMaterialize(): SourceLocationNoMaterialize {\n    return { sourceLocationType: 'noMaterialize' };\n  }\n\n  /**\n   * Returns a copy of the argument that is not materialized\n   */\n  public dematerialized<T extends Node>(arg: T): T & { loc: SourceLocationNoMaterialize } {\n    return { ...arg, loc: this.sourceLocationNoMaterialize() };\n  }\n\n  public safeObjectTransform(value: unknown, mapper: (some: object) => any): any {\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.safeObjectTransform(x, mapper));\n      }\n      return mapper(value);\n    }\n    return value;\n  }\n\n  public forcedAutoGenTree<T extends object>(obj: T): T {\n    const copy = { ...obj };\n    for (const [ key, value ] of Object.entries(copy)) {\n      (<Record<string, object>> copy)[key] = this.safeObjectTransform(value, obj => this.forcedAutoGenTree(obj));\n    }\n    if (this.isLocalized(copy)) {\n      copy.loc = this.gen();\n    }\n    return copy;\n  }\n\n  public forceMaterialized<T extends Node>(arg: T): T {\n    if (this.isSourceLocationNoMaterialize(arg.loc)) {\n      return this.forcedAutoGenTree(arg);\n    }\n    return { ...arg };\n  }\n\n  public isSourceLocation(loc: object): loc is SourceLocation {\n    return 'sourceLocationType' in loc;\n  }\n\n  public sourceLocationSource(start: number, end: number): SourceLocationSource {\n    return {\n      sourceLocationType: 'source',\n      start,\n      end,\n    };\n  }\n\n  public gen(): SourceLocationNodeAutoGenerate {\n    return { sourceLocationType: 'autoGenerate' };\n  }\n\n  public isSourceLocationSource(loc: object): loc is SourceLocationSource {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'source';\n  }\n\n  public isSourceLocationStringReplace(loc: object): loc is SourceLocationStringReplace {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'stringReplace';\n  }\n\n  public sourceLocationNodeReplaceUnsafe(loc: SourceLocation): SourceLocationNodeReplace {\n    if (this.isSourceLocationSource(loc)) {\n      return this.sourceLocationNodeReplace(loc);\n    }\n    throw new Error('not possible');\n  }\n\n  public sourceLocationNodeReplace(location: SourceLocationSource): SourceLocationNodeReplace;\n  public sourceLocationNodeReplace(start: number, end: number): SourceLocationNodeReplace;\n  public sourceLocationNodeReplace(startOrLoc: number | SourceLocationSource, end?: number): SourceLocationNodeReplace {\n    let starting;\n    let ending;\n    if (typeof startOrLoc === 'number') {\n      starting = startOrLoc;\n      ending = end!;\n    } else {\n      starting = startOrLoc.start;\n      ending = startOrLoc.end;\n    }\n    return {\n      sourceLocationType: 'nodeReplace',\n      start: starting,\n      end: ending,\n    };\n  }\n\n  public isSourceLocationNodeReplace(loc: object): loc is SourceLocationNodeReplace {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'nodeReplace';\n  }\n\n  public isSourceLocationNodeAutoGenerate(loc: object): loc is SourceLocationNodeAutoGenerate {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'autoGenerate';\n  }\n\n  public nodeShouldPrint(node: Localized): boolean {\n    return this.isSourceLocationNodeReplace(node.loc) ||\n      this.isSourceLocationNodeAutoGenerate(node.loc);\n  }\n\n  public printFilter(node: Localized, callback: () => void): void {\n    if (this.nodeShouldPrint(node)) {\n      callback();\n    }\n  }\n\n  public isSourceLocationNoMaterialize(loc: object): loc is SourceLocationNoMaterialize {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'noMaterialize';\n  }\n\n  public isOfType<Type extends string>(obj: object, type: Type): obj is Typed<Type> {\n    const casted: { type?: any } = obj;\n    return casted.type === type;\n  }\n\n  public isOfSubType<Type extends string, SubType extends string>(obj: object, type: Type, subType: SubType):\n    obj is SubTyped<Type, SubType> {\n    const temp: { type?: unknown; subType?: unknown } = obj;\n    return temp.type === type && temp.subType === subType;\n  }\n}\n"]}
+{"version":3,"file":"AstCoreFactory.js","sourceRoot":"","sources":["../../../lib/AstCoreFactory.ts"],"names":[],"mappings":"AAwBA,MAAM,OAAO,cAAc;IAClB,oBAAoB,CAAU;IACrC,YAAmB,OAAoC,EAAE;QACvD,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC;IAChE,CAAC;IAEM,IAAI,CAAI,GAAM,EAAE,GAAmB;QACxC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,CAAC;IAEM,WAAW,CAAC,GAAY;QAC7B,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,KAAK,IAAI,GAAG;YAC5D,OAAO,GAAG,CAAC,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,IAAI,oBAAoB,IAAI,GAAG,CAAC,GAAG,CAAC;IACvF,CAAC;IAEM,cAAc,CAAC,GAAG,QAA4C;QACnE,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;QACpB,CAAC;QAED,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QAC3D,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,2BAA2B,EAAE,CAAC;QAC5C,CAAC;QAED,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAC7C,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,CAAC;YACtE,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACpG,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;QACpB,CAAC;QACD,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC;QAC9B,OAAO;YACL,kBAAkB,EAAE,QAAQ;YAC5B,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC0B,KAAK,CAAC,GAAI,CAAC,KAAK,CAAC,CAAC;gBAC1E,KAAK,CAAC,WAAW;YACnB,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC6B,IAAI,CAAC,GAAI,CAAC,GAAG,CAAC,CAAC;gBACrE,CAAC,IAAI,CAAC,SAAU,GAAG,CAAC,CAAC;SAC1B,CAAC;IACJ,CAAC;IAEM,2BAA2B;QAChC,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;QACpB,CAAC;QACD,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,cAAc,CAAiB,GAAM;QAC1C,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,2BAA2B,EAAE,EAAE,CAAC;IAC7D,CAAC;IAEM,mBAAmB,CAAC,KAAc,EAAE,MAA6B;QACtE,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,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAC7D,CAAC;YACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,iBAAiB,CAAmB,GAAM;QAC/C,MAAM,IAAI,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,IAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7G,CAAC;QACD,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,iBAAiB,CAAiB,GAAM;QAC7C,IAAI,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;IACpB,CAAC;IAEM,gBAAgB,CAAC,GAAW;QACjC,OAAO,oBAAoB,IAAI,GAAG,CAAC;IACrC,CAAC;IAEM,oBAAoB,CAAC,KAAa,EAAE,GAAW;QACpD,OAAO;YACL,kBAAkB,EAAE,QAAQ;YAC5B,KAAK;YACL,GAAG;SACJ,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,2BAA2B,CAChC,SAAiB,EACjB,MAAsB,EACtB,KAAa,EACb,GAAW,EACX,UAAU,GAAG,CAAC,EACd,WAAmB,SAAS,CAAC,MAAM;QAEnC,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;QACpB,CAAC;QACD,IAAI,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,EAAE,CAAC;YACxC,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC;YAC1B,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC;QACxB,CAAC;QACD,OAAO;YACL,kBAAkB,EAAE,eAAe;YACnC,SAAS;YACT,KAAK;YACL,GAAG;YACH,GAAG,EAAE,MAAM;YACX,UAAU;YACV,QAAQ;SAC4B,CAAC;IACzC,CAAC;IAAA,CAAC;IAEK,6BAA6B,CAAC,GAAW;QAC9C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,eAAe,CAAC;IAClF,CAAC;IAEM,GAAG;QACR,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC;IAChD,CAAC;IAEM,sBAAsB,CAAC,GAAW;QACvC,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,QAAQ,CAAC;IAC3E,CAAC;IAEM,2BAA2B,CAAC,SAAiB,EAAE,KAAa,EAAE,GAAW;QAC9E,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;QACpB,CAAC;QACD,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAwC,CAAC;IAC9G,CAAC;IAEM,6BAA6B,CAAC,GAAW;QAC9C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,eAAe,CAAC;IAClF,CAAC;IAEM,+BAA+B,CAAC,GAAmB;QACxD,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5C,OAAO,IAAI,CAAC,+BAA+B,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,yCAAyC,GAAG,CAAC,kBAAkB,+BAA+B,CAAC,CAAC;IAClH,CAAC;IAIM,yBAAyB,CAAC,UAAyC,EAAE,GAAY;QACtF,IAAI,QAAQ,CAAC;QACb,IAAI,MAAM,CAAC;QACX,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACnC,QAAQ,GAAG,UAAU,CAAC;YACtB,MAAM,GAAG,GAAI,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC;YAC5B,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC;QAC1B,CAAC;QACD,OAAO;YACL,kBAAkB,EAAE,aAAa;YACjC,KAAK,EAAE,QAAQ;YACf,GAAG,EAAE,MAAM;SACZ,CAAC;IACJ,CAAC;IAEM,2BAA2B,CAAC,GAAW;QAC5C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,aAAa,CAAC;IAChF,CAAC;IAEM,gCAAgC,CAAC,GAAW;QACjD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,cAAc,CAAC;IACjF,CAAC;IAEM,aAAa,CAAC,GAAmB;QACtC,OAAO,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC;YAC1C,IAAI,CAAC,gCAAgC,CAAC,GAAG,CAAC;YAC1C,CAAC,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7E,CAAC;IAEM,WAAW,CAAC,IAAe,EAAE,QAAoB;QACtD,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,QAAQ,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAEM,6BAA6B,CAAC,GAAW;QAC9C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,eAAe,CAAC;IAClF,CAAC;IAEM,QAAQ,CAAsB,GAAW,EAAE,IAAU;QAC1D,MAAM,MAAM,GAAmB,GAAG,CAAC;QACnC,OAAO,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC;IAC9B,CAAC;IAEM,WAAW,CAA8C,GAAW,EAAE,IAAU,EAAE,OAAgB;QAEvG,MAAM,IAAI,GAA0C,GAAG,CAAC;QACxD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC;IACxD,CAAC;CACF","sourcesContent":["import type { IToken } from '@traqula/chevrotain';\n\nimport type {\n  SourceLocation,\n  SourceLocationNodeAutoGenerate,\n  SourceLocationNodeReplace,\n  SourceLocationNoMaterialize,\n  SourceLocationSource,\n  SourceLocationStringReplace,\n  Node,\n  Localized,\n  Wrap,\n  Typed,\n  SubTyped,\n  SourceLocationInlinedSource,\n} from './types.js';\n\nexport interface AstCoreFactoryArgs {\n  /**\n   * Whether the AstFactory can track sources, if not, the sourceLocation function returns autoGen. Default true\n   */\n  tracksSourceLocation: boolean;\n}\n\nexport class AstCoreFactory implements AstCoreFactoryArgs {\n  public tracksSourceLocation: boolean;\n  public constructor(args: Partial<AstCoreFactoryArgs> = {}) {\n    this.tracksSourceLocation = args.tracksSourceLocation ?? true;\n  }\n\n  public wrap<T>(val: T, loc: SourceLocation): Wrap<T> {\n    return { val, loc };\n  }\n\n  public isLocalized(obj: unknown): obj is Localized {\n    return typeof obj === 'object' && obj !== null && 'loc' in obj &&\n      typeof obj.loc === 'object' && obj.loc !== null && 'sourceLocationType' in obj.loc;\n  }\n\n  public sourceLocation(...elements: (undefined | IToken | Localized)[]): SourceLocation {\n    if (!this.tracksSourceLocation) {\n      return this.gen();\n    }\n\n    const pureElements = elements.filter(x => x !== undefined);\n    if (pureElements.length === 0) {\n      return this.sourceLocationNoMaterialize();\n    }\n\n    const filtered = pureElements.filter(element =>\n      !this.isLocalized(element) || this.isSourceLocationSource(element.loc) ||\n      this.isSourceLocationStringReplace(element.loc) || this.isSourceLocationNodeReplace(element.loc));\n    if (filtered.length === 0) {\n      return this.gen();\n    }\n    const first = filtered.at(0)!;\n    const last = filtered.at(-1)!;\n    return {\n      sourceLocationType: 'source',\n      start: this.isLocalized(first) ?\n          (<SourceLocationSource | SourceLocationStringReplace> first.loc).start :\n        first.startOffset,\n      end: this.isLocalized(last) ?\n          (<SourceLocationSource | SourceLocationStringReplace> last.loc).end :\n          (last.endOffset! + 1),\n    };\n  }\n\n  public sourceLocationNoMaterialize(): SourceLocation {\n    if (!this.tracksSourceLocation) {\n      return this.gen();\n    }\n    return { sourceLocationType: 'noMaterialize' };\n  }\n\n  /**\n   * Returns a copy of the argument that is not materialized\n   */\n  public dematerialized<T extends Node>(arg: T): T {\n    return { ...arg, loc: this.sourceLocationNoMaterialize() };\n  }\n\n  public safeObjectTransform(value: unknown, mapper: (some: object) => any): any {\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.safeObjectTransform(x, mapper));\n      }\n      return mapper(value);\n    }\n    return value;\n  }\n\n  public forcedAutoGenTree<T extends object>(obj: T): T {\n    const copy = { ...obj };\n    for (const [ key, value ] of Object.entries(copy)) {\n      (<Record<string, object>> copy)[key] = this.safeObjectTransform(value, obj => this.forcedAutoGenTree(obj));\n    }\n    if (this.isLocalized(copy)) {\n      copy.loc = this.gen();\n    }\n    return copy;\n  }\n\n  public forceMaterialized<T extends Node>(arg: T): T {\n    if (this.isSourceLocationNoMaterialize(arg.loc)) {\n      return this.forcedAutoGenTree(arg);\n    }\n    return { ...arg };\n  }\n\n  public isSourceLocation(loc: object): loc is SourceLocation {\n    return 'sourceLocationType' in loc;\n  }\n\n  public sourceLocationSource(start: number, end: number): SourceLocationSource {\n    return {\n      sourceLocationType: 'source',\n      start,\n      end,\n    };\n  }\n\n  /**\n   * {@inheritDoc SourceLocationInlinedSource}\n   */\n  public sourceLocationInlinedSource(\n    newSource: string,\n    subLoc: SourceLocation,\n    start: number,\n    end: number,\n    startOnNew = 0,\n    endOnNew: number = newSource.length,\n  ): SourceLocation {\n    if (!this.tracksSourceLocation) {\n      return this.gen();\n    }\n    if (this.isSourceLocationSource(subLoc)) {\n      startOnNew = subLoc.start;\n      endOnNew = subLoc.end;\n    }\n    return {\n      sourceLocationType: 'inlinedSource',\n      newSource,\n      start,\n      end,\n      loc: subLoc,\n      startOnNew,\n      endOnNew,\n    }satisfies SourceLocationInlinedSource;\n  };\n\n  public isSourceLocationInlinedSource(loc: object): loc is SourceLocationInlinedSource {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'inlinedSource';\n  }\n\n  public gen(): SourceLocationNodeAutoGenerate {\n    return { sourceLocationType: 'autoGenerate' };\n  }\n\n  public isSourceLocationSource(loc: object): loc is SourceLocationSource {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'source';\n  }\n\n  public sourceLocationStringReplace(newSource: string, start: number, end: number): SourceLocation {\n    if (!this.tracksSourceLocation) {\n      return this.gen();\n    }\n    return { sourceLocationType: 'stringReplace', newSource, start, end } satisfies SourceLocationStringReplace;\n  }\n\n  public isSourceLocationStringReplace(loc: object): loc is SourceLocationStringReplace {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'stringReplace';\n  }\n\n  public sourceLocationNodeReplaceUnsafe(loc: SourceLocation): SourceLocationNodeReplace {\n    if (this.isSourceLocationSource(loc)) {\n      return this.sourceLocationNodeReplace(loc);\n    }\n    if (this.isSourceLocationInlinedSource(loc)) {\n      return this.sourceLocationNodeReplaceUnsafe(loc.loc);\n    }\n    throw new Error(`Cannot convert SourceLocation of type ${loc.sourceLocationType} to SourceLocationNodeReplace`);\n  }\n\n  public sourceLocationNodeReplace(location: SourceLocationSource): SourceLocationNodeReplace;\n  public sourceLocationNodeReplace(start: number, end: number): SourceLocationNodeReplace;\n  public sourceLocationNodeReplace(startOrLoc: number | SourceLocationSource, end?: number): SourceLocationNodeReplace {\n    let starting;\n    let ending;\n    if (typeof startOrLoc === 'number') {\n      starting = startOrLoc;\n      ending = end!;\n    } else {\n      starting = startOrLoc.start;\n      ending = startOrLoc.end;\n    }\n    return {\n      sourceLocationType: 'nodeReplace',\n      start: starting,\n      end: ending,\n    };\n  }\n\n  public isSourceLocationNodeReplace(loc: object): loc is SourceLocationNodeReplace {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'nodeReplace';\n  }\n\n  public isSourceLocationNodeAutoGenerate(loc: object): loc is SourceLocationNodeAutoGenerate {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'autoGenerate';\n  }\n\n  public isPrintingLoc(loc: SourceLocation): boolean {\n    return this.isSourceLocationNodeReplace(loc) ||\n      this.isSourceLocationNodeAutoGenerate(loc) ||\n      (this.isSourceLocationInlinedSource(loc) && this.isPrintingLoc(loc.loc));\n  }\n\n  public printFilter(node: Localized, callback: () => void): void {\n    if (this.isPrintingLoc(node.loc)) {\n      callback();\n    }\n  }\n\n  public isSourceLocationNoMaterialize(loc: object): loc is SourceLocationNoMaterialize {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'noMaterialize';\n  }\n\n  public isOfType<Type extends string>(obj: object, type: Type): obj is Typed<Type> {\n    const casted: { type?: any } = obj;\n    return casted.type === type;\n  }\n\n  public isOfSubType<Type extends string, SubType extends string>(obj: object, type: Type, subType: SubType):\n    obj is SubTyped<Type, SubType> {\n    const temp: { type?: unknown; subType?: unknown } = obj;\n    return temp.type === type && temp.subType === subType;\n  }\n}\n"]}

package/dist/esm/lib/generator-builder/dynamicGenerator.d.ts

@@ -1,4 +1,5 @@
 import { AstCoreFactory } from '../AstCoreFactory.js';
+import type { SourceLocationInlinedSource } from '../types.js';
 import { traqulaIndentation } from '../utils.js';
 import type { GenRuleMap } from './builderTypes.js';
 import type { RuleDefArg } from './generatorTypes.js';
@@ -7,6 +8,7 @@ export declare class DynamicGenerator<Context, Names extends string, RuleDefs ex
     protected readonly factory: AstCoreFactory;
     protected __context: Context | undefined;
     protected origSource: string;
+    protected handledInlineSource: SourceLocationInlinedSource | undefined;
     protected generatedUntil: number;
     protected toEnsure: ((willPrint: string) => void)[];
     /**
@@ -21,6 +23,9 @@ export declare class DynamicGenerator<Context, Names extends string, RuleDefs ex
     };
     protected readonly subrule: RuleDefArg['SUBRULE'];
     protected readonly handleLoc: RuleDefArg['HANDLE_LOC'];
+    /**
+     * Catchup until, excluding
+     */
     protected readonly catchup: RuleDefArg['CATCHUP'];
     private handeEnsured;
     protected readonly print: RuleDefArg['PRINT'];

package/dist/esm/lib/generator-builder/dynamicGenerator.js

@@ -5,6 +5,7 @@ export class DynamicGenerator {
     factory = new AstCoreFactory();
     __context = undefined;
     origSource = '';
+    handledInlineSource;
     generatedUntil = 0;
     toEnsure = [];
     /**
@@ -77,6 +78,22 @@ export class DynamicGenerator {
         if (this.factory.isSourceLocationSource(localized.loc)) {
             this.catchup(localized.loc.start);
         }
+        if (this.factory.isSourceLocationInlinedSource(localized.loc) && this.handledInlineSource !== localized.loc) {
+            // Calling handleLoc on the same AST multiple times should be the same as doing it once.
+            this.handledInlineSource = localized.loc;
+            this.catchup(localized.loc.start);
+            const origSource = this.origSource;
+            const origPointer = this.generatedUntil;
+            this.origSource = localized.loc.newSource;
+            this.generatedUntil = 0;
+            this.catchup(localized.loc.startOnNew);
+            this.handleLoc(localized.loc, handle);
+            this.generatedUntil = localized.loc.endOnNew;
+            this.catchup(this.origSource.length);
+            this.origSource = origSource;
+            this.generatedUntil = Math.max(origPointer, localized.loc.end);
+            return;
+        }
         // If autoGenerate - do nothing
         const ret = handle();
         if (this.factory.isSourceLocationSource(localized.loc)) {
@@ -84,6 +101,9 @@ export class DynamicGenerator {
         }
         return ret;
     };
+    /**
+     * Catchup until, excluding
+     */
     catchup = (until) => {
         const start = this.generatedUntil;
         if (start < until) {