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

package/src/predicates.mjs

@@ -1,4 +1,4 @@
-import { createPredicate, isBooleanElement } from '@speclynx/apidom-core';
+import { includesClasses, isBooleanElement } from '@speclynx/apidom-datamodel';
 import CallbackElement from "./elements/Callback.mjs";
 import ComponentsElement from "./elements/Components.mjs";
 import ContactElement from "./elements/Contact.mjs";
@@ -28,295 +28,136 @@ import ServersElement from "./elements/nces/Servers.mjs";
 /**
  * @public
  */
-export const isCallbackElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof CallbackElement || hasBasicElementProps(element) && isElementType('callback', element) && primitiveEq('object', element);
-});
+export const isCallbackElement = element => element instanceof CallbackElement;
 
 /**
  * @public
  */
-export const isComponentsElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ComponentsElement || hasBasicElementProps(element) && isElementType('components', element) && primitiveEq('object', element);
-});
+export const isComponentsElement = element => element instanceof ComponentsElement;
 
 /**
  * @public
  */
-export const isContactElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ContactElement || hasBasicElementProps(element) && isElementType('contact', element) && primitiveEq('object', element);
-});
+export const isContactElement = element => element instanceof ContactElement;
 
 /**
  * @public
  */
-export const isExampleElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ExampleElement || hasBasicElementProps(element) && isElementType('example', element) && primitiveEq('object', element);
-});
+export const isExampleElement = element => element instanceof ExampleElement;
 
 /**
  * @public
  */
-export const isExternalDocumentationElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ExternalDocumentationElement || hasBasicElementProps(element) && isElementType('externalDocumentation', element) && primitiveEq('object', element);
-});
+export const isExternalDocumentationElement = element => element instanceof ExternalDocumentationElement;
 
 /**
  * @public
  */
-export const isHeaderElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof HeaderElement || hasBasicElementProps(element) && isElementType('header', element) && primitiveEq('object', element);
-});
+export const isHeaderElement = element => element instanceof HeaderElement;
 
 /**
  * @public
  */
-export const isInfoElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof InfoElement || hasBasicElementProps(element) && isElementType('info', element) && primitiveEq('object', element);
-});
+export const isInfoElement = element => element instanceof InfoElement;
 
 /**
  * @public
  */
-export const isLicenseElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof LicenseElement || hasBasicElementProps(element) && isElementType('license', element) && primitiveEq('object', element);
-});
+export const isLicenseElement = element => element instanceof LicenseElement;
 
 /**
  * @public
  */
-export const isLinkElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof LinkElement || hasBasicElementProps(element) && isElementType('link', element) && primitiveEq('object', element);
-});
+export const isLinkElement = element => element instanceof LinkElement;
 
 /**
  * @public
  */
-export const isOpenapiElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof OpenapiElement || hasBasicElementProps(element) && isElementType('openapi', element) && primitiveEq('string', element);
-});
+export const isOpenapiElement = element => element instanceof OpenapiElement;
 
 /**
  * @public
  */
-
-export const isOpenApi3_0Element = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq,
-  hasClass
-}) => {
-  return element => element instanceof OpenApi3_0Element || hasBasicElementProps(element) && isElementType('openApi3_0', element) && primitiveEq('object', element) && hasClass('api', element);
-});
+export const isOpenApi3_0Element = element => element instanceof OpenApi3_0Element;
 
 /**
  * @public
  */
-export const isOperationElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof OperationElement || hasBasicElementProps(element) && isElementType('operation', element) && primitiveEq('object', element);
-});
+export const isOperationElement = element => element instanceof OperationElement;
 
 /**
  * @public
  */
-export const isParameterElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ParameterElement || hasBasicElementProps(element) && isElementType('parameter', element) && primitiveEq('object', element);
-});
+export const isParameterElement = element => element instanceof ParameterElement;
 
 /**
  * @public
  */
-export const isPathItemElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof PathItemElement || hasBasicElementProps(element) && isElementType('pathItem', element) && primitiveEq('object', element);
-});
+export const isPathItemElement = element => element instanceof PathItemElement;
 
 /**
  * @public
  */
-export const isPathsElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof PathsElement || hasBasicElementProps(element) && isElementType('paths', element) && primitiveEq('object', element);
-});
+export const isPathsElement = element => element instanceof PathsElement;
 
 /**
  * @public
  */
-export const isReferenceElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ReferenceElement || hasBasicElementProps(element) && isElementType('reference', element) && primitiveEq('object', element);
-});
+export const isReferenceElement = element => element instanceof ReferenceElement;
 
 /**
  * @public
  */
-export const isRequestBodyElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof RequestBodyElement || hasBasicElementProps(element) && isElementType('requestBody', element) && primitiveEq('object', element);
-});
+export const isRequestBodyElement = element => element instanceof RequestBodyElement;
 
 /**
  * @public
  */
-export const isResponseElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ResponseElement || hasBasicElementProps(element) && isElementType('response', element) && primitiveEq('object', element);
-});
+export const isResponseElement = element => element instanceof ResponseElement;
 
 /**
  * @public
  */
-export const isResponsesElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ResponsesElement || hasBasicElementProps(element) && isElementType('responses', element) && primitiveEq('object', element);
-});
+export const isResponsesElement = element => element instanceof ResponsesElement;
 
 /**
  * @public
  */
-export const isSchemaElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof SchemaElement || hasBasicElementProps(element) && isElementType('schema', element) && primitiveEq('object', element);
-});
+export const isSchemaElement = element => element instanceof SchemaElement;
 
 /**
  * @public
  */
 export const isBooleanJsonSchemaElement = element => {
-  return isBooleanElement(element) && element.classes.includes('boolean-json-schema');
+  return isBooleanElement(element) && includesClasses(element, ['boolean-json-schema']);
 };
 
 /**
  * @public
  */
-export const isSecurityRequirementElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof SecurityRequirementElement || hasBasicElementProps(element) && isElementType('securityRequirement', element) && primitiveEq('object', element);
-});
+export const isSecurityRequirementElement = element => element instanceof SecurityRequirementElement;
 
 /**
  * @public
  */
-export const isSecuritySchemeElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof SecuritySchemeElement || hasBasicElementProps(element) && isElementType('securityScheme', element) && primitiveEq('object', element);
-});
+export const isSecuritySchemeElement = element => element instanceof SecuritySchemeElement;
 
 /**
  * @public
  */
-export const isServerElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ServerElement || hasBasicElementProps(element) && isElementType('server', element) && primitiveEq('object', element);
-});
+export const isServerElement = element => element instanceof ServerElement;
 
 /**
  * @public
  */
-export const isServerVariableElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ServerVariableElement || hasBasicElementProps(element) && isElementType('serverVariable', element) && primitiveEq('object', element);
-});
+export const isServerVariableElement = element => element instanceof ServerVariableElement;
 
 /**
  * @public
  */
-export const isMediaTypeElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof MediaTypeElement || hasBasicElementProps(element) && isElementType('mediaType', element) && primitiveEq('object', element);
-});
+export const isMediaTypeElement = element => element instanceof MediaTypeElement;
 
 /**
  * @public
  */
-export const isServersElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq,
-  hasClass
-}) => {
-  return element => element instanceof ServersElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('servers', element);
-});
+export const isServersElement = element => element instanceof ServersElement;

package/src/refractor/index.cjs

@@ -2,51 +2,355 @@
 
 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_0 = exports.refractOAuthFlows = exports.refractOAuthFlow = exports.refractMediaType = exports.refractLink = exports.refractLicense = 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_0',
+  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
   });
 };
 
 /**
+ * Refracts a value into an OpenApi3_0Element.
+ * @public
+ */
+const refractOpenApi3_0 = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'openApi3_0'
+});
+
+/**
+ * Refracts a value into an InfoElement.
+ * @public
+ */
+exports.refractOpenApi3_0 = refractOpenApi3_0;
+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
  */
-const createRefractor = specPath => (value, options = {}) => refract(value, {
-  specPath,
-  ...options
+exports.refractOAuthFlow = refractOAuthFlow;
+const refractSecurityRequirement = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityRequirement'
 });
-exports.createRefractor = createRefractor;
+exports.refractSecurityRequirement = refractSecurityRequirement;
 var _default = exports.default = refract;