@speclynx/apidom-ns-openapi-2 4.0.3 → 4.0.4

package/src/predicates.ts

@@ -1,194 +0,0 @@
-import SwaggerElement from './elements/Swagger.ts';
-import SwaggerVersionElement from './elements/SwaggerVersion.ts';
-import InfoElement from './elements/Info.ts';
-import ContactElement from './elements/Contact.ts';
-import LicenseElement from './elements/License.ts';
-import PathsElement from './elements/Paths.ts';
-import PathItemElement from './elements/PathItem.ts';
-import OperationElement from './elements/Operation.ts';
-import ExternalDocumentationElement from './elements/ExternalDocumentation.ts';
-import ParameterElement from './elements/Parameter.ts';
-import ItemsElement from './elements/Items.ts';
-import ExampleElement from './elements/Example.ts';
-import ResponsesElement from './elements/Responses.ts';
-import ResponseElement from './elements/Response.ts';
-import HeadersElement from './elements/Headers.ts';
-import HeaderElement from './elements/Header.ts';
-import TagElement from './elements/Tag.ts';
-import ReferenceElement from './elements/Reference.ts';
-import SchemaElement from './elements/Schema.ts';
-import XmlElement from './elements/Xml.ts';
-import DefinitionsElement from './elements/Definitions.ts';
-import ParametersDefinitionsElement from './elements/ParametersDefinitions.ts';
-import ResponsesDefinitionsElement from './elements/ResponsesDefinitions.ts';
-import SecurityDefinitionsElement from './elements/SecurityDefinitions.ts';
-import SecuritySchemeElement from './elements/SecurityScheme.ts';
-import SecurityRequirementElement from './elements/SecurityRequirement.ts';
-import ScopesElement from './elements/Scopes.ts';
-
-/**
- * @public
- */
-export const isSwaggerElement = (element: unknown): element is SwaggerElement =>
-  element instanceof SwaggerElement;
-
-/**
- * @public
- */
-export const isSwaggerVersionElement = (element: unknown): element is SwaggerVersionElement =>
-  element instanceof SwaggerVersionElement;
-
-/**
- * @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 isContactElement = (element: unknown): element is ContactElement =>
-  element instanceof ContactElement;
-
-/**
- * @public
- */
-export const isPathsElement = (element: unknown): element is PathsElement =>
-  element instanceof PathsElement;
-
-/**
- * @public
- */
-export const isPathItemElement = (element: unknown): element is PathItemElement =>
-  element instanceof PathItemElement;
-
-/**
- * @public
- */
-export const isOperationElement = (element: unknown): element is OperationElement =>
-  element instanceof OperationElement;
-
-/**
- * @public
- */
-export const isExternalDocumentationElement = (
-  element: unknown,
-): element is ExternalDocumentationElement => element instanceof ExternalDocumentationElement;
-
-/**
- * @public
- */
-export const isParameterElement = (element: unknown): element is ParameterElement =>
-  element instanceof ParameterElement;
-
-/**
- * @public
- */
-export const isItemsElement = (element: unknown): element is ItemsElement =>
-  element instanceof ItemsElement;
-
-/**
- * @public
- */
-export const isResponsesElement = (element: unknown): element is ResponsesElement =>
-  element instanceof ResponsesElement;
-
-/**
- * @public
- */
-export const isResponseElement = (element: unknown): element is ResponseElement =>
-  element instanceof ResponseElement;
-
-/**
- * @public
- */
-export const isHeadersElement = (element: unknown): element is HeadersElement =>
-  element instanceof HeadersElement;
-
-/**
- * @public
- */
-export const isExampleElement = (element: unknown): element is ExampleElement =>
-  element instanceof ExampleElement;
-
-/**
- * @public
- */
-export const isHeaderElement = (element: unknown): element is HeaderElement =>
-  element instanceof HeaderElement;
-
-/**
- * @public
- */
-export const isTagElement = (element: unknown): element is TagElement =>
-  element instanceof TagElement;
-
-/**
- * @public
- */
-export const isReferenceElement = (element: unknown): element is ReferenceElement =>
-  element instanceof ReferenceElement;
-
-/**
- * @public
- */
-export const isSchemaElement = (element: unknown): element is SchemaElement =>
-  element instanceof SchemaElement;
-
-/**
- * @public
- */
-export const isXmlElement = (element: unknown): element is XmlElement =>
-  element instanceof XmlElement;
-
-/**
- * @public
- */
-export const isResponsesDefinitionsElement = (
-  element: unknown,
-): element is ResponsesDefinitionsElement => element instanceof ResponsesDefinitionsElement;
-
-/**
- * @public
- */
-export const isSecurityDefinitionsElement = (
-  element: unknown,
-): element is SecurityDefinitionsElement => element instanceof SecurityDefinitionsElement;
-
-/**
- * @public
- */
-export const isDefinitionsElement = (element: unknown): element is DefinitionsElement =>
-  element instanceof DefinitionsElement;
-
-/**
- * @public
- */
-export const isParametersDefinitionsElement = (
-  element: unknown,
-): element is ParametersDefinitionsElement => element instanceof ParametersDefinitionsElement;
-
-/**
- * @public
- */
-export const isSecuritySchemeElement = (element: unknown): element is SecuritySchemeElement =>
-  element instanceof SecuritySchemeElement;
-
-/**
- * @public
- */
-export const isScopesElement = (element: unknown): element is ScopesElement =>
-  element instanceof ScopesElement;
-
-/**
- * @public
- */
-export const isSecurityRequirementElement = (
-  element: unknown,
-): element is SecurityRequirementElement => element instanceof SecurityRequirementElement;

package/src/refractor/index.ts

@@ -1,330 +0,0 @@
-import { resolveSpecification, dispatchRefractorPlugins } from '@speclynx/apidom-core';
-import { Element, refract as baseRefract } from '@speclynx/apidom-datamodel';
-import { traverse } 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 SwaggerElement from '../elements/Swagger.ts';
-import type InfoElement from '../elements/Info.ts';
-import type ContactElement from '../elements/Contact.ts';
-import type LicenseElement from '../elements/License.ts';
-import type PathsElement from '../elements/Paths.ts';
-import type PathItemElement from '../elements/PathItem.ts';
-import type OperationElement from '../elements/Operation.ts';
-import type ExternalDocumentationElement from '../elements/ExternalDocumentation.ts';
-import type ParameterElement from '../elements/Parameter.ts';
-import type ItemsElement from '../elements/Items.ts';
-import type ResponsesElement from '../elements/Responses.ts';
-import type ResponseElement from '../elements/Response.ts';
-import type HeadersElement from '../elements/Headers.ts';
-import type ExampleElement from '../elements/Example.ts';
-import type HeaderElement from '../elements/Header.ts';
-import type TagElement from '../elements/Tag.ts';
-import type ReferenceElement from '../elements/Reference.ts';
-import type SchemaElement from '../elements/Schema.ts';
-import type XmlElement from '../elements/Xml.ts';
-import type DefinitionsElement from '../elements/Definitions.ts';
-import type ParametersDefinitionsElement from '../elements/ParametersDefinitions.ts';
-import type ResponsesDefinitionsElement from '../elements/ResponsesDefinitions.ts';
-import type SecurityDefinitionsElement from '../elements/SecurityDefinitions.ts';
-import type SecuritySchemeElement from '../elements/SecurityScheme.ts';
-import type ScopesElement from '../elements/Scopes.ts';
-import type SecurityRequirementElement from '../elements/SecurityRequirement.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 = 'swagger',
-    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);
-
-  /**
-   * Running plugins visitors means extra single traversal === performance hit.
-   */
-  return dispatchRefractorPlugins(rootVisitor.element, plugins, {
-    toolboxCreator: createToolbox,
-  }) as T;
-};
-
-/**
- * Refracts a value into a SwaggerElement.
- * @public
- */
-export const refractSwagger = <T extends Element = SwaggerElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'swagger' });
-
-/**
- * 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 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 an ItemsElement.
- * @public
- */
-export const refractItems = <T extends Element = ItemsElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'items' });
-
-/**
- * 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 HeadersElement.
- * @public
- */
-export const refractHeaders = <T extends Element = HeadersElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'headers' });
-
-/**
- * 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 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 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 DefinitionsElement.
- * @public
- */
-export const refractDefinitions = <T extends Element = DefinitionsElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'definitions' });
-
-/**
- * Refracts a value into a ParametersDefinitionsElement.
- * @public
- */
-export const refractParametersDefinitions = <T extends Element = ParametersDefinitionsElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'parametersDefinitions' });
-
-/**
- * Refracts a value into a ResponsesDefinitionsElement.
- * @public
- */
-export const refractResponsesDefinitions = <T extends Element = ResponsesDefinitionsElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'responsesDefinitions' });
-
-/**
- * Refracts a value into a SecurityDefinitionsElement.
- * @public
- */
-export const refractSecurityDefinitions = <T extends Element = SecurityDefinitionsElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'securityDefinitions' });
-
-/**
- * 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 a ScopesElement.
- * @public
- */
-export const refractScopes = <T extends Element = ScopesElement>(
-  value: unknown,
-  options: Omit<RefractorOptions, 'element'> = {},
-): T => refract(value, { ...options, element: 'scopes' });
-
-/**
- * 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;

package/src/refractor/inspect.ts

@@ -1,181 +0,0 @@
-import { resolveSpecification, type ResolvedSpecification } from '@speclynx/apidom-core';
-import { isPlainObject } from 'ramda-adjunct';
-
-/**
- * OpenAPI 2.0 specification elements.
- */
-import SwaggerElement from '../elements/Swagger.ts';
-import SwaggerVersionElement from '../elements/SwaggerVersion.ts';
-import InfoElement from '../elements/Info.ts';
-import ContactElement from '../elements/Contact.ts';
-import LicenseElement from '../elements/License.ts';
-import PathsElement from '../elements/Paths.ts';
-import PathItemElement from '../elements/PathItem.ts';
-import OperationElement from '../elements/Operation.ts';
-import ExternalDocumentationElement from '../elements/ExternalDocumentation.ts';
-import ParameterElement from '../elements/Parameter.ts';
-import ItemsElement from '../elements/Items.ts';
-import ResponsesElement from '../elements/Responses.ts';
-import ResponseElement from '../elements/Response.ts';
-import HeadersElement from '../elements/Headers.ts';
-import ExampleElement from '../elements/Example.ts';
-import HeaderElement from '../elements/Header.ts';
-import TagElement from '../elements/Tag.ts';
-import ReferenceElement from '../elements/Reference.ts';
-import SchemaElement from '../elements/Schema.ts';
-import XmlElement from '../elements/Xml.ts';
-import DefinitionsElement from '../elements/Definitions.ts';
-import ParametersDefinitionsElement from '../elements/ParametersDefinitions.ts';
-import ResponsesDefinitionsElement from '../elements/ResponsesDefinitions.ts';
-import SecurityDefinitionsElement from '../elements/SecurityDefinitions.ts';
-import SecuritySchemeElement from '../elements/SecurityScheme.ts';
-import ScopesElement from '../elements/Scopes.ts';
-import SecurityRequirementElement from '../elements/SecurityRequirement.ts';
-import specification from './specification.ts';
-
-/**
- * @public
- */
-export interface FixedField {
-  name: string;
-  alias?: string;
-  $visitor: unknown;
-}
-
-interface ResolvedSpec extends ResolvedSpecification {
-  visitors: {
-    document: {
-      objects: Record<string, { fixedFields: Record<string, unknown> }>;
-    };
-  };
-}
-
-// Resolve specification to dereference $ref pointers
-const resolvedSpec = resolveSpecification<ResolvedSpec>(specification);
-
-// Extract fixed fields as list of { name, alias?, $visitor }
-const getFixedFields = (fixedFieldsSpec: Record<string, unknown>): FixedField[] => {
-  return Object.entries(fixedFieldsSpec).map(([name, fieldSpec]) => {
-    if (isPlainObject(fieldSpec)) {
-      return { name, ...fieldSpec } as FixedField;
-    }
-    return { name, $visitor: fieldSpec };
-  });
-};
-
-// OpenAPI 2.0 specification elements
-Object.defineProperty(SwaggerElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Swagger.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(InfoElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Info.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(ContactElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Contact.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(LicenseElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.License.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(PathItemElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.PathItem.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(OperationElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Operation.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(ExternalDocumentationElement, 'fixedFields', {
-  get: () =>
-    getFixedFields(resolvedSpec.visitors.document.objects.ExternalDocumentation.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(ParameterElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Parameter.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(ItemsElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Items.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(ResponsesElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Responses.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(ResponseElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Response.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(HeaderElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Header.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(TagElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Tag.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(ReferenceElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Reference.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(SchemaElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Schema.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(XmlElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.XML.fixedFields),
-  enumerable: true,
-});
-
-Object.defineProperty(SecuritySchemeElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.SecurityScheme.fixedFields),
-  enumerable: true,
-});
-
-export {
-  SwaggerElement,
-  SwaggerVersionElement,
-  InfoElement,
-  ContactElement,
-  LicenseElement,
-  PathsElement,
-  PathItemElement,
-  OperationElement,
-  ExternalDocumentationElement,
-  ParameterElement,
-  ItemsElement,
-  ResponsesElement,
-  ResponseElement,
-  HeadersElement,
-  ExampleElement,
-  HeaderElement,
-  TagElement,
-  ReferenceElement,
-  SchemaElement,
-  XmlElement,
-  DefinitionsElement,
-  ParametersDefinitionsElement,
-  ResponsesDefinitionsElement,
-  SecurityDefinitionsElement,
-  SecuritySchemeElement,
-  ScopesElement,
-  SecurityRequirementElement,
-};