@speclynx/apidom-ns-openapi-2 3.2.0 → 4.0.0

package/src/refractor/index.mjs

@@ -1,283 +0,0 @@
-import { resolveSpecification, dispatchRefractorPlugins } from '@speclynx/apidom-core';
-import { refract as baseRefract } from '@speclynx/apidom-datamodel';
-import { traverse } from '@speclynx/apidom-traverse';
-import { path } from 'ramda';
-import specification from "./specification.mjs";
-import createToolbox from "./toolbox.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-/**
- * @public
- */
-const refract = (value, {
-  element = 'swagger',
-  plugins = [],
-  specificationObj = specification,
-  consume = false
-} = {}) => {
-  const genericElement = baseRefract(value);
-  const resolvedSpec = 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 = path(specPath, resolvedSpec);
-  const rootVisitor = new RootVisitorClass({
-    specObj: resolvedSpec,
-    consume
-  });
-  traverse(genericElement, rootVisitor);
-
-  /**
-   * Running plugins visitors means extra single traversal === performance hit.
-   */
-  return dispatchRefractorPlugins(rootVisitor.element, plugins, {
-    toolboxCreator: createToolbox
-  });
-};
-
-/**
- * Refracts a value into a SwaggerElement.
- * @public
- */
-export const refractSwagger = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'swagger'
-});
-
-/**
- * Refracts a value into an InfoElement.
- * @public
- */
-export const refractInfo = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'info'
-});
-
-/**
- * Refracts a value into a ContactElement.
- * @public
- */
-export const refractContact = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'contact'
-});
-
-/**
- * Refracts a value into a LicenseElement.
- * @public
- */
-export const refractLicense = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'license'
-});
-
-/**
- * Refracts a value into a PathsElement.
- * @public
- */
-export const refractPaths = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'paths'
-});
-
-/**
- * Refracts a value into a PathItemElement.
- * @public
- */
-export const refractPathItem = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'pathItem'
-});
-
-/**
- * Refracts a value into an OperationElement.
- * @public
- */
-export const refractOperation = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'operation'
-});
-
-/**
- * Refracts a value into an ExternalDocumentationElement.
- * @public
- */
-export const refractExternalDocumentation = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'externalDocumentation'
-});
-
-/**
- * Refracts a value into a ParameterElement.
- * @public
- */
-export const refractParameter = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'parameter'
-});
-
-/**
- * Refracts a value into an ItemsElement.
- * @public
- */
-export const refractItems = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'items'
-});
-
-/**
- * Refracts a value into a ResponsesElement.
- * @public
- */
-export const refractResponses = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'responses'
-});
-
-/**
- * Refracts a value into a ResponseElement.
- * @public
- */
-export const refractResponse = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'response'
-});
-
-/**
- * Refracts a value into a HeadersElement.
- * @public
- */
-export const refractHeaders = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'headers'
-});
-
-/**
- * Refracts a value into an ExampleElement.
- * @public
- */
-export const refractExample = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'example'
-});
-
-/**
- * Refracts a value into a HeaderElement.
- * @public
- */
-export const refractHeader = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'header'
-});
-
-/**
- * Refracts a value into a TagElement.
- * @public
- */
-export const refractTag = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'tag'
-});
-
-/**
- * Refracts a value into a ReferenceElement.
- * @public
- */
-export const refractReference = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'reference'
-});
-
-/**
- * Refracts a value into a SchemaElement.
- * @public
- */
-export const refractSchema = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'schema'
-});
-
-/**
- * Refracts a value into an XmlElement.
- * @public
- */
-export const refractXml = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'xml'
-});
-
-/**
- * Refracts a value into a DefinitionsElement.
- * @public
- */
-export const refractDefinitions = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'definitions'
-});
-
-/**
- * Refracts a value into a ParametersDefinitionsElement.
- * @public
- */
-export const refractParametersDefinitions = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'parametersDefinitions'
-});
-
-/**
- * Refracts a value into a ResponsesDefinitionsElement.
- * @public
- */
-export const refractResponsesDefinitions = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'responsesDefinitions'
-});
-
-/**
- * Refracts a value into a SecurityDefinitionsElement.
- * @public
- */
-export const refractSecurityDefinitions = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'securityDefinitions'
-});
-
-/**
- * Refracts a value into a SecuritySchemeElement.
- * @public
- */
-export const refractSecurityScheme = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'securityScheme'
-});
-
-/**
- * Refracts a value into a ScopesElement.
- * @public
- */
-export const refractScopes = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'scopes'
-});
-
-/**
- * Refracts a value into a SecurityRequirementElement.
- * @public
- */
-export const refractSecurityRequirement = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'securityRequirement'
-});
-export default refract;

package/src/refractor/inspect.cjs

@@ -1,157 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-var _apidomCore = require("@speclynx/apidom-core");
-var _ramdaAdjunct = require("ramda-adjunct");
-var _Swagger = _interopRequireDefault(require("../elements/Swagger.cjs"));
-exports.SwaggerElement = _Swagger.default;
-var _SwaggerVersion = _interopRequireDefault(require("../elements/SwaggerVersion.cjs"));
-exports.SwaggerVersionElement = _SwaggerVersion.default;
-var _Info = _interopRequireDefault(require("../elements/Info.cjs"));
-exports.InfoElement = _Info.default;
-var _Contact = _interopRequireDefault(require("../elements/Contact.cjs"));
-exports.ContactElement = _Contact.default;
-var _License = _interopRequireDefault(require("../elements/License.cjs"));
-exports.LicenseElement = _License.default;
-var _Paths = _interopRequireDefault(require("../elements/Paths.cjs"));
-exports.PathsElement = _Paths.default;
-var _PathItem = _interopRequireDefault(require("../elements/PathItem.cjs"));
-exports.PathItemElement = _PathItem.default;
-var _Operation = _interopRequireDefault(require("../elements/Operation.cjs"));
-exports.OperationElement = _Operation.default;
-var _ExternalDocumentation = _interopRequireDefault(require("../elements/ExternalDocumentation.cjs"));
-exports.ExternalDocumentationElement = _ExternalDocumentation.default;
-var _Parameter = _interopRequireDefault(require("../elements/Parameter.cjs"));
-exports.ParameterElement = _Parameter.default;
-var _Items = _interopRequireDefault(require("../elements/Items.cjs"));
-exports.ItemsElement = _Items.default;
-var _Responses = _interopRequireDefault(require("../elements/Responses.cjs"));
-exports.ResponsesElement = _Responses.default;
-var _Response = _interopRequireDefault(require("../elements/Response.cjs"));
-exports.ResponseElement = _Response.default;
-var _Headers = _interopRequireDefault(require("../elements/Headers.cjs"));
-exports.HeadersElement = _Headers.default;
-var _Example = _interopRequireDefault(require("../elements/Example.cjs"));
-exports.ExampleElement = _Example.default;
-var _Header = _interopRequireDefault(require("../elements/Header.cjs"));
-exports.HeaderElement = _Header.default;
-var _Tag = _interopRequireDefault(require("../elements/Tag.cjs"));
-exports.TagElement = _Tag.default;
-var _Reference = _interopRequireDefault(require("../elements/Reference.cjs"));
-exports.ReferenceElement = _Reference.default;
-var _Schema = _interopRequireDefault(require("../elements/Schema.cjs"));
-exports.SchemaElement = _Schema.default;
-var _Xml = _interopRequireDefault(require("../elements/Xml.cjs"));
-exports.XmlElement = _Xml.default;
-var _Definitions = _interopRequireDefault(require("../elements/Definitions.cjs"));
-exports.DefinitionsElement = _Definitions.default;
-var _ParametersDefinitions = _interopRequireDefault(require("../elements/ParametersDefinitions.cjs"));
-exports.ParametersDefinitionsElement = _ParametersDefinitions.default;
-var _ResponsesDefinitions = _interopRequireDefault(require("../elements/ResponsesDefinitions.cjs"));
-exports.ResponsesDefinitionsElement = _ResponsesDefinitions.default;
-var _SecurityDefinitions = _interopRequireDefault(require("../elements/SecurityDefinitions.cjs"));
-exports.SecurityDefinitionsElement = _SecurityDefinitions.default;
-var _SecurityScheme = _interopRequireDefault(require("../elements/SecurityScheme.cjs"));
-exports.SecuritySchemeElement = _SecurityScheme.default;
-var _Scopes = _interopRequireDefault(require("../elements/Scopes.cjs"));
-exports.ScopesElement = _Scopes.default;
-var _SecurityRequirement = _interopRequireDefault(require("../elements/SecurityRequirement.cjs"));
-exports.SecurityRequirementElement = _SecurityRequirement.default;
-var _specification = _interopRequireDefault(require("./specification.cjs"));
-/**
- * OpenAPI 2.0 specification elements.
- */
-
-/**
- * @public
- */
-
-// Resolve specification to dereference $ref pointers
-const resolvedSpec = (0, _apidomCore.resolveSpecification)(_specification.default);
-
-// Extract fixed fields as list of { name, alias?, $visitor }
-const getFixedFields = fixedFieldsSpec => {
-  return Object.entries(fixedFieldsSpec).map(([name, fieldSpec]) => {
-    if ((0, _ramdaAdjunct.isPlainObject)(fieldSpec)) {
-      return {
-        name,
-        ...fieldSpec
-      };
-    }
-    return {
-      name,
-      $visitor: fieldSpec
-    };
-  });
-};
-
-// OpenAPI 2.0 specification elements
-Object.defineProperty(_Swagger.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Swagger.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Info.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Info.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Contact.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Contact.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_License.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.License.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_PathItem.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.PathItem.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Operation.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Operation.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_ExternalDocumentation.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.ExternalDocumentation.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Parameter.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Parameter.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Items.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Items.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Responses.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Responses.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Response.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Response.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Header.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Header.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Tag.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Tag.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Reference.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Reference.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Schema.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Schema.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_Xml.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.XML.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_SecurityScheme.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.SecurityScheme.fixedFields),
-  enumerable: true
-});

package/src/refractor/inspect.mjs

@@ -1,126 +0,0 @@
-import { resolveSpecification } from '@speclynx/apidom-core';
-import { isPlainObject } from 'ramda-adjunct';
-
-/**
- * OpenAPI 2.0 specification elements.
- */
-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 ResponsesElement from "../elements/Responses.mjs";
-import ResponseElement from "../elements/Response.mjs";
-import HeadersElement from "../elements/Headers.mjs";
-import ExampleElement from "../elements/Example.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 ScopesElement from "../elements/Scopes.mjs";
-import SecurityRequirementElement from "../elements/SecurityRequirement.mjs";
-import specification from "./specification.mjs";
-/**
- * @public
- */
-// Resolve specification to dereference $ref pointers
-const resolvedSpec = resolveSpecification(specification);
-
-// Extract fixed fields as list of { name, alias?, $visitor }
-const getFixedFields = fixedFieldsSpec => {
-  return Object.entries(fixedFieldsSpec).map(([name, fieldSpec]) => {
-    if (isPlainObject(fieldSpec)) {
-      return {
-        name,
-        ...fieldSpec
-      };
-    }
-    return {
-      name,
-      $visitor: fieldSpec
-    };
-  });
-};
-
-// OpenAPI 2.0 specification elements
-Object.defineProperty(SwaggerElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Swagger.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(InfoElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Info.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(ContactElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Contact.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(LicenseElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.License.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(PathItemElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.PathItem.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(OperationElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Operation.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(ExternalDocumentationElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.ExternalDocumentation.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(ParameterElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Parameter.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(ItemsElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Items.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(ResponsesElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Responses.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(ResponseElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Response.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(HeaderElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Header.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(TagElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Tag.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(ReferenceElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Reference.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(SchemaElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Schema.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(XmlElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.XML.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(SecuritySchemeElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.SecurityScheme.fixedFields),
-  enumerable: true
-});
-export { SwaggerElement, SwaggerVersionElement, InfoElement, ContactElement, LicenseElement, PathsElement, PathItemElement, OperationElement, ExternalDocumentationElement, ParameterElement, ItemsElement, ResponsesElement, ResponseElement, HeadersElement, ExampleElement, HeaderElement, TagElement, ReferenceElement, SchemaElement, XmlElement, DefinitionsElement, ParametersDefinitionsElement, ResponsesDefinitionsElement, SecurityDefinitionsElement, SecuritySchemeElement, ScopesElement, SecurityRequirementElement };