@swaggerexpert/jsonpath 2.3.0 → 2.4.1

package/README.md

@@ -41,6 +41,7 @@ The development of this library contributed to the identification and formal sub
         - [XML](#xml-translator)
       - [Statistics](#statistics)
       - [Tracing](#tracing)
+    - [Validation](#validation)
     - [Errors](#errors)
     - [Grammar](#grammar)
 - [More about JSONPath](#more-about-jsonpath)
@@ -201,6 +202,26 @@ By combining information from `result` and `trace`, it is possible to analyze th
 and generate a messages like this: `'Syntax error at position 1, expected "[", ".", ".."'`. Please see this
 [test file](https://github.com/swaggerexpert/jsonpath/blob/main/test/parse/trace.js) for more information how to achieve that.
 
+#### Validation
+
+`@swaggerexpert/jsonpath` provides a `test` function to validate JSONPath expressions.
+
+```js
+import { test } from '@swaggerexpert/jsonpath';
+
+test('$.store.book[0].title'); // => true
+test('$$'); // => false
+```
+
+Normalized paths can be validated by setting `normalized` option to `true`.
+
+```js
+import { test } from '@swaggerexpert/jsonpath';
+
+test("$['a']", { normalized: true }); // => true
+test('$.store.book[0].title', { normalized: true }); // => false
+```
+
 #### Errors
 
 `@swaggerexpert/jsonpath` provides a structured error class hierarchy,

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 "use strict";
 
 exports.__esModule = true;
-exports.parse = exports.XMLTranslator = exports.Grammar = exports.CSTTranslator = exports.CSTOptimizedTranslator = void 0;
+exports.test = 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"));
@@ -12,4 +12,6 @@ var _CSTOptimizedTranslator = _interopRequireDefault(require("./parse/translator
 exports.CSTOptimizedTranslator = _CSTOptimizedTranslator.default;
 var _XMLTranslator = _interopRequireDefault(require("./parse/translators/XMLTranslator.cjs"));
 exports.XMLTranslator = _XMLTranslator.default;
+var _index2 = _interopRequireDefault(require("./test/index.cjs"));
+exports.test = _index2.default;
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }

package/cjs/parse/index.cjs

@@ -12,8 +12,7 @@ const parse = (jsonPath, {
   normalized = false,
   stats = false,
   trace = false,
-  translator = new _CSTTranslator.default(),
-  test = 3
+  translator = new _CSTTranslator.default()
 } = {}) => {
   if (typeof jsonPath !== 'string') {
     throw new TypeError('JSONPath must be a string');
@@ -28,7 +27,7 @@ const parse = (jsonPath, {
     const result = parser.parse(grammar, startRule, jsonPath);
     return {
       result,
-      tree: (_parser$ast = parser.ast) == null ? void 0 : _parser$ast.getTree(),
+      tree: result.success ? (_parser$ast = parser.ast) == null ? void 0 : _parser$ast.getTree() : undefined,
       stats: parser.stats,
       trace: parser.trace
     };

package/cjs/test/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _index = _interopRequireDefault(require("../parse/index.cjs"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const test = (jsonPath, {
+  normalized = false
+} = {}) => {
+  if (typeof jsonPath !== 'string') return false;
+  try {
+    const {
+      result
+    } = (0, _index.default)(jsonPath, {
+      normalized,
+      stats: false,
+      trace: false,
+      translator: null
+    });
+    return result.success;
+  } catch {
+    return false;
+  }
+};
+var _default = exports.default = test;

package/es/index.mjs

@@ -2,4 +2,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";
+export { default as XMLTranslator } from "./parse/translators/XMLTranslator.mjs";
+export { default as test } from "./test/index.mjs";

package/es/parse/index.mjs

@@ -7,8 +7,7 @@ const parse = (jsonPath, {
   normalized = false,
   stats = false,
   trace = false,
-  translator = new CSTTranslator(),
-  test = 3
+  translator = new CSTTranslator()
 } = {}) => {
   if (typeof jsonPath !== 'string') {
     throw new TypeError('JSONPath must be a string');
@@ -23,7 +22,7 @@ const parse = (jsonPath, {
     const result = parser.parse(grammar, startRule, jsonPath);
     return {
       result,
-      tree: (_parser$ast = parser.ast) === null || _parser$ast === void 0 ? void 0 : _parser$ast.getTree(),
+      tree: result.success ? (_parser$ast = parser.ast) === null || _parser$ast === void 0 ? void 0 : _parser$ast.getTree() : undefined,
       stats: parser.stats,
       trace: parser.trace
     };

package/es/test/index.mjs

@@ -0,0 +1,20 @@
+import parse from "../parse/index.mjs";
+const test = (jsonPath, {
+  normalized = false
+} = {}) => {
+  if (typeof jsonPath !== 'string') return false;
+  try {
+    const {
+      result
+    } = parse(jsonPath, {
+      normalized,
+      stats: false,
+      trace: false,
+      translator: null
+    });
+    return result.success;
+  } catch {
+    return false;
+  }
+};
+export default test;

package/package.json

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

package/types/index.d.ts

@@ -63,6 +63,15 @@ export interface Trace {
   displayTrace(): string;
 }
 
+/**
+ * Validation
+ */
+export function test(jsonpath: string, options?: TestOptions): boolean;
+
+export interface TestOptions {
+  readonly normalized?: boolean;
+}
+
 /**
  * Grammar
  */