@speclynx/apidom-ns-openapi-3-0 1.12.2 → 2.1.0

package/src/refractor/index.mjs

@@ -1,46 +1,319 @@
-import { visit, dereference, refract as baseRefract, dispatchRefractorPlugins } from '@speclynx/apidom-core';
+import { resolveSpecification, dispatchRefractorPlugins } from '@speclynx/apidom-core';
+import { refract as baseRefract } from '@speclynx/apidom-datamodel';
+import { traverse, getNodePrimitiveType } from '@speclynx/apidom-traverse';
 import { path } from 'ramda';
 import specification from "./specification.mjs";
-import { keyMap, getNodeType } from "../traversal/visitor.mjs";
 import createToolbox from "./toolbox.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 /**
  * @public
  */
 const refract = (value, {
-  specPath = ['visitors', 'document', 'objects', 'OpenApi', '$visitor'],
-  plugins = []
+  element = 'openApi3_0',
+  plugins = [],
+  specificationObj = specification
 } = {}) => {
-  const element = baseRefract(value);
-  const resolvedSpec = dereference(specification);
+  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 onw plugins on already transformed ApiDOM.
+   * Though we allow consumers to define their own plugins on already transformed ApiDOM.
    */
   const RootVisitorClass = path(specPath, resolvedSpec);
   const rootVisitor = new RootVisitorClass({
     specObj: resolvedSpec
   });
-  visit(element, rootVisitor);
+  traverse(genericElement, rootVisitor, {
+    nodeTypeGetter: getNodePrimitiveType
+  });
 
   /**
    * Running plugins visitors means extra single traversal === performance hit.
    */
   return dispatchRefractorPlugins(rootVisitor.element, plugins, {
-    toolboxCreator: createToolbox,
-    visitorOptions: {
-      keyMap,
-      nodeTypeGetter: getNodeType
-    }
+    toolboxCreator: createToolbox
   });
 };
 
 /**
+ * Refracts a value into an OpenApi3_0Element.
+ * @public
+ */
+export const refractOpenApi3_0 = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'openApi3_0'
+});
+
+/**
+ * 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 ServerElement.
+ * @public
+ */
+export const refractServer = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'server'
+});
+
+/**
+ * Refracts a value into a ServerVariableElement.
+ * @public
+ */
+export const refractServerVariable = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'serverVariable'
+});
+
+/**
+ * Refracts a value into a ComponentsElement.
+ * @public
+ */
+export const refractComponents = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'components'
+});
+
+/**
+ * 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 a RequestBodyElement.
+ * @public
+ */
+export const refractRequestBody = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'requestBody'
+});
+
+/**
+ * Refracts a value into a MediaTypeElement.
+ * @public
+ */
+export const refractMediaType = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'mediaType'
+});
+
+/**
+ * Refracts a value into an EncodingElement.
+ * @public
+ */
+export const refractEncoding = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'encoding'
+});
+
+/**
+ * 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 CallbackElement.
+ * @public
+ */
+export const refractCallback = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'callback'
+});
+
+/**
+ * Refracts a value into an ExampleElement.
+ * @public
+ */
+export const refractExample = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'example'
+});
+
+/**
+ * Refracts a value into a LinkElement.
+ * @public
+ */
+export const refractLink = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'link'
+});
+
+/**
+ * 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 a DiscriminatorElement.
+ * @public
+ */
+export const refractDiscriminator = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'discriminator'
+});
+
+/**
+ * Refracts a value into an XmlElement.
+ * @public
+ */
+export const refractXml = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'xml'
+});
+
+/**
+ * Refracts a value into a SecuritySchemeElement.
+ * @public
+ */
+export const refractSecurityScheme = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityScheme'
+});
+
+/**
+ * Refracts a value into an OAuthFlowsElement.
+ * @public
+ */
+export const refractOAuthFlows = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'oAuthFlows'
+});
+
+/**
+ * Refracts a value into an OAuthFlowElement.
+ * @public
+ */
+export const refractOAuthFlow = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'oAuthFlow'
+});
+
+/**
+ * Refracts a value into a SecurityRequirementElement.
  * @public
  */
-export const createRefractor = specPath => (value, options = {}) => refract(value, {
-  specPath,
-  ...options
+export const refractSecurityRequirement = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityRequirement'
 });
 export default refract;

package/src/refractor/inspect.cjs

@@ -0,0 +1,205 @@
+"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 _Callback = _interopRequireDefault(require("../elements/Callback.cjs"));
+exports.CallbackElement = _Callback.default;
+var _Components = _interopRequireDefault(require("../elements/Components.cjs"));
+exports.ComponentsElement = _Components.default;
+var _Contact = _interopRequireDefault(require("../elements/Contact.cjs"));
+exports.ContactElement = _Contact.default;
+var _Discriminator = _interopRequireDefault(require("../elements/Discriminator.cjs"));
+exports.DiscriminatorElement = _Discriminator.default;
+var _Encoding = _interopRequireDefault(require("../elements/Encoding.cjs"));
+exports.EncodingElement = _Encoding.default;
+var _Example = _interopRequireDefault(require("../elements/Example.cjs"));
+exports.ExampleElement = _Example.default;
+var _ExternalDocumentation = _interopRequireDefault(require("../elements/ExternalDocumentation.cjs"));
+exports.ExternalDocumentationElement = _ExternalDocumentation.default;
+var _Header = _interopRequireDefault(require("../elements/Header.cjs"));
+exports.HeaderElement = _Header.default;
+var _Info = _interopRequireDefault(require("../elements/Info.cjs"));
+exports.InfoElement = _Info.default;
+var _License = _interopRequireDefault(require("../elements/License.cjs"));
+exports.LicenseElement = _License.default;
+var _Link = _interopRequireDefault(require("../elements/Link.cjs"));
+exports.LinkElement = _Link.default;
+var _MediaType = _interopRequireDefault(require("../elements/MediaType.cjs"));
+exports.MediaTypeElement = _MediaType.default;
+var _OAuthFlow = _interopRequireDefault(require("../elements/OAuthFlow.cjs"));
+exports.OAuthFlowElement = _OAuthFlow.default;
+var _OAuthFlows = _interopRequireDefault(require("../elements/OAuthFlows.cjs"));
+exports.OAuthFlowsElement = _OAuthFlows.default;
+var _Openapi = _interopRequireDefault(require("../elements/Openapi.cjs"));
+exports.OpenapiElement = _Openapi.default;
+var _OpenApi = _interopRequireDefault(require("../elements/OpenApi3-0.cjs"));
+exports.OpenApi3_0Element = _OpenApi.default;
+var _Operation = _interopRequireDefault(require("../elements/Operation.cjs"));
+exports.OperationElement = _Operation.default;
+var _Parameter = _interopRequireDefault(require("../elements/Parameter.cjs"));
+exports.ParameterElement = _Parameter.default;
+var _PathItem = _interopRequireDefault(require("../elements/PathItem.cjs"));
+exports.PathItemElement = _PathItem.default;
+var _Paths = _interopRequireDefault(require("../elements/Paths.cjs"));
+exports.PathsElement = _Paths.default;
+var _Reference = _interopRequireDefault(require("../elements/Reference.cjs"));
+exports.ReferenceElement = _Reference.default;
+var _RequestBody = _interopRequireDefault(require("../elements/RequestBody.cjs"));
+exports.RequestBodyElement = _RequestBody.default;
+var _Response = _interopRequireDefault(require("../elements/Response.cjs"));
+exports.ResponseElement = _Response.default;
+var _Responses = _interopRequireDefault(require("../elements/Responses.cjs"));
+exports.ResponsesElement = _Responses.default;
+var _Schema = _interopRequireDefault(require("../elements/Schema.cjs"));
+exports.SchemaElement = _Schema.default;
+var _SecurityRequirement = _interopRequireDefault(require("../elements/SecurityRequirement.cjs"));
+exports.SecurityRequirementElement = _SecurityRequirement.default;
+var _SecurityScheme = _interopRequireDefault(require("../elements/SecurityScheme.cjs"));
+exports.SecuritySchemeElement = _SecurityScheme.default;
+var _Server = _interopRequireDefault(require("../elements/Server.cjs"));
+exports.ServerElement = _Server.default;
+var _ServerVariable = _interopRequireDefault(require("../elements/ServerVariable.cjs"));
+exports.ServerVariableElement = _ServerVariable.default;
+var _Tag = _interopRequireDefault(require("../elements/Tag.cjs"));
+exports.TagElement = _Tag.default;
+var _Xml = _interopRequireDefault(require("../elements/Xml.cjs"));
+exports.XmlElement = _Xml.default;
+var _specification = _interopRequireDefault(require("./specification.cjs"));
+/**
+ * OpenAPI 3.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 3.0 specification elements
+Object.defineProperty(_OpenApi.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OpenApi.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(_Server.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Server.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(_ServerVariable.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.ServerVariable.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(_Components.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Components.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(_RequestBody.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.RequestBody.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(_MediaType.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.MediaType.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(_Encoding.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Encoding.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(_Example.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Example.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(_Link.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Link.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(_Discriminator.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Discriminator.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
+});
+Object.defineProperty(_OAuthFlows.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OAuthFlows.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(_OAuthFlow.default, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OAuthFlow.fixedFields),
+  enumerable: true
+});