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

package/src/refractor/visitors/SpecificationVisitor.ts

@@ -1,112 +0,0 @@
-import { pathSatisfies, path, pick } from 'ramda';
-import { isFunction } from 'ramda-adjunct';
-import { ObjectElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { traverse, getNodePrimitiveType } from '@speclynx/apidom-traverse';
-
-import OpenApi3_0Element from '../../elements/OpenApi3-0.ts';
-import Visitor, { VisitorOptions } from './Visitor.ts';
-import type specification from '../specification.ts';
-import FallbackVisitor from './FallbackVisitor.ts';
-
-/**
- * This is a base Type for every visitor that does
- * internal look-ups to retrieve other child visitors.
- * @public
- */
-export interface SpecificationVisitorOptions extends VisitorOptions {
-  readonly specObj: typeof specification;
-  readonly passingOptionsNames?: string[];
-  readonly openApiGenericElement?: ObjectElement;
-  readonly sourceContext?: Record<string, unknown>;
-  readonly openApiSemanticElement?: OpenApi3_0Element;
-}
-
-/**
- * @public
- */
-class SpecificationVisitor extends Visitor {
-  protected readonly specObj: typeof specification;
-
-  protected readonly passingOptionsNames: string[] = [
-    'specObj',
-    'openApiGenericElement',
-    'sourceContext',
-    'openApiSemanticElement',
-    'consume',
-  ];
-
-  protected openApiGenericElement?: ObjectElement;
-
-  protected sourceContext?: Record<string, unknown>;
-
-  protected openApiSemanticElement?: OpenApi3_0Element;
-
-  constructor({
-    specObj,
-    passingOptionsNames,
-    openApiGenericElement,
-    openApiSemanticElement,
-    ...rest
-  }: SpecificationVisitorOptions) {
-    super({ ...rest });
-    this.specObj = specObj;
-    this.openApiGenericElement = openApiGenericElement;
-    this.openApiSemanticElement = openApiSemanticElement;
-
-    if (Array.isArray(passingOptionsNames)) {
-      this.passingOptionsNames = passingOptionsNames;
-    }
-  }
-
-  retrievePassingOptions() {
-    return pick(this.passingOptionsNames as (keyof this)[], this) as unknown as Record<
-      string,
-      unknown
-    >;
-  }
-
-  retrieveFixedFields(specPath: string[]) {
-    const fixedFields = path(['visitors', ...specPath, 'fixedFields'], this.specObj);
-    if (typeof fixedFields === 'object' && fixedFields !== null) {
-      return Object.keys(fixedFields);
-    }
-    return [];
-  }
-
-  retrieveVisitor(specPath: string[]) {
-    if (pathSatisfies(isFunction, ['visitors', ...specPath], this.specObj)) {
-      return path(['visitors', ...specPath], this.specObj);
-    }
-
-    return path(['visitors', ...specPath, '$visitor'], this.specObj);
-  }
-
-  retrieveVisitorInstance(specPath: string[], options = {}): Visitor {
-    const passingOpts = this.retrievePassingOptions();
-    const VisitorClz = this.retrieveVisitor(specPath) as typeof Visitor;
-    const visitorOpts = { ...passingOpts, ...options };
-
-    return new VisitorClz(visitorOpts);
-  }
-
-  toRefractedElement(specPath: string[], element: any, options = {}) {
-    /**
-     * This is `Visitor shortcut`: a mechanism for short-circuiting the traversal and replacing
-     * it by basic node cloning.
-     *
-     * Visiting the element is equivalent to cloning it if the prototype of a visitor
-     * is the same as the prototype of FallbackVisitor. If that's the case, we can avoid
-     * bootstrapping the traversal cycle for fields that don't require any special visiting.
-     */
-    const visitor = this.retrieveVisitorInstance(specPath, options);
-
-    if (visitor instanceof FallbackVisitor && visitor?.constructor === FallbackVisitor) {
-      return this.consume ? element : cloneDeep(element);
-    }
-
-    traverse(element, visitor, { nodeTypeGetter: getNodePrimitiveType });
-    return visitor.element;
-  }
-}
-
-export default SpecificationVisitor;

package/src/refractor/visitors/Visitor.ts

@@ -1,47 +0,0 @@
-import { deepmerge } from '@speclynx/apidom-core';
-import {
-  Element,
-  ObjectElement,
-  SourceMapElement,
-  StyleElement,
-  cloneDeep,
-} from '@speclynx/apidom-datamodel';
-
-/**
- * @public
- */
-export interface VisitorOptions {
-  readonly consume?: boolean;
-}
-
-/**
- * @public
- */
-class Visitor {
-  public element!: Element;
-
-  protected readonly consume: boolean = false;
-
-  protected consumeSafe: boolean = false;
-
-  constructor(options: VisitorOptions = {}) {
-    Object.assign(this, options);
-  }
-
-  public copyMetaAndAttributes(from: Element, to: Element) {
-    if (!from.isMetaEmpty && !to.isMetaEmpty) {
-      to.meta = to.meta.merge(from.meta);
-    } else if (!from.isMetaEmpty) {
-      to.meta = from.meta.cloneDeep();
-    }
-    if (!from.isAttributesEmpty && !to.isAttributesEmpty) {
-      to.attributes = deepmerge(to.attributes, from.attributes) as ObjectElement;
-    } else if (!from.isAttributesEmpty) {
-      to.attributes = cloneDeep(from.attributes);
-    }
-    SourceMapElement.transfer(from, to);
-    StyleElement.transfer(from, to);
-  }
-}
-
-export default Visitor;

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,110 +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 { isOpenApiExtension } 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 isOpenApiExtension;
-}
-
-/**
- * @public
- */
-class FixedFieldsVisitor extends SpecificationVisitor {
-  protected specPath: SpecPath;
-
-  protected ignoredFields: string[];
-
-  protected canSupportSpecificationExtensions: boolean = true;
-
-  protected specificationExtensionPredicate = isOpenApiExtension;
-
-  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 { isOpenApiExtension } 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 isOpenApiExtension;
-}
-
-/**
- * @public
- */
-class PatternedFieldsVisitor extends SpecificationVisitor {
-  protected specPath: SpecPath;
-
-  protected ignoredFields: string[];
-
-  protected fieldPatternPredicate: (value: unknown) => boolean = stubFalse;
-
-  protected canSupportSpecificationExtensions: boolean = false;
-
-  protected specificationExtensionPredicate = isOpenApiExtension;
-
-  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-3-0/ContentVisitor.ts

@@ -1,28 +0,0 @@
-import { always } from 'ramda';
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-
-import { SpecPath } from '../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from './bases.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as ContentVisitorOptions };
-
-/**
- * @public
- */
-class ContentVisitor extends BaseMapVisitor {
-  declare public readonly element: ObjectElement;
-
-  declare protected readonly specPath: SpecPath<['document', 'objects', 'MediaType']>;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ObjectElement();
-    this.element.classes.push('content');
-    this.specPath = always(['document', 'objects', 'MediaType']);
-  }
-}
-
-export default ContentVisitor;

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

@@ -1,48 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import { SpecPath } from '../generics/MapVisitor.ts';
-import { BaseMapVisitor, BaseMapVisitorOptions } from './bases.ts';
-import { isReferenceLikeElement } from '../../predicates.ts';
-import { isReferenceElement } from '../../../predicates.ts';
-import ReferenceElement from '../../../elements/Reference.ts';
-
-/**
- * @public
- */
-export type { BaseMapVisitorOptions as ExamplesVisitorOptions };
-
-/**
- * @public
- */
-class ExamplesVisitor extends BaseMapVisitor {
-  declare public readonly element: ObjectElement;
-
-  declare protected readonly specPath: SpecPath<
-    ['document', 'objects', 'Reference'] | ['document', 'objects', 'Example']
-  >;
-
-  declare protected readonly canSupportSpecificationExtensions: true;
-
-  constructor(options: BaseMapVisitorOptions) {
-    super(options);
-    this.element = new ObjectElement();
-    this.element.classes.push('examples');
-    this.specPath = (element: unknown) =>
-      isReferenceLikeElement(element)
-        ? ['document', 'objects', 'Reference']
-        : ['document', 'objects', 'Example'];
-    this.canSupportSpecificationExtensions = true;
-  }
-
-  ObjectElement(path: Path<ObjectElement>) {
-    BaseMapVisitor.prototype.ObjectElement.call(this, path);
-
-    // @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/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-0/ParametersVisitor.ts

@@ -1,47 +0,0 @@
-import { ArrayElement, Element } from '@speclynx/apidom-datamodel';
-import { Path } from '@speclynx/apidom-traverse';
-
-import { BaseSpecificationVisitor, BaseSpecificationVisitorOptions } from './bases.ts';
-import { isReferenceLikeElement } from '../../predicates.ts';
-import { isReferenceElement } from '../../../predicates.ts';
-
-/**
- * @public
- */
-export type { BaseSpecificationVisitorOptions as ParametersVisitorOptions };
-
-/**
- * @public
- */
-class ParametersVisitor extends BaseSpecificationVisitor {
-  declare public readonly element: ArrayElement;
-
-  constructor(options: BaseSpecificationVisitorOptions) {
-    super(options);
-    this.element = new ArrayElement();
-    this.element.classes.push('parameters');
-  }
-
-  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;