@swaggerexpert/jsonpath 1.0.0

package/cjs/index.cjs

@@ -0,0 +1,13 @@
+"use strict";
+
+exports.__esModule = true;
+exports.translateEvaluator = exports.parse = exports.JSONPathQueryCST = exports.Grammar = 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;
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }

package/cjs/parse/ast/JSONPathQueryCST.cjs

@@ -0,0 +1,101 @@
+"use strict";
+
+exports.__esModule = true;
+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 {
+  constructor() {
+    super();
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.1.1
+    this.callbacks['jsonpath-query'] = (0, _cst.default)('jsonpath-query');
+    this.callbacks['segments'] = (0, _cst.default)('segments');
+    this.callbacks['B'] = (0, _cst.default)('text');
+    this.callbacks['S'] = (0, _cst.default)('text');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.2.1
+    this.callbacks['root-identifier'] = (0, _cst.default)('root-identifier');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.3
+    this.callbacks['selector'] = (0, _cst.default)('selector');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.3.1.1
+    this.callbacks['name-selector'] = (0, _cst.default)('name-selector');
+    this.callbacks['string-literal'] = (0, _cst.default)('string-literal');
+    this.callbacks['double-quoted'] = (0, _cst.default)('double-quoted');
+    this.callbacks['single-quoted'] = (0, _cst.default)('single-quoted');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.3.2.1
+    this.callbacks['wildcard-selector'] = (0, _cst.default)('wildcard-selector');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.3.3.1
+    this.callbacks['index-selector'] = (0, _cst.default)('index-selector');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.3.4.1
+    this.callbacks['slice-selector'] = (0, _cst.default)('slice-selector');
+    this.callbacks['start'] = (0, _cst.default)('start');
+    this.callbacks['end'] = (0, _cst.default)('end');
+    this.callbacks['step'] = (0, _cst.default)('step');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.3.5.1
+    this.callbacks['filter-selector'] = (0, _cst.default)('filter-selector');
+    this.callbacks['logical-expr'] = (0, _cst.default)('logical-expr');
+    this.callbacks['logical-or-expr'] = (0, _cst.default)('logical-or-expr');
+    this.callbacks['logical-and-expr'] = (0, _cst.default)('logical-and-expr');
+    this.callbacks['basic-expr'] = (0, _cst.default)('basic-expr');
+    this.callbacks['paren-expr'] = (0, _cst.default)('paren-expr');
+    this.callbacks['logical-not-op'] = (0, _cst.default)('logical-not-op');
+    this.callbacks['test-expr'] = (0, _cst.default)('test-expr');
+    this.callbacks['filter-query'] = (0, _cst.default)('filter-query');
+    this.callbacks['rel-query'] = (0, _cst.default)('rel-query');
+    this.callbacks['current-node-identifier'] = (0, _cst.default)('current-node-identifier');
+    this.callbacks['comparison-expr'] = (0, _cst.default)('comparison-expr');
+    this.callbacks['literal'] = (0, _cst.default)('literal');
+    this.callbacks['comparable'] = (0, _cst.default)('comparable');
+    this.callbacks['comparison-op'] = (0, _cst.default)('comparison-op');
+    this.callbacks['singular-query'] = (0, _cst.default)('singular-query');
+    this.callbacks['rel-singular-query'] = (0, _cst.default)('rel-singular-query');
+    this.callbacks['abs-singular-query'] = (0, _cst.default)('abs-singular-query');
+    this.callbacks['singular-query-segments'] = (0, _cst.default)('singular-query-segments');
+    this.callbacks['name-segment'] = (0, _cst.default)('name-segment');
+    this.callbacks['index-segment'] = (0, _cst.default)('index-segment');
+    this.callbacks['number'] = (0, _cst.default)('number');
+    this.callbacks['true'] = (0, _cst.default)('true');
+    this.callbacks['false'] = (0, _cst.default)('false');
+    this.callbacks['null'] = (0, _cst.default)('null');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.4
+    this.callbacks['function-name'] = (0, _cst.default)('function-name');
+    this.callbacks['function-expr'] = (0, _cst.default)('function-expr');
+    this.callbacks['function-argument'] = (0, _cst.default)('function-argument');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.5
+    this.callbacks['segment'] = (0, _cst.default)('segment');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.5.1.1
+    this.callbacks['child-segment'] = (0, _cst.default)('child-segment');
+    this.callbacks['bracketed-selection'] = (0, _cst.default)('bracketed-selection');
+    this.callbacks['member-name-shorthand'] = (0, _cst.default)('member-name-shorthand');
+
+    // https://www.rfc-editor.org/rfc/rfc9535#section-2.5.2.1
+    this.callbacks['descendant-segment'] = (0, _cst.default)('descendant-segment');
+
+    // Surrogate named rules
+    this.callbacks['dot-prefix'] = (0, _cst.default)('text');
+    this.callbacks['double-dot-prefix'] = (0, _cst.default)('text');
+    this.callbacks['left-bracket'] = (0, _cst.default)('text');
+    this.callbacks['right-bracket'] = (0, _cst.default)('text');
+    this.callbacks['comma'] = (0, _cst.default)('text');
+    this.callbacks['colon'] = (0, _cst.default)('text');
+    this.callbacks['dquote'] = (0, _cst.default)('text');
+    this.callbacks['squote'] = (0, _cst.default)('text');
+    this.callbacks['questionmark'] = (0, _cst.default)('text');
+    this.callbacks['disjunction'] = (0, _cst.default)('text');
+    this.callbacks['conjunction'] = (0, _cst.default)('text');
+    this.callbacks['left-paren'] = (0, _cst.default)('text');
+    this.callbacks['right-paren'] = (0, _cst.default)('text');
+  }
+}
+var _default = exports.default = JSONPathQueryCST;

package/cjs/parse/callbacks/cst.cjs

@@ -0,0 +1,44 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _apgLite = require("../../apg-lite.cjs");
+var _JSONPathParseError = _interopRequireDefault(require("../../errors/JSONPathParseError.cjs"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const cst = ruleName => {
+  return (state, chars, phraseIndex, phraseLength, data) => {
+    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;
+    if (state === _apgLite.identifiers.SEM_PRE) {
+      const node = {
+        type: ruleName,
+        text: _apgLite.utilities.charsToString(chars, phraseIndex, phraseLength),
+        start: phraseIndex,
+        length: phraseLength,
+        children: []
+      };
+      if (data.stack.length > 0) {
+        const parent = data.stack[data.stack.length - 1];
+        const isTextWithinTextNode = parent.type === 'text' && node.type === 'text';
+        if (!isTextWithinTextNode) {
+          parent.children.push(node);
+        }
+      } else {
+        data.root = node;
+      }
+      data.stack.push(node);
+    }
+    if (state === _apgLite.identifiers.SEM_POST) {
+      data.stack.pop();
+    }
+  };
+};
+var _default = exports.default = cst;

package/cjs/parse/evaluators/translate.cjs

@@ -0,0 +1,13 @@
+"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/cjs/parse/index.cjs

@@ -0,0 +1,38 @@
+"use strict";
+
+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 _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(),
+  evaluator = _translate.default
+} = {}) => {
+  if (typeof jsonPath !== 'string') {
+    throw new TypeError('JSONPath must be a string');
+  }
+  try {
+    const parser = new _apgLite.Parser();
+    parser.ast = ast;
+    const result = parser.parse(grammar, 'jsonpath-query', jsonPath);
+    const computed = evaluator(ast, {
+      result
+    });
+    return {
+      result,
+      ast,
+      computed
+    };
+  } catch (error) {
+    throw new _JSONPathParseError.default('Unexpected error during JSONPath parsing', {
+      cause: error,
+      jsonPath
+    });
+  }
+};
+var _default = exports.default = parse;

package/es/errors/JSONPathError.mjs

@@ -0,0 +1,40 @@
+class JSONPathError extends Error {
+  constructor(message, options = undefined) {
+    super(message, options);
+    this.name = this.constructor.name;
+    if (typeof message === 'string') {
+      this.message = message;
+    }
+    if (typeof Error.captureStackTrace === 'function') {
+      Error.captureStackTrace(this, this.constructor);
+    } else {
+      this.stack = new Error(message).stack;
+    }
+
+    /**
+     * This needs to stay here until our minimum supported version of Node.js is >= 16.9.0.
+     * Node.js is >= 16.9.0 supports error causes natively.
+     */
+    if (options != null && typeof options === 'object' && Object.prototype.hasOwnProperty.call(options, 'cause') && !('cause' in this)) {
+      const {
+        cause
+      } = options;
+      this.cause = cause;
+      if (cause instanceof Error && 'stack' in cause) {
+        this.stack = `${this.stack}\nCAUSE: ${cause.stack}`;
+      }
+    }
+
+    /**
+     * Allows to assign arbitrary properties to the error object.
+     */
+    if (options != null && typeof options === 'object') {
+      const {
+        cause,
+        ...causelessOptions
+      } = options;
+      Object.assign(this, causelessOptions);
+    }
+  }
+}
+export default JSONPathError;

package/es/errors/JSONPathParseError.mjs

@@ -0,0 +1,3 @@
+import JSONPathError from "./JSONPathError.mjs";
+class JSONPathParseError extends JSONPathError {}
+export default JSONPathParseError;