@swagger-api/apidom-ns-openapi-3-1 1.0.0-beta.1 → 1.0.0-beta.10

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 (204) hide show
  1. package/CHANGELOG.md +36 -0
  2. package/LICENSES/AFL-3.0.txt +182 -0
  3. package/LICENSES/BSD-3-Clause.txt +26 -0
  4. package/NOTICE +26 -0
  5. package/dist/apidom-ns-openapi-3-1.browser.js +747 -323
  6. package/dist/apidom-ns-openapi-3-1.browser.min.js +1 -1
  7. package/package.json +10 -10
  8. package/src/elements/Callback.cjs +3 -0
  9. package/src/elements/Callback.mjs +4 -0
  10. package/src/elements/Components.cjs +3 -0
  11. package/src/elements/Components.mjs +4 -0
  12. package/src/elements/Contact.cjs +3 -0
  13. package/src/elements/Contact.mjs +4 -0
  14. package/src/elements/Discriminator.cjs +3 -0
  15. package/src/elements/Discriminator.mjs +4 -0
  16. package/src/elements/Encoding.cjs +3 -0
  17. package/src/elements/Encoding.mjs +4 -0
  18. package/src/elements/Example.cjs +3 -0
  19. package/src/elements/Example.mjs +4 -0
  20. package/src/elements/ExternalDocumentation.cjs +3 -0
  21. package/src/elements/ExternalDocumentation.mjs +4 -0
  22. package/src/elements/Header.cjs +3 -0
  23. package/src/elements/Header.mjs +3 -0
  24. package/src/elements/Info.cjs +3 -0
  25. package/src/elements/Info.mjs +3 -0
  26. package/src/elements/JsonSchemaDialect.cjs +3 -0
  27. package/src/elements/JsonSchemaDialect.mjs +4 -0
  28. package/src/elements/License.cjs +3 -0
  29. package/src/elements/License.mjs +4 -0
  30. package/src/elements/Link.cjs +3 -0
  31. package/src/elements/Link.mjs +4 -0
  32. package/src/elements/MediaType.cjs +3 -0
  33. package/src/elements/MediaType.mjs +3 -0
  34. package/src/elements/OAuthFlow.cjs +3 -0
  35. package/src/elements/OAuthFlow.mjs +4 -0
  36. package/src/elements/OAuthFlows.cjs +3 -0
  37. package/src/elements/OAuthFlows.mjs +4 -0
  38. package/src/elements/OpenApi3-1.cjs +3 -0
  39. package/src/elements/OpenApi3-1.mjs +3 -0
  40. package/src/elements/Openapi.cjs +3 -0
  41. package/src/elements/Openapi.mjs +4 -0
  42. package/src/elements/Operation.cjs +3 -0
  43. package/src/elements/Operation.mjs +3 -0
  44. package/src/elements/Parameter.cjs +3 -0
  45. package/src/elements/Parameter.mjs +3 -0
  46. package/src/elements/PathItem.cjs +3 -0
  47. package/src/elements/PathItem.mjs +3 -0
  48. package/src/elements/Paths.cjs +3 -0
  49. package/src/elements/Paths.mjs +4 -0
  50. package/src/elements/Reference.cjs +3 -0
  51. package/src/elements/Reference.mjs +4 -0
  52. package/src/elements/RequestBody.cjs +3 -0
  53. package/src/elements/RequestBody.mjs +4 -0
  54. package/src/elements/Response.cjs +3 -0
  55. package/src/elements/Response.mjs +4 -0
  56. package/src/elements/Responses.cjs +3 -0
  57. package/src/elements/Responses.mjs +4 -0
  58. package/src/elements/Schema.cjs +3 -4
  59. package/src/elements/Schema.mjs +3 -4
  60. package/src/elements/SecurityRequirement.cjs +3 -0
  61. package/src/elements/SecurityRequirement.mjs +4 -0
  62. package/src/elements/SecurityScheme.cjs +3 -0
  63. package/src/elements/SecurityScheme.mjs +4 -0
  64. package/src/elements/Server.cjs +3 -0
  65. package/src/elements/Server.mjs +4 -0
  66. package/src/elements/ServerVariable.cjs +3 -0
  67. package/src/elements/ServerVariable.mjs +4 -0
  68. package/src/elements/Tag.cjs +3 -0
  69. package/src/elements/Tag.mjs +4 -0
  70. package/src/elements/Xml.cjs +3 -0
  71. package/src/elements/Xml.mjs +4 -0
  72. package/src/elements/nces/ComponentsPathItems.cjs +3 -0
  73. package/src/elements/nces/ComponentsPathItems.mjs +4 -0
  74. package/src/elements/nces/Webhooks.cjs +3 -0
  75. package/src/elements/nces/Webhooks.mjs +4 -0
  76. package/src/index.mjs +2 -1
  77. package/src/media-types.cjs +11 -0
  78. package/src/media-types.mjs +12 -0
  79. package/src/namespace.cjs +3 -0
  80. package/src/namespace.mjs +5 -1
  81. package/src/predicates.cjs +108 -0
  82. package/src/predicates.mjs +108 -0
  83. package/src/refractor/plugins/normalize-header-examples/index.cjs +4 -0
  84. package/src/refractor/plugins/normalize-header-examples/index.mjs +4 -0
  85. package/src/refractor/plugins/normalize-operation-ids.cjs +4 -0
  86. package/src/refractor/plugins/normalize-operation-ids.mjs +4 -0
  87. package/src/refractor/plugins/normalize-parameter-examples.cjs +4 -0
  88. package/src/refractor/plugins/normalize-parameter-examples.mjs +4 -0
  89. package/src/refractor/plugins/normalize-parameters.cjs +4 -0
  90. package/src/refractor/plugins/normalize-parameters.mjs +4 -0
  91. package/src/refractor/plugins/normalize-security-requirements.cjs +4 -0
  92. package/src/refractor/plugins/normalize-security-requirements.mjs +4 -0
  93. package/src/refractor/plugins/normalize-servers.cjs +6 -2
  94. package/src/refractor/plugins/normalize-servers.mjs +6 -2
  95. package/src/refractor/plugins/replace-empty-element.cjs +4 -0
  96. package/src/refractor/plugins/replace-empty-element.mjs +4 -0
  97. package/src/refractor/specification.cjs +1 -0
  98. package/src/refractor/specification.mjs +1 -0
  99. package/src/refractor/toolbox.cjs +19 -1
  100. package/src/refractor/toolbox.mjs +15 -1
  101. package/src/refractor/visitors/open-api-3-1/JsonSchemaDialectVisitor.cjs +7 -0
  102. package/src/refractor/visitors/open-api-3-1/JsonSchemaDialectVisitor.mjs +6 -0
  103. package/src/refractor/visitors/open-api-3-1/WebhooksVisitor.cjs +7 -0
  104. package/src/refractor/visitors/open-api-3-1/WebhooksVisitor.mjs +6 -0
  105. package/src/refractor/visitors/open-api-3-1/callback/index.cjs +8 -12
  106. package/src/refractor/visitors/open-api-3-1/callback/index.mjs +7 -11
  107. package/src/refractor/visitors/open-api-3-1/components/PathItemsVisitor.cjs +7 -0
  108. package/src/refractor/visitors/open-api-3-1/components/PathItemsVisitor.mjs +6 -0
  109. package/src/refractor/visitors/open-api-3-1/components/SchemasVisitor.cjs +7 -0
  110. package/src/refractor/visitors/open-api-3-1/components/SchemasVisitor.mjs +8 -0
  111. package/src/refractor/visitors/open-api-3-1/components/index.cjs +8 -12
  112. package/src/refractor/visitors/open-api-3-1/components/index.mjs +7 -11
  113. package/src/refractor/visitors/open-api-3-1/contact/index.cjs +8 -12
  114. package/src/refractor/visitors/open-api-3-1/contact/index.mjs +7 -11
  115. package/src/refractor/visitors/open-api-3-1/distriminator/index.cjs +8 -12
  116. package/src/refractor/visitors/open-api-3-1/distriminator/index.mjs +7 -11
  117. package/src/refractor/visitors/open-api-3-1/encoding/index.cjs +8 -12
  118. package/src/refractor/visitors/open-api-3-1/encoding/index.mjs +7 -11
  119. package/src/refractor/visitors/open-api-3-1/example/index.cjs +8 -12
  120. package/src/refractor/visitors/open-api-3-1/example/index.mjs +7 -11
  121. package/src/refractor/visitors/open-api-3-1/external-documentation/index.cjs +8 -12
  122. package/src/refractor/visitors/open-api-3-1/external-documentation/index.mjs +7 -11
  123. package/src/refractor/visitors/open-api-3-1/header/index.cjs +8 -12
  124. package/src/refractor/visitors/open-api-3-1/header/index.mjs +7 -11
  125. package/src/refractor/visitors/open-api-3-1/index.cjs +6 -0
  126. package/src/refractor/visitors/open-api-3-1/index.mjs +8 -1
  127. package/src/refractor/visitors/open-api-3-1/info/index.cjs +8 -12
  128. package/src/refractor/visitors/open-api-3-1/info/index.mjs +7 -11
  129. package/src/refractor/visitors/open-api-3-1/license/index.cjs +8 -12
  130. package/src/refractor/visitors/open-api-3-1/license/index.mjs +7 -11
  131. package/src/refractor/visitors/open-api-3-1/link/index.cjs +8 -12
  132. package/src/refractor/visitors/open-api-3-1/link/index.mjs +7 -11
  133. package/src/refractor/visitors/open-api-3-1/media-type/index.cjs +8 -12
  134. package/src/refractor/visitors/open-api-3-1/media-type/index.mjs +7 -11
  135. package/src/refractor/visitors/open-api-3-1/oauth-flow/index.cjs +8 -12
  136. package/src/refractor/visitors/open-api-3-1/oauth-flow/index.mjs +7 -11
  137. package/src/refractor/visitors/open-api-3-1/oauth-flows/index.cjs +8 -12
  138. package/src/refractor/visitors/open-api-3-1/oauth-flows/index.mjs +7 -11
  139. package/src/refractor/visitors/open-api-3-1/operation/index.cjs +8 -12
  140. package/src/refractor/visitors/open-api-3-1/operation/index.mjs +7 -11
  141. package/src/refractor/visitors/open-api-3-1/parameter/index.cjs +8 -12
  142. package/src/refractor/visitors/open-api-3-1/parameter/index.mjs +7 -11
  143. package/src/refractor/visitors/open-api-3-1/path-item/index.cjs +8 -12
  144. package/src/refractor/visitors/open-api-3-1/path-item/index.mjs +7 -11
  145. package/src/refractor/visitors/open-api-3-1/paths/index.cjs +8 -12
  146. package/src/refractor/visitors/open-api-3-1/paths/index.mjs +7 -11
  147. package/src/refractor/visitors/open-api-3-1/reference/index.cjs +8 -12
  148. package/src/refractor/visitors/open-api-3-1/reference/index.mjs +7 -11
  149. package/src/refractor/visitors/open-api-3-1/request-body/index.cjs +8 -12
  150. package/src/refractor/visitors/open-api-3-1/request-body/index.mjs +7 -11
  151. package/src/refractor/visitors/open-api-3-1/response/index.cjs +8 -12
  152. package/src/refractor/visitors/open-api-3-1/response/index.mjs +7 -11
  153. package/src/refractor/visitors/open-api-3-1/responses/index.cjs +8 -12
  154. package/src/refractor/visitors/open-api-3-1/responses/index.mjs +7 -11
  155. package/src/refractor/visitors/open-api-3-1/schema/$defsVisitor.cjs +7 -0
  156. package/src/refractor/visitors/open-api-3-1/schema/$defsVisitor.mjs +6 -0
  157. package/src/refractor/visitors/open-api-3-1/schema/$refVisitor.cjs +3 -0
  158. package/src/refractor/visitors/open-api-3-1/schema/$refVisitor.mjs +3 -0
  159. package/src/refractor/visitors/open-api-3-1/schema/$vocabularyVisitor.cjs +3 -0
  160. package/src/refractor/visitors/open-api-3-1/schema/$vocabularyVisitor.mjs +3 -0
  161. package/src/refractor/visitors/open-api-3-1/schema/AllOfVisitor.cjs +7 -0
  162. package/src/refractor/visitors/open-api-3-1/schema/AllOfVisitor.mjs +6 -0
  163. package/src/refractor/visitors/open-api-3-1/schema/AnyOfVisitor.cjs +7 -0
  164. package/src/refractor/visitors/open-api-3-1/schema/AnyOfVisitor.mjs +6 -0
  165. package/src/refractor/visitors/open-api-3-1/schema/DependentRequiredVisitor.cjs +3 -0
  166. package/src/refractor/visitors/open-api-3-1/schema/DependentRequiredVisitor.mjs +3 -0
  167. package/src/refractor/visitors/open-api-3-1/schema/DependentSchemasVisitor.cjs +7 -0
  168. package/src/refractor/visitors/open-api-3-1/schema/DependentSchemasVisitor.mjs +6 -0
  169. package/src/refractor/visitors/open-api-3-1/schema/EnumVisitor.cjs +3 -0
  170. package/src/refractor/visitors/open-api-3-1/schema/EnumVisitor.mjs +3 -0
  171. package/src/refractor/visitors/open-api-3-1/schema/ExamplesVisitor.cjs +3 -0
  172. package/src/refractor/visitors/open-api-3-1/schema/ExamplesVisitor.mjs +3 -0
  173. package/src/refractor/visitors/open-api-3-1/schema/OneOfVisitor.cjs +7 -0
  174. package/src/refractor/visitors/open-api-3-1/schema/OneOfVisitor.mjs +6 -0
  175. package/src/refractor/visitors/open-api-3-1/schema/ParentSchemaAwareVisitor.cjs +4 -0
  176. package/src/refractor/visitors/open-api-3-1/schema/ParentSchemaAwareVisitor.mjs +4 -0
  177. package/src/refractor/visitors/open-api-3-1/schema/PatternPropertiesVisitor.cjs +7 -0
  178. package/src/refractor/visitors/open-api-3-1/schema/PatternPropertiesVisitor.mjs +6 -0
  179. package/src/refractor/visitors/open-api-3-1/schema/PrefixItemsVisitor.cjs +7 -0
  180. package/src/refractor/visitors/open-api-3-1/schema/PrefixItemsVisitor.mjs +6 -0
  181. package/src/refractor/visitors/open-api-3-1/schema/PropertiesVisitor.cjs +7 -0
  182. package/src/refractor/visitors/open-api-3-1/schema/PropertiesVisitor.mjs +6 -0
  183. package/src/refractor/visitors/open-api-3-1/schema/RequiredVisitor.cjs +3 -0
  184. package/src/refractor/visitors/open-api-3-1/schema/RequiredVisitor.mjs +3 -0
  185. package/src/refractor/visitors/open-api-3-1/schema/TypeVisitor.cjs +3 -0
  186. package/src/refractor/visitors/open-api-3-1/schema/TypeVisitor.mjs +3 -0
  187. package/src/refractor/visitors/open-api-3-1/schema/index.cjs +8 -1
  188. package/src/refractor/visitors/open-api-3-1/schema/index.mjs +7 -1
  189. package/src/refractor/visitors/open-api-3-1/security-requirement/index.cjs +8 -12
  190. package/src/refractor/visitors/open-api-3-1/security-requirement/index.mjs +7 -11
  191. package/src/refractor/visitors/open-api-3-1/security-scheme/index.cjs +8 -12
  192. package/src/refractor/visitors/open-api-3-1/security-scheme/index.mjs +7 -11
  193. package/src/refractor/visitors/open-api-3-1/server/index.cjs +8 -12
  194. package/src/refractor/visitors/open-api-3-1/server/index.mjs +7 -11
  195. package/src/refractor/visitors/open-api-3-1/server-variable/index.cjs +8 -12
  196. package/src/refractor/visitors/open-api-3-1/server-variable/index.mjs +7 -11
  197. package/src/refractor/visitors/open-api-3-1/tag/index.cjs +8 -12
  198. package/src/refractor/visitors/open-api-3-1/tag/index.mjs +7 -11
  199. package/src/refractor/visitors/open-api-3-1/xml/index.cjs +8 -12
  200. package/src/refractor/visitors/open-api-3-1/xml/index.mjs +7 -11
  201. package/src/traversal/visitor.cjs +4 -1
  202. package/src/traversal/visitor.mjs +4 -1
  203. package/types/apidom-ns-openapi-3-1.d.ts +3014 -0
  204. package/types/dist.d.ts +0 -1778
@@ -25,6 +25,9 @@ import SecuritySchemeElement from "./elements/SecurityScheme.mjs";
25
25
  import ServerElement from "./elements/Server.mjs";
26
26
  import ServerVariableElement from "./elements/ServerVariable.mjs";
27
27
  import MediaTypeElement from "./elements/MediaType.mjs";
28
+ /**
29
+ * @public
30
+ */
28
31
  export const isCallbackElement = createPredicate(({
29
32
  hasBasicElementProps,
30
33
  isElementType,
@@ -32,6 +35,10 @@ export const isCallbackElement = createPredicate(({
32
35
  }) => {
33
36
  return element => element instanceof CallbackElement || hasBasicElementProps(element) && isElementType('callback', element) && primitiveEq('object', element);
34
37
  });
38
+
39
+ /**
40
+ * @public
41
+ */
35
42
  export const isComponentsElement = createPredicate(({
36
43
  hasBasicElementProps,
37
44
  isElementType,
@@ -39,6 +46,10 @@ export const isComponentsElement = createPredicate(({
39
46
  }) => {
40
47
  return element => element instanceof ComponentsElement || hasBasicElementProps(element) && isElementType('components', element) && primitiveEq('object', element);
41
48
  });
49
+
50
+ /**
51
+ * @public
52
+ */
42
53
  export const isContactElement = createPredicate(({
43
54
  hasBasicElementProps,
44
55
  isElementType,
@@ -46,6 +57,10 @@ export const isContactElement = createPredicate(({
46
57
  }) => {
47
58
  return element => element instanceof ContactElement || hasBasicElementProps(element) && isElementType('contact', element) && primitiveEq('object', element);
48
59
  });
60
+
61
+ /**
62
+ * @public
63
+ */
49
64
  export const isExampleElement = createPredicate(({
50
65
  hasBasicElementProps,
51
66
  isElementType,
@@ -53,6 +68,10 @@ export const isExampleElement = createPredicate(({
53
68
  }) => {
54
69
  return element => element instanceof ExampleElement || hasBasicElementProps(element) && isElementType('example', element) && primitiveEq('object', element);
55
70
  });
71
+
72
+ /**
73
+ * @public
74
+ */
56
75
  export const isExternalDocumentationElement = createPredicate(({
57
76
  hasBasicElementProps,
58
77
  isElementType,
@@ -60,6 +79,10 @@ export const isExternalDocumentationElement = createPredicate(({
60
79
  }) => {
61
80
  return element => element instanceof ExternalDocumentationElement || hasBasicElementProps(element) && isElementType('externalDocumentation', element) && primitiveEq('object', element);
62
81
  });
82
+
83
+ /**
84
+ * @public
85
+ */
63
86
  export const isHeaderElement = createPredicate(({
64
87
  hasBasicElementProps,
65
88
  isElementType,
@@ -67,6 +90,10 @@ export const isHeaderElement = createPredicate(({
67
90
  }) => {
68
91
  return element => element instanceof HeaderElement || hasBasicElementProps(element) && isElementType('header', element) && primitiveEq('object', element);
69
92
  });
93
+
94
+ /**
95
+ * @public
96
+ */
70
97
  export const isInfoElement = createPredicate(({
71
98
  hasBasicElementProps,
72
99
  isElementType,
@@ -74,6 +101,10 @@ export const isInfoElement = createPredicate(({
74
101
  }) => {
75
102
  return element => element instanceof InfoElement || hasBasicElementProps(element) && isElementType('info', element) && primitiveEq('object', element);
76
103
  });
104
+
105
+ /**
106
+ * @public
107
+ */
77
108
  export const isJsonSchemaDialectElement = createPredicate(({
78
109
  hasBasicElementProps,
79
110
  isElementType,
@@ -81,6 +112,10 @@ export const isJsonSchemaDialectElement = createPredicate(({
81
112
  }) => {
82
113
  return element => element instanceof JsonSchemaDialectElement || hasBasicElementProps(element) && isElementType('jsonSchemaDialect', element) && primitiveEq('string', element);
83
114
  });
115
+
116
+ /**
117
+ * @public
118
+ */
84
119
  export const isLicenseElement = createPredicate(({
85
120
  hasBasicElementProps,
86
121
  isElementType,
@@ -88,6 +123,10 @@ export const isLicenseElement = createPredicate(({
88
123
  }) => {
89
124
  return element => element instanceof LicenseElement || hasBasicElementProps(element) && isElementType('license', element) && primitiveEq('object', element);
90
125
  });
126
+
127
+ /**
128
+ * @public
129
+ */
91
130
  export const isLinkElement = createPredicate(({
92
131
  hasBasicElementProps,
93
132
  isElementType,
@@ -95,6 +134,10 @@ export const isLinkElement = createPredicate(({
95
134
  }) => {
96
135
  return element => element instanceof LinkElement || hasBasicElementProps(element) && isElementType('link', element) && primitiveEq('object', element);
97
136
  });
137
+
138
+ /**
139
+ * @public
140
+ */
98
141
  export const isOpenapiElement = createPredicate(({
99
142
  hasBasicElementProps,
100
143
  isElementType,
@@ -103,6 +146,9 @@ export const isOpenapiElement = createPredicate(({
103
146
  return element => element instanceof OpenapiElement || hasBasicElementProps(element) && isElementType('openapi', element) && primitiveEq('string', element);
104
147
  });
105
148
 
149
+ /**
150
+ * @public
151
+ */
106
152
  // eslint-disable-next-line @typescript-eslint/naming-convention
107
153
  export const isOpenApi3_1Element = createPredicate(({
108
154
  hasBasicElementProps,
@@ -112,6 +158,10 @@ export const isOpenApi3_1Element = createPredicate(({
112
158
  }) => {
113
159
  return element => element instanceof OpenApi3_1Element || hasBasicElementProps(element) && isElementType('openApi3_1', element) && primitiveEq('object', element) && hasClass('api', element);
114
160
  });
161
+
162
+ /**
163
+ * @public
164
+ */
115
165
  export const isOperationElement = createPredicate(({
116
166
  hasBasicElementProps,
117
167
  isElementType,
@@ -119,6 +169,10 @@ export const isOperationElement = createPredicate(({
119
169
  }) => {
120
170
  return element => element instanceof OperationElement || hasBasicElementProps(element) && isElementType('operation', element) && primitiveEq('object', element);
121
171
  });
172
+
173
+ /**
174
+ * @public
175
+ */
122
176
  export const isParameterElement = createPredicate(({
123
177
  hasBasicElementProps,
124
178
  isElementType,
@@ -126,6 +180,10 @@ export const isParameterElement = createPredicate(({
126
180
  }) => {
127
181
  return element => element instanceof ParameterElement || hasBasicElementProps(element) && isElementType('parameter', element) && primitiveEq('object', element);
128
182
  });
183
+
184
+ /**
185
+ * @public
186
+ */
129
187
  export const isPathItemElement = createPredicate(({
130
188
  hasBasicElementProps,
131
189
  isElementType,
@@ -139,6 +197,7 @@ export const isPathItemElement = createPredicate(({
139
197
  * Determining whether a PathItemElement is external or internal is not possible by just looking
140
198
  * at value of the $ref fixed field. The value of the $ref field needs to be resolved in runtime
141
199
  * using the referring document as the Base URI.
200
+ * @public
142
201
  */
143
202
  export const isPathItemElementExternal = element => {
144
203
  if (!isPathItemElement(element)) {
@@ -150,6 +209,10 @@ export const isPathItemElementExternal = element => {
150
209
  const value = toValue(element.$ref);
151
210
  return typeof value === 'string' && value.length > 0 && !value.startsWith('#');
152
211
  };
212
+
213
+ /**
214
+ * @public
215
+ */
153
216
  export const isPathsElement = createPredicate(({
154
217
  hasBasicElementProps,
155
218
  isElementType,
@@ -157,6 +220,10 @@ export const isPathsElement = createPredicate(({
157
220
  }) => {
158
221
  return element => element instanceof PathsElement || hasBasicElementProps(element) && isElementType('paths', element) && primitiveEq('object', element);
159
222
  });
223
+
224
+ /**
225
+ * @public
226
+ */
160
227
  export const isReferenceElement = createPredicate(({
161
228
  hasBasicElementProps,
162
229
  isElementType,
@@ -170,6 +237,7 @@ export const isReferenceElement = createPredicate(({
170
237
  * Determining whether a ReferenceElement is external or internal is not possible by just looking
171
238
  * at value of the $ref fixed field. The value of the $ref field needs to be resolved in runtime
172
239
  * using the referring document as the Base URI.
240
+ * @public
173
241
  */
174
242
  export const isReferenceElementExternal = element => {
175
243
  if (!isReferenceElement(element)) {
@@ -181,6 +249,10 @@ export const isReferenceElementExternal = element => {
181
249
  const value = toValue(element.$ref);
182
250
  return typeof value === 'string' && value.length > 0 && !value.startsWith('#');
183
251
  };
252
+
253
+ /**
254
+ * @public
255
+ */
184
256
  export const isRequestBodyElement = createPredicate(({
185
257
  hasBasicElementProps,
186
258
  isElementType,
@@ -188,6 +260,10 @@ export const isRequestBodyElement = createPredicate(({
188
260
  }) => {
189
261
  return element => element instanceof RequestBodyElement || hasBasicElementProps(element) && isElementType('requestBody', element) && primitiveEq('object', element);
190
262
  });
263
+
264
+ /**
265
+ * @public
266
+ */
191
267
  export const isResponseElement = createPredicate(({
192
268
  hasBasicElementProps,
193
269
  isElementType,
@@ -195,6 +271,10 @@ export const isResponseElement = createPredicate(({
195
271
  }) => {
196
272
  return element => element instanceof ResponseElement || hasBasicElementProps(element) && isElementType('response', element) && primitiveEq('object', element);
197
273
  });
274
+
275
+ /**
276
+ * @public
277
+ */
198
278
  export const isResponsesElement = createPredicate(({
199
279
  hasBasicElementProps,
200
280
  isElementType,
@@ -202,6 +282,10 @@ export const isResponsesElement = createPredicate(({
202
282
  }) => {
203
283
  return element => element instanceof ResponsesElement || hasBasicElementProps(element) && isElementType('responses', element) && primitiveEq('object', element);
204
284
  });
285
+
286
+ /**
287
+ * @public
288
+ */
205
289
  export const isSchemaElement = createPredicate(({
206
290
  hasBasicElementProps,
207
291
  isElementType,
@@ -209,9 +293,17 @@ export const isSchemaElement = createPredicate(({
209
293
  }) => {
210
294
  return element => element instanceof SchemaElement || hasBasicElementProps(element) && isElementType('schema', element) && primitiveEq('object', element);
211
295
  });
296
+
297
+ /**
298
+ * @public
299
+ */
212
300
  export const isBooleanJsonSchemaElement = element => {
213
301
  return isBooleanElement(element) && element.classes.includes('boolean-json-schema');
214
302
  };
303
+
304
+ /**
305
+ * @public
306
+ */
215
307
  export const isSecurityRequirementElement = createPredicate(({
216
308
  hasBasicElementProps,
217
309
  isElementType,
@@ -219,6 +311,10 @@ export const isSecurityRequirementElement = createPredicate(({
219
311
  }) => {
220
312
  return element => element instanceof SecurityRequirementElement || hasBasicElementProps(element) && isElementType('securityRequirement', element) && primitiveEq('object', element);
221
313
  });
314
+
315
+ /**
316
+ * @public
317
+ */
222
318
  export const isSecuritySchemeElement = createPredicate(({
223
319
  hasBasicElementProps,
224
320
  isElementType,
@@ -226,6 +322,10 @@ export const isSecuritySchemeElement = createPredicate(({
226
322
  }) => {
227
323
  return element => element instanceof SecuritySchemeElement || hasBasicElementProps(element) && isElementType('securityScheme', element) && primitiveEq('object', element);
228
324
  });
325
+
326
+ /**
327
+ * @public
328
+ */
229
329
  export const isServerElement = createPredicate(({
230
330
  hasBasicElementProps,
231
331
  isElementType,
@@ -233,6 +333,10 @@ export const isServerElement = createPredicate(({
233
333
  }) => {
234
334
  return element => element instanceof ServerElement || hasBasicElementProps(element) && isElementType('server', element) && primitiveEq('object', element);
235
335
  });
336
+
337
+ /**
338
+ * @public
339
+ */
236
340
  export const isServerVariableElement = createPredicate(({
237
341
  hasBasicElementProps,
238
342
  isElementType,
@@ -240,6 +344,10 @@ export const isServerVariableElement = createPredicate(({
240
344
  }) => {
241
345
  return element => element instanceof ServerVariableElement || hasBasicElementProps(element) && isElementType('serverVariable', element) && primitiveEq('object', element);
242
346
  });
347
+
348
+ /**
349
+ * @public
350
+ */
243
351
  export const isMediaTypeElement = createPredicate(({
244
352
  hasBasicElementProps,
245
353
  isElementType,
@@ -18,8 +18,12 @@ var _NormalizeStorage = _interopRequireDefault(require("./NormalizeStorage.cjs")
18
18
  * Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.
19
19
  *
20
20
  * NOTE: this plugin is idempotent
21
+ * @public
21
22
  */
22
23
 
24
+ /**
25
+ * @public
26
+ */
23
27
  const plugin = ({
24
28
  storageField = 'x-normalized'
25
29
  } = {}) => toolbox => {
@@ -13,6 +13,10 @@ import NormalizeStorage from "./NormalizeStorage.mjs";
13
13
  * Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.
14
14
  *
15
15
  * NOTE: this plugin is idempotent
16
+ * @public
17
+ */
18
+ /**
19
+ * @public
16
20
  */
17
21
  const plugin = ({
18
22
  storageField = 'x-normalized'
@@ -40,9 +40,13 @@ const normalizeOperationId = (operationId, path, method) => {
40
40
  * and make sure Link.operationId fields are pointing to correct and normalized Operation.operationId fields.
41
41
  *
42
42
  * NOTE: this plugin is idempotent
43
+ * @public
43
44
  */
44
45
 
45
46
  /* eslint-disable no-param-reassign */
47
+ /**
48
+ * @public
49
+ */
46
50
  const plugin = ({
47
51
  storageField = 'x-normalized',
48
52
  operationIdNormalizer = normalizeOperationId
@@ -35,9 +35,13 @@ const normalizeOperationId = (operationId, path, method) => {
35
35
  * and make sure Link.operationId fields are pointing to correct and normalized Operation.operationId fields.
36
36
  *
37
37
  * NOTE: this plugin is idempotent
38
+ * @public
38
39
  */
39
40
 
40
41
  /* eslint-disable no-param-reassign */
42
+ /**
43
+ * @public
44
+ */
41
45
  const plugin = ({
42
46
  storageField = 'x-normalized',
43
47
  operationIdNormalizer = normalizeOperationId
@@ -18,8 +18,12 @@ var _NormalizeStorage = _interopRequireDefault(require("./normalize-header-examp
18
18
  * Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.
19
19
  *
20
20
  * NOTE: this plugin is idempotent
21
+ * @public
21
22
  */
22
23
 
24
+ /**
25
+ * @public
26
+ */
23
27
  const plugin = ({
24
28
  storageField = 'x-normalized'
25
29
  } = {}) => toolbox => {
@@ -13,6 +13,10 @@ import NormalizeStorage from "./normalize-header-examples/NormalizeStorage.mjs";
13
13
  * Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.
14
14
  *
15
15
  * NOTE: this plugin is idempotent
16
+ * @public
17
+ */
18
+ /**
19
+ * @public
16
20
  */
17
21
  const plugin = ({
18
22
  storageField = 'x-normalized'
@@ -17,9 +17,13 @@ var _NormalizeStorage = _interopRequireDefault(require("./normalize-header-examp
17
17
  * A unique parameter is defined by a combination of a name and location.
18
18
  *
19
19
  * NOTE: this plugin is idempotent
20
+ * @public
20
21
  */
21
22
 
22
23
  /* eslint-disable no-param-reassign */
24
+ /**
25
+ * @public
26
+ */
23
27
  const plugin = ({
24
28
  storageField = 'x-normalized'
25
29
  } = {}) => toolbox => {
@@ -12,8 +12,12 @@ import NormalizeStorage from "./normalize-header-examples/NormalizeStorage.mjs";
12
12
  * A unique parameter is defined by a combination of a name and location.
13
13
  *
14
14
  * NOTE: this plugin is idempotent
15
+ * @public
15
16
  */
16
17
  /* eslint-disable no-param-reassign */
18
+ /**
19
+ * @public
20
+ */
17
21
  const plugin = ({
18
22
  storageField = 'x-normalized'
19
23
  } = {}) => toolbox => {
@@ -16,9 +16,13 @@ var _NormalizeStorage = _interopRequireDefault(require("./normalize-header-examp
16
16
  * only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request.
17
17
  *
18
18
  * NOTE: this plugin is idempotent
19
+ * @public
19
20
  */
20
21
 
21
22
  /* eslint-disable no-param-reassign */
23
+ /**
24
+ * @public
25
+ */
22
26
  const plugin = ({
23
27
  storageField = 'x-normalized'
24
28
  } = {}) => toolbox => {
@@ -11,8 +11,12 @@ import NormalizeStorage from "./normalize-header-examples/NormalizeStorage.mjs";
11
11
  * only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request.
12
12
  *
13
13
  * NOTE: this plugin is idempotent
14
+ * @public
14
15
  */
15
16
  /* eslint-disable no-param-reassign */
17
+ /**
18
+ * @public
19
+ */
16
20
  const plugin = ({
17
21
  storageField = 'x-normalized'
18
22
  } = {}) => toolbox => {
@@ -14,11 +14,15 @@ var _NormalizeStorage = _interopRequireDefault(require("./normalize-header-examp
14
14
  * - PathItem.servers
15
15
  * - Operation.servers
16
16
  *
17
- * If an alternative server object is specified at the Path Item Object level, it will override OpenAPI.servers.
18
- * If an alternative server object is specified at the Operation Object level, it will override PathItem.servers and OpenAPI.servers respectively.
17
+ * If a servers array is specified at the OpenAPI Object level, it will be overridden by `PathItem`.servers.
18
+ * If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by Operation.servers.
19
+ * @public
19
20
  */
20
21
 
21
22
  /* eslint-disable no-param-reassign */
23
+ /**
24
+ * @public
25
+ */
22
26
  const plugin = ({
23
27
  storageField = 'x-normalized'
24
28
  } = {}) => toolbox => {
@@ -9,10 +9,14 @@ import NormalizeStorage from "./normalize-header-examples/NormalizeStorage.mjs";
9
9
  * - PathItem.servers
10
10
  * - Operation.servers
11
11
  *
12
- * If an alternative server object is specified at the Path Item Object level, it will override OpenAPI.servers.
13
- * If an alternative server object is specified at the Operation Object level, it will override PathItem.servers and OpenAPI.servers respectively.
12
+ * If a servers array is specified at the OpenAPI Object level, it will be overridden by `PathItem`.servers.
13
+ * If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by Operation.servers.
14
+ * @public
14
15
  */
15
16
  /* eslint-disable no-param-reassign */
17
+ /**
18
+ * @public
19
+ */
16
20
  const plugin = ({
17
21
  storageField = 'x-normalized'
18
22
  } = {}) => toolbox => {
@@ -629,6 +629,10 @@ const findElementFactory = (ancestor, keyName) => {
629
629
  const keyMapping = schema[elementType] || schema[(0, _apidomCore.toValue)(ancestor.classes.first)];
630
630
  return typeof keyMapping === 'undefined' ? undefined : Object.prototype.hasOwnProperty.call(keyMapping, '[key: *]') ? keyMapping['[key: *]'] : keyMapping[keyName];
631
631
  };
632
+
633
+ /**
634
+ * @public
635
+ */
632
636
  const plugin = () => ({
633
637
  predicates
634
638
  }) => {
@@ -622,6 +622,10 @@ const findElementFactory = (ancestor, keyName) => {
622
622
  const keyMapping = schema[elementType] || schema[toValue(ancestor.classes.first)];
623
623
  return typeof keyMapping === 'undefined' ? undefined : Object.prototype.hasOwnProperty.call(keyMapping, '[key: *]') ? keyMapping['[key: *]'] : keyMapping[keyName];
624
624
  };
625
+
626
+ /**
627
+ * @public
628
+ */
625
629
  const plugin = () => ({
626
630
  predicates
627
631
  }) => {
@@ -59,6 +59,7 @@ var _WebhooksVisitor = _interopRequireDefault(require("./visitors/open-api-3-1/W
59
59
  * existing ones by manipulating it.
60
60
  *
61
61
  * Note: Specification object allows to use absolute internal JSON pointers.
62
+ * @public
62
63
  */
63
64
  const specification = {
64
65
  visitors: {
@@ -54,6 +54,7 @@ import WebhooksVisitor from "./visitors/open-api-3-1/WebhooksVisitor.mjs";
54
54
  * existing ones by manipulating it.
55
55
  *
56
56
  * Note: Specification object allows to use absolute internal JSON pointers.
57
+ * @public
57
58
  */
58
59
  const specification = {
59
60
  visitors: {
@@ -3,12 +3,24 @@
3
3
  var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
4
4
  var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
5
5
  exports.__esModule = true;
6
- exports.default = void 0;
6
+ exports.default = exports.ancestorLineageToJSONPointer = void 0;
7
7
  var _apidomCore = require("@swagger-api/apidom-core");
8
8
  var _apidomJsonPointer = require("@swagger-api/apidom-json-pointer");
9
9
  var _apidomNsOpenapi = require("@swagger-api/apidom-ns-openapi-3-0");
10
10
  var openApi3_1Predicates = _interopRequireWildcard(require("../predicates.cjs"));
11
11
  var _namespace = _interopRequireDefault(require("../namespace.cjs"));
12
+ /**
13
+ * @public
14
+ */
15
+
16
+ /**
17
+ * @public
18
+ */
19
+
20
+ /**
21
+ * @public
22
+ */
23
+
12
24
  /**
13
25
  * Translates visitor ancestor lineage to a JSON Pointer tokens.
14
26
  * Ancestor lineage is constructed of following visitor method arguments:
@@ -16,6 +28,7 @@ var _namespace = _interopRequireDefault(require("../namespace.cjs"));
16
28
  * - ancestors
17
29
  * - parent
18
30
  * - element
31
+ * @public
19
32
  */
20
33
  const ancestorLineageToJSONPointer = elementPath => {
21
34
  const jsonPointerTokens = elementPath.reduce((path, element, index) => {
@@ -30,6 +43,11 @@ const ancestorLineageToJSONPointer = elementPath => {
30
43
  }, []);
31
44
  return (0, _apidomJsonPointer.compile)(jsonPointerTokens);
32
45
  };
46
+
47
+ /**
48
+ * @public
49
+ */
50
+ exports.ancestorLineageToJSONPointer = ancestorLineageToJSONPointer;
33
51
  const createToolbox = () => {
34
52
  const namespace = (0, _apidomCore.createNamespace)(_namespace.default);
35
53
  const predicates = {
@@ -3,6 +3,15 @@ import { compile as compileJSONPointerTokens } from '@swagger-api/apidom-json-po
3
3
  import { isServersElement } from '@swagger-api/apidom-ns-openapi-3-0';
4
4
  import * as openApi3_1Predicates from "../predicates.mjs";
5
5
  import openApi3_1Namespace from "../namespace.mjs";
6
+ /**
7
+ * @public
8
+ */
9
+ /**
10
+ * @public
11
+ */
12
+ /**
13
+ * @public
14
+ */
6
15
  /**
7
16
  * Translates visitor ancestor lineage to a JSON Pointer tokens.
8
17
  * Ancestor lineage is constructed of following visitor method arguments:
@@ -10,8 +19,9 @@ import openApi3_1Namespace from "../namespace.mjs";
10
19
  * - ancestors
11
20
  * - parent
12
21
  * - element
22
+ * @public
13
23
  */
14
- const ancestorLineageToJSONPointer = elementPath => {
24
+ export const ancestorLineageToJSONPointer = elementPath => {
15
25
  const jsonPointerTokens = elementPath.reduce((path, element, index) => {
16
26
  if (isMemberElement(element)) {
17
27
  const token = String(toValue(element.key));
@@ -24,6 +34,10 @@ const ancestorLineageToJSONPointer = elementPath => {
24
34
  }, []);
25
35
  return compileJSONPointerTokens(jsonPointerTokens);
26
36
  };
37
+
38
+ /**
39
+ * @public
40
+ */
27
41
  const createToolbox = () => {
28
42
  const namespace = createNamespace(openApi3_1Namespace);
29
43
  const predicates = {
@@ -7,6 +7,13 @@ var _tsMixer = require("ts-mixer");
7
7
  var _apidomCore = require("@swagger-api/apidom-core");
8
8
  var _apidomNsOpenapi = require("@swagger-api/apidom-ns-openapi-3-0");
9
9
  var _JsonSchemaDialect = _interopRequireDefault(require("../../../elements/JsonSchemaDialect.cjs"));
10
+ /**
11
+ * @public
12
+ */
13
+
14
+ /**
15
+ * @public
16
+ */
10
17
  class JsonSchemaDialectVisitor extends (0, _tsMixer.Mixin)(_apidomNsOpenapi.SpecificationVisitor, _apidomNsOpenapi.FallbackVisitor) {
11
18
  StringElement(stringElement) {
12
19
  const jsonSchemaDialectElement = new _JsonSchemaDialect.default((0, _apidomCore.toValue)(stringElement));
@@ -2,6 +2,12 @@ import { Mixin } from 'ts-mixer';
2
2
  import { BREAK, toValue } from '@swagger-api/apidom-core';
3
3
  import { FallbackVisitor, SpecificationVisitor } from '@swagger-api/apidom-ns-openapi-3-0';
4
4
  import JsonSchemaDialectElement from "../../../elements/JsonSchemaDialect.mjs";
5
+ /**
6
+ * @public
7
+ */
8
+ /**
9
+ * @public
10
+ */
5
11
  class JsonSchemaDialectVisitor extends Mixin(SpecificationVisitor, FallbackVisitor) {
6
12
  StringElement(stringElement) {
7
13
  const jsonSchemaDialectElement = new JsonSchemaDialectElement(toValue(stringElement));
@@ -8,6 +8,13 @@ var _apidomCore = require("@swagger-api/apidom-core");
8
8
  var _apidomNsOpenapi = require("@swagger-api/apidom-ns-openapi-3-0");
9
9
  var _Webhooks = _interopRequireDefault(require("../../../elements/nces/Webhooks.cjs"));
10
10
  var _predicates = require("../../../predicates.cjs");
11
+ /**
12
+ * @public
13
+ */
14
+
15
+ /**
16
+ * @public
17
+ */
11
18
  class WebhooksVisitor extends (0, _tsMixer.Mixin)(_apidomNsOpenapi.MapVisitor, _apidomNsOpenapi.FallbackVisitor) {
12
19
  constructor(options) {
13
20
  super(options);
@@ -3,6 +3,12 @@ import { toValue } from '@swagger-api/apidom-core';
3
3
  import { isReferenceLikeElement, MapVisitor, FallbackVisitor } from '@swagger-api/apidom-ns-openapi-3-0';
4
4
  import WebhooksElement from "../../../elements/nces/Webhooks.mjs";
5
5
  import { isPathItemElement, isReferenceElement } from "../../../predicates.mjs";
6
+ /**
7
+ * @public
8
+ */
9
+ /**
10
+ * @public
11
+ */
6
12
  class WebhooksVisitor extends Mixin(MapVisitor, FallbackVisitor) {
7
13
  constructor(options) {
8
14
  super(options);