@swagger-api/apidom-json-pointer 1.0.0-beta.33 → 1.0.0-beta.34

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.
 
+# [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

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';
 ```
+