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

package/src/refractor/toolbox.ts

@@ -1,70 +0,0 @@
-import {
-  Element,
-  Namespace,
-  ArrayElement,
-  isStringElement,
-  isArrayElement,
-  isObjectElement,
-  isMemberElement,
-} from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { compile as compileJSONPointerTokens } from '@speclynx/apidom-json-pointer';
-
-import * as openApi3_1Predicates from '../predicates.ts';
-import * as refractorPredicates from './predicates.ts';
-import openApi3_1Namespace from '../namespace.ts';
-
-/**
- * @public
- */
-export interface Toolbox {
-  predicates: Record<string, (...args: any[]) => boolean>;
-  ancestorLineageToJSONPointer: typeof ancestorLineageToJSONPointer;
-  namespace: Namespace;
-}
-
-/**
- * Translates visitor ancestor lineage to a JSON Pointer tokens.
- * Ancestor lineage is constructed of following visitor method arguments:
- *
- *  - ancestors
- *  - parent
- *  - element
- * @public
- */
-export const ancestorLineageToJSONPointer = <T extends (Element | Element[])[]>(elementPath: T) => {
-  const jsonPointerTokens = elementPath.reduce((path, element, index) => {
-    if (isMemberElement(element)) {
-      const token = String(toValue(element.key));
-      path.push(token);
-    } else if (isArrayElement(elementPath[index - 2])) {
-      const arrayElement = elementPath[index - 2] as ArrayElement;
-      const token = String((arrayElement.content as Element[])?.indexOf(element as Element) ?? -1);
-      path.push(token);
-    }
-
-    return path;
-  }, [] as string[]);
-
-  return compileJSONPointerTokens(jsonPointerTokens);
-};
-
-/**
- * @public
- */
-const createToolbox = (): Toolbox => {
-  const namespace = new Namespace();
-  const predicates = {
-    ...refractorPredicates,
-    ...openApi3_1Predicates,
-    isStringElement,
-    isArrayElement,
-    isObjectElement,
-  };
-
-  namespace.use(openApi3_1Namespace);
-
-  return { predicates, ancestorLineageToJSONPointer, namespace };
-};
-
-export default createToolbox;

package/src/refractor/visitors/open-api-3-1/JsonSchemaDialectVisitor.ts

@@ -1,32 +0,0 @@
-import { StringElement } from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-
-import JsonSchemaDialectElement from '../../../elements/JsonSchemaDialect.ts';
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from './bases.ts';
-
-/**
- * @public
- */
-export interface JsonSchemaDialectVisitorOptions extends BaseSpecificationVisitorOptions {}
-
-/**
- * @public
- */
-class JsonSchemaDialectVisitor extends BaseSpecificationVisitor {
-  declare public element: JsonSchemaDialectElement;
-
-  StringElement(path: Path<StringElement>) {
-    const stringElement = path.node;
-    const jsonSchemaDialectElement = new JsonSchemaDialectElement(
-      toValue(stringElement) as string | undefined,
-    );
-
-    this.copyMetaAndAttributes(stringElement, jsonSchemaDialectElement);
-
-    this.element = jsonSchemaDialectElement;
-    path.stop();
-  }
-}
-
-export default JsonSchemaDialectVisitor;

package/src/refractor/visitors/open-api-3-1/OpenapiVisitor.ts

@@ -1,30 +0,0 @@
-import { StringElement } from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from './bases.ts';
-import OpenapiElement from '../../../elements/Openapi.ts';
-
-/**
- * @public
- */
-export type { BaseSpecificationVisitorOptions as OpenapiVisitorOptions };
-
-/**
- * @public
- */
-class OpenapiVisitor extends BaseSpecificationVisitor {
-  declare public element: OpenapiElement;
-
-  StringElement(path: Path<StringElement>) {
-    const stringElement = path.node;
-    const openapiElement = new OpenapiElement(toValue(stringElement) as string | undefined);
-
-    this.copyMetaAndAttributes(stringElement, openapiElement);
-
-    this.element = openapiElement;
-    path.stop();
-  }
-}
-
-export default OpenapiVisitor;

package/src/refractor/visitors/open-api-3-1/WebhooksVisitor.ts

@@ -1,57 +0,0 @@
-import { ObjectElement, StringElement } from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-import { isReferenceLikeElement, MapVisitor, SpecPath } from '@speclynx/apidom-ns-openapi-3-0';
-
-import ReferenceElement from '../../../elements/Reference.ts';
-import PathItemElement from '../../../elements/PathItem.ts';
-import WebhooksElement from '../../../elements/nces/Webhooks.ts';
-import { isPathItemElement, isReferenceElement } from '../../../predicates.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from './bases.ts';
-
-/**
- * @public
- */
-export interface WebhooksVisitorOptions extends BaseMapVisitorOptions {}
-
-/**
- * @public
- */
-class WebhooksVisitor extends BaseMapVisitor {
-  declare public readonly element: WebhooksElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'PathItem']
-  >;
-
-  constructor(options: WebhooksVisitorOptions) {
-    super(options);
-    this.element = new WebhooksElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'PathItem'];
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    MapVisitor.prototype.ObjectElement.call(this, path);
-
-    // decorate every ReferenceElement with metadata about their referencing type
-    // @ts-ignore
-    this.element.filter(isReferenceElement).forEach((referenceElement: ReferenceElement) => {
-      // @ts-ignore
-      referenceElement.setMetaProperty('referenced-element', 'pathItem');
-    });
-
-    // decorate every PathItemElement with Webhook name metadata
-    this.element
-      .filter(isPathItemElement)
-      // @ts-ignore
-      .forEach((pathItemElement: PathItemElement, key: StringElement) => {
-        // @ts-ignore
-        pathItemElement.setMetaProperty('webhook-name', toValue(key));
-      });
-  }
-}
-
-export default WebhooksVisitor;

package/src/refractor/visitors/open-api-3-1/bases.ts

@@ -1,66 +0,0 @@
-import { Mixin } from 'ts-mixer';
-import {
-  SpecificationVisitor,
-  SpecificationVisitorOptions,
-  FallbackVisitor,
-  FallbackVisitorOptions,
-  FixedFieldsVisitor,
-  FixedFieldsVisitorOptions,
-  MapVisitor,
-  MapVisitorOptions,
-} from '@speclynx/apidom-ns-openapi-3-0';
-import {
-  ParentSchemaAwareVisitor,
-  ParentSchemaAwareVisitorOptions,
-} from '@speclynx/apidom-ns-json-schema-2020-12';
-
-/**
- * Base class for visitors using Mixin(SpecificationVisitor, FallbackVisitor)
- * @public
- */
-export const BaseSpecificationVisitor = Mixin(SpecificationVisitor, FallbackVisitor);
-
-/**
- * @public
- */
-export interface BaseSpecificationVisitorOptions
-  extends SpecificationVisitorOptions, FallbackVisitorOptions {}
-
-/**
- * Base class for visitors using Mixin(FixedFieldsVisitor, FallbackVisitor)
- * @public
- */
-export const BaseFixedFieldsVisitor = Mixin(FixedFieldsVisitor, FallbackVisitor);
-
-/**
- * @public
- */
-export interface BaseFixedFieldsVisitorOptions
-  extends FixedFieldsVisitorOptions, FallbackVisitorOptions {}
-
-/**
- * Base class for visitors using Mixin(MapVisitor, FallbackVisitor)
- * @public
- */
-export const BaseMapVisitor = Mixin(MapVisitor, FallbackVisitor);
-
-/**
- * @public
- */
-export interface BaseMapVisitorOptions extends MapVisitorOptions, FallbackVisitorOptions {}
-
-/**
- * Base class for visitors using Mixin(FixedFieldsVisitor, ParentSchemaAwareVisitor, FallbackVisitor)
- * @public
- */
-export const BaseSchemaVisitor = Mixin(
-  FixedFieldsVisitor,
-  ParentSchemaAwareVisitor,
-  FallbackVisitor,
-);
-
-/**
- * @public
- */
-export interface BaseSchemaVisitorOptions
-  extends FixedFieldsVisitorOptions, ParentSchemaAwareVisitorOptions, FallbackVisitorOptions {}

package/src/refractor/visitors/open-api-3-1/callback/index.ts

@@ -1,56 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-import {
-  isReferenceLikeElement,
-  specificationObj as OpenApi3_1Specification,
-  SpecPath,
-  CallbackVisitorOptions,
-  CallbackVisitor as CallbackVisitorType,
-} from '@speclynx/apidom-ns-openapi-3-0';
-
-import CallbackElement from '../../../../elements/Callback.ts';
-import ReferenceElement from '../../../../elements/Reference.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-
-/**
- * @public
- */
-export const BaseCallbackVisitor: typeof CallbackVisitorType =
-  OpenApi3_1Specification.visitors.document.objects.Callback.$visitor;
-
-export type { CallbackVisitorOptions };
-
-/**
- * @public
- */
-class CallbackVisitor extends BaseCallbackVisitor {
-  declare public readonly element: CallbackElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'PathItem']
-  >;
-
-  constructor(options: CallbackVisitorOptions) {
-    super(options);
-    this.element = new CallbackElement();
-    this.specPath = (element: unknown) => {
-      // @ts-ignore
-      return isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'PathItem'];
-    };
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    BaseCallbackVisitor.prototype.ObjectElement.call(this, path);
-
-    // decorate every ReferenceElement with metadata about their referencing type
-    // @ts-ignore
-    this.element.filter(isReferenceElement).forEach((referenceElement: ReferenceElement) => {
-      // @ts-ignore
-      referenceElement.setMetaProperty('referenced-element', 'pathItem');
-    });
-  }
-}
-
-export default CallbackVisitor;

package/src/refractor/visitors/open-api-3-1/components/PathItemsVisitor.ts

@@ -1,45 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-import { isReferenceLikeElement, MapVisitor, SpecPath } from '@speclynx/apidom-ns-openapi-3-0';
-
-import ReferenceElement from '../../../../elements/Reference.ts';
-import ComponentsPathItemsElement from '../../../../elements/nces/ComponentsPathItems.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-
-/**
- * @public
- */
-export interface PathItemsVisitorOptions extends BaseMapVisitorOptions {}
-
-/**
- * @public
- */
-class PathItemsVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsPathItemsElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'PathItem']
-  >;
-
-  constructor(options: PathItemsVisitorOptions) {
-    super(options);
-    this.element = new ComponentsPathItemsElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'PathItem'];
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    MapVisitor.prototype.ObjectElement.call(this, path);
-
-    // @ts-ignore
-    this.element.filter(isReferenceElement).forEach((referenceElement: ReferenceElement) => {
-      // @ts-ignore
-      referenceElement.setMetaProperty('referenced-element', 'pathItem');
-    });
-  }
-}
-
-export default PathItemsVisitor;

package/src/refractor/visitors/open-api-3-1/components/SchemasVisitor.ts

@@ -1,26 +0,0 @@
-import { always } from 'ramda';
-import { ComponentsSchemasElement, SpecPath } from '@speclynx/apidom-ns-openapi-3-0';
-
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-
-/**
- * @public
- */
-export interface SchemasVisitorOptions extends BaseMapVisitorOptions {}
-
-/**
- * @public
- */
-class SchemasVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsSchemasElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'Schema']>;
-
-  constructor(options: SchemasVisitorOptions) {
-    super(options);
-    this.element = new ComponentsSchemasElement();
-    this.specPath = always(['document', 'objects', 'Schema']);
-  }
-}
-
-export default SchemasVisitor;

package/src/refractor/visitors/open-api-3-1/components/index.ts

@@ -1,29 +0,0 @@
-import {
-  specificationObj as OpenApi3_1Specification,
-  ComponentsVisitorOptions,
-  ComponentsVisitor as ComponentsVisitorType,
-} from '@speclynx/apidom-ns-openapi-3-0';
-
-import ComponentsElement from '../../../../elements/Components.ts';
-
-/**
- * @public
- */
-export const BaseComponentsVisitor: typeof ComponentsVisitorType =
-  OpenApi3_1Specification.visitors.document.objects.Components.$visitor;
-
-export type { ComponentsVisitorOptions };
-
-/**
- * @public
- */
-class ComponentsVisitor extends BaseComponentsVisitor {
-  declare public readonly element: ComponentsElement;
-
-  constructor(options: ComponentsVisitorOptions) {
-    super(options);
-    this.element = new ComponentsElement();
-  }
-}
-
-export default ComponentsVisitor;

package/src/refractor/visitors/open-api-3-1/contact/index.ts

@@ -1,29 +0,0 @@
-import {
-  specificationObj as OpenApi3_1Specification,
-  ContactVisitorOptions,
-  ContactVisitor as ContactVisitorType,
-} from '@speclynx/apidom-ns-openapi-3-0';
-
-import ContactElement from '../../../../elements/Contact.ts';
-
-/**
- * @public
- */
-export const BaseContactVisitor: typeof ContactVisitorType =
-  OpenApi3_1Specification.visitors.document.objects.Contact.$visitor;
-
-export type { ContactVisitorOptions };
-
-/**
- * @public
- */
-class ContactVisitor extends BaseContactVisitor {
-  declare public readonly element: ContactElement;
-
-  constructor(options: ContactVisitorOptions) {
-    super(options);
-    this.element = new ContactElement();
-  }
-}
-
-export default ContactVisitor;

package/src/refractor/visitors/open-api-3-1/distriminator/index.ts

@@ -1,32 +0,0 @@
-import {
-  specificationObj as OpenApi3_1Specification,
-  DiscriminatorVisitorOptions,
-  DiscriminatorVisitor as DiscriminatorVisitorType,
-} from '@speclynx/apidom-ns-openapi-3-0';
-
-import DiscriminatorElement from '../../../../elements/Discriminator.ts';
-
-/**
- * @public
- */
-export const BaseDiscriminatorVisitor: typeof DiscriminatorVisitorType =
-  OpenApi3_1Specification.visitors.document.objects.Discriminator.$visitor;
-
-export type { DiscriminatorVisitorOptions };
-
-/**
- * @public
- */
-class DiscriminatorVisitor extends BaseDiscriminatorVisitor {
-  declare public readonly element: DiscriminatorElement;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: DiscriminatorVisitorOptions) {
-    super(options);
-    this.element = new DiscriminatorElement();
-    this.canSupportSpecificationExtensions = true;
-  }
-}
-
-export default DiscriminatorVisitor;

package/src/refractor/visitors/open-api-3-1/encoding/index.ts

@@ -1,29 +0,0 @@
-import {
-  specificationObj as OpenApi3_1Specification,
-  EncodingVisitorOptions,
-  EncodingVisitor as EncodingVisitorType,
-} from '@speclynx/apidom-ns-openapi-3-0';
-
-import EncodingElement from '../../../../elements/Encoding.ts';
-
-/**
- * @public
- */
-export const BaseEncodingVisitor: typeof EncodingVisitorType =
-  OpenApi3_1Specification.visitors.document.objects.Encoding.$visitor;
-
-export type { EncodingVisitorOptions };
-
-/**
- * @public
- */
-class EncodingVisitor extends BaseEncodingVisitor {
-  declare public readonly element: EncodingElement;
-
-  constructor(options: EncodingVisitorOptions) {
-    super(options);
-    this.element = new EncodingElement();
-  }
-}
-
-export default EncodingVisitor;

package/src/refractor/visitors/open-api-3-1/example/index.ts

@@ -1,29 +0,0 @@
-import {
-  specificationObj as OpenApi3_1Specification,
-  ExampleVisitorOptions,
-  ExampleVisitor as ExampleVisitorType,
-} from '@speclynx/apidom-ns-openapi-3-0';
-
-import ExampleElement from '../../../../elements/Example.ts';
-
-/**
- * @public
- */
-export const BaseExampleVisitor: typeof ExampleVisitorType =
-  OpenApi3_1Specification.visitors.document.objects.Example.$visitor;
-
-export type { ExampleVisitorOptions };
-
-/**
- * @public
- */
-class ExampleVisitor extends BaseExampleVisitor {
-  declare public readonly element: ExampleElement;
-
-  constructor(options: ExampleVisitorOptions) {
-    super(options);
-    this.element = new ExampleElement();
-  }
-}
-
-export default ExampleVisitor;

package/src/refractor/visitors/open-api-3-1/external-documentation/index.ts

@@ -1,29 +0,0 @@
-import {
-  specificationObj as OpenApi3_1Specification,
-  ExternalDocumentationVisitorOptions,
-  ExternalDocumentationVisitor as ExternalDocumentationVisitorType,
-} from '@speclynx/apidom-ns-openapi-3-0';
-
-import ExternalDocumentationElement from '../../../../elements/ExternalDocumentation.ts';
-
-/**
- * @public
- */
-export const BaseExternalDocumentationVisitor: typeof ExternalDocumentationVisitorType =
-  OpenApi3_1Specification.visitors.document.objects.ExternalDocumentation.$visitor;
-
-export type { ExternalDocumentationVisitorOptions };
-
-/**
- * @public
- */
-class ExternalDocumentationVisitor extends BaseExternalDocumentationVisitor {
-  declare public readonly element: ExternalDocumentationElement;
-
-  constructor(options: ExternalDocumentationVisitorOptions) {
-    super(options);
-    this.element = new ExternalDocumentationElement();
-  }
-}
-
-export default ExternalDocumentationVisitor;

package/src/refractor/visitors/open-api-3-1/header/index.ts

@@ -1,29 +0,0 @@
-import {
-  specificationObj as OpenApi3_1Specification,
-  HeaderVisitorOptions,
-  HeaderVisitor as HeaderVisitorType,
-} from '@speclynx/apidom-ns-openapi-3-0';
-
-import HeaderElement from '../../../../elements/Header.ts';
-
-/**
- * @public
- */
-export const BaseHeaderVisitor: typeof HeaderVisitorType =
-  OpenApi3_1Specification.visitors.document.objects.Header.$visitor;
-
-export type { HeaderVisitorOptions };
-
-/**
- * @public
- */
-class HeaderVisitor extends BaseHeaderVisitor {
-  declare public readonly element: HeaderElement;
-
-  constructor(options: HeaderVisitorOptions) {
-    super(options);
-    this.element = new HeaderElement();
-  }
-}
-
-export default HeaderVisitor;

package/src/refractor/visitors/open-api-3-1/index.ts

@@ -1,52 +0,0 @@
-import { always } from 'ramda';
-import { ObjectElement, isStringElement } from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-import { FixedFieldsVisitor, SpecPath } from '@speclynx/apidom-ns-openapi-3-0';
-
-import OpenApi3_1Element from '../../../elements/OpenApi3-1.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from './bases.ts';
-
-/**
- * @public
- */
-
-export interface OpenApi3_1VisitorOptions extends BaseFixedFieldsVisitorOptions {}
-
-/**
- * @public
- */
-
-class OpenApi3_1Visitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: OpenApi3_1Element;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'OpenApi']>;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  declare protected readonly openApiSemanticElement: OpenApi3_1Element;
-
-  constructor(options: OpenApi3_1VisitorOptions) {
-    super(options);
-    this.element = new OpenApi3_1Element();
-    this.specPath = always(['document', 'objects', 'OpenApi']);
-    this.canSupportSpecificationExtensions = true;
-    this.consumeSafe = true;
-    this.openApiSemanticElement = this.element;
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    const objectElement = path.node;
-    this.openApiGenericElement = objectElement;
-    // precompute values from generic root before consume may release fields
-    if (isStringElement(objectElement.get('jsonSchemaDialect'))) {
-      this.sourceContext = {
-        jsonSchemaDialect: toValue(objectElement.get('jsonSchemaDialect')) as string,
-      };
-    }
-
-    FixedFieldsVisitor.prototype.ObjectElement.call(this, path);
-  }
-}
-
-export default OpenApi3_1Visitor;

package/src/refractor/visitors/open-api-3-1/info/index.ts

@@ -1,29 +0,0 @@
-import {
-  specificationObj as OpenApi3_1Specification,
-  InfoVisitorOptions,
-  InfoVisitor as InfoVisitorType,
-} from '@speclynx/apidom-ns-openapi-3-0';
-
-import InfoElement from '../../../../elements/Info.ts';
-
-/**
- * @public
- */
-export const BaseInfoVisitor: typeof InfoVisitorType =
-  OpenApi3_1Specification.visitors.document.objects.Info.$visitor;
-
-export type { InfoVisitorOptions };
-
-/**
- * @public
- */
-class InfoVisitor extends BaseInfoVisitor {
-  declare public readonly element: InfoElement;
-
-  constructor(options: InfoVisitorOptions) {
-    super(options);
-    this.element = new InfoElement();
-  }
-}
-
-export default InfoVisitor;