@speclynx/apidom-json-path 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.2.0](https://github.com/speclynx/apidom/compare/v2.1.0...v2.2.0) (2026-01-19)
+
+### Features
+
+- **json-path:** integrate @swaggerexpert/jsonpath as JSONPath engine ([#25](https://github.com/speclynx/apidom/issues/25)) ([40f9279](https://github.com/speclynx/apidom/commit/40f92793ab9d2ab82ba5a4431f82c186031b661f))
+
 # [2.1.0](https://github.com/speclynx/apidom/compare/v2.0.1...v2.1.0) (2026-01-17)
 
 **Note:** Version bump only for package @speclynx/apidom-json-path

package/README.md

@@ -10,67 +10,12 @@ You can install this package via [npm CLI](https://docs.npmjs.com/cli) by runnin
  $ npm install @speclynx/apidom-json-path
 ```
 
-## Evaluating
+The API of this package is fully compliant with [RFC 9535](https://www.rfc-editor.org/rfc/rfc9535.html) and supports all aspects of JSONPath.
+Uses [@swaggerexpert/jsonpath](https://www.npmjs.com/package/@swaggerexpert/jsonpath) under the hood and fully reflects its API.
 
-Package contains JSONPath evaluation functions for evaluating single or multiple JSONPath expression.
-
-### Evaluating single JSONPath expression
-
-Suited for evaluating single JSONPath expression against ApiDOM.
-
-```js
-import { ObjectElement } from '@speclynx/apidom-core';
-import { evaluate } from '@speclynx/apidom-json-path';
-
-const apidom = new ObjectElement({
-  a: {
-    b: [100, 1, 2],
-  },
-});
-const result = evaluate('$.a.b[?(@ < 10)]', apidom);
-// =>
-// [
-//   NumberElement(1),
-//   NumberElement(2),
-// ]
-```
-### Evaluating multiple JSONPath expressions
-
-Suited for evaluating multiple JSONPath expression against the same ApiDOM.
-Use this function in cases when you have multiple JSONPath expressions that need
-to be evaluated against single ApiDOM fragment.
+Evaluation is contextual to ApiDOM realm (`ApiDOMEvaluationRealm`) - meaning `evaluate` function
+expects only ApiDOM as the first argument.
 
 ```js
-import { ObjectElement } from '@speclynx/apidom-core';
-import { evaluateMulti } from '@speclynx/apidom-json-path';
-
-const apidom = new ObjectElement({
-  a: {
-    b: [100, 1, 2],
-  },
-});
-const resultMulti = evaluateMulti(['$.a.b[?(@ < 10)]', '$.a.b[?(@ > 10)]'], apidom);
-// => returns list of tuples which represents mappings between paths and end point values
-// [
-//   ['$.a.b[?(@ < 10)]', [NumberElement(1), NumberElement(2)]],
-//   ['$.a.b[?(@ > 10)]', [NUmberElement(100)]],
-// ]
-```
-
-## Invalid JSONPath expression
-
-If either `evaluate` or `evaluateMulti` functions are provided with invalid JSONPath expressions,
-they don't throw errors, but they rather return empty list of end point values.
-
-```js
-import { ObjectElement } from '@speclynx/apidom-core';
-import { evaluate, evaluateMulti } from '@speclynx/apidom-json-path';
-
-const apidom = new ObjectElement({
-  a: {
-    b: [100, 1, 2],
-  },
-});
-const result = evaluate('%~!@U@IU$@', apidom); // => []
-const resultMulti = evaluateMulti(['%~!@U@IU$@', 'd*AS&*)(&YR3R'], apidom); // => []
+import { evaluate, ApiDOMEvaluationRealm } from '@speclynx/apidom-json-path';
 ```