@speclynx/apidom-ns-openapi-3-1 4.0.1 → 4.0.3

package/src/media-types.ts

@@ -0,0 +1,46 @@
+import { last } from 'ramda';
+import { MediaTypes } from '@speclynx/apidom-core';
+
+/**
+ * @public
+ */
+export type Format = 'generic' | 'json' | 'yaml';
+
+/**
+ * @public
+ */
+export class OpenAPIMediaTypes extends MediaTypes<string> {
+  filterByFormat(format: Format = 'generic') {
+    const effectiveFormat = format === 'generic' ? 'openapi;version' : format;
+    return this.filter((mediaType) => mediaType.includes(effectiveFormat));
+  }
+
+  findBy(version = '3.1.2', format: Format = 'generic') {
+    const search =
+      format === 'generic' ? `openapi;version=${version}` : `openapi+${format};version=${version}`;
+    const found = this.find((mediaType) => mediaType.includes(search));
+
+    return found || this.unknownMediaType;
+  }
+
+  latest(format: Format = 'generic') {
+    return last(this.filterByFormat(format)) as string;
+  }
+}
+
+/**
+ * @public
+ */
+const mediaTypes = new OpenAPIMediaTypes(
+  'application/openapi;version=3.1.0',
+  'application/openapi+json;version=3.1.0',
+  'application/openapi+yaml;version=3.1.0',
+  'application/openapi;version=3.1.1',
+  'application/openapi+json;version=3.1.1',
+  'application/openapi+yaml;version=3.1.1',
+  'application/openapi;version=3.1.2',
+  'application/openapi+json;version=3.1.2',
+  'application/openapi+yaml;version=3.1.2',
+);
+
+export default mediaTypes;

package/src/namespace.cjs

@@ -0,0 +1,81 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _Callback = _interopRequireDefault(require("./elements/Callback.cjs"));
+var _Components = _interopRequireDefault(require("./elements/Components.cjs"));
+var _Contact = _interopRequireDefault(require("./elements/Contact.cjs"));
+var _Discriminator = _interopRequireDefault(require("./elements/Discriminator.cjs"));
+var _Encoding = _interopRequireDefault(require("./elements/Encoding.cjs"));
+var _Example = _interopRequireDefault(require("./elements/Example.cjs"));
+var _ExternalDocumentation = _interopRequireDefault(require("./elements/ExternalDocumentation.cjs"));
+var _Header = _interopRequireDefault(require("./elements/Header.cjs"));
+var _Info = _interopRequireDefault(require("./elements/Info.cjs"));
+var _JsonSchemaDialect = _interopRequireDefault(require("./elements/JsonSchemaDialect.cjs"));
+var _License = _interopRequireDefault(require("./elements/License.cjs"));
+var _Link = _interopRequireDefault(require("./elements/Link.cjs"));
+var _MediaType = _interopRequireDefault(require("./elements/MediaType.cjs"));
+var _OAuthFlow = _interopRequireDefault(require("./elements/OAuthFlow.cjs"));
+var _OAuthFlows = _interopRequireDefault(require("./elements/OAuthFlows.cjs"));
+var _Openapi = _interopRequireDefault(require("./elements/Openapi.cjs"));
+var _OpenApi = _interopRequireDefault(require("./elements/OpenApi3-1.cjs"));
+var _Operation = _interopRequireDefault(require("./elements/Operation.cjs"));
+var _Parameter = _interopRequireDefault(require("./elements/Parameter.cjs"));
+var _PathItem = _interopRequireDefault(require("./elements/PathItem.cjs"));
+var _Paths = _interopRequireDefault(require("./elements/Paths.cjs"));
+var _Reference = _interopRequireDefault(require("./elements/Reference.cjs"));
+var _RequestBody = _interopRequireDefault(require("./elements/RequestBody.cjs"));
+var _Response = _interopRequireDefault(require("./elements/Response.cjs"));
+var _Responses = _interopRequireDefault(require("./elements/Responses.cjs"));
+var _Schema = _interopRequireDefault(require("./elements/Schema.cjs"));
+var _SecurityRequirement = _interopRequireDefault(require("./elements/SecurityRequirement.cjs"));
+var _SecurityScheme = _interopRequireDefault(require("./elements/SecurityScheme.cjs"));
+var _Server = _interopRequireDefault(require("./elements/Server.cjs"));
+var _ServerVariable = _interopRequireDefault(require("./elements/ServerVariable.cjs"));
+var _Tag = _interopRequireDefault(require("./elements/Tag.cjs"));
+var _Xml = _interopRequireDefault(require("./elements/Xml.cjs"));
+/**
+ * @public
+ */
+const openApi3_1 = {
+  namespace: options => {
+    const {
+      base
+    } = options;
+    base.register('callback', _Callback.default);
+    base.register('components', _Components.default);
+    base.register('contact', _Contact.default);
+    base.register('discriminator', _Discriminator.default);
+    base.register('encoding', _Encoding.default);
+    base.register('example', _Example.default);
+    base.register('externalDocumentation', _ExternalDocumentation.default);
+    base.register('header', _Header.default);
+    base.register('info', _Info.default);
+    base.register('jsonSchemaDialect', _JsonSchemaDialect.default);
+    base.register('license', _License.default);
+    base.register('link', _Link.default);
+    base.register('mediaType', _MediaType.default);
+    base.register('oAuthFlow', _OAuthFlow.default);
+    base.register('oAuthFlows', _OAuthFlows.default);
+    base.register('openapi', _Openapi.default);
+    base.register('openApi3_1', _OpenApi.default);
+    base.register('operation', _Operation.default);
+    base.register('parameter', _Parameter.default);
+    base.register('pathItem', _PathItem.default);
+    base.register('paths', _Paths.default);
+    base.register('reference', _Reference.default);
+    base.register('requestBody', _RequestBody.default);
+    base.register('response', _Response.default);
+    base.register('responses', _Responses.default);
+    base.register('schema', _Schema.default);
+    base.register('securityRequirement', _SecurityRequirement.default);
+    base.register('securityScheme', _SecurityScheme.default);
+    base.register('server', _Server.default);
+    base.register('serverVariable', _ServerVariable.default);
+    base.register('tag', _Tag.default);
+    base.register('xml', _Xml.default);
+    return base;
+  }
+};
+var _default = exports.default = openApi3_1;

package/src/namespace.mjs

@@ -0,0 +1,76 @@
+import CallbackElement from "./elements/Callback.mjs";
+import ComponentsElement from "./elements/Components.mjs";
+import ContactElement from "./elements/Contact.mjs";
+import DiscriminatorElement from "./elements/Discriminator.mjs";
+import EncodingElement from "./elements/Encoding.mjs";
+import ExampleElement from "./elements/Example.mjs";
+import ExternalDocumentationElement from "./elements/ExternalDocumentation.mjs";
+import HeaderElement from "./elements/Header.mjs";
+import InfoElement from "./elements/Info.mjs";
+import JsonSchemaDialectElement from "./elements/JsonSchemaDialect.mjs";
+import LicenseElement from "./elements/License.mjs";
+import LinkElement from "./elements/Link.mjs";
+import MediaTypeElement from "./elements/MediaType.mjs";
+import OAuthFlowElement from "./elements/OAuthFlow.mjs";
+import OAuthFlowsElement from "./elements/OAuthFlows.mjs";
+import OpenapiElement from "./elements/Openapi.mjs";
+import OpenApi3_1Element from "./elements/OpenApi3-1.mjs";
+import OperationElement from "./elements/Operation.mjs";
+import ParameterElement from "./elements/Parameter.mjs";
+import PathItemElement from "./elements/PathItem.mjs";
+import PathsElement from "./elements/Paths.mjs";
+import ReferenceElement from "./elements/Reference.mjs";
+import RequestBodyElement from "./elements/RequestBody.mjs";
+import ResponseElement from "./elements/Response.mjs";
+import ResponsesElement from "./elements/Responses.mjs";
+import SchemaElement from "./elements/Schema.mjs";
+import SecurityRequirementElement from "./elements/SecurityRequirement.mjs";
+import SecuritySchemeElement from "./elements/SecurityScheme.mjs";
+import ServerElement from "./elements/Server.mjs";
+import ServerVariableElement from "./elements/ServerVariable.mjs";
+import TagElement from "./elements/Tag.mjs";
+import XmlElement from "./elements/Xml.mjs";
+/**
+ * @public
+ */
+const openApi3_1 = {
+  namespace: options => {
+    const {
+      base
+    } = options;
+    base.register('callback', CallbackElement);
+    base.register('components', ComponentsElement);
+    base.register('contact', ContactElement);
+    base.register('discriminator', DiscriminatorElement);
+    base.register('encoding', EncodingElement);
+    base.register('example', ExampleElement);
+    base.register('externalDocumentation', ExternalDocumentationElement);
+    base.register('header', HeaderElement);
+    base.register('info', InfoElement);
+    base.register('jsonSchemaDialect', JsonSchemaDialectElement);
+    base.register('license', LicenseElement);
+    base.register('link', LinkElement);
+    base.register('mediaType', MediaTypeElement);
+    base.register('oAuthFlow', OAuthFlowElement);
+    base.register('oAuthFlows', OAuthFlowsElement);
+    base.register('openapi', OpenapiElement);
+    base.register('openApi3_1', OpenApi3_1Element);
+    base.register('operation', OperationElement);
+    base.register('parameter', ParameterElement);
+    base.register('pathItem', PathItemElement);
+    base.register('paths', PathsElement);
+    base.register('reference', ReferenceElement);
+    base.register('requestBody', RequestBodyElement);
+    base.register('response', ResponseElement);
+    base.register('responses', ResponsesElement);
+    base.register('schema', SchemaElement);
+    base.register('securityRequirement', SecurityRequirementElement);
+    base.register('securityScheme', SecuritySchemeElement);
+    base.register('server', ServerElement);
+    base.register('serverVariable', ServerVariableElement);
+    base.register('tag', TagElement);
+    base.register('xml', XmlElement);
+    return base;
+  }
+};
+export default openApi3_1;

package/src/namespace.ts

@@ -0,0 +1,80 @@
+import { NamespacePlugin } from '@speclynx/apidom-datamodel';
+
+import CallbackElement from './elements/Callback.ts';
+import ComponentsElement from './elements/Components.ts';
+import ContactElement from './elements/Contact.ts';
+import DiscriminatorElement from './elements/Discriminator.ts';
+import EncodingElement from './elements/Encoding.ts';
+import ExampleElement from './elements/Example.ts';
+import ExternalDocumentationElement from './elements/ExternalDocumentation.ts';
+import HeaderElement from './elements/Header.ts';
+import InfoElement from './elements/Info.ts';
+import JsonSchemaDialectElement from './elements/JsonSchemaDialect.ts';
+import LicenseElement from './elements/License.ts';
+import LinkElement from './elements/Link.ts';
+import MediaTypeElement from './elements/MediaType.ts';
+import OAuthFlowElement from './elements/OAuthFlow.ts';
+import OAuthFlowsElement from './elements/OAuthFlows.ts';
+import OpenapiElement from './elements/Openapi.ts';
+import OpenApi3_1Element from './elements/OpenApi3-1.ts';
+import OperationElement from './elements/Operation.ts';
+import ParameterElement from './elements/Parameter.ts';
+import PathItemElement from './elements/PathItem.ts';
+import PathsElement from './elements/Paths.ts';
+import ReferenceElement from './elements/Reference.ts';
+import RequestBodyElement from './elements/RequestBody.ts';
+import ResponseElement from './elements/Response.ts';
+import ResponsesElement from './elements/Responses.ts';
+import SchemaElement from './elements/Schema.ts';
+import SecurityRequirementElement from './elements/SecurityRequirement.ts';
+import SecuritySchemeElement from './elements/SecurityScheme.ts';
+import ServerElement from './elements/Server.ts';
+import ServerVariableElement from './elements/ServerVariable.ts';
+import TagElement from './elements/Tag.ts';
+import XmlElement from './elements/Xml.ts';
+
+/**
+ * @public
+ */
+const openApi3_1: NamespacePlugin = {
+  namespace: (options) => {
+    const { base } = options;
+
+    base.register('callback', CallbackElement);
+    base.register('components', ComponentsElement);
+    base.register('contact', ContactElement);
+    base.register('discriminator', DiscriminatorElement);
+    base.register('encoding', EncodingElement);
+    base.register('example', ExampleElement);
+    base.register('externalDocumentation', ExternalDocumentationElement);
+    base.register('header', HeaderElement);
+    base.register('info', InfoElement);
+    base.register('jsonSchemaDialect', JsonSchemaDialectElement);
+    base.register('license', LicenseElement);
+    base.register('link', LinkElement);
+    base.register('mediaType', MediaTypeElement);
+    base.register('oAuthFlow', OAuthFlowElement);
+    base.register('oAuthFlows', OAuthFlowsElement);
+    base.register('openapi', OpenapiElement);
+    base.register('openApi3_1', OpenApi3_1Element);
+    base.register('operation', OperationElement);
+    base.register('parameter', ParameterElement);
+    base.register('pathItem', PathItemElement);
+    base.register('paths', PathsElement);
+    base.register('reference', ReferenceElement);
+    base.register('requestBody', RequestBodyElement);
+    base.register('response', ResponseElement);
+    base.register('responses', ResponsesElement);
+    base.register('schema', SchemaElement);
+    base.register('securityRequirement', SecurityRequirementElement);
+    base.register('securityScheme', SecuritySchemeElement);
+    base.register('server', ServerElement);
+    base.register('serverVariable', ServerVariableElement);
+    base.register('tag', TagElement);
+    base.register('xml', XmlElement);
+
+    return base;
+  },
+};
+
+export default openApi3_1;

package/src/predicates.cjs

@@ -0,0 +1,228 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+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;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomCore = require("@speclynx/apidom-core");
+var _Callback = _interopRequireDefault(require("./elements/Callback.cjs"));
+var _Components = _interopRequireDefault(require("./elements/Components.cjs"));
+var _Contact = _interopRequireDefault(require("./elements/Contact.cjs"));
+var _Example = _interopRequireDefault(require("./elements/Example.cjs"));
+var _ExternalDocumentation = _interopRequireDefault(require("./elements/ExternalDocumentation.cjs"));
+var _Header = _interopRequireDefault(require("./elements/Header.cjs"));
+var _Info = _interopRequireDefault(require("./elements/Info.cjs"));
+var _JsonSchemaDialect = _interopRequireDefault(require("./elements/JsonSchemaDialect.cjs"));
+var _License = _interopRequireDefault(require("./elements/License.cjs"));
+var _Link = _interopRequireDefault(require("./elements/Link.cjs"));
+var _Openapi = _interopRequireDefault(require("./elements/Openapi.cjs"));
+var _OpenApi = _interopRequireDefault(require("./elements/OpenApi3-1.cjs"));
+var _Operation = _interopRequireDefault(require("./elements/Operation.cjs"));
+var _Parameter = _interopRequireDefault(require("./elements/Parameter.cjs"));
+var _PathItem = _interopRequireDefault(require("./elements/PathItem.cjs"));
+var _Paths = _interopRequireDefault(require("./elements/Paths.cjs"));
+var _Reference = _interopRequireDefault(require("./elements/Reference.cjs"));
+var _RequestBody = _interopRequireDefault(require("./elements/RequestBody.cjs"));
+var _Response = _interopRequireDefault(require("./elements/Response.cjs"));
+var _Responses = _interopRequireDefault(require("./elements/Responses.cjs"));
+var _Schema = _interopRequireDefault(require("./elements/Schema.cjs"));
+var _SecurityRequirement = _interopRequireDefault(require("./elements/SecurityRequirement.cjs"));
+var _SecurityScheme = _interopRequireDefault(require("./elements/SecurityScheme.cjs"));
+var _Server = _interopRequireDefault(require("./elements/Server.cjs"));
+var _ServerVariable = _interopRequireDefault(require("./elements/ServerVariable.cjs"));
+var _MediaType = _interopRequireDefault(require("./elements/MediaType.cjs"));
+var _apidomNsJsonSchema = require("@speclynx/apidom-ns-json-schema-2020-12");
+exports.isBooleanJSONSchemaElement = _apidomNsJsonSchema.isBooleanJSONSchemaElement;
+/**
+ * @public
+ */
+const isCallbackElement = element => element instanceof _Callback.default;
+
+/**
+ * @public
+ */
+exports.isCallbackElement = isCallbackElement;
+const isComponentsElement = element => element instanceof _Components.default;
+
+/**
+ * @public
+ */
+exports.isComponentsElement = isComponentsElement;
+const isContactElement = element => element instanceof _Contact.default;
+
+/**
+ * @public
+ */
+exports.isContactElement = isContactElement;
+const isExampleElement = element => element instanceof _Example.default;
+
+/**
+ * @public
+ */
+exports.isExampleElement = isExampleElement;
+const isExternalDocumentationElement = element => element instanceof _ExternalDocumentation.default;
+
+/**
+ * @public
+ */
+exports.isExternalDocumentationElement = isExternalDocumentationElement;
+const isHeaderElement = element => element instanceof _Header.default;
+
+/**
+ * @public
+ */
+exports.isHeaderElement = isHeaderElement;
+const isInfoElement = element => element instanceof _Info.default;
+
+/**
+ * @public
+ */
+exports.isInfoElement = isInfoElement;
+const isJsonSchemaDialectElement = element => element instanceof _JsonSchemaDialect.default;
+
+/**
+ * @public
+ */
+exports.isJsonSchemaDialectElement = isJsonSchemaDialectElement;
+const isLicenseElement = element => element instanceof _License.default;
+
+/**
+ * @public
+ */
+exports.isLicenseElement = isLicenseElement;
+const isLinkElement = element => element instanceof _Link.default;
+
+/**
+ * @public
+ */
+exports.isLinkElement = isLinkElement;
+const isOpenapiElement = element => element instanceof _Openapi.default;
+
+/**
+ * @public
+ */
+exports.isOpenapiElement = isOpenapiElement;
+const isOpenApi3_1Element = element => element instanceof _OpenApi.default;
+
+/**
+ * @public
+ */
+exports.isOpenApi3_1Element = isOpenApi3_1Element;
+const isOperationElement = element => element instanceof _Operation.default;
+
+/**
+ * @public
+ */
+exports.isOperationElement = isOperationElement;
+const isParameterElement = element => element instanceof _Parameter.default;
+
+/**
+ * @public
+ */
+exports.isParameterElement = isParameterElement;
+const isPathItemElement = element => element instanceof _PathItem.default;
+
+/**
+ * @deprecated
+ * Determining whether a PathItemElement is external or internal is not possible by just looking
+ * at value of the $ref fixed field. The value of the $ref field needs to be resolved in runtime
+ * using the referring document as the Base URI.
+ * @public
+ */
+exports.isPathItemElement = isPathItemElement;
+const isPathItemElementExternal = element => {
+  if (!isPathItemElement(element)) {
+    return false;
+  }
+  if (!(0, _apidomDatamodel.isStringElement)(element.$ref)) {
+    return false;
+  }
+  const value = (0, _apidomCore.toValue)(element.$ref);
+  return typeof value === 'string' && value.length > 0 && !value.startsWith('#');
+};
+
+/**
+ * @public
+ */
+exports.isPathItemElementExternal = isPathItemElementExternal;
+const isPathsElement = element => element instanceof _Paths.default;
+
+/**
+ * @public
+ */
+exports.isPathsElement = isPathsElement;
+const isReferenceElement = element => element instanceof _Reference.default;
+
+/**
+ * @deprecated
+ * Determining whether a ReferenceElement is external or internal is not possible by just looking
+ * at value of the $ref fixed field. The value of the $ref field needs to be resolved in runtime
+ * using the referring document as the Base URI.
+ * @public
+ */
+exports.isReferenceElement = isReferenceElement;
+const isReferenceElementExternal = element => {
+  if (!isReferenceElement(element)) {
+    return false;
+  }
+  if (!(0, _apidomDatamodel.isStringElement)(element.$ref)) {
+    return false;
+  }
+  const value = (0, _apidomCore.toValue)(element.$ref);
+  return typeof value === 'string' && value.length > 0 && !value.startsWith('#');
+};
+
+/**
+ * @public
+ */
+exports.isReferenceElementExternal = isReferenceElementExternal;
+const isRequestBodyElement = element => element instanceof _RequestBody.default;
+
+/**
+ * @public
+ */
+exports.isRequestBodyElement = isRequestBodyElement;
+const isResponseElement = element => element instanceof _Response.default;
+
+/**
+ * @public
+ */
+exports.isResponseElement = isResponseElement;
+const isResponsesElement = element => element instanceof _Responses.default;
+
+/**
+ * @public
+ */
+exports.isResponsesElement = isResponsesElement;
+const isSchemaElement = element => element instanceof _Schema.default;
+
+/**
+ * @public
+ */
+exports.isSchemaElement = isSchemaElement;
+const isSecurityRequirementElement = element => element instanceof _SecurityRequirement.default;
+
+/**
+ * @public
+ */
+exports.isSecurityRequirementElement = isSecurityRequirementElement;
+const isSecuritySchemeElement = element => element instanceof _SecurityScheme.default;
+
+/**
+ * @public
+ */
+exports.isSecuritySchemeElement = isSecuritySchemeElement;
+const isServerElement = element => element instanceof _Server.default;
+
+/**
+ * @public
+ */
+exports.isServerElement = isServerElement;
+const isServerVariableElement = element => element instanceof _ServerVariable.default;
+
+/**
+ * @public
+ */
+exports.isServerVariableElement = isServerVariableElement;
+const isMediaTypeElement = element => element instanceof _MediaType.default;
+exports.isMediaTypeElement = isMediaTypeElement;