@speclynx/apidom-reference 5.2.5 → 5.2.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/README.md +7 -3
- package/dist/apidom-reference.browser.js +63590 -63495
- package/dist/apidom-reference.browser.min.js +1 -1
- package/package.json +29 -30
- package/src/dereference/strategies/arazzo-1/index.cjs +11 -10
- package/src/dereference/strategies/arazzo-1/index.mjs +11 -10
- package/src/dereference/strategies/arazzo-1/source-descriptions.cjs +65 -42
- package/src/dereference/strategies/arazzo-1/source-descriptions.mjs +64 -42
- package/src/dereference/strategies/arazzo-1/visitor.cjs +30 -26
- package/src/dereference/strategies/arazzo-1/visitor.mjs +30 -26
- package/src/util/url.cjs +7 -5
- package/src/util/url.mjs +6 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,19 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [5.2.7](https://github.com/speclynx/apidom/compare/v5.2.6...v5.2.7) (2026-10-13)
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
- **reference:** drop process polyfill dependency ([#584](https://github.com/speclynx/apidom/issues/584)) ([ecc62de](https://github.com/speclynx/apidom/commit/ecc62de070eee7db4a7c47d2f2380c783d9f10b7))
|
|
11
|
+
|
|
12
|
+
## [5.2.6](https://github.com/speclynx/apidom/compare/v5.2.5...v5.2.6) (2026-09-19)
|
|
13
|
+
|
|
14
|
+
### Bug Fixes
|
|
15
|
+
|
|
16
|
+
- **reference:** honour continueOnError for Arazzo Reusable Objects ([#552](https://github.com/speclynx/apidom/issues/552)) ([2bcd675](https://github.com/speclynx/apidom/commit/2bcd675d16fc1bf3fc5079fdee37419c1d84017c)), closes [#550](https://github.com/speclynx/apidom/issues/550)
|
|
17
|
+
- **reference:** isolate refSet of Arazzo source descriptions ([#553](https://github.com/speclynx/apidom/issues/553)) ([ac21c16](https://github.com/speclynx/apidom/commit/ac21c165104e604aa59f027a8d78645c8bd9ca66)), closes [#551](https://github.com/speclynx/apidom/issues/551)
|
|
18
|
+
|
|
6
19
|
## [5.2.5](https://github.com/speclynx/apidom/compare/v5.2.4...v5.2.5) (2026-09-17)
|
|
7
20
|
|
|
8
21
|
### Bug Fixes
|
package/README.md
CHANGED
|
@@ -2071,6 +2071,10 @@ Strategy-specific options take precedence over global options.
|
|
|
2071
2071
|
The `SourceDescriptionElement`'s `'parseResult'` meta points at that same `ParseResultElement`, so the dereferenced
|
|
2072
2072
|
document is reachable from every source description that references it.
|
|
2073
2073
|
|
|
2074
|
+
When `dereference.refSet` is provided, source descriptions reuse the documents it already contains,
|
|
2075
|
+
and every document reached through a source description is added to it.
|
|
2076
|
+
This is also how resolving with `sourceDescriptions` enabled reports the documents behind source descriptions.
|
|
2077
|
+
|
|
2074
2078
|
###### Error handling
|
|
2075
2079
|
|
|
2076
2080
|
The source descriptions dereferencing uses annotations instead of throwing errors, allowing dereferencing to continue
|
|
@@ -2496,16 +2500,16 @@ await dereference('/home/user/oas.json', {
|
|
|
2496
2500
|
// errors is an array of UnresolvableReferenceError instances
|
|
2497
2501
|
```
|
|
2498
2502
|
|
|
2499
|
-
Each `UnresolvableReferenceError` (extends `
|
|
2503
|
+
Each `UnresolvableReferenceError` (extends `ResolveError`) carries structured context:
|
|
2500
2504
|
|
|
2501
2505
|
| Property | Type | Description |
|
|
2502
2506
|
|---|---|---|
|
|
2503
2507
|
| `message` | `string` | Contextual description (e.g., "Error while dereferencing Reference Object. Cannot resolve $ref ...") |
|
|
2504
|
-
| `type` | `string` | Element type that failed (e.g., `"reference"`, `"pathItem"`, `"schema"`, `"link"`, `"example"`) |
|
|
2508
|
+
| `type` | `string` | Element type that failed (e.g., `"reference"`, `"pathItem"`, `"schema"`, `"link"`, `"example"`, `"reusable"`) |
|
|
2505
2509
|
| `uri` | `string` | Document URI where the error occurred |
|
|
2506
2510
|
| `location` | `string` | JSON Pointer to the element within the document |
|
|
2507
2511
|
| `codeFrame` | `string` | YAML snippet of the referencing element |
|
|
2508
|
-
| `refFieldName` | `string` | Reference field name (e.g., `"$ref"`, `"operationRef"`, `"externalValue"`) |
|
|
2512
|
+
| `refFieldName` | `string` | Reference field name (e.g., `"$ref"`, `"operationRef"`, `"externalValue"`, `"reference"`) |
|
|
2509
2513
|
| `refFieldValue` | `string` | Reference field value |
|
|
2510
2514
|
| `trace` | `Array` | Chain of reference hops from entry document to the failure |
|
|
2511
2515
|
| `cause` | `Error` | The underlying error |
|