@traqula/core - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

dist/cjs/lib/generator-builder/generatorBuilder.js

@@ -15,2 +15,10 @@ "use strict";
 }
+/**
+ * Builder for composing modular code generators from rule definitions.
+ * Mirrors the {@link ParserBuilder} API but targets code generation (AST → string)
+ * instead of parsing (string → AST).
+ *
+ * Builders mutate internal state and return `this`.
+ * Always start by copying an existing builder with `GeneratorBuilder.create(existingBuilder)`.
+ */
 class GeneratorBuilder {
@@ -27,5 +35,16 @@ static create(start) {
     }
+    /**
+     * Narrow the builder's context type parameter to a more specific subtype.
+     * This is a zero-cost type-level operation — the builder instance is returned as-is
+     * but with updated type parameters.
+     */
     widenContext() {
         return this;
     }
+    /**
+     * Update the type signatures (return types and/or parameter types) of existing rules
+     * without changing their implementations. Use this when a patched rule changes the types
+     * flowing through downstream rules that don't need new implementations.
+     * This is a zero-cost type-level operation.
+     */
     typePatch() {
@@ -60,2 +79,8 @@ return this;
     }
+    /**
+     * Add multiple rules at once using rest parameters.
+     * Provides better TypeScript type inference than calling {@link addRule} in a loop,
+     * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.
+     * TypeScript errors if any rule name conflicts with an existing one.
+     */
     addMany(...rules) {
@@ -72,2 +97,6 @@ this.rules = { ...this.rules, ...listToRuleDefMap(rules) };
     }
+    /**
+     * Delete multiple rules by name in a single call.
+     * @param ruleNames - Names of the rules to delete.
+     */
     deleteMany(...ruleNames) {
@@ -79,2 +108,7 @@ for (const name of ruleNames) {
     }
+    /**
+     * Retrieve a generator rule definition by its name.
+     * Useful for inspecting or wrapping existing rules when extending a generator.
+     * @param ruleName - The name of the rule, type-checked against the builder's known rule names.
+     */
     getRule(ruleName) {
@@ -118,2 +152,6 @@ return this.rules[ruleName];
     }
+    /**
+     * Construct a generator from the registered rules.
+     * @returns An object with a method for each registered rule name.
+     */
     build() {
@@ -120,0 +158,0 @@ return new dynamicGenerator_js_1.DynamicGenerator(this.rules);

dist/cjs/lib/generator-builder/generatorBuilder.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"generatorBuilder.js","sourceRoot":"","sources":["../../../../lib/generator-builder/generatorBuilder.ts"],"names":[],"mappings":";;;AAGA,+DAAyD;AAGzD;;GAEG;AACH,SAAS,gBAAgB,CAAqC,KAAQ;IACpE,MAAM,QAAQ,GAAkC,EAAE,CAAC;IACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA4B,QAAQ,CAAC;AACvC,CAAC;AAED,MAAa,gBAAgB;IAcpB,MAAM,CAAC,MAAM,CAMlB,KAAyD;QAEzD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA8D,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9G,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,EAAE,GAAqC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACrF,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAEM,YAAY;QAQjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAEM,SAAS;QAUd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAA2C;QAKpG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAA0C;QAK3G,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAA4C,IAAI,CAAC,KAAK,CAAC;QAClE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;QAC9E,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAAkE;QAKlE,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAKV,gBAAmE,EACnE,eAAmB;QAenB,yFAAyF;QACzF,MAAM,UAAU,GAA2C,EAAE,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC;QACzF,MAAM,OAAO,GAA2C,IAAI,CAAC,KAAK,CAAC;QAEnE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,IAAI,mFAAmF,CAAC,CAAC;oBACnI,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAEM,KAAK;QACV,OAAsD,IAAI,sCAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzF,CAAC;CACF;AAlND,4CAkNC","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\nimport type { CheckOverlap } from '../utils.js';\nimport type { GeneratorFromRules, GenRuleMap, GenRulesToObject } from './builderTypes.js';\nimport { DynamicGenerator } from './dynamicGenerator.js';\nimport type { GeneratorRule } from './generatorTypes.js';\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nfunction listToRuleDefMap<T extends readonly GeneratorRule[]>(rules: T): GenRulesToObject<T> {\n  const newRules: Record<string, GeneratorRule> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <GenRulesToObject<T>>newRules;\n}\n\nexport class GeneratorBuilder<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> {\n  /**\n   * Create a GeneratorBuilder from some initial grammar rules or an existing GeneratorBuilder.\n   * If a GeneratorBuilder is provided, a new copy will be created.\n   */\n  public static create<Context, Names extends string, RuleDefs extends GenRuleMap<Names>>(\n    args: GeneratorBuilder<Context, Names, RuleDefs>\n  ): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(rules: Rules): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(\n    start: Rules | GeneratorBuilder<Context, Names, RuleDefs>,\n  ): GeneratorBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <GeneratorBuilder<Context, Names, RuleDefs>> <unknown> new GeneratorBuilder(listToRuleDefMap(start));\n    }\n    return new GeneratorBuilder({ ...(<GeneratorBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  public widenContext<NewContext extends Context>(): GeneratorBuilder<\n    NewContext,\n    Names,\n    {[Key in keyof RuleDefs]: Key extends Names ?\n        (RuleDefs[Key] extends GeneratorRule<any, any, infer RT, infer PT> ?\n          GeneratorRule<NewContext, Key, RT, PT> : never)\n      : never }\n  > {\n    return <any> this;\n  }\n\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? GeneratorRule<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only  one - infer arg yourself\n      Patch[Key] extends [ any ] ?\n        RuleDefs[Key] extends GeneratorRule<any, any, any, infer Par> ?\n          GeneratorRule<Context, Key, Patch[Key][0], Par> : never\n        : never\n    )) : RuleDefs[Key] extends GeneratorRule<any, Key> ? RuleDefs[Key] : never\n  }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing generator rule.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    GeneratorRule<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      GeneratorRule<Context, Key, RET, ARGS> :\n        (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    const self = <GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n        (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n      : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never) }>>\n      <unknown> this;\n    const rules = <Record<string, GeneratorRule<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Rule ${rule.name} already exists in the GeneratorBuilder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, GeneratorRule<Context, U, RET, ARGS>>,\n  ): GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  public addMany<U extends readonly GeneratorRule<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): GeneratorBuilder<\n    Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof GenRulesToObject<typeof rules> ? (\n        GenRulesToObject<typeof rules>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n  > {\n    this.rules = { ...this.rules, ...listToRuleDefMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }> {\n    for (const name of ruleNames) {\n      delete this.rules[name];\n    }\n    return <GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends GeneratorRule<any, U, infer RT, infer PT> ?\n    GeneratorRule<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this grammar GeneratorBuilder with another.\n   * It is best to merge the bigger grammar with the smaller one.\n   * If the two builders both have a grammar rule with the same name,\n   * no error will be thrown case they map to the same ruledef object.\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,\n   * this rule implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends GenRuleMap<OtherNames>,\n    OW extends readonly GeneratorRule<Context>[],\n  >(\n    GeneratorBuilder: GeneratorBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    GeneratorBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof GenRulesToObject<OW> ? (\n          GenRulesToObject<OW>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends GeneratorRule<Context, K> ? OtherRules[K] : never)\n                  : never\n            ) }\n    > {\n    // Assume the other grammar is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, GeneratorRule<Context>> = { ...GeneratorBuilder.rules };\n    const myRules: Record<string, GeneratorRule<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Rule with name \"${rule.name}\" already exists in the GeneratorBuilder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  public build(): GeneratorFromRules<Context, Names, RuleDefs> {\n    return <GeneratorFromRules<Context, Names, RuleDefs>> new DynamicGenerator(this.rules);\n  }\n}\n"]}
+{"version":3,"file":"generatorBuilder.js","sourceRoot":"","sources":["../../../../lib/generator-builder/generatorBuilder.ts"],"names":[],"mappings":";;;AAGA,+DAAyD;AAGzD;;GAEG;AACH,SAAS,gBAAgB,CAAqC,KAAQ;IACpE,MAAM,QAAQ,GAAkC,EAAE,CAAC;IACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA4B,QAAQ,CAAC;AACvC,CAAC;AAED;;;;;;;GAOG;AACH,MAAa,gBAAgB;IAcpB,MAAM,CAAC,MAAM,CAMlB,KAAyD;QAEzD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA8D,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9G,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,EAAE,GAAqC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACrF,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,YAAY;QAQjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,SAAS;QAUd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAA2C;QAKpG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAA0C;QAK3G,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAA4C,IAAI,CAAC,KAAK,CAAC;QAClE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;QAC9E,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAAkE;QAKlE,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAKV,gBAAmE,EACnE,eAAmB;QAenB,yFAAyF;QACzF,MAAM,UAAU,GAA2C,EAAE,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC;QACzF,MAAM,OAAO,GAA2C,IAAI,CAAC,KAAK,CAAC;QAEnE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,IAAI,mFAAmF,CAAC,CAAC;oBACnI,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAAsD,IAAI,sCAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzF,CAAC;CACF;AAhPD,4CAgPC","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\nimport type { CheckOverlap } from '../utils.js';\nimport type { GeneratorFromRules, GenRuleMap, GenRulesToObject } from './builderTypes.js';\nimport { DynamicGenerator } from './dynamicGenerator.js';\nimport type { GeneratorRule } from './generatorTypes.js';\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nfunction listToRuleDefMap<T extends readonly GeneratorRule[]>(rules: T): GenRulesToObject<T> {\n  const newRules: Record<string, GeneratorRule> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <GenRulesToObject<T>>newRules;\n}\n\n/**\n * Builder for composing modular code generators from rule definitions.\n * Mirrors the {@link ParserBuilder} API but targets code generation (AST → string)\n * instead of parsing (string → AST).\n *\n * Builders mutate internal state and return `this`.\n * Always start by copying an existing builder with `GeneratorBuilder.create(existingBuilder)`.\n */\nexport class GeneratorBuilder<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> {\n  /**\n   * Create a GeneratorBuilder from some initial grammar rules or an existing GeneratorBuilder.\n   * If a GeneratorBuilder is provided, a new copy will be created.\n   */\n  public static create<Context, Names extends string, RuleDefs extends GenRuleMap<Names>>(\n    args: GeneratorBuilder<Context, Names, RuleDefs>\n  ): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(rules: Rules): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(\n    start: Rules | GeneratorBuilder<Context, Names, RuleDefs>,\n  ): GeneratorBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <GeneratorBuilder<Context, Names, RuleDefs>> <unknown> new GeneratorBuilder(listToRuleDefMap(start));\n    }\n    return new GeneratorBuilder({ ...(<GeneratorBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  /**\n   * Narrow the builder's context type parameter to a more specific subtype.\n   * This is a zero-cost type-level operation — the builder instance is returned as-is\n   * but with updated type parameters.\n   */\n  public widenContext<NewContext extends Context>(): GeneratorBuilder<\n    NewContext,\n    Names,\n    {[Key in keyof RuleDefs]: Key extends Names ?\n        (RuleDefs[Key] extends GeneratorRule<any, any, infer RT, infer PT> ?\n          GeneratorRule<NewContext, Key, RT, PT> : never)\n      : never }\n  > {\n    return <any> this;\n  }\n\n  /**\n   * Update the type signatures (return types and/or parameter types) of existing rules\n   * without changing their implementations. Use this when a patched rule changes the types\n   * flowing through downstream rules that don't need new implementations.\n   * This is a zero-cost type-level operation.\n   */\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? GeneratorRule<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only  one - infer arg yourself\n      Patch[Key] extends [ any ] ?\n        RuleDefs[Key] extends GeneratorRule<any, any, any, infer Par> ?\n          GeneratorRule<Context, Key, Patch[Key][0], Par> : never\n        : never\n    )) : RuleDefs[Key] extends GeneratorRule<any, Key> ? RuleDefs[Key] : never\n  }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing generator rule.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    GeneratorRule<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      GeneratorRule<Context, Key, RET, ARGS> :\n        (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    const self = <GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n        (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n      : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never) }>>\n      <unknown> this;\n    const rules = <Record<string, GeneratorRule<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Rule ${rule.name} already exists in the GeneratorBuilder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, GeneratorRule<Context, U, RET, ARGS>>,\n  ): GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  /**\n   * Add multiple rules at once using rest parameters.\n   * Provides better TypeScript type inference than calling {@link addRule} in a loop,\n   * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.\n   * TypeScript errors if any rule name conflicts with an existing one.\n   */\n  public addMany<U extends readonly GeneratorRule<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): GeneratorBuilder<\n    Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof GenRulesToObject<typeof rules> ? (\n        GenRulesToObject<typeof rules>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n  > {\n    this.rules = { ...this.rules, ...listToRuleDefMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Delete multiple rules by name in a single call.\n   * @param ruleNames - Names of the rules to delete.\n   */\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }> {\n    for (const name of ruleNames) {\n      delete this.rules[name];\n    }\n    return <GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Retrieve a generator rule definition by its name.\n   * Useful for inspecting or wrapping existing rules when extending a generator.\n   * @param ruleName - The name of the rule, type-checked against the builder's known rule names.\n   */\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends GeneratorRule<any, U, infer RT, infer PT> ?\n    GeneratorRule<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this grammar GeneratorBuilder with another.\n   * It is best to merge the bigger grammar with the smaller one.\n   * If the two builders both have a grammar rule with the same name,\n   * no error will be thrown case they map to the same ruledef object.\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,\n   * this rule implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends GenRuleMap<OtherNames>,\n    OW extends readonly GeneratorRule<Context>[],\n  >(\n    GeneratorBuilder: GeneratorBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    GeneratorBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof GenRulesToObject<OW> ? (\n          GenRulesToObject<OW>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends GeneratorRule<Context, K> ? OtherRules[K] : never)\n                  : never\n            ) }\n    > {\n    // Assume the other grammar is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, GeneratorRule<Context>> = { ...GeneratorBuilder.rules };\n    const myRules: Record<string, GeneratorRule<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Rule with name \"${rule.name}\" already exists in the GeneratorBuilder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Construct a generator from the registered rules.\n   * @returns An object with a method for each registered rule name.\n   */\n  public build(): GeneratorFromRules<Context, Names, RuleDefs> {\n    return <GeneratorFromRules<Context, Names, RuleDefs>> new DynamicGenerator(this.rules);\n  }\n}\n"]}

dist/cjs/lib/indirection-builder/helpers.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../lib/indirection-builder/helpers.ts"],"names":[],"mappings":";;AA2BA,oDAMC;AATD;;GAEG;AACH,SAAgB,oBAAoB,CAAgC,KAAQ;IAC1E,MAAM,QAAQ,GAA6B,EAAE,CAAC;IAC9C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA+B,QAAQ,CAAC;AAC1C,CAAC","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\n\nexport type IndirDef<\n  Context = any,\n  NameType extends string = string,\n  ReturnType = unknown,\n  ParamType extends any[] = any[],\n> = {\n  name: NameType;\n  fun: (def: IndirDefArg) => (c: Context, ...params: ParamType) => ReturnType;\n};\n\nexport type IndirDefArg = {\n  /**\n   * Calls another rule using the provided arguments.\n   * @param rule\n   * @param arg\n   * @constructor\n   */\n  SUBRULE: <T, U extends any[]>(rule: IndirDef<any, any, T, U>, ...arg: U) => T;\n};\n\nexport type IndirectionMap<RuleNames extends string> = {[Key in RuleNames]: IndirDef<any, Key> };\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nexport function listToIndirectionMap<T extends readonly IndirDef[]>(rules: T): ParseIndirsToObject<T> {\n  const newRules: Record<string, IndirDef> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <ParseIndirsToObject<T>>newRules;\n}\n\n/**\n * Convert a list of IndirDefs to a Record with the name of the IndirDef as the key, matching the IndirectionMap type.\n */\nexport type ParseIndirsToObject<\n  T extends readonly IndirDef[],\n  Names extends string = ParseNamesFromList<T>,\n  Agg extends Record<string, IndirDef> = Record<never, never>,\n> = T extends readonly [infer First, ...infer Rest] ? (\n  First extends IndirDef ? (\n    Rest extends readonly IndirDef[] ? (\n      ParseIndirsToObject<Rest, Names, {[K in keyof Agg | First['name']]: K extends First['name'] ? First : Agg[K] }>\n    ) : never\n  ) : never\n) : IndirectionMap<Names> & Agg;\n\nexport type IndirectObjFromIndirDefs<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> = {\n  [K in Names]: RuleDefs[K] extends IndirDef<Context, K, infer RET, infer ARGS> ?\n      (context: Context, ...args: ARGS) => RET : never\n};\n"]}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../lib/indirection-builder/helpers.ts"],"names":[],"mappings":";;AA+CA,oDAMC;AATD;;GAEG;AACH,SAAgB,oBAAoB,CAAgC,KAAQ;IAC1E,MAAM,QAAQ,GAA6B,EAAE,CAAC;IAC9C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA+B,QAAQ,CAAC;AAC1C,CAAC","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\n\n/**\n * Definition of an indirection function, analogous to {@link ParserRule} for parsers\n * and {@link GeneratorRule} for generators.\n *\n * An indirection definition has a `name` and a `fun` function.\n * The `fun` function receives helper utilities (currently just `SUBRULE`) and returns\n * the actual implementation function that receives a context and optional parameters.\n *\n * @typeParam Context - Context object available in the function implementation.\n * @typeParam NameType - Name of the function, should be a string literal type (e.g., `'myFunction'`).\n * @typeParam ReturnType - Type returned by the function.\n * @typeParam ParamType - Tuple of additional parameter types beyond the context.\n */\nexport type IndirDef<\n  Context = any,\n  NameType extends string = string,\n  ReturnType = unknown,\n  ParamType extends any[] = any[],\n> = {\n  name: NameType;\n  fun: (def: IndirDefArg) => (c: Context, ...params: ParamType) => ReturnType;\n};\n\n/**\n * Helper utilities provided to {@link IndirDef.fun} implementations.\n * Currently exposes only `SUBRULE` for calling other indirection definitions.\n */\nexport type IndirDefArg = {\n  /**\n   * Calls another rule using the provided arguments.\n   * @param rule\n   * @param arg\n   * @constructor\n   */\n  SUBRULE: <T, U extends any[]>(rule: IndirDef<any, any, T, U>, ...arg: U) => T;\n};\n\n/**\n * Record type mapping rule names to their corresponding {@link IndirDef} definitions.\n */\nexport type IndirectionMap<RuleNames extends string> = {[Key in RuleNames]: IndirDef<any, Key> };\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nexport function listToIndirectionMap<T extends readonly IndirDef[]>(rules: T): ParseIndirsToObject<T> {\n  const newRules: Record<string, IndirDef> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <ParseIndirsToObject<T>>newRules;\n}\n\n/**\n * Convert a list of IndirDefs to a Record with the name of the IndirDef as the key, matching the IndirectionMap type.\n */\nexport type ParseIndirsToObject<\n  T extends readonly IndirDef[],\n  Names extends string = ParseNamesFromList<T>,\n  Agg extends Record<string, IndirDef> = Record<never, never>,\n> = T extends readonly [infer First, ...infer Rest] ? (\n  First extends IndirDef ? (\n    Rest extends readonly IndirDef[] ? (\n      ParseIndirsToObject<Rest, Names, {[K in keyof Agg | First['name']]: K extends First['name'] ? First : Agg[K] }>\n    ) : never\n  ) : never\n) : IndirectionMap<Names> & Agg;\n\n/**\n * The callable object type produced by {@link IndirBuilder.build}.\n * Maps each rule name to a function with the appropriate context and parameter types.\n */\nexport type IndirectObjFromIndirDefs<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> = {\n  [K in Names]: RuleDefs[K] extends IndirDef<Context, K, infer RET, infer ARGS> ?\n      (context: Context, ...args: ARGS) => RET : never\n};\n"]}

dist/cjs/lib/indirection-builder/IndirBuilder.js

@@ -6,2 +6,10 @@ "use strict";
 const helpers_js_1 = require("./helpers.js");
+/**
+ * Builder for composing modular transformation pipelines using indirection definitions.
+ * Functions registered through this builder call each other via SUBRULE, enabling the same
+ * modularity and extensibility as the parser and generator builders.
+ *
+ * Builders mutate internal state and return `this`.
+ * Always start by copying an existing builder with `IndirBuilder.create(existingBuilder)`.
+ */
 class IndirBuilder {
@@ -18,5 +26,16 @@ static create(start) {
     }
+    /**
+     * Narrow the builder's context type parameter to a more specific subtype.
+     * This is a zero-cost type-level operation — the builder instance is returned as-is
+     * but with updated type parameters.
+     */
     widenContext() {
         return this;
     }
+    /**
+     * Update the type signatures (return types and/or parameter types) of existing indirections
+     * without changing their implementations. Use this when a patched indirection changes the types
+     * flowing through downstream indirections that don't need new implementations.
+     * This is a zero-cost type-level operation.
+     */
     typePatch() {
@@ -51,2 +70,8 @@ return this;
     }
+    /**
+     * Add multiple indirection definitions at once using rest parameters.
+     * Provides better TypeScript type inference than calling {@link addRule} in a loop,
+     * but avoid passing too many at once as this can cause TypeScript compilation slowdowns.
+     * TypeScript errors if any name conflicts with an existing one.
+     */
     addMany(...rules) {
@@ -63,2 +88,6 @@ this.rules = { ...this.rules, ...(0, helpers_js_1.listToIndirectionMap)(rules) };
     }
+    /**
+     * Delete multiple indirection definitions by name in a single call.
+     * @param ruleNames - Names of the indirections to delete.
+     */
     deleteMany(...ruleNames) {
@@ -70,5 +99,48 @@ for (const name of ruleNames) {
     }
+    /**
+     * Retrieve an indirection definition by its name.
+     * Useful for inspecting or wrapping existing definitions when extending a pipeline.
+     * @param ruleName - The name of the indirection, type-checked against the builder's known names.
+     */
     getRule(ruleName) {
         return this.rules[ruleName];
     }
+    /**
+     * Merge this indirection builder with another.
+     * If the two builders both have a definition with the same name,
+     * no error will be thrown in case they map to the same object (by reference).
+     * If they map to a different object, an error will be thrown.
+     * To fix this problem, the overridingRules array should contain a definition with the same conflicting name,
+     * whose implementation will be used.
+     */
+    merge(builder, overridingRules) {
+        // Assume the other set is bigger than yours. So start from that one and add this one
+        const otherRules = { ...builder.rules };
+        const myRules = this.rules;
+        for (const rule of Object.values(myRules)) {
+            if (otherRules[rule.name] === undefined) {
+                otherRules[rule.name] = rule;
+            }
+            else {
+                const existingRule = otherRules[rule.name];
+                // If same rule, no issue, move on. Else
+                if (existingRule !== rule) {
+                    const override = overridingRules.find(x => x.name === rule.name);
+                    // If override specified, take override, else, inform user that there is a conflict
+                    if (override) {
+                        otherRules[rule.name] = override;
+                    }
+                    else {
+                        throw new Error(`Function with name "${rule.name}" already exists in the builder, specify an override to resolve conflict`);
+                    }
+                }
+            }
+        }
+        this.rules = otherRules;
+        return this;
+    }
+    /**
+     * Construct an indirection object from the registered definitions.
+     * @returns An object with a method for each registered indirection name.
+     */
     build() {
@@ -75,0 +147,0 @@ return new dynamicIndirected_js_1.DynamicIndirect(this.rules);

dist/cjs/lib/indirection-builder/IndirBuilder.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"IndirBuilder.js","sourceRoot":"","sources":["../../../../lib/indirection-builder/IndirBuilder.ts"],"names":[],"mappings":";;;AAEA,iEAAyD;AAEzD,6CAAoD;AAEpD,MAAa,YAAY;IAUhB,MAAM,CAAC,MAAM,CAMlB,KAAqD;QAErD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA0D,IAAI,YAAY,CAAC,IAAA,iCAAoB,EAAC,KAAK,CAAC,CAAC,CAAC;QAC1G,CAAC;QACD,OAAO,IAAI,YAAY,CAAC,EAAE,GAAiC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAEM,YAAY;QAOjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAEM,SAAS;QASd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAAsC;QAK/F,MAAM,IAAI,GAEE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAAqC;QAKtG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAAuC,IAAI,CAAC,KAAK,CAAC;QAC7D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;QACzE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAA6D;QAI7D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,IAAA,iCAAoB,EAAC,KAAK,CAAC,EAAE,CAAC;QAC/D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK;QACV,OAA4D,IAAI,sCAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9F,CAAC;CACF;AAlJD,oCAkJC","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\nimport type { CheckOverlap } from '../utils.js';\nimport { DynamicIndirect } from './dynamicIndirected.js';\nimport type { IndirDef, IndirectionMap, IndirectObjFromIndirDefs, ParseIndirsToObject } from './helpers.js';\nimport { listToIndirectionMap } from './helpers.js';\n\nexport class IndirBuilder<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> {\n  public static create<Context, Names extends string, RuleDefs extends IndirectionMap<Names>>(\n    args: IndirBuilder<Context, Names, RuleDefs>\n  ): IndirBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly IndirDef[] = readonly IndirDef[],\n    Context = Rules[0] extends IndirDef<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends IndirectionMap<Names> = ParseIndirsToObject<Rules>,\n  >(rules: Rules): IndirBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly IndirDef[] = readonly IndirDef[],\n    Context = Rules[0] extends IndirDef<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends IndirectionMap<Names> = ParseIndirsToObject<Rules>,\n  >(\n    start: Rules | IndirBuilder<Context, Names, RuleDefs>,\n  ): IndirBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <IndirBuilder<Context, Names, RuleDefs>> <unknown> new IndirBuilder(listToIndirectionMap(start));\n    }\n    return new IndirBuilder({ ...(<IndirBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  public widenContext<NewContext extends Context>(): IndirBuilder<\n    NewContext,\n    Names,\n    {[Key in keyof RuleDefs]: Key extends Names ?\n        (RuleDefs[Key] extends IndirDef<any, any, infer RT, infer PT> ? IndirDef<NewContext, Key, RT, PT> : never)\n      : never }\n  > {\n    return <any> this;\n  }\n\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  IndirBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? IndirDef<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only  one - infer arg yourself\n      Patch[Key] extends [ any ] ? (\n        RuleDefs[Key] extends IndirDef<any, any, any, infer Par> ? IndirDef<Context, Key, Patch[Key][0], Par> : never\n      ) : never\n    )\n  ) : (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never) }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing indirection.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: IndirDef<Context, U, RET, ARGS>):\n  IndirBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    IndirDef<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <IndirBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      IndirDef<Context, Key, RET, ARGS> : (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add an indirection function. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: IndirDef<Context, U, RET, ARGS>):\n  IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    IndirDef<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never)\n  }> {\n    const self = <IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n      IndirDef<Context, K, RET, ARGS> :\n        (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never) }>>\n      <unknown> this;\n    const rules = <Record<string, IndirDef<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Function ${rule.name} already exists in the builder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, IndirDef<Context, U, RET, ARGS>>,\n  ): IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    IndirDef<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never) }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  public addMany<U extends readonly IndirDef<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): IndirBuilder<\n    Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof ParseIndirsToObject<typeof rules> ? (\n        ParseIndirsToObject<typeof rules>[K] extends IndirDef<Context, K> ? ParseIndirsToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n  > {\n    this.rules = { ...this.rules, ...listToIndirectionMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }> {\n    for (const name of ruleNames) {\n      delete this.rules[name];\n    }\n    return <IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends IndirDef<any, U, infer RT, infer PT> ?\n    IndirDef<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  public build(): IndirectObjFromIndirDefs<Context, Names, RuleDefs> {\n    return <IndirectObjFromIndirDefs<Context, Names, RuleDefs>> new DynamicIndirect(this.rules);\n  }\n}\n"]}
+{"version":3,"file":"IndirBuilder.js","sourceRoot":"","sources":["../../../../lib/indirection-builder/IndirBuilder.ts"],"names":[],"mappings":";;;AAEA,iEAAyD;AAEzD,6CAAoD;AAEpD;;;;;;;GAOG;AACH,MAAa,YAAY;IAchB,MAAM,CAAC,MAAM,CAMlB,KAAqD;QAErD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA0D,IAAI,YAAY,CAAC,IAAA,iCAAoB,EAAC,KAAK,CAAC,CAAC,CAAC;QAC1G,CAAC;QACD,OAAO,IAAI,YAAY,CAAC,EAAE,GAAiC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,YAAY;QAOjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,SAAS;QASd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAAsC;QAK/F,MAAM,IAAI,GAEE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAAqC;QAKtG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAAuC,IAAI,CAAC,KAAK,CAAC;QAC7D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;QACzE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAA6D;QAI7D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,IAAA,iCAAoB,EAAC,KAAK,CAAC,EAAE,CAAC;QAC/D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAKV,OAAsD,EACtD,eAAmB;QAcnB,qFAAqF;QACrF,MAAM,UAAU,GAAsC,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC3E,MAAM,OAAO,GAAsC,IAAI,CAAC,KAAK,CAAC;QAE9D,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;oBAC9H,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAA4D,IAAI,sCAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9F,CAAC;CACF;AA1OD,oCA0OC","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\nimport type { CheckOverlap } from '../utils.js';\nimport { DynamicIndirect } from './dynamicIndirected.js';\nimport type { IndirDef, IndirectionMap, IndirectObjFromIndirDefs, ParseIndirsToObject } from './helpers.js';\nimport { listToIndirectionMap } from './helpers.js';\n\n/**\n * Builder for composing modular transformation pipelines using indirection definitions.\n * Functions registered through this builder call each other via SUBRULE, enabling the same\n * modularity and extensibility as the parser and generator builders.\n *\n * Builders mutate internal state and return `this`.\n * Always start by copying an existing builder with `IndirBuilder.create(existingBuilder)`.\n */\nexport class IndirBuilder<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> {\n  /**\n   * Create an IndirBuilder from initial indirection definitions or an existing builder.\n   * If a builder is provided, a new copy will be created.\n   */\n  public static create<Context, Names extends string, RuleDefs extends IndirectionMap<Names>>(\n    args: IndirBuilder<Context, Names, RuleDefs>\n  ): IndirBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly IndirDef[] = readonly IndirDef[],\n    Context = Rules[0] extends IndirDef<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends IndirectionMap<Names> = ParseIndirsToObject<Rules>,\n  >(rules: Rules): IndirBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly IndirDef[] = readonly IndirDef[],\n    Context = Rules[0] extends IndirDef<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends IndirectionMap<Names> = ParseIndirsToObject<Rules>,\n  >(\n    start: Rules | IndirBuilder<Context, Names, RuleDefs>,\n  ): IndirBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <IndirBuilder<Context, Names, RuleDefs>> <unknown> new IndirBuilder(listToIndirectionMap(start));\n    }\n    return new IndirBuilder({ ...(<IndirBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  /**\n   * Narrow the builder's context type parameter to a more specific subtype.\n   * This is a zero-cost type-level operation — the builder instance is returned as-is\n   * but with updated type parameters.\n   */\n  public widenContext<NewContext extends Context>(): IndirBuilder<\n    NewContext,\n    Names,\n    {[Key in keyof RuleDefs]: Key extends Names ?\n        (RuleDefs[Key] extends IndirDef<any, any, infer RT, infer PT> ? IndirDef<NewContext, Key, RT, PT> : never)\n      : never }\n  > {\n    return <any> this;\n  }\n\n  /**\n   * Update the type signatures (return types and/or parameter types) of existing indirections\n   * without changing their implementations. Use this when a patched indirection changes the types\n   * flowing through downstream indirections that don't need new implementations.\n   * This is a zero-cost type-level operation.\n   */\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  IndirBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? IndirDef<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only  one - infer arg yourself\n      Patch[Key] extends [ any ] ? (\n        RuleDefs[Key] extends IndirDef<any, any, any, infer Par> ? IndirDef<Context, Key, Patch[Key][0], Par> : never\n      ) : never\n    )\n  ) : (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never) }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing indirection.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: IndirDef<Context, U, RET, ARGS>):\n  IndirBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    IndirDef<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <IndirBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      IndirDef<Context, Key, RET, ARGS> : (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add an indirection function. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: IndirDef<Context, U, RET, ARGS>):\n  IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    IndirDef<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never)\n  }> {\n    const self = <IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n      IndirDef<Context, K, RET, ARGS> :\n        (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never) }>>\n      <unknown> this;\n    const rules = <Record<string, IndirDef<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Function ${rule.name} already exists in the builder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, IndirDef<Context, U, RET, ARGS>>,\n  ): IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    IndirDef<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never) }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  /**\n   * Add multiple indirection definitions at once using rest parameters.\n   * Provides better TypeScript type inference than calling {@link addRule} in a loop,\n   * but avoid passing too many at once as this can cause TypeScript compilation slowdowns.\n   * TypeScript errors if any name conflicts with an existing one.\n   */\n  public addMany<U extends readonly IndirDef<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): IndirBuilder<\n    Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof ParseIndirsToObject<typeof rules> ? (\n        ParseIndirsToObject<typeof rules>[K] extends IndirDef<Context, K> ? ParseIndirsToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n  > {\n    this.rules = { ...this.rules, ...listToIndirectionMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Delete multiple indirection definitions by name in a single call.\n   * @param ruleNames - Names of the indirections to delete.\n   */\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }> {\n    for (const name of ruleNames) {\n      delete this.rules[name];\n    }\n    return <IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Retrieve an indirection definition by its name.\n   * Useful for inspecting or wrapping existing definitions when extending a pipeline.\n   * @param ruleName - The name of the indirection, type-checked against the builder's known names.\n   */\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends IndirDef<any, U, infer RT, infer PT> ?\n    IndirDef<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this indirection builder with another.\n   * If the two builders both have a definition with the same name,\n   * no error will be thrown in case they map to the same object (by reference).\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a definition with the same conflicting name,\n   * whose implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends IndirectionMap<OtherNames>,\n    OW extends readonly IndirDef<Context>[],\n  >(\n    builder: IndirBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    IndirBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof ParseIndirsToObject<OW> ? (\n          ParseIndirsToObject<OW>[K] extends IndirDef<Context, K> ? ParseIndirsToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends IndirDef<Context, K> ? OtherRules[K] : never) : never\n            ) }\n    > {\n    // Assume the other set is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, IndirDef<Context>> = { ...builder.rules };\n    const myRules: Record<string, IndirDef<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Function with name \"${rule.name}\" already exists in the builder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Construct an indirection object from the registered definitions.\n   * @returns An object with a method for each registered indirection name.\n   */\n  public build(): IndirectObjFromIndirDefs<Context, Names, RuleDefs> {\n    return <IndirectObjFromIndirDefs<Context, Names, RuleDefs>> new DynamicIndirect(this.rules);\n  }\n}\n"]}

dist/cjs/lib/lexer-builder/LexerBuilder.js

@@ -5,4 +5,16 @@ "use strict";
 const chevrotain_1 = require("@traqula/chevrotain");
+/**
+ * Builder for constructing Chevrotain lexers with type-safe token management.
+ * Token ordering matters — the lexer matches the first token that fits, so more specific
+ * tokens (e.g., keywords) must be positioned before more general ones (e.g., identifiers).
+ *
+ * Builders mutate internal state and return `this`.
+ * Always start by copying an existing builder with `LexerBuilder.create(existingBuilder)`.
+ */
 class LexerBuilder {
     tokens;
+    /**
+     * Create a new LexerBuilder, optionally copying from an existing one.
+     * @param starter - An existing builder to copy tokens from. If omitted, starts empty.
+     */
     static create(starter) {
@@ -14,2 +26,9 @@ return new LexerBuilder(starter);
     }
+    /**
+     * Merge tokens from another LexerBuilder into this one.
+     * Duplicate tokens (by reference) are skipped. Different tokens with the same name
+     * cause an error unless an override is provided.
+     * @param merge - The other builder whose tokens to merge.
+     * @param overwrite - Tokens that take precedence when names conflict.
+     */
     merge(merge, overwrite = []) {
@@ -33,2 +52,7 @@ const extraTokens = merge.tokens.filter((token) => {
     }
+    /**
+     * Append tokens to the end of the builder's token list.
+     * TypeScript errors if a token name already exists.
+     * @param token - One or more tokens to add.
+     */
     add(...token) {
@@ -38,2 +62,7 @@ this.tokens.push(...token);
     }
+    /**
+     * Insert tokens before a specified reference token in the ordering.
+     * @param before - The existing token to insert before.
+     * @param token - One or more tokens to insert.
+     */
     addBefore(before, ...token) {
@@ -63,4 +92,6 @@ const index = this.tokens.indexOf(before);
     /**
-     * @param before token to move rest before
-     * @param tokens tokens to move before the first token
+     * Move existing tokens so they appear before a specified reference token.
+     * The tokens must already exist in the builder.
+     * @param before - The reference token to move before.
+     * @param tokens - The tokens to reposition.
      */
@@ -70,5 +101,16 @@ moveBefore(before, ...tokens) {
     }
+    /**
+     * Move existing tokens so they appear after a specified reference token.
+     * The tokens must already exist in the builder.
+     * @param after - The reference token to move after.
+     * @param tokens - The tokens to reposition.
+     */
     moveAfter(after, ...tokens) {
         return this.moveBeforeOrAfter('after', after, ...tokens);
     }
+    /**
+     * Insert tokens after a specified reference token in the ordering.
+     * @param after - The existing token to insert after.
+     * @param token - One or more tokens to insert.
+     */
     addAfter(after, ...token) {
@@ -82,2 +124,6 @@ const index = this.tokens.indexOf(after);
     }
+    /**
+     * Remove tokens from the builder by reference.
+     * @param token - One or more tokens to remove. Throws if a token is not found.
+     */
     delete(...token) {
@@ -93,2 +139,6 @@ for (const t of token) {
     }
+    /**
+     * Construct a Chevrotain {@link Lexer} from the current token ordering.
+     * @param lexerConfig - Optional Chevrotain lexer configuration overrides.
+     */
     build(lexerConfig) {
@@ -104,2 +154,6 @@ return new chevrotain_1.Lexer(this.tokens, {
     }
+    /**
+     * Get the current token list (readonly).
+     * Useful for passing to {@link ParserBuilder.build} as the `tokenVocabulary` argument.
+     */
     get tokenVocabulary() {
@@ -106,0 +160,0 @@ return this.tokens;

dist/cjs/lib/lexer-builder/LexerBuilder.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"LexerBuilder.js","sourceRoot":"","sources":["../../../../lib/lexer-builder/LexerBuilder.ts"],"names":[],"mappings":";;;AACA,oDAA4C;AAG5C,MAAa,YAAY;IACN,MAAM,CAAc;IAE9B,MAAM,CAAC,MAAM,CAAsD,OAAW;QACnF,OAAW,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,YAAoB,OAA6B;QAC/C,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAE,GAAG,OAAO,CAAC,MAAM,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,CAAC;IAEM,KAAK,CACV,KAA+B,EAC/B,YAA8B,EAAE;QAGhC,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YAChD,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAClE,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3D,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,CAAC,IAAI,6EAA6E,CAAC,CAAC;gBAC9H,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,GAAG,CAAsB,GAAG,KAAoD;QAErF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,SAAS,CACd,MAAyB,EACzB,GAAG,KAAoD;QAEvD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,iBAAiB,CACvB,aAAiC,EACjC,MAAyB,EACzB,GAAG,MAA4D;QAE/D,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvF,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,UAAU,CACf,MAAyB,EACzB,GAAG,MAA4D;QAE/D,OAAO,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;IAC7D,CAAC;IAEM,SAAS,CACd,KAAwB,EACxB,GAAG,MAA4D;QAE/D,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,CAAC;IAC3D,CAAC;IAEM,QAAQ,CACb,KAAwB,EACxB,GAAG,KAAoD;QAEvD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAqB,GAAG,KAAyB;QAC5D,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACrC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,WAA0B;QACrC,OAAO,IAAI,kBAAK,CAAC,IAAI,CAAC,MAAM,EAAE;YAC5B,gBAAgB,EAAE,WAAW;YAC7B,eAAe,EAAE,KAAK;YACtB,mBAAmB,EAAE,IAAI;YACzB,kBAAkB;YAClB,yBAAyB;YACzB,GAAG,WAAW;SACf,CAAC,CAAC;IACL,CAAC;IAED,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AA/HD,oCA+HC","sourcesContent":["import type { ILexerConfig, TokenType } from '@traqula/chevrotain';\nimport { Lexer } from '@traqula/chevrotain';\nimport type { CheckOverlap, NamedToken } from '../utils.js';\n\nexport class LexerBuilder<NAMES extends string = string> {\n  private readonly tokens: TokenType[];\n\n  public static create<U extends LexerBuilder<T>, T extends string = never>(starter?: U): U {\n    return <U> new LexerBuilder(starter);\n  }\n\n  private constructor(starter?: LexerBuilder<NAMES>) {\n    this.tokens = starter?.tokens ? [ ...starter.tokens ] : [];\n  }\n\n  public merge<OtherNames extends string, OW extends string>(\n    merge: LexerBuilder<OtherNames>,\n    overwrite: NamedToken<OW>[] = [],\n  ):\n    LexerBuilder<NAMES | OtherNames> {\n    const extraTokens = merge.tokens.filter((token) => {\n      const overwriteToken = overwrite.find(t => t.name === token.name);\n      if (overwriteToken) {\n        return false;\n      }\n      const match = this.tokens.find(t => t.name === token.name);\n      if (match) {\n        if (match !== token) {\n          throw new Error(`Token with name ${token.name} already exists. Implementation is different and no overwrite was provided.`);\n        }\n        return false;\n      }\n      return true;\n    });\n    this.tokens.push(...extraTokens);\n    return this;\n  }\n\n  public add<Name extends string>(...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>):\n  LexerBuilder<Name | NAMES> {\n    this.tokens.push(...token);\n    return this;\n  }\n\n  public addBefore<Name extends string>(\n    before: NamedToken<NAMES>,\n    ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES | Name> {\n    const index = this.tokens.indexOf(before);\n    if (index === -1) {\n      throw new Error('Token not found');\n    }\n    this.tokens.splice(index, 0, ...token);\n    return this;\n  }\n\n  private moveBeforeOrAfter<Name extends string>(\n    beforeOrAfter: 'before' | 'after',\n    before: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    const beforeIndex = this.tokens.indexOf(before) + (beforeOrAfter === 'before' ? 0 : 1);\n    if (beforeIndex === -1) {\n      throw new Error('BeforeToken not found');\n    }\n    for (const token of tokens) {\n      const tokenIndex = this.tokens.indexOf(token);\n      if (tokenIndex === -1) {\n        throw new Error('Token not found');\n      }\n      this.tokens.splice(tokenIndex, 1);\n      this.tokens.splice(beforeIndex, 0, token);\n    }\n    return this;\n  }\n\n  /**\n   * @param before token to move rest before\n   * @param tokens tokens to move before the first token\n   */\n  public moveBefore<Name extends string>(\n    before: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    return this.moveBeforeOrAfter('before', before, ...tokens);\n  }\n\n  public moveAfter<Name extends string>(\n    after: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    return this.moveBeforeOrAfter('after', after, ...tokens);\n  }\n\n  public addAfter<Name extends string>(\n    after: NamedToken<NAMES>,\n    ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES | Name> {\n    const index = this.tokens.indexOf(after);\n    if (index === -1) {\n      throw new Error('Token not found');\n    }\n    this.tokens.splice(index + 1, 0, ...token);\n    return this;\n  }\n\n  public delete<Name extends NAMES>(...token: NamedToken<Name>[]): LexerBuilder<Exclude<NAMES, Name>> {\n    for (const t of token) {\n      const index = this.tokens.indexOf(t);\n      if (index === -1) {\n        throw new Error('Token not found');\n      }\n      this.tokens.splice(index, 1);\n    }\n    return this;\n  }\n\n  public build(lexerConfig?: ILexerConfig): Lexer {\n    return new Lexer(this.tokens, {\n      positionTracking: 'onlyStart',\n      recoveryEnabled: false,\n      ensureOptimizations: true,\n      // SafeMode: true,\n      // SkipValidations: true,\n      ...lexerConfig,\n    });\n  }\n\n  public get tokenVocabulary(): readonly TokenType[] {\n    return this.tokens;\n  }\n}\n"]}
+{"version":3,"file":"LexerBuilder.js","sourceRoot":"","sources":["../../../../lib/lexer-builder/LexerBuilder.ts"],"names":[],"mappings":";;;AACA,oDAA4C;AAG5C;;;;;;;GAOG;AACH,MAAa,YAAY;IACN,MAAM,CAAc;IAErC;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAsD,OAAW;QACnF,OAAW,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,YAAoB,OAA6B;QAC/C,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAE,GAAG,OAAO,CAAC,MAAM,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CACV,KAA+B,EAC/B,YAA8B,EAAE;QAGhC,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YAChD,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAClE,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3D,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,CAAC,IAAI,6EAA6E,CAAC,CAAC;gBAC9H,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAsB,GAAG,KAAoD;QAErF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,SAAS,CACd,MAAyB,EACzB,GAAG,KAAoD;QAEvD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,iBAAiB,CACvB,aAAiC,EACjC,MAAyB,EACzB,GAAG,MAA4D;QAE/D,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvF,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,UAAU,CACf,MAAyB,EACzB,GAAG,MAA4D;QAE/D,OAAO,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,SAAS,CACd,KAAwB,EACxB,GAAG,MAA4D;QAE/D,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,QAAQ,CACb,KAAwB,EACxB,GAAG,KAAoD;QAEvD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,MAAM,CAAqB,GAAG,KAAyB;QAC5D,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACrC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAA0B;QACrC,OAAO,IAAI,kBAAK,CAAC,IAAI,CAAC,MAAM,EAAE;YAC5B,gBAAgB,EAAE,WAAW;YAC7B,eAAe,EAAE,KAAK;YACtB,mBAAmB,EAAE,IAAI;YACzB,kBAAkB;YAClB,yBAAyB;YACzB,GAAG,WAAW;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AA7KD,oCA6KC","sourcesContent":["import type { ILexerConfig, TokenType } from '@traqula/chevrotain';\nimport { Lexer } from '@traqula/chevrotain';\nimport type { CheckOverlap, NamedToken } from '../utils.js';\n\n/**\n * Builder for constructing Chevrotain lexers with type-safe token management.\n * Token ordering matters — the lexer matches the first token that fits, so more specific\n * tokens (e.g., keywords) must be positioned before more general ones (e.g., identifiers).\n *\n * Builders mutate internal state and return `this`.\n * Always start by copying an existing builder with `LexerBuilder.create(existingBuilder)`.\n */\nexport class LexerBuilder<NAMES extends string = string> {\n  private readonly tokens: TokenType[];\n\n  /**\n   * Create a new LexerBuilder, optionally copying from an existing one.\n   * @param starter - An existing builder to copy tokens from. If omitted, starts empty.\n   */\n  public static create<U extends LexerBuilder<T>, T extends string = never>(starter?: U): U {\n    return <U> new LexerBuilder(starter);\n  }\n\n  private constructor(starter?: LexerBuilder<NAMES>) {\n    this.tokens = starter?.tokens ? [ ...starter.tokens ] : [];\n  }\n\n  /**\n   * Merge tokens from another LexerBuilder into this one.\n   * Duplicate tokens (by reference) are skipped. Different tokens with the same name\n   * cause an error unless an override is provided.\n   * @param merge - The other builder whose tokens to merge.\n   * @param overwrite - Tokens that take precedence when names conflict.\n   */\n  public merge<OtherNames extends string, OW extends string>(\n    merge: LexerBuilder<OtherNames>,\n    overwrite: NamedToken<OW>[] = [],\n  ):\n    LexerBuilder<NAMES | OtherNames> {\n    const extraTokens = merge.tokens.filter((token) => {\n      const overwriteToken = overwrite.find(t => t.name === token.name);\n      if (overwriteToken) {\n        return false;\n      }\n      const match = this.tokens.find(t => t.name === token.name);\n      if (match) {\n        if (match !== token) {\n          throw new Error(`Token with name ${token.name} already exists. Implementation is different and no overwrite was provided.`);\n        }\n        return false;\n      }\n      return true;\n    });\n    this.tokens.push(...extraTokens);\n    return this;\n  }\n\n  /**\n   * Append tokens to the end of the builder's token list.\n   * TypeScript errors if a token name already exists.\n   * @param token - One or more tokens to add.\n   */\n  public add<Name extends string>(...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>):\n  LexerBuilder<Name | NAMES> {\n    this.tokens.push(...token);\n    return this;\n  }\n\n  /**\n   * Insert tokens before a specified reference token in the ordering.\n   * @param before - The existing token to insert before.\n   * @param token - One or more tokens to insert.\n   */\n  public addBefore<Name extends string>(\n    before: NamedToken<NAMES>,\n    ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES | Name> {\n    const index = this.tokens.indexOf(before);\n    if (index === -1) {\n      throw new Error('Token not found');\n    }\n    this.tokens.splice(index, 0, ...token);\n    return this;\n  }\n\n  private moveBeforeOrAfter<Name extends string>(\n    beforeOrAfter: 'before' | 'after',\n    before: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    const beforeIndex = this.tokens.indexOf(before) + (beforeOrAfter === 'before' ? 0 : 1);\n    if (beforeIndex === -1) {\n      throw new Error('BeforeToken not found');\n    }\n    for (const token of tokens) {\n      const tokenIndex = this.tokens.indexOf(token);\n      if (tokenIndex === -1) {\n        throw new Error('Token not found');\n      }\n      this.tokens.splice(tokenIndex, 1);\n      this.tokens.splice(beforeIndex, 0, token);\n    }\n    return this;\n  }\n\n  /**\n   * Move existing tokens so they appear before a specified reference token.\n   * The tokens must already exist in the builder.\n   * @param before - The reference token to move before.\n   * @param tokens - The tokens to reposition.\n   */\n  public moveBefore<Name extends string>(\n    before: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    return this.moveBeforeOrAfter('before', before, ...tokens);\n  }\n\n  /**\n   * Move existing tokens so they appear after a specified reference token.\n   * The tokens must already exist in the builder.\n   * @param after - The reference token to move after.\n   * @param tokens - The tokens to reposition.\n   */\n  public moveAfter<Name extends string>(\n    after: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    return this.moveBeforeOrAfter('after', after, ...tokens);\n  }\n\n  /**\n   * Insert tokens after a specified reference token in the ordering.\n   * @param after - The existing token to insert after.\n   * @param token - One or more tokens to insert.\n   */\n  public addAfter<Name extends string>(\n    after: NamedToken<NAMES>,\n    ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES | Name> {\n    const index = this.tokens.indexOf(after);\n    if (index === -1) {\n      throw new Error('Token not found');\n    }\n    this.tokens.splice(index + 1, 0, ...token);\n    return this;\n  }\n\n  /**\n   * Remove tokens from the builder by reference.\n   * @param token - One or more tokens to remove. Throws if a token is not found.\n   */\n  public delete<Name extends NAMES>(...token: NamedToken<Name>[]): LexerBuilder<Exclude<NAMES, Name>> {\n    for (const t of token) {\n      const index = this.tokens.indexOf(t);\n      if (index === -1) {\n        throw new Error('Token not found');\n      }\n      this.tokens.splice(index, 1);\n    }\n    return this;\n  }\n\n  /**\n   * Construct a Chevrotain {@link Lexer} from the current token ordering.\n   * @param lexerConfig - Optional Chevrotain lexer configuration overrides.\n   */\n  public build(lexerConfig?: ILexerConfig): Lexer {\n    return new Lexer(this.tokens, {\n      positionTracking: 'onlyStart',\n      recoveryEnabled: false,\n      ensureOptimizations: true,\n      // SafeMode: true,\n      // SkipValidations: true,\n      ...lexerConfig,\n    });\n  }\n\n  /**\n   * Get the current token list (readonly).\n   * Useful for passing to {@link ParserBuilder.build} as the `tokenVocabulary` argument.\n   */\n  public get tokenVocabulary(): readonly TokenType[] {\n    return this.tokens;\n  }\n}\n"]}

dist/cjs/lib/parser-builder/parserBuilder.js

@@ -38,5 +38,16 @@ "use strict";
     }
+    /**
+     * Narrow the builder's context type parameter to a more specific subtype.
+     * This is a zero-cost type-level operation — the builder instance is returned as-is
+     * but with updated type parameters.
+     */
     widenContext() {
         return this;
     }
+    /**
+     * Update the type signatures (return types and/or parameter types) of existing rules
+     * without changing their implementations. Use this when a patched rule changes the types
+     * flowing through downstream rules that don't need new implementations.
+     * This is a zero-cost type-level operation.
+     */
     typePatch() {
@@ -71,2 +82,8 @@ return this;
     }
+    /**
+     * Add multiple rules at once using rest parameters.
+     * Provides better TypeScript type inference than calling {@link addRule} in a loop,
+     * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.
+     * TypeScript errors if any rule name conflicts with an existing one.
+     */
     addMany(...rules) {
@@ -83,2 +100,6 @@ this.rules = { ...this.rules, ...listToRuleDefMap(rules) };
     }
+    /**
+     * Delete multiple rules by name in a single call.
+     * @param ruleNames - Names of the rules to delete.
+     */
     deleteMany(...ruleNames) {
@@ -90,2 +111,7 @@ for (const ruleName of ruleNames) {
     }
+    /**
+     * Retrieve a grammar rule definition by its name.
+     * Useful for inspecting or wrapping existing rules when extending a parser.
+     * @param ruleName - The name of the rule, type-checked against the builder's known rule names.
+     */
     getRule(ruleName) {
@@ -145,2 +171,8 @@ return this.rules[ruleName];
     }
+    /**
+     * Construct a self-sufficient parser from the registered rules and token vocabulary.
+     * Building a parser is expensive (Chevrotain performs grammar recording), so the result
+     * should be reused across parse calls.
+     * @returns An object with a method for each registered rule name.
+     */
     build({ tokenVocabulary, parserConfig = {}, lexerConfig = {}, queryPreProcessor = s => s, errorHandler, }) {
@@ -147,0 +179,0 @@ const lexer = LexerBuilder_js_1.LexerBuilder.create().add(...tokenVocabulary).build({

dist/cjs/lib/parser-builder/parserBuilder.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"parserBuilder.js","sourceRoot":"","sources":["../../../../lib/parser-builder/parserBuilder.ts"],"names":[],"mappings":";;;AAQA,sEAAgE;AAShE,yDAAmD;AAGnD;;GAEG;AACH,SAAS,gBAAgB,CAAkC,KAAQ;IACjE,MAAM,QAAQ,GAA+B,EAAE,CAAC;IAChD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA8B,QAAQ,CAAC;AACzC,CAAC;AAUD;;;;;GAKG;AACH,iDAAiD;AACjD,MAAa,aAAa;IACxB;;;OAGG;IACI,MAAM,CAAC,MAAM,CAMlB,KAAsD;QAEtD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA2D,IAAI,aAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QACxG,CAAC;QACD,OAAO,IAAI,aAAa,CAAC,EAAE,GAAkC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC/E,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAEM,YAAY;QAOjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAEM,SAAS;QAUd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAAwC;QAKjG,MAAM,IAAI,GAEE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAAuC;QAKxG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAAyC,IAAI,CAAC,KAAK,CAAC;QAC/D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;QACrE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAA+D;QAI/D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAKV,OAAuD,EACvD,eAAmB;QAcnB,yFAAyF;QACzF,MAAM,UAAU,GAAwC,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7E,MAAM,OAAO,GAAwC,IAAI,CAAC,KAAK,CAAC;QAEhE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;oBAC1H,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAEO,mBAAmB,CAAC,KAAa,EAAE,MAA+B;QACxE,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,cAAc,GAAa,CAAE,aAAa,CAAE,CAAC;QACnD,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACpD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;YACjD,cAAc,CAAC,IAAI,CAAC,YAAY,OAAO;EAC3C,SAAS,EAAE,CAAC,CAAC;YACT,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC;YAC/C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,cAAc,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QACD,cAAc,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,EACX,eAAe,EACf,YAAY,GAAG,EAAE,EACjB,WAAW,GAAG,EAAE,EAChB,iBAAiB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAC1B,YAAY,GACI;QAChB,MAAM,KAAK,GAAG,8BAAY,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC,KAAK,CAAC;YAChE,gBAAgB,EAAE,YAAY;YAC9B,eAAe,EAAE,KAAK;YACtB,mBAAmB,EAAE,IAAI;YACzB,QAAQ,EAAE,KAAK;YACf,eAAe,EAAE,IAAI;YACrB,GAAG,WAAW;SACf,CAAC,CAAC;QACH,4BAA4B;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;YAC1B,eAAe,EAAgB,eAAe;YAC9C,MAAM,EAAE,YAAY;SACrB,CAAC,CAAC;QACH,8GAA8G;QAC9G,MAAM,oBAAoB,GAAuD,EAAE,CAAC;QAEpF,gEAAgE;QAChE,4DAA4D;QAC5D,KAAK,MAAM,IAAI,IAAmC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5E,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAS,CAAC,CAAC,KAAa,EAAE,OAAgB,EAAE,GAAG,IAAe,EAAE,EAAE;gBAC/F,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;gBAChD,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAEjD,8BAA8B;gBAC9B,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC;gBAChC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;gBACnD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC7B,mDAAmD;oBACnD,IAAI,YAAY,EAAE,CAAC;wBACjB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC9B,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC1D,CAAC;gBACH,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAmD,oBAAoB,CAAC;IAC1E,CAAC;IAEO,OAAO,CAAC,EAAE,eAAe,EAAE,MAAM,GAAG,EAAE,EAG7C;QAEC,OACuD,IAAI,gCAAa,CAAC,IAAI,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;IAChH,CAAC;CACF;AA3QD,sCA2QC","sourcesContent":["import type {\n  ILexerConfig,\n  IParserConfig,\n  IRecognitionException,\n  TokenType,\n  TokenVocabulary,\n  EmbeddedActionsParser,\n} from '@traqula/chevrotain';\nimport { LexerBuilder } from '../lexer-builder/LexerBuilder.js';\nimport type { CheckOverlap } from '../utils.js';\nimport type {\n  ParseMethodsFromRules,\n  ParserFromRules,\n  ParseRuleMap,\n  ParseRulesToObject,\n  ParseNamesFromList,\n} from './builderTypes.js';\nimport { DynamicParser } from './dynamicParser.js';\nimport type { ParserRule } from './ruleDefTypes.js';\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nfunction listToRuleDefMap<T extends readonly ParserRule[]>(rules: T): ParseRulesToObject<T> {\n  const newRules: Record<string, ParserRule> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <ParseRulesToObject<T>>newRules;\n}\n\nexport interface ParserBuildArgs {\n  tokenVocabulary: readonly TokenType[];\n  parserConfig?: IParserConfig;\n  lexerConfig?: ILexerConfig;\n  queryPreProcessor?: (input: string) => string;\n  errorHandler?: (errors: IRecognitionException[]) => void;\n}\n\n/**\n * The grammar builder. This is the core of traqula (besides using the amazing chevrotain framework).\n * Using the builder you can create a grammar + AST creator.\n * At any point in time, a parser can be constructed from the added rules.\n * Constructing a parser will cause a validation which will validate the correctness of the grammar.\n */\n// This code is wild so other code can be simple.\nexport class ParserBuilder<Context, Names extends string, RuleDefs extends ParseRuleMap<Names>> {\n  /**\n   * Create a builder from some initial grammar rules or an existing builder.\n   * If a builder is provided, a new copy will be created.\n   */\n  public static create<\n    Rules extends readonly ParserRule[] = readonly ParserRule[],\n    Context = Rules[0] extends ParserRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends ParseRuleMap<Names> = ParseRulesToObject<Rules>,\n  >(\n    start: Rules | ParserBuilder<Context, Names, RuleDefs>,\n  ): ParserBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <ParserBuilder<Context, Names, RuleDefs>> <unknown> new ParserBuilder(listToRuleDefMap(start));\n    }\n    return new ParserBuilder({ ...(<ParserBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  public widenContext<NewContext extends Context>(): ParserBuilder<\n    NewContext,\nNames,\n{[Key in keyof RuleDefs]: Key extends Names ?\n    (RuleDefs[Key] extends ParserRule<any, any, infer RT, infer PT> ? ParserRule<NewContext, Key, RT, PT> : never)\n  : never }\n> {\n    return <any> this;\n  }\n\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  ParserBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? ParserRule<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only one - infer yourself\n      Patch[Key] extends [any] ? (\n        RuleDefs[Key] extends ParserRule<any, any, any, infer Par> ?\n          ParserRule<Context, Key, Patch[Key][0], Par> : never\n      ) : never\n    )\n  ) : (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never) }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing grammar rule.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: ParserRule<Context, U, RET, ARGS>):\n  ParserBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    ParserRule<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <ParserBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      ParserRule<Context, Key, RET, ARGS> : (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: ParserRule<Context, U, RET, ARGS>):\n  ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    ParserRule<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never)\n  }> {\n    const self = <ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n      ParserRule<Context, K, RET, ARGS> :\n        (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never) }>>\n      <unknown> this;\n    const rules = <Record<string, ParserRule<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Rule ${rule.name} already exists in the builder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, ParserRule<Context, U, RET, ARGS>>,\n  ): ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    ParserRule<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never) }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  public addMany<U extends readonly ParserRule<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): ParserBuilder<\n      Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof ParseRulesToObject<typeof rules> ? (\n        ParseRulesToObject<typeof rules>[K] extends ParserRule<Context, K> ? ParseRulesToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n    > {\n    this.rules = { ...this.rules, ...listToRuleDefMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }> {\n    for (const ruleName of ruleNames) {\n      delete this.rules[ruleName];\n    }\n    return <ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends ParserRule<any, U, infer RT, infer PT> ?\n    ParserRule<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this grammar builder with another.\n   * It is best to merge the bigger grammar with the smaller one.\n   * If the two builders both have a grammar rule with the same name,\n   * no error will be thrown case they map to the same ruledef object.\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,\n   * this rule implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends ParseRuleMap<OtherNames>,\n    OW extends readonly ParserRule<Context>[],\n  >(\n    builder: ParserBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    ParserBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof ParseRulesToObject<OW> ? (\n          ParseRulesToObject<OW>[K] extends ParserRule<Context, K> ? ParseRulesToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends ParserRule<Context, K> ? OtherRules[K] : never) : never\n            ) }\n    > {\n    // Assume the other grammar is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, ParserRule<Context>> = { ...builder.rules };\n    const myRules: Record<string, ParserRule<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Rule with name \"${rule.name}\" already exists in the builder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  private defaultErrorHandler(input: string, errors: IRecognitionException[]): void {\n    const firstError = errors[0];\n    const messageBuilder: string[] = [ 'Parse error' ];\n    const lineIdx = firstError.token.startLine;\n    if (lineIdx !== undefined && !Number.isNaN(lineIdx)) {\n      const errorLine = input.split('\\n')[lineIdx - 1];\n      messageBuilder.push(` on line ${lineIdx}\n${errorLine}`);\n      const columnIdx = firstError.token.startColumn;\n      if (columnIdx !== undefined) {\n        messageBuilder.push(`\\n${'-'.repeat(columnIdx - 1)}^`);\n      }\n    }\n    messageBuilder.push(`\\n${firstError.message}`);\n    throw new Error(messageBuilder.join(''));\n  }\n\n  public build({\n    tokenVocabulary,\n    parserConfig = {},\n    lexerConfig = {},\n    queryPreProcessor = s => s,\n    errorHandler,\n  }: ParserBuildArgs): ParserFromRules<Context, Names, RuleDefs> {\n    const lexer = LexerBuilder.create().add(...tokenVocabulary).build({\n      positionTracking: 'onlyOffset',\n      recoveryEnabled: false,\n      ensureOptimizations: true,\n      safeMode: false,\n      skipValidations: true,\n      ...lexerConfig,\n    });\n    // Get the chevrotain parser\n    const parser = this.consume({\n      tokenVocabulary: <TokenType[]> tokenVocabulary,\n      config: parserConfig,\n    });\n    // Start building a parser that does not pass input using a state, but instead gets it as a function argument.\n    const selfSufficientParser: Partial<ParserFromRules<Context, Names, RuleDefs>> = {};\n\n    // To do that, we need to create a wrapper for each parser rule.\n    // eslint-disable-next-line ts/no-unnecessary-type-assertion\n    for (const rule of <ParserRule<Context, Names>[]> Object.values(this.rules)) {\n      selfSufficientParser[rule.name] = <any> ((input: string, context: Context, ...args: unknown[]) => {\n        const processedInput = queryPreProcessor(input);\n        const lexResult = lexer.tokenize(processedInput);\n\n        // This also resets the parser\n        parser.input = lexResult.tokens;\n        parser.setContext(context);\n        const result = parser[rule.name](context, ...args);\n        if (parser.errors.length > 0) {\n          // Console.log(JSON.stringify(lexResult, null, 2));\n          if (errorHandler) {\n            errorHandler(parser.errors);\n          } else {\n            this.defaultErrorHandler(processedInput, parser.errors);\n          }\n        }\n        return result;\n      });\n    }\n    return <ParserFromRules<Context, Names, RuleDefs>> selfSufficientParser;\n  }\n\n  private consume({ tokenVocabulary, config = {}}: {\n    tokenVocabulary: TokenVocabulary;\n    config?: IParserConfig;\n  }): EmbeddedActionsParser & ParseMethodsFromRules<Context, Names, RuleDefs> &\n    { setContext: (context: Context) => void } {\n    return <EmbeddedActionsParser & ParseMethodsFromRules<Context, Names, RuleDefs> &\n      { setContext: (context: Context) => void }><unknown> new DynamicParser(this.rules, tokenVocabulary, config);\n  }\n}\n"]}
+{"version":3,"file":"parserBuilder.js","sourceRoot":"","sources":["../../../../lib/parser-builder/parserBuilder.ts"],"names":[],"mappings":";;;AAQA,sEAAgE;AAShE,yDAAmD;AAGnD;;GAEG;AACH,SAAS,gBAAgB,CAAkC,KAAQ;IACjE,MAAM,QAAQ,GAA+B,EAAE,CAAC;IAChD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA8B,QAAQ,CAAC;AACzC,CAAC;AAoBD;;;;;GAKG;AACH,iDAAiD;AACjD,MAAa,aAAa;IACxB;;;OAGG;IACI,MAAM,CAAC,MAAM,CAMlB,KAAsD;QAEtD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA2D,IAAI,aAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QACxG,CAAC;QACD,OAAO,IAAI,aAAa,CAAC,EAAE,GAAkC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC/E,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,YAAY;QAOjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,SAAS;QAUd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAAwC;QAKjG,MAAM,IAAI,GAEE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAAuC;QAKxG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAAyC,IAAI,CAAC,KAAK,CAAC;QAC/D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;QACrE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAA+D;QAI/D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAKV,OAAuD,EACvD,eAAmB;QAcnB,yFAAyF;QACzF,MAAM,UAAU,GAAwC,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7E,MAAM,OAAO,GAAwC,IAAI,CAAC,KAAK,CAAC;QAEhE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;oBAC1H,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAEO,mBAAmB,CAAC,KAAa,EAAE,MAA+B;QACxE,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,cAAc,GAAa,CAAE,aAAa,CAAE,CAAC;QACnD,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACpD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;YACjD,cAAc,CAAC,IAAI,CAAC,YAAY,OAAO;EAC3C,SAAS,EAAE,CAAC,CAAC;YACT,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC;YAC/C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,cAAc,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QACD,cAAc,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,EACX,eAAe,EACf,YAAY,GAAG,EAAE,EACjB,WAAW,GAAG,EAAE,EAChB,iBAAiB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAC1B,YAAY,GACI;QAChB,MAAM,KAAK,GAAG,8BAAY,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC,KAAK,CAAC;YAChE,gBAAgB,EAAE,YAAY;YAC9B,eAAe,EAAE,KAAK;YACtB,mBAAmB,EAAE,IAAI;YACzB,QAAQ,EAAE,KAAK;YACf,eAAe,EAAE,IAAI;YACrB,GAAG,WAAW;SACf,CAAC,CAAC;QACH,4BAA4B;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;YAC1B,eAAe,EAAgB,eAAe;YAC9C,MAAM,EAAE,YAAY;SACrB,CAAC,CAAC;QACH,8GAA8G;QAC9G,MAAM,oBAAoB,GAAuD,EAAE,CAAC;QAEpF,gEAAgE;QAChE,4DAA4D;QAC5D,KAAK,MAAM,IAAI,IAAmC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5E,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAS,CAAC,CAAC,KAAa,EAAE,OAAgB,EAAE,GAAG,IAAe,EAAE,EAAE;gBAC/F,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;gBAChD,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAEjD,8BAA8B;gBAC9B,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC;gBAChC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;gBACnD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC7B,mDAAmD;oBACnD,IAAI,YAAY,EAAE,CAAC;wBACjB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC9B,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC1D,CAAC;gBACH,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAmD,oBAAoB,CAAC;IAC1E,CAAC;IAEO,OAAO,CAAC,EAAE,eAAe,EAAE,MAAM,GAAG,EAAE,EAG7C;QAEC,OACuD,IAAI,gCAAa,CAAC,IAAI,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;IAChH,CAAC;CACF;AA3SD,sCA2SC","sourcesContent":["import type {\n  ILexerConfig,\n  IParserConfig,\n  IRecognitionException,\n  TokenType,\n  TokenVocabulary,\n  EmbeddedActionsParser,\n} from '@traqula/chevrotain';\nimport { LexerBuilder } from '../lexer-builder/LexerBuilder.js';\nimport type { CheckOverlap } from '../utils.js';\nimport type {\n  ParseMethodsFromRules,\n  ParserFromRules,\n  ParseRuleMap,\n  ParseRulesToObject,\n  ParseNamesFromList,\n} from './builderTypes.js';\nimport { DynamicParser } from './dynamicParser.js';\nimport type { ParserRule } from './ruleDefTypes.js';\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nfunction listToRuleDefMap<T extends readonly ParserRule[]>(rules: T): ParseRulesToObject<T> {\n  const newRules: Record<string, ParserRule> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <ParseRulesToObject<T>>newRules;\n}\n\n/**\n * Configuration for {@link ParserBuilder.build}. Specifies the token vocabulary,\n * optional Chevrotain parser/lexer configuration, and optional hooks for\n * preprocessing input or handling parse errors.\n */\nexport interface ParserBuildArgs {\n  /** The complete token vocabulary the parser and lexer should recognize. */\n  tokenVocabulary: readonly TokenType[];\n  /** Optional Chevrotain parser configuration (e.g., `maxLookahead`). */\n  parserConfig?: IParserConfig;\n  /** Optional Chevrotain lexer configuration (e.g., `positionTracking`). */\n  lexerConfig?: ILexerConfig;\n  /** Optional function to preprocess the input string before lexing. */\n  queryPreProcessor?: (input: string) => string;\n  /** Optional custom error handler. If omitted, a default handler throws on the first error. */\n  errorHandler?: (errors: IRecognitionException[]) => void;\n}\n\n/**\n * The grammar builder. This is the core of traqula (besides using the amazing chevrotain framework).\n * Using the builder you can create a grammar + AST creator.\n * At any point in time, a parser can be constructed from the added rules.\n * Constructing a parser will cause a validation which will validate the correctness of the grammar.\n */\n// This code is wild so other code can be simple.\nexport class ParserBuilder<Context, Names extends string, RuleDefs extends ParseRuleMap<Names>> {\n  /**\n   * Create a builder from some initial grammar rules or an existing builder.\n   * If a builder is provided, a new copy will be created.\n   */\n  public static create<\n    Rules extends readonly ParserRule[] = readonly ParserRule[],\n    Context = Rules[0] extends ParserRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends ParseRuleMap<Names> = ParseRulesToObject<Rules>,\n  >(\n    start: Rules | ParserBuilder<Context, Names, RuleDefs>,\n  ): ParserBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <ParserBuilder<Context, Names, RuleDefs>> <unknown> new ParserBuilder(listToRuleDefMap(start));\n    }\n    return new ParserBuilder({ ...(<ParserBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  /**\n   * Narrow the builder's context type parameter to a more specific subtype.\n   * This is a zero-cost type-level operation — the builder instance is returned as-is\n   * but with updated type parameters.\n   */\n  public widenContext<NewContext extends Context>(): ParserBuilder<\n    NewContext,\nNames,\n{[Key in keyof RuleDefs]: Key extends Names ?\n    (RuleDefs[Key] extends ParserRule<any, any, infer RT, infer PT> ? ParserRule<NewContext, Key, RT, PT> : never)\n  : never }\n> {\n    return <any> this;\n  }\n\n  /**\n   * Update the type signatures (return types and/or parameter types) of existing rules\n   * without changing their implementations. Use this when a patched rule changes the types\n   * flowing through downstream rules that don't need new implementations.\n   * This is a zero-cost type-level operation.\n   */\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  ParserBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? ParserRule<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only one - infer yourself\n      Patch[Key] extends [any] ? (\n        RuleDefs[Key] extends ParserRule<any, any, any, infer Par> ?\n          ParserRule<Context, Key, Patch[Key][0], Par> : never\n      ) : never\n    )\n  ) : (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never) }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing grammar rule.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: ParserRule<Context, U, RET, ARGS>):\n  ParserBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    ParserRule<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <ParserBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      ParserRule<Context, Key, RET, ARGS> : (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: ParserRule<Context, U, RET, ARGS>):\n  ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    ParserRule<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never)\n  }> {\n    const self = <ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n      ParserRule<Context, K, RET, ARGS> :\n        (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never) }>>\n      <unknown> this;\n    const rules = <Record<string, ParserRule<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Rule ${rule.name} already exists in the builder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, ParserRule<Context, U, RET, ARGS>>,\n  ): ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    ParserRule<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never) }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  /**\n   * Add multiple rules at once using rest parameters.\n   * Provides better TypeScript type inference than calling {@link addRule} in a loop,\n   * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.\n   * TypeScript errors if any rule name conflicts with an existing one.\n   */\n  public addMany<U extends readonly ParserRule<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): ParserBuilder<\n      Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof ParseRulesToObject<typeof rules> ? (\n        ParseRulesToObject<typeof rules>[K] extends ParserRule<Context, K> ? ParseRulesToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n    > {\n    this.rules = { ...this.rules, ...listToRuleDefMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Delete multiple rules by name in a single call.\n   * @param ruleNames - Names of the rules to delete.\n   */\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }> {\n    for (const ruleName of ruleNames) {\n      delete this.rules[ruleName];\n    }\n    return <ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Retrieve a grammar rule definition by its name.\n   * Useful for inspecting or wrapping existing rules when extending a parser.\n   * @param ruleName - The name of the rule, type-checked against the builder's known rule names.\n   */\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends ParserRule<any, U, infer RT, infer PT> ?\n    ParserRule<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this grammar builder with another.\n   * It is best to merge the bigger grammar with the smaller one.\n   * If the two builders both have a grammar rule with the same name,\n   * no error will be thrown case they map to the same ruledef object.\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,\n   * this rule implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends ParseRuleMap<OtherNames>,\n    OW extends readonly ParserRule<Context>[],\n  >(\n    builder: ParserBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    ParserBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof ParseRulesToObject<OW> ? (\n          ParseRulesToObject<OW>[K] extends ParserRule<Context, K> ? ParseRulesToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends ParserRule<Context, K> ? OtherRules[K] : never) : never\n            ) }\n    > {\n    // Assume the other grammar is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, ParserRule<Context>> = { ...builder.rules };\n    const myRules: Record<string, ParserRule<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Rule with name \"${rule.name}\" already exists in the builder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  private defaultErrorHandler(input: string, errors: IRecognitionException[]): void {\n    const firstError = errors[0];\n    const messageBuilder: string[] = [ 'Parse error' ];\n    const lineIdx = firstError.token.startLine;\n    if (lineIdx !== undefined && !Number.isNaN(lineIdx)) {\n      const errorLine = input.split('\\n')[lineIdx - 1];\n      messageBuilder.push(` on line ${lineIdx}\n${errorLine}`);\n      const columnIdx = firstError.token.startColumn;\n      if (columnIdx !== undefined) {\n        messageBuilder.push(`\\n${'-'.repeat(columnIdx - 1)}^`);\n      }\n    }\n    messageBuilder.push(`\\n${firstError.message}`);\n    throw new Error(messageBuilder.join(''));\n  }\n\n  /**\n   * Construct a self-sufficient parser from the registered rules and token vocabulary.\n   * Building a parser is expensive (Chevrotain performs grammar recording), so the result\n   * should be reused across parse calls.\n   * @returns An object with a method for each registered rule name.\n   */\n  public build({\n    tokenVocabulary,\n    parserConfig = {},\n    lexerConfig = {},\n    queryPreProcessor = s => s,\n    errorHandler,\n  }: ParserBuildArgs): ParserFromRules<Context, Names, RuleDefs> {\n    const lexer = LexerBuilder.create().add(...tokenVocabulary).build({\n      positionTracking: 'onlyOffset',\n      recoveryEnabled: false,\n      ensureOptimizations: true,\n      safeMode: false,\n      skipValidations: true,\n      ...lexerConfig,\n    });\n    // Get the chevrotain parser\n    const parser = this.consume({\n      tokenVocabulary: <TokenType[]> tokenVocabulary,\n      config: parserConfig,\n    });\n    // Start building a parser that does not pass input using a state, but instead gets it as a function argument.\n    const selfSufficientParser: Partial<ParserFromRules<Context, Names, RuleDefs>> = {};\n\n    // To do that, we need to create a wrapper for each parser rule.\n    // eslint-disable-next-line ts/no-unnecessary-type-assertion\n    for (const rule of <ParserRule<Context, Names>[]> Object.values(this.rules)) {\n      selfSufficientParser[rule.name] = <any> ((input: string, context: Context, ...args: unknown[]) => {\n        const processedInput = queryPreProcessor(input);\n        const lexResult = lexer.tokenize(processedInput);\n\n        // This also resets the parser\n        parser.input = lexResult.tokens;\n        parser.setContext(context);\n        const result = parser[rule.name](context, ...args);\n        if (parser.errors.length > 0) {\n          // Console.log(JSON.stringify(lexResult, null, 2));\n          if (errorHandler) {\n            errorHandler(parser.errors);\n          } else {\n            this.defaultErrorHandler(processedInput, parser.errors);\n          }\n        }\n        return result;\n      });\n    }\n    return <ParserFromRules<Context, Names, RuleDefs>> selfSufficientParser;\n  }\n\n  private consume({ tokenVocabulary, config = {}}: {\n    tokenVocabulary: TokenVocabulary;\n    config?: IParserConfig;\n  }): EmbeddedActionsParser & ParseMethodsFromRules<Context, Names, RuleDefs> &\n    { setContext: (context: Context) => void } {\n    return <EmbeddedActionsParser & ParseMethodsFromRules<Context, Names, RuleDefs> &\n      { setContext: (context: Context) => void }><unknown> new DynamicParser(this.rules, tokenVocabulary, config);\n  }\n}\n"]}

dist/cjs/lib/transformers/TransformerObject.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransformerObject = void 0;
+/**
+ * Base transformer class for recursively visiting and transforming object trees.
+ * Operates on plain JavaScript objects without requiring specific type structure.
+ *
+ * Uses an iterative (stack-based) algorithm instead of recursion to handle deep trees safely.
+ * Both {@link transformObject} and {@link visitObject} traverse depth-first, processing
+ * deeper objects before their parents (post-order).
+ *
+ * For type-aware traversal based on `type` and `subType` fields,
+ * see {@link TransformerTyped} and {@link TransformerSubTyped}.
+ */
 class TransformerObject {
@@ -5,0 +16,0 @@ defaultContext;

dist/cjs/lib/transformers/TransformerObject.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"TransformerObject.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerObject.ts"],"names":[],"mappings":";;;AAsCA,MAAa,iBAAiB;IAMU;IAL5B,YAAY,GAAG,SAAS,CAAC;IACnC;;;OAGG;IACH,YAAsC,iBAAmC,EAAE;QAArC,mBAAc,GAAd,cAAc,CAAuB;IAAG,CAAC;IAExE,KAAK,CAAC,oBAAsC,EAAE;QACnD,OAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,iBAAiB,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAI,GAAM;QACvB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAEzC,0BAA0B;QAC1B,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjD,6CAA6C;YAC7C,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;QACpB,CAAC;QAED,mDAAmD;QACnD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CACpB,WAAmB,EACnB,MAA+C,EAC/C,aAAiD,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAE3D,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC;QACrC,MAAM,eAAe,GAAG,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC;QAC9C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;QACnD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC9C,MAAM,kBAAkB,GAAG,QAAQ,CAAC,WAAW,CAAC;QAChD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,QAAQ,IAAI,KAAK,CAAC;QAEtD,6FAA6F;QAC7F,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,MAAM,UAAU,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC;QAExC,mBAAmB;QACnB,MAAM,KAAK,GAAG,CAAE,WAAW,CAAE,CAAC;QAC9B,MAAM,WAAW,GAAa,CAAE,UAAU,CAAE,CAAC;QAC7C,MAAM,cAAc,GAAa,CAAE,KAAK,CAAE,CAAC;QAE3C,uGAAuG;QACvG,iHAAiH;QACjH,MAAM,iBAAiB,GAAa,EAAE,CAAC;QACvC,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,eAAe,GAAa,EAAE,CAAC;QAErC,SAAS,YAAY;YACnB,OAAO,KAAK,CAAC,MAAM,KAAK,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjD,iBAAiB,CAAC,GAAG,EAAE,CAAC;gBACxB,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,MAAM,GAA6B,YAAY,CAAC,GAAG,EAAG,CAAC;gBAC7D,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5D,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAC/B,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAG,CAAC;YACrC,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,EAAG,CAAC;YAErC,kDAAkD;YAClD,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7B,MAAM,MAAM,GAAG,CAAE,GAAG,SAAS,CAAE,CAAC;oBAChC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;oBACrC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC7B,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAChC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAC7B,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAE7B,KAAK,IAAI,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;wBAC3D,MAAM,GAAG,GAAa,SAAS,CAAC,KAAK,CAAC,CAAC;wBACvC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAChB,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;4BACzB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;wBACxC,CAAC;oBACH,CAAC;oBACD,YAAY,EAAE,CAAC;oBACf,SAAS;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,UAAU,CAAM,SAAS,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,IAAI,eAAe,CAAC;gBACjD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;gBACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;gBAC3D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,kBAAkB,CAAC;gBAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,kBAAkB,CAAC;gBAErD,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAE7D,uCAAuC;gBACvC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACrC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3B,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAChC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC7B,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE7B,oGAAoG;gBACpG,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;wBACvB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;4BAC9B,SAAS;wBACX,CAAC;wBACD,MAAM,GAAG,GAA8B,IAAK,CAAC,GAAG,CAAC,CAAC;wBAElD,+BAA+B;wBAC/B,MAAM,WAAW,GAAG,WAAW,IAAI,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;wBACzD,IAAI,WAAW,EAAE,CAAC;4BAChB,gDAAgD;4BACrB,IAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;wBAC7D,CAAC;wBACD,IAAI,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;4BACtC,yBAAyB;4BACzB,SAAS;wBACX,CAAC;wBACD,IAAI,CAAC,WAAW,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5D,sBAAsB;4BACtB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAChB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BACzB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACzB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,YAAY,EAAE,CAAC;QACjB,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,YAAY,EAAE,CAAC;QAEf,OAAa,UAAU,CAAC,GAAG,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,WAAW,CAChB,WAAmB,EACnB,OAA+B,EAC/B,aAA6C,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAEvD,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC;QACrC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;QACnD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC9C,MAAM,eAAe,GAAG,QAAQ,CAAC,QAAQ,IAAI,KAAK,CAAC;QAEnD,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,8BAA8B;QAC9B,MAAM,KAAK,GAAG,CAAE,WAAW,CAAE,CAAC;QAC9B,iFAAiF;QACjF,MAAM,kBAAkB,GAAa,EAAE,CAAC;QACxC,MAAM,YAAY,GAAa,EAAE,CAAC;QAElC,SAAS,aAAa;YACpB,OAAO,KAAK,CAAC,MAAM,KAAK,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClD,kBAAkB,CAAC,GAAG,EAAE,CAAC;gBACzB,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,EAAG,CAAC;gBACpC,OAAO,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5D,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAE/B,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7B,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBAC/C,MAAM,GAAG,GAAa,SAAS,CAAC,CAAC,CAAC,CAAC;wBACnC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAClB,CAAC;oBACH,CAAC;oBACD,aAAa,EAAE,CAAC;oBAChB,SAAS;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;gBACtC,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC;gBAClD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;gBACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;gBAE3D,uCAAuC;gBACvC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACtC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAE7B,oGAAoG;gBACpG,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC9B,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;wBAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC;4BACnC,SAAS;wBACX,CAAC;wBACD,IAAI,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;4BACtC,SAAS;wBACX,CAAC;wBACD,MAAM,GAAG,GAA8B,SAAU,CAAC,GAAG,CAAC,CAAC;wBACvD,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BACnC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAClB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,aAAa,EAAE,CAAC;QAClB,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,aAAa,EAAE,CAAC;IAClB,CAAC;CACF;AAjPD,8CAiPC","sourcesContent":["export interface VisitContext {\n  /**\n   * Whether you should stop iterating after this object. Default false.\n   */\n  shortcut?: boolean;\n  /**\n   * Whether you should continue iterating deeper with this object. Default true.\n   */\n  continue?: boolean;\n  /**\n   * Object keys that can be ignored, meaning they do not get visited.\n   */\n  ignoreKeys?: Set<string>;\n}\n\nexport interface TransformContext extends VisitContext {\n  /**\n   * Object keys that will be shallowly copied but not traversed.\n   * When the same key is included here and in ignoreKeys, the copy will still be made.\n   */\n  shallowKeys?: Set<string>;\n  /**\n   * Whether the visited object should be shallowly copied or not. Defaults to true.\n   */\n  copy?: boolean;\n}\n\nexport interface SelectiveTraversalContext<Nodes> {\n  /**\n   * Nodes you should visit next. Defaults to empty list\n   */\n  next?: Nodes[];\n  /**\n   * Whether you should stop visiting after visiting this object. Default false.\n   */\n  shortcut?: boolean;\n}\n\nexport class TransformerObject {\n  protected maxStackSize = 1_000_000;\n  /**\n   * Creates stateless transformer.\n   * @param defaultContext\n   */\n  public constructor(protected readonly defaultContext: TransformContext = {}) {}\n\n  public clone(newDefaultContext: TransformContext = {}): TransformerObject {\n    return new TransformerObject({ ...this.defaultContext, ...newDefaultContext });\n  }\n\n  /**\n   * Function to shallow clone any type.\n   * @param obj\n   * @protected\n   */\n  public cloneObj<T>(obj: T): T {\n    if (obj === null || typeof obj !== 'object') {\n      return obj;\n    }\n\n    const proto = Object.getPrototypeOf(obj);\n\n    // Fast path: plain object\n    if (proto === Object.prototype || proto === null) {\n      // Spread or assign preserves fast properties\n      return { ...obj };\n    }\n\n    // Otherwise, preserve prototype for custom objects\n    return Object.assign(Object.create(proto), obj);\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: (copy: object, orig: object) => unknown,\n    preVisitor: (orig: object) => TransformContext = () => ({}),\n  ): unknown {\n    const defaults = this.defaultContext;\n    const defaultCopyFlag = defaults.copy ?? true;\n    const defaultContinues = defaults.continue ?? true;\n    const defaultIgnoreKeys = defaults.ignoreKeys;\n    const defaultShallowKeys = defaults.shallowKeys;\n    const defaultDidShortCut = defaults.shortcut ?? false;\n\n    // Code handles own stack instead of using recursion - this optimizes it for deep operations.\n    let didShortCut = false;\n    const resultWrap = { res: startObject };\n\n    // Grows with stack\n    const stack = [ startObject ];\n    const stackParent: object[] = [ resultWrap ];\n    const stackParentKey: string[] = [ 'res' ];\n\n    // Grows with reverse stack - when popping down the stack, you realise you still want to map something.\n    // Counter of stack size when we started adding the children of this object, going beyond this means a new parent\n    const handleMapperOnLen: number[] = [];\n    const mapperCopyStack: object[] = [];\n    const mapperOrigStack: object[] = [];\n    const mapperParent: object[] = [];\n    const mapperParentKey: string[] = [];\n\n    function handleMapper(): void {\n      while (stack.length === handleMapperOnLen.at(-1)) {\n        handleMapperOnLen.pop();\n        const copyToMap = mapperCopyStack.pop()!;\n        const origToMap = mapperOrigStack.pop()!;\n        const parent = <Record<string, unknown>> mapperParent.pop()!;\n        const parentKey = mapperParentKey.pop()!;\n        parent[parentKey] = mapper(copyToMap, origToMap);\n      }\n    }\n\n    while (stack.length > 0 && stack.length < this.maxStackSize) {\n      const curObject = stack.pop()!;\n      const curParent = stackParent.pop()!;\n      const curKey = stackParentKey.pop()!;\n\n      // Only add to the stack when you did not shortcut\n      if (!didShortCut) {\n        if (Array.isArray(curObject)) {\n          const newArr = [ ...curObject ];\n          handleMapperOnLen.push(stack.length);\n          mapperCopyStack.push(newArr);\n          mapperOrigStack.push(curObject);\n          mapperParent.push(curParent);\n          mapperParentKey.push(curKey);\n\n          for (let index = curObject.length - 1; index >= 0; index--) {\n            const val = <unknown> curObject[index];\n            if (val !== null && typeof val === 'object') {\n              stack.push(val);\n              stackParent.push(newArr);\n              stackParentKey.push(index.toString());\n            }\n          }\n          handleMapper();\n          continue;\n        }\n\n        // Perform pre visit before expanding the stack\n        const context = preVisitor(<any>curObject);\n        const copyFlag = context.copy ?? defaultCopyFlag;\n        const continues = context.continue ?? defaultContinues;\n        const ignoreKeys = context.ignoreKeys ?? defaultIgnoreKeys;\n        const shallowKeys = context.shallowKeys ?? defaultShallowKeys;\n        didShortCut = context.shortcut ?? defaultDidShortCut;\n\n        const copy = copyFlag ? this.cloneObj(curObject) : curObject;\n\n        // Register that you want to be visited\n        handleMapperOnLen.push(stack.length);\n        mapperCopyStack.push(copy);\n        mapperOrigStack.push(curObject);\n        mapperParent.push(curParent);\n        mapperParentKey.push(curKey);\n\n        // Extend stack if needed. When shortcutted, should still unwind the stack, but no longer add to it.\n        if (continues && !didShortCut) {\n          for (const key in copy) {\n            if (!Object.hasOwn(copy, key)) {\n              continue;\n            }\n            const val = (<Record<string, unknown>> copy)[key];\n\n            // If shallow copy required, do\n            const onlyShallow = shallowKeys && shallowKeys?.has(key);\n            if (onlyShallow) {\n              // Do not add stack entry - assign straight away\n              (<Record<string, unknown>> copy)[key] = this.cloneObj(val);\n            }\n            if (ignoreKeys && ignoreKeys.has(key)) {\n              // Do not add stack entry\n              continue;\n            }\n            if (!onlyShallow && val !== null && typeof val === 'object') {\n              // Do add stack entry.\n              stack.push(val);\n              stackParentKey.push(key);\n              stackParent.push(copy);\n            }\n          }\n        }\n      }\n      handleMapper();\n    }\n    if (stack.length >= this.maxStackSize) {\n      throw new Error('Transform object stack overflowed');\n    }\n    handleMapper();\n\n    return <any> resultWrap.res;\n  }\n\n  /**\n   * Visitor that visits all objects. Visits deeper objects first.\n   */\n  public visitObject(\n    startObject: object,\n    visitor: (orig: object) => void,\n    preVisitor: (orig: object) => VisitContext = () => ({}),\n  ): void {\n    const defaults = this.defaultContext;\n    const defaultContinues = defaults.continue ?? true;\n    const defaultIgnoreKeys = defaults.ignoreKeys;\n    const defaultShortcut = defaults.shortcut ?? false;\n\n    let didShortCut = false;\n\n    // Stack of things to preVisit\n    const stack = [ startObject ];\n    // When the stack is done preVisiting things above this lengths, visit the bellow\n    const handleVisitorOnLen: number[] = [];\n    const visitorStack: object[] = [];\n\n    function handleVisitor(): void {\n      while (stack.length === handleVisitorOnLen.at(-1)) {\n        handleVisitorOnLen.pop();\n        const toVisit = visitorStack.pop()!;\n        visitor(toVisit);\n      }\n    }\n\n    while (stack.length > 0 && stack.length < this.maxStackSize) {\n      const curObject = stack.pop()!;\n\n      if (!didShortCut) {\n        if (Array.isArray(curObject)) {\n          for (let i = curObject.length - 1; i >= 0; i--) {\n            const val = <unknown> curObject[i];\n            if (val !== null && typeof val === 'object') {\n              stack.push(val);\n            }\n          }\n          handleVisitor();\n          continue;\n        }\n\n        // Perform pre visit before expanding the stack\n        const context = preVisitor(curObject);\n        didShortCut = context.shortcut ?? defaultShortcut;\n        const continues = context.continue ?? defaultContinues;\n        const ignoreKeys = context.ignoreKeys ?? defaultIgnoreKeys;\n\n        // Register that you want to be visited\n        handleVisitorOnLen.push(stack.length);\n        visitorStack.push(curObject);\n\n        // Extend stack if needed. When shortcutted, should still unwind the stack, but no longer add to it.\n        if (continues && !didShortCut) {\n          for (const key in curObject) {\n            if (!Object.hasOwn(curObject, key)) {\n              continue;\n            }\n            if (ignoreKeys && ignoreKeys.has(key)) {\n              continue;\n            }\n            const val = (<Record<string, unknown>> curObject)[key];\n            if (val && typeof val === 'object') {\n              stack.push(val);\n            }\n          }\n        }\n      }\n      handleVisitor();\n    }\n    if (stack.length >= this.maxStackSize) {\n      throw new Error('Transform object stack overflowed');\n    }\n    handleVisitor();\n  }\n}\n"]}
+{"version":3,"file":"TransformerObject.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerObject.ts"],"names":[],"mappings":";;;AAsCA;;;;;;;;;;GAUG;AACH,MAAa,iBAAiB;IAMU;IAL5B,YAAY,GAAG,SAAS,CAAC;IACnC;;;OAGG;IACH,YAAsC,iBAAmC,EAAE;QAArC,mBAAc,GAAd,cAAc,CAAuB;IAAG,CAAC;IAExE,KAAK,CAAC,oBAAsC,EAAE;QACnD,OAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,iBAAiB,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAI,GAAM;QACvB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAEzC,0BAA0B;QAC1B,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjD,6CAA6C;YAC7C,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;QACpB,CAAC;QAED,mDAAmD;QACnD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CACpB,WAAmB,EACnB,MAA+C,EAC/C,aAAiD,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAE3D,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC;QACrC,MAAM,eAAe,GAAG,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC;QAC9C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;QACnD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC9C,MAAM,kBAAkB,GAAG,QAAQ,CAAC,WAAW,CAAC;QAChD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,QAAQ,IAAI,KAAK,CAAC;QAEtD,6FAA6F;QAC7F,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,MAAM,UAAU,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC;QAExC,mBAAmB;QACnB,MAAM,KAAK,GAAG,CAAE,WAAW,CAAE,CAAC;QAC9B,MAAM,WAAW,GAAa,CAAE,UAAU,CAAE,CAAC;QAC7C,MAAM,cAAc,GAAa,CAAE,KAAK,CAAE,CAAC;QAE3C,uGAAuG;QACvG,iHAAiH;QACjH,MAAM,iBAAiB,GAAa,EAAE,CAAC;QACvC,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,eAAe,GAAa,EAAE,CAAC;QAErC,SAAS,YAAY;YACnB,OAAO,KAAK,CAAC,MAAM,KAAK,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjD,iBAAiB,CAAC,GAAG,EAAE,CAAC;gBACxB,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,MAAM,GAA6B,YAAY,CAAC,GAAG,EAAG,CAAC;gBAC7D,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5D,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAC/B,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAG,CAAC;YACrC,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,EAAG,CAAC;YAErC,kDAAkD;YAClD,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7B,MAAM,MAAM,GAAG,CAAE,GAAG,SAAS,CAAE,CAAC;oBAChC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;oBACrC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC7B,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAChC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAC7B,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAE7B,KAAK,IAAI,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;wBAC3D,MAAM,GAAG,GAAa,SAAS,CAAC,KAAK,CAAC,CAAC;wBACvC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAChB,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;4BACzB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;wBACxC,CAAC;oBACH,CAAC;oBACD,YAAY,EAAE,CAAC;oBACf,SAAS;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,UAAU,CAAM,SAAS,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,IAAI,eAAe,CAAC;gBACjD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;gBACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;gBAC3D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,kBAAkB,CAAC;gBAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,kBAAkB,CAAC;gBAErD,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAE7D,uCAAuC;gBACvC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACrC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3B,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAChC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC7B,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE7B,oGAAoG;gBACpG,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;wBACvB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;4BAC9B,SAAS;wBACX,CAAC;wBACD,MAAM,GAAG,GAA8B,IAAK,CAAC,GAAG,CAAC,CAAC;wBAElD,+BAA+B;wBAC/B,MAAM,WAAW,GAAG,WAAW,IAAI,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;wBACzD,IAAI,WAAW,EAAE,CAAC;4BAChB,gDAAgD;4BACrB,IAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;wBAC7D,CAAC;wBACD,IAAI,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;4BACtC,yBAAyB;4BACzB,SAAS;wBACX,CAAC;wBACD,IAAI,CAAC,WAAW,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5D,sBAAsB;4BACtB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAChB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BACzB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACzB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,YAAY,EAAE,CAAC;QACjB,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,YAAY,EAAE,CAAC;QAEf,OAAa,UAAU,CAAC,GAAG,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,WAAW,CAChB,WAAmB,EACnB,OAA+B,EAC/B,aAA6C,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAEvD,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC;QACrC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;QACnD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC9C,MAAM,eAAe,GAAG,QAAQ,CAAC,QAAQ,IAAI,KAAK,CAAC;QAEnD,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,8BAA8B;QAC9B,MAAM,KAAK,GAAG,CAAE,WAAW,CAAE,CAAC;QAC9B,iFAAiF;QACjF,MAAM,kBAAkB,GAAa,EAAE,CAAC;QACxC,MAAM,YAAY,GAAa,EAAE,CAAC;QAElC,SAAS,aAAa;YACpB,OAAO,KAAK,CAAC,MAAM,KAAK,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClD,kBAAkB,CAAC,GAAG,EAAE,CAAC;gBACzB,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,EAAG,CAAC;gBACpC,OAAO,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5D,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAE/B,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7B,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBAC/C,MAAM,GAAG,GAAa,SAAS,CAAC,CAAC,CAAC,CAAC;wBACnC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAClB,CAAC;oBACH,CAAC;oBACD,aAAa,EAAE,CAAC;oBAChB,SAAS;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;gBACtC,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC;gBAClD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;gBACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;gBAE3D,uCAAuC;gBACvC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACtC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAE7B,oGAAoG;gBACpG,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC9B,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;wBAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC;4BACnC,SAAS;wBACX,CAAC;wBACD,IAAI,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;4BACtC,SAAS;wBACX,CAAC;wBACD,MAAM,GAAG,GAA8B,SAAU,CAAC,GAAG,CAAC,CAAC;wBACvD,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BACnC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAClB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,aAAa,EAAE,CAAC;QAClB,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,aAAa,EAAE,CAAC;IAClB,CAAC;CACF;AAjPD,8CAiPC","sourcesContent":["export interface VisitContext {\n  /**\n   * Whether you should stop iterating after this object. Default false.\n   */\n  shortcut?: boolean;\n  /**\n   * Whether you should continue iterating deeper with this object. Default true.\n   */\n  continue?: boolean;\n  /**\n   * Object keys that can be ignored, meaning they do not get visited.\n   */\n  ignoreKeys?: Set<string>;\n}\n\nexport interface TransformContext extends VisitContext {\n  /**\n   * Object keys that will be shallowly copied but not traversed.\n   * When the same key is included here and in ignoreKeys, the copy will still be made.\n   */\n  shallowKeys?: Set<string>;\n  /**\n   * Whether the visited object should be shallowly copied or not. Defaults to true.\n   */\n  copy?: boolean;\n}\n\nexport interface SelectiveTraversalContext<Nodes> {\n  /**\n   * Nodes you should visit next. Defaults to empty list\n   */\n  next?: Nodes[];\n  /**\n   * Whether you should stop visiting after visiting this object. Default false.\n   */\n  shortcut?: boolean;\n}\n\n/**\n * Base transformer class for recursively visiting and transforming object trees.\n * Operates on plain JavaScript objects without requiring specific type structure.\n *\n * Uses an iterative (stack-based) algorithm instead of recursion to handle deep trees safely.\n * Both {@link transformObject} and {@link visitObject} traverse depth-first, processing\n * deeper objects before their parents (post-order).\n *\n * For type-aware traversal based on `type` and `subType` fields,\n * see {@link TransformerTyped} and {@link TransformerSubTyped}.\n */\nexport class TransformerObject {\n  protected maxStackSize = 1_000_000;\n  /**\n   * Creates stateless transformer.\n   * @param defaultContext\n   */\n  public constructor(protected readonly defaultContext: TransformContext = {}) {}\n\n  public clone(newDefaultContext: TransformContext = {}): TransformerObject {\n    return new TransformerObject({ ...this.defaultContext, ...newDefaultContext });\n  }\n\n  /**\n   * Function to shallow clone any type.\n   * @param obj\n   * @protected\n   */\n  public cloneObj<T>(obj: T): T {\n    if (obj === null || typeof obj !== 'object') {\n      return obj;\n    }\n\n    const proto = Object.getPrototypeOf(obj);\n\n    // Fast path: plain object\n    if (proto === Object.prototype || proto === null) {\n      // Spread or assign preserves fast properties\n      return { ...obj };\n    }\n\n    // Otherwise, preserve prototype for custom objects\n    return Object.assign(Object.create(proto), obj);\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: (copy: object, orig: object) => unknown,\n    preVisitor: (orig: object) => TransformContext = () => ({}),\n  ): unknown {\n    const defaults = this.defaultContext;\n    const defaultCopyFlag = defaults.copy ?? true;\n    const defaultContinues = defaults.continue ?? true;\n    const defaultIgnoreKeys = defaults.ignoreKeys;\n    const defaultShallowKeys = defaults.shallowKeys;\n    const defaultDidShortCut = defaults.shortcut ?? false;\n\n    // Code handles own stack instead of using recursion - this optimizes it for deep operations.\n    let didShortCut = false;\n    const resultWrap = { res: startObject };\n\n    // Grows with stack\n    const stack = [ startObject ];\n    const stackParent: object[] = [ resultWrap ];\n    const stackParentKey: string[] = [ 'res' ];\n\n    // Grows with reverse stack - when popping down the stack, you realise you still want to map something.\n    // Counter of stack size when we started adding the children of this object, going beyond this means a new parent\n    const handleMapperOnLen: number[] = [];\n    const mapperCopyStack: object[] = [];\n    const mapperOrigStack: object[] = [];\n    const mapperParent: object[] = [];\n    const mapperParentKey: string[] = [];\n\n    function handleMapper(): void {\n      while (stack.length === handleMapperOnLen.at(-1)) {\n        handleMapperOnLen.pop();\n        const copyToMap = mapperCopyStack.pop()!;\n        const origToMap = mapperOrigStack.pop()!;\n        const parent = <Record<string, unknown>> mapperParent.pop()!;\n        const parentKey = mapperParentKey.pop()!;\n        parent[parentKey] = mapper(copyToMap, origToMap);\n      }\n    }\n\n    while (stack.length > 0 && stack.length < this.maxStackSize) {\n      const curObject = stack.pop()!;\n      const curParent = stackParent.pop()!;\n      const curKey = stackParentKey.pop()!;\n\n      // Only add to the stack when you did not shortcut\n      if (!didShortCut) {\n        if (Array.isArray(curObject)) {\n          const newArr = [ ...curObject ];\n          handleMapperOnLen.push(stack.length);\n          mapperCopyStack.push(newArr);\n          mapperOrigStack.push(curObject);\n          mapperParent.push(curParent);\n          mapperParentKey.push(curKey);\n\n          for (let index = curObject.length - 1; index >= 0; index--) {\n            const val = <unknown> curObject[index];\n            if (val !== null && typeof val === 'object') {\n              stack.push(val);\n              stackParent.push(newArr);\n              stackParentKey.push(index.toString());\n            }\n          }\n          handleMapper();\n          continue;\n        }\n\n        // Perform pre visit before expanding the stack\n        const context = preVisitor(<any>curObject);\n        const copyFlag = context.copy ?? defaultCopyFlag;\n        const continues = context.continue ?? defaultContinues;\n        const ignoreKeys = context.ignoreKeys ?? defaultIgnoreKeys;\n        const shallowKeys = context.shallowKeys ?? defaultShallowKeys;\n        didShortCut = context.shortcut ?? defaultDidShortCut;\n\n        const copy = copyFlag ? this.cloneObj(curObject) : curObject;\n\n        // Register that you want to be visited\n        handleMapperOnLen.push(stack.length);\n        mapperCopyStack.push(copy);\n        mapperOrigStack.push(curObject);\n        mapperParent.push(curParent);\n        mapperParentKey.push(curKey);\n\n        // Extend stack if needed. When shortcutted, should still unwind the stack, but no longer add to it.\n        if (continues && !didShortCut) {\n          for (const key in copy) {\n            if (!Object.hasOwn(copy, key)) {\n              continue;\n            }\n            const val = (<Record<string, unknown>> copy)[key];\n\n            // If shallow copy required, do\n            const onlyShallow = shallowKeys && shallowKeys?.has(key);\n            if (onlyShallow) {\n              // Do not add stack entry - assign straight away\n              (<Record<string, unknown>> copy)[key] = this.cloneObj(val);\n            }\n            if (ignoreKeys && ignoreKeys.has(key)) {\n              // Do not add stack entry\n              continue;\n            }\n            if (!onlyShallow && val !== null && typeof val === 'object') {\n              // Do add stack entry.\n              stack.push(val);\n              stackParentKey.push(key);\n              stackParent.push(copy);\n            }\n          }\n        }\n      }\n      handleMapper();\n    }\n    if (stack.length >= this.maxStackSize) {\n      throw new Error('Transform object stack overflowed');\n    }\n    handleMapper();\n\n    return <any> resultWrap.res;\n  }\n\n  /**\n   * Visitor that visits all objects. Visits deeper objects first.\n   */\n  public visitObject(\n    startObject: object,\n    visitor: (orig: object) => void,\n    preVisitor: (orig: object) => VisitContext = () => ({}),\n  ): void {\n    const defaults = this.defaultContext;\n    const defaultContinues = defaults.continue ?? true;\n    const defaultIgnoreKeys = defaults.ignoreKeys;\n    const defaultShortcut = defaults.shortcut ?? false;\n\n    let didShortCut = false;\n\n    // Stack of things to preVisit\n    const stack = [ startObject ];\n    // When the stack is done preVisiting things above this lengths, visit the bellow\n    const handleVisitorOnLen: number[] = [];\n    const visitorStack: object[] = [];\n\n    function handleVisitor(): void {\n      while (stack.length === handleVisitorOnLen.at(-1)) {\n        handleVisitorOnLen.pop();\n        const toVisit = visitorStack.pop()!;\n        visitor(toVisit);\n      }\n    }\n\n    while (stack.length > 0 && stack.length < this.maxStackSize) {\n      const curObject = stack.pop()!;\n\n      if (!didShortCut) {\n        if (Array.isArray(curObject)) {\n          for (let i = curObject.length - 1; i >= 0; i--) {\n            const val = <unknown> curObject[i];\n            if (val !== null && typeof val === 'object') {\n              stack.push(val);\n            }\n          }\n          handleVisitor();\n          continue;\n        }\n\n        // Perform pre visit before expanding the stack\n        const context = preVisitor(curObject);\n        didShortCut = context.shortcut ?? defaultShortcut;\n        const continues = context.continue ?? defaultContinues;\n        const ignoreKeys = context.ignoreKeys ?? defaultIgnoreKeys;\n\n        // Register that you want to be visited\n        handleVisitorOnLen.push(stack.length);\n        visitorStack.push(curObject);\n\n        // Extend stack if needed. When shortcutted, should still unwind the stack, but no longer add to it.\n        if (continues && !didShortCut) {\n          for (const key in curObject) {\n            if (!Object.hasOwn(curObject, key)) {\n              continue;\n            }\n            if (ignoreKeys && ignoreKeys.has(key)) {\n              continue;\n            }\n            const val = (<Record<string, unknown>> curObject)[key];\n            if (val && typeof val === 'object') {\n              stack.push(val);\n            }\n          }\n        }\n      }\n      handleVisitor();\n    }\n    if (stack.length >= this.maxStackSize) {\n      throw new Error('Transform object stack overflowed');\n    }\n    handleVisitor();\n  }\n}\n"]}

dist/cjs/lib/transformers/TransformerSubTyped.js

@@ -5,2 +5,15 @@ "use strict";
 const TransformerTyped_js_1 = require("./TransformerTyped.js");
+/**
+ * Most specific AST transformer that dispatches visit and transform callbacks
+ * based on both the `type` and `subType` fields of {@link SubTyped} nodes.
+ *
+ * Extends {@link TransformerTyped} with an additional dispatch level. When a callback
+ * is registered for a specific `(type, subType)` pair, it takes precedence over
+ * the type-only callback from {@link TransformerTyped.transformNode}.
+ *
+ * This is the recommended transformer for SPARQL ASTs where nodes have both
+ * type and subType discriminators (e.g., `{ type: 'term', subType: 'literal' }`).
+ *
+ * @typeParam Nodes - Union type of all node types this transformer handles.
+ */
 class TransformerSubTyped extends TransformerTyped_js_1.TransformerTyped {
@@ -7,0 +20,0 @@ constructor(defaultContext = {}, defaultNodePreVisitor = {}) {

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

@@ -1,1 +0,1 @@
-{"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"]}
+{"version":3,"file":"TransformerSubTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerSubTyped.ts"],"names":[],"mappings":";;;AAMA,+DAAyD;AAEzD;;;;;;;;;;;;GAYG;AACH,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\n/**\n * Most specific AST transformer that dispatches visit and transform callbacks\n * based on both the `type` and `subType` fields of {@link SubTyped} nodes.\n *\n * Extends {@link TransformerTyped} with an additional dispatch level. When a callback\n * is registered for a specific `(type, subType)` pair, it takes precedence over\n * the type-only callback from {@link TransformerTyped.transformNode}.\n *\n * This is the recommended transformer for SPARQL ASTs where nodes have both\n * type and subType discriminators (e.g., `{ type: 'term', subType: 'literal' }`).\n *\n * @typeParam Nodes - Union type of all node types this transformer handles.\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"]}

dist/cjs/lib/transformers/TransformerTyped.js

@@ -5,2 +5,15 @@ "use strict";
 const TransformerObject_js_1 = require("./TransformerObject.js");
+/**
+ * Type-aware AST transformer that dispatches visit and transform callbacks
+ * based on the `type` field of {@link Typed} nodes.
+ *
+ * Extends {@link TransformerObject} with node-type-specific dispatch, so you can
+ * register handlers per node type rather than filtering manually.
+ *
+ * For even more specific dispatch based on both `type` and `subType`,
+ * see {@link TransformerSubTyped}.
+ *
+ * @typeParam Nodes - Union type of all node types this transformer handles.
+ *   Each member must extend {@link Typed}.
+ */
 class TransformerTyped extends TransformerObject_js_1.TransformerObject {
@@ -7,0 +20,0 @@ defaultNodePreVisitor;

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

@@ -1,1 +0,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;;;;;;;;;;;;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"]}
+{"version":3,"file":"TransformerTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerTyped.ts"],"names":[],"mappings":";;;AAEA,iEAA2D;AAqB3D;;;;;;;;;;;;GAYG;AACH,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\n/**\n * Controls whether transform callbacks receive fully typed nodes (`'unsafe'`) or\n * nodes where all fields are `unknown` (`'safe'`). Using `'safe'` (the default)\n * forces explicit type narrowing, reducing the risk of incorrect assumptions.\n */\nexport type Safeness = 'safe' | 'unsafe';\n/**\n * Conditionally wraps an object type: in `'safe'` mode, all fields become `unknown`;\n * in `'unsafe'` mode, the original types are preserved.\n */\nexport type SafeWrap<Safe extends Safeness, obj extends object> =\n  Safe extends 'safe' ? {[key in keyof obj]: unknown } : obj;\n\n/**\n * Default pre-visitor configuration per node type. Provides default {@link TransformContext}\n * values that apply when no explicit preVisitor is given for a node type.\n */\nexport type DefaultNodePreVisitor<Nodes extends Typed> = {[T in Nodes['type']]?: TransformContext };\n\n/**\n * Type-aware AST transformer that dispatches visit and transform callbacks\n * based on the `type` field of {@link Typed} nodes.\n *\n * Extends {@link TransformerObject} with node-type-specific dispatch, so you can\n * register handlers per node type rather than filtering manually.\n *\n * For even more specific dispatch based on both `type` and `subType`,\n * see {@link TransformerSubTyped}.\n *\n * @typeParam Nodes - Union type of all node types this transformer handles.\n *   Each member must extend {@link Typed}.\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"]}

dist/esm/lib/generator-builder/generatorBuilder.d.ts

@@ -5,2 +5,10 @@ import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';
 import type { GeneratorRule } from './generatorTypes.js';
+/**
+ * Builder for composing modular code generators from rule definitions.
+ * Mirrors the {@link ParserBuilder} API but targets code generation (AST → string)
+ * instead of parsing (string → AST).
+ *
+ * Builders mutate internal state and return `this`.
+ * Always start by copying an existing builder with `GeneratorBuilder.create(existingBuilder)`.
+ */
 export declare class GeneratorBuilder<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> {
@@ -15,5 +23,16 @@ /**
     private constructor();
+    /**
+     * Narrow the builder's context type parameter to a more specific subtype.
+     * This is a zero-cost type-level operation — the builder instance is returned as-is
+     * but with updated type parameters.
+     */
     widenContext<NewContext extends Context>(): GeneratorBuilder<NewContext, Names, {
         [Key in keyof RuleDefs]: Key extends Names ? (RuleDefs[Key] extends GeneratorRule<any, any, infer RT, infer PT> ? GeneratorRule<NewContext, Key, RT, PT> : never) : never;
     }>;
+    /**
+     * Update the type signatures (return types and/or parameter types) of existing rules
+     * without changing their implementations. Use this when a patched rule changes the types
+     * flowing through downstream rules that don't need new implementations.
+     * This is a zero-cost type-level operation.
+     */
     typePatch<Patch extends {
@@ -42,2 +61,8 @@ [Key in Names]?: [any] | [any, any[]];
     }>;
+    /**
+     * Add multiple rules at once using rest parameters.
+     * Provides better TypeScript type inference than calling {@link addRule} in a loop,
+     * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.
+     * TypeScript errors if any rule name conflicts with an existing one.
+     */
     addMany<U extends readonly GeneratorRule<Context>[]>(...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>): GeneratorBuilder<Context, Names | ParseNamesFromList<U>, {
@@ -52,5 +77,14 @@ [K in Names | ParseNamesFromList<U>]: K extends keyof GenRulesToObject<typeof rules> ? (GenRulesToObject<typeof rules>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<typeof rules>[K] : never) : (K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : never);
     }>;
+    /**
+     * Delete multiple rules by name in a single call.
+     * @param ruleNames - Names of the rules to delete.
+     */
     deleteMany<U extends Names>(...ruleNames: U[]): GeneratorBuilder<Context, Exclude<Names, U>, {
         [K in Exclude<Names, U>]: RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never;
     }>;
+    /**
+     * Retrieve a generator rule definition by its name.
+     * Useful for inspecting or wrapping existing rules when extending a generator.
+     * @param ruleName - The name of the rule, type-checked against the builder's known rule names.
+     */
     getRule<U extends Names>(ruleName: U): RuleDefs[U] extends GeneratorRule<any, U, infer RT, infer PT> ? GeneratorRule<Context, U, RT, PT> : never;
@@ -69,3 +103,7 @@ /**
     }>;
+    /**
+     * Construct a generator from the registered rules.
+     * @returns An object with a method for each registered rule name.
+     */
     build(): GeneratorFromRules<Context, Names, RuleDefs>;
 }

dist/esm/lib/generator-builder/generatorBuilder.js

@@ -12,2 +12,10 @@ import { DynamicGenerator } from './dynamicGenerator.js';
 }
+/**
+ * Builder for composing modular code generators from rule definitions.
+ * Mirrors the {@link ParserBuilder} API but targets code generation (AST → string)
+ * instead of parsing (string → AST).
+ *
+ * Builders mutate internal state and return `this`.
+ * Always start by copying an existing builder with `GeneratorBuilder.create(existingBuilder)`.
+ */
 export class GeneratorBuilder {
@@ -24,5 +32,16 @@ static create(start) {
     }
+    /**
+     * Narrow the builder's context type parameter to a more specific subtype.
+     * This is a zero-cost type-level operation — the builder instance is returned as-is
+     * but with updated type parameters.
+     */
     widenContext() {
         return this;
     }
+    /**
+     * Update the type signatures (return types and/or parameter types) of existing rules
+     * without changing their implementations. Use this when a patched rule changes the types
+     * flowing through downstream rules that don't need new implementations.
+     * This is a zero-cost type-level operation.
+     */
     typePatch() {
@@ -57,2 +76,8 @@ return this;
     }
+    /**
+     * Add multiple rules at once using rest parameters.
+     * Provides better TypeScript type inference than calling {@link addRule} in a loop,
+     * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.
+     * TypeScript errors if any rule name conflicts with an existing one.
+     */
     addMany(...rules) {
@@ -69,2 +94,6 @@ this.rules = { ...this.rules, ...listToRuleDefMap(rules) };
     }
+    /**
+     * Delete multiple rules by name in a single call.
+     * @param ruleNames - Names of the rules to delete.
+     */
     deleteMany(...ruleNames) {
@@ -76,2 +105,7 @@ for (const name of ruleNames) {
     }
+    /**
+     * Retrieve a generator rule definition by its name.
+     * Useful for inspecting or wrapping existing rules when extending a generator.
+     * @param ruleName - The name of the rule, type-checked against the builder's known rule names.
+     */
     getRule(ruleName) {
@@ -115,2 +149,6 @@ return this.rules[ruleName];
     }
+    /**
+     * Construct a generator from the registered rules.
+     * @returns An object with a method for each registered rule name.
+     */
     build() {
@@ -117,0 +155,0 @@ return new DynamicGenerator(this.rules);

dist/esm/lib/generator-builder/generatorBuilder.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"generatorBuilder.js","sourceRoot":"","sources":["../../../../lib/generator-builder/generatorBuilder.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAGzD;;GAEG;AACH,SAAS,gBAAgB,CAAqC,KAAQ;IACpE,MAAM,QAAQ,GAAkC,EAAE,CAAC;IACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA4B,QAAQ,CAAC;AACvC,CAAC;AAED,MAAM,OAAO,gBAAgB;IAcpB,MAAM,CAAC,MAAM,CAMlB,KAAyD;QAEzD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA8D,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9G,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,EAAE,GAAqC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACrF,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAEM,YAAY;QAQjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAEM,SAAS;QAUd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAA2C;QAKpG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAA0C;QAK3G,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAA4C,IAAI,CAAC,KAAK,CAAC;QAClE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;QAC9E,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAAkE;QAKlE,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAKV,gBAAmE,EACnE,eAAmB;QAenB,yFAAyF;QACzF,MAAM,UAAU,GAA2C,EAAE,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC;QACzF,MAAM,OAAO,GAA2C,IAAI,CAAC,KAAK,CAAC;QAEnE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,IAAI,mFAAmF,CAAC,CAAC;oBACnI,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAEM,KAAK;QACV,OAAsD,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzF,CAAC;CACF","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\nimport type { CheckOverlap } from '../utils.js';\nimport type { GeneratorFromRules, GenRuleMap, GenRulesToObject } from './builderTypes.js';\nimport { DynamicGenerator } from './dynamicGenerator.js';\nimport type { GeneratorRule } from './generatorTypes.js';\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nfunction listToRuleDefMap<T extends readonly GeneratorRule[]>(rules: T): GenRulesToObject<T> {\n  const newRules: Record<string, GeneratorRule> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <GenRulesToObject<T>>newRules;\n}\n\nexport class GeneratorBuilder<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> {\n  /**\n   * Create a GeneratorBuilder from some initial grammar rules or an existing GeneratorBuilder.\n   * If a GeneratorBuilder is provided, a new copy will be created.\n   */\n  public static create<Context, Names extends string, RuleDefs extends GenRuleMap<Names>>(\n    args: GeneratorBuilder<Context, Names, RuleDefs>\n  ): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(rules: Rules): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(\n    start: Rules | GeneratorBuilder<Context, Names, RuleDefs>,\n  ): GeneratorBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <GeneratorBuilder<Context, Names, RuleDefs>> <unknown> new GeneratorBuilder(listToRuleDefMap(start));\n    }\n    return new GeneratorBuilder({ ...(<GeneratorBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  public widenContext<NewContext extends Context>(): GeneratorBuilder<\n    NewContext,\n    Names,\n    {[Key in keyof RuleDefs]: Key extends Names ?\n        (RuleDefs[Key] extends GeneratorRule<any, any, infer RT, infer PT> ?\n          GeneratorRule<NewContext, Key, RT, PT> : never)\n      : never }\n  > {\n    return <any> this;\n  }\n\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? GeneratorRule<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only  one - infer arg yourself\n      Patch[Key] extends [ any ] ?\n        RuleDefs[Key] extends GeneratorRule<any, any, any, infer Par> ?\n          GeneratorRule<Context, Key, Patch[Key][0], Par> : never\n        : never\n    )) : RuleDefs[Key] extends GeneratorRule<any, Key> ? RuleDefs[Key] : never\n  }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing generator rule.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    GeneratorRule<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      GeneratorRule<Context, Key, RET, ARGS> :\n        (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    const self = <GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n        (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n      : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never) }>>\n      <unknown> this;\n    const rules = <Record<string, GeneratorRule<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Rule ${rule.name} already exists in the GeneratorBuilder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, GeneratorRule<Context, U, RET, ARGS>>,\n  ): GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  public addMany<U extends readonly GeneratorRule<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): GeneratorBuilder<\n    Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof GenRulesToObject<typeof rules> ? (\n        GenRulesToObject<typeof rules>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n  > {\n    this.rules = { ...this.rules, ...listToRuleDefMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }> {\n    for (const name of ruleNames) {\n      delete this.rules[name];\n    }\n    return <GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends GeneratorRule<any, U, infer RT, infer PT> ?\n    GeneratorRule<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this grammar GeneratorBuilder with another.\n   * It is best to merge the bigger grammar with the smaller one.\n   * If the two builders both have a grammar rule with the same name,\n   * no error will be thrown case they map to the same ruledef object.\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,\n   * this rule implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends GenRuleMap<OtherNames>,\n    OW extends readonly GeneratorRule<Context>[],\n  >(\n    GeneratorBuilder: GeneratorBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    GeneratorBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof GenRulesToObject<OW> ? (\n          GenRulesToObject<OW>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends GeneratorRule<Context, K> ? OtherRules[K] : never)\n                  : never\n            ) }\n    > {\n    // Assume the other grammar is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, GeneratorRule<Context>> = { ...GeneratorBuilder.rules };\n    const myRules: Record<string, GeneratorRule<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Rule with name \"${rule.name}\" already exists in the GeneratorBuilder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  public build(): GeneratorFromRules<Context, Names, RuleDefs> {\n    return <GeneratorFromRules<Context, Names, RuleDefs>> new DynamicGenerator(this.rules);\n  }\n}\n"]}
+{"version":3,"file":"generatorBuilder.js","sourceRoot":"","sources":["../../../../lib/generator-builder/generatorBuilder.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAGzD;;GAEG;AACH,SAAS,gBAAgB,CAAqC,KAAQ;IACpE,MAAM,QAAQ,GAAkC,EAAE,CAAC;IACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA4B,QAAQ,CAAC;AACvC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,gBAAgB;IAcpB,MAAM,CAAC,MAAM,CAMlB,KAAyD;QAEzD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA8D,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9G,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,EAAE,GAAqC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACrF,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,YAAY;QAQjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,SAAS;QAUd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAA2C;QAKpG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAA0C;QAK3G,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAA4C,IAAI,CAAC,KAAK,CAAC;QAClE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;QAC9E,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAAkE;QAKlE,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAKV,gBAAmE,EACnE,eAAmB;QAenB,yFAAyF;QACzF,MAAM,UAAU,GAA2C,EAAE,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC;QACzF,MAAM,OAAO,GAA2C,IAAI,CAAC,KAAK,CAAC;QAEnE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,IAAI,mFAAmF,CAAC,CAAC;oBACnI,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAAsD,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzF,CAAC;CACF","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\nimport type { CheckOverlap } from '../utils.js';\nimport type { GeneratorFromRules, GenRuleMap, GenRulesToObject } from './builderTypes.js';\nimport { DynamicGenerator } from './dynamicGenerator.js';\nimport type { GeneratorRule } from './generatorTypes.js';\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nfunction listToRuleDefMap<T extends readonly GeneratorRule[]>(rules: T): GenRulesToObject<T> {\n  const newRules: Record<string, GeneratorRule> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <GenRulesToObject<T>>newRules;\n}\n\n/**\n * Builder for composing modular code generators from rule definitions.\n * Mirrors the {@link ParserBuilder} API but targets code generation (AST → string)\n * instead of parsing (string → AST).\n *\n * Builders mutate internal state and return `this`.\n * Always start by copying an existing builder with `GeneratorBuilder.create(existingBuilder)`.\n */\nexport class GeneratorBuilder<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> {\n  /**\n   * Create a GeneratorBuilder from some initial grammar rules or an existing GeneratorBuilder.\n   * If a GeneratorBuilder is provided, a new copy will be created.\n   */\n  public static create<Context, Names extends string, RuleDefs extends GenRuleMap<Names>>(\n    args: GeneratorBuilder<Context, Names, RuleDefs>\n  ): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(rules: Rules): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(\n    start: Rules | GeneratorBuilder<Context, Names, RuleDefs>,\n  ): GeneratorBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <GeneratorBuilder<Context, Names, RuleDefs>> <unknown> new GeneratorBuilder(listToRuleDefMap(start));\n    }\n    return new GeneratorBuilder({ ...(<GeneratorBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  /**\n   * Narrow the builder's context type parameter to a more specific subtype.\n   * This is a zero-cost type-level operation — the builder instance is returned as-is\n   * but with updated type parameters.\n   */\n  public widenContext<NewContext extends Context>(): GeneratorBuilder<\n    NewContext,\n    Names,\n    {[Key in keyof RuleDefs]: Key extends Names ?\n        (RuleDefs[Key] extends GeneratorRule<any, any, infer RT, infer PT> ?\n          GeneratorRule<NewContext, Key, RT, PT> : never)\n      : never }\n  > {\n    return <any> this;\n  }\n\n  /**\n   * Update the type signatures (return types and/or parameter types) of existing rules\n   * without changing their implementations. Use this when a patched rule changes the types\n   * flowing through downstream rules that don't need new implementations.\n   * This is a zero-cost type-level operation.\n   */\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? GeneratorRule<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only  one - infer arg yourself\n      Patch[Key] extends [ any ] ?\n        RuleDefs[Key] extends GeneratorRule<any, any, any, infer Par> ?\n          GeneratorRule<Context, Key, Patch[Key][0], Par> : never\n        : never\n    )) : RuleDefs[Key] extends GeneratorRule<any, Key> ? RuleDefs[Key] : never\n  }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing generator rule.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    GeneratorRule<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      GeneratorRule<Context, Key, RET, ARGS> :\n        (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    const self = <GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n        (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n      : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never) }>>\n      <unknown> this;\n    const rules = <Record<string, GeneratorRule<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Rule ${rule.name} already exists in the GeneratorBuilder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, GeneratorRule<Context, U, RET, ARGS>>,\n  ): GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  /**\n   * Add multiple rules at once using rest parameters.\n   * Provides better TypeScript type inference than calling {@link addRule} in a loop,\n   * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.\n   * TypeScript errors if any rule name conflicts with an existing one.\n   */\n  public addMany<U extends readonly GeneratorRule<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): GeneratorBuilder<\n    Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof GenRulesToObject<typeof rules> ? (\n        GenRulesToObject<typeof rules>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n  > {\n    this.rules = { ...this.rules, ...listToRuleDefMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Delete multiple rules by name in a single call.\n   * @param ruleNames - Names of the rules to delete.\n   */\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }> {\n    for (const name of ruleNames) {\n      delete this.rules[name];\n    }\n    return <GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Retrieve a generator rule definition by its name.\n   * Useful for inspecting or wrapping existing rules when extending a generator.\n   * @param ruleName - The name of the rule, type-checked against the builder's known rule names.\n   */\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends GeneratorRule<any, U, infer RT, infer PT> ?\n    GeneratorRule<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this grammar GeneratorBuilder with another.\n   * It is best to merge the bigger grammar with the smaller one.\n   * If the two builders both have a grammar rule with the same name,\n   * no error will be thrown case they map to the same ruledef object.\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,\n   * this rule implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends GenRuleMap<OtherNames>,\n    OW extends readonly GeneratorRule<Context>[],\n  >(\n    GeneratorBuilder: GeneratorBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    GeneratorBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof GenRulesToObject<OW> ? (\n          GenRulesToObject<OW>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends GeneratorRule<Context, K> ? OtherRules[K] : never)\n                  : never\n            ) }\n    > {\n    // Assume the other grammar is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, GeneratorRule<Context>> = { ...GeneratorBuilder.rules };\n    const myRules: Record<string, GeneratorRule<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Rule with name \"${rule.name}\" already exists in the GeneratorBuilder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Construct a generator from the registered rules.\n   * @returns An object with a method for each registered rule name.\n   */\n  public build(): GeneratorFromRules<Context, Names, RuleDefs> {\n    return <GeneratorFromRules<Context, Names, RuleDefs>> new DynamicGenerator(this.rules);\n  }\n}\n"]}

dist/esm/lib/indirection-builder/helpers.d.ts

 import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';
+/**
+ * Definition of an indirection function, analogous to {@link ParserRule} for parsers
+ * and {@link GeneratorRule} for generators.
+ *
+ * An indirection definition has a `name` and a `fun` function.
+ * The `fun` function receives helper utilities (currently just `SUBRULE`) and returns
+ * the actual implementation function that receives a context and optional parameters.
+ *
+ * @typeParam Context - Context object available in the function implementation.
+ * @typeParam NameType - Name of the function, should be a string literal type (e.g., `'myFunction'`).
+ * @typeParam ReturnType - Type returned by the function.
+ * @typeParam ParamType - Tuple of additional parameter types beyond the context.
+ */
 export type IndirDef<Context = any, NameType extends string = string, ReturnType = unknown, ParamType extends any[] = any[]> = {
@@ -6,2 +19,6 @@ name: NameType;
 };
+/**
+ * Helper utilities provided to {@link IndirDef.fun} implementations.
+ * Currently exposes only `SUBRULE` for calling other indirection definitions.
+ */
 export type IndirDefArg = {
@@ -16,2 +33,5 @@ /**
 };
+/**
+ * Record type mapping rule names to their corresponding {@link IndirDef} definitions.
+ */
 export type IndirectionMap<RuleNames extends string> = {
@@ -30,4 +50,8 @@ [Key in RuleNames]: IndirDef<any, Key>;
 }>) : never) : never) : IndirectionMap<Names> & Agg;
+/**
+ * The callable object type produced by {@link IndirBuilder.build}.
+ * Maps each rule name to a function with the appropriate context and parameter types.
+ */
 export type IndirectObjFromIndirDefs<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> = {
     [K in Names]: RuleDefs[K] extends IndirDef<Context, K, infer RET, infer ARGS> ? (context: Context, ...args: ARGS) => RET : never;
 };

dist/esm/lib/indirection-builder/helpers.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../lib/indirection-builder/helpers.ts"],"names":[],"mappings":"AAwBA;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAgC,KAAQ;IAC1E,MAAM,QAAQ,GAA6B,EAAE,CAAC;IAC9C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA+B,QAAQ,CAAC;AAC1C,CAAC","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\n\nexport type IndirDef<\n  Context = any,\n  NameType extends string = string,\n  ReturnType = unknown,\n  ParamType extends any[] = any[],\n> = {\n  name: NameType;\n  fun: (def: IndirDefArg) => (c: Context, ...params: ParamType) => ReturnType;\n};\n\nexport type IndirDefArg = {\n  /**\n   * Calls another rule using the provided arguments.\n   * @param rule\n   * @param arg\n   * @constructor\n   */\n  SUBRULE: <T, U extends any[]>(rule: IndirDef<any, any, T, U>, ...arg: U) => T;\n};\n\nexport type IndirectionMap<RuleNames extends string> = {[Key in RuleNames]: IndirDef<any, Key> };\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nexport function listToIndirectionMap<T extends readonly IndirDef[]>(rules: T): ParseIndirsToObject<T> {\n  const newRules: Record<string, IndirDef> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <ParseIndirsToObject<T>>newRules;\n}\n\n/**\n * Convert a list of IndirDefs to a Record with the name of the IndirDef as the key, matching the IndirectionMap type.\n */\nexport type ParseIndirsToObject<\n  T extends readonly IndirDef[],\n  Names extends string = ParseNamesFromList<T>,\n  Agg extends Record<string, IndirDef> = Record<never, never>,\n> = T extends readonly [infer First, ...infer Rest] ? (\n  First extends IndirDef ? (\n    Rest extends readonly IndirDef[] ? (\n      ParseIndirsToObject<Rest, Names, {[K in keyof Agg | First['name']]: K extends First['name'] ? First : Agg[K] }>\n    ) : never\n  ) : never\n) : IndirectionMap<Names> & Agg;\n\nexport type IndirectObjFromIndirDefs<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> = {\n  [K in Names]: RuleDefs[K] extends IndirDef<Context, K, infer RET, infer ARGS> ?\n      (context: Context, ...args: ARGS) => RET : never\n};\n"]}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../lib/indirection-builder/helpers.ts"],"names":[],"mappings":"AA4CA;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAgC,KAAQ;IAC1E,MAAM,QAAQ,GAA6B,EAAE,CAAC;IAC9C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA+B,QAAQ,CAAC;AAC1C,CAAC","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\n\n/**\n * Definition of an indirection function, analogous to {@link ParserRule} for parsers\n * and {@link GeneratorRule} for generators.\n *\n * An indirection definition has a `name` and a `fun` function.\n * The `fun` function receives helper utilities (currently just `SUBRULE`) and returns\n * the actual implementation function that receives a context and optional parameters.\n *\n * @typeParam Context - Context object available in the function implementation.\n * @typeParam NameType - Name of the function, should be a string literal type (e.g., `'myFunction'`).\n * @typeParam ReturnType - Type returned by the function.\n * @typeParam ParamType - Tuple of additional parameter types beyond the context.\n */\nexport type IndirDef<\n  Context = any,\n  NameType extends string = string,\n  ReturnType = unknown,\n  ParamType extends any[] = any[],\n> = {\n  name: NameType;\n  fun: (def: IndirDefArg) => (c: Context, ...params: ParamType) => ReturnType;\n};\n\n/**\n * Helper utilities provided to {@link IndirDef.fun} implementations.\n * Currently exposes only `SUBRULE` for calling other indirection definitions.\n */\nexport type IndirDefArg = {\n  /**\n   * Calls another rule using the provided arguments.\n   * @param rule\n   * @param arg\n   * @constructor\n   */\n  SUBRULE: <T, U extends any[]>(rule: IndirDef<any, any, T, U>, ...arg: U) => T;\n};\n\n/**\n * Record type mapping rule names to their corresponding {@link IndirDef} definitions.\n */\nexport type IndirectionMap<RuleNames extends string> = {[Key in RuleNames]: IndirDef<any, Key> };\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nexport function listToIndirectionMap<T extends readonly IndirDef[]>(rules: T): ParseIndirsToObject<T> {\n  const newRules: Record<string, IndirDef> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <ParseIndirsToObject<T>>newRules;\n}\n\n/**\n * Convert a list of IndirDefs to a Record with the name of the IndirDef as the key, matching the IndirectionMap type.\n */\nexport type ParseIndirsToObject<\n  T extends readonly IndirDef[],\n  Names extends string = ParseNamesFromList<T>,\n  Agg extends Record<string, IndirDef> = Record<never, never>,\n> = T extends readonly [infer First, ...infer Rest] ? (\n  First extends IndirDef ? (\n    Rest extends readonly IndirDef[] ? (\n      ParseIndirsToObject<Rest, Names, {[K in keyof Agg | First['name']]: K extends First['name'] ? First : Agg[K] }>\n    ) : never\n  ) : never\n) : IndirectionMap<Names> & Agg;\n\n/**\n * The callable object type produced by {@link IndirBuilder.build}.\n * Maps each rule name to a function with the appropriate context and parameter types.\n */\nexport type IndirectObjFromIndirDefs<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> = {\n  [K in Names]: RuleDefs[K] extends IndirDef<Context, K, infer RET, infer ARGS> ?\n      (context: Context, ...args: ARGS) => RET : never\n};\n"]}

dist/esm/lib/indirection-builder/IndirBuilder.d.ts

 import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';
 import type { CheckOverlap } from '../utils.js';
 import type { IndirDef, IndirectionMap, IndirectObjFromIndirDefs, ParseIndirsToObject } from './helpers.js';
+/**
+ * Builder for composing modular transformation pipelines using indirection definitions.
+ * Functions registered through this builder call each other via SUBRULE, enabling the same
+ * modularity and extensibility as the parser and generator builders.
+ *
+ * Builders mutate internal state and return `this`.
+ * Always start by copying an existing builder with `IndirBuilder.create(existingBuilder)`.
+ */
 export declare class IndirBuilder<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> {
+    /**
+     * Create an IndirBuilder from initial indirection definitions or an existing builder.
+     * If a builder is provided, a new copy will be created.
+     */
     static create<Context, Names extends string, RuleDefs extends IndirectionMap<Names>>(args: IndirBuilder<Context, Names, RuleDefs>): IndirBuilder<Context, Names, RuleDefs>;
@@ -9,5 +21,16 @@ static create<Rules extends readonly IndirDef[] = readonly IndirDef[], Context = Rules[0] extends IndirDef<infer context> ? context : never, Names extends string = ParseNamesFromList<Rules>, RuleDefs extends IndirectionMap<Names> = ParseIndirsToObject<Rules>>(rules: Rules): IndirBuilder<Context, Names, RuleDefs>;
     private constructor();
+    /**
+     * Narrow the builder's context type parameter to a more specific subtype.
+     * This is a zero-cost type-level operation — the builder instance is returned as-is
+     * but with updated type parameters.
+     */
     widenContext<NewContext extends Context>(): IndirBuilder<NewContext, Names, {
         [Key in keyof RuleDefs]: Key extends Names ? (RuleDefs[Key] extends IndirDef<any, any, infer RT, infer PT> ? IndirDef<NewContext, Key, RT, PT> : never) : never;
     }>;
+    /**
+     * Update the type signatures (return types and/or parameter types) of existing indirections
+     * without changing their implementations. Use this when a patched indirection changes the types
+     * flowing through downstream indirections that don't need new implementations.
+     * This is a zero-cost type-level operation.
+     */
     typePatch<Patch extends {
@@ -36,2 +59,8 @@ [Key in Names]?: [any] | [any, any[]];
     }>;
+    /**
+     * Add multiple indirection definitions at once using rest parameters.
+     * Provides better TypeScript type inference than calling {@link addRule} in a loop,
+     * but avoid passing too many at once as this can cause TypeScript compilation slowdowns.
+     * TypeScript errors if any name conflicts with an existing one.
+     */
     addMany<U extends readonly IndirDef<Context>[]>(...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>): IndirBuilder<Context, Names | ParseNamesFromList<U>, {
@@ -46,7 +75,31 @@ [K in Names | ParseNamesFromList<U>]: K extends keyof ParseIndirsToObject<typeof rules> ? (ParseIndirsToObject<typeof rules>[K] extends IndirDef<Context, K> ? ParseIndirsToObject<typeof rules>[K] : never) : (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never);
     }>;
+    /**
+     * Delete multiple indirection definitions by name in a single call.
+     * @param ruleNames - Names of the indirections to delete.
+     */
     deleteMany<U extends Names>(...ruleNames: U[]): IndirBuilder<Context, Exclude<Names, U>, {
         [K in Exclude<Names, U>]: RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never;
     }>;
+    /**
+     * Retrieve an indirection definition by its name.
+     * Useful for inspecting or wrapping existing definitions when extending a pipeline.
+     * @param ruleName - The name of the indirection, type-checked against the builder's known names.
+     */
     getRule<U extends Names>(ruleName: U): RuleDefs[U] extends IndirDef<any, U, infer RT, infer PT> ? IndirDef<Context, U, RT, PT> : never;
+    /**
+     * Merge this indirection builder with another.
+     * If the two builders both have a definition with the same name,
+     * no error will be thrown in case they map to the same object (by reference).
+     * If they map to a different object, an error will be thrown.
+     * To fix this problem, the overridingRules array should contain a definition with the same conflicting name,
+     * whose implementation will be used.
+     */
+    merge<OtherNames extends string, OtherRules extends IndirectionMap<OtherNames>, OW extends readonly IndirDef<Context>[]>(builder: IndirBuilder<Context, OtherNames, OtherRules>, overridingRules: OW): IndirBuilder<Context, Names | OtherNames | ParseNamesFromList<OW>, {
+        [K in Names | OtherNames | ParseNamesFromList<OW>]: K extends keyof ParseIndirsToObject<OW> ? (ParseIndirsToObject<OW>[K] extends IndirDef<Context, K> ? ParseIndirsToObject<OW>[K] : never) : (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : K extends OtherNames ? (OtherRules[K] extends IndirDef<Context, K> ? OtherRules[K] : never) : never);
+    }>;
+    /**
+     * Construct an indirection object from the registered definitions.
+     * @returns An object with a method for each registered indirection name.
+     */
     build(): IndirectObjFromIndirDefs<Context, Names, RuleDefs>;
 }

dist/esm/lib/indirection-builder/IndirBuilder.js

 import { DynamicIndirect } from './dynamicIndirected.js';
 import { listToIndirectionMap } from './helpers.js';
+/**
+ * Builder for composing modular transformation pipelines using indirection definitions.
+ * Functions registered through this builder call each other via SUBRULE, enabling the same
+ * modularity and extensibility as the parser and generator builders.
+ *
+ * Builders mutate internal state and return `this`.
+ * Always start by copying an existing builder with `IndirBuilder.create(existingBuilder)`.
+ */
 export class IndirBuilder {
@@ -14,5 +22,16 @@ static create(start) {
     }
+    /**
+     * Narrow the builder's context type parameter to a more specific subtype.
+     * This is a zero-cost type-level operation — the builder instance is returned as-is
+     * but with updated type parameters.
+     */
     widenContext() {
         return this;
     }
+    /**
+     * Update the type signatures (return types and/or parameter types) of existing indirections
+     * without changing their implementations. Use this when a patched indirection changes the types
+     * flowing through downstream indirections that don't need new implementations.
+     * This is a zero-cost type-level operation.
+     */
     typePatch() {
@@ -47,2 +66,8 @@ return this;
     }
+    /**
+     * Add multiple indirection definitions at once using rest parameters.
+     * Provides better TypeScript type inference than calling {@link addRule} in a loop,
+     * but avoid passing too many at once as this can cause TypeScript compilation slowdowns.
+     * TypeScript errors if any name conflicts with an existing one.
+     */
     addMany(...rules) {
@@ -59,2 +84,6 @@ this.rules = { ...this.rules, ...listToIndirectionMap(rules) };
     }
+    /**
+     * Delete multiple indirection definitions by name in a single call.
+     * @param ruleNames - Names of the indirections to delete.
+     */
     deleteMany(...ruleNames) {
@@ -66,5 +95,48 @@ for (const name of ruleNames) {
     }
+    /**
+     * Retrieve an indirection definition by its name.
+     * Useful for inspecting or wrapping existing definitions when extending a pipeline.
+     * @param ruleName - The name of the indirection, type-checked against the builder's known names.
+     */
     getRule(ruleName) {
         return this.rules[ruleName];
     }
+    /**
+     * Merge this indirection builder with another.
+     * If the two builders both have a definition with the same name,
+     * no error will be thrown in case they map to the same object (by reference).
+     * If they map to a different object, an error will be thrown.
+     * To fix this problem, the overridingRules array should contain a definition with the same conflicting name,
+     * whose implementation will be used.
+     */
+    merge(builder, overridingRules) {
+        // Assume the other set is bigger than yours. So start from that one and add this one
+        const otherRules = { ...builder.rules };
+        const myRules = this.rules;
+        for (const rule of Object.values(myRules)) {
+            if (otherRules[rule.name] === undefined) {
+                otherRules[rule.name] = rule;
+            }
+            else {
+                const existingRule = otherRules[rule.name];
+                // If same rule, no issue, move on. Else
+                if (existingRule !== rule) {
+                    const override = overridingRules.find(x => x.name === rule.name);
+                    // If override specified, take override, else, inform user that there is a conflict
+                    if (override) {
+                        otherRules[rule.name] = override;
+                    }
+                    else {
+                        throw new Error(`Function with name "${rule.name}" already exists in the builder, specify an override to resolve conflict`);
+                    }
+                }
+            }
+        }
+        this.rules = otherRules;
+        return this;
+    }
+    /**
+     * Construct an indirection object from the registered definitions.
+     * @returns An object with a method for each registered indirection name.
+     */
     build() {
@@ -71,0 +143,0 @@ return new DynamicIndirect(this.rules);

dist/esm/lib/indirection-builder/IndirBuilder.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"IndirBuilder.js","sourceRoot":"","sources":["../../../../lib/indirection-builder/IndirBuilder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,OAAO,YAAY;IAUhB,MAAM,CAAC,MAAM,CAMlB,KAAqD;QAErD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA0D,IAAI,YAAY,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1G,CAAC;QACD,OAAO,IAAI,YAAY,CAAC,EAAE,GAAiC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAEM,YAAY;QAOjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAEM,SAAS;QASd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAAsC;QAK/F,MAAM,IAAI,GAEE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAAqC;QAKtG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAAuC,IAAI,CAAC,KAAK,CAAC;QAC7D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;QACzE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAA6D;QAI7D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK;QACV,OAA4D,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9F,CAAC;CACF","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\nimport type { CheckOverlap } from '../utils.js';\nimport { DynamicIndirect } from './dynamicIndirected.js';\nimport type { IndirDef, IndirectionMap, IndirectObjFromIndirDefs, ParseIndirsToObject } from './helpers.js';\nimport { listToIndirectionMap } from './helpers.js';\n\nexport class IndirBuilder<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> {\n  public static create<Context, Names extends string, RuleDefs extends IndirectionMap<Names>>(\n    args: IndirBuilder<Context, Names, RuleDefs>\n  ): IndirBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly IndirDef[] = readonly IndirDef[],\n    Context = Rules[0] extends IndirDef<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends IndirectionMap<Names> = ParseIndirsToObject<Rules>,\n  >(rules: Rules): IndirBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly IndirDef[] = readonly IndirDef[],\n    Context = Rules[0] extends IndirDef<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends IndirectionMap<Names> = ParseIndirsToObject<Rules>,\n  >(\n    start: Rules | IndirBuilder<Context, Names, RuleDefs>,\n  ): IndirBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <IndirBuilder<Context, Names, RuleDefs>> <unknown> new IndirBuilder(listToIndirectionMap(start));\n    }\n    return new IndirBuilder({ ...(<IndirBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  public widenContext<NewContext extends Context>(): IndirBuilder<\n    NewContext,\n    Names,\n    {[Key in keyof RuleDefs]: Key extends Names ?\n        (RuleDefs[Key] extends IndirDef<any, any, infer RT, infer PT> ? IndirDef<NewContext, Key, RT, PT> : never)\n      : never }\n  > {\n    return <any> this;\n  }\n\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  IndirBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? IndirDef<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only  one - infer arg yourself\n      Patch[Key] extends [ any ] ? (\n        RuleDefs[Key] extends IndirDef<any, any, any, infer Par> ? IndirDef<Context, Key, Patch[Key][0], Par> : never\n      ) : never\n    )\n  ) : (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never) }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing indirection.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: IndirDef<Context, U, RET, ARGS>):\n  IndirBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    IndirDef<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <IndirBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      IndirDef<Context, Key, RET, ARGS> : (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add an indirection function. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: IndirDef<Context, U, RET, ARGS>):\n  IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    IndirDef<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never)\n  }> {\n    const self = <IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n      IndirDef<Context, K, RET, ARGS> :\n        (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never) }>>\n      <unknown> this;\n    const rules = <Record<string, IndirDef<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Function ${rule.name} already exists in the builder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, IndirDef<Context, U, RET, ARGS>>,\n  ): IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    IndirDef<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never) }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  public addMany<U extends readonly IndirDef<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): IndirBuilder<\n    Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof ParseIndirsToObject<typeof rules> ? (\n        ParseIndirsToObject<typeof rules>[K] extends IndirDef<Context, K> ? ParseIndirsToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n  > {\n    this.rules = { ...this.rules, ...listToIndirectionMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }> {\n    for (const name of ruleNames) {\n      delete this.rules[name];\n    }\n    return <IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends IndirDef<any, U, infer RT, infer PT> ?\n    IndirDef<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  public build(): IndirectObjFromIndirDefs<Context, Names, RuleDefs> {\n    return <IndirectObjFromIndirDefs<Context, Names, RuleDefs>> new DynamicIndirect(this.rules);\n  }\n}\n"]}
+{"version":3,"file":"IndirBuilder.js","sourceRoot":"","sources":["../../../../lib/indirection-builder/IndirBuilder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD;;;;;;;GAOG;AACH,MAAM,OAAO,YAAY;IAchB,MAAM,CAAC,MAAM,CAMlB,KAAqD;QAErD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA0D,IAAI,YAAY,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1G,CAAC;QACD,OAAO,IAAI,YAAY,CAAC,EAAE,GAAiC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,YAAY;QAOjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,SAAS;QASd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAAsC;QAK/F,MAAM,IAAI,GAEE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAAqC;QAKtG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAAuC,IAAI,CAAC,KAAK,CAAC;QAC7D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;QACzE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAA6D;QAI7D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAKV,OAAsD,EACtD,eAAmB;QAcnB,qFAAqF;QACrF,MAAM,UAAU,GAAsC,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC3E,MAAM,OAAO,GAAsC,IAAI,CAAC,KAAK,CAAC;QAE9D,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;oBAC9H,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAA4D,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9F,CAAC;CACF","sourcesContent":["import type { ParseNamesFromList } from '../parser-builder/builderTypes.js';\nimport type { CheckOverlap } from '../utils.js';\nimport { DynamicIndirect } from './dynamicIndirected.js';\nimport type { IndirDef, IndirectionMap, IndirectObjFromIndirDefs, ParseIndirsToObject } from './helpers.js';\nimport { listToIndirectionMap } from './helpers.js';\n\n/**\n * Builder for composing modular transformation pipelines using indirection definitions.\n * Functions registered through this builder call each other via SUBRULE, enabling the same\n * modularity and extensibility as the parser and generator builders.\n *\n * Builders mutate internal state and return `this`.\n * Always start by copying an existing builder with `IndirBuilder.create(existingBuilder)`.\n */\nexport class IndirBuilder<Context, Names extends string, RuleDefs extends IndirectionMap<Names>> {\n  /**\n   * Create an IndirBuilder from initial indirection definitions or an existing builder.\n   * If a builder is provided, a new copy will be created.\n   */\n  public static create<Context, Names extends string, RuleDefs extends IndirectionMap<Names>>(\n    args: IndirBuilder<Context, Names, RuleDefs>\n  ): IndirBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly IndirDef[] = readonly IndirDef[],\n    Context = Rules[0] extends IndirDef<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends IndirectionMap<Names> = ParseIndirsToObject<Rules>,\n  >(rules: Rules): IndirBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly IndirDef[] = readonly IndirDef[],\n    Context = Rules[0] extends IndirDef<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends IndirectionMap<Names> = ParseIndirsToObject<Rules>,\n  >(\n    start: Rules | IndirBuilder<Context, Names, RuleDefs>,\n  ): IndirBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <IndirBuilder<Context, Names, RuleDefs>> <unknown> new IndirBuilder(listToIndirectionMap(start));\n    }\n    return new IndirBuilder({ ...(<IndirBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  /**\n   * Narrow the builder's context type parameter to a more specific subtype.\n   * This is a zero-cost type-level operation — the builder instance is returned as-is\n   * but with updated type parameters.\n   */\n  public widenContext<NewContext extends Context>(): IndirBuilder<\n    NewContext,\n    Names,\n    {[Key in keyof RuleDefs]: Key extends Names ?\n        (RuleDefs[Key] extends IndirDef<any, any, infer RT, infer PT> ? IndirDef<NewContext, Key, RT, PT> : never)\n      : never }\n  > {\n    return <any> this;\n  }\n\n  /**\n   * Update the type signatures (return types and/or parameter types) of existing indirections\n   * without changing their implementations. Use this when a patched indirection changes the types\n   * flowing through downstream indirections that don't need new implementations.\n   * This is a zero-cost type-level operation.\n   */\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  IndirBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? IndirDef<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only  one - infer arg yourself\n      Patch[Key] extends [ any ] ? (\n        RuleDefs[Key] extends IndirDef<any, any, any, infer Par> ? IndirDef<Context, Key, Patch[Key][0], Par> : never\n      ) : never\n    )\n  ) : (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never) }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing indirection.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: IndirDef<Context, U, RET, ARGS>):\n  IndirBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    IndirDef<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <IndirBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      IndirDef<Context, Key, RET, ARGS> : (RuleDefs[Key] extends IndirDef<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add an indirection function. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: IndirDef<Context, U, RET, ARGS>):\n  IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    IndirDef<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never)\n  }> {\n    const self = <IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n      IndirDef<Context, K, RET, ARGS> :\n        (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never) }>>\n      <unknown> this;\n    const rules = <Record<string, IndirDef<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Function ${rule.name} already exists in the builder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, IndirDef<Context, U, RET, ARGS>>,\n  ): IndirBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    IndirDef<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never) }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  /**\n   * Add multiple indirection definitions at once using rest parameters.\n   * Provides better TypeScript type inference than calling {@link addRule} in a loop,\n   * but avoid passing too many at once as this can cause TypeScript compilation slowdowns.\n   * TypeScript errors if any name conflicts with an existing one.\n   */\n  public addMany<U extends readonly IndirDef<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): IndirBuilder<\n    Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof ParseIndirsToObject<typeof rules> ? (\n        ParseIndirsToObject<typeof rules>[K] extends IndirDef<Context, K> ? ParseIndirsToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n  > {\n    this.rules = { ...this.rules, ...listToIndirectionMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Delete multiple indirection definitions by name in a single call.\n   * @param ruleNames - Names of the indirections to delete.\n   */\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }> {\n    for (const name of ruleNames) {\n      delete this.rules[name];\n    }\n    return <IndirBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Retrieve an indirection definition by its name.\n   * Useful for inspecting or wrapping existing definitions when extending a pipeline.\n   * @param ruleName - The name of the indirection, type-checked against the builder's known names.\n   */\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends IndirDef<any, U, infer RT, infer PT> ?\n    IndirDef<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this indirection builder with another.\n   * If the two builders both have a definition with the same name,\n   * no error will be thrown in case they map to the same object (by reference).\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a definition with the same conflicting name,\n   * whose implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends IndirectionMap<OtherNames>,\n    OW extends readonly IndirDef<Context>[],\n  >(\n    builder: IndirBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    IndirBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof ParseIndirsToObject<OW> ? (\n          ParseIndirsToObject<OW>[K] extends IndirDef<Context, K> ? ParseIndirsToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends IndirDef<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends IndirDef<Context, K> ? OtherRules[K] : never) : never\n            ) }\n    > {\n    // Assume the other set is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, IndirDef<Context>> = { ...builder.rules };\n    const myRules: Record<string, IndirDef<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Function with name \"${rule.name}\" already exists in the builder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Construct an indirection object from the registered definitions.\n   * @returns An object with a method for each registered indirection name.\n   */\n  public build(): IndirectObjFromIndirDefs<Context, Names, RuleDefs> {\n    return <IndirectObjFromIndirDefs<Context, Names, RuleDefs>> new DynamicIndirect(this.rules);\n  }\n}\n"]}

dist/esm/lib/lexer-builder/LexerBuilder.d.ts

 import type { ILexerConfig, TokenType } from '@traqula/chevrotain';
 import { Lexer } from '@traqula/chevrotain';
 import type { CheckOverlap, NamedToken } from '../utils.js';
+/**
+ * Builder for constructing Chevrotain lexers with type-safe token management.
+ * Token ordering matters — the lexer matches the first token that fits, so more specific
+ * tokens (e.g., keywords) must be positioned before more general ones (e.g., identifiers).
+ *
+ * Builders mutate internal state and return `this`.
+ * Always start by copying an existing builder with `LexerBuilder.create(existingBuilder)`.
+ */
 export declare class LexerBuilder<NAMES extends string = string> {
     private readonly tokens;
+    /**
+     * Create a new LexerBuilder, optionally copying from an existing one.
+     * @param starter - An existing builder to copy tokens from. If omitted, starts empty.
+     */
     static create<U extends LexerBuilder<T>, T extends string = never>(starter?: U): U;
     private constructor();
+    /**
+     * Merge tokens from another LexerBuilder into this one.
+     * Duplicate tokens (by reference) are skipped. Different tokens with the same name
+     * cause an error unless an override is provided.
+     * @param merge - The other builder whose tokens to merge.
+     * @param overwrite - Tokens that take precedence when names conflict.
+     */
     merge<OtherNames extends string, OW extends string>(merge: LexerBuilder<OtherNames>, overwrite?: NamedToken<OW>[]): LexerBuilder<NAMES | OtherNames>;
+    /**
+     * Append tokens to the end of the builder's token list.
+     * TypeScript errors if a token name already exists.
+     * @param token - One or more tokens to add.
+     */
     add<Name extends string>(...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>): LexerBuilder<Name | NAMES>;
+    /**
+     * Insert tokens before a specified reference token in the ordering.
+     * @param before - The existing token to insert before.
+     * @param token - One or more tokens to insert.
+     */
     addBefore<Name extends string>(before: NamedToken<NAMES>, ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>): LexerBuilder<NAMES | Name>;
     private moveBeforeOrAfter;
     /**
-     * @param before token to move rest before
-     * @param tokens tokens to move before the first token
+     * Move existing tokens so they appear before a specified reference token.
+     * The tokens must already exist in the builder.
+     * @param before - The reference token to move before.
+     * @param tokens - The tokens to reposition.
      */
     moveBefore<Name extends string>(before: NamedToken<NAMES>, ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>): LexerBuilder<NAMES>;
+    /**
+     * Move existing tokens so they appear after a specified reference token.
+     * The tokens must already exist in the builder.
+     * @param after - The reference token to move after.
+     * @param tokens - The tokens to reposition.
+     */
     moveAfter<Name extends string>(after: NamedToken<NAMES>, ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>): LexerBuilder<NAMES>;
+    /**
+     * Insert tokens after a specified reference token in the ordering.
+     * @param after - The existing token to insert after.
+     * @param token - One or more tokens to insert.
+     */
     addAfter<Name extends string>(after: NamedToken<NAMES>, ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>): LexerBuilder<NAMES | Name>;
+    /**
+     * Remove tokens from the builder by reference.
+     * @param token - One or more tokens to remove. Throws if a token is not found.
+     */
     delete<Name extends NAMES>(...token: NamedToken<Name>[]): LexerBuilder<Exclude<NAMES, Name>>;
+    /**
+     * Construct a Chevrotain {@link Lexer} from the current token ordering.
+     * @param lexerConfig - Optional Chevrotain lexer configuration overrides.
+     */
     build(lexerConfig?: ILexerConfig): Lexer;
+    /**
+     * Get the current token list (readonly).
+     * Useful for passing to {@link ParserBuilder.build} as the `tokenVocabulary` argument.
+     */
     get tokenVocabulary(): readonly TokenType[];
 }

dist/esm/lib/lexer-builder/LexerBuilder.js

 import { Lexer } from '@traqula/chevrotain';
+/**
+ * Builder for constructing Chevrotain lexers with type-safe token management.
+ * Token ordering matters — the lexer matches the first token that fits, so more specific
+ * tokens (e.g., keywords) must be positioned before more general ones (e.g., identifiers).
+ *
+ * Builders mutate internal state and return `this`.
+ * Always start by copying an existing builder with `LexerBuilder.create(existingBuilder)`.
+ */
 export class LexerBuilder {
     tokens;
+    /**
+     * Create a new LexerBuilder, optionally copying from an existing one.
+     * @param starter - An existing builder to copy tokens from. If omitted, starts empty.
+     */
     static create(starter) {
@@ -10,2 +22,9 @@ return new LexerBuilder(starter);
     }
+    /**
+     * Merge tokens from another LexerBuilder into this one.
+     * Duplicate tokens (by reference) are skipped. Different tokens with the same name
+     * cause an error unless an override is provided.
+     * @param merge - The other builder whose tokens to merge.
+     * @param overwrite - Tokens that take precedence when names conflict.
+     */
     merge(merge, overwrite = []) {
@@ -29,2 +48,7 @@ const extraTokens = merge.tokens.filter((token) => {
     }
+    /**
+     * Append tokens to the end of the builder's token list.
+     * TypeScript errors if a token name already exists.
+     * @param token - One or more tokens to add.
+     */
     add(...token) {
@@ -34,2 +58,7 @@ this.tokens.push(...token);
     }
+    /**
+     * Insert tokens before a specified reference token in the ordering.
+     * @param before - The existing token to insert before.
+     * @param token - One or more tokens to insert.
+     */
     addBefore(before, ...token) {
@@ -59,4 +88,6 @@ const index = this.tokens.indexOf(before);
     /**
-     * @param before token to move rest before
-     * @param tokens tokens to move before the first token
+     * Move existing tokens so they appear before a specified reference token.
+     * The tokens must already exist in the builder.
+     * @param before - The reference token to move before.
+     * @param tokens - The tokens to reposition.
      */
@@ -66,5 +97,16 @@ moveBefore(before, ...tokens) {
     }
+    /**
+     * Move existing tokens so they appear after a specified reference token.
+     * The tokens must already exist in the builder.
+     * @param after - The reference token to move after.
+     * @param tokens - The tokens to reposition.
+     */
     moveAfter(after, ...tokens) {
         return this.moveBeforeOrAfter('after', after, ...tokens);
     }
+    /**
+     * Insert tokens after a specified reference token in the ordering.
+     * @param after - The existing token to insert after.
+     * @param token - One or more tokens to insert.
+     */
     addAfter(after, ...token) {
@@ -78,2 +120,6 @@ const index = this.tokens.indexOf(after);
     }
+    /**
+     * Remove tokens from the builder by reference.
+     * @param token - One or more tokens to remove. Throws if a token is not found.
+     */
     delete(...token) {
@@ -89,2 +135,6 @@ for (const t of token) {
     }
+    /**
+     * Construct a Chevrotain {@link Lexer} from the current token ordering.
+     * @param lexerConfig - Optional Chevrotain lexer configuration overrides.
+     */
     build(lexerConfig) {
@@ -100,2 +150,6 @@ return new Lexer(this.tokens, {
     }
+    /**
+     * Get the current token list (readonly).
+     * Useful for passing to {@link ParserBuilder.build} as the `tokenVocabulary` argument.
+     */
     get tokenVocabulary() {
@@ -102,0 +156,0 @@ return this.tokens;

dist/esm/lib/lexer-builder/LexerBuilder.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"LexerBuilder.js","sourceRoot":"","sources":["../../../../lib/lexer-builder/LexerBuilder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAG5C,MAAM,OAAO,YAAY;IACN,MAAM,CAAc;IAE9B,MAAM,CAAC,MAAM,CAAsD,OAAW;QACnF,OAAW,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,YAAoB,OAA6B;QAC/C,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAE,GAAG,OAAO,CAAC,MAAM,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,CAAC;IAEM,KAAK,CACV,KAA+B,EAC/B,YAA8B,EAAE;QAGhC,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YAChD,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAClE,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3D,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,CAAC,IAAI,6EAA6E,CAAC,CAAC;gBAC9H,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,GAAG,CAAsB,GAAG,KAAoD;QAErF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,SAAS,CACd,MAAyB,EACzB,GAAG,KAAoD;QAEvD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,iBAAiB,CACvB,aAAiC,EACjC,MAAyB,EACzB,GAAG,MAA4D;QAE/D,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvF,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,UAAU,CACf,MAAyB,EACzB,GAAG,MAA4D;QAE/D,OAAO,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;IAC7D,CAAC;IAEM,SAAS,CACd,KAAwB,EACxB,GAAG,MAA4D;QAE/D,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,CAAC;IAC3D,CAAC;IAEM,QAAQ,CACb,KAAwB,EACxB,GAAG,KAAoD;QAEvD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAqB,GAAG,KAAyB;QAC5D,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACrC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,WAA0B;QACrC,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;YAC5B,gBAAgB,EAAE,WAAW;YAC7B,eAAe,EAAE,KAAK;YACtB,mBAAmB,EAAE,IAAI;YACzB,kBAAkB;YAClB,yBAAyB;YACzB,GAAG,WAAW;SACf,CAAC,CAAC;IACL,CAAC;IAED,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF","sourcesContent":["import type { ILexerConfig, TokenType } from '@traqula/chevrotain';\nimport { Lexer } from '@traqula/chevrotain';\nimport type { CheckOverlap, NamedToken } from '../utils.js';\n\nexport class LexerBuilder<NAMES extends string = string> {\n  private readonly tokens: TokenType[];\n\n  public static create<U extends LexerBuilder<T>, T extends string = never>(starter?: U): U {\n    return <U> new LexerBuilder(starter);\n  }\n\n  private constructor(starter?: LexerBuilder<NAMES>) {\n    this.tokens = starter?.tokens ? [ ...starter.tokens ] : [];\n  }\n\n  public merge<OtherNames extends string, OW extends string>(\n    merge: LexerBuilder<OtherNames>,\n    overwrite: NamedToken<OW>[] = [],\n  ):\n    LexerBuilder<NAMES | OtherNames> {\n    const extraTokens = merge.tokens.filter((token) => {\n      const overwriteToken = overwrite.find(t => t.name === token.name);\n      if (overwriteToken) {\n        return false;\n      }\n      const match = this.tokens.find(t => t.name === token.name);\n      if (match) {\n        if (match !== token) {\n          throw new Error(`Token with name ${token.name} already exists. Implementation is different and no overwrite was provided.`);\n        }\n        return false;\n      }\n      return true;\n    });\n    this.tokens.push(...extraTokens);\n    return this;\n  }\n\n  public add<Name extends string>(...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>):\n  LexerBuilder<Name | NAMES> {\n    this.tokens.push(...token);\n    return this;\n  }\n\n  public addBefore<Name extends string>(\n    before: NamedToken<NAMES>,\n    ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES | Name> {\n    const index = this.tokens.indexOf(before);\n    if (index === -1) {\n      throw new Error('Token not found');\n    }\n    this.tokens.splice(index, 0, ...token);\n    return this;\n  }\n\n  private moveBeforeOrAfter<Name extends string>(\n    beforeOrAfter: 'before' | 'after',\n    before: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    const beforeIndex = this.tokens.indexOf(before) + (beforeOrAfter === 'before' ? 0 : 1);\n    if (beforeIndex === -1) {\n      throw new Error('BeforeToken not found');\n    }\n    for (const token of tokens) {\n      const tokenIndex = this.tokens.indexOf(token);\n      if (tokenIndex === -1) {\n        throw new Error('Token not found');\n      }\n      this.tokens.splice(tokenIndex, 1);\n      this.tokens.splice(beforeIndex, 0, token);\n    }\n    return this;\n  }\n\n  /**\n   * @param before token to move rest before\n   * @param tokens tokens to move before the first token\n   */\n  public moveBefore<Name extends string>(\n    before: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    return this.moveBeforeOrAfter('before', before, ...tokens);\n  }\n\n  public moveAfter<Name extends string>(\n    after: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    return this.moveBeforeOrAfter('after', after, ...tokens);\n  }\n\n  public addAfter<Name extends string>(\n    after: NamedToken<NAMES>,\n    ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES | Name> {\n    const index = this.tokens.indexOf(after);\n    if (index === -1) {\n      throw new Error('Token not found');\n    }\n    this.tokens.splice(index + 1, 0, ...token);\n    return this;\n  }\n\n  public delete<Name extends NAMES>(...token: NamedToken<Name>[]): LexerBuilder<Exclude<NAMES, Name>> {\n    for (const t of token) {\n      const index = this.tokens.indexOf(t);\n      if (index === -1) {\n        throw new Error('Token not found');\n      }\n      this.tokens.splice(index, 1);\n    }\n    return this;\n  }\n\n  public build(lexerConfig?: ILexerConfig): Lexer {\n    return new Lexer(this.tokens, {\n      positionTracking: 'onlyStart',\n      recoveryEnabled: false,\n      ensureOptimizations: true,\n      // SafeMode: true,\n      // SkipValidations: true,\n      ...lexerConfig,\n    });\n  }\n\n  public get tokenVocabulary(): readonly TokenType[] {\n    return this.tokens;\n  }\n}\n"]}
+{"version":3,"file":"LexerBuilder.js","sourceRoot":"","sources":["../../../../lib/lexer-builder/LexerBuilder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAG5C;;;;;;;GAOG;AACH,MAAM,OAAO,YAAY;IACN,MAAM,CAAc;IAErC;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAsD,OAAW;QACnF,OAAW,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,YAAoB,OAA6B;QAC/C,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAE,GAAG,OAAO,CAAC,MAAM,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CACV,KAA+B,EAC/B,YAA8B,EAAE;QAGhC,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YAChD,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAClE,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3D,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,CAAC,IAAI,6EAA6E,CAAC,CAAC;gBAC9H,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAsB,GAAG,KAAoD;QAErF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,SAAS,CACd,MAAyB,EACzB,GAAG,KAAoD;QAEvD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,iBAAiB,CACvB,aAAiC,EACjC,MAAyB,EACzB,GAAG,MAA4D;QAE/D,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvF,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,UAAU,CACf,MAAyB,EACzB,GAAG,MAA4D;QAE/D,OAAO,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,SAAS,CACd,KAAwB,EACxB,GAAG,MAA4D;QAE/D,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,QAAQ,CACb,KAAwB,EACxB,GAAG,KAAoD;QAEvD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,MAAM,CAAqB,GAAG,KAAyB;QAC5D,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACrC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAA0B;QACrC,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;YAC5B,gBAAgB,EAAE,WAAW;YAC7B,eAAe,EAAE,KAAK;YACtB,mBAAmB,EAAE,IAAI;YACzB,kBAAkB;YAClB,yBAAyB;YACzB,GAAG,WAAW;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF","sourcesContent":["import type { ILexerConfig, TokenType } from '@traqula/chevrotain';\nimport { Lexer } from '@traqula/chevrotain';\nimport type { CheckOverlap, NamedToken } from '../utils.js';\n\n/**\n * Builder for constructing Chevrotain lexers with type-safe token management.\n * Token ordering matters — the lexer matches the first token that fits, so more specific\n * tokens (e.g., keywords) must be positioned before more general ones (e.g., identifiers).\n *\n * Builders mutate internal state and return `this`.\n * Always start by copying an existing builder with `LexerBuilder.create(existingBuilder)`.\n */\nexport class LexerBuilder<NAMES extends string = string> {\n  private readonly tokens: TokenType[];\n\n  /**\n   * Create a new LexerBuilder, optionally copying from an existing one.\n   * @param starter - An existing builder to copy tokens from. If omitted, starts empty.\n   */\n  public static create<U extends LexerBuilder<T>, T extends string = never>(starter?: U): U {\n    return <U> new LexerBuilder(starter);\n  }\n\n  private constructor(starter?: LexerBuilder<NAMES>) {\n    this.tokens = starter?.tokens ? [ ...starter.tokens ] : [];\n  }\n\n  /**\n   * Merge tokens from another LexerBuilder into this one.\n   * Duplicate tokens (by reference) are skipped. Different tokens with the same name\n   * cause an error unless an override is provided.\n   * @param merge - The other builder whose tokens to merge.\n   * @param overwrite - Tokens that take precedence when names conflict.\n   */\n  public merge<OtherNames extends string, OW extends string>(\n    merge: LexerBuilder<OtherNames>,\n    overwrite: NamedToken<OW>[] = [],\n  ):\n    LexerBuilder<NAMES | OtherNames> {\n    const extraTokens = merge.tokens.filter((token) => {\n      const overwriteToken = overwrite.find(t => t.name === token.name);\n      if (overwriteToken) {\n        return false;\n      }\n      const match = this.tokens.find(t => t.name === token.name);\n      if (match) {\n        if (match !== token) {\n          throw new Error(`Token with name ${token.name} already exists. Implementation is different and no overwrite was provided.`);\n        }\n        return false;\n      }\n      return true;\n    });\n    this.tokens.push(...extraTokens);\n    return this;\n  }\n\n  /**\n   * Append tokens to the end of the builder's token list.\n   * TypeScript errors if a token name already exists.\n   * @param token - One or more tokens to add.\n   */\n  public add<Name extends string>(...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>):\n  LexerBuilder<Name | NAMES> {\n    this.tokens.push(...token);\n    return this;\n  }\n\n  /**\n   * Insert tokens before a specified reference token in the ordering.\n   * @param before - The existing token to insert before.\n   * @param token - One or more tokens to insert.\n   */\n  public addBefore<Name extends string>(\n    before: NamedToken<NAMES>,\n    ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES | Name> {\n    const index = this.tokens.indexOf(before);\n    if (index === -1) {\n      throw new Error('Token not found');\n    }\n    this.tokens.splice(index, 0, ...token);\n    return this;\n  }\n\n  private moveBeforeOrAfter<Name extends string>(\n    beforeOrAfter: 'before' | 'after',\n    before: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    const beforeIndex = this.tokens.indexOf(before) + (beforeOrAfter === 'before' ? 0 : 1);\n    if (beforeIndex === -1) {\n      throw new Error('BeforeToken not found');\n    }\n    for (const token of tokens) {\n      const tokenIndex = this.tokens.indexOf(token);\n      if (tokenIndex === -1) {\n        throw new Error('Token not found');\n      }\n      this.tokens.splice(tokenIndex, 1);\n      this.tokens.splice(beforeIndex, 0, token);\n    }\n    return this;\n  }\n\n  /**\n   * Move existing tokens so they appear before a specified reference token.\n   * The tokens must already exist in the builder.\n   * @param before - The reference token to move before.\n   * @param tokens - The tokens to reposition.\n   */\n  public moveBefore<Name extends string>(\n    before: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    return this.moveBeforeOrAfter('before', before, ...tokens);\n  }\n\n  /**\n   * Move existing tokens so they appear after a specified reference token.\n   * The tokens must already exist in the builder.\n   * @param after - The reference token to move after.\n   * @param tokens - The tokens to reposition.\n   */\n  public moveAfter<Name extends string>(\n    after: NamedToken<NAMES>,\n    ...tokens: CheckOverlap<Name, NAMES, never, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES> {\n    return this.moveBeforeOrAfter('after', after, ...tokens);\n  }\n\n  /**\n   * Insert tokens after a specified reference token in the ordering.\n   * @param after - The existing token to insert after.\n   * @param token - One or more tokens to insert.\n   */\n  public addAfter<Name extends string>(\n    after: NamedToken<NAMES>,\n    ...token: CheckOverlap<Name, NAMES, NamedToken<Name>[]>\n  ): LexerBuilder<NAMES | Name> {\n    const index = this.tokens.indexOf(after);\n    if (index === -1) {\n      throw new Error('Token not found');\n    }\n    this.tokens.splice(index + 1, 0, ...token);\n    return this;\n  }\n\n  /**\n   * Remove tokens from the builder by reference.\n   * @param token - One or more tokens to remove. Throws if a token is not found.\n   */\n  public delete<Name extends NAMES>(...token: NamedToken<Name>[]): LexerBuilder<Exclude<NAMES, Name>> {\n    for (const t of token) {\n      const index = this.tokens.indexOf(t);\n      if (index === -1) {\n        throw new Error('Token not found');\n      }\n      this.tokens.splice(index, 1);\n    }\n    return this;\n  }\n\n  /**\n   * Construct a Chevrotain {@link Lexer} from the current token ordering.\n   * @param lexerConfig - Optional Chevrotain lexer configuration overrides.\n   */\n  public build(lexerConfig?: ILexerConfig): Lexer {\n    return new Lexer(this.tokens, {\n      positionTracking: 'onlyStart',\n      recoveryEnabled: false,\n      ensureOptimizations: true,\n      // SafeMode: true,\n      // SkipValidations: true,\n      ...lexerConfig,\n    });\n  }\n\n  /**\n   * Get the current token list (readonly).\n   * Useful for passing to {@link ParserBuilder.build} as the `tokenVocabulary` argument.\n   */\n  public get tokenVocabulary(): readonly TokenType[] {\n    return this.tokens;\n  }\n}\n"]}

dist/esm/lib/parser-builder/parserBuilder.d.ts

@@ -5,7 +5,17 @@ import type { ILexerConfig, IParserConfig, IRecognitionException, TokenType } from '@traqula/chevrotain';
 import type { ParserRule } from './ruleDefTypes.js';
+/**
+ * Configuration for {@link ParserBuilder.build}. Specifies the token vocabulary,
+ * optional Chevrotain parser/lexer configuration, and optional hooks for
+ * preprocessing input or handling parse errors.
+ */
 export interface ParserBuildArgs {
+    /** The complete token vocabulary the parser and lexer should recognize. */
     tokenVocabulary: readonly TokenType[];
+    /** Optional Chevrotain parser configuration (e.g., `maxLookahead`). */
     parserConfig?: IParserConfig;
+    /** Optional Chevrotain lexer configuration (e.g., `positionTracking`). */
     lexerConfig?: ILexerConfig;
+    /** Optional function to preprocess the input string before lexing. */
     queryPreProcessor?: (input: string) => string;
+    /** Optional custom error handler. If omitted, a default handler throws on the first error. */
     errorHandler?: (errors: IRecognitionException[]) => void;
@@ -27,5 +37,16 @@ }
     private constructor();
+    /**
+     * Narrow the builder's context type parameter to a more specific subtype.
+     * This is a zero-cost type-level operation — the builder instance is returned as-is
+     * but with updated type parameters.
+     */
     widenContext<NewContext extends Context>(): ParserBuilder<NewContext, Names, {
         [Key in keyof RuleDefs]: Key extends Names ? (RuleDefs[Key] extends ParserRule<any, any, infer RT, infer PT> ? ParserRule<NewContext, Key, RT, PT> : never) : never;
     }>;
+    /**
+     * Update the type signatures (return types and/or parameter types) of existing rules
+     * without changing their implementations. Use this when a patched rule changes the types
+     * flowing through downstream rules that don't need new implementations.
+     * This is a zero-cost type-level operation.
+     */
     typePatch<Patch extends {
@@ -54,2 +75,8 @@ [Key in Names]?: [any] | [any, any[]];
     }>;
+    /**
+     * Add multiple rules at once using rest parameters.
+     * Provides better TypeScript type inference than calling {@link addRule} in a loop,
+     * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.
+     * TypeScript errors if any rule name conflicts with an existing one.
+     */
     addMany<U extends readonly ParserRule<Context>[]>(...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>): ParserBuilder<Context, Names | ParseNamesFromList<U>, {
@@ -64,5 +91,14 @@ [K in Names | ParseNamesFromList<U>]: K extends keyof ParseRulesToObject<typeof rules> ? (ParseRulesToObject<typeof rules>[K] extends ParserRule<Context, K> ? ParseRulesToObject<typeof rules>[K] : never) : (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never);
     }>;
+    /**
+     * Delete multiple rules by name in a single call.
+     * @param ruleNames - Names of the rules to delete.
+     */
     deleteMany<U extends Names>(...ruleNames: U[]): ParserBuilder<Context, Exclude<Names, U>, {
         [K in Exclude<Names, U>]: RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never;
     }>;
+    /**
+     * Retrieve a grammar rule definition by its name.
+     * Useful for inspecting or wrapping existing rules when extending a parser.
+     * @param ruleName - The name of the rule, type-checked against the builder's known rule names.
+     */
     getRule<U extends Names>(ruleName: U): RuleDefs[U] extends ParserRule<any, U, infer RT, infer PT> ? ParserRule<Context, U, RT, PT> : never;
@@ -82,4 +118,10 @@ /**
     private defaultErrorHandler;
+    /**
+     * Construct a self-sufficient parser from the registered rules and token vocabulary.
+     * Building a parser is expensive (Chevrotain performs grammar recording), so the result
+     * should be reused across parse calls.
+     * @returns An object with a method for each registered rule name.
+     */
     build({ tokenVocabulary, parserConfig, lexerConfig, queryPreProcessor, errorHandler, }: ParserBuildArgs): ParserFromRules<Context, Names, RuleDefs>;
     private consume;
 }

dist/esm/lib/parser-builder/parserBuilder.js

@@ -35,5 +35,16 @@ import { LexerBuilder } from '../lexer-builder/LexerBuilder.js';
     }
+    /**
+     * Narrow the builder's context type parameter to a more specific subtype.
+     * This is a zero-cost type-level operation — the builder instance is returned as-is
+     * but with updated type parameters.
+     */
     widenContext() {
         return this;
     }
+    /**
+     * Update the type signatures (return types and/or parameter types) of existing rules
+     * without changing their implementations. Use this when a patched rule changes the types
+     * flowing through downstream rules that don't need new implementations.
+     * This is a zero-cost type-level operation.
+     */
     typePatch() {
@@ -68,2 +79,8 @@ return this;
     }
+    /**
+     * Add multiple rules at once using rest parameters.
+     * Provides better TypeScript type inference than calling {@link addRule} in a loop,
+     * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.
+     * TypeScript errors if any rule name conflicts with an existing one.
+     */
     addMany(...rules) {
@@ -80,2 +97,6 @@ this.rules = { ...this.rules, ...listToRuleDefMap(rules) };
     }
+    /**
+     * Delete multiple rules by name in a single call.
+     * @param ruleNames - Names of the rules to delete.
+     */
     deleteMany(...ruleNames) {
@@ -87,2 +108,7 @@ for (const ruleName of ruleNames) {
     }
+    /**
+     * Retrieve a grammar rule definition by its name.
+     * Useful for inspecting or wrapping existing rules when extending a parser.
+     * @param ruleName - The name of the rule, type-checked against the builder's known rule names.
+     */
     getRule(ruleName) {
@@ -142,2 +168,8 @@ return this.rules[ruleName];
     }
+    /**
+     * Construct a self-sufficient parser from the registered rules and token vocabulary.
+     * Building a parser is expensive (Chevrotain performs grammar recording), so the result
+     * should be reused across parse calls.
+     * @returns An object with a method for each registered rule name.
+     */
     build({ tokenVocabulary, parserConfig = {}, lexerConfig = {}, queryPreProcessor = s => s, errorHandler, }) {
@@ -144,0 +176,0 @@ const lexer = LexerBuilder.create().add(...tokenVocabulary).build({

dist/esm/lib/parser-builder/parserBuilder.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"parserBuilder.js","sourceRoot":"","sources":["../../../../lib/parser-builder/parserBuilder.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAShE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD;;GAEG;AACH,SAAS,gBAAgB,CAAkC,KAAQ;IACjE,MAAM,QAAQ,GAA+B,EAAE,CAAC;IAChD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA8B,QAAQ,CAAC;AACzC,CAAC;AAUD;;;;;GAKG;AACH,iDAAiD;AACjD,MAAM,OAAO,aAAa;IACxB;;;OAGG;IACI,MAAM,CAAC,MAAM,CAMlB,KAAsD;QAEtD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA2D,IAAI,aAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QACxG,CAAC;QACD,OAAO,IAAI,aAAa,CAAC,EAAE,GAAkC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC/E,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAEM,YAAY;QAOjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAEM,SAAS;QAUd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAAwC;QAKjG,MAAM,IAAI,GAEE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAAuC;QAKxG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAAyC,IAAI,CAAC,KAAK,CAAC;QAC/D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;QACrE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAA+D;QAI/D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAEM,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAKV,OAAuD,EACvD,eAAmB;QAcnB,yFAAyF;QACzF,MAAM,UAAU,GAAwC,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7E,MAAM,OAAO,GAAwC,IAAI,CAAC,KAAK,CAAC;QAEhE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;oBAC1H,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAEO,mBAAmB,CAAC,KAAa,EAAE,MAA+B;QACxE,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,cAAc,GAAa,CAAE,aAAa,CAAE,CAAC;QACnD,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACpD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;YACjD,cAAc,CAAC,IAAI,CAAC,YAAY,OAAO;EAC3C,SAAS,EAAE,CAAC,CAAC;YACT,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC;YAC/C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,cAAc,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QACD,cAAc,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,EACX,eAAe,EACf,YAAY,GAAG,EAAE,EACjB,WAAW,GAAG,EAAE,EAChB,iBAAiB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAC1B,YAAY,GACI;QAChB,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC,KAAK,CAAC;YAChE,gBAAgB,EAAE,YAAY;YAC9B,eAAe,EAAE,KAAK;YACtB,mBAAmB,EAAE,IAAI;YACzB,QAAQ,EAAE,KAAK;YACf,eAAe,EAAE,IAAI;YACrB,GAAG,WAAW;SACf,CAAC,CAAC;QACH,4BAA4B;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;YAC1B,eAAe,EAAgB,eAAe;YAC9C,MAAM,EAAE,YAAY;SACrB,CAAC,CAAC;QACH,8GAA8G;QAC9G,MAAM,oBAAoB,GAAuD,EAAE,CAAC;QAEpF,gEAAgE;QAChE,4DAA4D;QAC5D,KAAK,MAAM,IAAI,IAAmC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5E,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAS,CAAC,CAAC,KAAa,EAAE,OAAgB,EAAE,GAAG,IAAe,EAAE,EAAE;gBAC/F,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;gBAChD,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAEjD,8BAA8B;gBAC9B,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC;gBAChC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;gBACnD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC7B,mDAAmD;oBACnD,IAAI,YAAY,EAAE,CAAC;wBACjB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC9B,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC1D,CAAC;gBACH,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAmD,oBAAoB,CAAC;IAC1E,CAAC;IAEO,OAAO,CAAC,EAAE,eAAe,EAAE,MAAM,GAAG,EAAE,EAG7C;QAEC,OACuD,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;IAChH,CAAC;CACF","sourcesContent":["import type {\n  ILexerConfig,\n  IParserConfig,\n  IRecognitionException,\n  TokenType,\n  TokenVocabulary,\n  EmbeddedActionsParser,\n} from '@traqula/chevrotain';\nimport { LexerBuilder } from '../lexer-builder/LexerBuilder.js';\nimport type { CheckOverlap } from '../utils.js';\nimport type {\n  ParseMethodsFromRules,\n  ParserFromRules,\n  ParseRuleMap,\n  ParseRulesToObject,\n  ParseNamesFromList,\n} from './builderTypes.js';\nimport { DynamicParser } from './dynamicParser.js';\nimport type { ParserRule } from './ruleDefTypes.js';\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nfunction listToRuleDefMap<T extends readonly ParserRule[]>(rules: T): ParseRulesToObject<T> {\n  const newRules: Record<string, ParserRule> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <ParseRulesToObject<T>>newRules;\n}\n\nexport interface ParserBuildArgs {\n  tokenVocabulary: readonly TokenType[];\n  parserConfig?: IParserConfig;\n  lexerConfig?: ILexerConfig;\n  queryPreProcessor?: (input: string) => string;\n  errorHandler?: (errors: IRecognitionException[]) => void;\n}\n\n/**\n * The grammar builder. This is the core of traqula (besides using the amazing chevrotain framework).\n * Using the builder you can create a grammar + AST creator.\n * At any point in time, a parser can be constructed from the added rules.\n * Constructing a parser will cause a validation which will validate the correctness of the grammar.\n */\n// This code is wild so other code can be simple.\nexport class ParserBuilder<Context, Names extends string, RuleDefs extends ParseRuleMap<Names>> {\n  /**\n   * Create a builder from some initial grammar rules or an existing builder.\n   * If a builder is provided, a new copy will be created.\n   */\n  public static create<\n    Rules extends readonly ParserRule[] = readonly ParserRule[],\n    Context = Rules[0] extends ParserRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends ParseRuleMap<Names> = ParseRulesToObject<Rules>,\n  >(\n    start: Rules | ParserBuilder<Context, Names, RuleDefs>,\n  ): ParserBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <ParserBuilder<Context, Names, RuleDefs>> <unknown> new ParserBuilder(listToRuleDefMap(start));\n    }\n    return new ParserBuilder({ ...(<ParserBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  public widenContext<NewContext extends Context>(): ParserBuilder<\n    NewContext,\nNames,\n{[Key in keyof RuleDefs]: Key extends Names ?\n    (RuleDefs[Key] extends ParserRule<any, any, infer RT, infer PT> ? ParserRule<NewContext, Key, RT, PT> : never)\n  : never }\n> {\n    return <any> this;\n  }\n\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  ParserBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? ParserRule<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only one - infer yourself\n      Patch[Key] extends [any] ? (\n        RuleDefs[Key] extends ParserRule<any, any, any, infer Par> ?\n          ParserRule<Context, Key, Patch[Key][0], Par> : never\n      ) : never\n    )\n  ) : (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never) }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing grammar rule.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: ParserRule<Context, U, RET, ARGS>):\n  ParserBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    ParserRule<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <ParserBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      ParserRule<Context, Key, RET, ARGS> : (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: ParserRule<Context, U, RET, ARGS>):\n  ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    ParserRule<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never)\n  }> {\n    const self = <ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n      ParserRule<Context, K, RET, ARGS> :\n        (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never) }>>\n      <unknown> this;\n    const rules = <Record<string, ParserRule<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Rule ${rule.name} already exists in the builder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, ParserRule<Context, U, RET, ARGS>>,\n  ): ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    ParserRule<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never) }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  public addMany<U extends readonly ParserRule<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): ParserBuilder<\n      Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof ParseRulesToObject<typeof rules> ? (\n        ParseRulesToObject<typeof rules>[K] extends ParserRule<Context, K> ? ParseRulesToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n    > {\n    this.rules = { ...this.rules, ...listToRuleDefMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }> {\n    for (const ruleName of ruleNames) {\n      delete this.rules[ruleName];\n    }\n    return <ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends ParserRule<any, U, infer RT, infer PT> ?\n    ParserRule<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this grammar builder with another.\n   * It is best to merge the bigger grammar with the smaller one.\n   * If the two builders both have a grammar rule with the same name,\n   * no error will be thrown case they map to the same ruledef object.\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,\n   * this rule implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends ParseRuleMap<OtherNames>,\n    OW extends readonly ParserRule<Context>[],\n  >(\n    builder: ParserBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    ParserBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof ParseRulesToObject<OW> ? (\n          ParseRulesToObject<OW>[K] extends ParserRule<Context, K> ? ParseRulesToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends ParserRule<Context, K> ? OtherRules[K] : never) : never\n            ) }\n    > {\n    // Assume the other grammar is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, ParserRule<Context>> = { ...builder.rules };\n    const myRules: Record<string, ParserRule<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Rule with name \"${rule.name}\" already exists in the builder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  private defaultErrorHandler(input: string, errors: IRecognitionException[]): void {\n    const firstError = errors[0];\n    const messageBuilder: string[] = [ 'Parse error' ];\n    const lineIdx = firstError.token.startLine;\n    if (lineIdx !== undefined && !Number.isNaN(lineIdx)) {\n      const errorLine = input.split('\\n')[lineIdx - 1];\n      messageBuilder.push(` on line ${lineIdx}\n${errorLine}`);\n      const columnIdx = firstError.token.startColumn;\n      if (columnIdx !== undefined) {\n        messageBuilder.push(`\\n${'-'.repeat(columnIdx - 1)}^`);\n      }\n    }\n    messageBuilder.push(`\\n${firstError.message}`);\n    throw new Error(messageBuilder.join(''));\n  }\n\n  public build({\n    tokenVocabulary,\n    parserConfig = {},\n    lexerConfig = {},\n    queryPreProcessor = s => s,\n    errorHandler,\n  }: ParserBuildArgs): ParserFromRules<Context, Names, RuleDefs> {\n    const lexer = LexerBuilder.create().add(...tokenVocabulary).build({\n      positionTracking: 'onlyOffset',\n      recoveryEnabled: false,\n      ensureOptimizations: true,\n      safeMode: false,\n      skipValidations: true,\n      ...lexerConfig,\n    });\n    // Get the chevrotain parser\n    const parser = this.consume({\n      tokenVocabulary: <TokenType[]> tokenVocabulary,\n      config: parserConfig,\n    });\n    // Start building a parser that does not pass input using a state, but instead gets it as a function argument.\n    const selfSufficientParser: Partial<ParserFromRules<Context, Names, RuleDefs>> = {};\n\n    // To do that, we need to create a wrapper for each parser rule.\n    // eslint-disable-next-line ts/no-unnecessary-type-assertion\n    for (const rule of <ParserRule<Context, Names>[]> Object.values(this.rules)) {\n      selfSufficientParser[rule.name] = <any> ((input: string, context: Context, ...args: unknown[]) => {\n        const processedInput = queryPreProcessor(input);\n        const lexResult = lexer.tokenize(processedInput);\n\n        // This also resets the parser\n        parser.input = lexResult.tokens;\n        parser.setContext(context);\n        const result = parser[rule.name](context, ...args);\n        if (parser.errors.length > 0) {\n          // Console.log(JSON.stringify(lexResult, null, 2));\n          if (errorHandler) {\n            errorHandler(parser.errors);\n          } else {\n            this.defaultErrorHandler(processedInput, parser.errors);\n          }\n        }\n        return result;\n      });\n    }\n    return <ParserFromRules<Context, Names, RuleDefs>> selfSufficientParser;\n  }\n\n  private consume({ tokenVocabulary, config = {}}: {\n    tokenVocabulary: TokenVocabulary;\n    config?: IParserConfig;\n  }): EmbeddedActionsParser & ParseMethodsFromRules<Context, Names, RuleDefs> &\n    { setContext: (context: Context) => void } {\n    return <EmbeddedActionsParser & ParseMethodsFromRules<Context, Names, RuleDefs> &\n      { setContext: (context: Context) => void }><unknown> new DynamicParser(this.rules, tokenVocabulary, config);\n  }\n}\n"]}
+{"version":3,"file":"parserBuilder.js","sourceRoot":"","sources":["../../../../lib/parser-builder/parserBuilder.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAShE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD;;GAEG;AACH,SAAS,gBAAgB,CAAkC,KAAQ;IACjE,MAAM,QAAQ,GAA+B,EAAE,CAAC;IAChD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA8B,QAAQ,CAAC;AACzC,CAAC;AAoBD;;;;;GAKG;AACH,iDAAiD;AACjD,MAAM,OAAO,aAAa;IACxB;;;OAGG;IACI,MAAM,CAAC,MAAM,CAMlB,KAAsD;QAEtD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAA2D,IAAI,aAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QACxG,CAAC;QACD,OAAO,IAAI,aAAa,CAAC,EAAE,GAAkC,KAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC/E,CAAC;IAEO,KAAK,CAAW;IAExB,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,YAAY;QAOjB,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,SAAS;QAUd,OAAa,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAA2C,KAAwC;QAKjG,MAAM,IAAI,GAEE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA4C,IAAuC;QAKxG,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAAyC,IAAI,CAAC,KAAK,CAAC;QAC/D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;QACrE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAA+D;QAI/D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CACZ,GAAG,KAAoD;QAYvD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,UAAU,CAAkB,GAAG,SAAc;QAGlD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAkB,QAAW;QAEzC,OAAa,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAKV,OAAuD,EACvD,eAAmB;QAcnB,yFAAyF;QACzF,MAAM,UAAU,GAAwC,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7E,MAAM,OAAO,GAAwC,IAAI,CAAC,KAAK,CAAC;QAEhE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;oBAC1H,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAEO,mBAAmB,CAAC,KAAa,EAAE,MAA+B;QACxE,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,cAAc,GAAa,CAAE,aAAa,CAAE,CAAC;QACnD,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACpD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;YACjD,cAAc,CAAC,IAAI,CAAC,YAAY,OAAO;EAC3C,SAAS,EAAE,CAAC,CAAC;YACT,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC;YAC/C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,cAAc,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QACD,cAAc,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,EACX,eAAe,EACf,YAAY,GAAG,EAAE,EACjB,WAAW,GAAG,EAAE,EAChB,iBAAiB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAC1B,YAAY,GACI;QAChB,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,CAAC,KAAK,CAAC;YAChE,gBAAgB,EAAE,YAAY;YAC9B,eAAe,EAAE,KAAK;YACtB,mBAAmB,EAAE,IAAI;YACzB,QAAQ,EAAE,KAAK;YACf,eAAe,EAAE,IAAI;YACrB,GAAG,WAAW;SACf,CAAC,CAAC;QACH,4BAA4B;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;YAC1B,eAAe,EAAgB,eAAe;YAC9C,MAAM,EAAE,YAAY;SACrB,CAAC,CAAC;QACH,8GAA8G;QAC9G,MAAM,oBAAoB,GAAuD,EAAE,CAAC;QAEpF,gEAAgE;QAChE,4DAA4D;QAC5D,KAAK,MAAM,IAAI,IAAmC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5E,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAS,CAAC,CAAC,KAAa,EAAE,OAAgB,EAAE,GAAG,IAAe,EAAE,EAAE;gBAC/F,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;gBAChD,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAEjD,8BAA8B;gBAC9B,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC;gBAChC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;gBACnD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC7B,mDAAmD;oBACnD,IAAI,YAAY,EAAE,CAAC;wBACjB,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC9B,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;oBAC1D,CAAC;gBACH,CAAC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAmD,oBAAoB,CAAC;IAC1E,CAAC;IAEO,OAAO,CAAC,EAAE,eAAe,EAAE,MAAM,GAAG,EAAE,EAG7C;QAEC,OACuD,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;IAChH,CAAC;CACF","sourcesContent":["import type {\n  ILexerConfig,\n  IParserConfig,\n  IRecognitionException,\n  TokenType,\n  TokenVocabulary,\n  EmbeddedActionsParser,\n} from '@traqula/chevrotain';\nimport { LexerBuilder } from '../lexer-builder/LexerBuilder.js';\nimport type { CheckOverlap } from '../utils.js';\nimport type {\n  ParseMethodsFromRules,\n  ParserFromRules,\n  ParseRuleMap,\n  ParseRulesToObject,\n  ParseNamesFromList,\n} from './builderTypes.js';\nimport { DynamicParser } from './dynamicParser.js';\nimport type { ParserRule } from './ruleDefTypes.js';\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nfunction listToRuleDefMap<T extends readonly ParserRule[]>(rules: T): ParseRulesToObject<T> {\n  const newRules: Record<string, ParserRule> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <ParseRulesToObject<T>>newRules;\n}\n\n/**\n * Configuration for {@link ParserBuilder.build}. Specifies the token vocabulary,\n * optional Chevrotain parser/lexer configuration, and optional hooks for\n * preprocessing input or handling parse errors.\n */\nexport interface ParserBuildArgs {\n  /** The complete token vocabulary the parser and lexer should recognize. */\n  tokenVocabulary: readonly TokenType[];\n  /** Optional Chevrotain parser configuration (e.g., `maxLookahead`). */\n  parserConfig?: IParserConfig;\n  /** Optional Chevrotain lexer configuration (e.g., `positionTracking`). */\n  lexerConfig?: ILexerConfig;\n  /** Optional function to preprocess the input string before lexing. */\n  queryPreProcessor?: (input: string) => string;\n  /** Optional custom error handler. If omitted, a default handler throws on the first error. */\n  errorHandler?: (errors: IRecognitionException[]) => void;\n}\n\n/**\n * The grammar builder. This is the core of traqula (besides using the amazing chevrotain framework).\n * Using the builder you can create a grammar + AST creator.\n * At any point in time, a parser can be constructed from the added rules.\n * Constructing a parser will cause a validation which will validate the correctness of the grammar.\n */\n// This code is wild so other code can be simple.\nexport class ParserBuilder<Context, Names extends string, RuleDefs extends ParseRuleMap<Names>> {\n  /**\n   * Create a builder from some initial grammar rules or an existing builder.\n   * If a builder is provided, a new copy will be created.\n   */\n  public static create<\n    Rules extends readonly ParserRule[] = readonly ParserRule[],\n    Context = Rules[0] extends ParserRule<infer context> ? context : never,\n    Names extends string = ParseNamesFromList<Rules>,\n    RuleDefs extends ParseRuleMap<Names> = ParseRulesToObject<Rules>,\n  >(\n    start: Rules | ParserBuilder<Context, Names, RuleDefs>,\n  ): ParserBuilder<Context, Names, RuleDefs> {\n    if (Array.isArray(start)) {\n      return <ParserBuilder<Context, Names, RuleDefs>> <unknown> new ParserBuilder(listToRuleDefMap(start));\n    }\n    return new ParserBuilder({ ...(<ParserBuilder<any, any, any>>start).rules });\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  /**\n   * Narrow the builder's context type parameter to a more specific subtype.\n   * This is a zero-cost type-level operation — the builder instance is returned as-is\n   * but with updated type parameters.\n   */\n  public widenContext<NewContext extends Context>(): ParserBuilder<\n    NewContext,\nNames,\n{[Key in keyof RuleDefs]: Key extends Names ?\n    (RuleDefs[Key] extends ParserRule<any, any, infer RT, infer PT> ? ParserRule<NewContext, Key, RT, PT> : never)\n  : never }\n> {\n    return <any> this;\n  }\n\n  /**\n   * Update the type signatures (return types and/or parameter types) of existing rules\n   * without changing their implementations. Use this when a patched rule changes the types\n   * flowing through downstream rules that don't need new implementations.\n   * This is a zero-cost type-level operation.\n   */\n  public typePatch<Patch extends {[Key in Names]?: [any] | [any, any[]]}>():\n  ParserBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    Patch[Key] extends [any, any[]] ? ParserRule<Context, Key, Patch[Key][0], Patch[Key][1]> : (\n      // Only one - infer yourself\n      Patch[Key] extends [any] ? (\n        RuleDefs[Key] extends ParserRule<any, any, any, infer Par> ?\n          ParserRule<Context, Key, Patch[Key][0], Par> : never\n      ) : never\n    )\n  ) : (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never) }> {\n    return <any> this;\n  }\n\n  /**\n   * Change the implementation of an existing grammar rule.\n   */\n  public patchRule<U extends Names, RET, ARGS extends any[]>(patch: ParserRule<Context, U, RET, ARGS>):\n  ParserBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    ParserRule<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <ParserBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      ParserRule<Context, Key, RET, ARGS> : (RuleDefs[Key] extends ParserRule<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS extends any[]>(rule: ParserRule<Context, U, RET, ARGS>):\n  ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    ParserRule<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never)\n  }> {\n    const self = <ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n      ParserRule<Context, K, RET, ARGS> :\n        (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never) }>>\n      <unknown> this;\n    const rules = <Record<string, ParserRule<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Rule ${rule.name} already exists in the builder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS extends any[]>(\n    rule: CheckOverlap<U, Names, ParserRule<Context, U, RET, ARGS>>,\n  ): ParserBuilder<Context, Names | U, {[K in Names | U]: K extends U ?\n    ParserRule<Context, K, RET, ARGS> :\n      (K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never) }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  /**\n   * Add multiple rules at once using rest parameters.\n   * Provides better TypeScript type inference than calling {@link addRule} in a loop,\n   * but avoid passing too many rules at once as this can cause TypeScript compilation slowdowns.\n   * TypeScript errors if any rule name conflicts with an existing one.\n   */\n  public addMany<U extends readonly ParserRule<Context>[]>(\n    ...rules: CheckOverlap<ParseNamesFromList<U>, Names, U>\n  ): ParserBuilder<\n      Context,\n    Names | ParseNamesFromList<U>,\n    {[K in Names | ParseNamesFromList<U>]:\n      K extends keyof ParseRulesToObject<typeof rules> ? (\n        ParseRulesToObject<typeof rules>[K] extends ParserRule<Context, K> ? ParseRulesToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n    > {\n    this.rules = { ...this.rules, ...listToRuleDefMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Delete multiple rules by name in a single call.\n   * @param ruleNames - Names of the rules to delete.\n   */\n  public deleteMany<U extends Names>(...ruleNames: U[]):\n  ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }> {\n    for (const ruleName of ruleNames) {\n      delete this.rules[ruleName];\n    }\n    return <ParserBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Retrieve a grammar rule definition by its name.\n   * Useful for inspecting or wrapping existing rules when extending a parser.\n   * @param ruleName - The name of the rule, type-checked against the builder's known rule names.\n   */\n  public getRule<U extends Names>(ruleName: U): RuleDefs[U] extends ParserRule<any, U, infer RT, infer PT> ?\n    ParserRule<Context, U, RT, PT> : never {\n    return <any> this.rules[ruleName];\n  }\n\n  /**\n   * Merge this grammar builder with another.\n   * It is best to merge the bigger grammar with the smaller one.\n   * If the two builders both have a grammar rule with the same name,\n   * no error will be thrown case they map to the same ruledef object.\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,\n   * this rule implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends ParseRuleMap<OtherNames>,\n    OW extends readonly ParserRule<Context>[],\n  >(\n    builder: ParserBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    ParserBuilder<\n      Context,\n      Names | OtherNames | ParseNamesFromList<OW>,\n      {[K in Names | OtherNames | ParseNamesFromList<OW>]:\n        K extends keyof ParseRulesToObject<OW> ? (\n          ParseRulesToObject<OW>[K] extends ParserRule<Context, K> ? ParseRulesToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends ParserRule<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends ParserRule<Context, K> ? OtherRules[K] : never) : never\n            ) }\n    > {\n    // Assume the other grammar is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, ParserRule<Context>> = { ...builder.rules };\n    const myRules: Record<string, ParserRule<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Rule with name \"${rule.name}\" already exists in the builder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  private defaultErrorHandler(input: string, errors: IRecognitionException[]): void {\n    const firstError = errors[0];\n    const messageBuilder: string[] = [ 'Parse error' ];\n    const lineIdx = firstError.token.startLine;\n    if (lineIdx !== undefined && !Number.isNaN(lineIdx)) {\n      const errorLine = input.split('\\n')[lineIdx - 1];\n      messageBuilder.push(` on line ${lineIdx}\n${errorLine}`);\n      const columnIdx = firstError.token.startColumn;\n      if (columnIdx !== undefined) {\n        messageBuilder.push(`\\n${'-'.repeat(columnIdx - 1)}^`);\n      }\n    }\n    messageBuilder.push(`\\n${firstError.message}`);\n    throw new Error(messageBuilder.join(''));\n  }\n\n  /**\n   * Construct a self-sufficient parser from the registered rules and token vocabulary.\n   * Building a parser is expensive (Chevrotain performs grammar recording), so the result\n   * should be reused across parse calls.\n   * @returns An object with a method for each registered rule name.\n   */\n  public build({\n    tokenVocabulary,\n    parserConfig = {},\n    lexerConfig = {},\n    queryPreProcessor = s => s,\n    errorHandler,\n  }: ParserBuildArgs): ParserFromRules<Context, Names, RuleDefs> {\n    const lexer = LexerBuilder.create().add(...tokenVocabulary).build({\n      positionTracking: 'onlyOffset',\n      recoveryEnabled: false,\n      ensureOptimizations: true,\n      safeMode: false,\n      skipValidations: true,\n      ...lexerConfig,\n    });\n    // Get the chevrotain parser\n    const parser = this.consume({\n      tokenVocabulary: <TokenType[]> tokenVocabulary,\n      config: parserConfig,\n    });\n    // Start building a parser that does not pass input using a state, but instead gets it as a function argument.\n    const selfSufficientParser: Partial<ParserFromRules<Context, Names, RuleDefs>> = {};\n\n    // To do that, we need to create a wrapper for each parser rule.\n    // eslint-disable-next-line ts/no-unnecessary-type-assertion\n    for (const rule of <ParserRule<Context, Names>[]> Object.values(this.rules)) {\n      selfSufficientParser[rule.name] = <any> ((input: string, context: Context, ...args: unknown[]) => {\n        const processedInput = queryPreProcessor(input);\n        const lexResult = lexer.tokenize(processedInput);\n\n        // This also resets the parser\n        parser.input = lexResult.tokens;\n        parser.setContext(context);\n        const result = parser[rule.name](context, ...args);\n        if (parser.errors.length > 0) {\n          // Console.log(JSON.stringify(lexResult, null, 2));\n          if (errorHandler) {\n            errorHandler(parser.errors);\n          } else {\n            this.defaultErrorHandler(processedInput, parser.errors);\n          }\n        }\n        return result;\n      });\n    }\n    return <ParserFromRules<Context, Names, RuleDefs>> selfSufficientParser;\n  }\n\n  private consume({ tokenVocabulary, config = {}}: {\n    tokenVocabulary: TokenVocabulary;\n    config?: IParserConfig;\n  }): EmbeddedActionsParser & ParseMethodsFromRules<Context, Names, RuleDefs> &\n    { setContext: (context: Context) => void } {\n    return <EmbeddedActionsParser & ParseMethodsFromRules<Context, Names, RuleDefs> &\n      { setContext: (context: Context) => void }><unknown> new DynamicParser(this.rules, tokenVocabulary, config);\n  }\n}\n"]}

dist/esm/lib/transformers/TransformerObject.d.ts

@@ -36,2 +36,13 @@ export interface VisitContext {
 }
+/**
+ * Base transformer class for recursively visiting and transforming object trees.
+ * Operates on plain JavaScript objects without requiring specific type structure.
+ *
+ * Uses an iterative (stack-based) algorithm instead of recursion to handle deep trees safely.
+ * Both {@link transformObject} and {@link visitObject} traverse depth-first, processing
+ * deeper objects before their parents (post-order).
+ *
+ * For type-aware traversal based on `type` and `subType` fields,
+ * see {@link TransformerTyped} and {@link TransformerSubTyped}.
+ */
 export declare class TransformerObject {
@@ -38,0 +49,0 @@ protected readonly defaultContext: TransformContext;

dist/esm/lib/transformers/TransformerObject.js

@@ -0,1 +1,12 @@
+/**
+ * Base transformer class for recursively visiting and transforming object trees.
+ * Operates on plain JavaScript objects without requiring specific type structure.
+ *
+ * Uses an iterative (stack-based) algorithm instead of recursion to handle deep trees safely.
+ * Both {@link transformObject} and {@link visitObject} traverse depth-first, processing
+ * deeper objects before their parents (post-order).
+ *
+ * For type-aware traversal based on `type` and `subType` fields,
+ * see {@link TransformerTyped} and {@link TransformerSubTyped}.
+ */
 export class TransformerObject {
@@ -2,0 +13,0 @@ defaultContext;

dist/esm/lib/transformers/TransformerObject.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"TransformerObject.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerObject.ts"],"names":[],"mappings":"AAsCA,MAAM,OAAO,iBAAiB;IAMU;IAL5B,YAAY,GAAG,SAAS,CAAC;IACnC;;;OAGG;IACH,YAAsC,iBAAmC,EAAE;QAArC,mBAAc,GAAd,cAAc,CAAuB;IAAG,CAAC;IAExE,KAAK,CAAC,oBAAsC,EAAE;QACnD,OAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,iBAAiB,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAI,GAAM;QACvB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAEzC,0BAA0B;QAC1B,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjD,6CAA6C;YAC7C,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;QACpB,CAAC;QAED,mDAAmD;QACnD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CACpB,WAAmB,EACnB,MAA+C,EAC/C,aAAiD,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAE3D,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC;QACrC,MAAM,eAAe,GAAG,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC;QAC9C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;QACnD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC9C,MAAM,kBAAkB,GAAG,QAAQ,CAAC,WAAW,CAAC;QAChD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,QAAQ,IAAI,KAAK,CAAC;QAEtD,6FAA6F;QAC7F,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,MAAM,UAAU,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC;QAExC,mBAAmB;QACnB,MAAM,KAAK,GAAG,CAAE,WAAW,CAAE,CAAC;QAC9B,MAAM,WAAW,GAAa,CAAE,UAAU,CAAE,CAAC;QAC7C,MAAM,cAAc,GAAa,CAAE,KAAK,CAAE,CAAC;QAE3C,uGAAuG;QACvG,iHAAiH;QACjH,MAAM,iBAAiB,GAAa,EAAE,CAAC;QACvC,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,eAAe,GAAa,EAAE,CAAC;QAErC,SAAS,YAAY;YACnB,OAAO,KAAK,CAAC,MAAM,KAAK,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjD,iBAAiB,CAAC,GAAG,EAAE,CAAC;gBACxB,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,MAAM,GAA6B,YAAY,CAAC,GAAG,EAAG,CAAC;gBAC7D,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5D,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAC/B,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAG,CAAC;YACrC,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,EAAG,CAAC;YAErC,kDAAkD;YAClD,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7B,MAAM,MAAM,GAAG,CAAE,GAAG,SAAS,CAAE,CAAC;oBAChC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;oBACrC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC7B,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAChC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAC7B,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAE7B,KAAK,IAAI,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;wBAC3D,MAAM,GAAG,GAAa,SAAS,CAAC,KAAK,CAAC,CAAC;wBACvC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAChB,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;4BACzB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;wBACxC,CAAC;oBACH,CAAC;oBACD,YAAY,EAAE,CAAC;oBACf,SAAS;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,UAAU,CAAM,SAAS,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,IAAI,eAAe,CAAC;gBACjD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;gBACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;gBAC3D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,kBAAkB,CAAC;gBAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,kBAAkB,CAAC;gBAErD,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAE7D,uCAAuC;gBACvC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACrC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3B,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAChC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC7B,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE7B,oGAAoG;gBACpG,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;wBACvB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;4BAC9B,SAAS;wBACX,CAAC;wBACD,MAAM,GAAG,GAA8B,IAAK,CAAC,GAAG,CAAC,CAAC;wBAElD,+BAA+B;wBAC/B,MAAM,WAAW,GAAG,WAAW,IAAI,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;wBACzD,IAAI,WAAW,EAAE,CAAC;4BAChB,gDAAgD;4BACrB,IAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;wBAC7D,CAAC;wBACD,IAAI,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;4BACtC,yBAAyB;4BACzB,SAAS;wBACX,CAAC;wBACD,IAAI,CAAC,WAAW,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5D,sBAAsB;4BACtB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAChB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BACzB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACzB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,YAAY,EAAE,CAAC;QACjB,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,YAAY,EAAE,CAAC;QAEf,OAAa,UAAU,CAAC,GAAG,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,WAAW,CAChB,WAAmB,EACnB,OAA+B,EAC/B,aAA6C,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAEvD,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC;QACrC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;QACnD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC9C,MAAM,eAAe,GAAG,QAAQ,CAAC,QAAQ,IAAI,KAAK,CAAC;QAEnD,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,8BAA8B;QAC9B,MAAM,KAAK,GAAG,CAAE,WAAW,CAAE,CAAC;QAC9B,iFAAiF;QACjF,MAAM,kBAAkB,GAAa,EAAE,CAAC;QACxC,MAAM,YAAY,GAAa,EAAE,CAAC;QAElC,SAAS,aAAa;YACpB,OAAO,KAAK,CAAC,MAAM,KAAK,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClD,kBAAkB,CAAC,GAAG,EAAE,CAAC;gBACzB,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,EAAG,CAAC;gBACpC,OAAO,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5D,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAE/B,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7B,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBAC/C,MAAM,GAAG,GAAa,SAAS,CAAC,CAAC,CAAC,CAAC;wBACnC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAClB,CAAC;oBACH,CAAC;oBACD,aAAa,EAAE,CAAC;oBAChB,SAAS;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;gBACtC,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC;gBAClD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;gBACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;gBAE3D,uCAAuC;gBACvC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACtC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAE7B,oGAAoG;gBACpG,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC9B,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;wBAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC;4BACnC,SAAS;wBACX,CAAC;wBACD,IAAI,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;4BACtC,SAAS;wBACX,CAAC;wBACD,MAAM,GAAG,GAA8B,SAAU,CAAC,GAAG,CAAC,CAAC;wBACvD,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BACnC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAClB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,aAAa,EAAE,CAAC;QAClB,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,aAAa,EAAE,CAAC;IAClB,CAAC;CACF","sourcesContent":["export interface VisitContext {\n  /**\n   * Whether you should stop iterating after this object. Default false.\n   */\n  shortcut?: boolean;\n  /**\n   * Whether you should continue iterating deeper with this object. Default true.\n   */\n  continue?: boolean;\n  /**\n   * Object keys that can be ignored, meaning they do not get visited.\n   */\n  ignoreKeys?: Set<string>;\n}\n\nexport interface TransformContext extends VisitContext {\n  /**\n   * Object keys that will be shallowly copied but not traversed.\n   * When the same key is included here and in ignoreKeys, the copy will still be made.\n   */\n  shallowKeys?: Set<string>;\n  /**\n   * Whether the visited object should be shallowly copied or not. Defaults to true.\n   */\n  copy?: boolean;\n}\n\nexport interface SelectiveTraversalContext<Nodes> {\n  /**\n   * Nodes you should visit next. Defaults to empty list\n   */\n  next?: Nodes[];\n  /**\n   * Whether you should stop visiting after visiting this object. Default false.\n   */\n  shortcut?: boolean;\n}\n\nexport class TransformerObject {\n  protected maxStackSize = 1_000_000;\n  /**\n   * Creates stateless transformer.\n   * @param defaultContext\n   */\n  public constructor(protected readonly defaultContext: TransformContext = {}) {}\n\n  public clone(newDefaultContext: TransformContext = {}): TransformerObject {\n    return new TransformerObject({ ...this.defaultContext, ...newDefaultContext });\n  }\n\n  /**\n   * Function to shallow clone any type.\n   * @param obj\n   * @protected\n   */\n  public cloneObj<T>(obj: T): T {\n    if (obj === null || typeof obj !== 'object') {\n      return obj;\n    }\n\n    const proto = Object.getPrototypeOf(obj);\n\n    // Fast path: plain object\n    if (proto === Object.prototype || proto === null) {\n      // Spread or assign preserves fast properties\n      return { ...obj };\n    }\n\n    // Otherwise, preserve prototype for custom objects\n    return Object.assign(Object.create(proto), obj);\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: (copy: object, orig: object) => unknown,\n    preVisitor: (orig: object) => TransformContext = () => ({}),\n  ): unknown {\n    const defaults = this.defaultContext;\n    const defaultCopyFlag = defaults.copy ?? true;\n    const defaultContinues = defaults.continue ?? true;\n    const defaultIgnoreKeys = defaults.ignoreKeys;\n    const defaultShallowKeys = defaults.shallowKeys;\n    const defaultDidShortCut = defaults.shortcut ?? false;\n\n    // Code handles own stack instead of using recursion - this optimizes it for deep operations.\n    let didShortCut = false;\n    const resultWrap = { res: startObject };\n\n    // Grows with stack\n    const stack = [ startObject ];\n    const stackParent: object[] = [ resultWrap ];\n    const stackParentKey: string[] = [ 'res' ];\n\n    // Grows with reverse stack - when popping down the stack, you realise you still want to map something.\n    // Counter of stack size when we started adding the children of this object, going beyond this means a new parent\n    const handleMapperOnLen: number[] = [];\n    const mapperCopyStack: object[] = [];\n    const mapperOrigStack: object[] = [];\n    const mapperParent: object[] = [];\n    const mapperParentKey: string[] = [];\n\n    function handleMapper(): void {\n      while (stack.length === handleMapperOnLen.at(-1)) {\n        handleMapperOnLen.pop();\n        const copyToMap = mapperCopyStack.pop()!;\n        const origToMap = mapperOrigStack.pop()!;\n        const parent = <Record<string, unknown>> mapperParent.pop()!;\n        const parentKey = mapperParentKey.pop()!;\n        parent[parentKey] = mapper(copyToMap, origToMap);\n      }\n    }\n\n    while (stack.length > 0 && stack.length < this.maxStackSize) {\n      const curObject = stack.pop()!;\n      const curParent = stackParent.pop()!;\n      const curKey = stackParentKey.pop()!;\n\n      // Only add to the stack when you did not shortcut\n      if (!didShortCut) {\n        if (Array.isArray(curObject)) {\n          const newArr = [ ...curObject ];\n          handleMapperOnLen.push(stack.length);\n          mapperCopyStack.push(newArr);\n          mapperOrigStack.push(curObject);\n          mapperParent.push(curParent);\n          mapperParentKey.push(curKey);\n\n          for (let index = curObject.length - 1; index >= 0; index--) {\n            const val = <unknown> curObject[index];\n            if (val !== null && typeof val === 'object') {\n              stack.push(val);\n              stackParent.push(newArr);\n              stackParentKey.push(index.toString());\n            }\n          }\n          handleMapper();\n          continue;\n        }\n\n        // Perform pre visit before expanding the stack\n        const context = preVisitor(<any>curObject);\n        const copyFlag = context.copy ?? defaultCopyFlag;\n        const continues = context.continue ?? defaultContinues;\n        const ignoreKeys = context.ignoreKeys ?? defaultIgnoreKeys;\n        const shallowKeys = context.shallowKeys ?? defaultShallowKeys;\n        didShortCut = context.shortcut ?? defaultDidShortCut;\n\n        const copy = copyFlag ? this.cloneObj(curObject) : curObject;\n\n        // Register that you want to be visited\n        handleMapperOnLen.push(stack.length);\n        mapperCopyStack.push(copy);\n        mapperOrigStack.push(curObject);\n        mapperParent.push(curParent);\n        mapperParentKey.push(curKey);\n\n        // Extend stack if needed. When shortcutted, should still unwind the stack, but no longer add to it.\n        if (continues && !didShortCut) {\n          for (const key in copy) {\n            if (!Object.hasOwn(copy, key)) {\n              continue;\n            }\n            const val = (<Record<string, unknown>> copy)[key];\n\n            // If shallow copy required, do\n            const onlyShallow = shallowKeys && shallowKeys?.has(key);\n            if (onlyShallow) {\n              // Do not add stack entry - assign straight away\n              (<Record<string, unknown>> copy)[key] = this.cloneObj(val);\n            }\n            if (ignoreKeys && ignoreKeys.has(key)) {\n              // Do not add stack entry\n              continue;\n            }\n            if (!onlyShallow && val !== null && typeof val === 'object') {\n              // Do add stack entry.\n              stack.push(val);\n              stackParentKey.push(key);\n              stackParent.push(copy);\n            }\n          }\n        }\n      }\n      handleMapper();\n    }\n    if (stack.length >= this.maxStackSize) {\n      throw new Error('Transform object stack overflowed');\n    }\n    handleMapper();\n\n    return <any> resultWrap.res;\n  }\n\n  /**\n   * Visitor that visits all objects. Visits deeper objects first.\n   */\n  public visitObject(\n    startObject: object,\n    visitor: (orig: object) => void,\n    preVisitor: (orig: object) => VisitContext = () => ({}),\n  ): void {\n    const defaults = this.defaultContext;\n    const defaultContinues = defaults.continue ?? true;\n    const defaultIgnoreKeys = defaults.ignoreKeys;\n    const defaultShortcut = defaults.shortcut ?? false;\n\n    let didShortCut = false;\n\n    // Stack of things to preVisit\n    const stack = [ startObject ];\n    // When the stack is done preVisiting things above this lengths, visit the bellow\n    const handleVisitorOnLen: number[] = [];\n    const visitorStack: object[] = [];\n\n    function handleVisitor(): void {\n      while (stack.length === handleVisitorOnLen.at(-1)) {\n        handleVisitorOnLen.pop();\n        const toVisit = visitorStack.pop()!;\n        visitor(toVisit);\n      }\n    }\n\n    while (stack.length > 0 && stack.length < this.maxStackSize) {\n      const curObject = stack.pop()!;\n\n      if (!didShortCut) {\n        if (Array.isArray(curObject)) {\n          for (let i = curObject.length - 1; i >= 0; i--) {\n            const val = <unknown> curObject[i];\n            if (val !== null && typeof val === 'object') {\n              stack.push(val);\n            }\n          }\n          handleVisitor();\n          continue;\n        }\n\n        // Perform pre visit before expanding the stack\n        const context = preVisitor(curObject);\n        didShortCut = context.shortcut ?? defaultShortcut;\n        const continues = context.continue ?? defaultContinues;\n        const ignoreKeys = context.ignoreKeys ?? defaultIgnoreKeys;\n\n        // Register that you want to be visited\n        handleVisitorOnLen.push(stack.length);\n        visitorStack.push(curObject);\n\n        // Extend stack if needed. When shortcutted, should still unwind the stack, but no longer add to it.\n        if (continues && !didShortCut) {\n          for (const key in curObject) {\n            if (!Object.hasOwn(curObject, key)) {\n              continue;\n            }\n            if (ignoreKeys && ignoreKeys.has(key)) {\n              continue;\n            }\n            const val = (<Record<string, unknown>> curObject)[key];\n            if (val && typeof val === 'object') {\n              stack.push(val);\n            }\n          }\n        }\n      }\n      handleVisitor();\n    }\n    if (stack.length >= this.maxStackSize) {\n      throw new Error('Transform object stack overflowed');\n    }\n    handleVisitor();\n  }\n}\n"]}
+{"version":3,"file":"TransformerObject.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerObject.ts"],"names":[],"mappings":"AAsCA;;;;;;;;;;GAUG;AACH,MAAM,OAAO,iBAAiB;IAMU;IAL5B,YAAY,GAAG,SAAS,CAAC;IACnC;;;OAGG;IACH,YAAsC,iBAAmC,EAAE;QAArC,mBAAc,GAAd,cAAc,CAAuB;IAAG,CAAC;IAExE,KAAK,CAAC,oBAAsC,EAAE;QACnD,OAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,iBAAiB,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAI,GAAM;QACvB,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAEzC,0BAA0B;QAC1B,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjD,6CAA6C;YAC7C,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;QACpB,CAAC;QAED,mDAAmD;QACnD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CACpB,WAAmB,EACnB,MAA+C,EAC/C,aAAiD,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAE3D,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC;QACrC,MAAM,eAAe,GAAG,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC;QAC9C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;QACnD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC9C,MAAM,kBAAkB,GAAG,QAAQ,CAAC,WAAW,CAAC;QAChD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,QAAQ,IAAI,KAAK,CAAC;QAEtD,6FAA6F;QAC7F,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,MAAM,UAAU,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC;QAExC,mBAAmB;QACnB,MAAM,KAAK,GAAG,CAAE,WAAW,CAAE,CAAC;QAC9B,MAAM,WAAW,GAAa,CAAE,UAAU,CAAE,CAAC;QAC7C,MAAM,cAAc,GAAa,CAAE,KAAK,CAAE,CAAC;QAE3C,uGAAuG;QACvG,iHAAiH;QACjH,MAAM,iBAAiB,GAAa,EAAE,CAAC;QACvC,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,eAAe,GAAa,EAAE,CAAC;QACrC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,eAAe,GAAa,EAAE,CAAC;QAErC,SAAS,YAAY;YACnB,OAAO,KAAK,CAAC,MAAM,KAAK,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjD,iBAAiB,CAAC,GAAG,EAAE,CAAC;gBACxB,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,MAAM,GAA6B,YAAY,CAAC,GAAG,EAAG,CAAC;gBAC7D,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAG,CAAC;gBACzC,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5D,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAC/B,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAG,CAAC;YACrC,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,EAAG,CAAC;YAErC,kDAAkD;YAClD,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7B,MAAM,MAAM,GAAG,CAAE,GAAG,SAAS,CAAE,CAAC;oBAChC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;oBACrC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC7B,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAChC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAC7B,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAE7B,KAAK,IAAI,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;wBAC3D,MAAM,GAAG,GAAa,SAAS,CAAC,KAAK,CAAC,CAAC;wBACvC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAChB,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;4BACzB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;wBACxC,CAAC;oBACH,CAAC;oBACD,YAAY,EAAE,CAAC;oBACf,SAAS;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,UAAU,CAAM,SAAS,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,IAAI,eAAe,CAAC;gBACjD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;gBACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;gBAC3D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,kBAAkB,CAAC;gBAC9D,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,kBAAkB,CAAC;gBAErD,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAE7D,uCAAuC;gBACvC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACrC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3B,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAChC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC7B,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE7B,oGAAoG;gBACpG,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;wBACvB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;4BAC9B,SAAS;wBACX,CAAC;wBACD,MAAM,GAAG,GAA8B,IAAK,CAAC,GAAG,CAAC,CAAC;wBAElD,+BAA+B;wBAC/B,MAAM,WAAW,GAAG,WAAW,IAAI,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;wBACzD,IAAI,WAAW,EAAE,CAAC;4BAChB,gDAAgD;4BACrB,IAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;wBAC7D,CAAC;wBACD,IAAI,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;4BACtC,yBAAyB;4BACzB,SAAS;wBACX,CAAC;wBACD,IAAI,CAAC,WAAW,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5D,sBAAsB;4BACtB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BAChB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;4BACzB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACzB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,YAAY,EAAE,CAAC;QACjB,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,YAAY,EAAE,CAAC;QAEf,OAAa,UAAU,CAAC,GAAG,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,WAAW,CAChB,WAAmB,EACnB,OAA+B,EAC/B,aAA6C,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAEvD,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC;QACrC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;QACnD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC9C,MAAM,eAAe,GAAG,QAAQ,CAAC,QAAQ,IAAI,KAAK,CAAC;QAEnD,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,8BAA8B;QAC9B,MAAM,KAAK,GAAG,CAAE,WAAW,CAAE,CAAC;QAC9B,iFAAiF;QACjF,MAAM,kBAAkB,GAAa,EAAE,CAAC;QACxC,MAAM,YAAY,GAAa,EAAE,CAAC;QAElC,SAAS,aAAa;YACpB,OAAO,KAAK,CAAC,MAAM,KAAK,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClD,kBAAkB,CAAC,GAAG,EAAE,CAAC;gBACzB,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,EAAG,CAAC;gBACpC,OAAO,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5D,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAE/B,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7B,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBAC/C,MAAM,GAAG,GAAa,SAAS,CAAC,CAAC,CAAC,CAAC;wBACnC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAClB,CAAC;oBACH,CAAC;oBACD,aAAa,EAAE,CAAC;oBAChB,SAAS;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;gBACtC,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC;gBAClD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,gBAAgB,CAAC;gBACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;gBAE3D,uCAAuC;gBACvC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACtC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAE7B,oGAAoG;gBACpG,IAAI,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC9B,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;wBAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC;4BACnC,SAAS;wBACX,CAAC;wBACD,IAAI,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;4BACtC,SAAS;wBACX,CAAC;wBACD,MAAM,GAAG,GAA8B,SAAU,CAAC,GAAG,CAAC,CAAC;wBACvD,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;4BACnC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAClB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,aAAa,EAAE,CAAC;QAClB,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,aAAa,EAAE,CAAC;IAClB,CAAC;CACF","sourcesContent":["export interface VisitContext {\n  /**\n   * Whether you should stop iterating after this object. Default false.\n   */\n  shortcut?: boolean;\n  /**\n   * Whether you should continue iterating deeper with this object. Default true.\n   */\n  continue?: boolean;\n  /**\n   * Object keys that can be ignored, meaning they do not get visited.\n   */\n  ignoreKeys?: Set<string>;\n}\n\nexport interface TransformContext extends VisitContext {\n  /**\n   * Object keys that will be shallowly copied but not traversed.\n   * When the same key is included here and in ignoreKeys, the copy will still be made.\n   */\n  shallowKeys?: Set<string>;\n  /**\n   * Whether the visited object should be shallowly copied or not. Defaults to true.\n   */\n  copy?: boolean;\n}\n\nexport interface SelectiveTraversalContext<Nodes> {\n  /**\n   * Nodes you should visit next. Defaults to empty list\n   */\n  next?: Nodes[];\n  /**\n   * Whether you should stop visiting after visiting this object. Default false.\n   */\n  shortcut?: boolean;\n}\n\n/**\n * Base transformer class for recursively visiting and transforming object trees.\n * Operates on plain JavaScript objects without requiring specific type structure.\n *\n * Uses an iterative (stack-based) algorithm instead of recursion to handle deep trees safely.\n * Both {@link transformObject} and {@link visitObject} traverse depth-first, processing\n * deeper objects before their parents (post-order).\n *\n * For type-aware traversal based on `type` and `subType` fields,\n * see {@link TransformerTyped} and {@link TransformerSubTyped}.\n */\nexport class TransformerObject {\n  protected maxStackSize = 1_000_000;\n  /**\n   * Creates stateless transformer.\n   * @param defaultContext\n   */\n  public constructor(protected readonly defaultContext: TransformContext = {}) {}\n\n  public clone(newDefaultContext: TransformContext = {}): TransformerObject {\n    return new TransformerObject({ ...this.defaultContext, ...newDefaultContext });\n  }\n\n  /**\n   * Function to shallow clone any type.\n   * @param obj\n   * @protected\n   */\n  public cloneObj<T>(obj: T): T {\n    if (obj === null || typeof obj !== 'object') {\n      return obj;\n    }\n\n    const proto = Object.getPrototypeOf(obj);\n\n    // Fast path: plain object\n    if (proto === Object.prototype || proto === null) {\n      // Spread or assign preserves fast properties\n      return { ...obj };\n    }\n\n    // Otherwise, preserve prototype for custom objects\n    return Object.assign(Object.create(proto), obj);\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: (copy: object, orig: object) => unknown,\n    preVisitor: (orig: object) => TransformContext = () => ({}),\n  ): unknown {\n    const defaults = this.defaultContext;\n    const defaultCopyFlag = defaults.copy ?? true;\n    const defaultContinues = defaults.continue ?? true;\n    const defaultIgnoreKeys = defaults.ignoreKeys;\n    const defaultShallowKeys = defaults.shallowKeys;\n    const defaultDidShortCut = defaults.shortcut ?? false;\n\n    // Code handles own stack instead of using recursion - this optimizes it for deep operations.\n    let didShortCut = false;\n    const resultWrap = { res: startObject };\n\n    // Grows with stack\n    const stack = [ startObject ];\n    const stackParent: object[] = [ resultWrap ];\n    const stackParentKey: string[] = [ 'res' ];\n\n    // Grows with reverse stack - when popping down the stack, you realise you still want to map something.\n    // Counter of stack size when we started adding the children of this object, going beyond this means a new parent\n    const handleMapperOnLen: number[] = [];\n    const mapperCopyStack: object[] = [];\n    const mapperOrigStack: object[] = [];\n    const mapperParent: object[] = [];\n    const mapperParentKey: string[] = [];\n\n    function handleMapper(): void {\n      while (stack.length === handleMapperOnLen.at(-1)) {\n        handleMapperOnLen.pop();\n        const copyToMap = mapperCopyStack.pop()!;\n        const origToMap = mapperOrigStack.pop()!;\n        const parent = <Record<string, unknown>> mapperParent.pop()!;\n        const parentKey = mapperParentKey.pop()!;\n        parent[parentKey] = mapper(copyToMap, origToMap);\n      }\n    }\n\n    while (stack.length > 0 && stack.length < this.maxStackSize) {\n      const curObject = stack.pop()!;\n      const curParent = stackParent.pop()!;\n      const curKey = stackParentKey.pop()!;\n\n      // Only add to the stack when you did not shortcut\n      if (!didShortCut) {\n        if (Array.isArray(curObject)) {\n          const newArr = [ ...curObject ];\n          handleMapperOnLen.push(stack.length);\n          mapperCopyStack.push(newArr);\n          mapperOrigStack.push(curObject);\n          mapperParent.push(curParent);\n          mapperParentKey.push(curKey);\n\n          for (let index = curObject.length - 1; index >= 0; index--) {\n            const val = <unknown> curObject[index];\n            if (val !== null && typeof val === 'object') {\n              stack.push(val);\n              stackParent.push(newArr);\n              stackParentKey.push(index.toString());\n            }\n          }\n          handleMapper();\n          continue;\n        }\n\n        // Perform pre visit before expanding the stack\n        const context = preVisitor(<any>curObject);\n        const copyFlag = context.copy ?? defaultCopyFlag;\n        const continues = context.continue ?? defaultContinues;\n        const ignoreKeys = context.ignoreKeys ?? defaultIgnoreKeys;\n        const shallowKeys = context.shallowKeys ?? defaultShallowKeys;\n        didShortCut = context.shortcut ?? defaultDidShortCut;\n\n        const copy = copyFlag ? this.cloneObj(curObject) : curObject;\n\n        // Register that you want to be visited\n        handleMapperOnLen.push(stack.length);\n        mapperCopyStack.push(copy);\n        mapperOrigStack.push(curObject);\n        mapperParent.push(curParent);\n        mapperParentKey.push(curKey);\n\n        // Extend stack if needed. When shortcutted, should still unwind the stack, but no longer add to it.\n        if (continues && !didShortCut) {\n          for (const key in copy) {\n            if (!Object.hasOwn(copy, key)) {\n              continue;\n            }\n            const val = (<Record<string, unknown>> copy)[key];\n\n            // If shallow copy required, do\n            const onlyShallow = shallowKeys && shallowKeys?.has(key);\n            if (onlyShallow) {\n              // Do not add stack entry - assign straight away\n              (<Record<string, unknown>> copy)[key] = this.cloneObj(val);\n            }\n            if (ignoreKeys && ignoreKeys.has(key)) {\n              // Do not add stack entry\n              continue;\n            }\n            if (!onlyShallow && val !== null && typeof val === 'object') {\n              // Do add stack entry.\n              stack.push(val);\n              stackParentKey.push(key);\n              stackParent.push(copy);\n            }\n          }\n        }\n      }\n      handleMapper();\n    }\n    if (stack.length >= this.maxStackSize) {\n      throw new Error('Transform object stack overflowed');\n    }\n    handleMapper();\n\n    return <any> resultWrap.res;\n  }\n\n  /**\n   * Visitor that visits all objects. Visits deeper objects first.\n   */\n  public visitObject(\n    startObject: object,\n    visitor: (orig: object) => void,\n    preVisitor: (orig: object) => VisitContext = () => ({}),\n  ): void {\n    const defaults = this.defaultContext;\n    const defaultContinues = defaults.continue ?? true;\n    const defaultIgnoreKeys = defaults.ignoreKeys;\n    const defaultShortcut = defaults.shortcut ?? false;\n\n    let didShortCut = false;\n\n    // Stack of things to preVisit\n    const stack = [ startObject ];\n    // When the stack is done preVisiting things above this lengths, visit the bellow\n    const handleVisitorOnLen: number[] = [];\n    const visitorStack: object[] = [];\n\n    function handleVisitor(): void {\n      while (stack.length === handleVisitorOnLen.at(-1)) {\n        handleVisitorOnLen.pop();\n        const toVisit = visitorStack.pop()!;\n        visitor(toVisit);\n      }\n    }\n\n    while (stack.length > 0 && stack.length < this.maxStackSize) {\n      const curObject = stack.pop()!;\n\n      if (!didShortCut) {\n        if (Array.isArray(curObject)) {\n          for (let i = curObject.length - 1; i >= 0; i--) {\n            const val = <unknown> curObject[i];\n            if (val !== null && typeof val === 'object') {\n              stack.push(val);\n            }\n          }\n          handleVisitor();\n          continue;\n        }\n\n        // Perform pre visit before expanding the stack\n        const context = preVisitor(curObject);\n        didShortCut = context.shortcut ?? defaultShortcut;\n        const continues = context.continue ?? defaultContinues;\n        const ignoreKeys = context.ignoreKeys ?? defaultIgnoreKeys;\n\n        // Register that you want to be visited\n        handleVisitorOnLen.push(stack.length);\n        visitorStack.push(curObject);\n\n        // Extend stack if needed. When shortcutted, should still unwind the stack, but no longer add to it.\n        if (continues && !didShortCut) {\n          for (const key in curObject) {\n            if (!Object.hasOwn(curObject, key)) {\n              continue;\n            }\n            if (ignoreKeys && ignoreKeys.has(key)) {\n              continue;\n            }\n            const val = (<Record<string, unknown>> curObject)[key];\n            if (val && typeof val === 'object') {\n              stack.push(val);\n            }\n          }\n        }\n      }\n      handleVisitor();\n    }\n    if (stack.length >= this.maxStackSize) {\n      throw new Error('Transform object stack overflowed');\n    }\n    handleVisitor();\n  }\n}\n"]}

dist/esm/lib/transformers/TransformerSubTyped.d.ts

@@ -5,2 +5,15 @@ import type { SubTyped, Typed } from '../types.js';
 import { TransformerTyped } from './TransformerTyped.js';
+/**
+ * Most specific AST transformer that dispatches visit and transform callbacks
+ * based on both the `type` and `subType` fields of {@link SubTyped} nodes.
+ *
+ * Extends {@link TransformerTyped} with an additional dispatch level. When a callback
+ * is registered for a specific `(type, subType)` pair, it takes precedence over
+ * the type-only callback from {@link TransformerTyped.transformNode}.
+ *
+ * This is the recommended transformer for SPARQL ASTs where nodes have both
+ * type and subType discriminators (e.g., `{ type: 'term', subType: 'literal' }`).
+ *
+ * @typeParam Nodes - Union type of all node types this transformer handles.
+ */
 export declare class TransformerSubTyped<Nodes extends Typed> extends TransformerTyped<Nodes> {
@@ -7,0 +20,0 @@ constructor(defaultContext?: TransformContext, defaultNodePreVisitor?: DefaultNodePreVisitor<Nodes>);

dist/esm/lib/transformers/TransformerSubTyped.js

 import { TransformerTyped } from './TransformerTyped.js';
+/**
+ * Most specific AST transformer that dispatches visit and transform callbacks
+ * based on both the `type` and `subType` fields of {@link SubTyped} nodes.
+ *
+ * Extends {@link TransformerTyped} with an additional dispatch level. When a callback
+ * is registered for a specific `(type, subType)` pair, it takes precedence over
+ * the type-only callback from {@link TransformerTyped.transformNode}.
+ *
+ * This is the recommended transformer for SPARQL ASTs where nodes have both
+ * type and subType discriminators (e.g., `{ type: 'term', subType: 'literal' }`).
+ *
+ * @typeParam Nodes - Union type of all node types this transformer handles.
+ */
 export class TransformerSubTyped extends TransformerTyped {
@@ -3,0 +16,0 @@ constructor(defaultContext = {}, defaultNodePreVisitor = {}) {

dist/esm/lib/transformers/TransformerSubTyped.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"TransformerSubTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerSubTyped.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,MAAM,OAAO,mBAAyC,SAAQ,gBAAuB;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","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"]}
+{"version":3,"file":"TransformerSubTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerSubTyped.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,mBAAyC,SAAQ,gBAAuB;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","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\n/**\n * Most specific AST transformer that dispatches visit and transform callbacks\n * based on both the `type` and `subType` fields of {@link SubTyped} nodes.\n *\n * Extends {@link TransformerTyped} with an additional dispatch level. When a callback\n * is registered for a specific `(type, subType)` pair, it takes precedence over\n * the type-only callback from {@link TransformerTyped.transformNode}.\n *\n * This is the recommended transformer for SPARQL ASTs where nodes have both\n * type and subType discriminators (e.g., `{ type: 'term', subType: 'literal' }`).\n *\n * @typeParam Nodes - Union type of all node types this transformer handles.\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"]}

dist/esm/lib/transformers/TransformerTyped.d.ts

 import type { Typed } from '../types.js';
 import type { TransformContext, VisitContext } from './TransformerObject.js';
 import { TransformerObject } from './TransformerObject.js';
+/**
+ * Controls whether transform callbacks receive fully typed nodes (`'unsafe'`) or
+ * nodes where all fields are `unknown` (`'safe'`). Using `'safe'` (the default)
+ * forces explicit type narrowing, reducing the risk of incorrect assumptions.
+ */
 export type Safeness = 'safe' | 'unsafe';
+/**
+ * Conditionally wraps an object type: in `'safe'` mode, all fields become `unknown`;
+ * in `'unsafe'` mode, the original types are preserved.
+ */
 export type SafeWrap<Safe extends Safeness, obj extends object> = Safe extends 'safe' ? {
     [key in keyof obj]: unknown;
 } : obj;
+/**
+ * Default pre-visitor configuration per node type. Provides default {@link TransformContext}
+ * values that apply when no explicit preVisitor is given for a node type.
+ */
 export type DefaultNodePreVisitor<Nodes extends Typed> = {
     [T in Nodes['type']]?: TransformContext;
 };
+/**
+ * Type-aware AST transformer that dispatches visit and transform callbacks
+ * based on the `type` field of {@link Typed} nodes.
+ *
+ * Extends {@link TransformerObject} with node-type-specific dispatch, so you can
+ * register handlers per node type rather than filtering manually.
+ *
+ * For even more specific dispatch based on both `type` and `subType`,
+ * see {@link TransformerSubTyped}.
+ *
+ * @typeParam Nodes - Union type of all node types this transformer handles.
+ *   Each member must extend {@link Typed}.
+ */
 export declare class TransformerTyped<Nodes extends Typed> extends TransformerObject {
@@ -12,0 +38,0 @@ protected defaultNodePreVisitor: DefaultNodePreVisitor<Nodes>;

dist/esm/lib/transformers/TransformerTyped.js

 import { TransformerObject } from './TransformerObject.js';
+/**
+ * Type-aware AST transformer that dispatches visit and transform callbacks
+ * based on the `type` field of {@link Typed} nodes.
+ *
+ * Extends {@link TransformerObject} with node-type-specific dispatch, so you can
+ * register handlers per node type rather than filtering manually.
+ *
+ * For even more specific dispatch based on both `type` and `subType`,
+ * see {@link TransformerSubTyped}.
+ *
+ * @typeParam Nodes - Union type of all node types this transformer handles.
+ *   Each member must extend {@link Typed}.
+ */
 export class TransformerTyped extends TransformerObject {
@@ -3,0 +16,0 @@ defaultNodePreVisitor;

dist/esm/lib/transformers/TransformerTyped.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"TransformerTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerTyped.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAQ3D,MAAM,OAAO,gBAAsC,SAAQ,iBAAiB;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","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"]}
+{"version":3,"file":"TransformerTyped.js","sourceRoot":"","sources":["../../../../lib/transformers/TransformerTyped.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAqB3D;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,gBAAsC,SAAQ,iBAAiB;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","sourcesContent":["import type { Typed } from '../types.js';\nimport type { TransformContext, VisitContext } from './TransformerObject.js';\nimport { TransformerObject } from './TransformerObject.js';\n\n/**\n * Controls whether transform callbacks receive fully typed nodes (`'unsafe'`) or\n * nodes where all fields are `unknown` (`'safe'`). Using `'safe'` (the default)\n * forces explicit type narrowing, reducing the risk of incorrect assumptions.\n */\nexport type Safeness = 'safe' | 'unsafe';\n/**\n * Conditionally wraps an object type: in `'safe'` mode, all fields become `unknown`;\n * in `'unsafe'` mode, the original types are preserved.\n */\nexport type SafeWrap<Safe extends Safeness, obj extends object> =\n  Safe extends 'safe' ? {[key in keyof obj]: unknown } : obj;\n\n/**\n * Default pre-visitor configuration per node type. Provides default {@link TransformContext}\n * values that apply when no explicit preVisitor is given for a node type.\n */\nexport type DefaultNodePreVisitor<Nodes extends Typed> = {[T in Nodes['type']]?: TransformContext };\n\n/**\n * Type-aware AST transformer that dispatches visit and transform callbacks\n * based on the `type` field of {@link Typed} nodes.\n *\n * Extends {@link TransformerObject} with node-type-specific dispatch, so you can\n * register handlers per node type rather than filtering manually.\n *\n * For even more specific dispatch based on both `type` and `subType`,\n * see {@link TransformerSubTyped}.\n *\n * @typeParam Nodes - Union type of all node types this transformer handles.\n *   Each member must extend {@link Typed}.\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.json

 {
   "name": "@traqula/core",
   "type": "module",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Core components of Traqula",
@@ -46,3 +46,3 @@ "lsd:module": true,
   },
-  "gitHead": "ecbed266b9247b7600d4d7185a98b2ead74e33b9"
+  "gitHead": "51799d80873e4f0fb0ca6ab778861f526d3a66d1"
 }

README.md

@@ -171,3 +171,3 @@ # Traqula core package
 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.
+Both are ignored in the AST, but if you want to generate the same string out of your AST, you need to store them somewhere.
 Traqula helps you store this information using it's `Node` `Localization`.
@@ -174,0 +174,0 @@

No alert changes

Improved metrics

Total package byte prevSize

614260

12.03%

Lines of code

5233

16.16%

No dependency changes