@speclynx/apidom-reference 4.12.1 → 4.14.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/README.md +99 -4
- package/dist/apidom-reference.browser.js +2353 -293
- package/dist/apidom-reference.browser.min.js +1 -1
- package/package.json +33 -28
- package/src/bundle/strategies/openapi-2/index.cjs +94 -0
- package/src/bundle/strategies/openapi-2/index.mjs +81 -0
- package/src/bundle/strategies/openapi-2/visitor.cjs +559 -0
- package/src/bundle/strategies/openapi-2/visitor.mjs +551 -0
- package/src/bundle/strategies/openapi-3-0/visitor.cjs +10 -18
- package/src/bundle/strategies/openapi-3-0/visitor.mjs +10 -18
- package/src/bundle/strategies/openapi-3-1/index.cjs +59 -2
- package/src/bundle/strategies/openapi-3-1/index.mjs +54 -2
- package/src/bundle/strategies/openapi-3-1/visitor.cjs +811 -0
- package/src/bundle/strategies/openapi-3-1/visitor.mjs +803 -0
- package/src/configuration/saturated.cjs +12 -11
- package/src/configuration/saturated.mjs +2 -1
- package/src/util/url.cjs +26 -4
- package/src/util/url.mjs +23 -2
- package/types/apidom-reference.d.ts +10 -0
- package/types/bundle/strategies/openapi-2/index.d.ts +31 -0
- package/types/bundle/strategies/openapi-2/visitor.d.ts +131 -0
- package/types/bundle/strategies/openapi-3-0/visitor.d.ts +2 -2
- package/types/bundle/strategies/openapi-3-1/index.d.ts +6 -1
- package/types/bundle/strategies/openapi-3-1/visitor.d.ts +141 -0
- package/types/util/url.d.ts +8 -0
|
@@ -4,9 +4,20 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
|
|
|
4
4
|
Object.defineProperty(exports, "__esModule", {
|
|
5
5
|
value: true
|
|
6
6
|
});
|
|
7
|
+
Object.defineProperty(exports, "OpenAPI3_1BundleVisitor", {
|
|
8
|
+
enumerable: true,
|
|
9
|
+
get: function () {
|
|
10
|
+
return _visitor.default;
|
|
11
|
+
}
|
|
12
|
+
});
|
|
7
13
|
exports.default = void 0;
|
|
14
|
+
var _apidomDatamodel = require("@speclynx/apidom-datamodel");
|
|
15
|
+
var _apidomTraverse = require("@speclynx/apidom-traverse");
|
|
8
16
|
var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-1");
|
|
17
|
+
var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
|
|
18
|
+
var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
|
|
9
19
|
var _BundleStrategy = _interopRequireDefault(require("../BundleStrategy.cjs"));
|
|
20
|
+
var _visitor = _interopRequireDefault(require("./visitor.cjs"));
|
|
10
21
|
/**
|
|
11
22
|
* @public
|
|
12
23
|
*/
|
|
@@ -30,8 +41,54 @@ class OpenAPI3_1BundleStrategy extends _BundleStrategy.default {
|
|
|
30
41
|
// assert by inspecting ApiDOM
|
|
31
42
|
return (0, _apidomNsOpenapi.isOpenApi3_1Element)(file.parseResult?.result);
|
|
32
43
|
}
|
|
33
|
-
async bundle(file) {
|
|
34
|
-
|
|
44
|
+
async bundle(file, options) {
|
|
45
|
+
const immutableRefSet = options.bundle.refSet ?? new _ReferenceSet.default();
|
|
46
|
+
const mutableRefSet = new _ReferenceSet.default();
|
|
47
|
+
let refSet = immutableRefSet;
|
|
48
|
+
let reference;
|
|
49
|
+
|
|
50
|
+
// determine the initial reference
|
|
51
|
+
if (!immutableRefSet.has(file.uri)) {
|
|
52
|
+
reference = new _Reference.default({
|
|
53
|
+
uri: file.uri,
|
|
54
|
+
value: file.parseResult
|
|
55
|
+
});
|
|
56
|
+
immutableRefSet.add(reference);
|
|
57
|
+
} else {
|
|
58
|
+
// pre-computed refSet was provided as configuration option
|
|
59
|
+
reference = immutableRefSet.find(ref => ref.uri === file.uri);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Clone refSet due the bundling process being mutable.
|
|
64
|
+
* We don't want to mutate the original refSet and the references.
|
|
65
|
+
*/
|
|
66
|
+
if (options.bundle.immutable) {
|
|
67
|
+
immutableRefSet.refs.map(ref => new _Reference.default({
|
|
68
|
+
...ref,
|
|
69
|
+
value: (0, _apidomDatamodel.cloneDeep)(ref.value)
|
|
70
|
+
})).forEach(ref => mutableRefSet.add(ref));
|
|
71
|
+
reference = mutableRefSet.find(ref => ref.uri === file.uri);
|
|
72
|
+
refSet = mutableRefSet;
|
|
73
|
+
}
|
|
74
|
+
const visitor = new _visitor.default({
|
|
75
|
+
reference: reference,
|
|
76
|
+
options
|
|
77
|
+
});
|
|
78
|
+
await (0, _apidomTraverse.traverseAsync)(refSet.rootRef.value, visitor, {
|
|
79
|
+
mutable: true
|
|
80
|
+
});
|
|
81
|
+
const parseResult = reference.value;
|
|
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.bundle.refSet === null) {
|
|
88
|
+
immutableRefSet.clean();
|
|
89
|
+
}
|
|
90
|
+
mutableRefSet.clean();
|
|
91
|
+
return parseResult;
|
|
35
92
|
}
|
|
36
93
|
}
|
|
37
94
|
var _default = exports.default = OpenAPI3_1BundleStrategy;
|
|
@@ -1,5 +1,10 @@
|
|
|
1
|
+
import { cloneDeep } from '@speclynx/apidom-datamodel';
|
|
2
|
+
import { traverseAsync } from '@speclynx/apidom-traverse';
|
|
1
3
|
import { mediaTypes, isOpenApi3_1Element } from '@speclynx/apidom-ns-openapi-3-1';
|
|
4
|
+
import Reference from "../../../Reference.mjs";
|
|
5
|
+
import ReferenceSet from "../../../ReferenceSet.mjs";
|
|
2
6
|
import BundleStrategy from "../BundleStrategy.mjs";
|
|
7
|
+
import OpenAPI3_1BundleVisitor from "./visitor.mjs";
|
|
3
8
|
/**
|
|
4
9
|
* @public
|
|
5
10
|
*/
|
|
@@ -22,8 +27,55 @@ class OpenAPI3_1BundleStrategy extends BundleStrategy {
|
|
|
22
27
|
// assert by inspecting ApiDOM
|
|
23
28
|
return isOpenApi3_1Element(file.parseResult?.result);
|
|
24
29
|
}
|
|
25
|
-
async bundle(file) {
|
|
26
|
-
|
|
30
|
+
async bundle(file, options) {
|
|
31
|
+
const immutableRefSet = options.bundle.refSet ?? new ReferenceSet();
|
|
32
|
+
const mutableRefSet = new ReferenceSet();
|
|
33
|
+
let refSet = immutableRefSet;
|
|
34
|
+
let reference;
|
|
35
|
+
|
|
36
|
+
// determine the initial reference
|
|
37
|
+
if (!immutableRefSet.has(file.uri)) {
|
|
38
|
+
reference = new Reference({
|
|
39
|
+
uri: file.uri,
|
|
40
|
+
value: file.parseResult
|
|
41
|
+
});
|
|
42
|
+
immutableRefSet.add(reference);
|
|
43
|
+
} else {
|
|
44
|
+
// pre-computed refSet was provided as configuration option
|
|
45
|
+
reference = immutableRefSet.find(ref => ref.uri === file.uri);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Clone refSet due the bundling process being mutable.
|
|
50
|
+
* We don't want to mutate the original refSet and the references.
|
|
51
|
+
*/
|
|
52
|
+
if (options.bundle.immutable) {
|
|
53
|
+
immutableRefSet.refs.map(ref => new Reference({
|
|
54
|
+
...ref,
|
|
55
|
+
value: cloneDeep(ref.value)
|
|
56
|
+
})).forEach(ref => mutableRefSet.add(ref));
|
|
57
|
+
reference = mutableRefSet.find(ref => ref.uri === file.uri);
|
|
58
|
+
refSet = mutableRefSet;
|
|
59
|
+
}
|
|
60
|
+
const visitor = new OpenAPI3_1BundleVisitor({
|
|
61
|
+
reference: reference,
|
|
62
|
+
options
|
|
63
|
+
});
|
|
64
|
+
await traverseAsync(refSet.rootRef.value, visitor, {
|
|
65
|
+
mutable: true
|
|
66
|
+
});
|
|
67
|
+
const parseResult = reference.value;
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* Release all memory if this refSet was not provided as a configuration option.
|
|
71
|
+
* If provided as configuration option, then provider is responsible for cleanup.
|
|
72
|
+
*/
|
|
73
|
+
if (options.bundle.refSet === null) {
|
|
74
|
+
immutableRefSet.clean();
|
|
75
|
+
}
|
|
76
|
+
mutableRefSet.clean();
|
|
77
|
+
return parseResult;
|
|
27
78
|
}
|
|
28
79
|
}
|
|
80
|
+
export { OpenAPI3_1BundleVisitor };
|
|
29
81
|
export default OpenAPI3_1BundleStrategy;
|