@speclynx/apidom-reference 5.2.7 → 6.0.6
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 +38 -0
- package/README.md +23 -1
- package/dist/apidom-reference.browser.js +865 -31
- package/dist/apidom-reference.browser.min.js +1 -1
- package/package.json +30 -29
- package/src/dereference/strategies/overlay-1/extends.cjs +5 -1
- package/src/dereference/strategies/overlay-1/extends.mjs +5 -1
- package/src/dereference/strategies/overlay-1/index.cjs +20 -0
- package/src/dereference/strategies/overlay-1/index.mjs +15 -0
- package/src/dereference/strategies/overlay-1/visitor.cjs +148 -0
- package/src/dereference/strategies/overlay-1/visitor.mjs +140 -0
- package/src/parse/parsers/overlay-json-1/extends.cjs +5 -1
- package/src/parse/parsers/overlay-json-1/extends.mjs +5 -1
- package/src/util/url.cjs +3 -2
- package/src/util/url.mjs +3 -2
- package/types/dereference/strategies/overlay-1/index.d.ts +3 -0
- package/types/dereference/strategies/overlay-1/visitor.d.ts +21 -0
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,44 @@
|
|
|
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
|
+
## [6.0.6](https://github.com/speclynx/apidom/compare/v6.0.5...v6.0.6) (2026-10-15)
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
- **release:** pass sigstore timeout as a number via publishConfig ([#603](https://github.com/speclynx/apidom/issues/603)) ([3bb44d9](https://github.com/speclynx/apidom/commit/3bb44d9a924741a1f8bbbccebae9b6a2a7cd557b)), closes [#602](https://github.com/speclynx/apidom/issues/602) [#602](https://github.com/speclynx/apidom/issues/602)
|
|
11
|
+
|
|
12
|
+
## [6.0.5](https://github.com/speclynx/apidom/compare/v6.0.4...v6.0.5) (2026-10-15)
|
|
13
|
+
|
|
14
|
+
**Note:** Version bump only for package @speclynx/apidom-reference
|
|
15
|
+
|
|
16
|
+
## [6.0.4](https://github.com/speclynx/apidom/compare/v6.0.3...v6.0.4) (2026-10-15)
|
|
17
|
+
|
|
18
|
+
**Note:** Version bump only for package @speclynx/apidom-reference
|
|
19
|
+
|
|
20
|
+
## [6.0.3](https://github.com/speclynx/apidom/compare/v6.0.2...v6.0.3) (2026-10-15)
|
|
21
|
+
|
|
22
|
+
**Note:** Version bump only for package @speclynx/apidom-reference
|
|
23
|
+
|
|
24
|
+
## [6.0.2](https://github.com/speclynx/apidom/compare/v6.0.1...v6.0.2) (2026-10-15)
|
|
25
|
+
|
|
26
|
+
**Note:** Version bump only for package @speclynx/apidom-reference
|
|
27
|
+
|
|
28
|
+
## [6.0.1](https://github.com/speclynx/apidom/compare/v6.0.0...v6.0.1) (2026-10-15)
|
|
29
|
+
|
|
30
|
+
**Note:** Version bump only for package @speclynx/apidom-reference
|
|
31
|
+
|
|
32
|
+
# [6.0.0](https://github.com/speclynx/apidom/compare/v5.2.7...v6.0.0) (2026-10-15)
|
|
33
|
+
|
|
34
|
+
### Bug Fixes
|
|
35
|
+
|
|
36
|
+
- **reference:** keep authority of network-path references ([14eb9a1](https://github.com/speclynx/apidom/commit/14eb9a10ae78e80a2b06b7d711eec54f375e1c0b))
|
|
37
|
+
- **reference:** keep source position of dereferenced action refs ([1501cd0](https://github.com/speclynx/apidom/commit/1501cd074f99901e24ae74d66861bf0f18f839b3))
|
|
38
|
+
|
|
39
|
+
### Features
|
|
40
|
+
|
|
41
|
+
- **reference:** dereference overlay reusable action references ([ee5d4e1](https://github.com/speclynx/apidom/commit/ee5d4e1fbaf816318901707fe05100a9cadb72bd))
|
|
42
|
+
- **reference:** resolve overlay extends against $self ([d002292](https://github.com/speclynx/apidom/commit/d00229286bcad30b30cd2df9080e8762f2a46b6a))
|
|
43
|
+
|
|
6
44
|
## [5.2.7](https://github.com/speclynx/apidom/compare/v5.2.6...v5.2.7) (2026-10-13)
|
|
7
45
|
|
|
8
46
|
### Bug Fixes
|
package/README.md
CHANGED
|
@@ -543,6 +543,8 @@ Supported media types are:
|
|
|
543
543
|
'application/vnd.oai.overlay+json;version=1.0.0',
|
|
544
544
|
'application/vnd.oai.overlay;version=1.1.0',
|
|
545
545
|
'application/vnd.oai.overlay+json;version=1.1.0',
|
|
546
|
+
'application/vnd.oai.overlay;version=1.2.0',
|
|
547
|
+
'application/vnd.oai.overlay+json;version=1.2.0',
|
|
546
548
|
]
|
|
547
549
|
```
|
|
548
550
|
|
|
@@ -556,6 +558,7 @@ Parser-specific options take precedence over global options.
|
|
|
556
558
|
|
|
557
559
|
The parsed extends document is added with an `'extends'` class and `retrievalURI` metadata.
|
|
558
560
|
A `ParseResultElement` is also attached to the extends element's meta as `'parseResult'`.
|
|
561
|
+
The `extends` URI is resolved against the Overlay document's base URI (its `$self` field when present, otherwise its retrieval URI).
|
|
559
562
|
|
|
560
563
|
##### Error handling
|
|
561
564
|
|
|
@@ -656,6 +659,8 @@ Supported media types are:
|
|
|
656
659
|
'application/vnd.oai.overlay+yaml;version=1.0.0',
|
|
657
660
|
'application/vnd.oai.overlay;version=1.1.0',
|
|
658
661
|
'application/vnd.oai.overlay+yaml;version=1.1.0',
|
|
662
|
+
'application/vnd.oai.overlay;version=1.2.0',
|
|
663
|
+
'application/vnd.oai.overlay+yaml;version=1.2.0',
|
|
659
664
|
]
|
|
660
665
|
```
|
|
661
666
|
|
|
@@ -669,6 +674,7 @@ Parser-specific options take precedence over global options. See [overlay-json-1
|
|
|
669
674
|
|
|
670
675
|
The parsed extends document is added with an `'extends'` class and `retrievalURI` metadata.
|
|
671
676
|
A `ParseResultElement` is also attached to the extends element's meta as `'parseResult'`.
|
|
677
|
+
The `extends` URI is resolved against the Overlay document's base URI (its `$self` field when present, otherwise its retrieval URI).
|
|
672
678
|
|
|
673
679
|
##### Error handling
|
|
674
680
|
|
|
@@ -1645,6 +1651,9 @@ Supported media types:
|
|
|
1645
1651
|
'application/vnd.oai.overlay;version=1.1.0',
|
|
1646
1652
|
'application/vnd.oai.overlay+json;version=1.1.0',
|
|
1647
1653
|
'application/vnd.oai.overlay+yaml;version=1.1.0',
|
|
1654
|
+
'application/vnd.oai.overlay;version=1.2.0',
|
|
1655
|
+
'application/vnd.oai.overlay+json;version=1.2.0',
|
|
1656
|
+
'application/vnd.oai.overlay+yaml;version=1.2.0',
|
|
1648
1657
|
]
|
|
1649
1658
|
```
|
|
1650
1659
|
|
|
@@ -2192,7 +2201,16 @@ dereferenceSourceDescriptions(
|
|
|
2192
2201
|
|
|
2193
2202
|
##### [overlay-1](https://github.com/speclynx/apidom/tree/main/packages/apidom-reference/src/dereference/strategies/overlay-1)
|
|
2194
2203
|
|
|
2195
|
-
Dereference strategy for dereferencing [Overlay 1.x](https://spec.openapis.org/overlay/v1.
|
|
2204
|
+
Dereference strategy for dereferencing [Overlay 1.x](https://spec.openapis.org/overlay/v1.2.0.html) definitions.
|
|
2205
|
+
|
|
2206
|
+
[Reusable Action References](https://spec.openapis.org/overlay/v1.2.0.html#reusable-action-reference-object) (Overlay 1.2.0)
|
|
2207
|
+
in `actions` are replaced with the Action Objects they resolve to in `components.actions`. The reference provides `target`,
|
|
2208
|
+
and its `description` takes precedence over the one from the reusable action's `fields`. Every resolved Action Object
|
|
2209
|
+
carries `ref-fields`, `ref-origin` and `ref-type` meta. Reusable Action References are same-document references,
|
|
2210
|
+
so they are only dereferenced when `resolve.internal` is `true` (the default). As the specification requires,
|
|
2211
|
+
external references (relative or absolute URLs in `$ref`) are not supported and are reported as unresolvable. Unresolvable references
|
|
2212
|
+
raise `UnresolvableReferenceError`, honoring the `dereference.continueOnError` option; when errors are continued on,
|
|
2213
|
+
the reference is left in place.
|
|
2196
2214
|
|
|
2197
2215
|
Supported media types:
|
|
2198
2216
|
|
|
@@ -2204,6 +2222,9 @@ Supported media types:
|
|
|
2204
2222
|
'application/vnd.oai.overlay;version=1.1.0',
|
|
2205
2223
|
'application/vnd.oai.overlay+json;version=1.1.0',
|
|
2206
2224
|
'application/vnd.oai.overlay+yaml;version=1.1.0',
|
|
2225
|
+
'application/vnd.oai.overlay;version=1.2.0',
|
|
2226
|
+
'application/vnd.oai.overlay+json;version=1.2.0',
|
|
2227
|
+
'application/vnd.oai.overlay+yaml;version=1.2.0',
|
|
2207
2228
|
]
|
|
2208
2229
|
```
|
|
2209
2230
|
|
|
@@ -2218,6 +2239,7 @@ Strategy-specific options take precedence over global options.
|
|
|
2218
2239
|
The dereferenced extends document is added with an `'extends'` class and `retrievalURI` metadata.
|
|
2219
2240
|
If the extends target was already parsed during the parse phase, it will be dereferenced in place
|
|
2220
2241
|
without re-fetching.
|
|
2242
|
+
The `extends` URI is resolved against the Overlay document's base URI (its `$self` field when present, otherwise its retrieval URI).
|
|
2221
2243
|
|
|
2222
2244
|
###### Error handling
|
|
2223
2245
|
|