@speclynx/apidom-reference 5.1.1 → 5.2.1
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 +10 -0
- package/README.md +26 -2
- package/dist/apidom-reference.browser.js +1029 -222
- package/dist/apidom-reference.browser.min.js +1 -1
- package/package.json +29 -29
- package/src/bundle/strategies/arazzo-1/visitor.cjs +24 -8
- package/src/bundle/strategies/arazzo-1/visitor.mjs +25 -9
- package/src/dereference/strategies/arazzo-1/index.cjs +12 -0
- package/src/dereference/strategies/arazzo-1/index.mjs +1 -1
- package/src/dereference/strategies/arazzo-1/source-descriptions.cjs +8 -3
- package/src/dereference/strategies/arazzo-1/source-descriptions.mjs +8 -3
- package/src/dereference/strategies/arazzo-1/util.cjs +41 -1
- package/src/dereference/strategies/arazzo-1/util.mjs +38 -1
- package/src/dereference/strategies/arazzo-1/visitor.cjs +21 -7
- package/src/dereference/strategies/arazzo-1/visitor.mjs +22 -8
- package/src/parse/parsers/arazzo-json-1/source-descriptions.cjs +7 -2
- package/src/parse/parsers/arazzo-json-1/source-descriptions.mjs +8 -3
- package/types/bundle/strategies/arazzo-1/visitor.d.ts +6 -0
- package/types/dereference/strategies/arazzo-1/index.d.ts +1 -1
- package/types/dereference/strategies/arazzo-1/util.d.ts +22 -0
- package/types/dereference/strategies/arazzo-1/visitor.d.ts +6 -0
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,16 @@
|
|
|
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.1](https://github.com/speclynx/apidom/compare/v5.2.0...v5.2.1) (2026-08-29)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @speclynx/apidom-reference
|
|
9
|
+
|
|
10
|
+
# [5.2.0](https://github.com/speclynx/apidom/compare/v5.1.1...v5.2.0) (2026-08-29)
|
|
11
|
+
|
|
12
|
+
### Features
|
|
13
|
+
|
|
14
|
+
- **reference:** add support for Arazzo 1.1.0 ([#504](https://github.com/speclynx/apidom/issues/504)) ([1bad06a](https://github.com/speclynx/apidom/commit/1bad06a2a4a7ea7ef57223d4d08a8f60d17eddf2)), closes [#297](https://github.com/speclynx/apidom/issues/297)
|
|
15
|
+
|
|
6
16
|
## [5.1.1](https://github.com/speclynx/apidom/compare/v5.1.0...v5.1.1) (2026-08-19)
|
|
7
17
|
|
|
8
18
|
**Note:** Version bump only for package @speclynx/apidom-reference
|
package/README.md
CHANGED
|
@@ -289,6 +289,8 @@ Supported media types are:
|
|
|
289
289
|
'application/vnd.oai.workflows+json;version=1.0.0',
|
|
290
290
|
'application/vnd.oai.workflows;version=1.0.1',
|
|
291
291
|
'application/vnd.oai.workflows+json;version=1.0.1',
|
|
292
|
+
'application/vnd.oai.workflows;version=1.1.0',
|
|
293
|
+
'application/vnd.oai.workflows+json;version=1.1.0',
|
|
292
294
|
]
|
|
293
295
|
```
|
|
294
296
|
|
|
@@ -303,6 +305,7 @@ Parser-specific options take precedence over global options.
|
|
|
303
305
|
|
|
304
306
|
Each parsed source description is added with a `'source-description'` class and metadata (`name`, `type`, `retrievalURI`).
|
|
305
307
|
Only OpenAPI 2.0, OpenAPI 3.0.x, OpenAPI 3.1.x, and Arazzo 1.x documents are accepted as source descriptions.
|
|
308
|
+
Source description URLs are resolved against the Arazzo document's base URI (its `$self` field when present, otherwise its retrieval URI).
|
|
306
309
|
- **sourceDescriptionsMaxDepth** - Maximum recursion depth for parsing nested Arazzo source descriptions.
|
|
307
310
|
Defaults to `+Infinity`. Circular references are automatically detected and skipped.
|
|
308
311
|
|
|
@@ -442,6 +445,8 @@ Supported media types are:
|
|
|
442
445
|
'application/vnd.oai.workflows+yaml;version=1.0.0',
|
|
443
446
|
'application/vnd.oai.workflows;version=1.0.1',
|
|
444
447
|
'application/vnd.oai.workflows+yaml;version=1.0.1',
|
|
448
|
+
'application/vnd.oai.workflows;version=1.1.0',
|
|
449
|
+
'application/vnd.oai.workflows+yaml;version=1.1.0',
|
|
445
450
|
]
|
|
446
451
|
```
|
|
447
452
|
|
|
@@ -456,6 +461,7 @@ Parser-specific options take precedence over global options. See [arazzo-json-1]
|
|
|
456
461
|
|
|
457
462
|
Each parsed source description is added with a `'source-description'` class and metadata (`name`, `type`, `retrievalURI`).
|
|
458
463
|
Only OpenAPI 2.0, OpenAPI 3.0.x, OpenAPI 3.1.x, and Arazzo 1.x documents are accepted as source descriptions.
|
|
464
|
+
Source description URLs are resolved against the Arazzo document's base URI (its `$self` field when present, otherwise its retrieval URI).
|
|
459
465
|
- **sourceDescriptionsMaxDepth** - Maximum recursion depth for parsing nested Arazzo source descriptions.
|
|
460
466
|
Defaults to `+Infinity`. Circular references are automatically detected and skipped.
|
|
461
467
|
|
|
@@ -1607,6 +1613,9 @@ Supported media types:
|
|
|
1607
1613
|
'application/vnd.oai.workflows;version=1.0.1',
|
|
1608
1614
|
'application/vnd.oai.workflows+json;version=1.0.1',
|
|
1609
1615
|
'application/vnd.oai.workflows+yaml;version=1.0.1',
|
|
1616
|
+
'application/vnd.oai.workflows;version=1.1.0',
|
|
1617
|
+
'application/vnd.oai.workflows+json;version=1.1.0',
|
|
1618
|
+
'application/vnd.oai.workflows+yaml;version=1.1.0',
|
|
1610
1619
|
]
|
|
1611
1620
|
```
|
|
1612
1621
|
|
|
@@ -2008,6 +2017,11 @@ Supported media types:
|
|
|
2008
2017
|
|
|
2009
2018
|
Dereference strategy for dereferencing [Arazzo 1.x](https://spec.openapis.org/arazzo/latest.html) definitions.
|
|
2010
2019
|
|
|
2020
|
+
Relative references (JSON Schema `$ref` keywords and Source Description URLs) are resolved against the document's
|
|
2021
|
+
base URI. Per Arazzo 1.1.0, the base URI is the Arazzo Object's `$self` field when present (itself resolved
|
|
2022
|
+
against the retrieval URI when relative), otherwise the retrieval URI. A reference whose URI matches the `$self`
|
|
2023
|
+
of an already loaded Arazzo document resolves to that document by identity, without fetching it again.
|
|
2024
|
+
|
|
2011
2025
|
Supported media types:
|
|
2012
2026
|
|
|
2013
2027
|
```js
|
|
@@ -2018,6 +2032,9 @@ Supported media types:
|
|
|
2018
2032
|
'application/vnd.oai.workflows;version=1.0.1',
|
|
2019
2033
|
'application/vnd.oai.workflows+json;version=1.0.1',
|
|
2020
2034
|
'application/vnd.oai.workflows+yaml;version=1.0.1',
|
|
2035
|
+
'application/vnd.oai.workflows;version=1.1.0',
|
|
2036
|
+
'application/vnd.oai.workflows+json;version=1.1.0',
|
|
2037
|
+
'application/vnd.oai.workflows+yaml;version=1.1.0',
|
|
2021
2038
|
]
|
|
2022
2039
|
```
|
|
2023
2040
|
|
|
@@ -2032,6 +2049,7 @@ Strategy-specific options take precedence over global options.
|
|
|
2032
2049
|
|
|
2033
2050
|
Each dereferenced source description is added with a `'source-description'` class and metadata (`name`, `type`, `retrievalURI`).
|
|
2034
2051
|
Only OpenAPI 2.0, OpenAPI 3.0.x, OpenAPI 3.1.x, and Arazzo 1.x documents are accepted as source descriptions.
|
|
2052
|
+
Source description URLs are resolved against the Arazzo document's base URI (its `$self` field when present, otherwise its retrieval URI).
|
|
2035
2053
|
- **sourceDescriptionsMaxDepth** - Maximum recursion depth for dereferencing nested Arazzo source descriptions.
|
|
2036
2054
|
Defaults to `+Infinity`. Circular references are automatically detected and skipped.
|
|
2037
2055
|
|
|
@@ -2940,6 +2958,9 @@ rules, exactly as in the `openapi-3-1` strategy: the external schema **resource*
|
|
|
2940
2958
|
resource is embedded once, keyed by its `$id`; references (including `$anchor`, `$dynamicRef`, and
|
|
2941
2959
|
`$dynamicAnchor`) are never rewritten. Nested external schema resources are embedded flat into the top-level
|
|
2942
2960
|
`components.inputs`, deduplicated by resource URI. Internal Schema Object references are preserved untouched.
|
|
2961
|
+
Schema Object `$ref`s are resolved against the document's base URI — the Arazzo Object's `$self` field when
|
|
2962
|
+
present (Arazzo 1.1.0), otherwise the retrieval URI — and references resolving into the entry document
|
|
2963
|
+
(including by its `$self` identity) are treated as internal.
|
|
2943
2964
|
|
|
2944
2965
|
Supported media types:
|
|
2945
2966
|
|
|
@@ -2950,7 +2971,10 @@ Supported media types:
|
|
|
2950
2971
|
'application/vnd.oai.workflows+yaml;version=1.0.0',
|
|
2951
2972
|
'application/vnd.oai.workflows;version=1.0.1',
|
|
2952
2973
|
'application/vnd.oai.workflows+json;version=1.0.1',
|
|
2953
|
-
'application/vnd.oai.workflows+yaml;version=1.0.1'
|
|
2974
|
+
'application/vnd.oai.workflows+yaml;version=1.0.1',
|
|
2975
|
+
'application/vnd.oai.workflows;version=1.1.0',
|
|
2976
|
+
'application/vnd.oai.workflows+json;version=1.1.0',
|
|
2977
|
+
'application/vnd.oai.workflows+yaml;version=1.1.0',
|
|
2954
2978
|
]
|
|
2955
2979
|
```
|
|
2956
2980
|
|
|
@@ -2963,7 +2987,7 @@ import { bundle } from '@speclynx/apidom-reference';
|
|
|
2963
2987
|
|
|
2964
2988
|
await bundle('/home/user/arazzo.json', {
|
|
2965
2989
|
parse: {
|
|
2966
|
-
mediaType: 'application/vnd.oai.workflows+json;version=1.0
|
|
2990
|
+
mediaType: 'application/vnd.oai.workflows+json;version=1.1.0',
|
|
2967
2991
|
},
|
|
2968
2992
|
bundle: {
|
|
2969
2993
|
strategyOpts: {
|