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

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

@@ -1,27 +0,0 @@
-import { always } from 'ramda';
-
-import ContactElement from '../../../../elements/Contact.ts';
-import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
-
-export type { BaseFixedFieldsVisitorOptions as ContactVisitorOptions };
-
-/**
- * @public
- */
-class ContactVisitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: ContactElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'Contact']>;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BaseFixedFieldsVisitorOptions) {
-    super(options);
-    this.element = new ContactElement();
-    this.specPath = always(['document', 'objects', 'Contact']);
-    this.canSupportSpecificationExtensions = true;
-  }
-}
-
-export default ContactVisitor;

package/src/refractor/visitors/open-api-2/definitions/index.ts

@@ -1,48 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-import {
-  isJSONReferenceLikeElement,
-  isJSONReferenceElement,
-  JSONReferenceElement,
-} from '@speclynx/apidom-ns-json-schema-draft-4';
-
-import DefinitionsElement from '../../../../elements/Definitions.ts';
-import { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-
-export type { BaseMapVisitorOptions as DefinitionsVisitorOptions };
-
-/**
- * @public
- */
-class DefinitionsVisitor extends BaseMapVisitor {
-  declare public readonly element: DefinitionsElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'JSONReference'] | ['document', 'objects', 'Schema']
-  >;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new DefinitionsElement();
-    this.specPath = (element: unknown) => {
-      return isJSONReferenceLikeElement(element)
-        ? ['document', 'objects', 'JSONReference']
-        : ['document', 'objects', 'Schema'];
-    };
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    BaseMapVisitor.prototype.ObjectElement.call(this, path);
-
-    // decorate every JSONReferenceElement with metadata about their referencing type
-    this.element
-      .filter(isJSONReferenceElement)
-      // @ts-ignore
-      .forEach((referenceElement: JSONReferenceElement) => {
-        referenceElement.meta.set('referenced-element', 'schema');
-      });
-  }
-}
-
-export default DefinitionsVisitor;

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

@@ -1,27 +0,0 @@
-import { always } from 'ramda';
-
-import ExampleElement from '../../../../elements/Example.ts';
-import { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-
-export type { BaseMapVisitorOptions as ExampleVisitorOptions };
-
-/**
- * @public
- */
-class ExampleVisitor extends BaseMapVisitor {
-  declare public readonly element: ExampleElement;
-
-  declare protected readonly specPath: SpecPath<['value']>;
-
-  declare protected readonly canSupportSpecificationExtensions: false;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ExampleElement();
-    this.specPath = always(['value']);
-    this.canSupportSpecificationExtensions = false;
-  }
-}
-
-export default ExampleVisitor;

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

@@ -1,27 +0,0 @@
-import { always } from 'ramda';
-
-import ExternalDocumentationElement from '../../../../elements/ExternalDocumentation.ts';
-import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
-
-export type { BaseFixedFieldsVisitorOptions as ExternalDocumentationVisitorOptions };
-
-/**
- * @public
- */
-class ExternalDocumentationVisitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: ExternalDocumentationElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'ExternalDocumentation']>;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BaseFixedFieldsVisitorOptions) {
-    super(options);
-    this.element = new ExternalDocumentationElement();
-    this.specPath = always(['document', 'objects', 'ExternalDocumentation']);
-    this.canSupportSpecificationExtensions = true;
-  }
-}
-
-export default ExternalDocumentationVisitor;

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

@@ -1,27 +0,0 @@
-import { always } from 'ramda';
-
-import HeaderElement from '../../../../elements/Header.ts';
-import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
-
-export type { BaseFixedFieldsVisitorOptions as HeaderVisitorOptions };
-
-/**
- * @public
- */
-class HeaderVisitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: HeaderElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'Header']>;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BaseFixedFieldsVisitorOptions) {
-    super(options);
-    this.element = new HeaderElement();
-    this.specPath = always(['document', 'objects', 'Header']);
-    this.canSupportSpecificationExtensions = true;
-  }
-}
-
-export default HeaderVisitor;

package/src/refractor/visitors/open-api-2/headers/index.ts

@@ -1,27 +0,0 @@
-import { always } from 'ramda';
-
-import { SpecPath } from '../../generics/MapVisitor.ts';
-import HeadersElement from '../../../../elements/Headers.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-
-export type { BaseMapVisitorOptions as HeadersVisitorOptions };
-
-/**
- * @public
- */
-class HeadersVisitor extends BaseMapVisitor {
-  declare public readonly element: HeadersElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'Header']>;
-
-  declare protected readonly canSupportSpecificationExtensions: false;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new HeadersElement();
-    this.specPath = always(['document', 'objects', 'Header']);
-    this.canSupportSpecificationExtensions = false;
-  }
-}
-
-export default HeadersVisitor;

package/src/refractor/visitors/open-api-2/index.ts

@@ -1,28 +0,0 @@
-import { always } from 'ramda';
-
-import SwaggerElement from '../../../elements/Swagger.ts';
-import { SpecPath } from '../generics/FixedFieldsVisitor.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from './bases.ts';
-
-export type { BaseFixedFieldsVisitorOptions as SwaggerVisitorOptions };
-
-/**
- * @public
- */
-class SwaggerVisitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: SwaggerElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'Swagger']>;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BaseFixedFieldsVisitorOptions) {
-    super(options);
-    this.element = new SwaggerElement();
-    this.consumeSafe = true;
-    this.specPath = always(['document', 'objects', 'Swagger']);
-    this.canSupportSpecificationExtensions = true;
-  }
-}
-
-export default SwaggerVisitor;

package/src/refractor/visitors/open-api-2/info/VersionVisitor.ts

@@ -1,21 +0,0 @@
-import { StringElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import FallbackVisitor, { FallbackVisitorOptions } from '../../FallbackVisitor.ts';
-
-export type { FallbackVisitorOptions as VersionVisitorOptions };
-
-/**
- * @public
- */
-class VersionVisitor extends FallbackVisitor {
-  declare public readonly element: StringElement;
-
-  StringElement(path: Path<StringElement>) {
-    super.enter(path);
-    this.element.classes.push('api-version');
-    this.element.classes.push('version');
-  }
-}
-
-export default VersionVisitor;

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

@@ -1,27 +0,0 @@
-import { always } from 'ramda';
-
-import InfoElement from '../../../../elements/Info.ts';
-import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
-
-export type { BaseFixedFieldsVisitorOptions as InfoVisitorOptions };
-
-/**
- * @public
- */
-class InfoVisitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: InfoElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'Info']>;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BaseFixedFieldsVisitorOptions) {
-    super(options);
-    this.element = new InfoElement();
-    this.specPath = always(['document', 'objects', 'Info']);
-    this.canSupportSpecificationExtensions = true;
-  }
-}
-
-export default InfoVisitor;

package/src/refractor/visitors/open-api-2/items/index.ts

@@ -1,27 +0,0 @@
-import { always } from 'ramda';
-
-import ItemsElement from '../../../../elements/Items.ts';
-import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
-
-export type { BaseFixedFieldsVisitorOptions as ItemsVisitorOptions };
-
-/**
- * @public
- */
-class ItemsVisitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: ItemsElement;
-
-  protected readonly specPath: SpecPath<['document', 'objects', 'Items']>;
-
-  protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BaseFixedFieldsVisitorOptions) {
-    super(options);
-    this.element = new ItemsElement();
-    this.specPath = always(['document', 'objects', 'Items']);
-    this.canSupportSpecificationExtensions = true;
-  }
-}
-
-export default ItemsVisitor;

package/src/refractor/visitors/open-api-2/license/index.ts

@@ -1,27 +0,0 @@
-import { always } from 'ramda';
-
-import LicenseElement from '../../../../elements/License.ts';
-import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
-
-export type { BaseFixedFieldsVisitorOptions as LicenseVisitorOptions };
-
-/**
- * @public
- */
-class LicenseVisitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: LicenseElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'License']>;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BaseFixedFieldsVisitorOptions) {
-    super(options);
-    this.element = new LicenseElement();
-    this.specPath = always(['document', 'objects', 'License']);
-    this.canSupportSpecificationExtensions = true;
-  }
-}
-
-export default LicenseVisitor;

package/src/refractor/visitors/open-api-2/operation/ConsumesVisitor.ts

@@ -1,29 +0,0 @@
-import { ArrayElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import OperationConsumesElement from '../../../../elements/nces/OperationConsumes.ts';
-import FallbackVisitor, { FallbackVisitorOptions } from '../../FallbackVisitor.ts';
-
-export type { FallbackVisitorOptions as ConsumesVisitorOptions };
-
-/**
- * @public
- */
-class ConsumesVisitor extends FallbackVisitor {
-  declare public element: OperationConsumesElement;
-
-  constructor(options: FallbackVisitorOptions) {
-    super(options);
-    this.element = new OperationConsumesElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    this.element = this.element.concat(cloneDeep(arrayElement));
-
-    path.stop();
-  }
-}
-
-export default ConsumesVisitor;

package/src/refractor/visitors/open-api-2/operation/ParametersVisitor.ts

@@ -1,44 +0,0 @@
-import { ArrayElement, Element } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-import OperationParametersElement from '../../../../elements/nces/OperationParameters.ts';
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from '../bases.ts';
-
-export type { BaseSpecificationVisitorOptions as ParametersVisitorOptions };
-
-/**
- * @public
- */
-class ParametersVisitor extends BaseSpecificationVisitor {
-  declare public readonly element: OperationParametersElement;
-
-  constructor(options: BaseSpecificationVisitorOptions) {
-    super(options);
-    this.element = new OperationParametersElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    arrayElement.forEach((item: Element): void => {
-      const specPath = isReferenceLikeElement(item)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Parameter'];
-      const element = this.toRefractedElement(specPath, item);
-
-      if (isReferenceElement(element)) {
-        element.meta.set('referenced-element', 'parameter');
-      }
-
-      this.element.push(element);
-    });
-
-    this.copyMetaAndAttributes(arrayElement, this.element);
-
-    path.stop();
-  }
-}
-
-export default ParametersVisitor;

package/src/refractor/visitors/open-api-2/operation/ProducesVisitor.ts

@@ -1,29 +0,0 @@
-import { ArrayElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import OperationProducesElement from '../../../../elements/nces/OperationProduces.ts';
-import FallbackVisitor, { FallbackVisitorOptions } from '../../FallbackVisitor.ts';
-
-export type { FallbackVisitorOptions as ProducesVisitorOptions };
-
-/**
- * @public
- */
-class ProducesVisitor extends FallbackVisitor {
-  declare public element: OperationProducesElement;
-
-  constructor(options: FallbackVisitorOptions) {
-    super(options);
-    this.element = new OperationProducesElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    this.element = this.element.concat(cloneDeep(arrayElement));
-
-    path.stop();
-  }
-}
-
-export default ProducesVisitor;

package/src/refractor/visitors/open-api-2/operation/SchemesVisitor.ts

@@ -1,29 +0,0 @@
-import { ArrayElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import OperationSchemesElement from '../../../../elements/nces/OperationSchemes.ts';
-import FallbackVisitor, { FallbackVisitorOptions } from '../../FallbackVisitor.ts';
-
-export type { FallbackVisitorOptions as SchemesVisitorOptions };
-
-/**
- * @public
- */
-class SchemesVisitor extends FallbackVisitor {
-  declare public element: OperationSchemesElement;
-
-  constructor(options: FallbackVisitorOptions) {
-    super(options);
-    this.element = new OperationSchemesElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    this.element = this.element.concat(cloneDeep(arrayElement));
-
-    path.stop();
-  }
-}
-
-export default SchemesVisitor;

package/src/refractor/visitors/open-api-2/operation/SecurityVisitor.ts

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

package/src/refractor/visitors/open-api-2/operation/TagsVisitor.ts

@@ -1,29 +0,0 @@
-import { ArrayElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import OperationTagsElement from '../../../../elements/nces/OperationTags.ts';
-import FallbackVisitor, { FallbackVisitorOptions } from '../../FallbackVisitor.ts';
-
-export type { FallbackVisitorOptions as TagsVisitorOptions };
-
-/**
- * @public
- */
-class TagsVisitor extends FallbackVisitor {
-  declare public element: OperationTagsElement;
-
-  constructor(options: FallbackVisitorOptions) {
-    super(options);
-    this.element = new OperationTagsElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    this.element = this.element.concat(cloneDeep(arrayElement));
-
-    path.stop();
-  }
-}
-
-export default TagsVisitor;

package/src/refractor/visitors/open-api-2/operation/index.ts

@@ -1,24 +0,0 @@
-import { always } from 'ramda';
-
-import OperationElement from '../../../../elements/Operation.ts';
-import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
-
-export type { BaseFixedFieldsVisitorOptions as OperationVisitorOptions };
-
-/**
- * @public
- */
-class OperationVisitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: OperationElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'Operation']>;
-
-  constructor(options: BaseFixedFieldsVisitorOptions) {
-    super(options);
-    this.element = new OperationElement();
-    this.specPath = always(['document', 'objects', 'Operation']);
-  }
-}
-
-export default OperationVisitor;

package/src/refractor/visitors/open-api-2/parameter/index.ts

@@ -1,27 +0,0 @@
-import { always } from 'ramda';
-
-import ParameterElement from '../../../../elements/Parameter.ts';
-import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
-import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
-
-export type { BaseFixedFieldsVisitorOptions as ParameterVisitorOptions };
-
-/**
- * @public
- */
-class ParameterVisitor extends BaseFixedFieldsVisitor {
-  declare public readonly element: ParameterElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'Parameter']>;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BaseFixedFieldsVisitorOptions) {
-    super(options);
-    this.element = new ParameterElement();
-    this.specPath = always(['document', 'objects', 'Parameter']);
-    this.canSupportSpecificationExtensions = true;
-  }
-}
-
-export default ParameterVisitor;

package/src/refractor/visitors/open-api-2/parameters-definitions/index.ts

@@ -1,24 +0,0 @@
-import { always } from 'ramda';
-
-import ParametersDefinitionsElement from '../../../../elements/ParametersDefinitions.ts';
-import { SpecPath } from '../../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from '../bases.ts';
-
-export type { BaseMapVisitorOptions as ParametersDefinitionsVisitorOptions };
-
-/**
- * @public
- */
-class ParametersDefinitionsVisitor extends BaseMapVisitor {
-  declare public readonly element: ParametersDefinitionsElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'Parameter']>;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ParametersDefinitionsElement();
-    this.specPath = always(['document', 'objects', 'Parameter']);
-  }
-}
-
-export default ParametersDefinitionsVisitor;

package/src/refractor/visitors/open-api-2/path-item/$RefVisitor.ts

@@ -1,20 +0,0 @@
-import { StringElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import FallbackVisitor, { FallbackVisitorOptions } from '../../FallbackVisitor.ts';
-
-export type { FallbackVisitorOptions as $RefVisitorOptions };
-
-/**
- * @public
- */
-class $RefVisitor extends FallbackVisitor {
-  declare public readonly element: StringElement;
-
-  StringElement(path: Path<StringElement>) {
-    super.enter(path);
-    this.element.classes.push('reference-value');
-  }
-}
-
-export default $RefVisitor;

package/src/refractor/visitors/open-api-2/path-item/ParametersVisitor.ts

@@ -1,44 +0,0 @@
-import { ArrayElement, Element } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import { isReferenceLikeElement } from '../../../predicates.ts';
-import { isReferenceElement } from '../../../../predicates.ts';
-import PathItemParametersElement from '../../../../elements/nces/PathItemParameters.ts';
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from '../bases.ts';
-
-export type { BaseSpecificationVisitorOptions as ParametersVisitorOptions };
-
-/**
- * @public
- */
-class ParametersVisitor extends BaseSpecificationVisitor {
-  declare public readonly element: PathItemParametersElement;
-
-  constructor(options: BaseSpecificationVisitorOptions) {
-    super(options);
-    this.element = new PathItemParametersElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    arrayElement.forEach((item: Element): void => {
-      const specPath = isReferenceLikeElement(item)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Parameter'];
-      const element = this.toRefractedElement(specPath, item);
-
-      if (isReferenceElement(element)) {
-        element.meta.set('referenced-element', 'parameter');
-      }
-
-      this.element.push(element);
-    });
-
-    this.copyMetaAndAttributes(arrayElement, this.element);
-
-    path.stop();
-  }
-}
-
-export default ParametersVisitor;