@speclynx/apidom-reference 3.2.0 → 4.0.0

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.
Files changed (192) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/dist/apidom-reference.browser.js +162 -127
  3. package/dist/apidom-reference.browser.min.js +1 -1
  4. package/package.json +25 -25
  5. package/types/dereference/strategies/apidom/visitor.d.ts +1 -1
  6. package/types/dereference/strategies/arazzo-1/visitor.d.ts +1 -1
  7. package/types/dereference/strategies/asyncapi-2/visitor.d.ts +1 -1
  8. package/types/dereference/strategies/openapi-2/visitor.d.ts +1 -1
  9. package/types/dereference/strategies/openapi-3-0/visitor.d.ts +1 -1
  10. package/types/dereference/strategies/openapi-3-1/visitor.d.ts +1 -1
  11. package/src/File.cjs +0 -50
  12. package/src/File.mjs +0 -44
  13. package/src/Reference.cjs +0 -31
  14. package/src/Reference.mjs +0 -27
  15. package/src/ReferenceSet.cjs +0 -60
  16. package/src/ReferenceSet.mjs +0 -57
  17. package/src/bundle/index.cjs +0 -61
  18. package/src/bundle/index.mjs +0 -55
  19. package/src/bundle/strategies/BundleStrategy.cjs +0 -20
  20. package/src/bundle/strategies/BundleStrategy.mjs +0 -16
  21. package/src/bundle/strategies/openapi-3-1/index.cjs +0 -35
  22. package/src/bundle/strategies/openapi-3-1/index.mjs +0 -29
  23. package/src/configuration/empty.cjs +0 -9
  24. package/src/configuration/empty.mjs +0 -1
  25. package/src/configuration/saturated.cjs +0 -88
  26. package/src/configuration/saturated.mjs +0 -80
  27. package/src/dereference/index.cjs +0 -90
  28. package/src/dereference/index.mjs +0 -83
  29. package/src/dereference/strategies/DereferenceStrategy.cjs +0 -20
  30. package/src/dereference/strategies/DereferenceStrategy.mjs +0 -16
  31. package/src/dereference/strategies/apidom/index.cjs +0 -89
  32. package/src/dereference/strategies/apidom/index.mjs +0 -83
  33. package/src/dereference/strategies/apidom/selectors/element-id.cjs +0 -47
  34. package/src/dereference/strategies/apidom/selectors/element-id.mjs +0 -41
  35. package/src/dereference/strategies/apidom/visitor.cjs +0 -259
  36. package/src/dereference/strategies/apidom/visitor.mjs +0 -252
  37. package/src/dereference/strategies/arazzo-1/index.cjs +0 -109
  38. package/src/dereference/strategies/arazzo-1/index.mjs +0 -100
  39. package/src/dereference/strategies/arazzo-1/selectors/$anchor.cjs +0 -12
  40. package/src/dereference/strategies/arazzo-1/selectors/$anchor.mjs +0 -1
  41. package/src/dereference/strategies/arazzo-1/selectors/uri.cjs +0 -8
  42. package/src/dereference/strategies/arazzo-1/selectors/uri.mjs +0 -1
  43. package/src/dereference/strategies/arazzo-1/source-descriptions.cjs +0 -248
  44. package/src/dereference/strategies/arazzo-1/source-descriptions.mjs +0 -243
  45. package/src/dereference/strategies/arazzo-1/util.cjs +0 -37
  46. package/src/dereference/strategies/arazzo-1/util.mjs +0 -29
  47. package/src/dereference/strategies/arazzo-1/visitor.cjs +0 -501
  48. package/src/dereference/strategies/arazzo-1/visitor.mjs +0 -494
  49. package/src/dereference/strategies/asyncapi-2/index.cjs +0 -94
  50. package/src/dereference/strategies/asyncapi-2/index.mjs +0 -88
  51. package/src/dereference/strategies/asyncapi-2/visitor.cjs +0 -495
  52. package/src/dereference/strategies/asyncapi-2/visitor.mjs +0 -488
  53. package/src/dereference/strategies/openapi-2/index.cjs +0 -96
  54. package/src/dereference/strategies/openapi-2/index.mjs +0 -90
  55. package/src/dereference/strategies/openapi-2/visitor.cjs +0 -623
  56. package/src/dereference/strategies/openapi-2/visitor.mjs +0 -616
  57. package/src/dereference/strategies/openapi-3-0/index.cjs +0 -96
  58. package/src/dereference/strategies/openapi-3-0/index.mjs +0 -90
  59. package/src/dereference/strategies/openapi-3-0/visitor.cjs +0 -615
  60. package/src/dereference/strategies/openapi-3-0/visitor.mjs +0 -608
  61. package/src/dereference/strategies/openapi-3-1/index.cjs +0 -99
  62. package/src/dereference/strategies/openapi-3-1/index.mjs +0 -90
  63. package/src/dereference/strategies/openapi-3-1/selectors/$anchor.cjs +0 -67
  64. package/src/dereference/strategies/openapi-3-1/selectors/$anchor.mjs +0 -56
  65. package/src/dereference/strategies/openapi-3-1/selectors/uri.cjs +0 -50
  66. package/src/dereference/strategies/openapi-3-1/selectors/uri.mjs +0 -42
  67. package/src/dereference/strategies/openapi-3-1/util.cjs +0 -68
  68. package/src/dereference/strategies/openapi-3-1/util.mjs +0 -59
  69. package/src/dereference/strategies/openapi-3-1/visitor.cjs +0 -867
  70. package/src/dereference/strategies/openapi-3-1/visitor.mjs +0 -860
  71. package/src/dereference/util.cjs +0 -31
  72. package/src/dereference/util.mjs +0 -27
  73. package/src/errors/BundleError.cjs +0 -10
  74. package/src/errors/BundleError.mjs +0 -7
  75. package/src/errors/DereferenceError.cjs +0 -10
  76. package/src/errors/DereferenceError.mjs +0 -7
  77. package/src/errors/EvaluationElementIdError.cjs +0 -10
  78. package/src/errors/EvaluationElementIdError.mjs +0 -7
  79. package/src/errors/EvaluationJsonSchema$anchorError.cjs +0 -11
  80. package/src/errors/EvaluationJsonSchema$anchorError.mjs +0 -6
  81. package/src/errors/EvaluationJsonSchemaUriError.cjs +0 -11
  82. package/src/errors/EvaluationJsonSchemaUriError.mjs +0 -6
  83. package/src/errors/InvalidJsonSchema$anchorError.cjs +0 -15
  84. package/src/errors/InvalidJsonSchema$anchorError.mjs +0 -10
  85. package/src/errors/JsonSchema$anchorError.cjs +0 -10
  86. package/src/errors/JsonSchema$anchorError.mjs +0 -7
  87. package/src/errors/JsonSchemaUriError.cjs +0 -10
  88. package/src/errors/JsonSchemaUriError.mjs +0 -7
  89. package/src/errors/MaximumBundleDepthError.cjs +0 -11
  90. package/src/errors/MaximumBundleDepthError.mjs +0 -6
  91. package/src/errors/MaximumDereferenceDepthError.cjs +0 -11
  92. package/src/errors/MaximumDereferenceDepthError.mjs +0 -6
  93. package/src/errors/MaximumResolveDepthError.cjs +0 -11
  94. package/src/errors/MaximumResolveDepthError.mjs +0 -6
  95. package/src/errors/ParseError.cjs +0 -10
  96. package/src/errors/ParseError.mjs +0 -7
  97. package/src/errors/ParserError.cjs +0 -11
  98. package/src/errors/ParserError.mjs +0 -6
  99. package/src/errors/PluginError.cjs +0 -18
  100. package/src/errors/PluginError.mjs +0 -15
  101. package/src/errors/ResolveError.cjs +0 -10
  102. package/src/errors/ResolveError.mjs +0 -7
  103. package/src/errors/ResolverError.cjs +0 -11
  104. package/src/errors/ResolverError.mjs +0 -6
  105. package/src/errors/UnmatchedBundleStrategyError.cjs +0 -11
  106. package/src/errors/UnmatchedBundleStrategyError.mjs +0 -6
  107. package/src/errors/UnmatchedDereferenceStrategyError.cjs +0 -11
  108. package/src/errors/UnmatchedDereferenceStrategyError.mjs +0 -6
  109. package/src/errors/UnmatchedParserError.cjs +0 -11
  110. package/src/errors/UnmatchedParserError.mjs +0 -6
  111. package/src/errors/UnmatchedResolveStrategyError.cjs +0 -11
  112. package/src/errors/UnmatchedResolveStrategyError.mjs +0 -6
  113. package/src/errors/UnmatchedResolverError.cjs +0 -11
  114. package/src/errors/UnmatchedResolverError.mjs +0 -6
  115. package/src/errors/UnresolvableReferenceError.cjs +0 -11
  116. package/src/errors/UnresolvableReferenceError.mjs +0 -6
  117. package/src/index.cjs +0 -146
  118. package/src/index.mjs +0 -103
  119. package/src/options/index.cjs +0 -194
  120. package/src/options/index.mjs +0 -191
  121. package/src/options/util.cjs +0 -24
  122. package/src/options/util.mjs +0 -19
  123. package/src/parse/index.cjs +0 -69
  124. package/src/parse/index.mjs +0 -63
  125. package/src/parse/parsers/Parser.cjs +0 -62
  126. package/src/parse/parsers/Parser.mjs +0 -58
  127. package/src/parse/parsers/apidom-json/index.cjs +0 -70
  128. package/src/parse/parsers/apidom-json/index.mjs +0 -64
  129. package/src/parse/parsers/arazzo-json-1/index.cjs +0 -62
  130. package/src/parse/parsers/arazzo-json-1/index.mjs +0 -56
  131. package/src/parse/parsers/arazzo-json-1/source-descriptions.cjs +0 -221
  132. package/src/parse/parsers/arazzo-json-1/source-descriptions.mjs +0 -214
  133. package/src/parse/parsers/arazzo-yaml-1/index.cjs +0 -62
  134. package/src/parse/parsers/arazzo-yaml-1/index.mjs +0 -56
  135. package/src/parse/parsers/arazzo-yaml-1/source-descriptions.cjs +0 -12
  136. package/src/parse/parsers/arazzo-yaml-1/source-descriptions.mjs +0 -7
  137. package/src/parse/parsers/asyncapi-json-2/index.cjs +0 -54
  138. package/src/parse/parsers/asyncapi-json-2/index.mjs +0 -48
  139. package/src/parse/parsers/asyncapi-yaml-2/index.cjs +0 -54
  140. package/src/parse/parsers/asyncapi-yaml-2/index.mjs +0 -48
  141. package/src/parse/parsers/binary/index-browser.cjs +0 -56
  142. package/src/parse/parsers/binary/index-browser.mjs +0 -50
  143. package/src/parse/parsers/binary/index-node.cjs +0 -51
  144. package/src/parse/parsers/binary/index-node.mjs +0 -45
  145. package/src/parse/parsers/json/index.cjs +0 -53
  146. package/src/parse/parsers/json/index.mjs +0 -47
  147. package/src/parse/parsers/openapi-json-2/index.cjs +0 -54
  148. package/src/parse/parsers/openapi-json-2/index.mjs +0 -48
  149. package/src/parse/parsers/openapi-json-3-0/index.cjs +0 -54
  150. package/src/parse/parsers/openapi-json-3-0/index.mjs +0 -48
  151. package/src/parse/parsers/openapi-json-3-1/index.cjs +0 -54
  152. package/src/parse/parsers/openapi-json-3-1/index.mjs +0 -48
  153. package/src/parse/parsers/openapi-yaml-2/index.cjs +0 -54
  154. package/src/parse/parsers/openapi-yaml-2/index.mjs +0 -48
  155. package/src/parse/parsers/openapi-yaml-3-0/index.cjs +0 -54
  156. package/src/parse/parsers/openapi-yaml-3-0/index.mjs +0 -48
  157. package/src/parse/parsers/openapi-yaml-3-1/index.cjs +0 -54
  158. package/src/parse/parsers/openapi-yaml-3-1/index.mjs +0 -48
  159. package/src/parse/parsers/yaml-1-2/index.cjs +0 -56
  160. package/src/parse/parsers/yaml-1-2/index.mjs +0 -50
  161. package/src/resolve/index.cjs +0 -67
  162. package/src/resolve/index.mjs +0 -60
  163. package/src/resolve/resolvers/HTTPResolver.cjs +0 -45
  164. package/src/resolve/resolvers/HTTPResolver.mjs +0 -37
  165. package/src/resolve/resolvers/Resolver.cjs +0 -20
  166. package/src/resolve/resolvers/Resolver.mjs +0 -16
  167. package/src/resolve/resolvers/file/index-browser.cjs +0 -24
  168. package/src/resolve/resolvers/file/index-browser.mjs +0 -19
  169. package/src/resolve/resolvers/file/index-node.cjs +0 -49
  170. package/src/resolve/resolvers/file/index-node.mjs +0 -42
  171. package/src/resolve/resolvers/http-axios/cache/MemoryCache.cjs +0 -41
  172. package/src/resolve/resolvers/http-axios/cache/MemoryCache.mjs +0 -37
  173. package/src/resolve/resolvers/http-axios/index.cjs +0 -113
  174. package/src/resolve/resolvers/http-axios/index.mjs +0 -105
  175. package/src/resolve/strategies/ResolveStrategy.cjs +0 -20
  176. package/src/resolve/strategies/ResolveStrategy.mjs +0 -16
  177. package/src/resolve/strategies/apidom/index.cjs +0 -49
  178. package/src/resolve/strategies/apidom/index.mjs +0 -43
  179. package/src/resolve/strategies/asyncapi-2/index.cjs +0 -49
  180. package/src/resolve/strategies/asyncapi-2/index.mjs +0 -43
  181. package/src/resolve/strategies/openapi-2/index.cjs +0 -49
  182. package/src/resolve/strategies/openapi-2/index.mjs +0 -43
  183. package/src/resolve/strategies/openapi-3-0/index.cjs +0 -49
  184. package/src/resolve/strategies/openapi-3-0/index.mjs +0 -43
  185. package/src/resolve/strategies/openapi-3-1/index.cjs +0 -49
  186. package/src/resolve/strategies/openapi-3-1/index.mjs +0 -43
  187. package/src/resolve/util.cjs +0 -37
  188. package/src/resolve/util.mjs +0 -30
  189. package/src/util/plugins.cjs +0 -39
  190. package/src/util/plugins.mjs +0 -34
  191. package/src/util/url.cjs +0 -288
  192. package/src/util/url.mjs +0 -274
@@ -1,494 +0,0 @@
1
- import { propEq, none } from 'ramda';
2
- import { isElement, isStringElement, RefElement, cloneShallow, cloneDeep } from '@speclynx/apidom-datamodel';
3
- import { toValue, toYAML } from '@speclynx/apidom-core';
4
- import { ApiDOMStructuredError } from '@speclynx/apidom-error';
5
- import { traverse, traverseAsync } from '@speclynx/apidom-traverse';
6
- import { evaluate as jsonPointerEvaluate, compile as jsonPointerCompile, URIFragmentIdentifier } from '@speclynx/apidom-json-pointer';
7
- import { isParameterElement, isJSONSchemaElement, isBooleanJSONSchemaElement } from '@speclynx/apidom-ns-arazzo-1';
8
- import { parse as parseRuntimeExpression } from '@swaggerexpert/arazzo-runtime-expression';
9
- import { isAnchor, uriToAnchor, evaluate as $anchorEvaluate } from "./selectors/$anchor.mjs";
10
- import { evaluate as uriEvaluate } from "./selectors/uri.mjs";
11
- import { resolveSchema$refField } from "../openapi-3-1/util.mjs";
12
- import { maybeRefractToJSONSchemaElement } from "./util.mjs";
13
- import UnresolvableReferenceError from "../../../errors/UnresolvableReferenceError.mjs";
14
- import MaximumDereferenceDepthError from "../../../errors/MaximumDereferenceDepthError.mjs";
15
- import MaximumResolveDepthError from "../../../errors/MaximumResolveDepthError.mjs";
16
- import * as url from "../../../util/url.mjs";
17
- import parse from "../../../parse/index.mjs";
18
- import Reference from "../../../Reference.mjs";
19
- import File from "../../../File.mjs";
20
- import { AncestorLineage } from "../../util.mjs";
21
- import EvaluationJsonSchemaUriError from "../../../errors/EvaluationJsonSchemaUriError.mjs";
22
- /**
23
- * @public
24
- */
25
- /**
26
- * @public
27
- */
28
- class Arazzo1DereferenceVisitor {
29
- indirections;
30
- reference;
31
- options;
32
-
33
- /**
34
- * Tracks element ancestors across dive-deep traversal boundaries.
35
- * Used for cycle detection: if a referenced element is found in
36
- * the ancestor lineage, a circular reference is detected.
37
- */
38
- ancestors;
39
- constructor({
40
- reference,
41
- options,
42
- indirections = [],
43
- ancestors = new AncestorLineage()
44
- }) {
45
- this.indirections = indirections;
46
- this.reference = reference;
47
- this.options = options;
48
- this.ancestors = new AncestorLineage(...ancestors);
49
- }
50
- toAncestorLineage(path) {
51
- const ancestorNodes = path.getAncestorNodes();
52
- const directAncestors = new Set(ancestorNodes.filter(isElement));
53
- const ancestorsLineage = new AncestorLineage(...this.ancestors, directAncestors);
54
- return [ancestorsLineage, directAncestors];
55
- }
56
- toBaseURI(uri) {
57
- return url.resolve(this.reference.uri, url.sanitize(url.stripHash(uri)));
58
- }
59
- async toReference(uri) {
60
- // detect maximum depth of resolution
61
- if (this.reference.depth >= this.options.resolve.maxDepth) {
62
- throw new MaximumResolveDepthError(`Maximum resolution depth of ${this.options.resolve.maxDepth} has been exceeded by file "${this.reference.uri}"`, {
63
- maxDepth: this.options.resolve.maxDepth,
64
- uri: this.reference.uri
65
- });
66
- }
67
- const baseURI = this.toBaseURI(uri);
68
- const {
69
- refSet
70
- } = this.reference;
71
-
72
- // we've already processed this Reference in past
73
- if (refSet.has(baseURI)) {
74
- return refSet.find(propEq(baseURI, 'uri'));
75
- }
76
- const parseResult = await parse(url.unsanitize(baseURI), {
77
- ...this.options,
78
- parse: {
79
- ...this.options.parse,
80
- mediaType: 'text/plain'
81
- }
82
- });
83
-
84
- // register new mutable reference with a refSet
85
- //
86
- // NOTE(known limitation): the mutable reference is mutated in place during traversal
87
- // (via `{ mutable: true }`). When an external document evaluates a JSON pointer back
88
- // into this document, it may receive an already-resolved element instead of the original
89
- // $ref. That resolved element was produced using the entry document's resolution context
90
- // (ancestors, indirections), which may differ from the external document's context.
91
- // This can affect cycle detection in rare cross-document circular reference patterns.
92
- //
93
- // Remediation: evaluate JSON pointers against the immutable (original) parse tree
94
- // instead of the mutable working copy. The `immutable://` reference below preserves
95
- // the original tree and could be used for pointer evaluation, ensuring every resolution
96
- // context always sees raw, unresolved elements and processes them with its own
97
- // ancestors/indirections. The trade-off is that elements referenced by multiple
98
- // documents would be resolved once per context instead of being reused.
99
- const mutableReference = new Reference({
100
- uri: baseURI,
101
- value: this.options.dereference.immutable ? cloneDeep(parseResult) : parseResult,
102
- depth: this.reference.depth + 1
103
- });
104
- refSet.add(mutableReference);
105
- if (this.options.dereference.immutable) {
106
- // register new immutable reference with a refSet
107
- const immutableReference = new Reference({
108
- uri: `immutable://${baseURI}`,
109
- value: parseResult,
110
- depth: this.reference.depth + 1
111
- });
112
- refSet.add(immutableReference);
113
- }
114
- return mutableReference;
115
- }
116
-
117
- /**
118
- * Handles an error according to the continueOnError option.
119
- *
120
- * For new errors: wraps in UnresolvableReferenceError with structured context
121
- * (type, uri, location, codeFrame, refFieldName, refFieldValue, trace).
122
- * For errors already wrapped by a nested visitor: prepends the current hop to the trace.
123
- *
124
- * Inner/intermediate visitors always throw to let the trace accumulate.
125
- * Only the entry document visitor respects continueOnError (callback/swallow/throw).
126
- */
127
- handleError(message, error, referencingElement, refFieldName, refFieldValue, visitorPath) {
128
- const {
129
- continueOnError
130
- } = this.options.dereference;
131
- const isEntryDocument = url.stripHash(this.reference.refSet?.rootRef?.uri ?? '') === this.reference.uri;
132
- const uri = this.reference.uri;
133
- const type = referencingElement.element;
134
- const codeFrame = toYAML(referencingElement);
135
-
136
- // find element location: tree search for entry documents, visitor path for external
137
- let location;
138
- traverse(this.reference.value.result, {
139
- enter: p => {
140
- if (p.node === referencingElement) {
141
- location = p.formatPath();
142
- p.stop();
143
- }
144
- }
145
- });
146
- location ??= visitorPath.formatPath();
147
- const hop = {
148
- uri,
149
- type,
150
- refFieldName,
151
- refFieldValue,
152
- location,
153
- codeFrame
154
- };
155
-
156
- // enrich existing error from nested visitor or create new one
157
- let unresolvedError;
158
- if (error instanceof UnresolvableReferenceError) {
159
- // prefix relative locations for entries belonging to the referenced document
160
- const refBaseURI = this.toBaseURI(refFieldValue);
161
- const fragment = URIFragmentIdentifier.fromURIReference(refFieldValue);
162
- if (fragment) {
163
- if (refBaseURI === error.uri && error.location) {
164
- error.location = fragment + error.location;
165
- }
166
- for (const h of error.trace) {
167
- if (h.uri === refBaseURI && h.location) h.location = fragment + h.location;
168
- }
169
- }
170
- // @ts-ignore
171
- error.trace = [hop, ...error.trace];
172
- unresolvedError = error;
173
- } else {
174
- unresolvedError = new UnresolvableReferenceError(message, {
175
- cause: error,
176
- type,
177
- uri,
178
- location,
179
- codeFrame,
180
- refFieldName,
181
- refFieldValue,
182
- trace: []
183
- });
184
- }
185
- if (!isEntryDocument || continueOnError === false) throw unresolvedError;
186
- if (typeof continueOnError === 'function') continueOnError(unresolvedError);
187
- }
188
- ReusableElement(path) {
189
- const referencingElement = path.node;
190
-
191
- // skip current Reusable Object if reference field is not defined as a string
192
- if (!isStringElement(referencingElement.reference)) {
193
- path.skip();
194
- return;
195
- }
196
-
197
- // ignore if resolve.internal is false (Reusable Objects are internal references only)
198
- if (!this.options.resolve.internal) {
199
- path.skip();
200
- return;
201
- }
202
- const runtimeExpression = toValue(referencingElement.reference);
203
-
204
- // parse the runtime expression
205
- const {
206
- result,
207
- tree
208
- } = parseRuntimeExpression(runtimeExpression);
209
- if (!result.success) {
210
- throw new ApiDOMStructuredError(`Invalid Reusable Object reference format: "${runtimeExpression}"`, {
211
- runtimeExpression
212
- });
213
- }
214
-
215
- // ReusableElement can only reference components
216
- if (tree.type !== 'ComponentsExpression') {
217
- throw new ApiDOMStructuredError(`Reusable Object reference "${runtimeExpression}" must be a components expression`, {
218
- runtimeExpression
219
- });
220
- }
221
-
222
- // evaluate runtime expression as JSON Pointer to get the referenced element
223
- const jsonPointer = jsonPointerCompile(['components', tree.field, tree.subField]);
224
- let referencedElement;
225
- try {
226
- referencedElement = jsonPointerEvaluate(this.reference.value.result, jsonPointer);
227
- } catch {
228
- throw new ApiDOMStructuredError(`Reusable Object reference "${runtimeExpression}" cannot be resolved`, {
229
- runtimeExpression
230
- });
231
- }
232
-
233
- /**
234
- * Create a shallow clone of the referenced element to avoid modifying the original.
235
- */
236
- const mergedElement = cloneShallow(referencedElement);
237
- // annotate with info about original referencing element
238
- mergedElement.meta.set('ref-fields', {
239
- reference: runtimeExpression,
240
- value: toValue(referencingElement.value)
241
- });
242
- // annotate with info about origin
243
- mergedElement.meta.set('ref-origin', this.reference.uri);
244
- mergedElement.meta.set('ref-type', referencingElement.element);
245
-
246
- // override value field if present for Parameter Objects
247
- if (isParameterElement(mergedElement) && referencingElement.hasKey('value')) {
248
- mergedElement.remove('value');
249
- mergedElement.set('value', referencingElement.get('value'));
250
- }
251
-
252
- /**
253
- * Transclude referencing element with merged referenced element.
254
- */
255
- path.replaceWith(mergedElement);
256
- }
257
- async JSONSchemaElement(path) {
258
- const referencingElement = path.node;
259
-
260
- // skip current referencing schema as $ref keyword was not defined
261
- if (!isStringElement(referencingElement.$ref)) {
262
- return;
263
- }
264
-
265
- // skip current referencing element as it's already been accessed
266
- if (this.indirections.includes(referencingElement)) {
267
- path.skip();
268
- return;
269
- }
270
- const indirectionsSize = this.indirections.length;
271
- try {
272
- // compute baseURI using rules around $id and $ref keywords
273
- let reference = await this.toReference(url.unsanitize(this.reference.uri));
274
- let {
275
- uri: retrievalURI
276
- } = reference;
277
- const $refBaseURI = resolveSchema$refField(retrievalURI, referencingElement);
278
- const $refBaseURIStrippedHash = url.stripHash($refBaseURI);
279
- const file = new File({
280
- uri: $refBaseURIStrippedHash
281
- });
282
- const isUnknownURI = none(r => r.canRead(file), this.options.resolve.resolvers);
283
- const isURL = !isUnknownURI;
284
- let isInternalReference = url.stripHash(this.reference.uri) === $refBaseURI;
285
- let isExternalReference = !isInternalReference;
286
-
287
- // determining reference, proper evaluation and selection mechanism
288
- let referencedElement;
289
- try {
290
- if (isUnknownURI || isURL) {
291
- // we're dealing with canonical URI or URL with possible fragment
292
- retrievalURI = this.toBaseURI($refBaseURI);
293
- const selector = $refBaseURI;
294
- const referenceAsSchema = maybeRefractToJSONSchemaElement(reference.value.result);
295
- referencedElement = uriEvaluate(selector, referenceAsSchema);
296
- referencedElement = maybeRefractToJSONSchemaElement(referencedElement);
297
-
298
- // ignore resolving internal Schema Objects
299
- if (!this.options.resolve.internal && isInternalReference) {
300
- // skip traversing this schema element but traverse all its child elements
301
- return;
302
- }
303
- // ignore resolving external Schema Objects
304
- if (!this.options.resolve.external && isExternalReference) {
305
- // skip traversing this schema element but traverse all its child elements
306
- return;
307
- }
308
- } else {
309
- // we're assuming here that we're dealing with JSON Pointer here
310
- retrievalURI = this.toBaseURI($refBaseURI);
311
- isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
312
- isExternalReference = !isInternalReference;
313
-
314
- // ignore resolving internal Schema Objects
315
- if (!this.options.resolve.internal && isInternalReference) {
316
- // skip traversing this schema element but traverse all its child elements
317
- return;
318
- }
319
- // ignore resolving external Schema Objects
320
- if (!this.options.resolve.external && isExternalReference) {
321
- // skip traversing this schema element but traverse all its child elements
322
- return;
323
- }
324
- reference = await this.toReference(url.unsanitize($refBaseURI));
325
- const selector = URIFragmentIdentifier.fromURIReference($refBaseURI);
326
- const referenceAsSchema = maybeRefractToJSONSchemaElement(reference.value.result);
327
- referencedElement = jsonPointerEvaluate(referenceAsSchema, selector);
328
- referencedElement = maybeRefractToJSONSchemaElement(referencedElement);
329
- }
330
- } catch (error) {
331
- /**
332
- * JSONSchemaElement($id=URL) was not found, so we're going to try to resolve
333
- * the URL and assume the returned response is a JSON Schema.
334
- */
335
- if (isURL && error instanceof EvaluationJsonSchemaUriError) {
336
- if (isAnchor(uriToAnchor($refBaseURI))) {
337
- // we're dealing with JSON Schema $anchor here
338
- isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
339
- isExternalReference = !isInternalReference;
340
-
341
- // ignore resolving internal Schema Objects
342
- if (!this.options.resolve.internal && isInternalReference) {
343
- // skip traversing this schema element but traverse all its child elements
344
- return;
345
- }
346
- // ignore resolving external Schema Objects
347
- if (!this.options.resolve.external && isExternalReference) {
348
- // skip traversing this schema element but traverse all its child elements
349
- return;
350
- }
351
- reference = await this.toReference(url.unsanitize($refBaseURI));
352
- const selector = uriToAnchor($refBaseURI);
353
- const referenceAsSchema = maybeRefractToJSONSchemaElement(reference.value.result);
354
- referencedElement = $anchorEvaluate(selector, referenceAsSchema);
355
- referencedElement = maybeRefractToJSONSchemaElement(referencedElement);
356
- } else {
357
- // we're assuming here that we're dealing with JSON Pointer here
358
- retrievalURI = this.toBaseURI($refBaseURI);
359
- isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
360
- isExternalReference = !isInternalReference;
361
-
362
- // ignore resolving internal Schema Objects
363
- if (!this.options.resolve.internal && isInternalReference) {
364
- // skip traversing this schema element but traverse all its child elements
365
- return;
366
- }
367
- // ignore resolving external Schema Objects
368
- if (!this.options.resolve.external && isExternalReference) {
369
- // skip traversing this schema element but traverse all its child elements
370
- return;
371
- }
372
- reference = await this.toReference(url.unsanitize($refBaseURI));
373
- const selector = URIFragmentIdentifier.fromURIReference($refBaseURI);
374
- const referenceAsSchema = maybeRefractToJSONSchemaElement(reference.value.result);
375
- referencedElement = jsonPointerEvaluate(referenceAsSchema, selector);
376
- referencedElement = maybeRefractToJSONSchemaElement(referencedElement);
377
- }
378
- } else {
379
- throw error;
380
- }
381
- }
382
- this.indirections.push(referencingElement);
383
-
384
- // detect direct or indirect reference
385
- if (referencingElement === referencedElement) {
386
- throw new ApiDOMStructuredError('Recursive JSON Schema reference detected', {
387
- $ref: toValue(referencingElement.$ref)
388
- });
389
- }
390
-
391
- // detect maximum depth of dereferencing
392
- if (this.indirections.length > this.options.dereference.maxDepth) {
393
- throw new MaximumDereferenceDepthError(`Maximum dereference depth of "${this.options.dereference.maxDepth}" has been exceeded in file "${this.reference.uri}"`, {
394
- maxDepth: this.options.dereference.maxDepth,
395
- uri: this.reference.uri
396
- });
397
- }
398
-
399
- // detect cross-boundary cycle
400
- const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
401
- if (ancestorsLineage.includes(referencedElement)) {
402
- reference.refSet.circular = true;
403
- if (this.options.dereference.circular === 'error') {
404
- throw new ApiDOMStructuredError('Circular reference detected', {
405
- $ref: toValue(referencingElement.$ref)
406
- });
407
- } else if (this.options.dereference.circular === 'replace') {
408
- const refElement = new RefElement($refBaseURI, {
409
- type: referencingElement.element,
410
- uri: reference.uri,
411
- $ref: toValue(referencingElement.$ref)
412
- });
413
- const replacer = this.options.dereference.strategyOpts['arazzo-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
414
- const replacement = replacer(refElement);
415
- path.replaceWith(replacement);
416
- return;
417
- }
418
- }
419
-
420
- /**
421
- * Dive deep into the fragment.
422
- *
423
- * Cases to consider:
424
- * 1. We're crossing document boundary
425
- * 2. Fragment is from non-entry document
426
- * 3. Fragment is a JSON Schema with $ref field. We need to follow it to get the eventual value
427
- * 4. We are dereferencing the fragment lazily/eagerly depending on circular mode
428
- */
429
- const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
430
- const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
431
- if ((isExternalReference || isNonEntryDocument || isJSONSchemaElement(referencedElement) && isStringElement(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
432
- // append referencing reference to ancestors lineage
433
- directAncestors.add(referencingElement);
434
- const visitor = new Arazzo1DereferenceVisitor({
435
- reference,
436
- indirections: [...this.indirections],
437
- options: this.options,
438
- ancestors: ancestorsLineage
439
- });
440
- referencedElement = await traverseAsync(referencedElement, visitor, {
441
- mutable: true
442
- });
443
-
444
- // remove referencing reference from ancestors lineage
445
- directAncestors.delete(referencingElement);
446
- }
447
-
448
- // Boolean JSON Schemas
449
- if (isBooleanJSONSchemaElement(referencedElement)) {
450
- const booleanJsonSchemaElement = cloneDeep(referencedElement);
451
- // annotate referenced element with info about original referencing element
452
- booleanJsonSchemaElement.meta.set('ref-fields', {
453
- $ref: toValue(referencingElement.$ref)
454
- });
455
- // annotate referenced element with info about origin
456
- booleanJsonSchemaElement.meta.set('ref-origin', reference.uri);
457
- booleanJsonSchemaElement.meta.set('ref-type', referencingElement.element);
458
- path.replaceWith(booleanJsonSchemaElement);
459
- return;
460
- }
461
-
462
- /**
463
- * Creating a new version of JSON Schema by merging fields from referenced Schema with referencing one.
464
- */
465
- if (isJSONSchemaElement(referencedElement)) {
466
- const mergedElement = cloneShallow(referencedElement);
467
- // existing keywords from referencing schema overrides ones from referenced schema
468
- referencingElement.forEach((value, keyElement, item) => {
469
- mergedElement.remove(toValue(keyElement));
470
- mergedElement.content.push(item);
471
- });
472
- mergedElement.remove('$ref');
473
- // annotate referenced element with info about original referencing element
474
- mergedElement.meta.set('ref-fields', {
475
- $ref: toValue(referencingElement.$ref)
476
- });
477
- // annotate fragment with info about origin
478
- mergedElement.meta.set('ref-origin', reference.uri);
479
- mergedElement.meta.set('ref-type', referencingElement.element);
480
- referencedElement = mergedElement;
481
- }
482
- /**
483
- * Transclude referencing element with merged referenced element.
484
- */
485
- path.replaceWith(referencedElement);
486
- } catch (error) {
487
- const $ref = toValue(referencingElement.$ref);
488
- this.handleError(`Error while dereferencing Schema Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
489
- } finally {
490
- if (this.indirections.length > indirectionsSize) this.indirections.pop();
491
- }
492
- }
493
- }
494
- export default Arazzo1DereferenceVisitor;
@@ -1,94 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
4
- exports.__esModule = true;
5
- exports.default = void 0;
6
- var _apidomDatamodel = require("@speclynx/apidom-datamodel");
7
- var _apidomTraverse = require("@speclynx/apidom-traverse");
8
- var _apidomNsAsyncapi = require("@speclynx/apidom-ns-asyncapi-2");
9
- var _DereferenceStrategy = _interopRequireDefault(require("../DereferenceStrategy.cjs"));
10
- var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
11
- var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
12
- var _visitor = _interopRequireDefault(require("./visitor.cjs"));
13
- exports.AsyncAPI2DereferenceVisitor = _visitor.default;
14
- /**
15
- * @public
16
- */
17
-
18
- /**
19
- * @public
20
- */
21
- class AsyncAPI2DereferenceStrategy extends _DereferenceStrategy.default {
22
- constructor(options) {
23
- super({
24
- ...(options ?? {}),
25
- name: 'asyncapi-2'
26
- });
27
- }
28
- canDereference(file) {
29
- // assert by media type
30
- if (file.mediaType !== 'text/plain') {
31
- return _apidomNsAsyncapi.mediaTypes.includes(file.mediaType);
32
- }
33
-
34
- // assert by inspecting ApiDOM
35
- return (0, _apidomNsAsyncapi.isAsyncApi2Element)(file.parseResult?.result);
36
- }
37
- async dereference(file, options) {
38
- const immutableRefSet = options.dereference.refSet ?? new _ReferenceSet.default();
39
- const mutableRefSet = new _ReferenceSet.default();
40
- let refSet = immutableRefSet;
41
- let reference;
42
- if (!immutableRefSet.has(file.uri)) {
43
- reference = new _Reference.default({
44
- uri: file.uri,
45
- value: file.parseResult
46
- });
47
- immutableRefSet.add(reference);
48
- } else {
49
- // pre-computed refSet was provided as configuration option
50
- reference = immutableRefSet.find(ref => ref.uri === file.uri);
51
- }
52
-
53
- /**
54
- * Clone refSet due the dereferencing process being mutable.
55
- * We don't want to mutate the original refSet and the references.
56
- */
57
- if (options.dereference.immutable) {
58
- immutableRefSet.refs.map(ref => new _Reference.default({
59
- ...ref,
60
- value: (0, _apidomDatamodel.cloneDeep)(ref.value)
61
- })).forEach(ref => mutableRefSet.add(ref));
62
- reference = mutableRefSet.find(ref => ref.uri === file.uri);
63
- refSet = mutableRefSet;
64
- }
65
- const visitor = new _visitor.default({
66
- reference,
67
- options
68
- });
69
- const dereferencedElement = await (0, _apidomTraverse.traverseAsync)(refSet.rootRef.value, visitor, {
70
- mutable: true
71
- });
72
-
73
- /**
74
- * If immutable option is set, replay refs from the refSet.
75
- */
76
- if (options.dereference.immutable) {
77
- mutableRefSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => new _Reference.default({
78
- ...ref,
79
- uri: ref.uri.replace(/^immutable:\/\//, '')
80
- })).forEach(ref => immutableRefSet.add(ref));
81
- }
82
-
83
- /**
84
- * Release all memory if this refSet was not provided as a configuration option.
85
- * If provided as configuration option, then provider is responsible for cleanup.
86
- */
87
- if (options.dereference.refSet === null) {
88
- immutableRefSet.clean();
89
- }
90
- mutableRefSet.clean();
91
- return dereferencedElement;
92
- }
93
- }
94
- var _default = exports.default = AsyncAPI2DereferenceStrategy;
@@ -1,88 +0,0 @@
1
- import { cloneDeep } from '@speclynx/apidom-datamodel';
2
- import { traverseAsync } from '@speclynx/apidom-traverse';
3
- import { isAsyncApi2Element, mediaTypes } from '@speclynx/apidom-ns-asyncapi-2';
4
- import DereferenceStrategy from "../DereferenceStrategy.mjs";
5
- import Reference from "../../../Reference.mjs";
6
- import ReferenceSet from "../../../ReferenceSet.mjs";
7
- import AsyncAPI2DereferenceVisitor from "./visitor.mjs";
8
- /**
9
- * @public
10
- */
11
- /**
12
- * @public
13
- */
14
- class AsyncAPI2DereferenceStrategy extends DereferenceStrategy {
15
- constructor(options) {
16
- super({
17
- ...(options ?? {}),
18
- name: 'asyncapi-2'
19
- });
20
- }
21
- canDereference(file) {
22
- // assert by media type
23
- if (file.mediaType !== 'text/plain') {
24
- return mediaTypes.includes(file.mediaType);
25
- }
26
-
27
- // assert by inspecting ApiDOM
28
- return isAsyncApi2Element(file.parseResult?.result);
29
- }
30
- async dereference(file, options) {
31
- const immutableRefSet = options.dereference.refSet ?? new ReferenceSet();
32
- const mutableRefSet = new ReferenceSet();
33
- let refSet = immutableRefSet;
34
- let reference;
35
- if (!immutableRefSet.has(file.uri)) {
36
- reference = new Reference({
37
- uri: file.uri,
38
- value: file.parseResult
39
- });
40
- immutableRefSet.add(reference);
41
- } else {
42
- // pre-computed refSet was provided as configuration option
43
- reference = immutableRefSet.find(ref => ref.uri === file.uri);
44
- }
45
-
46
- /**
47
- * Clone refSet due the dereferencing process being mutable.
48
- * We don't want to mutate the original refSet and the references.
49
- */
50
- if (options.dereference.immutable) {
51
- immutableRefSet.refs.map(ref => new Reference({
52
- ...ref,
53
- value: cloneDeep(ref.value)
54
- })).forEach(ref => mutableRefSet.add(ref));
55
- reference = mutableRefSet.find(ref => ref.uri === file.uri);
56
- refSet = mutableRefSet;
57
- }
58
- const visitor = new AsyncAPI2DereferenceVisitor({
59
- reference,
60
- options
61
- });
62
- const dereferencedElement = await traverseAsync(refSet.rootRef.value, visitor, {
63
- mutable: true
64
- });
65
-
66
- /**
67
- * If immutable option is set, replay refs from the refSet.
68
- */
69
- if (options.dereference.immutable) {
70
- mutableRefSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => new Reference({
71
- ...ref,
72
- uri: ref.uri.replace(/^immutable:\/\//, '')
73
- })).forEach(ref => immutableRefSet.add(ref));
74
- }
75
-
76
- /**
77
- * Release all memory if this refSet was not provided as a configuration option.
78
- * If provided as configuration option, then provider is responsible for cleanup.
79
- */
80
- if (options.dereference.refSet === null) {
81
- immutableRefSet.clean();
82
- }
83
- mutableRefSet.clean();
84
- return dereferencedElement;
85
- }
86
- }
87
- export { AsyncAPI2DereferenceVisitor };
88
- export default AsyncAPI2DereferenceStrategy;