@swaggerexpert/jsonpath 1.2.1 → 2.1.0

package/README.md

@@ -34,8 +34,10 @@ The development of this library contributed to the identification and formal sub
   - [Installation](#installation)
   - [Usage](#usage)
     - [Parsing](#parsing)
-      - [Concrete Syntax Tree (CST)](#concrete-syntax-tree-cst)
-      - [Interpreting Parse result as XML](#interpreting-parse-result-as-xml)
+      - [Normalized paths](#normalized-paths)
+      - [Translators](#translators)
+        - [CST](#cst-translator)
+        - [XML](#xml-translator)
       - [Statistics](#statistics)
       - [Tracing](#tracing)
     - [Errors](#errors)
@@ -69,231 +71,92 @@ import { parse } from '@swaggerexpert/jsonpath';
 const parseResult = parse('$.store.book[0].title');
 ```
 
-or
-
-```js
-import { parse, JSONPathQueryCST } from '@swaggerexpert/jsonpath';
-
-const parseResult = parse('$.store.book[0].title', { ast: new JSONPathQueryCST() });
-```
-
 **parseResult** variable has the following shape:
 
 ```
 {
-  result: {
-    success: true,
-    state: 101,
-    stateName: 'MATCH',
-    length: 21,
-    matched: 21,
-    maxMatched: 21,
-    maxTreeDepth: 21,
-    nodeHits: 298
-  },
-  ast: <JSONPathQueryCST>,
-  computed: {
-    stack: [],
-    root: {
-      type: 'jsonpath-query',
-      text: '$.store.book[0].title',
-      start: 0,
-      length: 21,
-      children: [
-        {
-          type: 'root-identifier',
-          text: '$',
-          start: 0,
-          length: 1,
-          children: []
-        },
-        {
-          type: 'segments',
-          text: '.store.book[0].title',
-          start: 1,
-          length: 20,
-          children: [
-            {
-              type: 'segment',
-              text: '.store',
-              start: 1,
-              length: 6,
-              children: [
-                {
-                  type: 'child-segment',
-                  text: '.store',
-                  start: 1,
-                  length: 6,
-                  children: [
-                    {
-                      type: 'text',
-                      text: '.',
-                      start: 1,
-                      length: 1,
-                      children: []
-                    },
-                    {
-                      type: 'member-name-shorthand',
-                      text: 'store',
-                      start: 2,
-                      length: 5,
-                      children: []
-                    }
-                  ]
-                }
-              ]
-            },
-            {
-              type: 'segment',
-              text: '.book',
-              start: 7,
-              length: 5,
-              children: [
-                {
-                  type: 'child-segment',
-                  text: '.book',
-                  start: 7,
-                  length: 5,
-                  children: [
-                    {
-                      type: 'text',
-                      text: '.',
-                      start: 7,
-                      length: 1,
-                      children: []
-                    },
-                    {
-                      type: 'member-name-shorthand',
-                      text: 'book',
-                      start: 8,
-                      length: 4,
-                      children: []
-                    }
-                  ]
-                }
-              ]
-            },
-            {
-              type: 'segment',
-              text: '[0]',
-              start: 12,
-              length: 3,
-              children: [
-                {
-                  type: 'child-segment',
-                  text: '[0]',
-                  start: 12,
-                  length: 3,
-                  children: [
-                    {
-                      type: 'bracketed-selection',
-                      text: '[0]',
-                      start: 12,
-                      length: 3,
-                      children: [
-                        {
-                          type: 'text',
-                          text: '[',
-                          start: 12,
-                          length: 1,
-                          children: []
-                        },
-                        {
-                          type: 'selector',
-                          text: '0',
-                          start: 13,
-                          length: 1,
-                          children: [
-                            {
-                              type: 'index-selector',
-                              text: '0',
-                              start: 13,
-                              length: 1,
-                              children: []
-                            }
-                          ]
-                        },
-                        {
-                          type: 'text',
-                          text: ']',
-                          start: 14,
-                          length: 1,
-                          children: []
-                        }
-                      ]
-                    }
-                  ]
-                }
-              ]
-            },
-            {
-              type: 'segment',
-              text: '.title',
-              start: 15,
-              length: 6,
-              children: [
-                {
-                  type: 'child-segment',
-                  text: '.title',
-                  start: 15,
-                  length: 6,
-                  children: [
-                    {
-                      type: 'text',
-                      text: '.',
-                      start: 15,
-                      length: 1,
-                      children: []
-                    },
-                    {
-                      type: 'member-name-shorthand',
-                      text: 'title',
-                      start: 16,
-                      length: 5,
-                      children: []
-                    }
-                  ]
-                }
-              ]
-            }
-          ]
-        }
-      ]
-    }
-  }
+  result: <ParseResult['result]>,
+  tree: <ParseResult['tree']>,
+  stats: <ParseResult['stats']>,
+  trace: <ParseResult['trace']>,
 }
 ```
 
-###### Concrete Syntax Tree (CST)
+[TypeScript typings](https://github.com/swaggerexpert/jsonpath/blob/main/types/index.d.ts) are available for all fields attached to parse result object returned by the `parse` function.
+
+
+##### Normalized paths
+
+[comment]: <> (SPDX-FileCopyrightText: Copyright &#40;c&#41; 2024 IETF Trust and the persons identified as the document authors. All rights reserved.)
+[comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
+
+[Normalized Path](https://www.rfc-editor.org/rfc/rfc9535#name-normalized-paths) is a JSONPath query with restricted syntax.
+A Normalized Path represents the identity of a node in a specific value.
+There is precisely one Normalized Path identifying any particular node in a value.
+Normalized Paths provide a predictable format that simplifies testing and post-processing of nodelists, e.g., to remove duplicate nodes.
+Normalized Paths use the canonical bracket notation, rather than dot notation.
+Single quotes are used in Normalized Paths to delimit string member names. This reduces the number of characters that need escaping when Normalized Paths appear in strings delimited by double quotes.
+
+Parsing in normalized path mode can be enabled by setting `normalized` option to `true`.
+
+```js
+import { parse } from '@swaggerexpert/jsonpath';
+
+parse("$['a']", { normalized: true });
+parse("$[1]", { normalized: true });
+parse("$[2]", { normalized: true });
+parse("$['a']['b'][1]", { normalized: true });
+parse("$['\\u000b']", { normalized: true });
+```
+
+##### Translators
+
+`@swaggerexpert/jsonpath` provides several translators to convert the parse result into different tree representations.
+
+###### CST translator
 
-[Concrete Syntax Tree](https://en.wikipedia.org/wiki/Parse_tree) (Parse tree) is available on parse result via `computed` field.
-Instance of `JSONPathQueryCST` needs to be assigned to `ast` option in `parse` function (default behavior).
+[Concrete Syntax Tree](https://en.wikipedia.org/wiki/Parse_tree) (Parse tree) representation is available on parse result
+by default or when instance of `CSTTranslator` is provided via a `translator` option to the `parse` function.
 CST is suitable to be consumed by other tools like IDEs, editors, etc...
 
 ```js
 import { parse } from '@swaggerexpert/jsonpath';
 
-const { computed: CST } = parse('$.store.book[0].title');
+const { tree: CST } = parse('$.store.book[0].title');
 ```
 
 or
 
 ```js
-import { parse, JSONPathQueryCST } from '@swaggerexpert/jsonpath';
+import { parse, CSTTranslator } from '@swaggerexpert/jsonpath';
 
-const { computed: CST } = parse('$.store.book[0].title', { ast: new JSONPathQueryCST() });
+const { tree: CST } = parse('$.store.book[0].title', { translator: new CSTTranslator() });
 ```
 
-###### Interpreting Parse result as XML
+CST tree has the following shape:
+
+```ts
+interface CSTTree {
+  readonly root: CSTNode;
+}
+interface CSTNode {
+  readonly type: string,
+  readonly text: string,
+  readonly start: number,
+  readonly length: number,
+  readonly children: CSTNode[],
+}
+```
+
+###### XML translator
 
 ```js
-import { parse } from '@swaggerexpert/jsonpath';
+import { parse, XMLTranslator } from '@swaggerexpert/jsonpath';
 
-const parseResult = parse('$.store.book[0].title');
-const xml = parseResult.ast.toXml();
+const { tree: XML } = parse('$.store.book[0].title', { translator: new XMLTranslator() });
 ```
 
-###### Statistics
+##### Statistics
 
 `parse` function returns additional statistical information about the parsing process.
 Collection of the statistics can be enabled by setting `stats` option to `true`.
@@ -307,7 +170,7 @@ stats.displayStats(); // returns operator stats
 stats.displayHits(); // returns rules grouped by hit count
 ```
 
-###### Tracing
+##### Tracing
 
 `parse` function returns additional tracing information about the parsing process.
 Tracing can be enabled by setting `trace` option to `true`. Tracing is essential

package/cjs/grammar.cjs

@@ -16,9 +16,9 @@ function grammar() {
   //        ALT = 41
   //        CAT = 60
   //        REP = 32
-  //        RNM = 174
-  //        TLS = 66
-  //        TBS = 30
+  //        RNM = 178
+  //        TLS = 64
+  //        TBS = 28
   //        TRG = 20
   //        ---   SABNF superset opcodes
   //        UDT = 0
@@ -2247,17 +2247,17 @@ function grammar() {
     children: [1, 2, 3]
   }; // CAT
   this.rules[69].opcodes[1] = {
-    type: 7,
-    string: [91]
-  }; // TLS
+    type: 4,
+    index: 80
+  }; // RNM(left-bracket)
   this.rules[69].opcodes[2] = {
     type: 4,
     index: 70
   }; // RNM(normal-selector)
   this.rules[69].opcodes[3] = {
-    type: 7,
-    string: [93]
-  }; // TLS
+    type: 4,
+    index: 81
+  }; // RNM(right-bracket)
 
   /* normal-selector */
   this.rules[70].opcodes = [];
@@ -2281,9 +2281,9 @@ function grammar() {
     children: [1, 2, 4]
   }; // CAT
   this.rules[71].opcodes[1] = {
-    type: 6,
-    string: [39]
-  }; // TBS
+    type: 4,
+    index: 87
+  }; // RNM(squote)
   this.rules[71].opcodes[2] = {
     type: 3,
     min: 0,
@@ -2294,9 +2294,9 @@ function grammar() {
     index: 72
   }; // RNM(normal-single-quoted)
   this.rules[71].opcodes[4] = {
-    type: 6,
-    string: [39]
-  }; // TBS
+    type: 4,
+    index: 87
+  }; // RNM(squote)
 
   /* normal-single-quoted */
   this.rules[72].opcodes = [];
@@ -2784,9 +2784,9 @@ function grammar() {
     str += "\n";
     str += "; https://www.rfc-editor.org/rfc/rfc9535#name-normalized-paths\n";
     str += "normalized-path      = root-identifier *(normal-index-segment)\n";
-    str += "normal-index-segment = \"[\" normal-selector \"]\"\n";
+    str += "normal-index-segment = left-bracket normal-selector right-bracket ; MODIFICATION: surrogate text rule used\n";
     str += "normal-selector      = normal-name-selector / normal-index-selector\n";
-    str += "normal-name-selector = %x27 *normal-single-quoted %x27 ; 'string'\n";
+    str += "normal-name-selector = squote *normal-single-quoted squote ; 'string', MODIFICATION: surrogate text rule used\n";
     str += "normal-single-quoted = normal-unescaped /\n";
     str += "                       ESC normal-escapable\n";
     str += "normal-unescaped     =    ; omit %x0-1F control codes\n";

package/cjs/index.cjs

@@ -1,13 +1,13 @@
 "use strict";
 
 exports.__esModule = true;
-exports.translateEvaluator = exports.parse = exports.JSONPathQueryCST = exports.Grammar = void 0;
+exports.parse = exports.XMLTranslator = exports.Grammar = exports.CSTTranslator = void 0;
 var _grammar = _interopRequireDefault(require("./grammar.cjs"));
 exports.Grammar = _grammar.default;
 var _index = _interopRequireDefault(require("./parse/index.cjs"));
 exports.parse = _index.default;
-var _JSONPathQueryCST = _interopRequireDefault(require("./parse/ast/JSONPathQueryCST.cjs"));
-exports.JSONPathQueryCST = _JSONPathQueryCST.default;
-var _translate = _interopRequireDefault(require("./parse/evaluators/translate.cjs"));
-exports.translateEvaluator = _translate.default;
+var _CSTTranslator = _interopRequireDefault(require("./parse/translators/CSTTranslator.cjs"));
+exports.CSTTranslator = _CSTTranslator.default;
+var _XMLTranslator = _interopRequireDefault(require("./parse/translators/XMLTranslator.cjs"));
+exports.XMLTranslator = _XMLTranslator.default;
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }

package/cjs/parse/callbacks/cst.cjs

@@ -10,10 +10,6 @@ const cst = ruleName => {
     if (!(typeof data === 'object' && data !== null && !Array.isArray(data))) {
       throw new _JSONPathParseError.default("parser's user data must be an object");
     }
-    if (!data.stack) {
-      data.stack = [];
-      data.root = null;
-    }
 
     // drop the empty nodes
     if (phraseLength === 0) return;

package/cjs/parse/index.cjs

@@ -4,35 +4,33 @@ exports.__esModule = true;
 exports.default = void 0;
 var _apgLite = require("../apg-lite.cjs");
 var _grammar = _interopRequireDefault(require("../grammar.cjs"));
-var _translate = _interopRequireDefault(require("./evaluators/translate.cjs"));
-var _JSONPathQueryCST = _interopRequireDefault(require("./ast/JSONPathQueryCST.cjs"));
+var _CSTTranslator = _interopRequireDefault(require("./translators/CSTTranslator.cjs"));
 var _JSONPathParseError = _interopRequireDefault(require("../errors/JSONPathParseError.cjs"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const grammar = new _grammar.default();
 const parse = (jsonPath, {
-  ast = new _JSONPathQueryCST.default(),
+  normalized = false,
   stats = false,
   trace = false,
-  evaluator = _translate.default
+  translator = new _CSTTranslator.default(),
+  test = 3
 } = {}) => {
   if (typeof jsonPath !== 'string') {
     throw new TypeError('JSONPath must be a string');
   }
   try {
+    var _parser$ast;
     const parser = new _apgLite.Parser();
-    parser.ast = ast;
+    if (translator) parser.ast = translator;
     if (stats) parser.stats = new _apgLite.Stats();
     if (trace) parser.trace = new _apgLite.Trace();
-    const result = parser.parse(grammar, 'jsonpath-query', jsonPath);
-    const computed = evaluator(ast, {
-      result
-    });
+    const startRule = normalized ? 'normalized-path' : 'jsonpath-query';
+    const result = parser.parse(grammar, startRule, jsonPath);
     return {
       result,
-      ast,
+      tree: (_parser$ast = parser.ast) == null ? void 0 : _parser$ast.getTree(),
       stats: parser.stats,
-      trace: parser.trace,
-      computed
+      trace: parser.trace
     };
   } catch (error) {
     throw new _JSONPathParseError.default('Unexpected error during JSONPath parsing', {

package/cjs/parse/{ast/JSONPathQueryCST.cjs → translators/CSTTranslator.cjs}

@@ -5,7 +5,7 @@ exports.default = void 0;
 var _apgLite = require("../../apg-lite.cjs");
 var _cst = _interopRequireDefault(require("../callbacks/cst.cjs"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class JSONPathQueryCST extends _apgLite.Ast {
+class CSTTranslator extends _apgLite.Ast {
   constructor() {
     super();
 
@@ -82,6 +82,14 @@ class JSONPathQueryCST extends _apgLite.Ast {
     // https://www.rfc-editor.org/rfc/rfc9535#section-2.5.2.1
     this.callbacks['descendant-segment'] = (0, _cst.default)('descendant-segment');
 
+    // https://www.rfc-editor.org/rfc/rfc9535#name-normalized-paths
+    this.callbacks['normalized-path'] = (0, _cst.default)('normalized-path');
+    this.callbacks['normal-index-segment'] = (0, _cst.default)('normal-index-segment');
+    this.callbacks['normal-selector'] = (0, _cst.default)('normal-selector');
+    this.callbacks['normal-name-selector'] = (0, _cst.default)('normal-name-selector');
+    this.callbacks['normal-index-selector'] = (0, _cst.default)('normal-index-selector');
+    this.callbacks['normal-single-quoted'] = (0, _cst.default)('normal-single-quoted');
+
     // Surrogate named rules
     this.callbacks['dot-prefix'] = (0, _cst.default)('text');
     this.callbacks['double-dot-prefix'] = (0, _cst.default)('text');
@@ -97,5 +105,14 @@ class JSONPathQueryCST extends _apgLite.Ast {
     this.callbacks['left-paren'] = (0, _cst.default)('text');
     this.callbacks['right-paren'] = (0, _cst.default)('text');
   }
+  getTree() {
+    const data = {
+      stack: [],
+      root: null
+    };
+    this.translate(data);
+    delete data.stack;
+    return data;
+  }
 }
-var _default = exports.default = JSONPathQueryCST;
+var _default = exports.default = CSTTranslator;

package/cjs/parse/translators/XMLTranslator.cjs

@@ -0,0 +1,12 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _CSTTranslator = _interopRequireDefault(require("./CSTTranslator.cjs"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class XMLTranslator extends _CSTTranslator.default {
+  getTree() {
+    return this.toXml();
+  }
+}
+var _default = exports.default = XMLTranslator;

package/es/grammar.mjs

@@ -12,9 +12,9 @@ export default function grammar() {
   //        ALT = 41
   //        CAT = 60
   //        REP = 32
-  //        RNM = 174
-  //        TLS = 66
-  //        TBS = 30
+  //        RNM = 178
+  //        TLS = 64
+  //        TBS = 28
   //        TRG = 20
   //        ---   SABNF superset opcodes
   //        UDT = 0
@@ -2243,17 +2243,17 @@ export default function grammar() {
     children: [1, 2, 3]
   }; // CAT
   this.rules[69].opcodes[1] = {
-    type: 7,
-    string: [91]
-  }; // TLS
+    type: 4,
+    index: 80
+  }; // RNM(left-bracket)
   this.rules[69].opcodes[2] = {
     type: 4,
     index: 70
   }; // RNM(normal-selector)
   this.rules[69].opcodes[3] = {
-    type: 7,
-    string: [93]
-  }; // TLS
+    type: 4,
+    index: 81
+  }; // RNM(right-bracket)
 
   /* normal-selector */
   this.rules[70].opcodes = [];
@@ -2277,9 +2277,9 @@ export default function grammar() {
     children: [1, 2, 4]
   }; // CAT
   this.rules[71].opcodes[1] = {
-    type: 6,
-    string: [39]
-  }; // TBS
+    type: 4,
+    index: 87
+  }; // RNM(squote)
   this.rules[71].opcodes[2] = {
     type: 3,
     min: 0,
@@ -2290,9 +2290,9 @@ export default function grammar() {
     index: 72
   }; // RNM(normal-single-quoted)
   this.rules[71].opcodes[4] = {
-    type: 6,
-    string: [39]
-  }; // TBS
+    type: 4,
+    index: 87
+  }; // RNM(squote)
 
   /* normal-single-quoted */
   this.rules[72].opcodes = [];
@@ -2780,9 +2780,9 @@ export default function grammar() {
     str += "\n";
     str += "; https://www.rfc-editor.org/rfc/rfc9535#name-normalized-paths\n";
     str += "normalized-path      = root-identifier *(normal-index-segment)\n";
-    str += "normal-index-segment = \"[\" normal-selector \"]\"\n";
+    str += "normal-index-segment = left-bracket normal-selector right-bracket ; MODIFICATION: surrogate text rule used\n";
     str += "normal-selector      = normal-name-selector / normal-index-selector\n";
-    str += "normal-name-selector = %x27 *normal-single-quoted %x27 ; 'string'\n";
+    str += "normal-name-selector = squote *normal-single-quoted squote ; 'string', MODIFICATION: surrogate text rule used\n";
     str += "normal-single-quoted = normal-unescaped /\n";
     str += "                       ESC normal-escapable\n";
     str += "normal-unescaped     =    ; omit %x0-1F control codes\n";

package/es/index.mjs

@@ -1,4 +1,4 @@
 export { default as Grammar } from "./grammar.mjs";
 export { default as parse } from "./parse/index.mjs";
-export { default as JSONPathQueryCST } from "./parse/ast/JSONPathQueryCST.mjs";
-export { default as translateEvaluator } from "./parse/evaluators/translate.mjs";
+export { default as CSTTranslator } from "./parse/translators/CSTTranslator.mjs";
+export { default as XMLTranslator } from "./parse/translators/XMLTranslator.mjs";

package/es/parse/callbacks/cst.mjs

@@ -5,10 +5,6 @@ const cst = ruleName => {
     if (!(typeof data === 'object' && data !== null && !Array.isArray(data))) {
       throw new JSONPathParseError("parser's user data must be an object");
     }
-    if (!data.stack) {
-      data.stack = [];
-      data.root = null;
-    }
 
     // drop the empty nodes
     if (phraseLength === 0) return;

package/es/parse/index.mjs

@@ -1,33 +1,31 @@
 import { Parser, Stats, Trace } from 'apg-lite';
 import Grammar from "../grammar.mjs";
-import translateEvaluator from "./evaluators/translate.mjs";
-import JSONPathQueryCST from "./ast/JSONPathQueryCST.mjs";
+import CSTTranslator from "./translators/CSTTranslator.mjs";
 import JSONPathParseError from "../errors/JSONPathParseError.mjs";
 const grammar = new Grammar();
 const parse = (jsonPath, {
-  ast = new JSONPathQueryCST(),
+  normalized = false,
   stats = false,
   trace = false,
-  evaluator = translateEvaluator
+  translator = new CSTTranslator(),
+  test = 3
 } = {}) => {
   if (typeof jsonPath !== 'string') {
     throw new TypeError('JSONPath must be a string');
   }
   try {
+    var _parser$ast;
     const parser = new Parser();
-    parser.ast = ast;
+    if (translator) parser.ast = translator;
     if (stats) parser.stats = new Stats();
     if (trace) parser.trace = new Trace();
-    const result = parser.parse(grammar, 'jsonpath-query', jsonPath);
-    const computed = evaluator(ast, {
-      result
-    });
+    const startRule = normalized ? 'normalized-path' : 'jsonpath-query';
+    const result = parser.parse(grammar, startRule, jsonPath);
     return {
       result,
-      ast,
+      tree: (_parser$ast = parser.ast) === null || _parser$ast === void 0 ? void 0 : _parser$ast.getTree(),
       stats: parser.stats,
-      trace: parser.trace,
-      computed
+      trace: parser.trace
     };
   } catch (error) {
     throw new JSONPathParseError('Unexpected error during JSONPath parsing', {

package/es/parse/{ast/JSONPathQueryCST.mjs → translators/CSTTranslator.mjs}

@@ -1,6 +1,6 @@
 import { Ast as AST } from 'apg-lite';
 import cstCallback from "../callbacks/cst.mjs";
-class JSONPathQueryCST extends AST {
+class CSTTranslator extends AST {
   constructor() {
     super();
 
@@ -77,6 +77,14 @@ class JSONPathQueryCST extends AST {
     // https://www.rfc-editor.org/rfc/rfc9535#section-2.5.2.1
     this.callbacks['descendant-segment'] = cstCallback('descendant-segment');
 
+    // https://www.rfc-editor.org/rfc/rfc9535#name-normalized-paths
+    this.callbacks['normalized-path'] = cstCallback('normalized-path');
+    this.callbacks['normal-index-segment'] = cstCallback('normal-index-segment');
+    this.callbacks['normal-selector'] = cstCallback('normal-selector');
+    this.callbacks['normal-name-selector'] = cstCallback('normal-name-selector');
+    this.callbacks['normal-index-selector'] = cstCallback('normal-index-selector');
+    this.callbacks['normal-single-quoted'] = cstCallback('normal-single-quoted');
+
     // Surrogate named rules
     this.callbacks['dot-prefix'] = cstCallback('text');
     this.callbacks['double-dot-prefix'] = cstCallback('text');
@@ -92,5 +100,14 @@ class JSONPathQueryCST extends AST {
     this.callbacks['left-paren'] = cstCallback('text');
     this.callbacks['right-paren'] = cstCallback('text');
   }
+  getTree() {
+    const data = {
+      stack: [],
+      root: null
+    };
+    this.translate(data);
+    delete data.stack;
+    return data;
+  }
 }
-export default JSONPathQueryCST;
+export default CSTTranslator;

package/es/parse/translators/XMLTranslator.mjs

@@ -0,0 +1,7 @@
+import CSTTranslator from "./CSTTranslator.mjs";
+class XMLTranslator extends CSTTranslator {
+  getTree() {
+    return this.toXml();
+  }
+}
+export default XMLTranslator;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.2.1",
+  "version": "2.1.0",
   "description": "RCF 9535 implementation of JSONPath",
   "main": "./cjs/index.cjs",
   "types": "./types/index.d.ts",

package/types/index.d.ts

@@ -4,22 +4,34 @@
 export function parse(jsonpath: string, options?: ParseOptions): ParseResult;
 
 export interface ParseOptions {
-  readonly ast?: AST;
+  readonly normalized?: boolean;
   readonly stats?: boolean;
   readonly trace?: boolean;
+  readonly translator?: Translator | null;
 }
 
-export interface AST {
-  readonly translate: (parts: Record<string, CSTNode>) => Record<string, CSTNode>;
-  readonly toXml: () => string;
+export interface Translator<TTree = unknown> {
+  getTree(): TTree;
+}
+export declare class CSTTranslator implements Translator<CSTTree> {
+  getTree(): CSTTree;
+}
+export declare class XMLTranslator implements Translator<XMLTree> {
+  getTree(): XMLTree;
 }
 
-export interface ParseResult {
+export interface ParseResult<TTree = unknown> {
   readonly result: {
     readonly success: boolean;
+    readonly state: number;
+    readonly stateName: string;
+    readonly length: number;
+    readonly matched: number;
+    readonly maxMatched: number;
+    readonly maxTreeDepth: number
+    readonly nodeHits: number;
   };
-  readonly ast: AST;
-  readonly computed: Record<string, CSTNode>;
+  readonly tree: TTree;
   readonly stats?: Stats;
   readonly trace?: Trace;
 }
@@ -32,6 +44,12 @@ export interface CSTNode {
   readonly children: CSTNode[],
 }
 
+export interface CSTTree {
+  readonly root: CSTNode;
+}
+
+export type XMLTree = string;
+
 export interface Stats {
   displayStats(): string;
   displayHits(): string;

package/cjs/parse/evaluators/translate.cjs

@@ -1,13 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-const translateEvaluator = (ast, {
-  result
-}) => {
-  if (!result.success) return null;
-  const parts = {};
-  ast.translate(parts);
-  return parts;
-};
-var _default = exports.default = translateEvaluator;

package/es/parse/evaluators/translate.mjs

@@ -1,9 +0,0 @@
-const translateEvaluator = (ast, {
-  result
-}) => {
-  if (!result.success) return null;
-  const parts = {};
-  ast.translate(parts);
-  return parts;
-};
-export default translateEvaluator;