@speclynx/apidom-reference 4.0.2 → 4.0.4

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 (186) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/apidom-reference.browser.js +15 -15
  3. package/dist/apidom-reference.browser.min.js +1 -1
  4. package/package.json +25 -25
  5. package/src/File.cjs +50 -0
  6. package/src/File.mjs +44 -0
  7. package/src/Reference.cjs +31 -0
  8. package/src/Reference.mjs +27 -0
  9. package/src/ReferenceSet.cjs +60 -0
  10. package/src/ReferenceSet.mjs +57 -0
  11. package/src/bundle/index.cjs +61 -0
  12. package/src/bundle/index.mjs +55 -0
  13. package/src/bundle/strategies/BundleStrategy.cjs +20 -0
  14. package/src/bundle/strategies/BundleStrategy.mjs +16 -0
  15. package/src/bundle/strategies/openapi-3-1/index.cjs +35 -0
  16. package/src/bundle/strategies/openapi-3-1/index.mjs +29 -0
  17. package/src/configuration/empty.cjs +9 -0
  18. package/src/configuration/empty.mjs +1 -0
  19. package/src/configuration/saturated.cjs +88 -0
  20. package/src/configuration/saturated.mjs +80 -0
  21. package/src/dereference/index.cjs +90 -0
  22. package/src/dereference/index.mjs +83 -0
  23. package/src/dereference/strategies/DereferenceStrategy.cjs +20 -0
  24. package/src/dereference/strategies/DereferenceStrategy.mjs +16 -0
  25. package/src/dereference/strategies/apidom/index.cjs +89 -0
  26. package/src/dereference/strategies/apidom/index.mjs +83 -0
  27. package/src/dereference/strategies/apidom/selectors/element-id.cjs +47 -0
  28. package/src/dereference/strategies/apidom/selectors/element-id.mjs +41 -0
  29. package/src/dereference/strategies/apidom/visitor.cjs +266 -0
  30. package/src/dereference/strategies/apidom/visitor.mjs +259 -0
  31. package/src/dereference/strategies/arazzo-1/index.cjs +109 -0
  32. package/src/dereference/strategies/arazzo-1/index.mjs +100 -0
  33. package/src/dereference/strategies/arazzo-1/selectors/$anchor.cjs +12 -0
  34. package/src/dereference/strategies/arazzo-1/selectors/$anchor.mjs +1 -0
  35. package/src/dereference/strategies/arazzo-1/selectors/uri.cjs +8 -0
  36. package/src/dereference/strategies/arazzo-1/selectors/uri.mjs +1 -0
  37. package/src/dereference/strategies/arazzo-1/source-descriptions.cjs +248 -0
  38. package/src/dereference/strategies/arazzo-1/source-descriptions.mjs +243 -0
  39. package/src/dereference/strategies/arazzo-1/util.cjs +37 -0
  40. package/src/dereference/strategies/arazzo-1/util.mjs +29 -0
  41. package/src/dereference/strategies/arazzo-1/visitor.cjs +507 -0
  42. package/src/dereference/strategies/arazzo-1/visitor.mjs +500 -0
  43. package/src/dereference/strategies/asyncapi-2/index.cjs +94 -0
  44. package/src/dereference/strategies/asyncapi-2/index.mjs +88 -0
  45. package/src/dereference/strategies/asyncapi-2/visitor.cjs +501 -0
  46. package/src/dereference/strategies/asyncapi-2/visitor.mjs +494 -0
  47. package/src/dereference/strategies/openapi-2/index.cjs +96 -0
  48. package/src/dereference/strategies/openapi-2/index.mjs +90 -0
  49. package/src/dereference/strategies/openapi-2/visitor.cjs +629 -0
  50. package/src/dereference/strategies/openapi-2/visitor.mjs +622 -0
  51. package/src/dereference/strategies/openapi-3-0/index.cjs +96 -0
  52. package/src/dereference/strategies/openapi-3-0/index.mjs +90 -0
  53. package/src/dereference/strategies/openapi-3-0/visitor.cjs +622 -0
  54. package/src/dereference/strategies/openapi-3-0/visitor.mjs +615 -0
  55. package/src/dereference/strategies/openapi-3-1/index.cjs +99 -0
  56. package/src/dereference/strategies/openapi-3-1/index.mjs +90 -0
  57. package/src/dereference/strategies/openapi-3-1/selectors/$anchor.cjs +65 -0
  58. package/src/dereference/strategies/openapi-3-1/selectors/$anchor.mjs +54 -0
  59. package/src/dereference/strategies/openapi-3-1/selectors/uri.cjs +50 -0
  60. package/src/dereference/strategies/openapi-3-1/selectors/uri.mjs +42 -0
  61. package/src/dereference/strategies/openapi-3-1/util.cjs +68 -0
  62. package/src/dereference/strategies/openapi-3-1/util.mjs +59 -0
  63. package/src/dereference/strategies/openapi-3-1/visitor.cjs +874 -0
  64. package/src/dereference/strategies/openapi-3-1/visitor.mjs +867 -0
  65. package/src/dereference/util.cjs +31 -0
  66. package/src/dereference/util.mjs +27 -0
  67. package/src/errors/BundleError.cjs +10 -0
  68. package/src/errors/BundleError.mjs +7 -0
  69. package/src/errors/DereferenceError.cjs +10 -0
  70. package/src/errors/DereferenceError.mjs +7 -0
  71. package/src/errors/EvaluationElementIdError.cjs +10 -0
  72. package/src/errors/EvaluationElementIdError.mjs +7 -0
  73. package/src/errors/EvaluationJsonSchema$anchorError.cjs +11 -0
  74. package/src/errors/EvaluationJsonSchema$anchorError.mjs +6 -0
  75. package/src/errors/EvaluationJsonSchemaUriError.cjs +11 -0
  76. package/src/errors/EvaluationJsonSchemaUriError.mjs +6 -0
  77. package/src/errors/InvalidJsonSchema$anchorError.cjs +15 -0
  78. package/src/errors/InvalidJsonSchema$anchorError.mjs +10 -0
  79. package/src/errors/JsonSchema$anchorError.cjs +10 -0
  80. package/src/errors/JsonSchema$anchorError.mjs +7 -0
  81. package/src/errors/JsonSchemaUriError.cjs +10 -0
  82. package/src/errors/JsonSchemaUriError.mjs +7 -0
  83. package/src/errors/MaximumBundleDepthError.cjs +11 -0
  84. package/src/errors/MaximumBundleDepthError.mjs +6 -0
  85. package/src/errors/MaximumDereferenceDepthError.cjs +11 -0
  86. package/src/errors/MaximumDereferenceDepthError.mjs +6 -0
  87. package/src/errors/MaximumResolveDepthError.cjs +11 -0
  88. package/src/errors/MaximumResolveDepthError.mjs +6 -0
  89. package/src/errors/ParseError.cjs +10 -0
  90. package/src/errors/ParseError.mjs +7 -0
  91. package/src/errors/ParserError.cjs +11 -0
  92. package/src/errors/ParserError.mjs +6 -0
  93. package/src/errors/PluginError.cjs +18 -0
  94. package/src/errors/PluginError.mjs +15 -0
  95. package/src/errors/ResolveError.cjs +10 -0
  96. package/src/errors/ResolveError.mjs +7 -0
  97. package/src/errors/ResolverError.cjs +11 -0
  98. package/src/errors/ResolverError.mjs +6 -0
  99. package/src/errors/UnmatchedBundleStrategyError.cjs +11 -0
  100. package/src/errors/UnmatchedBundleStrategyError.mjs +6 -0
  101. package/src/errors/UnmatchedDereferenceStrategyError.cjs +11 -0
  102. package/src/errors/UnmatchedDereferenceStrategyError.mjs +6 -0
  103. package/src/errors/UnmatchedParserError.cjs +11 -0
  104. package/src/errors/UnmatchedParserError.mjs +6 -0
  105. package/src/errors/UnmatchedResolveStrategyError.cjs +11 -0
  106. package/src/errors/UnmatchedResolveStrategyError.mjs +6 -0
  107. package/src/errors/UnmatchedResolverError.cjs +11 -0
  108. package/src/errors/UnmatchedResolverError.mjs +6 -0
  109. package/src/errors/UnresolvableReferenceError.cjs +11 -0
  110. package/src/errors/UnresolvableReferenceError.mjs +6 -0
  111. package/src/index.cjs +146 -0
  112. package/src/index.mjs +103 -0
  113. package/src/options/index.cjs +194 -0
  114. package/src/options/index.mjs +191 -0
  115. package/src/options/util.cjs +24 -0
  116. package/src/options/util.mjs +19 -0
  117. package/src/parse/index.cjs +69 -0
  118. package/src/parse/index.mjs +63 -0
  119. package/src/parse/parsers/Parser.cjs +62 -0
  120. package/src/parse/parsers/Parser.mjs +58 -0
  121. package/src/parse/parsers/apidom-json/index.cjs +70 -0
  122. package/src/parse/parsers/apidom-json/index.mjs +64 -0
  123. package/src/parse/parsers/arazzo-json-1/index.cjs +62 -0
  124. package/src/parse/parsers/arazzo-json-1/index.mjs +56 -0
  125. package/src/parse/parsers/arazzo-json-1/source-descriptions.cjs +221 -0
  126. package/src/parse/parsers/arazzo-json-1/source-descriptions.mjs +214 -0
  127. package/src/parse/parsers/arazzo-yaml-1/index.cjs +62 -0
  128. package/src/parse/parsers/arazzo-yaml-1/index.mjs +56 -0
  129. package/src/parse/parsers/arazzo-yaml-1/source-descriptions.cjs +12 -0
  130. package/src/parse/parsers/arazzo-yaml-1/source-descriptions.mjs +7 -0
  131. package/src/parse/parsers/asyncapi-json-2/index.cjs +54 -0
  132. package/src/parse/parsers/asyncapi-json-2/index.mjs +48 -0
  133. package/src/parse/parsers/asyncapi-yaml-2/index.cjs +54 -0
  134. package/src/parse/parsers/asyncapi-yaml-2/index.mjs +48 -0
  135. package/src/parse/parsers/binary/index-browser.cjs +56 -0
  136. package/src/parse/parsers/binary/index-browser.mjs +50 -0
  137. package/src/parse/parsers/binary/index-node.cjs +51 -0
  138. package/src/parse/parsers/binary/index-node.mjs +45 -0
  139. package/src/parse/parsers/json/index.cjs +53 -0
  140. package/src/parse/parsers/json/index.mjs +47 -0
  141. package/src/parse/parsers/openapi-json-2/index.cjs +54 -0
  142. package/src/parse/parsers/openapi-json-2/index.mjs +48 -0
  143. package/src/parse/parsers/openapi-json-3-0/index.cjs +54 -0
  144. package/src/parse/parsers/openapi-json-3-0/index.mjs +48 -0
  145. package/src/parse/parsers/openapi-json-3-1/index.cjs +54 -0
  146. package/src/parse/parsers/openapi-json-3-1/index.mjs +48 -0
  147. package/src/parse/parsers/openapi-yaml-2/index.cjs +54 -0
  148. package/src/parse/parsers/openapi-yaml-2/index.mjs +48 -0
  149. package/src/parse/parsers/openapi-yaml-3-0/index.cjs +54 -0
  150. package/src/parse/parsers/openapi-yaml-3-0/index.mjs +48 -0
  151. package/src/parse/parsers/openapi-yaml-3-1/index.cjs +54 -0
  152. package/src/parse/parsers/openapi-yaml-3-1/index.mjs +48 -0
  153. package/src/parse/parsers/yaml-1-2/index.cjs +56 -0
  154. package/src/parse/parsers/yaml-1-2/index.mjs +50 -0
  155. package/src/resolve/index.cjs +67 -0
  156. package/src/resolve/index.mjs +60 -0
  157. package/src/resolve/resolvers/HTTPResolver.cjs +45 -0
  158. package/src/resolve/resolvers/HTTPResolver.mjs +37 -0
  159. package/src/resolve/resolvers/Resolver.cjs +20 -0
  160. package/src/resolve/resolvers/Resolver.mjs +16 -0
  161. package/src/resolve/resolvers/file/index-browser.cjs +24 -0
  162. package/src/resolve/resolvers/file/index-browser.mjs +19 -0
  163. package/src/resolve/resolvers/file/index-node.cjs +49 -0
  164. package/src/resolve/resolvers/file/index-node.mjs +42 -0
  165. package/src/resolve/resolvers/http-axios/cache/MemoryCache.cjs +41 -0
  166. package/src/resolve/resolvers/http-axios/cache/MemoryCache.mjs +37 -0
  167. package/src/resolve/resolvers/http-axios/index.cjs +113 -0
  168. package/src/resolve/resolvers/http-axios/index.mjs +105 -0
  169. package/src/resolve/strategies/ResolveStrategy.cjs +20 -0
  170. package/src/resolve/strategies/ResolveStrategy.mjs +16 -0
  171. package/src/resolve/strategies/apidom/index.cjs +49 -0
  172. package/src/resolve/strategies/apidom/index.mjs +43 -0
  173. package/src/resolve/strategies/asyncapi-2/index.cjs +49 -0
  174. package/src/resolve/strategies/asyncapi-2/index.mjs +43 -0
  175. package/src/resolve/strategies/openapi-2/index.cjs +49 -0
  176. package/src/resolve/strategies/openapi-2/index.mjs +43 -0
  177. package/src/resolve/strategies/openapi-3-0/index.cjs +49 -0
  178. package/src/resolve/strategies/openapi-3-0/index.mjs +43 -0
  179. package/src/resolve/strategies/openapi-3-1/index.cjs +49 -0
  180. package/src/resolve/strategies/openapi-3-1/index.mjs +43 -0
  181. package/src/resolve/util.cjs +37 -0
  182. package/src/resolve/util.mjs +30 -0
  183. package/src/util/plugins.cjs +39 -0
  184. package/src/util/plugins.mjs +34 -0
  185. package/src/util/url.cjs +288 -0
  186. package/src/util/url.mjs +274 -0
@@ -0,0 +1,622 @@
1
+ import { propEq } from 'ramda';
2
+ import { RefElement, isStringElement, isElement, 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, URIFragmentIdentifier } from '@speclynx/apidom-json-pointer';
7
+ import { isReferenceElement, isJSONReferenceElement, isPathItemElement, isReferenceLikeElement, isJSONReferenceLikeElement, refract, refractReference, refractPathItem, refractJSONReference } from '@speclynx/apidom-ns-openapi-2';
8
+ import UnresolvableReferenceError from "../../../errors/UnresolvableReferenceError.mjs";
9
+ import MaximumDereferenceDepthError from "../../../errors/MaximumDereferenceDepthError.mjs";
10
+ import MaximumResolveDepthError from "../../../errors/MaximumResolveDepthError.mjs";
11
+ import { AncestorLineage } from "../../util.mjs";
12
+ import * as url from "../../../util/url.mjs";
13
+ import parse from "../../../parse/index.mjs";
14
+ import Reference from "../../../Reference.mjs";
15
+ /**
16
+ * @public
17
+ */
18
+ /**
19
+ * @public
20
+ */
21
+ class OpenAPI2DereferenceVisitor {
22
+ indirections;
23
+ reference;
24
+ options;
25
+ refractCache;
26
+
27
+ /**
28
+ * Tracks element ancestors across dive-deep traversal boundaries.
29
+ * Used for cycle detection: if a referenced element is found in
30
+ * the ancestor lineage, a circular reference is detected.
31
+ */
32
+ ancestors;
33
+ constructor({
34
+ reference,
35
+ options,
36
+ indirections = [],
37
+ ancestors = new AncestorLineage(),
38
+ refractCache = new WeakMap()
39
+ }) {
40
+ this.indirections = indirections;
41
+ this.reference = reference;
42
+ this.options = options;
43
+ this.refractCache = refractCache;
44
+ this.ancestors = new AncestorLineage(...ancestors);
45
+ }
46
+ toAncestorLineage(path) {
47
+ const ancestorNodes = path.getAncestorNodes();
48
+ const directAncestors = new Set(ancestorNodes.filter(isElement));
49
+ const ancestorsLineage = new AncestorLineage(...this.ancestors, directAncestors);
50
+ return [ancestorsLineage, directAncestors];
51
+ }
52
+ toBaseURI(uri) {
53
+ return url.resolve(this.reference.uri, url.sanitize(url.stripHash(uri)));
54
+ }
55
+ async toReference(uri) {
56
+ // detect maximum depth of resolution
57
+ if (this.reference.depth >= this.options.resolve.maxDepth) {
58
+ throw new MaximumResolveDepthError(`Maximum resolution depth of ${this.options.resolve.maxDepth} has been exceeded by file "${this.reference.uri}"`, {
59
+ maxDepth: this.options.resolve.maxDepth,
60
+ uri: this.reference.uri
61
+ });
62
+ }
63
+ const baseURI = this.toBaseURI(uri);
64
+ const {
65
+ refSet
66
+ } = this.reference;
67
+
68
+ // we've already processed this Reference in past
69
+ if (refSet.has(baseURI)) {
70
+ return refSet.find(propEq(baseURI, 'uri'));
71
+ }
72
+ const parseResult = await parse(url.unsanitize(baseURI), {
73
+ ...this.options,
74
+ parse: {
75
+ ...this.options.parse,
76
+ mediaType: 'text/plain'
77
+ }
78
+ });
79
+
80
+ // register new mutable reference with a refSet
81
+ //
82
+ // NOTE(known limitation): the mutable reference is mutated in place during traversal
83
+ // (via `{ mutable: true }`). When an external document evaluates a JSON pointer back
84
+ // into this document, it may receive an already-resolved element instead of the original
85
+ // $ref. That resolved element was produced using the entry document's resolution context
86
+ // (ancestors, indirections), which may differ from the external document's context.
87
+ // This can affect cycle detection in rare cross-document circular reference patterns.
88
+ //
89
+ // Remediation: evaluate JSON pointers against the immutable (original) parse tree
90
+ // instead of the mutable working copy. The `immutable://` reference below preserves
91
+ // the original tree and could be used for pointer evaluation, ensuring every resolution
92
+ // context always sees raw, unresolved elements and processes them with its own
93
+ // ancestors/indirections. The trade-off is that elements referenced by multiple
94
+ // documents would be resolved once per context instead of being reused.
95
+ const mutableReference = new Reference({
96
+ uri: baseURI,
97
+ value: this.options.dereference.immutable ? cloneDeep(parseResult) : parseResult,
98
+ depth: this.reference.depth + 1
99
+ });
100
+ refSet.add(mutableReference);
101
+ if (this.options.dereference.immutable) {
102
+ // register new immutable reference with a refSet
103
+ const immutableReference = new Reference({
104
+ uri: `immutable://${baseURI}`,
105
+ value: parseResult,
106
+ depth: this.reference.depth + 1
107
+ });
108
+ refSet.add(immutableReference);
109
+ }
110
+ return mutableReference;
111
+ }
112
+
113
+ /**
114
+ * Handles an error according to the continueOnError option.
115
+ *
116
+ * For new errors: wraps in UnresolvableReferenceError with structured context
117
+ * (type, uri, location, codeFrame, refFieldName, refFieldValue, trace).
118
+ * For errors already wrapped by a nested visitor: prepends the current hop to the trace.
119
+ *
120
+ * Inner/intermediate visitors always throw to let the trace accumulate.
121
+ * Only the entry document visitor respects continueOnError (callback/swallow/throw).
122
+ */
123
+ handleError(message, error, referencingElement, refFieldName, refFieldValue, visitorPath) {
124
+ const {
125
+ continueOnError
126
+ } = this.options.dereference;
127
+ const isEntryDocument = url.stripHash(this.reference.refSet?.rootRef?.uri ?? '') === this.reference.uri;
128
+ const uri = this.reference.uri;
129
+ const type = referencingElement.element;
130
+ const codeFrame = toYAML(referencingElement);
131
+
132
+ // find element location by identity in the document tree.
133
+ // guarded: this.reference.value may not be a ParseResultElement or may lack a result.
134
+ // falls back to visitorPath which may produce an incomplete path when
135
+ // dereferenceApiDOM is called with a fragment (cloneShallow creates a new root identity).
136
+ let location;
137
+ const root = this.reference.value.result;
138
+ if (isElement(root)) {
139
+ traverse(root, {
140
+ enter: p => {
141
+ if (p.node === referencingElement || this.refractCache.get(p.node) === referencingElement) {
142
+ location = p.formatPath();
143
+ p.stop();
144
+ }
145
+ }
146
+ });
147
+ }
148
+ location ??= visitorPath.formatPath();
149
+ const hop = {
150
+ uri,
151
+ type,
152
+ refFieldName,
153
+ refFieldValue,
154
+ location,
155
+ codeFrame
156
+ };
157
+
158
+ // enrich existing error from nested visitor or create new one
159
+ let unresolvedError;
160
+ if (error instanceof UnresolvableReferenceError) {
161
+ // prefix relative locations for entries belonging to the referenced document
162
+ const refBaseURI = this.toBaseURI(refFieldValue);
163
+ const fragment = URIFragmentIdentifier.fromURIReference(refFieldValue);
164
+ if (fragment) {
165
+ if (refBaseURI === error.uri && error.location) {
166
+ error.location = fragment + error.location;
167
+ }
168
+ for (const h of error.trace) {
169
+ if (h.uri === refBaseURI && h.location) h.location = fragment + h.location;
170
+ }
171
+ }
172
+ // @ts-ignore
173
+ error.trace = [hop, ...error.trace];
174
+ unresolvedError = error;
175
+ } else {
176
+ unresolvedError = new UnresolvableReferenceError(message, {
177
+ cause: error,
178
+ type,
179
+ uri,
180
+ location,
181
+ codeFrame,
182
+ refFieldName,
183
+ refFieldValue,
184
+ trace: []
185
+ });
186
+ }
187
+ if (!isEntryDocument || continueOnError === false) throw unresolvedError;
188
+ if (typeof continueOnError === 'function') continueOnError(unresolvedError);
189
+ }
190
+ async ReferenceElement(path) {
191
+ const referencingElement = path.node;
192
+
193
+ // skip current referencing element as it's already been access
194
+ if (this.indirections.includes(referencingElement)) {
195
+ path.skip();
196
+ return;
197
+ }
198
+ const retrievalURI = this.toBaseURI(toValue(referencingElement.$ref));
199
+ const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
200
+ const isExternalReference = !isInternalReference;
201
+
202
+ // ignore resolving internal Reference Objects
203
+ if (!this.options.resolve.internal && isInternalReference) {
204
+ // skip traversing this reference element and all it's child elements
205
+ path.skip();
206
+ return;
207
+ }
208
+ // ignore resolving external Reference Objects
209
+ if (!this.options.resolve.external && isExternalReference) {
210
+ // skip traversing this reference element and all it's child elements
211
+ path.skip();
212
+ return;
213
+ }
214
+ const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
215
+ const indirectionsSize = this.indirections.length;
216
+ try {
217
+ const reference = await this.toReference(toValue(referencingElement.$ref));
218
+ this.indirections.push(referencingElement);
219
+ const jsonPointer = URIFragmentIdentifier.fromURIReference($refBaseURI);
220
+
221
+ // possibly non-semantic fragment
222
+ let referencedElement = evaluate(reference.value.result, jsonPointer);
223
+
224
+ // applying semantics to a fragment
225
+ const referencedElementType = referencingElement.meta.get('referenced-element');
226
+ if (referencedElement.element !== referencedElementType && !isReferenceElement(referencedElement)) {
227
+ if (this.refractCache.has(referencedElement)) {
228
+ referencedElement = this.refractCache.get(referencedElement);
229
+ } else if (isReferenceLikeElement(referencedElement)) {
230
+ // handling generic indirect references
231
+ const sourceElement = referencedElement;
232
+ referencedElement = refractReference(referencedElement);
233
+ referencedElement.meta.set('referenced-element', referencedElementType);
234
+ this.refractCache.set(sourceElement, referencedElement);
235
+ } else {
236
+ // handling direct references
237
+ const sourceElement = referencedElement;
238
+ referencedElement = refract(referencedElement, {
239
+ element: referencedElementType
240
+ });
241
+ this.refractCache.set(sourceElement, referencedElement);
242
+ }
243
+ }
244
+
245
+ // detect direct or indirect reference
246
+ if (referencingElement === referencedElement) {
247
+ throw new ApiDOMStructuredError('Recursive Reference Object detected', {
248
+ $ref: toValue(referencingElement.$ref)
249
+ });
250
+ }
251
+
252
+ // detect maximum depth of dereferencing
253
+ if (this.indirections.length > this.options.dereference.maxDepth) {
254
+ throw new MaximumDereferenceDepthError(`Maximum dereference depth of "${this.options.dereference.maxDepth}" has been exceeded in file "${this.reference.uri}"`, {
255
+ maxDepth: this.options.dereference.maxDepth,
256
+ uri: this.reference.uri
257
+ });
258
+ }
259
+
260
+ // detect cross-boundary cycle
261
+ const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
262
+ if (ancestorsLineage.includes(referencedElement)) {
263
+ reference.refSet.circular = true;
264
+ if (this.options.dereference.circular === 'error') {
265
+ throw new ApiDOMStructuredError('Circular reference detected', {
266
+ $ref: toValue(referencingElement.$ref)
267
+ });
268
+ } else if (this.options.dereference.circular === 'replace') {
269
+ const refElement = new RefElement($refBaseURI, {
270
+ type: referencingElement.element,
271
+ uri: reference.uri,
272
+ $ref: toValue(referencingElement.$ref)
273
+ });
274
+ const replacer = this.options.dereference.strategyOpts['openapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
275
+ const replacement = replacer(refElement);
276
+ path.replaceWith(replacement);
277
+ return;
278
+ }
279
+ }
280
+
281
+ /**
282
+ * Dive deep into the fragment.
283
+ *
284
+ * Cases to consider:
285
+ * 1. We're crossing document boundary
286
+ * 2. Fragment is from non-entry document
287
+ * 3. Fragment is a Reference Object. We need to follow it to get the eventual value
288
+ * 4. We are dereferencing the fragment lazily/eagerly depending on circular mode
289
+ */
290
+ const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
291
+ const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
292
+ if ((isExternalReference || isNonEntryDocument || isReferenceElement(referencedElement) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
293
+ // append referencing reference to ancestors lineage
294
+ directAncestors.add(referencingElement);
295
+ const visitor = new OpenAPI2DereferenceVisitor({
296
+ reference,
297
+ indirections: [...this.indirections],
298
+ options: this.options,
299
+ refractCache: this.refractCache,
300
+ ancestors: ancestorsLineage
301
+ });
302
+ referencedElement = await traverseAsync(referencedElement, visitor, {
303
+ mutable: true
304
+ });
305
+ directAncestors.delete(referencingElement);
306
+ }
307
+
308
+ /**
309
+ * Creating a new version of referenced element to avoid modifying the original one.
310
+ */
311
+ const mergedElement = cloneShallow(referencedElement);
312
+ // annotate referenced element with info about original referencing element
313
+ mergedElement.meta.set('ref-fields', {
314
+ $ref: toValue(referencingElement.$ref)
315
+ });
316
+ // annotate fragment with info about origin
317
+ mergedElement.meta.set('ref-origin', reference.uri);
318
+ mergedElement.meta.set('ref-type', referencingElement.element);
319
+
320
+ /**
321
+ * Transclude referencing element with merged referenced element.
322
+ */
323
+ path.replaceWith(mergedElement);
324
+ } catch (error) {
325
+ const $ref = toValue(referencingElement.$ref);
326
+ this.handleError(`Error while dereferencing Reference Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
327
+ } finally {
328
+ if (this.indirections.length > indirectionsSize) this.indirections.pop();
329
+ }
330
+ }
331
+ async PathItemElement(path) {
332
+ const referencingElement = path.node;
333
+
334
+ // ignore PathItemElement without $ref field
335
+ if (!isStringElement(referencingElement.$ref)) {
336
+ return;
337
+ }
338
+
339
+ // skip current referencing element as it's already been access
340
+ if (this.indirections.includes(referencingElement)) {
341
+ path.skip();
342
+ return;
343
+ }
344
+ const retrievalURI = this.toBaseURI(toValue(referencingElement.$ref));
345
+ const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
346
+ const isExternalReference = !isInternalReference;
347
+
348
+ // ignore resolving internal Path Item Objects
349
+ if (!this.options.resolve.internal && isInternalReference) {
350
+ // skip traversing this Path Item element but traverse all it's child elements
351
+ return;
352
+ }
353
+ // ignore resolving external Path Item Objects
354
+ if (!this.options.resolve.external && isExternalReference) {
355
+ // skip traversing this Path Item element but traverse all it's child elements
356
+ return;
357
+ }
358
+ const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
359
+ const indirectionsSize = this.indirections.length;
360
+ try {
361
+ const reference = await this.toReference(toValue(referencingElement.$ref));
362
+ this.indirections.push(referencingElement);
363
+ const jsonPointer = URIFragmentIdentifier.fromURIReference($refBaseURI);
364
+
365
+ // possibly non-semantic referenced element
366
+ let referencedElement = evaluate(reference.value.result, jsonPointer);
367
+
368
+ // applying semantics to a referenced element
369
+ if (!isPathItemElement(referencedElement)) {
370
+ if (this.refractCache.has(referencedElement)) {
371
+ referencedElement = this.refractCache.get(referencedElement);
372
+ } else {
373
+ const sourceElement = referencedElement;
374
+ referencedElement = refractPathItem(referencedElement);
375
+ this.refractCache.set(sourceElement, referencedElement);
376
+ }
377
+ }
378
+
379
+ // detect direct or indirect reference
380
+ if (referencingElement === referencedElement) {
381
+ throw new ApiDOMStructuredError('Recursive Path Item Object reference detected', {
382
+ $ref: toValue(referencingElement.$ref)
383
+ });
384
+ }
385
+
386
+ // detect maximum depth of dereferencing
387
+ if (this.indirections.length > this.options.dereference.maxDepth) {
388
+ throw new MaximumDereferenceDepthError(`Maximum dereference depth of "${this.options.dereference.maxDepth}" has been exceeded in file "${this.reference.uri}"`, {
389
+ maxDepth: this.options.dereference.maxDepth,
390
+ uri: this.reference.uri
391
+ });
392
+ }
393
+
394
+ // detect cross-boundary cycle
395
+ const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
396
+ if (ancestorsLineage.includes(referencedElement)) {
397
+ reference.refSet.circular = true;
398
+ if (this.options.dereference.circular === 'error') {
399
+ throw new ApiDOMStructuredError('Circular reference detected', {
400
+ $ref: toValue(referencingElement.$ref)
401
+ });
402
+ } else if (this.options.dereference.circular === 'replace') {
403
+ const refElement = new RefElement($refBaseURI, {
404
+ type: referencingElement.element,
405
+ uri: reference.uri,
406
+ $ref: toValue(referencingElement.$ref)
407
+ });
408
+ const replacer = this.options.dereference.strategyOpts['openapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
409
+ const replacement = replacer(refElement);
410
+ path.replaceWith(replacement);
411
+ return;
412
+ }
413
+ }
414
+
415
+ /**
416
+ * Dive deep into the fragment.
417
+ *
418
+ * Cases to consider:
419
+ * 1. We're crossing document boundary
420
+ * 2. Fragment is from non-entry document
421
+ * 3. Fragment is a Path Item Object with $ref field. We need to follow it to get the eventual value
422
+ * 4. We are dereferencing the fragment lazily/eagerly depending on circular mode
423
+ */
424
+ const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
425
+ const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
426
+ if ((isExternalReference || isNonEntryDocument || isPathItemElement(referencedElement) && isStringElement(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
427
+ // append referencing reference to ancestors lineage
428
+ directAncestors.add(referencingElement);
429
+ const visitor = new OpenAPI2DereferenceVisitor({
430
+ reference,
431
+ indirections: [...this.indirections],
432
+ options: this.options,
433
+ refractCache: this.refractCache,
434
+ ancestors: ancestorsLineage
435
+ });
436
+ referencedElement = await traverseAsync(referencedElement, visitor, {
437
+ mutable: true
438
+ });
439
+
440
+ // remove referencing reference from ancestors lineage
441
+ directAncestors.delete(referencingElement);
442
+ }
443
+
444
+ /**
445
+ * Creating a new version of Path Item by merging fields from referenced Path Item with referencing one.
446
+ */
447
+ if (isPathItemElement(referencedElement)) {
448
+ const mergedElement = cloneShallow(referencedElement);
449
+ // existing keywords from referencing PathItemElement overrides ones from referenced element
450
+ referencingElement.forEach((value, keyElement, item) => {
451
+ mergedElement.remove(toValue(keyElement));
452
+ mergedElement.content.push(item);
453
+ });
454
+ mergedElement.remove('$ref');
455
+
456
+ // annotate referenced element with info about original referencing element
457
+ mergedElement.meta.set('ref-fields', {
458
+ $ref: toValue(referencingElement.$ref)
459
+ });
460
+ // annotate referenced element with info about origin and type
461
+ mergedElement.meta.set('ref-origin', reference.uri);
462
+ mergedElement.meta.set('ref-type', referencingElement.element);
463
+ referencedElement = mergedElement;
464
+ }
465
+
466
+ /**
467
+ * Transclude referencing element with merged referenced element.
468
+ */
469
+ path.replaceWith(referencedElement);
470
+ return;
471
+ } catch (error) {
472
+ const $ref = toValue(referencingElement.$ref);
473
+ this.handleError(`Error while dereferencing Path Item Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
474
+ } finally {
475
+ if (this.indirections.length > indirectionsSize) this.indirections.pop();
476
+ }
477
+ }
478
+ async JSONReferenceElement(path) {
479
+ const referencingElement = path.node;
480
+
481
+ // skip current referencing element as it's already been access
482
+ if (this.indirections.includes(referencingElement)) {
483
+ path.skip();
484
+ return;
485
+ }
486
+ const retrievalURI = this.toBaseURI(toValue(referencingElement.$ref));
487
+ const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
488
+ const isExternalReference = !isInternalReference;
489
+
490
+ // ignore resolving internal JSONReference Objects
491
+ if (!this.options.resolve.internal && isInternalReference) {
492
+ // skip traversing this JSONReference element and all it's child elements
493
+ path.skip();
494
+ return;
495
+ }
496
+ // ignore resolving external JSONReference Objects
497
+ if (!this.options.resolve.external && isExternalReference) {
498
+ // skip traversing this JSONReference element and all it's child elements
499
+ path.skip();
500
+ return;
501
+ }
502
+ const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
503
+ const indirectionsSize = this.indirections.length;
504
+ try {
505
+ const reference = await this.toReference(toValue(referencingElement.$ref));
506
+ this.indirections.push(referencingElement);
507
+ const jsonPointer = URIFragmentIdentifier.fromURIReference($refBaseURI);
508
+
509
+ // possibly non-semantic fragment
510
+ let referencedElement = evaluate(reference.value.result, jsonPointer);
511
+
512
+ // applying semantics to a fragment
513
+ const referencedElementType = referencingElement.meta.get('referenced-element');
514
+ if (referencedElement.element !== referencedElementType && !isJSONReferenceElement(referencedElement)) {
515
+ if (this.refractCache.has(referencedElement)) {
516
+ referencedElement = this.refractCache.get(referencedElement);
517
+ } else if (isJSONReferenceLikeElement(referencedElement)) {
518
+ // handling generic indirect references
519
+ const sourceElement = referencedElement;
520
+ referencedElement = refractJSONReference(referencedElement);
521
+ referencedElement.meta.set('referenced-element', referencedElementType);
522
+ this.refractCache.set(sourceElement, referencedElement);
523
+ } else {
524
+ // handling direct references
525
+ const sourceElement = referencedElement;
526
+ referencedElement = refract(referencedElement, {
527
+ element: referencedElementType
528
+ });
529
+ this.refractCache.set(sourceElement, referencedElement);
530
+ }
531
+ }
532
+
533
+ // detect direct or indirect reference
534
+ if (referencingElement === referencedElement) {
535
+ throw new ApiDOMStructuredError('Recursive JSON Reference Object detected', {
536
+ $ref: toValue(referencingElement.$ref)
537
+ });
538
+ }
539
+
540
+ // detect maximum depth of dereferencing
541
+ if (this.indirections.length > this.options.dereference.maxDepth) {
542
+ throw new MaximumDereferenceDepthError(`Maximum dereference depth of "${this.options.dereference.maxDepth}" has been exceeded in file "${this.reference.uri}"`, {
543
+ maxDepth: this.options.dereference.maxDepth,
544
+ uri: this.reference.uri
545
+ });
546
+ }
547
+
548
+ // detect cross-boundary cycle
549
+ const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
550
+ if (ancestorsLineage.includes(referencedElement)) {
551
+ reference.refSet.circular = true;
552
+ if (this.options.dereference.circular === 'error') {
553
+ throw new ApiDOMStructuredError('Circular reference detected', {
554
+ $ref: toValue(referencingElement.$ref)
555
+ });
556
+ } else if (this.options.dereference.circular === 'replace') {
557
+ const refElement = new RefElement($refBaseURI, {
558
+ type: referencingElement.element,
559
+ uri: reference.uri,
560
+ $ref: toValue(referencingElement.$ref)
561
+ });
562
+ const replacer = this.options.dereference.strategyOpts['openapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
563
+ const replacement = replacer(refElement);
564
+ path.replaceWith(replacement);
565
+ return;
566
+ }
567
+ }
568
+
569
+ /**
570
+ * Dive deep into the fragment.
571
+ *
572
+ * Cases to consider:
573
+ * 1. We're crossing document boundary
574
+ 2. Fragment is from non-entry document
575
+ * 3. Fragment is a JSON Reference Object. We need to follow it to get the eventual value
576
+ * 4. We are dereferencing the fragment lazily/eagerly depending on circular mode
577
+ */
578
+ const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
579
+ const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
580
+ if ((isExternalReference || isNonEntryDocument || isJSONReferenceElement(referencedElement) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
581
+ // append referencing reference to ancestors lineage
582
+ directAncestors.add(referencingElement);
583
+ const visitor = new OpenAPI2DereferenceVisitor({
584
+ reference,
585
+ indirections: [...this.indirections],
586
+ options: this.options,
587
+ refractCache: this.refractCache,
588
+ ancestors: ancestorsLineage
589
+ });
590
+ referencedElement = await traverseAsync(referencedElement, visitor, {
591
+ mutable: true
592
+ });
593
+
594
+ // remove referencing reference from ancestors lineage
595
+ directAncestors.delete(referencingElement);
596
+ }
597
+
598
+ /**
599
+ * Creating a new version of referenced element to avoid modifying the original one.
600
+ */
601
+ const mergedElement = cloneShallow(referencedElement);
602
+ // annotate referenced element with info about original referencing element
603
+ mergedElement.meta.set('ref-fields', {
604
+ $ref: toValue(referencingElement.$ref)
605
+ });
606
+ // annotate fragment with info about origin
607
+ mergedElement.meta.set('ref-origin', reference.uri);
608
+ mergedElement.meta.set('ref-type', referencingElement.element);
609
+
610
+ /**
611
+ * Transclude referencing element with merged referenced element.
612
+ */
613
+ path.replaceWith(mergedElement);
614
+ } catch (error) {
615
+ const $ref = toValue(referencingElement.$ref);
616
+ this.handleError(`Error while dereferencing JSON Reference Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
617
+ } finally {
618
+ if (this.indirections.length > indirectionsSize) this.indirections.pop();
619
+ }
620
+ }
621
+ }
622
+ export default OpenAPI2DereferenceVisitor;