@speclynx/apidom-ns-openapi-2 4.0.2 → 4.0.4

package/src/predicates.cjs

@@ -0,0 +1,193 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.isXmlElement = exports.isTagElement = exports.isSwaggerVersionElement = exports.isSwaggerElement = exports.isSecuritySchemeElement = exports.isSecurityRequirementElement = exports.isSecurityDefinitionsElement = exports.isScopesElement = exports.isSchemaElement = exports.isResponsesElement = exports.isResponsesDefinitionsElement = exports.isResponseElement = exports.isReferenceElement = exports.isPathsElement = exports.isPathItemElement = exports.isParametersDefinitionsElement = exports.isParameterElement = exports.isOperationElement = exports.isLicenseElement = exports.isItemsElement = exports.isInfoElement = exports.isHeadersElement = exports.isHeaderElement = exports.isExternalDocumentationElement = exports.isExampleElement = exports.isDefinitionsElement = exports.isContactElement = void 0;
+var _Swagger = _interopRequireDefault(require("./elements/Swagger.cjs"));
+var _SwaggerVersion = _interopRequireDefault(require("./elements/SwaggerVersion.cjs"));
+var _Info = _interopRequireDefault(require("./elements/Info.cjs"));
+var _Contact = _interopRequireDefault(require("./elements/Contact.cjs"));
+var _License = _interopRequireDefault(require("./elements/License.cjs"));
+var _Paths = _interopRequireDefault(require("./elements/Paths.cjs"));
+var _PathItem = _interopRequireDefault(require("./elements/PathItem.cjs"));
+var _Operation = _interopRequireDefault(require("./elements/Operation.cjs"));
+var _ExternalDocumentation = _interopRequireDefault(require("./elements/ExternalDocumentation.cjs"));
+var _Parameter = _interopRequireDefault(require("./elements/Parameter.cjs"));
+var _Items = _interopRequireDefault(require("./elements/Items.cjs"));
+var _Example = _interopRequireDefault(require("./elements/Example.cjs"));
+var _Responses = _interopRequireDefault(require("./elements/Responses.cjs"));
+var _Response = _interopRequireDefault(require("./elements/Response.cjs"));
+var _Headers = _interopRequireDefault(require("./elements/Headers.cjs"));
+var _Header = _interopRequireDefault(require("./elements/Header.cjs"));
+var _Tag = _interopRequireDefault(require("./elements/Tag.cjs"));
+var _Reference = _interopRequireDefault(require("./elements/Reference.cjs"));
+var _Schema = _interopRequireDefault(require("./elements/Schema.cjs"));
+var _Xml = _interopRequireDefault(require("./elements/Xml.cjs"));
+var _Definitions = _interopRequireDefault(require("./elements/Definitions.cjs"));
+var _ParametersDefinitions = _interopRequireDefault(require("./elements/ParametersDefinitions.cjs"));
+var _ResponsesDefinitions = _interopRequireDefault(require("./elements/ResponsesDefinitions.cjs"));
+var _SecurityDefinitions = _interopRequireDefault(require("./elements/SecurityDefinitions.cjs"));
+var _SecurityScheme = _interopRequireDefault(require("./elements/SecurityScheme.cjs"));
+var _SecurityRequirement = _interopRequireDefault(require("./elements/SecurityRequirement.cjs"));
+var _Scopes = _interopRequireDefault(require("./elements/Scopes.cjs"));
+/**
+ * @public
+ */
+const isSwaggerElement = element => element instanceof _Swagger.default;
+
+/**
+ * @public
+ */
+exports.isSwaggerElement = isSwaggerElement;
+const isSwaggerVersionElement = element => element instanceof _SwaggerVersion.default;
+
+/**
+ * @public
+ */
+exports.isSwaggerVersionElement = isSwaggerVersionElement;
+const isInfoElement = element => element instanceof _Info.default;
+
+/**
+ * @public
+ */
+exports.isInfoElement = isInfoElement;
+const isLicenseElement = element => element instanceof _License.default;
+
+/**
+ * @public
+ */
+exports.isLicenseElement = isLicenseElement;
+const isContactElement = element => element instanceof _Contact.default;
+
+/**
+ * @public
+ */
+exports.isContactElement = isContactElement;
+const isPathsElement = element => element instanceof _Paths.default;
+
+/**
+ * @public
+ */
+exports.isPathsElement = isPathsElement;
+const isPathItemElement = element => element instanceof _PathItem.default;
+
+/**
+ * @public
+ */
+exports.isPathItemElement = isPathItemElement;
+const isOperationElement = element => element instanceof _Operation.default;
+
+/**
+ * @public
+ */
+exports.isOperationElement = isOperationElement;
+const isExternalDocumentationElement = element => element instanceof _ExternalDocumentation.default;
+
+/**
+ * @public
+ */
+exports.isExternalDocumentationElement = isExternalDocumentationElement;
+const isParameterElement = element => element instanceof _Parameter.default;
+
+/**
+ * @public
+ */
+exports.isParameterElement = isParameterElement;
+const isItemsElement = element => element instanceof _Items.default;
+
+/**
+ * @public
+ */
+exports.isItemsElement = isItemsElement;
+const isResponsesElement = element => element instanceof _Responses.default;
+
+/**
+ * @public
+ */
+exports.isResponsesElement = isResponsesElement;
+const isResponseElement = element => element instanceof _Response.default;
+
+/**
+ * @public
+ */
+exports.isResponseElement = isResponseElement;
+const isHeadersElement = element => element instanceof _Headers.default;
+
+/**
+ * @public
+ */
+exports.isHeadersElement = isHeadersElement;
+const isExampleElement = element => element instanceof _Example.default;
+
+/**
+ * @public
+ */
+exports.isExampleElement = isExampleElement;
+const isHeaderElement = element => element instanceof _Header.default;
+
+/**
+ * @public
+ */
+exports.isHeaderElement = isHeaderElement;
+const isTagElement = element => element instanceof _Tag.default;
+
+/**
+ * @public
+ */
+exports.isTagElement = isTagElement;
+const isReferenceElement = element => element instanceof _Reference.default;
+
+/**
+ * @public
+ */
+exports.isReferenceElement = isReferenceElement;
+const isSchemaElement = element => element instanceof _Schema.default;
+
+/**
+ * @public
+ */
+exports.isSchemaElement = isSchemaElement;
+const isXmlElement = element => element instanceof _Xml.default;
+
+/**
+ * @public
+ */
+exports.isXmlElement = isXmlElement;
+const isResponsesDefinitionsElement = element => element instanceof _ResponsesDefinitions.default;
+
+/**
+ * @public
+ */
+exports.isResponsesDefinitionsElement = isResponsesDefinitionsElement;
+const isSecurityDefinitionsElement = element => element instanceof _SecurityDefinitions.default;
+
+/**
+ * @public
+ */
+exports.isSecurityDefinitionsElement = isSecurityDefinitionsElement;
+const isDefinitionsElement = element => element instanceof _Definitions.default;
+
+/**
+ * @public
+ */
+exports.isDefinitionsElement = isDefinitionsElement;
+const isParametersDefinitionsElement = element => element instanceof _ParametersDefinitions.default;
+
+/**
+ * @public
+ */
+exports.isParametersDefinitionsElement = isParametersDefinitionsElement;
+const isSecuritySchemeElement = element => element instanceof _SecurityScheme.default;
+
+/**
+ * @public
+ */
+exports.isSecuritySchemeElement = isSecuritySchemeElement;
+const isScopesElement = element => element instanceof _Scopes.default;
+
+/**
+ * @public
+ */
+exports.isScopesElement = isScopesElement;
+const isSecurityRequirementElement = element => element instanceof _SecurityRequirement.default;
+exports.isSecurityRequirementElement = isSecurityRequirementElement;

package/src/predicates.mjs

@@ -0,0 +1,161 @@
+import SwaggerElement from "./elements/Swagger.mjs";
+import SwaggerVersionElement from "./elements/SwaggerVersion.mjs";
+import InfoElement from "./elements/Info.mjs";
+import ContactElement from "./elements/Contact.mjs";
+import LicenseElement from "./elements/License.mjs";
+import PathsElement from "./elements/Paths.mjs";
+import PathItemElement from "./elements/PathItem.mjs";
+import OperationElement from "./elements/Operation.mjs";
+import ExternalDocumentationElement from "./elements/ExternalDocumentation.mjs";
+import ParameterElement from "./elements/Parameter.mjs";
+import ItemsElement from "./elements/Items.mjs";
+import ExampleElement from "./elements/Example.mjs";
+import ResponsesElement from "./elements/Responses.mjs";
+import ResponseElement from "./elements/Response.mjs";
+import HeadersElement from "./elements/Headers.mjs";
+import HeaderElement from "./elements/Header.mjs";
+import TagElement from "./elements/Tag.mjs";
+import ReferenceElement from "./elements/Reference.mjs";
+import SchemaElement from "./elements/Schema.mjs";
+import XmlElement from "./elements/Xml.mjs";
+import DefinitionsElement from "./elements/Definitions.mjs";
+import ParametersDefinitionsElement from "./elements/ParametersDefinitions.mjs";
+import ResponsesDefinitionsElement from "./elements/ResponsesDefinitions.mjs";
+import SecurityDefinitionsElement from "./elements/SecurityDefinitions.mjs";
+import SecuritySchemeElement from "./elements/SecurityScheme.mjs";
+import SecurityRequirementElement from "./elements/SecurityRequirement.mjs";
+import ScopesElement from "./elements/Scopes.mjs";
+/**
+ * @public
+ */
+export const isSwaggerElement = element => element instanceof SwaggerElement;
+
+/**
+ * @public
+ */
+export const isSwaggerVersionElement = element => element instanceof SwaggerVersionElement;
+
+/**
+ * @public
+ */
+export const isInfoElement = element => element instanceof InfoElement;
+
+/**
+ * @public
+ */
+export const isLicenseElement = element => element instanceof LicenseElement;
+
+/**
+ * @public
+ */
+export const isContactElement = element => element instanceof ContactElement;
+
+/**
+ * @public
+ */
+export const isPathsElement = element => element instanceof PathsElement;
+
+/**
+ * @public
+ */
+export const isPathItemElement = element => element instanceof PathItemElement;
+
+/**
+ * @public
+ */
+export const isOperationElement = element => element instanceof OperationElement;
+
+/**
+ * @public
+ */
+export const isExternalDocumentationElement = element => element instanceof ExternalDocumentationElement;
+
+/**
+ * @public
+ */
+export const isParameterElement = element => element instanceof ParameterElement;
+
+/**
+ * @public
+ */
+export const isItemsElement = element => element instanceof ItemsElement;
+
+/**
+ * @public
+ */
+export const isResponsesElement = element => element instanceof ResponsesElement;
+
+/**
+ * @public
+ */
+export const isResponseElement = element => element instanceof ResponseElement;
+
+/**
+ * @public
+ */
+export const isHeadersElement = element => element instanceof HeadersElement;
+
+/**
+ * @public
+ */
+export const isExampleElement = element => element instanceof ExampleElement;
+
+/**
+ * @public
+ */
+export const isHeaderElement = element => element instanceof HeaderElement;
+
+/**
+ * @public
+ */
+export const isTagElement = element => element instanceof TagElement;
+
+/**
+ * @public
+ */
+export const isReferenceElement = element => element instanceof ReferenceElement;
+
+/**
+ * @public
+ */
+export const isSchemaElement = element => element instanceof SchemaElement;
+
+/**
+ * @public
+ */
+export const isXmlElement = element => element instanceof XmlElement;
+
+/**
+ * @public
+ */
+export const isResponsesDefinitionsElement = element => element instanceof ResponsesDefinitionsElement;
+
+/**
+ * @public
+ */
+export const isSecurityDefinitionsElement = element => element instanceof SecurityDefinitionsElement;
+
+/**
+ * @public
+ */
+export const isDefinitionsElement = element => element instanceof DefinitionsElement;
+
+/**
+ * @public
+ */
+export const isParametersDefinitionsElement = element => element instanceof ParametersDefinitionsElement;
+
+/**
+ * @public
+ */
+export const isSecuritySchemeElement = element => element instanceof SecuritySchemeElement;
+
+/**
+ * @public
+ */
+export const isScopesElement = element => element instanceof ScopesElement;
+
+/**
+ * @public
+ */
+export const isSecurityRequirementElement = element => element instanceof SecurityRequirementElement;

package/src/refractor/index.cjs

@@ -0,0 +1,316 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.refractXml = exports.refractTag = exports.refractSwagger = exports.refractSecurityScheme = exports.refractSecurityRequirement = exports.refractSecurityDefinitions = exports.refractScopes = exports.refractSchema = exports.refractResponsesDefinitions = exports.refractResponses = exports.refractResponse = exports.refractReference = exports.refractPaths = exports.refractPathItem = exports.refractParametersDefinitions = exports.refractParameter = exports.refractOperation = exports.refractLicense = exports.refractItems = exports.refractInfo = exports.refractHeaders = exports.refractHeader = exports.refractExternalDocumentation = exports.refractExample = exports.refractDefinitions = exports.refractContact = exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
+var _ramda = require("ramda");
+var _specification = _interopRequireDefault(require("./specification.cjs"));
+var _toolbox = _interopRequireDefault(require("./toolbox.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+const refract = (value, {
+  element = 'swagger',
+  plugins = [],
+  specificationObj = _specification.default,
+  consume = false
+} = {}) => {
+  const genericElement = (0, _apidomDatamodel.refract)(value);
+  const resolvedSpec = (0, _apidomCore.resolveSpecification)(specificationObj);
+  const elementMap = resolvedSpec.elementMap;
+  const specPath = elementMap[element];
+  if (!specPath) {
+    throw new Error(`Unknown element type: "${element}"`);
+  }
+
+  /**
+   * This is where generic ApiDOM becomes semantic (namespace applied).
+   * We don't allow consumers to hook into this translation.
+   * Though we allow consumers to define their own plugins on already transformed ApiDOM.
+   */
+  const RootVisitorClass = (0, _ramda.path)(specPath, resolvedSpec);
+  const rootVisitor = new RootVisitorClass({
+    specObj: resolvedSpec,
+    consume
+  });
+  (0, _apidomTraverse.traverse)(genericElement, rootVisitor);
+
+  /**
+   * Running plugins visitors means extra single traversal === performance hit.
+   */
+  return (0, _apidomCore.dispatchRefractorPlugins)(rootVisitor.element, plugins, {
+    toolboxCreator: _toolbox.default
+  });
+};
+
+/**
+ * Refracts a value into a SwaggerElement.
+ * @public
+ */
+const refractSwagger = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'swagger'
+});
+
+/**
+ * Refracts a value into an InfoElement.
+ * @public
+ */
+exports.refractSwagger = refractSwagger;
+const refractInfo = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'info'
+});
+
+/**
+ * Refracts a value into a ContactElement.
+ * @public
+ */
+exports.refractInfo = refractInfo;
+const refractContact = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'contact'
+});
+
+/**
+ * Refracts a value into a LicenseElement.
+ * @public
+ */
+exports.refractContact = refractContact;
+const refractLicense = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'license'
+});
+
+/**
+ * Refracts a value into a PathsElement.
+ * @public
+ */
+exports.refractLicense = refractLicense;
+const refractPaths = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'paths'
+});
+
+/**
+ * Refracts a value into a PathItemElement.
+ * @public
+ */
+exports.refractPaths = refractPaths;
+const refractPathItem = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'pathItem'
+});
+
+/**
+ * Refracts a value into an OperationElement.
+ * @public
+ */
+exports.refractPathItem = refractPathItem;
+const refractOperation = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'operation'
+});
+
+/**
+ * Refracts a value into an ExternalDocumentationElement.
+ * @public
+ */
+exports.refractOperation = refractOperation;
+const refractExternalDocumentation = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'externalDocumentation'
+});
+
+/**
+ * Refracts a value into a ParameterElement.
+ * @public
+ */
+exports.refractExternalDocumentation = refractExternalDocumentation;
+const refractParameter = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'parameter'
+});
+
+/**
+ * Refracts a value into an ItemsElement.
+ * @public
+ */
+exports.refractParameter = refractParameter;
+const refractItems = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'items'
+});
+
+/**
+ * Refracts a value into a ResponsesElement.
+ * @public
+ */
+exports.refractItems = refractItems;
+const refractResponses = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'responses'
+});
+
+/**
+ * Refracts a value into a ResponseElement.
+ * @public
+ */
+exports.refractResponses = refractResponses;
+const refractResponse = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'response'
+});
+
+/**
+ * Refracts a value into a HeadersElement.
+ * @public
+ */
+exports.refractResponse = refractResponse;
+const refractHeaders = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'headers'
+});
+
+/**
+ * Refracts a value into an ExampleElement.
+ * @public
+ */
+exports.refractHeaders = refractHeaders;
+const refractExample = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'example'
+});
+
+/**
+ * Refracts a value into a HeaderElement.
+ * @public
+ */
+exports.refractExample = refractExample;
+const refractHeader = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'header'
+});
+
+/**
+ * Refracts a value into a TagElement.
+ * @public
+ */
+exports.refractHeader = refractHeader;
+const refractTag = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'tag'
+});
+
+/**
+ * Refracts a value into a ReferenceElement.
+ * @public
+ */
+exports.refractTag = refractTag;
+const refractReference = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'reference'
+});
+
+/**
+ * Refracts a value into a SchemaElement.
+ * @public
+ */
+exports.refractReference = refractReference;
+const refractSchema = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'schema'
+});
+
+/**
+ * Refracts a value into an XmlElement.
+ * @public
+ */
+exports.refractSchema = refractSchema;
+const refractXml = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'xml'
+});
+
+/**
+ * Refracts a value into a DefinitionsElement.
+ * @public
+ */
+exports.refractXml = refractXml;
+const refractDefinitions = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'definitions'
+});
+
+/**
+ * Refracts a value into a ParametersDefinitionsElement.
+ * @public
+ */
+exports.refractDefinitions = refractDefinitions;
+const refractParametersDefinitions = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'parametersDefinitions'
+});
+
+/**
+ * Refracts a value into a ResponsesDefinitionsElement.
+ * @public
+ */
+exports.refractParametersDefinitions = refractParametersDefinitions;
+const refractResponsesDefinitions = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'responsesDefinitions'
+});
+
+/**
+ * Refracts a value into a SecurityDefinitionsElement.
+ * @public
+ */
+exports.refractResponsesDefinitions = refractResponsesDefinitions;
+const refractSecurityDefinitions = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityDefinitions'
+});
+
+/**
+ * Refracts a value into a SecuritySchemeElement.
+ * @public
+ */
+exports.refractSecurityDefinitions = refractSecurityDefinitions;
+const refractSecurityScheme = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityScheme'
+});
+
+/**
+ * Refracts a value into a ScopesElement.
+ * @public
+ */
+exports.refractSecurityScheme = refractSecurityScheme;
+const refractScopes = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'scopes'
+});
+
+/**
+ * Refracts a value into a SecurityRequirementElement.
+ * @public
+ */
+exports.refractScopes = refractScopes;
+const refractSecurityRequirement = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityRequirement'
+});
+exports.refractSecurityRequirement = refractSecurityRequirement;
+var _default = exports.default = refract;