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

package/src/refractor/visitors/open-api-3-0/SecurityVisitor.ts

@@ -1,44 +0,0 @@
-import { ArrayElement, isObjectElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import SecurityElement from '../../../elements/nces/Security.ts';
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from './bases.ts';
-
-/**
- * @public
- */
-export type { BaseSpecificationVisitorOptions as SecurityVisitorOptions };
-
-/**
- * @public
- */
-class SecurityVisitor extends BaseSpecificationVisitor {
-  declare public readonly element: SecurityElement;
-
-  constructor(options: BaseSpecificationVisitorOptions) {
-    super(options);
-    this.element = new SecurityElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    arrayElement.forEach((item) => {
-      if (isObjectElement(item)) {
-        const element = this.toRefractedElement(
-          ['document', 'objects', 'SecurityRequirement'],
-          item,
-        );
-        this.element.push(element);
-      } else {
-        this.element.push(cloneDeep(item));
-      }
-    });
-
-    this.copyMetaAndAttributes(arrayElement, this.element);
-
-    path.stop();
-  }
-}
-
-export default SecurityVisitor;

package/src/refractor/visitors/open-api-3-0/ServersVisitor.ts

@@ -1,40 +0,0 @@
-import { ArrayElement, Element } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import ServersElement from '../../../elements/nces/Servers.ts';
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from './bases.ts';
-import { isServerLikeElement } from '../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseSpecificationVisitorOptions as ServersVisitorOptions };
-
-/**
- * @public
- */
-class ServersVisitor extends BaseSpecificationVisitor {
-  declare public readonly element: ServersElement;
-
-  constructor(options: BaseSpecificationVisitorOptions) {
-    super(options);
-    this.element = new ServersElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    arrayElement.forEach((item: Element) => {
-      const specPath = isServerLikeElement(item) ? ['document', 'objects', 'Server'] : ['value'];
-      const element = this.toRefractedElement(specPath, item);
-
-      this.element.push(element);
-    });
-
-    this.copyMetaAndAttributes(arrayElement, this.element);
-
-    path.stop();
-  }
-}
-
-export default ServersVisitor;

package/src/refractor/visitors/open-api-3-0/TagsVisitor.ts

@@ -1,40 +0,0 @@
-import { ArrayElement, Element } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import TagsElement from '../../../elements/nces/Tags.ts';
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from './bases.ts';
-import { isTagLikeElement } from '../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseSpecificationVisitorOptions as TagsVisitorOptions };
-
-/**
- * @public
- */
-class TagsVisitor extends BaseSpecificationVisitor {
-  declare public readonly element: TagsElement;
-
-  constructor(options: BaseSpecificationVisitorOptions) {
-    super(options);
-    this.element = new TagsElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    arrayElement.forEach((item: Element) => {
-      const specPath = isTagLikeElement(item) ? ['document', 'objects', 'Tag'] : ['value'];
-      const element = this.toRefractedElement(specPath, item);
-
-      this.element.push(element);
-    });
-
-    this.copyMetaAndAttributes(arrayElement, this.element);
-
-    path.stop();
-  }
-}
-
-export default TagsVisitor;

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

@@ -1,82 +0,0 @@
-import { Mixin } from 'ts-mixer';
-
-import SpecificationVisitor, { SpecificationVisitorOptions } from '../SpecificationVisitor.ts';
-import FallbackVisitor, { FallbackVisitorOptions } from '../FallbackVisitor.ts';
-import FixedFieldsVisitor, { FixedFieldsVisitorOptions } from '../generics/FixedFieldsVisitor.ts';
-import PatternedFieldsVisitor, {
-  PatternedFieldsVisitorOptions,
-} from '../generics/PatternedFieldsVisitor.ts';
-import MapVisitor, { MapVisitorOptions } from '../generics/MapVisitor.ts';
-import AlternatingVisitor, { AlternatingVisitorOptions } from '../generics/AlternatingVisitor.ts';
-import MixedFieldsVisitor, { MixedFieldsVisitorOptions } from '../generics/MixedFieldsVisitor.ts';
-
-/**
- * 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(PatternedFieldsVisitor, FallbackVisitor)
- * @public
- */
-export const BasePatternedFieldsVisitor = Mixin(PatternedFieldsVisitor, FallbackVisitor);
-
-/**
- * @public
- */
-export interface BasePatternedFieldsVisitorOptions
-  extends PatternedFieldsVisitorOptions, 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(AlternatingVisitor, FallbackVisitor)
- * @public
- */
-export const BaseAlternatingVisitor = Mixin(AlternatingVisitor, FallbackVisitor);
-
-/**
- * @public
- */
-export interface BaseAlternatingVisitorOptions
-  extends AlternatingVisitorOptions, FallbackVisitorOptions {}
-
-/**
- * Base class for visitors using Mixin(MixedFieldsVisitor, FallbackVisitor)
- * @public
- */
-export const BaseMixedFieldsVisitor = Mixin(MixedFieldsVisitor, FallbackVisitor);
-
-/**
- * @public
- */
-export interface BaseMixedFieldsVisitorOptions
-  extends MixedFieldsVisitorOptions, FallbackVisitorOptions {}

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

@@ -1,49 +0,0 @@
-import { always } from 'ramda';
-import { ObjectElement, StringElement } from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-
-import CallbackElement from '../../../../elements/Callback.ts';
-import PathItemElement from '../../../../elements/PathItem.ts';
-import { SpecPath } from '../../generics/PatternedFieldsVisitor.ts';
-import MapVisitor from '../../generics/MapVisitor.ts';
-import { isPathItemElement } from '../../../../predicates.ts';
-import { BasePatternedFieldsVisitor, BasePatternedFieldsVisitorOptions } from '../bases.ts';
-
-/**
- * @public
- */
-export type { BasePatternedFieldsVisitorOptions as CallbackVisitorOptions };
-
-/**
- * @public
- */
-class CallbackVisitor extends BasePatternedFieldsVisitor {
-  declare public readonly element: CallbackElement;
-
-  declare protected readonly specPath: SpecPath;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BasePatternedFieldsVisitorOptions) {
-    super(options);
-    this.element = new CallbackElement();
-    this.specPath = always(['document', 'objects', 'PathItem']);
-    this.canSupportSpecificationExtensions = true;
-    this.fieldPatternPredicate = (value) => /{(?<expression>[^}]{1,2083})}/.test(String(value)); // 2,083 characters is the maximum length of a URL in Chrome
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    MapVisitor.prototype.ObjectElement.call(this, path);
-
-    // decorate every PathItemElement with Callback Object expression metadata
-    this.element
-      .filter(isPathItemElement)
-      // @ts-ignore
-      .forEach((pathItemElement: PathItemElement, key: StringElement) => {
-        pathItemElement.meta.set('runtime-expression', toValue(key));
-      });
-  }
-}
-
-export default CallbackVisitor;

package/src/refractor/visitors/open-api-3-0/components/CallbacksVisitor.ts

@@ -1,45 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import ReferenceElement from '../../../../elements/Reference.ts';
-import ComponentsCallbacksElement from '../../../../elements/nces/ComponentsCallbacks.ts';
-import MapVisitor, { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as CallbackVisitorOptions };
-
-/**
- * @public
- */
-class CallbacksVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsCallbacksElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'Callback']
-  >;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ComponentsCallbacksElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Callback'];
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    MapVisitor.prototype.ObjectElement.call(this, path);
-
-    // @ts-ignore
-    this.element.filter(isReferenceElement).forEach((referenceElement: ReferenceElement) => {
-      referenceElement.meta.set('referenced-element', 'callback');
-    });
-  }
-}
-
-export default CallbacksVisitor;

package/src/refractor/visitors/open-api-3-0/components/ExamplesVisitor.ts

@@ -1,46 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import ReferenceElement from '../../../../elements/Reference.ts';
-import ComponentsExamplesElement from '../../../../elements/nces/ComponentsExamples.ts';
-import MapVisitor, { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as ExamplesVisitorOptions };
-
-/**
- * @public
- */
-class ExamplesVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsExamplesElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'Example']
-  >;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ComponentsExamplesElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Example'];
-  }
-
-  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) => {
-      referenceElement.meta.set('referenced-element', 'example');
-    });
-  }
-}
-
-export default ExamplesVisitor;

package/src/refractor/visitors/open-api-3-0/components/HeadersVisitor.ts

@@ -1,53 +0,0 @@
-import { ObjectElement, Element, StringElement } from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-
-import ReferenceElement from '../../../../elements/Reference.ts';
-import ComponentsHeadersElement from '../../../../elements/nces/ComponentsHeaders.ts';
-import MapVisitor, { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement, isHeaderElement } from '../../../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as HeadersVisitorOptions };
-
-/**
- * @public
- */
-class HeadersVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsHeadersElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'Header']
-  >;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ComponentsHeadersElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Header'];
-  }
-
-  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) => {
-      referenceElement.meta.set('referenced-element', 'header');
-    });
-
-    // decorate every HeaderElement with metadata about their name
-    // @ts-ignore
-    this.element.filter(isHeaderElement).forEach((value: Element, key: StringElement) => {
-      value.meta.set('header-name', toValue(key));
-    });
-  }
-}
-
-export default HeadersVisitor;

package/src/refractor/visitors/open-api-3-0/components/LinksVisitor.ts

@@ -1,45 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import ReferenceElement from '../../../../elements/Reference.ts';
-import ComponentsLinksElement from '../../../../elements/nces/ComponentsLinks.ts';
-import MapVisitor, { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as LinksVisitorOptions };
-
-/**
- * @public
- */
-class LinksVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsLinksElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'Link']
-  >;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ComponentsLinksElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Link'];
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    MapVisitor.prototype.ObjectElement.call(this, path);
-
-    // @ts-ignore
-    this.element.filter(isReferenceElement).forEach((referenceElement: ReferenceElement) => {
-      referenceElement.meta.set('referenced-element', 'link');
-    });
-  }
-}
-
-export default LinksVisitor;

package/src/refractor/visitors/open-api-3-0/components/ParametersVisitor.ts

@@ -1,46 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import ReferenceElement from '../../../../elements/Reference.ts';
-import ComponentsParametersElement from '../../../../elements/nces/ComponentsParameters.ts';
-import MapVisitor, { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as ParametersVisitorOptions };
-
-/**
- * @public
- */
-class ParametersVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsParametersElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'Parameter']
-  >;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ComponentsParametersElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Parameter'];
-  }
-
-  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) => {
-      referenceElement.meta.set('referenced-element', 'parameter');
-    });
-  }
-}
-
-export default ParametersVisitor;

package/src/refractor/visitors/open-api-3-0/components/RequestBodiesVisitor.ts

@@ -1,45 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import ReferenceElement from '../../../../elements/Reference.ts';
-import ComponentsRequestBodiesElement from '../../../../elements/nces/ComponentsRequestBodies.ts';
-import MapVisitor, { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as RequestBodiesVisitorOptions };
-
-/**
- * @public
- */
-class RequestBodiesVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsRequestBodiesElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'RequestBody']
-  >;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ComponentsRequestBodiesElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'RequestBody'];
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    MapVisitor.prototype.ObjectElement.call(this, path);
-
-    // @ts-ignore
-    this.element.filter(isReferenceElement).forEach((referenceElement: ReferenceElement) => {
-      referenceElement.meta.set('referenced-element', 'requestBody');
-    });
-  }
-}
-
-export default RequestBodiesVisitor;

package/src/refractor/visitors/open-api-3-0/components/ResponsesVisitor.ts

@@ -1,53 +0,0 @@
-import { ObjectElement, Element, StringElement } from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-
-import ReferenceElement from '../../../../elements/Reference.ts';
-import ComponentsResponsesElement from '../../../../elements/nces/ComponentsResponses.ts';
-import MapVisitor, { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement, isResponseElement } from '../../../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as ResponsesVisitorOptions };
-
-/**
- * @public
- */
-class ResponsesVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsResponsesElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'Response']
-  >;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ComponentsResponsesElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Response'];
-  }
-
-  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) => {
-      referenceElement.meta.set('referenced-element', 'response');
-    });
-
-    // decorate every ResponseElement with metadata about their status code
-    // @ts-ignore
-    this.element.filter(isResponseElement).forEach((value: Element, key: StringElement) => {
-      value.meta.set('http-status-code', toValue(key));
-    });
-  }
-}
-
-export default ResponsesVisitor;

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

@@ -1,46 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import ReferenceElement from '../../../../elements/Reference.ts';
-import ComponentsSchemasElement from '../../../../elements/nces/ComponentsSchemas.ts';
-import MapVisitor, { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as SchemasVisitorOptions };
-
-/**
- * @public
- */
-class SchemasVisitor extends BaseMapVisitor {
-  declare public readonly element: ComponentsSchemasElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'Schema']
-  >;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ComponentsSchemasElement();
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Schema'];
-  }
-
-  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) => {
-      referenceElement.meta.set('referenced-element', 'schema');
-    });
-  }
-}
-
-export default SchemasVisitor;