@swaggerexpert/jsonpath 2.1.0 → 2.2.0

package/README.md

@@ -37,6 +37,7 @@ The development of this library contributed to the identification and formal sub
       - [Normalized paths](#normalized-paths)
       - [Translators](#translators)
         - [CST](#cst-translator)
+        - [CST Optimized](#cst-optimized-translator)
         - [XML](#xml-translator)
       - [Statistics](#statistics)
       - [Tracing](#tracing)
@@ -148,6 +149,17 @@ interface CSTNode {
 }
 ```
 
+###### CST Optimized translator
+
+Same as CST, but optimizes the tree for more optimized representation. By default, it collapses
+fragmented `single-quoted` or `double-quoted` nodes into a single node.
+
+```js
+import { parse, CSTOptimizedTranslator } from '@swaggerexpert/jsonpath';
+
+const { tree: CST } = parse('$.store.book[0].title', { translator: new CSTOptimizedTranslator() });
+```
+
 ###### XML translator
 
 ```js

package/cjs/index.cjs

@@ -1,13 +1,15 @@
 "use strict";
 
 exports.__esModule = true;
-exports.parse = exports.XMLTranslator = exports.Grammar = exports.CSTTranslator = void 0;
+exports.parse = exports.XMLTranslator = exports.Grammar = exports.CSTTranslator = exports.CSTOptimizedTranslator = void 0;
 var _grammar = _interopRequireDefault(require("./grammar.cjs"));
 exports.Grammar = _grammar.default;
 var _index = _interopRequireDefault(require("./parse/index.cjs"));
 exports.parse = _index.default;
 var _CSTTranslator = _interopRequireDefault(require("./parse/translators/CSTTranslator.cjs"));
 exports.CSTTranslator = _CSTTranslator.default;
+var _CSTOptimizedTranslator = _interopRequireDefault(require("./parse/translators/CSTOptimizedTranslator.cjs"));
+exports.CSTOptimizedTranslator = _CSTOptimizedTranslator.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

@@ -22,9 +22,15 @@ const cst = ruleName => {
         children: []
       };
       if (data.stack.length > 0) {
+        var _data$options, _data$options2;
         const parent = data.stack[data.stack.length - 1];
-        const isTextWithinTextNode = parent.type === 'text' && node.type === 'text';
-        if (!isTextWithinTextNode) {
+        const prevSibling = parent.children[parent.children.length - 1];
+        const isTextNodeWithinTextNode = parent.type === 'text' && node.type === 'text';
+        const shouldCollapse = ((_data$options = data.options) == null ? void 0 : _data$options.optimize) && ((_data$options2 = data.options) == null || (_data$options2 = _data$options2.collapsibleTypes) == null ? void 0 : _data$options2.includes(node.type)) && (prevSibling == null ? void 0 : prevSibling.type) === node.type;
+        if (shouldCollapse) {
+          prevSibling.text += node.text;
+          prevSibling.length += node.length;
+        } else if (!isTextNodeWithinTextNode) {
           parent.children.push(node);
         }
       } else {

package/cjs/parse/translators/CSTOptimizedTranslator.cjs

@@ -0,0 +1,33 @@
+"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 CSTOptimizedTranslator extends _CSTTranslator.default {
+  collapsibleTypes = ['single-quoted', 'double-quoted'];
+  constructor({
+    collapsibleTypes
+  } = {}) {
+    super();
+    if (Array.isArray(collapsibleTypes)) {
+      this.collapsibleTypes = collapsibleTypes;
+    }
+  }
+  getTree() {
+    const options = {
+      optimize: true,
+      collapsibleTypes: this.collapsibleTypes
+    };
+    const data = {
+      stack: [],
+      root: null,
+      options
+    };
+    this.translate(data);
+    delete data.stack;
+    delete data.options;
+    return data;
+  }
+}
+var _default = exports.default = CSTOptimizedTranslator;

package/es/index.mjs

@@ -1,4 +1,5 @@
 export { default as Grammar } from "./grammar.mjs";
 export { default as parse } from "./parse/index.mjs";
 export { default as CSTTranslator } from "./parse/translators/CSTTranslator.mjs";
+export { default as CSTOptimizedTranslator } from "./parse/translators/CSTOptimizedTranslator.mjs";
 export { default as XMLTranslator } from "./parse/translators/XMLTranslator.mjs";

package/es/parse/callbacks/cst.mjs

@@ -17,9 +17,15 @@ const cst = ruleName => {
         children: []
       };
       if (data.stack.length > 0) {
+        var _data$options, _data$options2;
         const parent = data.stack[data.stack.length - 1];
-        const isTextWithinTextNode = parent.type === 'text' && node.type === 'text';
-        if (!isTextWithinTextNode) {
+        const prevSibling = parent.children[parent.children.length - 1];
+        const isTextNodeWithinTextNode = parent.type === 'text' && node.type === 'text';
+        const shouldCollapse = ((_data$options = data.options) === null || _data$options === void 0 ? void 0 : _data$options.optimize) && ((_data$options2 = data.options) === null || _data$options2 === void 0 || (_data$options2 = _data$options2.collapsibleTypes) === null || _data$options2 === void 0 ? void 0 : _data$options2.includes(node.type)) && (prevSibling === null || prevSibling === void 0 ? void 0 : prevSibling.type) === node.type;
+        if (shouldCollapse) {
+          prevSibling.text += node.text;
+          prevSibling.length += node.length;
+        } else if (!isTextNodeWithinTextNode) {
           parent.children.push(node);
         }
       } else {

package/es/parse/translators/CSTOptimizedTranslator.mjs

@@ -0,0 +1,28 @@
+import CSTTranslator from "./CSTTranslator.mjs";
+class CSTOptimizedTranslator extends CSTTranslator {
+  collapsibleTypes = ['single-quoted', 'double-quoted'];
+  constructor({
+    collapsibleTypes
+  } = {}) {
+    super();
+    if (Array.isArray(collapsibleTypes)) {
+      this.collapsibleTypes = collapsibleTypes;
+    }
+  }
+  getTree() {
+    const options = {
+      optimize: true,
+      collapsibleTypes: this.collapsibleTypes
+    };
+    const data = {
+      stack: [],
+      root: null,
+      options
+    };
+    this.translate(data);
+    delete data.stack;
+    delete data.options;
+    return data;
+  }
+}
+export default CSTOptimizedTranslator;

package/package.json

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

package/types/index.d.ts

@@ -16,6 +16,10 @@ export interface Translator<TTree = unknown> {
 export declare class CSTTranslator implements Translator<CSTTree> {
   getTree(): CSTTree;
 }
+export declare class CSTOptimizedTranslator implements CSTTranslator {
+  constructor(options?: { collapsibleTypes?: string[] });
+  getTree(): CSTTree;
+}
 export declare class XMLTranslator implements Translator<XMLTree> {
   getTree(): XMLTree;
 }