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

package/src/refractor/visitors/generics/AlternatingVisitor.ts

@@ -1,45 +0,0 @@
-import { ifElse, always } from 'ramda';
-import { dispatch, stubUndefined } from 'ramda-adjunct';
-import { Element } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import SpecificationVisitor, { SpecificationVisitorOptions } from '../SpecificationVisitor.ts';
-
-/**
- * @public
- */
-export type Alternator = { predicate: (element: unknown) => boolean; specPath: string[] };
-
-/**
- * @public
- */
-export interface AlternatingVisitorOptions extends SpecificationVisitorOptions {
-  readonly alternator?: Alternator[];
-}
-
-/**
- * @public
- */
-class AlternatingVisitor extends SpecificationVisitor {
-  protected alternator: Alternator[];
-
-  constructor({ alternator, ...rest }: AlternatingVisitorOptions) {
-    super({ ...rest });
-    this.alternator = alternator || [];
-  }
-
-  enter(path: Path<Element>) {
-    const element = path.node;
-    const functions = this.alternator.map(
-      ({ predicate, specPath }: { predicate: (element: unknown) => boolean; specPath: string[] }) =>
-        ifElse(predicate, always(specPath), stubUndefined),
-    );
-    const specPath = dispatch(functions)(element);
-
-    this.element = this.toRefractedElement(specPath, element);
-
-    path.stop();
-  }
-}
-
-export default AlternatingVisitor;

package/src/refractor/visitors/generics/FixedFieldsVisitor.ts

@@ -1,109 +0,0 @@
-import {
-  isStringElement,
-  MemberElement,
-  Element,
-  ObjectElement,
-  cloneDeep,
-} from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-
-import SpecificationVisitor, { SpecificationVisitorOptions } from '../SpecificationVisitor.ts';
-import { isSwaggerExtension } from '../../predicates.ts';
-
-/**
- * @public
- */
-export type SpecPath<T = string[]> = (element: unknown) => T;
-
-/**
- * @public
- */
-export interface FixedFieldsVisitorOptions extends SpecificationVisitorOptions {
-  readonly specPath: SpecPath;
-  readonly ignoredFields?: string[];
-  readonly canSupportSpecificationExtensions?: boolean;
-  readonly specificationExtensionPredicate?: typeof isSwaggerExtension;
-}
-
-/**
- * @public
- */
-class FixedFieldsVisitor extends SpecificationVisitor {
-  protected specPath: SpecPath;
-
-  protected ignoredFields: string[];
-
-  protected canSupportSpecificationExtensions: boolean = true;
-
-  protected specificationExtensionPredicate = isSwaggerExtension;
-
-  constructor({
-    specPath,
-    ignoredFields,
-    canSupportSpecificationExtensions,
-    specificationExtensionPredicate,
-    ...rest
-  }: FixedFieldsVisitorOptions) {
-    super({ ...rest });
-    this.specPath = specPath;
-    this.ignoredFields = ignoredFields || [];
-
-    if (typeof canSupportSpecificationExtensions === 'boolean') {
-      this.canSupportSpecificationExtensions = canSupportSpecificationExtensions;
-    }
-
-    if (typeof specificationExtensionPredicate === 'function') {
-      this.specificationExtensionPredicate = specificationExtensionPredicate;
-    }
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    const objectElement = path.node;
-    const specPath = this.specPath(objectElement);
-    const fields = this.retrieveFixedFields(specPath);
-
-    // @ts-ignore
-    objectElement.forEach((value: Element, key: Element, memberElement: MemberElement) => {
-      const keyValue = toValue(key) as string;
-      if (
-        isStringElement(key) &&
-        fields.includes(keyValue) &&
-        !this.ignoredFields.includes(keyValue)
-      ) {
-        const fixedFieldElement = this.toRefractedElement(
-          [...specPath, 'fixedFields', keyValue],
-          value,
-        );
-        const newMemberElement = new MemberElement(
-          this.consume ? key : cloneDeep(key),
-          fixedFieldElement,
-        );
-        this.copyMetaAndAttributes(memberElement, newMemberElement);
-        (this.element.content as Element[]).push(newMemberElement);
-        // consume: release processed generic subtree
-        if (this.consume && this.consumeSafe && !memberElement.isFrozen)
-          memberElement.value = undefined;
-      } else if (
-        this.canSupportSpecificationExtensions &&
-        this.specificationExtensionPredicate(memberElement)
-      ) {
-        const extensionElement = this.toRefractedElement(['document', 'extension'], memberElement);
-        (this.element.content as Element[]).push(extensionElement);
-        // consume: release processed generic subtree
-        if (this.consume && this.consumeSafe && !memberElement.isFrozen)
-          memberElement.value = undefined;
-      } else if (!this.ignoredFields.includes(keyValue)) {
-        (this.element.content as Element[]).push(
-          this.consume ? memberElement : cloneDeep(memberElement),
-        );
-      }
-    });
-
-    this.copyMetaAndAttributes(objectElement, this.element);
-
-    path.stop();
-  }
-}
-
-export default FixedFieldsVisitor;

package/src/refractor/visitors/generics/MapVisitor.ts

@@ -1,25 +0,0 @@
-import { isNonEmptyString } from 'ramda-adjunct';
-
-import PatternedFieldsVisitor, {
-  PatternedFieldsVisitorOptions,
-  SpecPath,
-} from './PatternedFieldsVisitor.ts';
-
-export type { SpecPath };
-
-/**
- * @public
- */
-export interface MapVisitorOptions extends PatternedFieldsVisitorOptions {}
-
-/**
- * @public
- */
-class MapVisitor extends PatternedFieldsVisitor {
-  constructor(options: MapVisitorOptions) {
-    super(options);
-    this.fieldPatternPredicate = isNonEmptyString;
-  }
-}
-
-export default MapVisitor;

package/src/refractor/visitors/generics/MixedFieldsVisitor.ts

@@ -1,77 +0,0 @@
-import { Mixin } from 'ts-mixer';
-import { difference } from 'ramda';
-import { ObjectElement, MemberElement, Element } from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-
-import FixedFieldsVisitor, { SpecPath } from './FixedFieldsVisitor.ts';
-import PatternedFieldsVisitor, { PatternedFieldsVisitorOptions } from './PatternedFieldsVisitor.ts';
-
-export type { SpecPath };
-
-/**
- * @public
- */
-export interface MixedFieldsVisitorOptions extends PatternedFieldsVisitorOptions {
-  readonly specPathFixedFields: SpecPath;
-  readonly specPathPatternedFields: SpecPath;
-}
-
-/**
- * Base class for MixedFieldsVisitor combining FixedFieldsVisitor and PatternedFieldsVisitor.
- * @public
- */
-export const MixedFieldsVisitorBase = Mixin(FixedFieldsVisitor, PatternedFieldsVisitor);
-
-/**
- * @public
- */
-class MixedFieldsVisitor extends MixedFieldsVisitorBase {
-  protected readonly specPathFixedFields: SpecPath;
-
-  protected readonly specPathPatternedFields: SpecPath;
-
-  constructor({
-    specPathFixedFields,
-    specPathPatternedFields,
-    ...rest
-  }: MixedFieldsVisitorOptions) {
-    super({ ...rest });
-    this.specPathFixedFields = specPathFixedFields;
-    this.specPathPatternedFields = specPathPatternedFields;
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    const objectElement = path.node;
-    const { specPath, ignoredFields } = this;
-
-    try {
-      this.specPath = this.specPathFixedFields;
-      const fixedFields = this.retrieveFixedFields(this.specPath(objectElement));
-      // let FixedFieldsVisitor only process fixed fields and leave rest to PatternedFieldsVisitor
-      // @ts-ignore
-      this.ignoredFields = [...ignoredFields, ...difference(objectElement.keys(), fixedFields)];
-      FixedFieldsVisitor.prototype.ObjectElement.call(this, path);
-
-      this.specPath = this.specPathPatternedFields;
-      this.ignoredFields = fixedFields;
-      PatternedFieldsVisitor.prototype.ObjectElement.call(this, path);
-
-      // reorder this.element members by original objectElement keys
-      const objectElementKeys = objectElement.keys() as string[];
-      (this.element.content as Element[]).sort((a: unknown, b: unknown) => {
-        return (
-          objectElementKeys.indexOf(toValue((a as MemberElement).key) as string) -
-          objectElementKeys.indexOf(toValue((b as MemberElement).key) as string)
-        );
-      });
-    } catch (e) {
-      this.specPath = specPath;
-      throw e;
-    }
-
-    path.stop();
-  }
-}
-
-export default MixedFieldsVisitor;

package/src/refractor/visitors/generics/PatternedFieldsVisitor.ts

@@ -1,99 +0,0 @@
-import { F as stubFalse } from 'ramda';
-import { ObjectElement, Element, MemberElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path } from '@speclynx/apidom-traverse';
-
-import SpecificationVisitor, { SpecificationVisitorOptions } from '../SpecificationVisitor.ts';
-import type { SpecPath } from './FixedFieldsVisitor.ts';
-import { isSwaggerExtension } from '../../predicates.ts';
-
-export type { SpecPath };
-
-/**
- * @public
- */
-export interface PatternedFieldsVisitorOptions extends SpecificationVisitorOptions {
-  readonly specPath: SpecPath;
-  readonly ignoredFields?: string[];
-  readonly fieldPatternPredicate?: (...args: unknown[]) => boolean;
-  readonly canSupportSpecificationExtensions?: boolean;
-  readonly specificationExtensionPredicate?: typeof isSwaggerExtension;
-}
-
-/**
- * @public
- */
-class PatternedFieldsVisitor extends SpecificationVisitor {
-  protected specPath: SpecPath;
-
-  protected ignoredFields: string[];
-
-  protected fieldPatternPredicate: (value: unknown) => boolean = stubFalse;
-
-  protected canSupportSpecificationExtensions: boolean = false;
-
-  protected specificationExtensionPredicate = isSwaggerExtension;
-
-  constructor({
-    specPath,
-    ignoredFields,
-    fieldPatternPredicate,
-    canSupportSpecificationExtensions,
-    specificationExtensionPredicate,
-    ...rest
-  }: PatternedFieldsVisitorOptions) {
-    super({ ...rest });
-    this.specPath = specPath;
-    this.ignoredFields = ignoredFields || [];
-
-    if (typeof fieldPatternPredicate === 'function') {
-      this.fieldPatternPredicate = fieldPatternPredicate;
-    }
-
-    if (typeof canSupportSpecificationExtensions === 'boolean') {
-      this.canSupportSpecificationExtensions = canSupportSpecificationExtensions;
-    }
-
-    if (typeof specificationExtensionPredicate === 'function') {
-      this.specificationExtensionPredicate = specificationExtensionPredicate;
-    }
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    const objectElement = path.node;
-    // @ts-ignore
-    objectElement.forEach((value: Element, key: Element, memberElement: MemberElement) => {
-      const keyValue = toValue(key) as string;
-      if (
-        this.canSupportSpecificationExtensions &&
-        this.specificationExtensionPredicate(memberElement)
-      ) {
-        const extensionElement = this.toRefractedElement(['document', 'extension'], memberElement);
-        (this.element.content as Element[]).push(extensionElement);
-      } else if (!this.ignoredFields.includes(keyValue) && this.fieldPatternPredicate(keyValue)) {
-        const specPath = this.specPath(value);
-        const patternedFieldElement = this.toRefractedElement(specPath, value);
-        const newMemberElement = new MemberElement(
-          this.consume ? key : cloneDeep(key),
-          patternedFieldElement,
-        );
-        this.copyMetaAndAttributes(memberElement, newMemberElement);
-        newMemberElement.classes.push('patterned-field');
-        (this.element.content as Element[]).push(newMemberElement);
-        // consume: release processed generic subtree
-        if (this.consume && this.consumeSafe && !memberElement.isFrozen)
-          memberElement.value = undefined;
-      } else if (!this.ignoredFields.includes(keyValue)) {
-        (this.element.content as Element[]).push(
-          this.consume ? memberElement : cloneDeep(memberElement),
-        );
-      }
-    });
-
-    this.copyMetaAndAttributes(objectElement, this.element);
-
-    path.stop();
-  }
-}
-
-export default PatternedFieldsVisitor;

package/src/refractor/visitors/open-api-2/BasePathVisitor.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 BasePathVisitorOptions };
-
-/**
- * @public
- */
-class BasePathVisitor extends FallbackVisitor {
-  declare public readonly element: StringElement;
-
-  StringElement(path: Path<StringElement>) {
-    super.enter(path);
-    this.element.classes.push('swagger-base-path');
-  }
-}
-
-export default BasePathVisitor;

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

@@ -1,29 +0,0 @@
-import { ArrayElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import SwaggerConsumesElement from '../../../elements/nces/SwaggerConsumes.ts';
-import FallbackVisitor, { FallbackVisitorOptions } from '../FallbackVisitor.ts';
-
-export type { FallbackVisitorOptions as ConsumesVisitorOptions };
-
-/**
- * @public
- */
-class ConsumesVisitor extends FallbackVisitor {
-  declare public element: SwaggerConsumesElement;
-
-  constructor(options: FallbackVisitorOptions) {
-    super(options);
-    this.element = new SwaggerConsumesElement();
-  }
-
-  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/HostVisitor.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 HostVisitorOptions };
-
-/**
- * @public
- */
-class HostVisitor extends FallbackVisitor {
-  declare public readonly element: StringElement;
-
-  StringElement(path: Path<StringElement>) {
-    super.enter(path);
-    this.element.classes.push('swagger-host');
-  }
-}
-
-export default HostVisitor;

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

@@ -1,29 +0,0 @@
-import { ArrayElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import SwaggerProducesElement from '../../../elements/nces/SwaggerProduces.ts';
-import FallbackVisitor, { FallbackVisitorOptions } from '../FallbackVisitor.ts';
-
-export type { FallbackVisitorOptions as ProducesVisitorOptions };
-
-/**
- * @public
- */
-class ProducesVisitor extends FallbackVisitor {
-  declare public element: SwaggerProducesElement;
-
-  constructor(options: FallbackVisitorOptions) {
-    super(options);
-    this.element = new SwaggerProducesElement();
-  }
-
-  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/SchemesVisitor.ts

@@ -1,29 +0,0 @@
-import { ArrayElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import SwaggerSchemesElement from '../../../elements/nces/SwaggerSchemes.ts';
-import FallbackVisitor, { FallbackVisitorOptions } from '../FallbackVisitor.ts';
-
-export type { FallbackVisitorOptions as SchemesVisitorOptions };
-
-/**
- * @public
- */
-class SchemesVisitor extends FallbackVisitor {
-  declare public element: SwaggerSchemesElement;
-
-  constructor(options: FallbackVisitorOptions) {
-    super(options);
-    this.element = new SwaggerSchemesElement();
-  }
-
-  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/SecurityVisitor.ts

@@ -1,34 +0,0 @@
-import { ArrayElement, Element } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import SwaggerSecurityElement from '../../../elements/nces/SwaggerSecurity.ts';
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from './bases.ts';
-
-export type { BaseSpecificationVisitorOptions as SecurityVisitorOptions };
-
-/**
- * @public
- */
-class SecurityVisitor extends BaseSpecificationVisitor {
-  declare public readonly element: SwaggerSecurityElement;
-
-  constructor(options: BaseSpecificationVisitorOptions) {
-    super(options);
-    this.element = new SwaggerSecurityElement();
-  }
-
-  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/SwaggerVisitor.ts

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

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

@@ -1,34 +0,0 @@
-import { ArrayElement, Element } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import SwaggerTagsElement from '../../../elements/nces/SwaggerTags.ts';
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from './bases.ts';
-
-export type { BaseSpecificationVisitorOptions as TagsVisitorOptions };
-
-/**
- * @public
- */
-class TagsVisitor extends BaseSpecificationVisitor {
-  declare public readonly element: SwaggerTagsElement;
-
-  constructor(options: BaseSpecificationVisitorOptions) {
-    super(options);
-    this.element = new SwaggerTagsElement();
-  }
-
-  ArrayElement(path: Path<ArrayElement>) {
-    const arrayElement = path.node;
-
-    arrayElement.forEach((item: Element): void => {
-      const specPath = ['document', 'objects', 'Tag'];
-      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-2/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 {}