@speclynx/apidom-reference 3.2.1 → 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.
- package/CHANGELOG.md +12 -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,500 +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 by identity in the document tree.
|
|
137
|
-
// guarded: this.reference.value may not be a ParseResultElement or may lack a result.
|
|
138
|
-
// falls back to visitorPath which may produce an incomplete path when
|
|
139
|
-
// dereferenceApiDOM is called with a fragment (cloneShallow creates a new root identity).
|
|
140
|
-
let location;
|
|
141
|
-
const root = this.reference.value.result;
|
|
142
|
-
if (isElement(root)) {
|
|
143
|
-
traverse(root, {
|
|
144
|
-
enter(p) {
|
|
145
|
-
if (p.node === referencingElement) {
|
|
146
|
-
location = p.formatPath();
|
|
147
|
-
p.stop();
|
|
148
|
-
}
|
|
149
|
-
}
|
|
150
|
-
});
|
|
151
|
-
}
|
|
152
|
-
location ??= visitorPath.formatPath();
|
|
153
|
-
const hop = {
|
|
154
|
-
uri,
|
|
155
|
-
type,
|
|
156
|
-
refFieldName,
|
|
157
|
-
refFieldValue,
|
|
158
|
-
location,
|
|
159
|
-
codeFrame
|
|
160
|
-
};
|
|
161
|
-
|
|
162
|
-
// enrich existing error from nested visitor or create new one
|
|
163
|
-
let unresolvedError;
|
|
164
|
-
if (error instanceof UnresolvableReferenceError) {
|
|
165
|
-
// prefix relative locations for entries belonging to the referenced document
|
|
166
|
-
const refBaseURI = this.toBaseURI(refFieldValue);
|
|
167
|
-
const fragment = URIFragmentIdentifier.fromURIReference(refFieldValue);
|
|
168
|
-
if (fragment) {
|
|
169
|
-
if (refBaseURI === error.uri && error.location) {
|
|
170
|
-
error.location = fragment + error.location;
|
|
171
|
-
}
|
|
172
|
-
for (const h of error.trace) {
|
|
173
|
-
if (h.uri === refBaseURI && h.location) h.location = fragment + h.location;
|
|
174
|
-
}
|
|
175
|
-
}
|
|
176
|
-
// @ts-ignore
|
|
177
|
-
error.trace = [hop, ...error.trace];
|
|
178
|
-
unresolvedError = error;
|
|
179
|
-
} else {
|
|
180
|
-
unresolvedError = new UnresolvableReferenceError(message, {
|
|
181
|
-
cause: error,
|
|
182
|
-
type,
|
|
183
|
-
uri,
|
|
184
|
-
location,
|
|
185
|
-
codeFrame,
|
|
186
|
-
refFieldName,
|
|
187
|
-
refFieldValue,
|
|
188
|
-
trace: []
|
|
189
|
-
});
|
|
190
|
-
}
|
|
191
|
-
if (!isEntryDocument || continueOnError === false) throw unresolvedError;
|
|
192
|
-
if (typeof continueOnError === 'function') continueOnError(unresolvedError);
|
|
193
|
-
}
|
|
194
|
-
ReusableElement(path) {
|
|
195
|
-
const referencingElement = path.node;
|
|
196
|
-
|
|
197
|
-
// skip current Reusable Object if reference field is not defined as a string
|
|
198
|
-
if (!isStringElement(referencingElement.reference)) {
|
|
199
|
-
path.skip();
|
|
200
|
-
return;
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
// ignore if resolve.internal is false (Reusable Objects are internal references only)
|
|
204
|
-
if (!this.options.resolve.internal) {
|
|
205
|
-
path.skip();
|
|
206
|
-
return;
|
|
207
|
-
}
|
|
208
|
-
const runtimeExpression = toValue(referencingElement.reference);
|
|
209
|
-
|
|
210
|
-
// parse the runtime expression
|
|
211
|
-
const {
|
|
212
|
-
result,
|
|
213
|
-
tree
|
|
214
|
-
} = parseRuntimeExpression(runtimeExpression);
|
|
215
|
-
if (!result.success) {
|
|
216
|
-
throw new ApiDOMStructuredError(`Invalid Reusable Object reference format: "${runtimeExpression}"`, {
|
|
217
|
-
runtimeExpression
|
|
218
|
-
});
|
|
219
|
-
}
|
|
220
|
-
|
|
221
|
-
// ReusableElement can only reference components
|
|
222
|
-
if (tree.type !== 'ComponentsExpression') {
|
|
223
|
-
throw new ApiDOMStructuredError(`Reusable Object reference "${runtimeExpression}" must be a components expression`, {
|
|
224
|
-
runtimeExpression
|
|
225
|
-
});
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
// evaluate runtime expression as JSON Pointer to get the referenced element
|
|
229
|
-
const jsonPointer = jsonPointerCompile(['components', tree.field, tree.subField]);
|
|
230
|
-
let referencedElement;
|
|
231
|
-
try {
|
|
232
|
-
referencedElement = jsonPointerEvaluate(this.reference.value.result, jsonPointer);
|
|
233
|
-
} catch {
|
|
234
|
-
throw new ApiDOMStructuredError(`Reusable Object reference "${runtimeExpression}" cannot be resolved`, {
|
|
235
|
-
runtimeExpression
|
|
236
|
-
});
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
/**
|
|
240
|
-
* Create a shallow clone of the referenced element to avoid modifying the original.
|
|
241
|
-
*/
|
|
242
|
-
const mergedElement = cloneShallow(referencedElement);
|
|
243
|
-
// annotate with info about original referencing element
|
|
244
|
-
mergedElement.meta.set('ref-fields', {
|
|
245
|
-
reference: runtimeExpression,
|
|
246
|
-
value: toValue(referencingElement.value)
|
|
247
|
-
});
|
|
248
|
-
// annotate with info about origin
|
|
249
|
-
mergedElement.meta.set('ref-origin', this.reference.uri);
|
|
250
|
-
mergedElement.meta.set('ref-type', referencingElement.element);
|
|
251
|
-
|
|
252
|
-
// override value field if present for Parameter Objects
|
|
253
|
-
if (isParameterElement(mergedElement) && referencingElement.hasKey('value')) {
|
|
254
|
-
mergedElement.remove('value');
|
|
255
|
-
mergedElement.set('value', referencingElement.get('value'));
|
|
256
|
-
}
|
|
257
|
-
|
|
258
|
-
/**
|
|
259
|
-
* Transclude referencing element with merged referenced element.
|
|
260
|
-
*/
|
|
261
|
-
path.replaceWith(mergedElement);
|
|
262
|
-
}
|
|
263
|
-
async JSONSchemaElement(path) {
|
|
264
|
-
const referencingElement = path.node;
|
|
265
|
-
|
|
266
|
-
// skip current referencing schema as $ref keyword was not defined
|
|
267
|
-
if (!isStringElement(referencingElement.$ref)) {
|
|
268
|
-
return;
|
|
269
|
-
}
|
|
270
|
-
|
|
271
|
-
// skip current referencing element as it's already been accessed
|
|
272
|
-
if (this.indirections.includes(referencingElement)) {
|
|
273
|
-
path.skip();
|
|
274
|
-
return;
|
|
275
|
-
}
|
|
276
|
-
const indirectionsSize = this.indirections.length;
|
|
277
|
-
try {
|
|
278
|
-
// compute baseURI using rules around $id and $ref keywords
|
|
279
|
-
let reference = await this.toReference(url.unsanitize(this.reference.uri));
|
|
280
|
-
let {
|
|
281
|
-
uri: retrievalURI
|
|
282
|
-
} = reference;
|
|
283
|
-
const $refBaseURI = resolveSchema$refField(retrievalURI, referencingElement);
|
|
284
|
-
const $refBaseURIStrippedHash = url.stripHash($refBaseURI);
|
|
285
|
-
const file = new File({
|
|
286
|
-
uri: $refBaseURIStrippedHash
|
|
287
|
-
});
|
|
288
|
-
const isUnknownURI = none(r => r.canRead(file), this.options.resolve.resolvers);
|
|
289
|
-
const isURL = !isUnknownURI;
|
|
290
|
-
let isInternalReference = url.stripHash(this.reference.uri) === $refBaseURI;
|
|
291
|
-
let isExternalReference = !isInternalReference;
|
|
292
|
-
|
|
293
|
-
// determining reference, proper evaluation and selection mechanism
|
|
294
|
-
let referencedElement;
|
|
295
|
-
try {
|
|
296
|
-
if (isUnknownURI || isURL) {
|
|
297
|
-
// we're dealing with canonical URI or URL with possible fragment
|
|
298
|
-
retrievalURI = this.toBaseURI($refBaseURI);
|
|
299
|
-
const selector = $refBaseURI;
|
|
300
|
-
const referenceAsSchema = maybeRefractToJSONSchemaElement(reference.value.result);
|
|
301
|
-
referencedElement = uriEvaluate(selector, referenceAsSchema);
|
|
302
|
-
referencedElement = maybeRefractToJSONSchemaElement(referencedElement);
|
|
303
|
-
|
|
304
|
-
// ignore resolving internal Schema Objects
|
|
305
|
-
if (!this.options.resolve.internal && isInternalReference) {
|
|
306
|
-
// skip traversing this schema element but traverse all its child elements
|
|
307
|
-
return;
|
|
308
|
-
}
|
|
309
|
-
// ignore resolving external Schema Objects
|
|
310
|
-
if (!this.options.resolve.external && isExternalReference) {
|
|
311
|
-
// skip traversing this schema element but traverse all its child elements
|
|
312
|
-
return;
|
|
313
|
-
}
|
|
314
|
-
} else {
|
|
315
|
-
// we're assuming here that we're dealing with JSON Pointer here
|
|
316
|
-
retrievalURI = this.toBaseURI($refBaseURI);
|
|
317
|
-
isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
|
|
318
|
-
isExternalReference = !isInternalReference;
|
|
319
|
-
|
|
320
|
-
// ignore resolving internal Schema Objects
|
|
321
|
-
if (!this.options.resolve.internal && isInternalReference) {
|
|
322
|
-
// skip traversing this schema element but traverse all its child elements
|
|
323
|
-
return;
|
|
324
|
-
}
|
|
325
|
-
// ignore resolving external Schema Objects
|
|
326
|
-
if (!this.options.resolve.external && isExternalReference) {
|
|
327
|
-
// skip traversing this schema element but traverse all its child elements
|
|
328
|
-
return;
|
|
329
|
-
}
|
|
330
|
-
reference = await this.toReference(url.unsanitize($refBaseURI));
|
|
331
|
-
const selector = URIFragmentIdentifier.fromURIReference($refBaseURI);
|
|
332
|
-
const referenceAsSchema = maybeRefractToJSONSchemaElement(reference.value.result);
|
|
333
|
-
referencedElement = jsonPointerEvaluate(referenceAsSchema, selector);
|
|
334
|
-
referencedElement = maybeRefractToJSONSchemaElement(referencedElement);
|
|
335
|
-
}
|
|
336
|
-
} catch (error) {
|
|
337
|
-
/**
|
|
338
|
-
* JSONSchemaElement($id=URL) was not found, so we're going to try to resolve
|
|
339
|
-
* the URL and assume the returned response is a JSON Schema.
|
|
340
|
-
*/
|
|
341
|
-
if (isURL && error instanceof EvaluationJsonSchemaUriError) {
|
|
342
|
-
if (isAnchor(uriToAnchor($refBaseURI))) {
|
|
343
|
-
// we're dealing with JSON Schema $anchor here
|
|
344
|
-
isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
|
|
345
|
-
isExternalReference = !isInternalReference;
|
|
346
|
-
|
|
347
|
-
// ignore resolving internal Schema Objects
|
|
348
|
-
if (!this.options.resolve.internal && isInternalReference) {
|
|
349
|
-
// skip traversing this schema element but traverse all its child elements
|
|
350
|
-
return;
|
|
351
|
-
}
|
|
352
|
-
// ignore resolving external Schema Objects
|
|
353
|
-
if (!this.options.resolve.external && isExternalReference) {
|
|
354
|
-
// skip traversing this schema element but traverse all its child elements
|
|
355
|
-
return;
|
|
356
|
-
}
|
|
357
|
-
reference = await this.toReference(url.unsanitize($refBaseURI));
|
|
358
|
-
const selector = uriToAnchor($refBaseURI);
|
|
359
|
-
const referenceAsSchema = maybeRefractToJSONSchemaElement(reference.value.result);
|
|
360
|
-
referencedElement = $anchorEvaluate(selector, referenceAsSchema);
|
|
361
|
-
referencedElement = maybeRefractToJSONSchemaElement(referencedElement);
|
|
362
|
-
} else {
|
|
363
|
-
// we're assuming here that we're dealing with JSON Pointer here
|
|
364
|
-
retrievalURI = this.toBaseURI($refBaseURI);
|
|
365
|
-
isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
|
|
366
|
-
isExternalReference = !isInternalReference;
|
|
367
|
-
|
|
368
|
-
// ignore resolving internal Schema Objects
|
|
369
|
-
if (!this.options.resolve.internal && isInternalReference) {
|
|
370
|
-
// skip traversing this schema element but traverse all its child elements
|
|
371
|
-
return;
|
|
372
|
-
}
|
|
373
|
-
// ignore resolving external Schema Objects
|
|
374
|
-
if (!this.options.resolve.external && isExternalReference) {
|
|
375
|
-
// skip traversing this schema element but traverse all its child elements
|
|
376
|
-
return;
|
|
377
|
-
}
|
|
378
|
-
reference = await this.toReference(url.unsanitize($refBaseURI));
|
|
379
|
-
const selector = URIFragmentIdentifier.fromURIReference($refBaseURI);
|
|
380
|
-
const referenceAsSchema = maybeRefractToJSONSchemaElement(reference.value.result);
|
|
381
|
-
referencedElement = jsonPointerEvaluate(referenceAsSchema, selector);
|
|
382
|
-
referencedElement = maybeRefractToJSONSchemaElement(referencedElement);
|
|
383
|
-
}
|
|
384
|
-
} else {
|
|
385
|
-
throw error;
|
|
386
|
-
}
|
|
387
|
-
}
|
|
388
|
-
this.indirections.push(referencingElement);
|
|
389
|
-
|
|
390
|
-
// detect direct or indirect reference
|
|
391
|
-
if (referencingElement === referencedElement) {
|
|
392
|
-
throw new ApiDOMStructuredError('Recursive JSON Schema reference detected', {
|
|
393
|
-
$ref: toValue(referencingElement.$ref)
|
|
394
|
-
});
|
|
395
|
-
}
|
|
396
|
-
|
|
397
|
-
// detect maximum depth of dereferencing
|
|
398
|
-
if (this.indirections.length > this.options.dereference.maxDepth) {
|
|
399
|
-
throw new MaximumDereferenceDepthError(`Maximum dereference depth of "${this.options.dereference.maxDepth}" has been exceeded in file "${this.reference.uri}"`, {
|
|
400
|
-
maxDepth: this.options.dereference.maxDepth,
|
|
401
|
-
uri: this.reference.uri
|
|
402
|
-
});
|
|
403
|
-
}
|
|
404
|
-
|
|
405
|
-
// detect cross-boundary cycle
|
|
406
|
-
const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
|
|
407
|
-
if (ancestorsLineage.includes(referencedElement)) {
|
|
408
|
-
reference.refSet.circular = true;
|
|
409
|
-
if (this.options.dereference.circular === 'error') {
|
|
410
|
-
throw new ApiDOMStructuredError('Circular reference detected', {
|
|
411
|
-
$ref: toValue(referencingElement.$ref)
|
|
412
|
-
});
|
|
413
|
-
} else if (this.options.dereference.circular === 'replace') {
|
|
414
|
-
const refElement = new RefElement($refBaseURI, {
|
|
415
|
-
type: referencingElement.element,
|
|
416
|
-
uri: reference.uri,
|
|
417
|
-
$ref: toValue(referencingElement.$ref)
|
|
418
|
-
});
|
|
419
|
-
const replacer = this.options.dereference.strategyOpts['arazzo-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
|
|
420
|
-
const replacement = replacer(refElement);
|
|
421
|
-
path.replaceWith(replacement);
|
|
422
|
-
return;
|
|
423
|
-
}
|
|
424
|
-
}
|
|
425
|
-
|
|
426
|
-
/**
|
|
427
|
-
* Dive deep into the fragment.
|
|
428
|
-
*
|
|
429
|
-
* Cases to consider:
|
|
430
|
-
* 1. We're crossing document boundary
|
|
431
|
-
* 2. Fragment is from non-entry document
|
|
432
|
-
* 3. Fragment is a JSON Schema with $ref field. We need to follow it to get the eventual value
|
|
433
|
-
* 4. We are dereferencing the fragment lazily/eagerly depending on circular mode
|
|
434
|
-
*/
|
|
435
|
-
const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
|
|
436
|
-
const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
|
|
437
|
-
if ((isExternalReference || isNonEntryDocument || isJSONSchemaElement(referencedElement) && isStringElement(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
|
|
438
|
-
// append referencing reference to ancestors lineage
|
|
439
|
-
directAncestors.add(referencingElement);
|
|
440
|
-
const visitor = new Arazzo1DereferenceVisitor({
|
|
441
|
-
reference,
|
|
442
|
-
indirections: [...this.indirections],
|
|
443
|
-
options: this.options,
|
|
444
|
-
ancestors: ancestorsLineage
|
|
445
|
-
});
|
|
446
|
-
referencedElement = await traverseAsync(referencedElement, visitor, {
|
|
447
|
-
mutable: true
|
|
448
|
-
});
|
|
449
|
-
|
|
450
|
-
// remove referencing reference from ancestors lineage
|
|
451
|
-
directAncestors.delete(referencingElement);
|
|
452
|
-
}
|
|
453
|
-
|
|
454
|
-
// Boolean JSON Schemas
|
|
455
|
-
if (isBooleanJSONSchemaElement(referencedElement)) {
|
|
456
|
-
const booleanJsonSchemaElement = cloneDeep(referencedElement);
|
|
457
|
-
// annotate referenced element with info about original referencing element
|
|
458
|
-
booleanJsonSchemaElement.meta.set('ref-fields', {
|
|
459
|
-
$ref: toValue(referencingElement.$ref)
|
|
460
|
-
});
|
|
461
|
-
// annotate referenced element with info about origin
|
|
462
|
-
booleanJsonSchemaElement.meta.set('ref-origin', reference.uri);
|
|
463
|
-
booleanJsonSchemaElement.meta.set('ref-type', referencingElement.element);
|
|
464
|
-
path.replaceWith(booleanJsonSchemaElement);
|
|
465
|
-
return;
|
|
466
|
-
}
|
|
467
|
-
|
|
468
|
-
/**
|
|
469
|
-
* Creating a new version of JSON Schema by merging fields from referenced Schema with referencing one.
|
|
470
|
-
*/
|
|
471
|
-
if (isJSONSchemaElement(referencedElement)) {
|
|
472
|
-
const mergedElement = cloneShallow(referencedElement);
|
|
473
|
-
// existing keywords from referencing schema overrides ones from referenced schema
|
|
474
|
-
referencingElement.forEach((value, keyElement, item) => {
|
|
475
|
-
mergedElement.remove(toValue(keyElement));
|
|
476
|
-
mergedElement.content.push(item);
|
|
477
|
-
});
|
|
478
|
-
mergedElement.remove('$ref');
|
|
479
|
-
// annotate referenced element with info about original referencing element
|
|
480
|
-
mergedElement.meta.set('ref-fields', {
|
|
481
|
-
$ref: toValue(referencingElement.$ref)
|
|
482
|
-
});
|
|
483
|
-
// annotate fragment with info about origin
|
|
484
|
-
mergedElement.meta.set('ref-origin', reference.uri);
|
|
485
|
-
mergedElement.meta.set('ref-type', referencingElement.element);
|
|
486
|
-
referencedElement = mergedElement;
|
|
487
|
-
}
|
|
488
|
-
/**
|
|
489
|
-
* Transclude referencing element with merged referenced element.
|
|
490
|
-
*/
|
|
491
|
-
path.replaceWith(referencedElement);
|
|
492
|
-
} catch (error) {
|
|
493
|
-
const $ref = toValue(referencingElement.$ref);
|
|
494
|
-
this.handleError(`Error while dereferencing Schema Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
|
|
495
|
-
} finally {
|
|
496
|
-
if (this.indirections.length > indirectionsSize) this.indirections.pop();
|
|
497
|
-
}
|
|
498
|
-
}
|
|
499
|
-
}
|
|
500
|
-
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;
|