@usearazzo/resolver 1.0.1-alpha.2 → 1.0.1-alpha.21
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 +93 -0
- package/README.md +6 -3
- package/dist/arazzo-resolver.browser.js +2397 -2371
- package/dist/arazzo-resolver.browser.min.js +1 -1
- package/package.json +18 -15
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# Change Log
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
|
+
|
|
6
|
+
## [1.0.1-alpha.21](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.20...v1.0.1-alpha.21) (2026-11-03)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
9
|
+
|
|
10
|
+
## [1.0.1-alpha.20](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.19...v1.0.1-alpha.20) (2026-11-01)
|
|
11
|
+
|
|
12
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
13
|
+
|
|
14
|
+
## [1.0.1-alpha.19](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.18...v1.0.1-alpha.19) (2026-10-31)
|
|
15
|
+
|
|
16
|
+
### Bug Fixes
|
|
17
|
+
|
|
18
|
+
- **validator:** accept in: querystring in Arazzo 1.1.0 documents ([#299](https://github.com/usearazzo/arazzo-toolkit/issues/299)) ([4d26bbb](https://github.com/usearazzo/arazzo-toolkit/commit/4d26bbb3fd9c08c1345c51d4d6aae99f4e359f28)), closes [speclynx/api-languageservice#97](https://github.com/speclynx/api-languageservice/issues/97) [#281](https://github.com/usearazzo/arazzo-toolkit/issues/281)
|
|
19
|
+
|
|
20
|
+
## [1.0.1-alpha.18](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.17...v1.0.1-alpha.18) (2026-10-30)
|
|
21
|
+
|
|
22
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
23
|
+
|
|
24
|
+
## [1.0.1-alpha.17](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.16...v1.0.1-alpha.17) (2026-10-29)
|
|
25
|
+
|
|
26
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
27
|
+
|
|
28
|
+
## [1.0.1-alpha.16](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.15...v1.0.1-alpha.16) (2026-10-28)
|
|
29
|
+
|
|
30
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
31
|
+
|
|
32
|
+
## [1.0.1-alpha.15](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.14...v1.0.1-alpha.15) (2026-10-28)
|
|
33
|
+
|
|
34
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
35
|
+
|
|
36
|
+
## [1.0.1-alpha.14](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.13...v1.0.1-alpha.14) (2026-10-27)
|
|
37
|
+
|
|
38
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
39
|
+
|
|
40
|
+
## [1.0.1-alpha.13](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.12...v1.0.1-alpha.13) (2026-10-27)
|
|
41
|
+
|
|
42
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
43
|
+
|
|
44
|
+
## [1.0.1-alpha.12](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.11...v1.0.1-alpha.12) (2026-10-27)
|
|
45
|
+
|
|
46
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
47
|
+
|
|
48
|
+
## [1.0.1-alpha.11](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.10...v1.0.1-alpha.11) (2026-10-25)
|
|
49
|
+
|
|
50
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
51
|
+
|
|
52
|
+
## [1.0.1-alpha.10](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.9...v1.0.1-alpha.10) (2026-10-23)
|
|
53
|
+
|
|
54
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
55
|
+
|
|
56
|
+
## [1.0.1-alpha.9](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.8...v1.0.1-alpha.9) (2026-10-22)
|
|
57
|
+
|
|
58
|
+
### Bug Fixes
|
|
59
|
+
|
|
60
|
+
- **release:** publish serially with a longer sigstore timeout ([ea02ce2](https://github.com/usearazzo/arazzo-toolkit/commit/ea02ce2e69871b5580c86f50aacb20cf45746a04))
|
|
61
|
+
|
|
62
|
+
## [1.0.1-alpha.8](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.7...v1.0.1-alpha.8) (2026-10-22)
|
|
63
|
+
|
|
64
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
65
|
+
|
|
66
|
+
## [1.0.1-alpha.7](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.6...v1.0.1-alpha.7) (2026-10-10)
|
|
67
|
+
|
|
68
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
69
|
+
|
|
70
|
+
## [1.0.1-alpha.6](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.5...v1.0.1-alpha.6) (2026-10-04)
|
|
71
|
+
|
|
72
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
73
|
+
|
|
74
|
+
## [1.0.1-alpha.5](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.4...v1.0.1-alpha.5) (2026-09-24)
|
|
75
|
+
|
|
76
|
+
### Bug Fixes
|
|
77
|
+
|
|
78
|
+
- **docs:** add documentation section to parser and resolver READMEs ([#184](https://github.com/usearazzo/arazzo-toolkit/issues/184)) ([f3a7f89](https://github.com/usearazzo/arazzo-toolkit/commit/f3a7f89900c5a002116c91c0c628ca120dc4f97a))
|
|
79
|
+
|
|
80
|
+
## [1.0.1-alpha.4](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.3...v1.0.1-alpha.4) (2026-09-19)
|
|
81
|
+
|
|
82
|
+
**Note:** Version bump only for package @usearazzo/resolver
|
|
83
|
+
|
|
84
|
+
## [1.0.1-alpha.3](https://github.com/usearazzo/arazzo-toolkit/compare/v1.0.1-alpha.2...v1.0.1-alpha.3) (2026-09-19)
|
|
85
|
+
|
|
86
|
+
### Bug Fixes
|
|
87
|
+
|
|
88
|
+
- **resolver:** bump apidom to 5.2.5 to rebase bundled schema $ref ([#167](https://github.com/usearazzo/arazzo-toolkit/issues/167)) ([189bdf5](https://github.com/usearazzo/arazzo-toolkit/commit/189bdf512ed74f6bc80e3fc4dc1f2b83049688e8)), closes [#158](https://github.com/usearazzo/arazzo-toolkit/issues/158)
|
|
89
|
+
|
|
90
|
+
### Features
|
|
91
|
+
|
|
92
|
+
- release @usearazzo/resolver ([#171](https://github.com/usearazzo/arazzo-toolkit/issues/171)) ([7fe7597](https://github.com/usearazzo/arazzo-toolkit/commit/7fe759757436416562c47d1d7f7dd6b26d945b05))
|
|
93
|
+
- **resolver:** add resolve and bundle and publish the package ([#157](https://github.com/usearazzo/arazzo-toolkit/issues/157)) ([eb84108](https://github.com/usearazzo/arazzo-toolkit/commit/eb8410866bac5569a86eebeda863d9a1feed6c87))
|
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
|
|
21
21
|
Arazzo and OpenAPI documents contain references, to other parts of the same document and to other documents. This package handles those references in three ways, all on [SpecLynx ApiDOM](https://github.com/speclynx/apidom):
|
|
22
22
|
|
|
23
|
-
- **Bundle.** `bundleArazzo` and `bundleOpenAPI` pull external documents into the entry document's components, producing a single *compound document* that still reads like the original: external JSON Schema resources land in `components.inputs` in Arazzo; Reference Object targets land in the matching `components` field and external Path Items in `components.pathItems` in OpenAPI.
|
|
23
|
+
- **Bundle.** `bundleArazzo` and `bundleOpenAPI` pull external documents into the entry document's components, producing a single *compound document* that still reads like the original: external JSON Schema resources land in `components.inputs` in Arazzo; Reference Object targets land in the matching `components` field and external Path Items in `components.pathItems` in OpenAPI. Reference Objects are repointed to the hoisted components. JSON Schema references stay as written and resolve through the `$id` each hoisted schema receives.
|
|
24
24
|
- **Dereference.** `dereferenceArazzo` and `dereferenceOpenAPI` replace every reference with the content it points at: JSON Schema References and Reusable Object references (`$components.*`) in Arazzo; Reference Objects, Path Item references, and schema references in OpenAPI. The result is one self-contained directed graph: a Directed Acyclic Graph (DAG), or a Directed Cyclic Graph (DCG) when references form cycles. Arazzo source descriptions can be dereferenced along with the entry document.
|
|
25
25
|
- **Resolve.** `resolveArazzo` and `resolveOpenAPI` fetch the document and every external document its references reach, and return the `ReferenceSet` listing them all, parsed. Nothing is replaced; this is the reference graph itself.
|
|
26
26
|
|
|
@@ -76,9 +76,12 @@ const dereferenced = await dereferenceArazzoElement(parseResult, {
|
|
|
76
76
|
});
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
## Documentation
|
|
80
80
|
|
|
81
|
-
|
|
81
|
+
The examples above are the happy path. Everything else is in the docs at [usearazzo.com/docs](https://usearazzo.com/docs/):
|
|
82
|
+
|
|
83
|
+
- **[Resolver API Reference](https://usearazzo.com/docs/resolver/)** covers every exported function: its options, from base URIs to source descriptions, the shape of what it returns, and the errors it can throw. Start here when you know what you want to call.
|
|
84
|
+
- **[Resolving Arazzo Documents](https://usearazzo.com/docs/guides/arazzo-document-resolving/)** explains why an Arazzo document is never one file, what bundling, dereferencing and resolving each mean, and what makes references hard to get right. Start here when you want to understand why the package is shaped the way it is.
|
|
82
85
|
|
|
83
86
|
## Supported versions
|
|
84
87
|
|