@swagger-api/apidom-json-pointer 1.0.0-beta.8 → 1.0.0-rc.0

package/CHANGELOG.md

@@ -3,6 +3,192 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-rc.0](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.51...v1.0.0-rc.0) (2025-10-21)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.51](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.50...v1.0.0-beta.51) (2025-10-14)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.50](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.49...v1.0.0-beta.50) (2025-09-26)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.49](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.48...v1.0.0-beta.49) (2025-09-22)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.48](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.47...v1.0.0-beta.48) (2025-09-09)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.47](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.46...v1.0.0-beta.47) (2025-09-01)
+
+### Features
+
+- **ls:** disable newly added rules for 3.1 spec ([#4997](https://github.com/swagger-api/apidom/issues/4997)) ([d5b16f8](https://github.com/swagger-api/apidom/commit/d5b16f82a916aea70929d2f3ff5be04769d8d8d3))
+
+# [1.0.0-beta.46](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.45...v1.0.0-beta.46) (2025-08-19)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.45](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.44...v1.0.0-beta.45) (2025-08-01)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.44](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.43...v1.0.0-beta.44) (2025-07-07)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.43](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.42...v1.0.0-beta.43) (2025-06-13)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.42](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.41...v1.0.0-beta.42) (2025-06-06)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.41](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.40...v1.0.0-beta.41) (2025-06-04)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.40](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.39...v1.0.0-beta.40) (2025-05-30)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.39](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.38...v1.0.0-beta.39) (2025-05-20)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.38](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.37...v1.0.0-beta.38) (2025-05-16)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.37](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.36...v1.0.0-beta.37) (2025-05-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.36](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.35...v1.0.0-beta.36) (2025-05-06)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.35](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.34...v1.0.0-beta.35) (2025-05-02)
+
+### Bug Fixes
+
+- **json-pointer-relative:** use spec compliant JSON Pointer impl ([#4885](https://github.com/swagger-api/apidom/issues/4885)) ([f22949c](https://github.com/swagger-api/apidom/commit/f22949c26b3b3f1dab2081dc32b84f4e1035049c)), closes [#4870](https://github.com/swagger-api/apidom/issues/4870)
+
+# [1.0.0-beta.34](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.33...v1.0.0-beta.34) (2025-05-02)
+
+### Bug Fixes
+
+- **ns-openapi-3-1:** use spec compliant JSON Pointer implementation ([#4880](https://github.com/swagger-api/apidom/issues/4880)) ([9499aa8](https://github.com/swagger-api/apidom/commit/9499aa8733445f15ec7441c7f87b89dab8542c49)), closes [#4870](https://github.com/swagger-api/apidom/issues/4870)
+
+# [1.0.0-beta.33](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.32...v1.0.0-beta.33) (2025-04-30)
+
+### Bug Fixes
+
+- **json-path:** use spec compliant JSON Pointer evaluation ([#4873](https://github.com/swagger-api/apidom/issues/4873)) ([c8407d6](https://github.com/swagger-api/apidom/commit/c8407d691b0fc540dfd3476f61ce17611621e67b))
+
+# [1.0.0-beta.32](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.31...v1.0.0-beta.32) (2025-04-28)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.31](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.30...v1.0.0-beta.31) (2025-04-24)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.30](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.29...v1.0.0-beta.30) (2025-03-17)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.29](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.28...v1.0.0-beta.29) (2025-03-17)
+
+### Bug Fixes
+
+- **security:** eliminate CVE-2025-27789 ([#4797](https://github.com/swagger-api/apidom/issues/4797)) ([af335c3](https://github.com/swagger-api/apidom/commit/af335c3d53616b7991acc74329e61d350398997a))
+
+# [1.0.0-beta.28](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.27...v1.0.0-beta.28) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.27](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.26...v1.0.0-beta.27) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.26](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.25...v1.0.0-beta.26) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.25](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.24...v1.0.0-beta.25) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.24](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.23...v1.0.0-beta.24) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.23](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.22...v1.0.0-beta.23) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.22](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.21...v1.0.0-beta.22) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.21](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.20...v1.0.0-beta.21) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.20](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.19...v1.0.0-beta.20) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.19](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.18...v1.0.0-beta.19) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.18](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.17...v1.0.0-beta.18) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.17](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.16...v1.0.0-beta.17) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.16](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.15...v1.0.0-beta.16) (2025-03-12)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.15](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.14...v1.0.0-beta.15) (2025-03-11)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.14](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.13...v1.0.0-beta.14) (2025-03-11)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.13](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.12...v1.0.0-beta.13) (2025-03-10)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.12](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.11...v1.0.0-beta.12) (2025-02-11)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.11](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.10...v1.0.0-beta.11) (2025-01-27)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.10](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.9...v1.0.0-beta.10) (2025-01-25)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.9](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.8...v1.0.0-beta.9) (2025-01-23)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
 # [1.0.0-beta.8](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.7...v1.0.0-beta.8) (2025-01-23)
 
 **Note:** Version bump only for package @swagger-api/apidom-json-pointer

package/README.md

@@ -9,7 +9,37 @@ You can install this package via [npm CLI](https://docs.npmjs.com/cli) by runnin
 ```sh
  $ npm install @swagger-api/apidom-json-pointer
 ```
-## Evaluating
+
+## Modern API
+
+This is the recommended API for use in new projects. It is fully compliant with [RFC 6901](https://datatracker.ietf.org/doc/html/rfc6901) and supports all aspects of JSON Pointer.
+Uses [@swaggerexpert/json-pointer](https://www.npmjs.com/package/@swaggerexpert/json-pointer) under the hood and fully reflects its API.
+
+Evaluation is contextual to [ApiDOM realm](https://github.com/swaggerexpert/json-pointer?tab=readme-ov-file#apidom-evaluation-realm) - meaning `evaluate` function
+expects only ApiDOM as the first argument.
+
+```js
+import { evaluate } from '@swagger-api/apidom-json-pointer/modern';
+```
+
+
+
+## Legacy API
+
+This is a legacy API not recommended for use in new projects. It is provided for backward compatibility only.
+The legacy API implementation is not RFC 6901 compliant, nor does it support all features of JSON Pointer.
+
+Importing legacy API from `@swagger-api/apidom-json-pointer` is equivalent to importing from `@swagger-api/apidom-json-pointer/legacy`.
+
+```js
+import { evaluate } from '@swagger-api/apidom-json-pointer';
+```
+or
+```js
+import { evaluate } from '@swagger-api/apidom-json-pointer/legacy';
+```
+
+### Evaluating
 
 ```js
 import { ObjectElement } from '@swagger-api/apidom-core';
@@ -20,7 +50,7 @@ const result =  evaluate('/a/b', apidom);
 // => StringElement('c')
 ```
 
-## Parsing
+### Parsing
 
 Parses JSON Pointer into list of tokens.
 
@@ -30,7 +60,7 @@ import { parse } from '@swagger-api/apidom-json-pointer';
 const tokens = parse('/a/b'); // => ['a', 'b']
 ```
 
-## Compiling
+### Compiling
 
 Compiles list of tokens into JSON Pointer.
 
@@ -40,7 +70,7 @@ import { compile } from '@swagger-api/apidom-json-pointer';
 const jsonPointer = compile(['a', 'b']); // => '/a/b'
 ```
 
-## Escaping
+### Escaping
 
 Escapes/unescapes tokens of JSON Pointer.
 
@@ -51,7 +81,7 @@ escape('~a/'); // => '~0a~1'
 unescape('~0a~1'); // => '~a/'
 ```
 
-## Transforming URI to JSON Pointer
+### Transforming URI to JSON Pointer
 
 Handles case of [URI Fragment Identifier Representation](https://datatracker.ietf.org/doc/html/rfc6901#section-6).
 
@@ -61,7 +91,7 @@ import { uriToPointer } from '@swagger-api/apidom-json-pointer';
 uriToPointer('https://example.com/path/#/a/b'); // => '/a/b'
 ```
 
-## Invalid JSON Pointers
+### Invalid JSON Pointers
 
 If invalid JSON Pointer is supplied to `parse` or `evaluate` functions, `InvalidJsonPointerError`
 is thrown.
@@ -76,3 +106,4 @@ ApiDOM fragment, `EvaluationJsonPointerError` is thrown.
 ```js
 import { EvaluationJsonPointerError } from '@swagger-api/apidom-json-pointer';
 ```
+