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

package/src/refractor/index.cjs

@@ -2,44 +2,365 @@
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
-exports.default = exports.createRefractor = void 0;
+exports.refractXml = exports.refractTag = exports.refractServerVariable = exports.refractServer = exports.refractSecurityScheme = exports.refractSecurityRequirement = exports.refractSchema = exports.refractResponses = exports.refractResponse = exports.refractRequestBody = exports.refractReference = exports.refractPaths = exports.refractPathItem = exports.refractParameter = exports.refractOperation = exports.refractOpenApi3_1 = exports.refractOAuthFlows = exports.refractOAuthFlow = exports.refractMediaType = exports.refractLink = exports.refractLicense = exports.refractJsonSchemaDialect = exports.refractInfo = exports.refractHeader = exports.refractExternalDocumentation = exports.refractExample = exports.refractEncoding = exports.refractDiscriminator = exports.refractContact = exports.refractComponents = exports.refractCallback = 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 _visitor = require("../traversal/visitor.cjs");
 var _toolbox = _interopRequireDefault(require("./toolbox.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
 const refract = (value, {
-  specPath = ['visitors', 'document', 'objects', 'OpenApi', '$visitor'],
-  plugins = []
+  element = 'openApi3_1',
+  plugins = [],
+  specificationObj = _specification.default
 } = {}) => {
-  const element = (0, _apidomCore.refract)(value);
-  const resolvedSpec = (0, _apidomCore.dereference)(_specification.default);
+  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 onw plugins on already transformed ApiDOM.
+   * 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
   });
-  (0, _apidomCore.visit)(element, rootVisitor);
+  (0, _apidomTraverse.traverse)(genericElement, rootVisitor, {
+    nodeTypeGetter: _apidomTraverse.getNodePrimitiveType
+  });
 
   /**
    * Running plugins visitors means extra single traversal === performance hit.
    */
   return (0, _apidomCore.dispatchRefractorPlugins)(rootVisitor.element, plugins, {
-    toolboxCreator: _toolbox.default,
-    visitorOptions: {
-      keyMap: _visitor.keyMap,
-      nodeTypeGetter: _visitor.getNodeType
-    }
+    toolboxCreator: _toolbox.default
   });
 };
-const createRefractor = specPath => (value, options = {}) => refract(value, {
-  specPath,
-  ...options
+
+/**
+ * Refracts a value into an OpenApi3_1Element.
+ * @public
+ */
+const refractOpenApi3_1 = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'openApi3_1'
+});
+
+/**
+ * Refracts a value into an InfoElement.
+ * @public
+ */
+exports.refractOpenApi3_1 = refractOpenApi3_1;
+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 ServerElement.
+ * @public
+ */
+exports.refractLicense = refractLicense;
+const refractServer = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'server'
+});
+
+/**
+ * Refracts a value into a ServerVariableElement.
+ * @public
+ */
+exports.refractServer = refractServer;
+const refractServerVariable = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'serverVariable'
+});
+
+/**
+ * Refracts a value into a ComponentsElement.
+ * @public
+ */
+exports.refractServerVariable = refractServerVariable;
+const refractComponents = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'components'
+});
+
+/**
+ * Refracts a value into a PathsElement.
+ * @public
+ */
+exports.refractComponents = refractComponents;
+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 a RequestBodyElement.
+ * @public
+ */
+exports.refractParameter = refractParameter;
+const refractRequestBody = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'requestBody'
+});
+
+/**
+ * Refracts a value into a MediaTypeElement.
+ * @public
+ */
+exports.refractRequestBody = refractRequestBody;
+const refractMediaType = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'mediaType'
+});
+
+/**
+ * Refracts a value into an EncodingElement.
+ * @public
+ */
+exports.refractMediaType = refractMediaType;
+const refractEncoding = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'encoding'
+});
+
+/**
+ * Refracts a value into a ResponsesElement.
+ * @public
+ */
+exports.refractEncoding = refractEncoding;
+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 CallbackElement.
+ * @public
+ */
+exports.refractResponse = refractResponse;
+const refractCallback = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'callback'
+});
+
+/**
+ * Refracts a value into an ExampleElement.
+ * @public
+ */
+exports.refractCallback = refractCallback;
+const refractExample = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'example'
+});
+
+/**
+ * Refracts a value into a LinkElement.
+ * @public
+ */
+exports.refractExample = refractExample;
+const refractLink = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'link'
+});
+
+/**
+ * Refracts a value into a HeaderElement.
+ * @public
+ */
+exports.refractLink = refractLink;
+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 a DiscriminatorElement.
+ * @public
+ */
+exports.refractSchema = refractSchema;
+const refractDiscriminator = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'discriminator'
+});
+
+/**
+ * Refracts a value into an XmlElement.
+ * @public
+ */
+exports.refractDiscriminator = refractDiscriminator;
+const refractXml = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'xml'
+});
+
+/**
+ * Refracts a value into a SecuritySchemeElement.
+ * @public
+ */
+exports.refractXml = refractXml;
+const refractSecurityScheme = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityScheme'
+});
+
+/**
+ * Refracts a value into an OAuthFlowsElement.
+ * @public
+ */
+exports.refractSecurityScheme = refractSecurityScheme;
+const refractOAuthFlows = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'oAuthFlows'
+});
+
+/**
+ * Refracts a value into an OAuthFlowElement.
+ * @public
+ */
+exports.refractOAuthFlows = refractOAuthFlows;
+const refractOAuthFlow = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'oAuthFlow'
+});
+
+/**
+ * Refracts a value into a SecurityRequirementElement.
+ * @public
+ */
+exports.refractOAuthFlow = refractOAuthFlow;
+const refractSecurityRequirement = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityRequirement'
+});
+
+/**
+ * Refracts a value into a JsonSchemaDialectElement.
+ * @public
+ */
+exports.refractSecurityRequirement = refractSecurityRequirement;
+const refractJsonSchemaDialect = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'jsonSchemaDialect'
 });
-exports.createRefractor = createRefractor;
+exports.refractJsonSchemaDialect = refractJsonSchemaDialect;
 var _default = exports.default = refract;

package/src/refractor/index.mjs

@@ -1,39 +1,328 @@
-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_1',
+  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
   });
 };
-export const createRefractor = specPath => (value, options = {}) => refract(value, {
-  specPath,
-  ...options
+
+/**
+ * Refracts a value into an OpenApi3_1Element.
+ * @public
+ */
+export const refractOpenApi3_1 = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'openApi3_1'
+});
+
+/**
+ * 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 refractSecurityRequirement = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityRequirement'
+});
+
+/**
+ * Refracts a value into a JsonSchemaDialectElement.
+ * @public
+ */
+export const refractJsonSchemaDialect = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'jsonSchemaDialect'
 });
 export default refract;