@speclynx/apidom-reference 6.2.0 → 7.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 +49 -0
- package/README.md +45 -0
- package/dist/apidom-reference.browser.js +4701 -3478
- package/dist/apidom-reference.browser.min.js +1 -1
- package/package.json +29 -28
- package/src/File.cjs +5 -2
- package/src/File.mjs +5 -2
- package/src/bundle/strategies/arazzo-1/index.cjs +3 -2
- package/src/bundle/strategies/arazzo-1/index.mjs +3 -2
- package/src/bundle/strategies/asyncapi-2/index.cjs +3 -2
- package/src/bundle/strategies/asyncapi-2/index.mjs +3 -2
- package/src/bundle/strategies/openapi-2/index.cjs +3 -2
- package/src/bundle/strategies/openapi-2/index.mjs +3 -2
- package/src/bundle/strategies/openapi-3-0/index.cjs +3 -2
- package/src/bundle/strategies/openapi-3-0/index.mjs +3 -2
- package/src/bundle/strategies/openapi-3-1/index.cjs +3 -2
- package/src/bundle/strategies/openapi-3-1/index.mjs +3 -2
- package/src/dereference/strategies/DereferenceVisitor.cjs +588 -0
- package/src/dereference/strategies/DereferenceVisitor.mjs +580 -0
- package/src/dereference/strategies/arazzo-1/index.cjs +14 -39
- package/src/dereference/strategies/arazzo-1/index.mjs +15 -40
- package/src/dereference/strategies/arazzo-1/visitor.cjs +207 -331
- package/src/dereference/strategies/arazzo-1/visitor.mjs +215 -338
- package/src/dereference/strategies/asyncapi-2/index.cjs +11 -39
- package/src/dereference/strategies/asyncapi-2/index.mjs +11 -39
- package/src/dereference/strategies/asyncapi-2/visitor.cjs +133 -425
- package/src/dereference/strategies/asyncapi-2/visitor.mjs +137 -429
- package/src/dereference/strategies/openapi-2/index.cjs +12 -42
- package/src/dereference/strategies/openapi-2/index.mjs +12 -42
- package/src/dereference/strategies/openapi-2/visitor.cjs +168 -532
- package/src/dereference/strategies/openapi-2/visitor.mjs +172 -536
- package/src/dereference/strategies/openapi-3-0/index.cjs +12 -42
- package/src/dereference/strategies/openapi-3-0/index.mjs +12 -42
- package/src/dereference/strategies/openapi-3-0/visitor.cjs +194 -468
- package/src/dereference/strategies/openapi-3-0/visitor.mjs +199 -473
- package/src/dereference/strategies/openapi-3-1/index.cjs +16 -42
- package/src/dereference/strategies/openapi-3-1/index.mjs +16 -42
- package/src/dereference/strategies/openapi-3-1/visitor.cjs +350 -602
- package/src/dereference/strategies/openapi-3-1/visitor.mjs +357 -608
- package/src/dereference/strategies/overlay-1/index.cjs +3 -2
- package/src/dereference/strategies/overlay-1/index.mjs +3 -2
- package/src/index.cjs +0 -7
- package/src/index.mjs +0 -1
- package/src/parse/index.cjs +9 -1
- package/src/parse/index.mjs +9 -1
- package/src/parse/parsers/apidom-json/index.cjs +2 -1
- package/src/parse/parsers/apidom-json/index.mjs +2 -1
- package/src/parse/parsers/arazzo-json-1/index.cjs +2 -1
- package/src/parse/parsers/arazzo-json-1/index.mjs +2 -1
- package/src/parse/parsers/arazzo-yaml-1/index.cjs +2 -1
- package/src/parse/parsers/arazzo-yaml-1/index.mjs +2 -1
- package/src/parse/parsers/asyncapi-json-2/index.cjs +2 -1
- package/src/parse/parsers/asyncapi-json-2/index.mjs +2 -1
- package/src/parse/parsers/asyncapi-yaml-2/index.cjs +2 -1
- package/src/parse/parsers/asyncapi-yaml-2/index.mjs +2 -1
- package/src/parse/parsers/json/index.cjs +2 -1
- package/src/parse/parsers/json/index.mjs +2 -1
- package/src/parse/parsers/openapi-json-2/index.cjs +2 -1
- package/src/parse/parsers/openapi-json-2/index.mjs +2 -1
- package/src/parse/parsers/openapi-json-3-0/index.cjs +2 -1
- package/src/parse/parsers/openapi-json-3-0/index.mjs +2 -1
- package/src/parse/parsers/openapi-json-3-1/index.cjs +2 -1
- package/src/parse/parsers/openapi-json-3-1/index.mjs +2 -1
- package/src/parse/parsers/openapi-yaml-2/index.cjs +2 -1
- package/src/parse/parsers/openapi-yaml-2/index.mjs +2 -1
- package/src/parse/parsers/openapi-yaml-3-0/index.cjs +2 -1
- package/src/parse/parsers/openapi-yaml-3-0/index.mjs +2 -1
- package/src/parse/parsers/openapi-yaml-3-1/index.cjs +2 -1
- package/src/parse/parsers/openapi-yaml-3-1/index.mjs +2 -1
- package/src/parse/parsers/overlay-json-1/index.cjs +2 -1
- package/src/parse/parsers/overlay-json-1/index.mjs +2 -1
- package/src/parse/parsers/overlay-yaml-1/index.cjs +2 -1
- package/src/parse/parsers/overlay-yaml-1/index.mjs +2 -1
- package/src/parse/parsers/yaml-1-2/index.cjs +2 -1
- package/src/parse/parsers/yaml-1-2/index.mjs +2 -1
- package/types/apidom-reference.d.ts +0 -9
- package/types/dereference/strategies/DereferenceVisitor.d.ts +224 -0
- package/types/dereference/strategies/arazzo-1/index.d.ts +0 -1
- package/types/dereference/strategies/arazzo-1/visitor.d.ts +38 -38
- package/types/dereference/strategies/asyncapi-2/index.d.ts +0 -1
- package/types/dereference/strategies/asyncapi-2/visitor.d.ts +13 -29
- package/types/dereference/strategies/openapi-2/index.d.ts +0 -1
- package/types/dereference/strategies/openapi-2/visitor.d.ts +14 -29
- package/types/dereference/strategies/openapi-3-0/index.d.ts +0 -1
- package/types/dereference/strategies/openapi-3-0/visitor.d.ts +13 -28
- package/types/dereference/strategies/openapi-3-1/index.d.ts +0 -1
- package/types/dereference/strategies/openapi-3-1/visitor.d.ts +37 -33
- package/types/index.d.ts +0 -1
- package/src/dereference/util.cjs +0 -33
- package/src/dereference/util.mjs +0 -27
- package/types/dereference/util.d.ts +0 -9
|
@@ -11,9 +11,8 @@ Object.defineProperty(exports, "AsyncAPI2DereferenceVisitor", {
|
|
|
11
11
|
}
|
|
12
12
|
});
|
|
13
13
|
exports.default = void 0;
|
|
14
|
-
var _apidomDatamodel = require("@speclynx/apidom-datamodel");
|
|
15
|
-
var _apidomTraverse = require("@speclynx/apidom-traverse");
|
|
16
14
|
var _apidomNsAsyncapi = require("@speclynx/apidom-ns-asyncapi-2");
|
|
15
|
+
var _mediaTypes = require("@swaggerexpert/media-types");
|
|
17
16
|
var _DereferenceStrategy = _interopRequireDefault(require("../DereferenceStrategy.cjs"));
|
|
18
17
|
var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
|
|
19
18
|
var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
|
|
@@ -34,71 +33,44 @@ class AsyncAPI2DereferenceStrategy extends _DereferenceStrategy.default {
|
|
|
34
33
|
}
|
|
35
34
|
canDereference(file) {
|
|
36
35
|
// assert by media type
|
|
37
|
-
if (
|
|
38
|
-
return _apidomNsAsyncapi.mediaTypes
|
|
36
|
+
if (!(0, _mediaTypes.matches)('text/plain', file.mediaType)) {
|
|
37
|
+
return (0, _mediaTypes.selectBestMatch)(_apidomNsAsyncapi.mediaTypes, file.mediaType) !== null;
|
|
39
38
|
}
|
|
40
39
|
|
|
41
40
|
// assert by inspecting ApiDOM
|
|
42
41
|
return (0, _apidomNsAsyncapi.isAsyncApi2Element)(file.parseResult?.result);
|
|
43
42
|
}
|
|
44
43
|
async dereference(file, options) {
|
|
45
|
-
const
|
|
46
|
-
const mutableRefSet = new _ReferenceSet.default();
|
|
47
|
-
let refSet = immutableRefSet;
|
|
44
|
+
const refSet = options.dereference.refSet ?? new _ReferenceSet.default();
|
|
48
45
|
let reference;
|
|
49
|
-
if (!
|
|
46
|
+
if (!refSet.has(file.uri)) {
|
|
50
47
|
reference = new _Reference.default({
|
|
51
48
|
uri: file.uri,
|
|
52
49
|
value: file.parseResult
|
|
53
50
|
});
|
|
54
|
-
|
|
51
|
+
refSet.add(reference);
|
|
55
52
|
} else {
|
|
56
53
|
// pre-computed refSet was provided as configuration option
|
|
57
|
-
reference =
|
|
54
|
+
reference = refSet.find(ref => ref.uri === file.uri);
|
|
58
55
|
}
|
|
59
56
|
|
|
60
57
|
/**
|
|
61
|
-
*
|
|
62
|
-
*
|
|
58
|
+
* With the immutable option the dereferenced element is a new tree,
|
|
59
|
+
* otherwise the dereferenced root is dereferenced in place.
|
|
63
60
|
*/
|
|
64
|
-
if (options.dereference.immutable) {
|
|
65
|
-
immutableRefSet.refs.map(ref => new _Reference.default({
|
|
66
|
-
...ref,
|
|
67
|
-
value: (0, _apidomDatamodel.cloneDeep)(ref.value)
|
|
68
|
-
})).forEach(ref => mutableRefSet.add(ref));
|
|
69
|
-
reference = mutableRefSet.find(ref => ref.uri === file.uri);
|
|
70
|
-
refSet = mutableRefSet;
|
|
71
|
-
}
|
|
72
|
-
const shouldDetectCircular = ['error', 'replace'].includes(options.dereference.circular);
|
|
73
61
|
const visitor = new _visitor.default({
|
|
74
62
|
reference,
|
|
75
63
|
options
|
|
76
64
|
});
|
|
77
|
-
const dereferencedElement = await
|
|
78
|
-
mutable: true,
|
|
79
|
-
...(shouldDetectCircular && {
|
|
80
|
-
skipVisited: 'skip'
|
|
81
|
-
})
|
|
82
|
-
});
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* If immutable option is set, replay refs from the refSet.
|
|
86
|
-
*/
|
|
87
|
-
if (options.dereference.immutable) {
|
|
88
|
-
mutableRefSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => new _Reference.default({
|
|
89
|
-
...ref,
|
|
90
|
-
uri: ref.uri.replace(/^immutable:\/\//, '')
|
|
91
|
-
})).forEach(ref => immutableRefSet.add(ref));
|
|
92
|
-
}
|
|
65
|
+
const dereferencedElement = await visitor.dereference(refSet.rootRef.value, undefined);
|
|
93
66
|
|
|
94
67
|
/**
|
|
95
68
|
* Release all memory if this refSet was not provided as a configuration option.
|
|
96
69
|
* If provided as configuration option, then provider is responsible for cleanup.
|
|
97
70
|
*/
|
|
98
71
|
if (options.dereference.refSet === null) {
|
|
99
|
-
|
|
72
|
+
refSet.clean();
|
|
100
73
|
}
|
|
101
|
-
mutableRefSet.clean();
|
|
102
74
|
return dereferencedElement;
|
|
103
75
|
}
|
|
104
76
|
}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import { cloneDeep } from '@speclynx/apidom-datamodel';
|
|
2
|
-
import { traverseAsync } from '@speclynx/apidom-traverse';
|
|
3
1
|
import { isAsyncApi2Element, mediaTypes } from '@speclynx/apidom-ns-asyncapi-2';
|
|
2
|
+
import { matches, selectBestMatch } from '@swaggerexpert/media-types';
|
|
4
3
|
import DereferenceStrategy from "../DereferenceStrategy.mjs";
|
|
5
4
|
import Reference from "../../../Reference.mjs";
|
|
6
5
|
import ReferenceSet from "../../../ReferenceSet.mjs";
|
|
@@ -20,71 +19,44 @@ class AsyncAPI2DereferenceStrategy extends DereferenceStrategy {
|
|
|
20
19
|
}
|
|
21
20
|
canDereference(file) {
|
|
22
21
|
// assert by media type
|
|
23
|
-
if (
|
|
24
|
-
return mediaTypes
|
|
22
|
+
if (!matches('text/plain', file.mediaType)) {
|
|
23
|
+
return selectBestMatch(mediaTypes, file.mediaType) !== null;
|
|
25
24
|
}
|
|
26
25
|
|
|
27
26
|
// assert by inspecting ApiDOM
|
|
28
27
|
return isAsyncApi2Element(file.parseResult?.result);
|
|
29
28
|
}
|
|
30
29
|
async dereference(file, options) {
|
|
31
|
-
const
|
|
32
|
-
const mutableRefSet = new ReferenceSet();
|
|
33
|
-
let refSet = immutableRefSet;
|
|
30
|
+
const refSet = options.dereference.refSet ?? new ReferenceSet();
|
|
34
31
|
let reference;
|
|
35
|
-
if (!
|
|
32
|
+
if (!refSet.has(file.uri)) {
|
|
36
33
|
reference = new Reference({
|
|
37
34
|
uri: file.uri,
|
|
38
35
|
value: file.parseResult
|
|
39
36
|
});
|
|
40
|
-
|
|
37
|
+
refSet.add(reference);
|
|
41
38
|
} else {
|
|
42
39
|
// pre-computed refSet was provided as configuration option
|
|
43
|
-
reference =
|
|
40
|
+
reference = refSet.find(ref => ref.uri === file.uri);
|
|
44
41
|
}
|
|
45
42
|
|
|
46
43
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
44
|
+
* With the immutable option the dereferenced element is a new tree,
|
|
45
|
+
* otherwise the dereferenced root is dereferenced in place.
|
|
49
46
|
*/
|
|
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 shouldDetectCircular = ['error', 'replace'].includes(options.dereference.circular);
|
|
59
47
|
const visitor = new AsyncAPI2DereferenceVisitor({
|
|
60
48
|
reference,
|
|
61
49
|
options
|
|
62
50
|
});
|
|
63
|
-
const dereferencedElement = await
|
|
64
|
-
mutable: true,
|
|
65
|
-
...(shouldDetectCircular && {
|
|
66
|
-
skipVisited: 'skip'
|
|
67
|
-
})
|
|
68
|
-
});
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* If immutable option is set, replay refs from the refSet.
|
|
72
|
-
*/
|
|
73
|
-
if (options.dereference.immutable) {
|
|
74
|
-
mutableRefSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => new Reference({
|
|
75
|
-
...ref,
|
|
76
|
-
uri: ref.uri.replace(/^immutable:\/\//, '')
|
|
77
|
-
})).forEach(ref => immutableRefSet.add(ref));
|
|
78
|
-
}
|
|
51
|
+
const dereferencedElement = await visitor.dereference(refSet.rootRef.value, undefined);
|
|
79
52
|
|
|
80
53
|
/**
|
|
81
54
|
* Release all memory if this refSet was not provided as a configuration option.
|
|
82
55
|
* If provided as configuration option, then provider is responsible for cleanup.
|
|
83
56
|
*/
|
|
84
57
|
if (options.dereference.refSet === null) {
|
|
85
|
-
|
|
58
|
+
refSet.clean();
|
|
86
59
|
}
|
|
87
|
-
mutableRefSet.clean();
|
|
88
60
|
return dereferencedElement;
|
|
89
61
|
}
|
|
90
62
|
}
|