@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.
Files changed (192) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/apidom-reference.browser.js +40 -36
  3. package/dist/apidom-reference.browser.min.js +1 -1
  4. package/package.json +25 -25
  5. package/types/dereference/strategies/apidom/visitor.d.ts +1 -1
  6. package/types/dereference/strategies/arazzo-1/visitor.d.ts +1 -1
  7. package/types/dereference/strategies/asyncapi-2/visitor.d.ts +1 -1
  8. package/types/dereference/strategies/openapi-2/visitor.d.ts +1 -1
  9. package/types/dereference/strategies/openapi-3-0/visitor.d.ts +1 -1
  10. package/types/dereference/strategies/openapi-3-1/visitor.d.ts +1 -1
  11. package/src/File.cjs +0 -50
  12. package/src/File.mjs +0 -44
  13. package/src/Reference.cjs +0 -31
  14. package/src/Reference.mjs +0 -27
  15. package/src/ReferenceSet.cjs +0 -60
  16. package/src/ReferenceSet.mjs +0 -57
  17. package/src/bundle/index.cjs +0 -61
  18. package/src/bundle/index.mjs +0 -55
  19. package/src/bundle/strategies/BundleStrategy.cjs +0 -20
  20. package/src/bundle/strategies/BundleStrategy.mjs +0 -16
  21. package/src/bundle/strategies/openapi-3-1/index.cjs +0 -35
  22. package/src/bundle/strategies/openapi-3-1/index.mjs +0 -29
  23. package/src/configuration/empty.cjs +0 -9
  24. package/src/configuration/empty.mjs +0 -1
  25. package/src/configuration/saturated.cjs +0 -88
  26. package/src/configuration/saturated.mjs +0 -80
  27. package/src/dereference/index.cjs +0 -90
  28. package/src/dereference/index.mjs +0 -83
  29. package/src/dereference/strategies/DereferenceStrategy.cjs +0 -20
  30. package/src/dereference/strategies/DereferenceStrategy.mjs +0 -16
  31. package/src/dereference/strategies/apidom/index.cjs +0 -89
  32. package/src/dereference/strategies/apidom/index.mjs +0 -83
  33. package/src/dereference/strategies/apidom/selectors/element-id.cjs +0 -47
  34. package/src/dereference/strategies/apidom/selectors/element-id.mjs +0 -41
  35. package/src/dereference/strategies/apidom/visitor.cjs +0 -266
  36. package/src/dereference/strategies/apidom/visitor.mjs +0 -259
  37. package/src/dereference/strategies/arazzo-1/index.cjs +0 -109
  38. package/src/dereference/strategies/arazzo-1/index.mjs +0 -100
  39. package/src/dereference/strategies/arazzo-1/selectors/$anchor.cjs +0 -12
  40. package/src/dereference/strategies/arazzo-1/selectors/$anchor.mjs +0 -1
  41. package/src/dereference/strategies/arazzo-1/selectors/uri.cjs +0 -8
  42. package/src/dereference/strategies/arazzo-1/selectors/uri.mjs +0 -1
  43. package/src/dereference/strategies/arazzo-1/source-descriptions.cjs +0 -248
  44. package/src/dereference/strategies/arazzo-1/source-descriptions.mjs +0 -243
  45. package/src/dereference/strategies/arazzo-1/util.cjs +0 -37
  46. package/src/dereference/strategies/arazzo-1/util.mjs +0 -29
  47. package/src/dereference/strategies/arazzo-1/visitor.cjs +0 -507
  48. package/src/dereference/strategies/arazzo-1/visitor.mjs +0 -500
  49. package/src/dereference/strategies/asyncapi-2/index.cjs +0 -94
  50. package/src/dereference/strategies/asyncapi-2/index.mjs +0 -88
  51. package/src/dereference/strategies/asyncapi-2/visitor.cjs +0 -501
  52. package/src/dereference/strategies/asyncapi-2/visitor.mjs +0 -494
  53. package/src/dereference/strategies/openapi-2/index.cjs +0 -96
  54. package/src/dereference/strategies/openapi-2/index.mjs +0 -90
  55. package/src/dereference/strategies/openapi-2/visitor.cjs +0 -629
  56. package/src/dereference/strategies/openapi-2/visitor.mjs +0 -622
  57. package/src/dereference/strategies/openapi-3-0/index.cjs +0 -96
  58. package/src/dereference/strategies/openapi-3-0/index.mjs +0 -90
  59. package/src/dereference/strategies/openapi-3-0/visitor.cjs +0 -621
  60. package/src/dereference/strategies/openapi-3-0/visitor.mjs +0 -614
  61. package/src/dereference/strategies/openapi-3-1/index.cjs +0 -99
  62. package/src/dereference/strategies/openapi-3-1/index.mjs +0 -90
  63. package/src/dereference/strategies/openapi-3-1/selectors/$anchor.cjs +0 -67
  64. package/src/dereference/strategies/openapi-3-1/selectors/$anchor.mjs +0 -56
  65. package/src/dereference/strategies/openapi-3-1/selectors/uri.cjs +0 -50
  66. package/src/dereference/strategies/openapi-3-1/selectors/uri.mjs +0 -42
  67. package/src/dereference/strategies/openapi-3-1/util.cjs +0 -68
  68. package/src/dereference/strategies/openapi-3-1/util.mjs +0 -59
  69. package/src/dereference/strategies/openapi-3-1/visitor.cjs +0 -873
  70. package/src/dereference/strategies/openapi-3-1/visitor.mjs +0 -866
  71. package/src/dereference/util.cjs +0 -31
  72. package/src/dereference/util.mjs +0 -27
  73. package/src/errors/BundleError.cjs +0 -10
  74. package/src/errors/BundleError.mjs +0 -7
  75. package/src/errors/DereferenceError.cjs +0 -10
  76. package/src/errors/DereferenceError.mjs +0 -7
  77. package/src/errors/EvaluationElementIdError.cjs +0 -10
  78. package/src/errors/EvaluationElementIdError.mjs +0 -7
  79. package/src/errors/EvaluationJsonSchema$anchorError.cjs +0 -11
  80. package/src/errors/EvaluationJsonSchema$anchorError.mjs +0 -6
  81. package/src/errors/EvaluationJsonSchemaUriError.cjs +0 -11
  82. package/src/errors/EvaluationJsonSchemaUriError.mjs +0 -6
  83. package/src/errors/InvalidJsonSchema$anchorError.cjs +0 -15
  84. package/src/errors/InvalidJsonSchema$anchorError.mjs +0 -10
  85. package/src/errors/JsonSchema$anchorError.cjs +0 -10
  86. package/src/errors/JsonSchema$anchorError.mjs +0 -7
  87. package/src/errors/JsonSchemaUriError.cjs +0 -10
  88. package/src/errors/JsonSchemaUriError.mjs +0 -7
  89. package/src/errors/MaximumBundleDepthError.cjs +0 -11
  90. package/src/errors/MaximumBundleDepthError.mjs +0 -6
  91. package/src/errors/MaximumDereferenceDepthError.cjs +0 -11
  92. package/src/errors/MaximumDereferenceDepthError.mjs +0 -6
  93. package/src/errors/MaximumResolveDepthError.cjs +0 -11
  94. package/src/errors/MaximumResolveDepthError.mjs +0 -6
  95. package/src/errors/ParseError.cjs +0 -10
  96. package/src/errors/ParseError.mjs +0 -7
  97. package/src/errors/ParserError.cjs +0 -11
  98. package/src/errors/ParserError.mjs +0 -6
  99. package/src/errors/PluginError.cjs +0 -18
  100. package/src/errors/PluginError.mjs +0 -15
  101. package/src/errors/ResolveError.cjs +0 -10
  102. package/src/errors/ResolveError.mjs +0 -7
  103. package/src/errors/ResolverError.cjs +0 -11
  104. package/src/errors/ResolverError.mjs +0 -6
  105. package/src/errors/UnmatchedBundleStrategyError.cjs +0 -11
  106. package/src/errors/UnmatchedBundleStrategyError.mjs +0 -6
  107. package/src/errors/UnmatchedDereferenceStrategyError.cjs +0 -11
  108. package/src/errors/UnmatchedDereferenceStrategyError.mjs +0 -6
  109. package/src/errors/UnmatchedParserError.cjs +0 -11
  110. package/src/errors/UnmatchedParserError.mjs +0 -6
  111. package/src/errors/UnmatchedResolveStrategyError.cjs +0 -11
  112. package/src/errors/UnmatchedResolveStrategyError.mjs +0 -6
  113. package/src/errors/UnmatchedResolverError.cjs +0 -11
  114. package/src/errors/UnmatchedResolverError.mjs +0 -6
  115. package/src/errors/UnresolvableReferenceError.cjs +0 -11
  116. package/src/errors/UnresolvableReferenceError.mjs +0 -6
  117. package/src/index.cjs +0 -146
  118. package/src/index.mjs +0 -103
  119. package/src/options/index.cjs +0 -194
  120. package/src/options/index.mjs +0 -191
  121. package/src/options/util.cjs +0 -24
  122. package/src/options/util.mjs +0 -19
  123. package/src/parse/index.cjs +0 -69
  124. package/src/parse/index.mjs +0 -63
  125. package/src/parse/parsers/Parser.cjs +0 -62
  126. package/src/parse/parsers/Parser.mjs +0 -58
  127. package/src/parse/parsers/apidom-json/index.cjs +0 -70
  128. package/src/parse/parsers/apidom-json/index.mjs +0 -64
  129. package/src/parse/parsers/arazzo-json-1/index.cjs +0 -62
  130. package/src/parse/parsers/arazzo-json-1/index.mjs +0 -56
  131. package/src/parse/parsers/arazzo-json-1/source-descriptions.cjs +0 -221
  132. package/src/parse/parsers/arazzo-json-1/source-descriptions.mjs +0 -214
  133. package/src/parse/parsers/arazzo-yaml-1/index.cjs +0 -62
  134. package/src/parse/parsers/arazzo-yaml-1/index.mjs +0 -56
  135. package/src/parse/parsers/arazzo-yaml-1/source-descriptions.cjs +0 -12
  136. package/src/parse/parsers/arazzo-yaml-1/source-descriptions.mjs +0 -7
  137. package/src/parse/parsers/asyncapi-json-2/index.cjs +0 -54
  138. package/src/parse/parsers/asyncapi-json-2/index.mjs +0 -48
  139. package/src/parse/parsers/asyncapi-yaml-2/index.cjs +0 -54
  140. package/src/parse/parsers/asyncapi-yaml-2/index.mjs +0 -48
  141. package/src/parse/parsers/binary/index-browser.cjs +0 -56
  142. package/src/parse/parsers/binary/index-browser.mjs +0 -50
  143. package/src/parse/parsers/binary/index-node.cjs +0 -51
  144. package/src/parse/parsers/binary/index-node.mjs +0 -45
  145. package/src/parse/parsers/json/index.cjs +0 -53
  146. package/src/parse/parsers/json/index.mjs +0 -47
  147. package/src/parse/parsers/openapi-json-2/index.cjs +0 -54
  148. package/src/parse/parsers/openapi-json-2/index.mjs +0 -48
  149. package/src/parse/parsers/openapi-json-3-0/index.cjs +0 -54
  150. package/src/parse/parsers/openapi-json-3-0/index.mjs +0 -48
  151. package/src/parse/parsers/openapi-json-3-1/index.cjs +0 -54
  152. package/src/parse/parsers/openapi-json-3-1/index.mjs +0 -48
  153. package/src/parse/parsers/openapi-yaml-2/index.cjs +0 -54
  154. package/src/parse/parsers/openapi-yaml-2/index.mjs +0 -48
  155. package/src/parse/parsers/openapi-yaml-3-0/index.cjs +0 -54
  156. package/src/parse/parsers/openapi-yaml-3-0/index.mjs +0 -48
  157. package/src/parse/parsers/openapi-yaml-3-1/index.cjs +0 -54
  158. package/src/parse/parsers/openapi-yaml-3-1/index.mjs +0 -48
  159. package/src/parse/parsers/yaml-1-2/index.cjs +0 -56
  160. package/src/parse/parsers/yaml-1-2/index.mjs +0 -50
  161. package/src/resolve/index.cjs +0 -67
  162. package/src/resolve/index.mjs +0 -60
  163. package/src/resolve/resolvers/HTTPResolver.cjs +0 -45
  164. package/src/resolve/resolvers/HTTPResolver.mjs +0 -37
  165. package/src/resolve/resolvers/Resolver.cjs +0 -20
  166. package/src/resolve/resolvers/Resolver.mjs +0 -16
  167. package/src/resolve/resolvers/file/index-browser.cjs +0 -24
  168. package/src/resolve/resolvers/file/index-browser.mjs +0 -19
  169. package/src/resolve/resolvers/file/index-node.cjs +0 -49
  170. package/src/resolve/resolvers/file/index-node.mjs +0 -42
  171. package/src/resolve/resolvers/http-axios/cache/MemoryCache.cjs +0 -41
  172. package/src/resolve/resolvers/http-axios/cache/MemoryCache.mjs +0 -37
  173. package/src/resolve/resolvers/http-axios/index.cjs +0 -113
  174. package/src/resolve/resolvers/http-axios/index.mjs +0 -105
  175. package/src/resolve/strategies/ResolveStrategy.cjs +0 -20
  176. package/src/resolve/strategies/ResolveStrategy.mjs +0 -16
  177. package/src/resolve/strategies/apidom/index.cjs +0 -49
  178. package/src/resolve/strategies/apidom/index.mjs +0 -43
  179. package/src/resolve/strategies/asyncapi-2/index.cjs +0 -49
  180. package/src/resolve/strategies/asyncapi-2/index.mjs +0 -43
  181. package/src/resolve/strategies/openapi-2/index.cjs +0 -49
  182. package/src/resolve/strategies/openapi-2/index.mjs +0 -43
  183. package/src/resolve/strategies/openapi-3-0/index.cjs +0 -49
  184. package/src/resolve/strategies/openapi-3-0/index.mjs +0 -43
  185. package/src/resolve/strategies/openapi-3-1/index.cjs +0 -49
  186. package/src/resolve/strategies/openapi-3-1/index.mjs +0 -43
  187. package/src/resolve/util.cjs +0 -37
  188. package/src/resolve/util.mjs +0 -30
  189. package/src/util/plugins.cjs +0 -39
  190. package/src/util/plugins.mjs +0 -34
  191. package/src/util/url.cjs +0 -288
  192. package/src/util/url.mjs +0 -274
package/src/index.cjs DELETED
@@ -1,146 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
4
- var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
5
- exports.__esModule = true;
6
- exports.url = exports.resolveApiDOM = exports.resolve = exports.readFile = exports.parse = exports.options = exports.mergeOptions = exports.dereferenceApiDOM = exports.dereference = exports.bundle = exports.UnresolvableReferenceError = exports.UnmatchedResolverError = exports.UnmatchedResolveStrategyError = exports.UnmatchedParserError = exports.UnmatchedDereferenceStrategyError = exports.UnmatchedBundleStrategyError = exports.ResolverError = exports.Resolver = exports.ResolveStrategy = exports.ResolveError = exports.Reference = exports.PluginError = exports.ParserError = exports.Parser = exports.ParseError = exports.MaximumResolveDepthError = exports.MaximumDereferenceDepthError = exports.MaximumBundleDepthError = exports.JsonSchemaURIError = exports.JsonSchema$anchorError = exports.InvalidJsonSchema$anchorError = exports.HTTPResolver = exports.EvaluationJsonSchemaUriError = exports.EvaluationJsonSchema$anchorError = exports.EvaluationElementIdError = exports.DereferenceStrategy = exports.DereferenceError = exports.DereferenceAncestorLineage = exports.BundleStrategy = exports.BundleError = void 0;
7
- var _File = _interopRequireDefault(require("./File.cjs"));
8
- exports.File = _File.default;
9
- var _ReferenceSet = _interopRequireDefault(require("./ReferenceSet.cjs"));
10
- exports.ReferenceSet = _ReferenceSet.default;
11
- var url = _interopRequireWildcard(require("./util/url.cjs"));
12
- exports.url = url;
13
- var _index = _interopRequireDefault(require("./options/index.cjs"));
14
- exports.options = _index.default;
15
- var _util = require("./options/util.cjs");
16
- exports.mergeOptions = _util.merge;
17
- var _index2 = _interopRequireDefault(require("./parse/index.cjs"));
18
- var _index3 = _interopRequireWildcard(require("./resolve/index.cjs"));
19
- var _util2 = require("./resolve/util.cjs");
20
- var _index4 = _interopRequireWildcard(require("./dereference/index.cjs"));
21
- var _index5 = _interopRequireDefault(require("./bundle/index.cjs"));
22
- var _Parser = _interopRequireDefault(require("./parse/parsers/Parser.cjs"));
23
- exports.Parser = _Parser.default;
24
- var _Resolver = _interopRequireDefault(require("./resolve/resolvers/Resolver.cjs"));
25
- exports.Resolver = _Resolver.default;
26
- var _HTTPResolver = _interopRequireDefault(require("./resolve/resolvers/HTTPResolver.cjs"));
27
- exports.HTTPResolver = _HTTPResolver.default;
28
- var _ResolveStrategy = _interopRequireDefault(require("./resolve/strategies/ResolveStrategy.cjs"));
29
- exports.ResolveStrategy = _ResolveStrategy.default;
30
- var _DereferenceStrategy = _interopRequireDefault(require("./dereference/strategies/DereferenceStrategy.cjs"));
31
- exports.DereferenceStrategy = _DereferenceStrategy.default;
32
- var _util3 = require("./dereference/util.cjs");
33
- exports.DereferenceAncestorLineage = _util3.AncestorLineage;
34
- var _BundleStrategy = _interopRequireDefault(require("./bundle/strategies/BundleStrategy.cjs"));
35
- exports.BundleStrategy = _BundleStrategy.default;
36
- var _Reference = _interopRequireDefault(require("./Reference.cjs"));
37
- exports.Reference = _Reference.default;
38
- var _BundleError = _interopRequireDefault(require("./errors/BundleError.cjs"));
39
- exports.BundleError = _BundleError.default;
40
- var _MaximumBundleDepthError = _interopRequireDefault(require("./errors/MaximumBundleDepthError.cjs"));
41
- exports.MaximumBundleDepthError = _MaximumBundleDepthError.default;
42
- var _UnmatchedBundleStrategyError = _interopRequireDefault(require("./errors/UnmatchedBundleStrategyError.cjs"));
43
- exports.UnmatchedBundleStrategyError = _UnmatchedBundleStrategyError.default;
44
- var _DereferenceError = _interopRequireDefault(require("./errors/DereferenceError.cjs"));
45
- exports.DereferenceError = _DereferenceError.default;
46
- var _UnresolvableReferenceError = _interopRequireDefault(require("./errors/UnresolvableReferenceError.cjs"));
47
- exports.UnresolvableReferenceError = _UnresolvableReferenceError.default;
48
- var _EvaluationElementIdError = _interopRequireDefault(require("./errors/EvaluationElementIdError.cjs"));
49
- exports.EvaluationElementIdError = _EvaluationElementIdError.default;
50
- var _EvaluationJsonSchema$anchorError = _interopRequireDefault(require("./errors/EvaluationJsonSchema$anchorError.cjs"));
51
- exports.EvaluationJsonSchema$anchorError = _EvaluationJsonSchema$anchorError.default;
52
- var _EvaluationJsonSchemaUriError = _interopRequireDefault(require("./errors/EvaluationJsonSchemaUriError.cjs"));
53
- exports.EvaluationJsonSchemaUriError = _EvaluationJsonSchemaUriError.default;
54
- var _InvalidJsonSchema$anchorError = _interopRequireDefault(require("./errors/InvalidJsonSchema$anchorError.cjs"));
55
- exports.InvalidJsonSchema$anchorError = _InvalidJsonSchema$anchorError.default;
56
- var _JsonSchema$anchorError = _interopRequireDefault(require("./errors/JsonSchema$anchorError.cjs"));
57
- exports.JsonSchema$anchorError = _JsonSchema$anchorError.default;
58
- var _JsonSchemaUriError = _interopRequireDefault(require("./errors/JsonSchemaUriError.cjs"));
59
- exports.JsonSchemaURIError = _JsonSchemaUriError.default;
60
- var _MaximumDereferenceDepthError = _interopRequireDefault(require("./errors/MaximumDereferenceDepthError.cjs"));
61
- exports.MaximumDereferenceDepthError = _MaximumDereferenceDepthError.default;
62
- var _MaximumResolveDepthError = _interopRequireDefault(require("./errors/MaximumResolveDepthError.cjs"));
63
- exports.MaximumResolveDepthError = _MaximumResolveDepthError.default;
64
- var _ParseError = _interopRequireDefault(require("./errors/ParseError.cjs"));
65
- exports.ParseError = _ParseError.default;
66
- var _ParserError = _interopRequireDefault(require("./errors/ParserError.cjs"));
67
- exports.ParserError = _ParserError.default;
68
- var _PluginError = _interopRequireDefault(require("./errors/PluginError.cjs"));
69
- exports.PluginError = _PluginError.default;
70
- var _ResolveError = _interopRequireDefault(require("./errors/ResolveError.cjs"));
71
- exports.ResolveError = _ResolveError.default;
72
- var _ResolverError = _interopRequireDefault(require("./errors/ResolverError.cjs"));
73
- exports.ResolverError = _ResolverError.default;
74
- var _UnmatchedDereferenceStrategyError = _interopRequireDefault(require("./errors/UnmatchedDereferenceStrategyError.cjs"));
75
- exports.UnmatchedDereferenceStrategyError = _UnmatchedDereferenceStrategyError.default;
76
- var _UnmatchedResolveStrategyError = _interopRequireDefault(require("./errors/UnmatchedResolveStrategyError.cjs"));
77
- exports.UnmatchedResolveStrategyError = _UnmatchedResolveStrategyError.default;
78
- var _UnmatchedResolverError = _interopRequireDefault(require("./errors/UnmatchedResolverError.cjs"));
79
- exports.UnmatchedResolverError = _UnmatchedResolverError.default;
80
- var _UnmatchedParserError = _interopRequireDefault(require("./errors/UnmatchedParserError.cjs"));
81
- exports.UnmatchedParserError = _UnmatchedParserError.default;
82
- /**
83
- * @public
84
- */
85
- const readFile = async (uri, options = {}) => {
86
- const mergedOptions = (0, _util.merge)(_index.default, options);
87
- const file = new _File.default({
88
- uri: url.sanitize(uri)
89
- });
90
- return (0, _util2.readFile)(file, mergedOptions);
91
- };
92
-
93
- /**
94
- * @public
95
- */
96
- exports.readFile = readFile;
97
- const parse = async (uri, options = {}) => {
98
- const mergedOptions = (0, _util.merge)(_index.default, options);
99
- return (0, _index2.default)(uri, mergedOptions);
100
- };
101
-
102
- /**
103
- * @public
104
- */
105
- exports.parse = parse;
106
- const resolve = async (uri, options = {}) => {
107
- const mergedOptions = (0, _util.merge)(_index.default, options);
108
- return (0, _index3.default)(uri, mergedOptions);
109
- };
110
-
111
- /**
112
- * @public
113
- */
114
- exports.resolve = resolve;
115
- const resolveApiDOM = async (element, options = {}) => {
116
- const mergedOptions = (0, _util.merge)(_index.default, options);
117
- return (0, _index3.resolveApiDOM)(element, mergedOptions);
118
- };
119
-
120
- /**
121
- * @public
122
- */
123
- exports.resolveApiDOM = resolveApiDOM;
124
- const dereference = async (uri, options = {}) => {
125
- const mergedOptions = (0, _util.merge)(_index.default, options);
126
- return (0, _index4.default)(uri, mergedOptions);
127
- };
128
-
129
- /**
130
- * @public
131
- */
132
- exports.dereference = dereference;
133
- const dereferenceApiDOM = async (element, options = {}) => {
134
- const mergedOptions = (0, _util.merge)(_index.default, options);
135
- return (0, _index4.dereferenceApiDOM)(element, mergedOptions);
136
- };
137
-
138
- /**
139
- * @public
140
- */
141
- exports.dereferenceApiDOM = dereferenceApiDOM;
142
- const bundle = async (uri, options = {}) => {
143
- const mergedOptions = (0, _util.merge)(_index.default, options);
144
- return (0, _index5.default)(uri, mergedOptions);
145
- };
146
- exports.bundle = bundle;
package/src/index.mjs DELETED
@@ -1,103 +0,0 @@
1
- import File from "./File.mjs";
2
- import ReferenceSet from "./ReferenceSet.mjs";
3
- import * as url from "./util/url.mjs";
4
- import defaultOptions from "./options/index.mjs";
5
- import { merge as mergeOptions } from "./options/util.mjs";
6
- import parseFn from "./parse/index.mjs";
7
- import resolveFn, { resolveApiDOM as resolveApiDOMFn } from "./resolve/index.mjs";
8
- import { readFile as readFileFn } from "./resolve/util.mjs";
9
- import dereferenceFn, { dereferenceApiDOM as dereferenceApiDOMFn } from "./dereference/index.mjs";
10
- import bundleFn from "./bundle/index.mjs";
11
- export { url };
12
- export { default as Parser } from "./parse/parsers/Parser.mjs";
13
- export { default as Resolver } from "./resolve/resolvers/Resolver.mjs";
14
- export { default as HTTPResolver } from "./resolve/resolvers/HTTPResolver.mjs";
15
- export { default as ResolveStrategy } from "./resolve/strategies/ResolveStrategy.mjs";
16
- export { default as DereferenceStrategy } from "./dereference/strategies/DereferenceStrategy.mjs";
17
- export { AncestorLineage as DereferenceAncestorLineage } from "./dereference/util.mjs";
18
- export { default as BundleStrategy } from "./bundle/strategies/BundleStrategy.mjs";
19
- export { default as options } from "./options/index.mjs";
20
- export { merge as mergeOptions } from "./options/util.mjs";
21
- export { File };
22
- export { default as Reference } from "./Reference.mjs";
23
- export { ReferenceSet };
24
- export { default as BundleError } from "./errors/BundleError.mjs";
25
- export { default as MaximumBundleDepthError } from "./errors/MaximumBundleDepthError.mjs";
26
- export { default as UnmatchedBundleStrategyError } from "./errors/UnmatchedBundleStrategyError.mjs";
27
- export { default as DereferenceError } from "./errors/DereferenceError.mjs";
28
- export { default as UnresolvableReferenceError } from "./errors/UnresolvableReferenceError.mjs";
29
- export { default as EvaluationElementIdError } from "./errors/EvaluationElementIdError.mjs";
30
- export { default as EvaluationJsonSchema$anchorError } from "./errors/EvaluationJsonSchema$anchorError.mjs";
31
- export { default as EvaluationJsonSchemaUriError } from "./errors/EvaluationJsonSchemaUriError.mjs";
32
- export { default as InvalidJsonSchema$anchorError } from "./errors/InvalidJsonSchema$anchorError.mjs";
33
- export { default as JsonSchema$anchorError } from "./errors/JsonSchema$anchorError.mjs";
34
- export { default as JsonSchemaURIError } from "./errors/JsonSchemaUriError.mjs";
35
- export { default as MaximumDereferenceDepthError } from "./errors/MaximumDereferenceDepthError.mjs";
36
- export { default as MaximumResolveDepthError } from "./errors/MaximumResolveDepthError.mjs";
37
- export { default as ParseError } from "./errors/ParseError.mjs";
38
- export { default as ParserError } from "./errors/ParserError.mjs";
39
- export { default as PluginError } from "./errors/PluginError.mjs";
40
- export { default as ResolveError } from "./errors/ResolveError.mjs";
41
- export { default as ResolverError } from "./errors/ResolverError.mjs";
42
- export { default as UnmatchedDereferenceStrategyError } from "./errors/UnmatchedDereferenceStrategyError.mjs";
43
- export { default as UnmatchedResolveStrategyError } from "./errors/UnmatchedResolveStrategyError.mjs";
44
- export { default as UnmatchedResolverError } from "./errors/UnmatchedResolverError.mjs";
45
- export { default as UnmatchedParserError } from "./errors/UnmatchedParserError.mjs";
46
- /**
47
- * @public
48
- */
49
- export const readFile = async (uri, options = {}) => {
50
- const mergedOptions = mergeOptions(defaultOptions, options);
51
- const file = new File({
52
- uri: url.sanitize(uri)
53
- });
54
- return readFileFn(file, mergedOptions);
55
- };
56
-
57
- /**
58
- * @public
59
- */
60
- export const parse = async (uri, options = {}) => {
61
- const mergedOptions = mergeOptions(defaultOptions, options);
62
- return parseFn(uri, mergedOptions);
63
- };
64
-
65
- /**
66
- * @public
67
- */
68
- export const resolve = async (uri, options = {}) => {
69
- const mergedOptions = mergeOptions(defaultOptions, options);
70
- return resolveFn(uri, mergedOptions);
71
- };
72
-
73
- /**
74
- * @public
75
- */
76
- export const resolveApiDOM = async (element, options = {}) => {
77
- const mergedOptions = mergeOptions(defaultOptions, options);
78
- return resolveApiDOMFn(element, mergedOptions);
79
- };
80
-
81
- /**
82
- * @public
83
- */
84
- export const dereference = async (uri, options = {}) => {
85
- const mergedOptions = mergeOptions(defaultOptions, options);
86
- return dereferenceFn(uri, mergedOptions);
87
- };
88
-
89
- /**
90
- * @public
91
- */
92
- export const dereferenceApiDOM = async (element, options = {}) => {
93
- const mergedOptions = mergeOptions(defaultOptions, options);
94
- return dereferenceApiDOMFn(element, mergedOptions);
95
- };
96
-
97
- /**
98
- * @public
99
- */
100
- export const bundle = async (uri, options = {}) => {
101
- const mergedOptions = mergeOptions(defaultOptions, options);
102
- return bundleFn(uri, mergedOptions);
103
- };
@@ -1,194 +0,0 @@
1
- "use strict";
2
-
3
- exports.__esModule = true;
4
- exports.default = void 0;
5
- var _ramda = require("ramda");
6
- /**
7
- * @public
8
- */
9
-
10
- /**
11
- * @public
12
- */
13
-
14
- /**
15
- * @public
16
- */
17
-
18
- /**
19
- * @public
20
- */
21
-
22
- /**
23
- * @public
24
- */
25
-
26
- /**
27
- * @public
28
- */
29
- const defaultOptions = {
30
- parse: {
31
- /**
32
- * This is media type that will be used to parse the input.
33
- */
34
- mediaType: 'text/plain',
35
- /**
36
- * Determines how different types of files will be parsed.
37
- *
38
- * You can add additional parsers of your own, replace an existing one with
39
- * your own implementation, or remove any resolver by removing it from the list.
40
- * It's recommended to keep the order of parser from most specific ones to most generic ones.
41
- */
42
- parsers: [],
43
- /**
44
- * These options are merged with parser plugin instance before the plugin is run.
45
- */
46
- parserOpts: {}
47
- },
48
- resolve: {
49
- /**
50
- * baseURI serves as a base for all relative URL found in ApiDOM references.
51
- */
52
- baseURI: '',
53
- /**
54
- * Determines how References will be resolved.
55
- *
56
- * You can add additional resolvers of your own, replace an existing one with
57
- * your own implementation, or remove any resolver by removing it from the list.
58
- */
59
- resolvers: [],
60
- /**
61
- * These options are merged with resolver plugin instance before the plugin is run.
62
- */
63
- resolverOpts: {},
64
- /**
65
- * Determines strategies how References are identified and processed by resolvers.
66
- * Strategy is determined by media type.
67
- *
68
- * You can add additional resolver strategies of your own, replace an existing one with
69
- * your own implementation, or remove any resolve strategy by removing it from the list.
70
- */
71
- strategies: [],
72
- /**
73
- * These options are available in resolver strategy `canResolve` and `resolve` methods.
74
- */
75
- strategyOpts: {},
76
- /**
77
- * Determines whether internal references will be resolved.
78
- * Internal references will simply be ignored.
79
- */
80
- internal: true,
81
- /**
82
- * Determines whether external references will be resolved.
83
- * If this option is disabled, then none of above resolvers will be called.
84
- * Instead, external references will simply be ignored.
85
- */
86
- external: true,
87
- /**
88
- * Determines the maximum depth of resolve algorithms.
89
- * By default, there is no limit.
90
- *
91
- * This option tracks the depth of the file tree not the depth of the dereference path.
92
- *
93
- * It can be set to any positive integer number or zero (0).
94
- *
95
- * The resolver should throw MaximumResolverDepthError if resolution depth
96
- * is exceeded by this option.
97
- */
98
- maxDepth: +Infinity
99
- },
100
- dereference: {
101
- /**
102
- * Determines strategies how ApiDOM is dereferenced.
103
- * Strategy is determined by media type or by inspecting ApiDOM to be dereferenced.
104
- *
105
- * You can add additional dereference strategies of your own, replace an existing one with
106
- * your own implementation, or remove any dereference strategy by removing it from the list.
107
- */
108
- strategies: [],
109
- /**
110
- * These options are available in dereference strategy `canDereference` and `dereference` methods.
111
- */
112
- strategyOpts: {},
113
- /**
114
- * This option accepts an instance of pre-computed ReferenceSet.
115
- * If provided it will speed up the dereferencing significantly as the external
116
- * resolution doesn't need to happen anymore.
117
- */
118
- refSet: null,
119
- /**
120
- * Determines the maximum depth of dereferencing.
121
- * By default, there is no limit.
122
- *
123
- * The maxDepth represents a number of references that needed to be followed
124
- * before the eventual value was reached.
125
- *
126
- * It can be set to any positive integer number or zero (0).
127
- *
128
- * The dereferencing should throw MaximumDereferenceDepthError if dereferencing depth
129
- * is exceeded by this option.
130
- */
131
- maxDepth: +Infinity,
132
- /**
133
- * Determines how circular references are handled.
134
- *
135
- * "ignore" - circular reference are allowed
136
- * "replace" - circular references are not allowed and are translated to RefElement
137
- * "error" - circular references are not allowed and will throw an error
138
- */
139
- circular: 'ignore',
140
- /**
141
- * This function is used to replace circular references when `circular` option is set to "replace".
142
- * By default, it's an identity function. It means that circular references are replaced with RefElement.
143
- */
144
- circularReplacer: _ramda.identity,
145
- /**
146
- * Determines whether the dereferencing process will be immutable.
147
- * By default, the dereferencing process is immutable, which means that the original
148
- * ApiDOM passed to the dereference process is NOT modified.
149
- *
150
- * true - the dereferencing process will be immutable (deep cloning of ApiDOM is involved)
151
- * false - the dereferencing process will be mutable
152
- */
153
- immutable: true,
154
- /**
155
- * Controls error handling during dereferencing.
156
- *
157
- * false - fail fast, throw on first error (default)
158
- * true - skip unresolvable references silently, continue dereferencing
159
- * (error) => void - callback invoked for each error; if the callback
160
- * itself throws, dereferencing stops with that error
161
- */
162
- continueOnError: false
163
- },
164
- bundle: {
165
- /**
166
- * Determines strategies how ApiDOM is bundled.
167
- * Strategy is determined by media type or by inspecting ApiDOM to be bundled.
168
- *
169
- * You can add additional bundle strategies of your own, replace an existing one with
170
- * your own implementation, or remove any bundle strategy by removing it from the list.
171
- */
172
- strategies: [],
173
- /**
174
- * This option accepts an instance of pre-computed ReferenceSet.
175
- * If provided it will speed up the bundling significantly as the external
176
- * resolution doesn't need to happen anymore.
177
- */
178
- refSet: null,
179
- /**
180
- * Determines the maximum depth of bundling.
181
- * By default, there is no limit.
182
- *
183
- * The maxDepth represents a number of references that needed to be followed
184
- * before the eventual value was reached.
185
- *
186
- * It can be set to any positive integer number or zero (0).
187
- *
188
- * The bundling should throw MaximumBundleDepthError if bundling depth
189
- * is exceeded by this option.
190
- */
191
- maxDepth: +Infinity
192
- }
193
- };
194
- var _default = exports.default = defaultOptions;
@@ -1,191 +0,0 @@
1
- import { identity } from 'ramda';
2
-
3
- /**
4
- * @public
5
- */
6
-
7
- /**
8
- * @public
9
- */
10
-
11
- /**
12
- * @public
13
- */
14
-
15
- /**
16
- * @public
17
- */
18
-
19
- /**
20
- * @public
21
- */
22
-
23
- /**
24
- * @public
25
- */
26
- const defaultOptions = {
27
- parse: {
28
- /**
29
- * This is media type that will be used to parse the input.
30
- */
31
- mediaType: 'text/plain',
32
- /**
33
- * Determines how different types of files will be parsed.
34
- *
35
- * You can add additional parsers of your own, replace an existing one with
36
- * your own implementation, or remove any resolver by removing it from the list.
37
- * It's recommended to keep the order of parser from most specific ones to most generic ones.
38
- */
39
- parsers: [],
40
- /**
41
- * These options are merged with parser plugin instance before the plugin is run.
42
- */
43
- parserOpts: {}
44
- },
45
- resolve: {
46
- /**
47
- * baseURI serves as a base for all relative URL found in ApiDOM references.
48
- */
49
- baseURI: '',
50
- /**
51
- * Determines how References will be resolved.
52
- *
53
- * You can add additional resolvers of your own, replace an existing one with
54
- * your own implementation, or remove any resolver by removing it from the list.
55
- */
56
- resolvers: [],
57
- /**
58
- * These options are merged with resolver plugin instance before the plugin is run.
59
- */
60
- resolverOpts: {},
61
- /**
62
- * Determines strategies how References are identified and processed by resolvers.
63
- * Strategy is determined by media type.
64
- *
65
- * You can add additional resolver strategies of your own, replace an existing one with
66
- * your own implementation, or remove any resolve strategy by removing it from the list.
67
- */
68
- strategies: [],
69
- /**
70
- * These options are available in resolver strategy `canResolve` and `resolve` methods.
71
- */
72
- strategyOpts: {},
73
- /**
74
- * Determines whether internal references will be resolved.
75
- * Internal references will simply be ignored.
76
- */
77
- internal: true,
78
- /**
79
- * Determines whether external references will be resolved.
80
- * If this option is disabled, then none of above resolvers will be called.
81
- * Instead, external references will simply be ignored.
82
- */
83
- external: true,
84
- /**
85
- * Determines the maximum depth of resolve algorithms.
86
- * By default, there is no limit.
87
- *
88
- * This option tracks the depth of the file tree not the depth of the dereference path.
89
- *
90
- * It can be set to any positive integer number or zero (0).
91
- *
92
- * The resolver should throw MaximumResolverDepthError if resolution depth
93
- * is exceeded by this option.
94
- */
95
- maxDepth: +Infinity
96
- },
97
- dereference: {
98
- /**
99
- * Determines strategies how ApiDOM is dereferenced.
100
- * Strategy is determined by media type or by inspecting ApiDOM to be dereferenced.
101
- *
102
- * You can add additional dereference strategies of your own, replace an existing one with
103
- * your own implementation, or remove any dereference strategy by removing it from the list.
104
- */
105
- strategies: [],
106
- /**
107
- * These options are available in dereference strategy `canDereference` and `dereference` methods.
108
- */
109
- strategyOpts: {},
110
- /**
111
- * This option accepts an instance of pre-computed ReferenceSet.
112
- * If provided it will speed up the dereferencing significantly as the external
113
- * resolution doesn't need to happen anymore.
114
- */
115
- refSet: null,
116
- /**
117
- * Determines the maximum depth of dereferencing.
118
- * By default, there is no limit.
119
- *
120
- * The maxDepth represents a number of references that needed to be followed
121
- * before the eventual value was reached.
122
- *
123
- * It can be set to any positive integer number or zero (0).
124
- *
125
- * The dereferencing should throw MaximumDereferenceDepthError if dereferencing depth
126
- * is exceeded by this option.
127
- */
128
- maxDepth: +Infinity,
129
- /**
130
- * Determines how circular references are handled.
131
- *
132
- * "ignore" - circular reference are allowed
133
- * "replace" - circular references are not allowed and are translated to RefElement
134
- * "error" - circular references are not allowed and will throw an error
135
- */
136
- circular: 'ignore',
137
- /**
138
- * This function is used to replace circular references when `circular` option is set to "replace".
139
- * By default, it's an identity function. It means that circular references are replaced with RefElement.
140
- */
141
- circularReplacer: identity,
142
- /**
143
- * Determines whether the dereferencing process will be immutable.
144
- * By default, the dereferencing process is immutable, which means that the original
145
- * ApiDOM passed to the dereference process is NOT modified.
146
- *
147
- * true - the dereferencing process will be immutable (deep cloning of ApiDOM is involved)
148
- * false - the dereferencing process will be mutable
149
- */
150
- immutable: true,
151
- /**
152
- * Controls error handling during dereferencing.
153
- *
154
- * false - fail fast, throw on first error (default)
155
- * true - skip unresolvable references silently, continue dereferencing
156
- * (error) => void - callback invoked for each error; if the callback
157
- * itself throws, dereferencing stops with that error
158
- */
159
- continueOnError: false
160
- },
161
- bundle: {
162
- /**
163
- * Determines strategies how ApiDOM is bundled.
164
- * Strategy is determined by media type or by inspecting ApiDOM to be bundled.
165
- *
166
- * You can add additional bundle strategies of your own, replace an existing one with
167
- * your own implementation, or remove any bundle strategy by removing it from the list.
168
- */
169
- strategies: [],
170
- /**
171
- * This option accepts an instance of pre-computed ReferenceSet.
172
- * If provided it will speed up the bundling significantly as the external
173
- * resolution doesn't need to happen anymore.
174
- */
175
- refSet: null,
176
- /**
177
- * Determines the maximum depth of bundling.
178
- * By default, there is no limit.
179
- *
180
- * The maxDepth represents a number of references that needed to be followed
181
- * before the eventual value was reached.
182
- *
183
- * It can be set to any positive integer number or zero (0).
184
- *
185
- * The bundling should throw MaximumBundleDepthError if bundling depth
186
- * is exceeded by this option.
187
- */
188
- maxDepth: +Infinity
189
- }
190
- };
191
- export default defaultOptions;
@@ -1,24 +0,0 @@
1
- "use strict";
2
-
3
- exports.__esModule = true;
4
- exports.merge = void 0;
5
- var _ramda = require("ramda");
6
- var _ramdaAdjunct = require("ramda-adjunct");
7
- var _url = require("../util/url.cjs");
8
- /**
9
- * Algorithm for deep merging options.
10
- */
11
-
12
- const baseURILens = (0, _ramda.lens)((0, _ramda.path)(['resolve', 'baseURI']), (0, _ramda.assocPath)(['resolve', 'baseURI']));
13
- const baseURIDefault = baseURI => (0, _ramdaAdjunct.isEmptyString)(baseURI) ? (0, _url.cwd)() : baseURI;
14
-
15
- /**
16
- * @public
17
- */
18
-
19
- const merge = (lObj, rObj) => {
20
- const withoutDefaults = (0, _ramda.mergeDeepRight)(lObj, rObj);
21
- // @ts-ignore
22
- return (0, _ramda.over)(baseURILens, baseURIDefault, withoutDefaults);
23
- };
24
- exports.merge = merge;
@@ -1,19 +0,0 @@
1
- import { mergeDeepRight, lens, path, assocPath, over } from 'ramda';
2
- import { isEmptyString } from 'ramda-adjunct';
3
- import { cwd } from "../util/url.mjs";
4
- /**
5
- * Algorithm for deep merging options.
6
- */
7
-
8
- const baseURILens = lens(path(['resolve', 'baseURI']), assocPath(['resolve', 'baseURI']));
9
- const baseURIDefault = baseURI => isEmptyString(baseURI) ? cwd() : baseURI;
10
-
11
- /**
12
- * @public
13
- */
14
-
15
- export const merge = (lObj, rObj) => {
16
- const withoutDefaults = mergeDeepRight(lObj, rObj);
17
- // @ts-ignore
18
- return over(baseURILens, baseURIDefault, withoutDefaults);
19
- };