@speclynx/apidom-ns-openapi-3-1 1.12.2 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/NOTICE +16 -7
  3. package/README.md +16 -29
  4. package/dist/apidom-ns-openapi-3-1.browser.js +11148 -16196
  5. package/dist/apidom-ns-openapi-3-1.browser.min.js +1 -1
  6. package/package.json +11 -11
  7. package/src/elements/JsonSchemaDialect.cjs +2 -2
  8. package/src/elements/JsonSchemaDialect.mjs +1 -1
  9. package/src/elements/OpenApi3-1.cjs +2 -2
  10. package/src/elements/OpenApi3-1.mjs +1 -1
  11. package/src/elements/PathItem.cjs +24 -24
  12. package/src/elements/PathItem.mjs +24 -24
  13. package/src/elements/nces/ComponentsPathItems.cjs +2 -2
  14. package/src/elements/nces/ComponentsPathItems.mjs +1 -1
  15. package/src/elements/nces/Webhooks.cjs +2 -2
  16. package/src/elements/nces/Webhooks.mjs +1 -1
  17. package/src/index.cjs +73 -49
  18. package/src/index.mjs +6 -3
  19. package/src/namespace.cjs +0 -1
  20. package/src/predicates.cjs +56 -187
  21. package/src/predicates.mjs +29 -186
  22. package/src/refractor/index.cjs +338 -17
  23. package/src/refractor/index.mjs +305 -16
  24. package/src/refractor/inspect.cjs +207 -0
  25. package/src/refractor/inspect.mjs +171 -0
  26. package/src/refractor/plugins/normalize-header-examples/NormalizeStorage.cjs +5 -5
  27. package/src/refractor/plugins/normalize-header-examples/NormalizeStorage.mjs +1 -1
  28. package/src/refractor/plugins/normalize-header-examples/index.cjs +11 -7
  29. package/src/refractor/plugins/normalize-header-examples/index.mjs +8 -4
  30. package/src/refractor/plugins/normalize-operation-ids.cjs +13 -6
  31. package/src/refractor/plugins/normalize-operation-ids.mjs +13 -6
  32. package/src/refractor/plugins/normalize-parameter-examples.cjs +11 -7
  33. package/src/refractor/plugins/normalize-parameter-examples.mjs +8 -4
  34. package/src/refractor/plugins/normalize-parameters.cjs +11 -5
  35. package/src/refractor/plugins/normalize-parameters.mjs +11 -5
  36. package/src/refractor/plugins/normalize-security-requirements.cjs +8 -4
  37. package/src/refractor/plugins/normalize-security-requirements.mjs +8 -4
  38. package/src/refractor/plugins/normalize-servers.cjs +15 -9
  39. package/src/refractor/plugins/normalize-servers.mjs +15 -9
  40. package/src/refractor/plugins/replace-empty-element.cjs +32 -30
  41. package/src/refractor/plugins/replace-empty-element.mjs +16 -15
  42. package/src/refractor/predicates.cjs +36 -0
  43. package/src/refractor/predicates.mjs +31 -0
  44. package/src/refractor/specification.cjs +43 -4
  45. package/src/refractor/specification.mjs +43 -4
  46. package/src/refractor/toolbox.cjs +12 -21
  47. package/src/refractor/toolbox.mjs +9 -16
  48. package/src/refractor/visitors/open-api-3-1/JsonSchemaDialectVisitor.cjs +5 -5
  49. package/src/refractor/visitors/open-api-3-1/JsonSchemaDialectVisitor.mjs +6 -6
  50. package/src/refractor/visitors/open-api-3-1/OpenapiVisitor.cjs +25 -0
  51. package/src/refractor/visitors/open-api-3-1/OpenapiVisitor.mjs +19 -0
  52. package/src/refractor/visitors/open-api-3-1/WebhooksVisitor.cjs +4 -5
  53. package/src/refractor/visitors/open-api-3-1/WebhooksVisitor.mjs +5 -6
  54. package/src/refractor/visitors/open-api-3-1/bases.cjs +46 -0
  55. package/src/refractor/visitors/open-api-3-1/bases.mjs +43 -0
  56. package/src/refractor/visitors/open-api-3-1/callback/index.cjs +2 -3
  57. package/src/refractor/visitors/open-api-3-1/callback/index.mjs +2 -3
  58. package/src/refractor/visitors/open-api-3-1/components/PathItemsVisitor.cjs +4 -5
  59. package/src/refractor/visitors/open-api-3-1/components/PathItemsVisitor.mjs +5 -6
  60. package/src/refractor/visitors/open-api-3-1/components/SchemasVisitor.cjs +2 -2
  61. package/src/refractor/visitors/open-api-3-1/components/SchemasVisitor.mjs +3 -5
  62. package/src/refractor/visitors/open-api-3-1/index.cjs +5 -4
  63. package/src/refractor/visitors/open-api-3-1/index.mjs +6 -5
  64. package/src/refractor/visitors/open-api-3-1/schema/index.cjs +11 -10
  65. package/src/refractor/visitors/open-api-3-1/schema/index.mjs +12 -11
  66. package/types/apidom-ns-openapi-3-1.d.ts +435 -274
  67. package/src/refractor/registration.cjs +0 -102
  68. package/src/refractor/registration.mjs +0 -66
  69. package/src/traversal/visitor.cjs +0 -57
  70. package/src/traversal/visitor.mjs +0 -54
@@ -3,6 +3,7 @@
3
3
  var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
4
4
  exports.__esModule = true;
5
5
  exports.isServerVariableElement = exports.isServerElement = exports.isSecuritySchemeElement = exports.isSecurityRequirementElement = exports.isSchemaElement = exports.isResponsesElement = exports.isResponseElement = exports.isRequestBodyElement = exports.isReferenceElementExternal = exports.isReferenceElement = exports.isPathsElement = exports.isPathItemElementExternal = exports.isPathItemElement = exports.isParameterElement = exports.isOperationElement = exports.isOpenapiElement = exports.isOpenApi3_1Element = exports.isMediaTypeElement = exports.isLinkElement = exports.isLicenseElement = exports.isJsonSchemaDialectElement = exports.isInfoElement = exports.isHeaderElement = exports.isExternalDocumentationElement = exports.isExampleElement = exports.isContactElement = exports.isComponentsElement = exports.isCallbackElement = exports.isBooleanJsonSchemaElement = void 0;
6
+ var _apidomDatamodel = require("@speclynx/apidom-datamodel");
6
7
  var _apidomCore = require("@speclynx/apidom-core");
7
8
  var _Callback = _interopRequireDefault(require("./elements/Callback.cjs"));
8
9
  var _Components = _interopRequireDefault(require("./elements/Components.cjs"));
@@ -33,169 +34,91 @@ var _MediaType = _interopRequireDefault(require("./elements/MediaType.cjs"));
33
34
  /**
34
35
  * @public
35
36
  */
36
- const isCallbackElement = exports.isCallbackElement = (0, _apidomCore.createPredicate)(({
37
- hasBasicElementProps,
38
- isElementType,
39
- primitiveEq
40
- }) => {
41
- return element => element instanceof _Callback.default || hasBasicElementProps(element) && isElementType('callback', element) && primitiveEq('object', element);
42
- });
37
+ const isCallbackElement = element => element instanceof _Callback.default;
43
38
 
44
39
  /**
45
40
  * @public
46
41
  */
47
- const isComponentsElement = exports.isComponentsElement = (0, _apidomCore.createPredicate)(({
48
- hasBasicElementProps,
49
- isElementType,
50
- primitiveEq
51
- }) => {
52
- return element => element instanceof _Components.default || hasBasicElementProps(element) && isElementType('components', element) && primitiveEq('object', element);
53
- });
42
+ exports.isCallbackElement = isCallbackElement;
43
+ const isComponentsElement = element => element instanceof _Components.default;
54
44
 
55
45
  /**
56
46
  * @public
57
47
  */
58
- const isContactElement = exports.isContactElement = (0, _apidomCore.createPredicate)(({
59
- hasBasicElementProps,
60
- isElementType,
61
- primitiveEq
62
- }) => {
63
- return element => element instanceof _Contact.default || hasBasicElementProps(element) && isElementType('contact', element) && primitiveEq('object', element);
64
- });
48
+ exports.isComponentsElement = isComponentsElement;
49
+ const isContactElement = element => element instanceof _Contact.default;
65
50
 
66
51
  /**
67
52
  * @public
68
53
  */
69
- const isExampleElement = exports.isExampleElement = (0, _apidomCore.createPredicate)(({
70
- hasBasicElementProps,
71
- isElementType,
72
- primitiveEq
73
- }) => {
74
- return element => element instanceof _Example.default || hasBasicElementProps(element) && isElementType('example', element) && primitiveEq('object', element);
75
- });
54
+ exports.isContactElement = isContactElement;
55
+ const isExampleElement = element => element instanceof _Example.default;
76
56
 
77
57
  /**
78
58
  * @public
79
59
  */
80
- const isExternalDocumentationElement = exports.isExternalDocumentationElement = (0, _apidomCore.createPredicate)(({
81
- hasBasicElementProps,
82
- isElementType,
83
- primitiveEq
84
- }) => {
85
- return element => element instanceof _ExternalDocumentation.default || hasBasicElementProps(element) && isElementType('externalDocumentation', element) && primitiveEq('object', element);
86
- });
60
+ exports.isExampleElement = isExampleElement;
61
+ const isExternalDocumentationElement = element => element instanceof _ExternalDocumentation.default;
87
62
 
88
63
  /**
89
64
  * @public
90
65
  */
91
- const isHeaderElement = exports.isHeaderElement = (0, _apidomCore.createPredicate)(({
92
- hasBasicElementProps,
93
- isElementType,
94
- primitiveEq
95
- }) => {
96
- return element => element instanceof _Header.default || hasBasicElementProps(element) && isElementType('header', element) && primitiveEq('object', element);
97
- });
66
+ exports.isExternalDocumentationElement = isExternalDocumentationElement;
67
+ const isHeaderElement = element => element instanceof _Header.default;
98
68
 
99
69
  /**
100
70
  * @public
101
71
  */
102
- const isInfoElement = exports.isInfoElement = (0, _apidomCore.createPredicate)(({
103
- hasBasicElementProps,
104
- isElementType,
105
- primitiveEq
106
- }) => {
107
- return element => element instanceof _Info.default || hasBasicElementProps(element) && isElementType('info', element) && primitiveEq('object', element);
108
- });
72
+ exports.isHeaderElement = isHeaderElement;
73
+ const isInfoElement = element => element instanceof _Info.default;
109
74
 
110
75
  /**
111
76
  * @public
112
77
  */
113
- const isJsonSchemaDialectElement = exports.isJsonSchemaDialectElement = (0, _apidomCore.createPredicate)(({
114
- hasBasicElementProps,
115
- isElementType,
116
- primitiveEq
117
- }) => {
118
- return element => element instanceof _JsonSchemaDialect.default || hasBasicElementProps(element) && isElementType('jsonSchemaDialect', element) && primitiveEq('string', element);
119
- });
78
+ exports.isInfoElement = isInfoElement;
79
+ const isJsonSchemaDialectElement = element => element instanceof _JsonSchemaDialect.default;
120
80
 
121
81
  /**
122
82
  * @public
123
83
  */
124
- const isLicenseElement = exports.isLicenseElement = (0, _apidomCore.createPredicate)(({
125
- hasBasicElementProps,
126
- isElementType,
127
- primitiveEq
128
- }) => {
129
- return element => element instanceof _License.default || hasBasicElementProps(element) && isElementType('license', element) && primitiveEq('object', element);
130
- });
84
+ exports.isJsonSchemaDialectElement = isJsonSchemaDialectElement;
85
+ const isLicenseElement = element => element instanceof _License.default;
131
86
 
132
87
  /**
133
88
  * @public
134
89
  */
135
- const isLinkElement = exports.isLinkElement = (0, _apidomCore.createPredicate)(({
136
- hasBasicElementProps,
137
- isElementType,
138
- primitiveEq
139
- }) => {
140
- return element => element instanceof _Link.default || hasBasicElementProps(element) && isElementType('link', element) && primitiveEq('object', element);
141
- });
90
+ exports.isLicenseElement = isLicenseElement;
91
+ const isLinkElement = element => element instanceof _Link.default;
142
92
 
143
93
  /**
144
94
  * @public
145
95
  */
146
- const isOpenapiElement = exports.isOpenapiElement = (0, _apidomCore.createPredicate)(({
147
- hasBasicElementProps,
148
- isElementType,
149
- primitiveEq
150
- }) => {
151
- return element => element instanceof _Openapi.default || hasBasicElementProps(element) && isElementType('openapi', element) && primitiveEq('string', element);
152
- });
96
+ exports.isLinkElement = isLinkElement;
97
+ const isOpenapiElement = element => element instanceof _Openapi.default;
153
98
 
154
99
  /**
155
100
  * @public
156
101
  */
157
-
158
- const isOpenApi3_1Element = exports.isOpenApi3_1Element = (0, _apidomCore.createPredicate)(({
159
- hasBasicElementProps,
160
- isElementType,
161
- primitiveEq,
162
- hasClass
163
- }) => {
164
- return element => element instanceof _OpenApi.default || hasBasicElementProps(element) && isElementType('openApi3_1', element) && primitiveEq('object', element) && hasClass('api', element);
165
- });
102
+ exports.isOpenapiElement = isOpenapiElement;
103
+ const isOpenApi3_1Element = element => element instanceof _OpenApi.default;
166
104
 
167
105
  /**
168
106
  * @public
169
107
  */
170
- const isOperationElement = exports.isOperationElement = (0, _apidomCore.createPredicate)(({
171
- hasBasicElementProps,
172
- isElementType,
173
- primitiveEq
174
- }) => {
175
- return element => element instanceof _Operation.default || hasBasicElementProps(element) && isElementType('operation', element) && primitiveEq('object', element);
176
- });
108
+ exports.isOpenApi3_1Element = isOpenApi3_1Element;
109
+ const isOperationElement = element => element instanceof _Operation.default;
177
110
 
178
111
  /**
179
112
  * @public
180
113
  */
181
- const isParameterElement = exports.isParameterElement = (0, _apidomCore.createPredicate)(({
182
- hasBasicElementProps,
183
- isElementType,
184
- primitiveEq
185
- }) => {
186
- return element => element instanceof _Parameter.default || hasBasicElementProps(element) && isElementType('parameter', element) && primitiveEq('object', element);
187
- });
114
+ exports.isOperationElement = isOperationElement;
115
+ const isParameterElement = element => element instanceof _Parameter.default;
188
116
 
189
117
  /**
190
118
  * @public
191
119
  */
192
- const isPathItemElement = exports.isPathItemElement = (0, _apidomCore.createPredicate)(({
193
- hasBasicElementProps,
194
- isElementType,
195
- primitiveEq
196
- }) => {
197
- return element => element instanceof _PathItem.default || hasBasicElementProps(element) && isElementType('pathItem', element) && primitiveEq('object', element);
198
- });
120
+ exports.isParameterElement = isParameterElement;
121
+ const isPathItemElement = element => element instanceof _PathItem.default;
199
122
 
200
123
  /**
201
124
  * @deprecated
@@ -204,11 +127,12 @@ const isPathItemElement = exports.isPathItemElement = (0, _apidomCore.createPred
204
127
  * using the referring document as the Base URI.
205
128
  * @public
206
129
  */
130
+ exports.isPathItemElement = isPathItemElement;
207
131
  const isPathItemElementExternal = element => {
208
132
  if (!isPathItemElement(element)) {
209
133
  return false;
210
134
  }
211
- if (!(0, _apidomCore.isStringElement)(element.$ref)) {
135
+ if (!(0, _apidomDatamodel.isStringElement)(element.$ref)) {
212
136
  return false;
213
137
  }
214
138
  const value = (0, _apidomCore.toValue)(element.$ref);
@@ -219,24 +143,13 @@ const isPathItemElementExternal = element => {
219
143
  * @public
220
144
  */
221
145
  exports.isPathItemElementExternal = isPathItemElementExternal;
222
- const isPathsElement = exports.isPathsElement = (0, _apidomCore.createPredicate)(({
223
- hasBasicElementProps,
224
- isElementType,
225
- primitiveEq
226
- }) => {
227
- return element => element instanceof _Paths.default || hasBasicElementProps(element) && isElementType('paths', element) && primitiveEq('object', element);
228
- });
146
+ const isPathsElement = element => element instanceof _Paths.default;
229
147
 
230
148
  /**
231
149
  * @public
232
150
  */
233
- const isReferenceElement = exports.isReferenceElement = (0, _apidomCore.createPredicate)(({
234
- hasBasicElementProps,
235
- isElementType,
236
- primitiveEq
237
- }) => {
238
- return element => element instanceof _Reference.default || hasBasicElementProps(element) && isElementType('reference', element) && primitiveEq('object', element);
239
- });
151
+ exports.isPathsElement = isPathsElement;
152
+ const isReferenceElement = element => element instanceof _Reference.default;
240
153
 
241
154
  /**
242
155
  * @deprecated
@@ -245,11 +158,12 @@ const isReferenceElement = exports.isReferenceElement = (0, _apidomCore.createPr
245
158
  * using the referring document as the Base URI.
246
159
  * @public
247
160
  */
161
+ exports.isReferenceElement = isReferenceElement;
248
162
  const isReferenceElementExternal = element => {
249
163
  if (!isReferenceElement(element)) {
250
164
  return false;
251
165
  }
252
- if (!(0, _apidomCore.isStringElement)(element.$ref)) {
166
+ if (!(0, _apidomDatamodel.isStringElement)(element.$ref)) {
253
167
  return false;
254
168
  }
255
169
  const value = (0, _apidomCore.toValue)(element.$ref);
@@ -260,106 +174,61 @@ const isReferenceElementExternal = element => {
260
174
  * @public
261
175
  */
262
176
  exports.isReferenceElementExternal = isReferenceElementExternal;
263
- const isRequestBodyElement = exports.isRequestBodyElement = (0, _apidomCore.createPredicate)(({
264
- hasBasicElementProps,
265
- isElementType,
266
- primitiveEq
267
- }) => {
268
- return element => element instanceof _RequestBody.default || hasBasicElementProps(element) && isElementType('requestBody', element) && primitiveEq('object', element);
269
- });
177
+ const isRequestBodyElement = element => element instanceof _RequestBody.default;
270
178
 
271
179
  /**
272
180
  * @public
273
181
  */
274
- const isResponseElement = exports.isResponseElement = (0, _apidomCore.createPredicate)(({
275
- hasBasicElementProps,
276
- isElementType,
277
- primitiveEq
278
- }) => {
279
- return element => element instanceof _Response.default || hasBasicElementProps(element) && isElementType('response', element) && primitiveEq('object', element);
280
- });
182
+ exports.isRequestBodyElement = isRequestBodyElement;
183
+ const isResponseElement = element => element instanceof _Response.default;
281
184
 
282
185
  /**
283
186
  * @public
284
187
  */
285
- const isResponsesElement = exports.isResponsesElement = (0, _apidomCore.createPredicate)(({
286
- hasBasicElementProps,
287
- isElementType,
288
- primitiveEq
289
- }) => {
290
- return element => element instanceof _Responses.default || hasBasicElementProps(element) && isElementType('responses', element) && primitiveEq('object', element);
291
- });
188
+ exports.isResponseElement = isResponseElement;
189
+ const isResponsesElement = element => element instanceof _Responses.default;
292
190
 
293
191
  /**
294
192
  * @public
295
193
  */
296
- const isSchemaElement = exports.isSchemaElement = (0, _apidomCore.createPredicate)(({
297
- hasBasicElementProps,
298
- isElementType,
299
- primitiveEq
300
- }) => {
301
- return element => element instanceof _Schema.default || hasBasicElementProps(element) && isElementType('schema', element) && primitiveEq('object', element);
302
- });
194
+ exports.isResponsesElement = isResponsesElement;
195
+ const isSchemaElement = element => element instanceof _Schema.default;
303
196
 
304
197
  /**
305
198
  * @public
306
199
  */
200
+ exports.isSchemaElement = isSchemaElement;
307
201
  const isBooleanJsonSchemaElement = element => {
308
- return (0, _apidomCore.isBooleanElement)(element) && element.classes.includes('boolean-json-schema');
202
+ return (0, _apidomDatamodel.isBooleanElement)(element) && (0, _apidomDatamodel.includesClasses)(element, ['boolean-json-schema']);
309
203
  };
310
204
 
311
205
  /**
312
206
  * @public
313
207
  */
314
208
  exports.isBooleanJsonSchemaElement = isBooleanJsonSchemaElement;
315
- const isSecurityRequirementElement = exports.isSecurityRequirementElement = (0, _apidomCore.createPredicate)(({
316
- hasBasicElementProps,
317
- isElementType,
318
- primitiveEq
319
- }) => {
320
- return element => element instanceof _SecurityRequirement.default || hasBasicElementProps(element) && isElementType('securityRequirement', element) && primitiveEq('object', element);
321
- });
209
+ const isSecurityRequirementElement = element => element instanceof _SecurityRequirement.default;
322
210
 
323
211
  /**
324
212
  * @public
325
213
  */
326
- const isSecuritySchemeElement = exports.isSecuritySchemeElement = (0, _apidomCore.createPredicate)(({
327
- hasBasicElementProps,
328
- isElementType,
329
- primitiveEq
330
- }) => {
331
- return element => element instanceof _SecurityScheme.default || hasBasicElementProps(element) && isElementType('securityScheme', element) && primitiveEq('object', element);
332
- });
214
+ exports.isSecurityRequirementElement = isSecurityRequirementElement;
215
+ const isSecuritySchemeElement = element => element instanceof _SecurityScheme.default;
333
216
 
334
217
  /**
335
218
  * @public
336
219
  */
337
- const isServerElement = exports.isServerElement = (0, _apidomCore.createPredicate)(({
338
- hasBasicElementProps,
339
- isElementType,
340
- primitiveEq
341
- }) => {
342
- return element => element instanceof _Server.default || hasBasicElementProps(element) && isElementType('server', element) && primitiveEq('object', element);
343
- });
220
+ exports.isSecuritySchemeElement = isSecuritySchemeElement;
221
+ const isServerElement = element => element instanceof _Server.default;
344
222
 
345
223
  /**
346
224
  * @public
347
225
  */
348
- const isServerVariableElement = exports.isServerVariableElement = (0, _apidomCore.createPredicate)(({
349
- hasBasicElementProps,
350
- isElementType,
351
- primitiveEq
352
- }) => {
353
- return element => element instanceof _ServerVariable.default || hasBasicElementProps(element) && isElementType('serverVariable', element) && primitiveEq('object', element);
354
- });
226
+ exports.isServerElement = isServerElement;
227
+ const isServerVariableElement = element => element instanceof _ServerVariable.default;
355
228
 
356
229
  /**
357
230
  * @public
358
231
  */
359
- const isMediaTypeElement = exports.isMediaTypeElement = (0, _apidomCore.createPredicate)(({
360
- hasBasicElementProps,
361
- isElementType,
362
- primitiveEq
363
- }) => {
364
- return element => element instanceof _MediaType.default || hasBasicElementProps(element) && isElementType('mediaType', element) && primitiveEq('object', element);
365
- });
232
+ exports.isServerVariableElement = isServerVariableElement;
233
+ const isMediaTypeElement = element => element instanceof _MediaType.default;
234
+ exports.isMediaTypeElement = isMediaTypeElement;