@speclynx/apidom-reference 3.2.1 → 4.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/dist/apidom-reference.browser.js +40 -36
- package/dist/apidom-reference.browser.min.js +1 -1
- package/package.json +25 -25
- package/types/dereference/strategies/apidom/visitor.d.ts +1 -1
- package/types/dereference/strategies/arazzo-1/visitor.d.ts +1 -1
- package/types/dereference/strategies/asyncapi-2/visitor.d.ts +1 -1
- package/types/dereference/strategies/openapi-2/visitor.d.ts +1 -1
- package/types/dereference/strategies/openapi-3-0/visitor.d.ts +1 -1
- package/types/dereference/strategies/openapi-3-1/visitor.d.ts +1 -1
- package/src/File.cjs +0 -50
- package/src/File.mjs +0 -44
- package/src/Reference.cjs +0 -31
- package/src/Reference.mjs +0 -27
- package/src/ReferenceSet.cjs +0 -60
- package/src/ReferenceSet.mjs +0 -57
- package/src/bundle/index.cjs +0 -61
- package/src/bundle/index.mjs +0 -55
- package/src/bundle/strategies/BundleStrategy.cjs +0 -20
- package/src/bundle/strategies/BundleStrategy.mjs +0 -16
- package/src/bundle/strategies/openapi-3-1/index.cjs +0 -35
- package/src/bundle/strategies/openapi-3-1/index.mjs +0 -29
- package/src/configuration/empty.cjs +0 -9
- package/src/configuration/empty.mjs +0 -1
- package/src/configuration/saturated.cjs +0 -88
- package/src/configuration/saturated.mjs +0 -80
- package/src/dereference/index.cjs +0 -90
- package/src/dereference/index.mjs +0 -83
- package/src/dereference/strategies/DereferenceStrategy.cjs +0 -20
- package/src/dereference/strategies/DereferenceStrategy.mjs +0 -16
- package/src/dereference/strategies/apidom/index.cjs +0 -89
- package/src/dereference/strategies/apidom/index.mjs +0 -83
- package/src/dereference/strategies/apidom/selectors/element-id.cjs +0 -47
- package/src/dereference/strategies/apidom/selectors/element-id.mjs +0 -41
- package/src/dereference/strategies/apidom/visitor.cjs +0 -266
- package/src/dereference/strategies/apidom/visitor.mjs +0 -259
- package/src/dereference/strategies/arazzo-1/index.cjs +0 -109
- package/src/dereference/strategies/arazzo-1/index.mjs +0 -100
- package/src/dereference/strategies/arazzo-1/selectors/$anchor.cjs +0 -12
- package/src/dereference/strategies/arazzo-1/selectors/$anchor.mjs +0 -1
- package/src/dereference/strategies/arazzo-1/selectors/uri.cjs +0 -8
- package/src/dereference/strategies/arazzo-1/selectors/uri.mjs +0 -1
- package/src/dereference/strategies/arazzo-1/source-descriptions.cjs +0 -248
- package/src/dereference/strategies/arazzo-1/source-descriptions.mjs +0 -243
- package/src/dereference/strategies/arazzo-1/util.cjs +0 -37
- package/src/dereference/strategies/arazzo-1/util.mjs +0 -29
- package/src/dereference/strategies/arazzo-1/visitor.cjs +0 -507
- package/src/dereference/strategies/arazzo-1/visitor.mjs +0 -500
- package/src/dereference/strategies/asyncapi-2/index.cjs +0 -94
- package/src/dereference/strategies/asyncapi-2/index.mjs +0 -88
- package/src/dereference/strategies/asyncapi-2/visitor.cjs +0 -501
- package/src/dereference/strategies/asyncapi-2/visitor.mjs +0 -494
- package/src/dereference/strategies/openapi-2/index.cjs +0 -96
- package/src/dereference/strategies/openapi-2/index.mjs +0 -90
- package/src/dereference/strategies/openapi-2/visitor.cjs +0 -629
- package/src/dereference/strategies/openapi-2/visitor.mjs +0 -622
- package/src/dereference/strategies/openapi-3-0/index.cjs +0 -96
- package/src/dereference/strategies/openapi-3-0/index.mjs +0 -90
- package/src/dereference/strategies/openapi-3-0/visitor.cjs +0 -621
- package/src/dereference/strategies/openapi-3-0/visitor.mjs +0 -614
- package/src/dereference/strategies/openapi-3-1/index.cjs +0 -99
- package/src/dereference/strategies/openapi-3-1/index.mjs +0 -90
- package/src/dereference/strategies/openapi-3-1/selectors/$anchor.cjs +0 -67
- package/src/dereference/strategies/openapi-3-1/selectors/$anchor.mjs +0 -56
- package/src/dereference/strategies/openapi-3-1/selectors/uri.cjs +0 -50
- package/src/dereference/strategies/openapi-3-1/selectors/uri.mjs +0 -42
- package/src/dereference/strategies/openapi-3-1/util.cjs +0 -68
- package/src/dereference/strategies/openapi-3-1/util.mjs +0 -59
- package/src/dereference/strategies/openapi-3-1/visitor.cjs +0 -873
- package/src/dereference/strategies/openapi-3-1/visitor.mjs +0 -866
- package/src/dereference/util.cjs +0 -31
- package/src/dereference/util.mjs +0 -27
- package/src/errors/BundleError.cjs +0 -10
- package/src/errors/BundleError.mjs +0 -7
- package/src/errors/DereferenceError.cjs +0 -10
- package/src/errors/DereferenceError.mjs +0 -7
- package/src/errors/EvaluationElementIdError.cjs +0 -10
- package/src/errors/EvaluationElementIdError.mjs +0 -7
- package/src/errors/EvaluationJsonSchema$anchorError.cjs +0 -11
- package/src/errors/EvaluationJsonSchema$anchorError.mjs +0 -6
- package/src/errors/EvaluationJsonSchemaUriError.cjs +0 -11
- package/src/errors/EvaluationJsonSchemaUriError.mjs +0 -6
- package/src/errors/InvalidJsonSchema$anchorError.cjs +0 -15
- package/src/errors/InvalidJsonSchema$anchorError.mjs +0 -10
- package/src/errors/JsonSchema$anchorError.cjs +0 -10
- package/src/errors/JsonSchema$anchorError.mjs +0 -7
- package/src/errors/JsonSchemaUriError.cjs +0 -10
- package/src/errors/JsonSchemaUriError.mjs +0 -7
- package/src/errors/MaximumBundleDepthError.cjs +0 -11
- package/src/errors/MaximumBundleDepthError.mjs +0 -6
- package/src/errors/MaximumDereferenceDepthError.cjs +0 -11
- package/src/errors/MaximumDereferenceDepthError.mjs +0 -6
- package/src/errors/MaximumResolveDepthError.cjs +0 -11
- package/src/errors/MaximumResolveDepthError.mjs +0 -6
- package/src/errors/ParseError.cjs +0 -10
- package/src/errors/ParseError.mjs +0 -7
- package/src/errors/ParserError.cjs +0 -11
- package/src/errors/ParserError.mjs +0 -6
- package/src/errors/PluginError.cjs +0 -18
- package/src/errors/PluginError.mjs +0 -15
- package/src/errors/ResolveError.cjs +0 -10
- package/src/errors/ResolveError.mjs +0 -7
- package/src/errors/ResolverError.cjs +0 -11
- package/src/errors/ResolverError.mjs +0 -6
- package/src/errors/UnmatchedBundleStrategyError.cjs +0 -11
- package/src/errors/UnmatchedBundleStrategyError.mjs +0 -6
- package/src/errors/UnmatchedDereferenceStrategyError.cjs +0 -11
- package/src/errors/UnmatchedDereferenceStrategyError.mjs +0 -6
- package/src/errors/UnmatchedParserError.cjs +0 -11
- package/src/errors/UnmatchedParserError.mjs +0 -6
- package/src/errors/UnmatchedResolveStrategyError.cjs +0 -11
- package/src/errors/UnmatchedResolveStrategyError.mjs +0 -6
- package/src/errors/UnmatchedResolverError.cjs +0 -11
- package/src/errors/UnmatchedResolverError.mjs +0 -6
- package/src/errors/UnresolvableReferenceError.cjs +0 -11
- package/src/errors/UnresolvableReferenceError.mjs +0 -6
- package/src/index.cjs +0 -146
- package/src/index.mjs +0 -103
- package/src/options/index.cjs +0 -194
- package/src/options/index.mjs +0 -191
- package/src/options/util.cjs +0 -24
- package/src/options/util.mjs +0 -19
- package/src/parse/index.cjs +0 -69
- package/src/parse/index.mjs +0 -63
- package/src/parse/parsers/Parser.cjs +0 -62
- package/src/parse/parsers/Parser.mjs +0 -58
- package/src/parse/parsers/apidom-json/index.cjs +0 -70
- package/src/parse/parsers/apidom-json/index.mjs +0 -64
- package/src/parse/parsers/arazzo-json-1/index.cjs +0 -62
- package/src/parse/parsers/arazzo-json-1/index.mjs +0 -56
- package/src/parse/parsers/arazzo-json-1/source-descriptions.cjs +0 -221
- package/src/parse/parsers/arazzo-json-1/source-descriptions.mjs +0 -214
- package/src/parse/parsers/arazzo-yaml-1/index.cjs +0 -62
- package/src/parse/parsers/arazzo-yaml-1/index.mjs +0 -56
- package/src/parse/parsers/arazzo-yaml-1/source-descriptions.cjs +0 -12
- package/src/parse/parsers/arazzo-yaml-1/source-descriptions.mjs +0 -7
- package/src/parse/parsers/asyncapi-json-2/index.cjs +0 -54
- package/src/parse/parsers/asyncapi-json-2/index.mjs +0 -48
- package/src/parse/parsers/asyncapi-yaml-2/index.cjs +0 -54
- package/src/parse/parsers/asyncapi-yaml-2/index.mjs +0 -48
- package/src/parse/parsers/binary/index-browser.cjs +0 -56
- package/src/parse/parsers/binary/index-browser.mjs +0 -50
- package/src/parse/parsers/binary/index-node.cjs +0 -51
- package/src/parse/parsers/binary/index-node.mjs +0 -45
- package/src/parse/parsers/json/index.cjs +0 -53
- package/src/parse/parsers/json/index.mjs +0 -47
- package/src/parse/parsers/openapi-json-2/index.cjs +0 -54
- package/src/parse/parsers/openapi-json-2/index.mjs +0 -48
- package/src/parse/parsers/openapi-json-3-0/index.cjs +0 -54
- package/src/parse/parsers/openapi-json-3-0/index.mjs +0 -48
- package/src/parse/parsers/openapi-json-3-1/index.cjs +0 -54
- package/src/parse/parsers/openapi-json-3-1/index.mjs +0 -48
- package/src/parse/parsers/openapi-yaml-2/index.cjs +0 -54
- package/src/parse/parsers/openapi-yaml-2/index.mjs +0 -48
- package/src/parse/parsers/openapi-yaml-3-0/index.cjs +0 -54
- package/src/parse/parsers/openapi-yaml-3-0/index.mjs +0 -48
- package/src/parse/parsers/openapi-yaml-3-1/index.cjs +0 -54
- package/src/parse/parsers/openapi-yaml-3-1/index.mjs +0 -48
- package/src/parse/parsers/yaml-1-2/index.cjs +0 -56
- package/src/parse/parsers/yaml-1-2/index.mjs +0 -50
- package/src/resolve/index.cjs +0 -67
- package/src/resolve/index.mjs +0 -60
- package/src/resolve/resolvers/HTTPResolver.cjs +0 -45
- package/src/resolve/resolvers/HTTPResolver.mjs +0 -37
- package/src/resolve/resolvers/Resolver.cjs +0 -20
- package/src/resolve/resolvers/Resolver.mjs +0 -16
- package/src/resolve/resolvers/file/index-browser.cjs +0 -24
- package/src/resolve/resolvers/file/index-browser.mjs +0 -19
- package/src/resolve/resolvers/file/index-node.cjs +0 -49
- package/src/resolve/resolvers/file/index-node.mjs +0 -42
- package/src/resolve/resolvers/http-axios/cache/MemoryCache.cjs +0 -41
- package/src/resolve/resolvers/http-axios/cache/MemoryCache.mjs +0 -37
- package/src/resolve/resolvers/http-axios/index.cjs +0 -113
- package/src/resolve/resolvers/http-axios/index.mjs +0 -105
- package/src/resolve/strategies/ResolveStrategy.cjs +0 -20
- package/src/resolve/strategies/ResolveStrategy.mjs +0 -16
- package/src/resolve/strategies/apidom/index.cjs +0 -49
- package/src/resolve/strategies/apidom/index.mjs +0 -43
- package/src/resolve/strategies/asyncapi-2/index.cjs +0 -49
- package/src/resolve/strategies/asyncapi-2/index.mjs +0 -43
- package/src/resolve/strategies/openapi-2/index.cjs +0 -49
- package/src/resolve/strategies/openapi-2/index.mjs +0 -43
- package/src/resolve/strategies/openapi-3-0/index.cjs +0 -49
- package/src/resolve/strategies/openapi-3-0/index.mjs +0 -43
- package/src/resolve/strategies/openapi-3-1/index.cjs +0 -49
- package/src/resolve/strategies/openapi-3-1/index.mjs +0 -43
- package/src/resolve/util.cjs +0 -37
- package/src/resolve/util.mjs +0 -30
- package/src/util/plugins.cjs +0 -39
- package/src/util/plugins.mjs +0 -34
- package/src/util/url.cjs +0 -288
- package/src/util/url.mjs +0 -274
|
@@ -1,494 +0,0 @@
|
|
|
1
|
-
import { propEq } from 'ramda';
|
|
2
|
-
import { isElement, isStringElement, RefElement, cloneDeep, cloneShallow } 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 { isReferenceLikeElement, isBooleanJSONSchemaElement, isChannelItemElement, isReferenceElement, refract, refractReference, refractChannelItem } from '@speclynx/apidom-ns-asyncapi-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 AsyncAPI2DereferenceVisitor {
|
|
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.ancestors = new AncestorLineage(...ancestors);
|
|
44
|
-
this.refractCache = refractCache;
|
|
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 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 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 circular 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 second deep dive into the same fragment and avoid it
|
|
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['asyncapi-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 AsyncAPI2DereferenceVisitor({
|
|
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
|
-
|
|
306
|
-
// remove referencing reference from ancestors lineage
|
|
307
|
-
directAncestors.delete(referencingElement);
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
// Boolean JSON Schemas
|
|
311
|
-
if (isBooleanJSONSchemaElement(referencedElement)) {
|
|
312
|
-
const booleanJsonSchemaElement = cloneDeep(referencedElement);
|
|
313
|
-
// annotate referenced element with info about original referencing element
|
|
314
|
-
booleanJsonSchemaElement.meta.set('ref-fields', {
|
|
315
|
-
$ref: toValue(referencingElement.$ref)
|
|
316
|
-
});
|
|
317
|
-
// annotate referenced element with info about origin
|
|
318
|
-
booleanJsonSchemaElement.meta.set('ref-origin', reference.uri);
|
|
319
|
-
booleanJsonSchemaElement.meta.set('ref-type', referencingElement.element);
|
|
320
|
-
path.replaceWith(booleanJsonSchemaElement);
|
|
321
|
-
return;
|
|
322
|
-
}
|
|
323
|
-
|
|
324
|
-
/**
|
|
325
|
-
* Creating a new version of referenced element to avoid modifying the original one.
|
|
326
|
-
*/
|
|
327
|
-
const mergedElement = cloneShallow(referencedElement);
|
|
328
|
-
// annotate referenced element with info about original referencing element
|
|
329
|
-
mergedElement.meta.set('ref-fields', {
|
|
330
|
-
$ref: toValue(referencingElement.$ref)
|
|
331
|
-
});
|
|
332
|
-
// annotate fragment with info about origin
|
|
333
|
-
mergedElement.meta.set('ref-origin', reference.uri);
|
|
334
|
-
mergedElement.meta.set('ref-type', referencingElement.element);
|
|
335
|
-
|
|
336
|
-
/**
|
|
337
|
-
* Transclude referencing element with merged referenced element.
|
|
338
|
-
*/
|
|
339
|
-
path.replaceWith(mergedElement);
|
|
340
|
-
} catch (error) {
|
|
341
|
-
const $ref = toValue(referencingElement.$ref);
|
|
342
|
-
this.handleError(`Error while dereferencing Reference Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
|
|
343
|
-
} finally {
|
|
344
|
-
if (this.indirections.length > indirectionsSize) this.indirections.pop();
|
|
345
|
-
}
|
|
346
|
-
}
|
|
347
|
-
async ChannelItemElement(path) {
|
|
348
|
-
const referencingElement = path.node;
|
|
349
|
-
|
|
350
|
-
// ignore ChannelItemElement without $ref field
|
|
351
|
-
if (!isStringElement(referencingElement.$ref)) {
|
|
352
|
-
return;
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
// skip current referencing element as it's already been access
|
|
356
|
-
if (this.indirections.includes(referencingElement)) {
|
|
357
|
-
path.skip();
|
|
358
|
-
return;
|
|
359
|
-
}
|
|
360
|
-
const retrievalURI = this.toBaseURI(toValue(referencingElement.$ref));
|
|
361
|
-
const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
|
|
362
|
-
const isExternalReference = !isInternalReference;
|
|
363
|
-
|
|
364
|
-
// ignore resolving internal Channel Item Objects
|
|
365
|
-
if (!this.options.resolve.internal && isInternalReference) {
|
|
366
|
-
// skip traversing this channel item but traverse all it's child elements
|
|
367
|
-
return;
|
|
368
|
-
}
|
|
369
|
-
// ignore resolving external Channel Item Objects
|
|
370
|
-
if (!this.options.resolve.external && isExternalReference) {
|
|
371
|
-
// skip traversing this channel item but traverse all it's child elements
|
|
372
|
-
return;
|
|
373
|
-
}
|
|
374
|
-
const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
|
|
375
|
-
const indirectionsSize = this.indirections.length;
|
|
376
|
-
try {
|
|
377
|
-
const reference = await this.toReference(toValue(referencingElement.$ref));
|
|
378
|
-
this.indirections.push(referencingElement);
|
|
379
|
-
const jsonPointer = URIFragmentIdentifier.fromURIReference($refBaseURI);
|
|
380
|
-
|
|
381
|
-
// possibly non-semantic referenced element
|
|
382
|
-
let referencedElement = evaluate(reference.value.result, jsonPointer);
|
|
383
|
-
|
|
384
|
-
// applying semantics to a referenced element
|
|
385
|
-
if (!isChannelItemElement(referencedElement)) {
|
|
386
|
-
if (this.refractCache.has(referencedElement)) {
|
|
387
|
-
referencedElement = this.refractCache.get(referencedElement);
|
|
388
|
-
} else {
|
|
389
|
-
const sourceElement = referencedElement;
|
|
390
|
-
referencedElement = refractChannelItem(referencedElement);
|
|
391
|
-
this.refractCache.set(sourceElement, referencedElement);
|
|
392
|
-
}
|
|
393
|
-
}
|
|
394
|
-
|
|
395
|
-
// detect direct or indirect reference
|
|
396
|
-
if (referencingElement === referencedElement) {
|
|
397
|
-
throw new ApiDOMStructuredError('Recursive Channel Item Object reference detected', {
|
|
398
|
-
$ref: toValue(referencingElement.$ref)
|
|
399
|
-
});
|
|
400
|
-
}
|
|
401
|
-
|
|
402
|
-
// detect maximum depth of dereferencing
|
|
403
|
-
if (this.indirections.length > this.options.dereference.maxDepth) {
|
|
404
|
-
throw new MaximumDereferenceDepthError(`Maximum dereference depth of "${this.options.dereference.maxDepth}" has been exceeded in file "${this.reference.uri}"`, {
|
|
405
|
-
maxDepth: this.options.dereference.maxDepth,
|
|
406
|
-
uri: this.reference.uri
|
|
407
|
-
});
|
|
408
|
-
}
|
|
409
|
-
|
|
410
|
-
// detect second deep dive into the same fragment and avoid it
|
|
411
|
-
const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
|
|
412
|
-
if (ancestorsLineage.includes(referencedElement)) {
|
|
413
|
-
reference.refSet.circular = true;
|
|
414
|
-
if (this.options.dereference.circular === 'error') {
|
|
415
|
-
throw new ApiDOMStructuredError('Circular reference detected', {
|
|
416
|
-
$ref: toValue(referencingElement.$ref)
|
|
417
|
-
});
|
|
418
|
-
} else if (this.options.dereference.circular === 'replace') {
|
|
419
|
-
const refElement = new RefElement($refBaseURI, {
|
|
420
|
-
type: referencingElement.element,
|
|
421
|
-
uri: reference.uri,
|
|
422
|
-
$ref: toValue(referencingElement.$ref)
|
|
423
|
-
});
|
|
424
|
-
const replacer = this.options.dereference.strategyOpts['asyncapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
|
|
425
|
-
const replacement = replacer(refElement);
|
|
426
|
-
path.replaceWith(replacement);
|
|
427
|
-
return;
|
|
428
|
-
}
|
|
429
|
-
}
|
|
430
|
-
|
|
431
|
-
/**
|
|
432
|
-
* Dive deep into the fragment.
|
|
433
|
-
*
|
|
434
|
-
* Cases to consider:
|
|
435
|
-
* 1. We're crossing document boundary
|
|
436
|
-
* 2. Fragment is from non-entry document
|
|
437
|
-
* 3. Fragment is a Channel Item Object with $ref field. We need to follow it to get the eventual value
|
|
438
|
-
* 4. We are dereferencing the fragment lazily/eagerly depending on circular mode
|
|
439
|
-
*/
|
|
440
|
-
const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
|
|
441
|
-
const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
|
|
442
|
-
if ((isExternalReference || isNonEntryDocument || isChannelItemElement(referencedElement) && isStringElement(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
|
|
443
|
-
// append referencing reference to ancestors lineage
|
|
444
|
-
directAncestors.add(referencingElement);
|
|
445
|
-
const visitor = new AsyncAPI2DereferenceVisitor({
|
|
446
|
-
reference,
|
|
447
|
-
indirections: [...this.indirections],
|
|
448
|
-
options: this.options,
|
|
449
|
-
refractCache: this.refractCache,
|
|
450
|
-
ancestors: ancestorsLineage
|
|
451
|
-
});
|
|
452
|
-
referencedElement = await traverseAsync(referencedElement, visitor, {
|
|
453
|
-
mutable: true
|
|
454
|
-
});
|
|
455
|
-
|
|
456
|
-
// remove referencing reference from ancestors lineage
|
|
457
|
-
directAncestors.delete(referencingElement);
|
|
458
|
-
}
|
|
459
|
-
|
|
460
|
-
/**
|
|
461
|
-
* Creating a new version of Channel Item by merging fields from referenced Channel Item with referencing one.
|
|
462
|
-
*/
|
|
463
|
-
if (isChannelItemElement(referencedElement)) {
|
|
464
|
-
const mergedElement = cloneShallow(referencedElement);
|
|
465
|
-
// existing keywords from referencing ChannelItemElement overrides ones from referenced ChannelItemElement
|
|
466
|
-
referencingElement.forEach((value, keyElement, item) => {
|
|
467
|
-
mergedElement.remove(toValue(keyElement));
|
|
468
|
-
mergedElement.content.push(item);
|
|
469
|
-
});
|
|
470
|
-
mergedElement.remove('$ref');
|
|
471
|
-
|
|
472
|
-
// annotate referenced element with info about original referencing element
|
|
473
|
-
mergedElement.meta.set('ref-fields', {
|
|
474
|
-
$ref: toValue(referencingElement.$ref)
|
|
475
|
-
});
|
|
476
|
-
// annotate referenced with info about origin
|
|
477
|
-
mergedElement.meta.set('ref-origin', reference.uri);
|
|
478
|
-
mergedElement.meta.set('ref-type', referencingElement.element);
|
|
479
|
-
referencedElement = mergedElement;
|
|
480
|
-
}
|
|
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 Channel Item 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 AsyncAPI2DereferenceVisitor;
|
|
@@ -1,96 +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 _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-2");
|
|
8
|
-
var _apidomTraverse = require("@speclynx/apidom-traverse");
|
|
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.OpenAPI2DereferenceVisitor = _visitor.default;
|
|
14
|
-
/**
|
|
15
|
-
* @public
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* @public
|
|
20
|
-
*/
|
|
21
|
-
class OpenAPI2DereferenceStrategy extends _DereferenceStrategy.default {
|
|
22
|
-
constructor(options) {
|
|
23
|
-
super({
|
|
24
|
-
...(options ?? {}),
|
|
25
|
-
name: 'openapi-2'
|
|
26
|
-
});
|
|
27
|
-
}
|
|
28
|
-
canDereference(file) {
|
|
29
|
-
// assert by media type
|
|
30
|
-
if (file.mediaType !== 'text/plain') {
|
|
31
|
-
return _apidomNsOpenapi.mediaTypes.includes(file.mediaType);
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
// assert by inspecting ApiDOM
|
|
35
|
-
return (0, _apidomNsOpenapi.isSwaggerElement)(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: 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
|
-
reference = immutableRefSet.find(ref => ref.uri === file.uri);
|
|
82
|
-
refSet = immutableRefSet;
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
/**
|
|
86
|
-
* Release all memory if this refSet was not provided as a configuration option.
|
|
87
|
-
* If provided as configuration option, then provider is responsible for cleanup.
|
|
88
|
-
*/
|
|
89
|
-
if (options.dereference.refSet === null) {
|
|
90
|
-
immutableRefSet.clean();
|
|
91
|
-
}
|
|
92
|
-
mutableRefSet.clean();
|
|
93
|
-
return dereferencedElement;
|
|
94
|
-
}
|
|
95
|
-
}
|
|
96
|
-
var _default = exports.default = OpenAPI2DereferenceStrategy;
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
import { cloneDeep } from '@speclynx/apidom-datamodel';
|
|
2
|
-
import { isSwaggerElement, mediaTypes } from '@speclynx/apidom-ns-openapi-2';
|
|
3
|
-
import { traverseAsync } from '@speclynx/apidom-traverse';
|
|
4
|
-
import DereferenceStrategy from "../DereferenceStrategy.mjs";
|
|
5
|
-
import Reference from "../../../Reference.mjs";
|
|
6
|
-
import ReferenceSet from "../../../ReferenceSet.mjs";
|
|
7
|
-
import OpenAPI2DereferenceVisitor from "./visitor.mjs";
|
|
8
|
-
/**
|
|
9
|
-
* @public
|
|
10
|
-
*/
|
|
11
|
-
/**
|
|
12
|
-
* @public
|
|
13
|
-
*/
|
|
14
|
-
class OpenAPI2DereferenceStrategy extends DereferenceStrategy {
|
|
15
|
-
constructor(options) {
|
|
16
|
-
super({
|
|
17
|
-
...(options ?? {}),
|
|
18
|
-
name: 'openapi-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 isSwaggerElement(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 OpenAPI2DereferenceVisitor({
|
|
59
|
-
reference: 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
|
-
reference = immutableRefSet.find(ref => ref.uri === file.uri);
|
|
75
|
-
refSet = immutableRefSet;
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
* Release all memory if this refSet was not provided as a configuration option.
|
|
80
|
-
* If provided as configuration option, then provider is responsible for cleanup.
|
|
81
|
-
*/
|
|
82
|
-
if (options.dereference.refSet === null) {
|
|
83
|
-
immutableRefSet.clean();
|
|
84
|
-
}
|
|
85
|
-
mutableRefSet.clean();
|
|
86
|
-
return dereferencedElement;
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
export { OpenAPI2DereferenceVisitor };
|
|
90
|
-
export default OpenAPI2DereferenceStrategy;
|