@speclynx/apidom-ns-openapi-3-0 4.0.1 → 4.0.3

package/src/predicates.ts

@@ -0,0 +1,185 @@
+import CallbackElement from './elements/Callback.ts';
+import ComponentsElement from './elements/Components.ts';
+import ContactElement from './elements/Contact.ts';
+import ExampleElement from './elements/Example.ts';
+import ExternalDocumentationElement from './elements/ExternalDocumentation.ts';
+import HeaderElement from './elements/Header.ts';
+import InfoElement from './elements/Info.ts';
+import LicenseElement from './elements/License.ts';
+import LinkElement from './elements/Link.ts';
+import OpenapiElement from './elements/Openapi.ts';
+import OpenApi3_0Element from './elements/OpenApi3-0.ts';
+import OperationElement from './elements/Operation.ts';
+import ParameterElement from './elements/Parameter.ts';
+import PathItemElement from './elements/PathItem.ts';
+import PathsElement from './elements/Paths.ts';
+import ReferenceElement from './elements/Reference.ts';
+import RequestBodyElement from './elements/RequestBody.ts';
+import ResponseElement from './elements/Response.ts';
+import ResponsesElement from './elements/Responses.ts';
+import SchemaElement from './elements/Schema.ts';
+import SecurityRequirementElement from './elements/SecurityRequirement.ts';
+import SecuritySchemeElement from './elements/SecurityScheme.ts';
+import ServerElement from './elements/Server.ts';
+import ServerVariableElement from './elements/ServerVariable.ts';
+import MediaTypeElement from './elements/MediaType.ts';
+// NCE types
+import ServersElement from './elements/nces/Servers.ts';
+
+/**
+ * @public
+ */
+export const isCallbackElement = (element: unknown): element is CallbackElement =>
+  element instanceof CallbackElement;
+
+/**
+ * @public
+ */
+export const isComponentsElement = (element: unknown): element is ComponentsElement =>
+  element instanceof ComponentsElement;
+
+/**
+ * @public
+ */
+export const isContactElement = (element: unknown): element is ContactElement =>
+  element instanceof ContactElement;
+
+/**
+ * @public
+ */
+export const isExampleElement = (element: unknown): element is ExampleElement =>
+  element instanceof ExampleElement;
+
+/**
+ * @public
+ */
+export const isExternalDocumentationElement = (
+  element: unknown,
+): element is ExternalDocumentationElement => element instanceof ExternalDocumentationElement;
+
+/**
+ * @public
+ */
+export const isHeaderElement = (element: unknown): element is HeaderElement =>
+  element instanceof HeaderElement;
+
+/**
+ * @public
+ */
+export const isInfoElement = (element: unknown): element is InfoElement =>
+  element instanceof InfoElement;
+
+/**
+ * @public
+ */
+export const isLicenseElement = (element: unknown): element is LicenseElement =>
+  element instanceof LicenseElement;
+
+/**
+ * @public
+ */
+export const isLinkElement = (element: unknown): element is LinkElement =>
+  element instanceof LinkElement;
+
+/**
+ * @public
+ */
+export const isOpenapiElement = (element: unknown): element is OpenapiElement =>
+  element instanceof OpenapiElement;
+
+/**
+ * @public
+ */
+export const isOpenApi3_0Element = (element: unknown): element is OpenApi3_0Element =>
+  element instanceof OpenApi3_0Element;
+
+/**
+ * @public
+ */
+export const isOperationElement = (element: unknown): element is OperationElement =>
+  element instanceof OperationElement;
+
+/**
+ * @public
+ */
+export const isParameterElement = (element: unknown): element is ParameterElement =>
+  element instanceof ParameterElement;
+
+/**
+ * @public
+ */
+export const isPathItemElement = (element: unknown): element is PathItemElement =>
+  element instanceof PathItemElement;
+
+/**
+ * @public
+ */
+export const isPathsElement = (element: unknown): element is PathsElement =>
+  element instanceof PathsElement;
+
+/**
+ * @public
+ */
+export const isReferenceElement = (element: unknown): element is ReferenceElement =>
+  element instanceof ReferenceElement;
+
+/**
+ * @public
+ */
+export const isRequestBodyElement = (element: unknown): element is RequestBodyElement =>
+  element instanceof RequestBodyElement;
+
+/**
+ * @public
+ */
+export const isResponseElement = (element: unknown): element is ResponseElement =>
+  element instanceof ResponseElement;
+
+/**
+ * @public
+ */
+export const isResponsesElement = (element: unknown): element is ResponsesElement =>
+  element instanceof ResponsesElement;
+
+/**
+ * @public
+ */
+export const isSchemaElement = (element: unknown): element is SchemaElement =>
+  element instanceof SchemaElement;
+
+/**
+ * @public
+ */
+export const isSecurityRequirementElement = (
+  element: unknown,
+): element is SecurityRequirementElement => element instanceof SecurityRequirementElement;
+
+/**
+ * @public
+ */
+export const isSecuritySchemeElement = (element: unknown): element is SecuritySchemeElement =>
+  element instanceof SecuritySchemeElement;
+
+/**
+ * @public
+ */
+export const isServerElement = (element: unknown): element is ServerElement =>
+  element instanceof ServerElement;
+
+/**
+ * @public
+ */
+export const isServerVariableElement = (element: unknown): element is ServerVariableElement =>
+  element instanceof ServerVariableElement;
+
+/**
+ * @public
+ */
+export const isMediaTypeElement = (element: unknown): element is MediaTypeElement =>
+  element instanceof MediaTypeElement;
+
+/**
+ * @public
+ */
+export const isServersElement = (element: unknown): element is ServersElement =>
+  element instanceof ServersElement;

package/src/refractor/index.cjs

@@ -0,0 +1,358 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+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 _toolbox = _interopRequireDefault(require("./toolbox.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+const refract = (value, {
+  element = 'openApi3_0',
+  plugins = [],
+  specificationObj = _specification.default,
+  consume = false
+} = {}) => {
+  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 own plugins on already transformed ApiDOM.
+   */
+  const RootVisitorClass = (0, _ramda.path)(specPath, resolvedSpec);
+  const rootVisitor = new RootVisitorClass({
+    specObj: resolvedSpec,
+    consume
+  });
+  (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
+  });
+};
+
+/**
+ * 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
+ */
+exports.refractOAuthFlow = refractOAuthFlow;
+const refractSecurityRequirement = (value, options = {}) => refract(value, {
+  ...options,
+  element: 'securityRequirement'
+});
+exports.refractSecurityRequirement = refractSecurityRequirement;
+var _default = exports.default = refract;