@speclynx/apidom-ns-openapi-2 1.12.2 → 2.0.1

package/src/predicates.mjs

@@ -1,4 +1,3 @@
-import { createPredicate } from '@speclynx/apidom-core';
 import SwaggerElement from "./elements/Swagger.mjs";
 import SwaggerVersionElement from "./elements/SwaggerVersion.mjs";
 import InfoElement from "./elements/Info.mjs";
@@ -29,296 +28,134 @@ import ScopesElement from "./elements/Scopes.mjs";
 /**
  * @public
  */
-export const isSwaggerElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof SwaggerElement || hasBasicElementProps(element) && isElementType('swagger', element) && primitiveEq('object', element);
-});
+export const isSwaggerElement = element => element instanceof SwaggerElement;
 
 /**
  * @public
  */
-export const isSwaggerVersionElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof SwaggerVersionElement || hasBasicElementProps(element) && isElementType('swaggerVersion', element) && primitiveEq('string', element);
-});
+export const isSwaggerVersionElement = element => element instanceof SwaggerVersionElement;
 
 /**
  * @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 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 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 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 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 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 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 isItemsElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ItemsElement || hasBasicElementProps(element) && isElementType('items', element) && primitiveEq('object', element);
-});
+export const isItemsElement = element => element instanceof ItemsElement;
 
 /**
  * @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 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 isHeadersElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof HeadersElement || hasBasicElementProps(element) && isElementType('headers', element) && primitiveEq('object', element);
-});
+export const isHeadersElement = element => element instanceof HeadersElement;
 
 /**
  * @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 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 isTagElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof TagElement || hasBasicElementProps(element) && isElementType('tag', element) && primitiveEq('object', element);
-});
+export const isTagElement = element => element instanceof TagElement;
 
 /**
  * @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 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 isXmlElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof XmlElement || hasBasicElementProps(element) && isElementType('xml', element) && primitiveEq('object', element);
-});
+export const isXmlElement = element => element instanceof XmlElement;
 
 /**
  * @public
  */
-export const isResponsesDefinitionsElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ResponsesDefinitionsElement || hasBasicElementProps(element) && isElementType('responsesDefinitions', element) && primitiveEq('object', element);
-});
+export const isResponsesDefinitionsElement = element => element instanceof ResponsesDefinitionsElement;
 
 /**
  * @public
  */
-export const isSecurityDefinitionsElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof SecurityDefinitionsElement || hasBasicElementProps(element) && isElementType('securityDefinitions', element) && primitiveEq('object', element);
-});
+export const isSecurityDefinitionsElement = element => element instanceof SecurityDefinitionsElement;
 
 /**
  * @public
  */
-export const isDefinitionsElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof DefinitionsElement || hasBasicElementProps(element) && isElementType('definitions', element) && primitiveEq('object', element);
-});
+export const isDefinitionsElement = element => element instanceof DefinitionsElement;
 
 /**
  * @public
  */
-export const isParametersDefinitionsElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ParametersDefinitionsElement || hasBasicElementProps(element) && isElementType('parametersDefinitions', element) && primitiveEq('object', element);
-});
+export const isParametersDefinitionsElement = element => element instanceof ParametersDefinitionsElement;
 
 /**
  * @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 isScopesElement = createPredicate(({
-  hasBasicElementProps,
-  isElementType,
-  primitiveEq
-}) => {
-  return element => element instanceof ScopesElement || hasBasicElementProps(element) && isElementType('scopes', element) && primitiveEq('object', element);
-});
+export const isScopesElement = element => element instanceof ScopesElement;
 
 /**
  * @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;

package/src/refractor/index.cjs

@@ -2,51 +2,313 @@
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
-exports.default = exports.createRefractor = void 0;
+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 _visitor = require("../traversal/visitor.cjs");
 var _toolbox = _interopRequireDefault(require("./toolbox.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
 /**
  * @public
  */
 const refract = (value, {
-  specPath = ['visitors', 'document', 'objects', 'Swagger', '$visitor'],
-  plugins = []
+  element = 'swagger',
+  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);
 
   /**
    * 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 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
  */
-const createRefractor = specPath => (value, options = {}) => refract(value, {
-  specPath,
-  ...options
+exports.refractScopes = refractScopes;
+const refractSecurityRequirement = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityRequirement'
 });
-exports.createRefractor = createRefractor;
+exports.refractSecurityRequirement = refractSecurityRequirement;
 var _default = exports.default = refract;