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

package/src/predicates.ts

@@ -1,185 +0,0 @@
-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.ts

@@ -1,370 +0,0 @@
-import { resolveSpecification, dispatchRefractorPlugins } from '@speclynx/apidom-core';
-import { Element, refract as baseRefract } from '@speclynx/apidom-datamodel';
-import { traverse, getNodePrimitiveType } from '@speclynx/apidom-traverse';
-import { path } from 'ramda';
-
-import type VisitorClass from './visitors/Visitor.ts';
-import specification from './specification.ts';
-import createToolbox, { type Toolbox } from './toolbox.ts';
-import type CallbackElement from '../elements/Callback.ts';
-import type ComponentsElement from '../elements/Components.ts';
-import type ContactElement from '../elements/Contact.ts';
-import type DiscriminatorElement from '../elements/Discriminator.ts';
-import type EncodingElement from '../elements/Encoding.ts';
-import type ExampleElement from '../elements/Example.ts';
-import type ExternalDocumentationElement from '../elements/ExternalDocumentation.ts';
-import type HeaderElement from '../elements/Header.ts';
-import type InfoElement from '../elements/Info.ts';
-import type LicenseElement from '../elements/License.ts';
-import type LinkElement from '../elements/Link.ts';
-import type MediaTypeElement from '../elements/MediaType.ts';
-import type OAuthFlowElement from '../elements/OAuthFlow.ts';
-import type OAuthFlowsElement from '../elements/OAuthFlows.ts';
-import type OpenApi3_0Element from '../elements/OpenApi3-0.ts';
-import type OperationElement from '../elements/Operation.ts';
-import type ParameterElement from '../elements/Parameter.ts';
-import type PathItemElement from '../elements/PathItem.ts';
-import type PathsElement from '../elements/Paths.ts';
-import type ReferenceElement from '../elements/Reference.ts';
-import type RequestBodyElement from '../elements/RequestBody.ts';
-import type ResponseElement from '../elements/Response.ts';
-import type ResponsesElement from '../elements/Responses.ts';
-import type SchemaElement from '../elements/Schema.ts';
-import type SecurityRequirementElement from '../elements/SecurityRequirement.ts';
-import type SecuritySchemeElement from '../elements/SecurityScheme.ts';
-import type ServerElement from '../elements/Server.ts';
-import type ServerVariableElement from '../elements/ServerVariable.ts';
-import type TagElement from '../elements/Tag.ts';
-import type XmlElement from '../elements/Xml.ts';
-
-/**
- * @public
- */
-export type RefractorPlugin = (toolbox: Toolbox) => {
-  visitor?: object;
-  pre?: () => void;
-  post?: () => void;
-};
-
-/**
- * @public
- */
-export interface RefractorOptions {
-  readonly element?: string;
-  readonly plugins?: RefractorPlugin[];
-  readonly specificationObj?: typeof specification;
-  readonly consume?: boolean;
-}
-
-/**
- * @public
- */
-const refract = <T extends Element>(
-  value: unknown,
-  {
-    element = 'openApi3_0',
-    plugins = [],
-    specificationObj = specification,
-    consume = false,
-  }: RefractorOptions = {},
-): T => {
-  const genericElement = baseRefract(value);
-  const resolvedSpec = resolveSpecification(specificationObj);
-  const elementMap = resolvedSpec.elementMap as Record<string, string[]>;
-  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 = path(specPath, resolvedSpec) as new (
-    options: Record<string, unknown>,
-  ) => InstanceType<typeof VisitorClass>;
-  const rootVisitor = new RootVisitorClass({ specObj: resolvedSpec, consume });
-
-  traverse(genericElement, rootVisitor, { nodeTypeGetter: getNodePrimitiveType });
-
-  /**
-   * Running plugins visitors means extra single traversal === performance hit.
-   */
-  return dispatchRefractorPlugins(rootVisitor.element, plugins, {
-    toolboxCreator: createToolbox,
-  }) as T;
-};
-
-/**
- * Refracts a value into an OpenApi3_0Element.
- * @public
- */
-export const refractOpenApi3_0 = <T extends Element = OpenApi3_0Element>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'openApi3_0' });
-
-/**
- * Refracts a value into an InfoElement.
- * @public
- */
-export const refractInfo = <T extends Element = InfoElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'info' });
-
-/**
- * Refracts a value into a ContactElement.
- * @public
- */
-export const refractContact = <T extends Element = ContactElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'contact' });
-
-/**
- * Refracts a value into a LicenseElement.
- * @public
- */
-export const refractLicense = <T extends Element = LicenseElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'license' });
-
-/**
- * Refracts a value into a ServerElement.
- * @public
- */
-export const refractServer = <T extends Element = ServerElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'server' });
-
-/**
- * Refracts a value into a ServerVariableElement.
- * @public
- */
-export const refractServerVariable = <T extends Element = ServerVariableElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'serverVariable' });
-
-/**
- * Refracts a value into a ComponentsElement.
- * @public
- */
-export const refractComponents = <T extends Element = ComponentsElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'components' });
-
-/**
- * Refracts a value into a PathsElement.
- * @public
- */
-export const refractPaths = <T extends Element = PathsElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'paths' });
-
-/**
- * Refracts a value into a PathItemElement.
- * @public
- */
-export const refractPathItem = <T extends Element = PathItemElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'pathItem' });
-
-/**
- * Refracts a value into an OperationElement.
- * @public
- */
-export const refractOperation = <T extends Element = OperationElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'operation' });
-
-/**
- * Refracts a value into an ExternalDocumentationElement.
- * @public
- */
-export const refractExternalDocumentation = <T extends Element = ExternalDocumentationElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'externalDocumentation' });
-
-/**
- * Refracts a value into a ParameterElement.
- * @public
- */
-export const refractParameter = <T extends Element = ParameterElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'parameter' });
-
-/**
- * Refracts a value into a RequestBodyElement.
- * @public
- */
-export const refractRequestBody = <T extends Element = RequestBodyElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'requestBody' });
-
-/**
- * Refracts a value into a MediaTypeElement.
- * @public
- */
-export const refractMediaType = <T extends Element = MediaTypeElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'mediaType' });
-
-/**
- * Refracts a value into an EncodingElement.
- * @public
- */
-export const refractEncoding = <T extends Element = EncodingElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'encoding' });
-
-/**
- * Refracts a value into a ResponsesElement.
- * @public
- */
-export const refractResponses = <T extends Element = ResponsesElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'responses' });
-
-/**
- * Refracts a value into a ResponseElement.
- * @public
- */
-export const refractResponse = <T extends Element = ResponseElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'response' });
-
-/**
- * Refracts a value into a CallbackElement.
- * @public
- */
-export const refractCallback = <T extends Element = CallbackElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'callback' });
-
-/**
- * Refracts a value into an ExampleElement.
- * @public
- */
-export const refractExample = <T extends Element = ExampleElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'example' });
-
-/**
- * Refracts a value into a LinkElement.
- * @public
- */
-export const refractLink = <T extends Element = LinkElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'link' });
-
-/**
- * Refracts a value into a HeaderElement.
- * @public
- */
-export const refractHeader = <T extends Element = HeaderElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'header' });
-
-/**
- * Refracts a value into a TagElement.
- * @public
- */
-export const refractTag = <T extends Element = TagElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'tag' });
-
-/**
- * Refracts a value into a ReferenceElement.
- * @public
- */
-export const refractReference = <T extends Element = ReferenceElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'reference' });
-
-/**
- * Refracts a value into a SchemaElement.
- * @public
- */
-export const refractSchema = <T extends Element = SchemaElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'schema' });
-
-/**
- * Refracts a value into a DiscriminatorElement.
- * @public
- */
-export const refractDiscriminator = <T extends Element = DiscriminatorElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'discriminator' });
-
-/**
- * Refracts a value into an XmlElement.
- * @public
- */
-export const refractXml = <T extends Element = XmlElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'xml' });
-
-/**
- * Refracts a value into a SecuritySchemeElement.
- * @public
- */
-export const refractSecurityScheme = <T extends Element = SecuritySchemeElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'securityScheme' });
-
-/**
- * Refracts a value into an OAuthFlowsElement.
- * @public
- */
-export const refractOAuthFlows = <T extends Element = OAuthFlowsElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'oAuthFlows' });
-
-/**
- * Refracts a value into an OAuthFlowElement.
- * @public
- */
-export const refractOAuthFlow = <T extends Element = OAuthFlowElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'oAuthFlow' });
-
-/**
- * Refracts a value into a SecurityRequirementElement.
- * @public
- */
-export const refractSecurityRequirement = <T extends Element = SecurityRequirementElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'securityRequirement' });
-
-export default refract;