@speclynx/apidom-ns-openapi-3-0 1.12.1

package/src/refractor/toolbox.mjs

@@ -0,0 +1,30 @@
+import { isElement, isStringElement, isArrayElement, isObjectElement, isMemberElement, createNamespace, includesClasses, hasElementSourceMap } from '@speclynx/apidom-core';
+import * as openApi3_0Predicates from "../predicates.mjs";
+import openApi3_0Namespace from "../namespace.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+const createToolbox = () => {
+  const namespace = createNamespace(openApi3_0Namespace);
+  const predicates = {
+    ...openApi3_0Predicates,
+    isElement,
+    isStringElement,
+    isArrayElement,
+    isObjectElement,
+    isMemberElement,
+    includesClasses,
+    hasElementSourceMap
+  };
+  return {
+    predicates,
+    namespace
+  };
+};
+export default createToolbox;

package/src/refractor/visitors/FallbackVisitor.cjs

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _Visitor = _interopRequireDefault(require("./Visitor.cjs"));
+/**
+ * This visitor is responsible for falling back to current traversed element
+ * Given OpenApi3_0Visitor expects ObjectElement to be traversed. If
+ * different Element is provided FallBackVisitor is responsible to assigning
+ * this Element as current element.
+ */
+
+/**
+ * @public
+ */
+class FallbackVisitor extends _Visitor.default {
+  enter(element) {
+    this.element = (0, _apidomCore.cloneDeep)(element);
+    return _apidomCore.BREAK;
+  }
+}
+var _default = exports.default = FallbackVisitor;

package/src/refractor/visitors/FallbackVisitor.mjs

@@ -0,0 +1,18 @@
+import { BREAK, cloneDeep } from '@speclynx/apidom-core';
+import Visitor from "./Visitor.mjs";
+/**
+ * This visitor is responsible for falling back to current traversed element
+ * Given OpenApi3_0Visitor expects ObjectElement to be traversed. If
+ * different Element is provided FallBackVisitor is responsible to assigning
+ * this Element as current element.
+ */
+/**
+ * @public
+ */
+class FallbackVisitor extends Visitor {
+  enter(element) {
+    this.element = cloneDeep(element);
+    return BREAK;
+  }
+}
+export default FallbackVisitor;

package/src/refractor/visitors/SpecificationExtensionVisitor.cjs

@@ -0,0 +1,18 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _SpecificationVisitor = _interopRequireDefault(require("./SpecificationVisitor.cjs"));
+/**
+ * @public
+ */
+class SpecificationExtensionVisitor extends _SpecificationVisitor.default {
+  MemberElement(memberElement) {
+    this.element = (0, _apidomCore.cloneDeep)(memberElement);
+    this.element.classes.push('specification-extension');
+    return _apidomCore.BREAK;
+  }
+}
+var _default = exports.default = SpecificationExtensionVisitor;

package/src/refractor/visitors/SpecificationExtensionVisitor.mjs

@@ -0,0 +1,13 @@
+import { BREAK, cloneDeep } from '@speclynx/apidom-core';
+import SpecificationVisitor from "./SpecificationVisitor.mjs";
+/**
+ * @public
+ */
+class SpecificationExtensionVisitor extends SpecificationVisitor {
+  MemberElement(memberElement) {
+    this.element = cloneDeep(memberElement);
+    this.element.classes.push('specification-extension');
+    return BREAK;
+  }
+}
+export default SpecificationExtensionVisitor;

package/src/refractor/visitors/SpecificationVisitor.cjs

@@ -0,0 +1,84 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _ramdaAdjunct = require("ramda-adjunct");
+var _apidomCore = require("@speclynx/apidom-core");
+var _Visitor = _interopRequireDefault(require("./Visitor.cjs"));
+var _FallbackVisitor = _interopRequireDefault(require("./FallbackVisitor.cjs"));
+/**
+ * This is a base Type for every visitor that does
+ * internal look-ups to retrieve other child visitors.
+ * @public
+ */
+
+/**
+ * @public
+ */
+class SpecificationVisitor extends _Visitor.default {
+  specObj;
+  passingOptionsNames = ['specObj', 'openApiGenericElement', 'openApiSemanticElement'];
+  openApiGenericElement;
+  openApiSemanticElement;
+  constructor({
+    specObj,
+    passingOptionsNames,
+    openApiGenericElement,
+    openApiSemanticElement,
+    ...rest
+  }) {
+    super({
+      ...rest
+    });
+    this.specObj = specObj;
+    this.openApiGenericElement = openApiGenericElement;
+    this.openApiSemanticElement = openApiSemanticElement;
+    if (Array.isArray(passingOptionsNames)) {
+      this.passingOptionsNames = passingOptionsNames;
+    }
+  }
+  retrievePassingOptions() {
+    return (0, _ramda.pick)(this.passingOptionsNames, this);
+  }
+  retrieveFixedFields(specPath) {
+    const fixedFields = (0, _ramda.path)(['visitors', ...specPath, 'fixedFields'], this.specObj);
+    if (typeof fixedFields === 'object' && fixedFields !== null) {
+      return Object.keys(fixedFields);
+    }
+    return [];
+  }
+  retrieveVisitor(specPath) {
+    if ((0, _ramda.pathSatisfies)(_ramdaAdjunct.isFunction, ['visitors', ...specPath], this.specObj)) {
+      return (0, _ramda.path)(['visitors', ...specPath], this.specObj);
+    }
+    return (0, _ramda.path)(['visitors', ...specPath, '$visitor'], this.specObj);
+  }
+  retrieveVisitorInstance(specPath, options = {}) {
+    const passingOpts = this.retrievePassingOptions();
+    const VisitorClz = this.retrieveVisitor(specPath);
+    const visitorOpts = {
+      ...passingOpts,
+      ...options
+    };
+    return new VisitorClz(visitorOpts);
+  }
+  toRefractedElement(specPath, element, 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.default && visitor?.constructor === _FallbackVisitor.default) {
+      return (0, _apidomCore.cloneDeep)(element);
+    }
+    (0, _apidomCore.visit)(element, visitor, options);
+    return visitor.element;
+  }
+}
+var _default = exports.default = SpecificationVisitor;

package/src/refractor/visitors/SpecificationVisitor.mjs

@@ -0,0 +1,78 @@
+import { pathSatisfies, path, pick } from 'ramda';
+import { isFunction } from 'ramda-adjunct';
+import { visit, cloneDeep } from '@speclynx/apidom-core';
+import Visitor from "./Visitor.mjs";
+import FallbackVisitor from "./FallbackVisitor.mjs";
+/**
+ * This is a base Type for every visitor that does
+ * internal look-ups to retrieve other child visitors.
+ * @public
+ */
+/**
+ * @public
+ */
+class SpecificationVisitor extends Visitor {
+  specObj;
+  passingOptionsNames = ['specObj', 'openApiGenericElement', 'openApiSemanticElement'];
+  openApiGenericElement;
+  openApiSemanticElement;
+  constructor({
+    specObj,
+    passingOptionsNames,
+    openApiGenericElement,
+    openApiSemanticElement,
+    ...rest
+  }) {
+    super({
+      ...rest
+    });
+    this.specObj = specObj;
+    this.openApiGenericElement = openApiGenericElement;
+    this.openApiSemanticElement = openApiSemanticElement;
+    if (Array.isArray(passingOptionsNames)) {
+      this.passingOptionsNames = passingOptionsNames;
+    }
+  }
+  retrievePassingOptions() {
+    return pick(this.passingOptionsNames, this);
+  }
+  retrieveFixedFields(specPath) {
+    const fixedFields = path(['visitors', ...specPath, 'fixedFields'], this.specObj);
+    if (typeof fixedFields === 'object' && fixedFields !== null) {
+      return Object.keys(fixedFields);
+    }
+    return [];
+  }
+  retrieveVisitor(specPath) {
+    if (pathSatisfies(isFunction, ['visitors', ...specPath], this.specObj)) {
+      return path(['visitors', ...specPath], this.specObj);
+    }
+    return path(['visitors', ...specPath, '$visitor'], this.specObj);
+  }
+  retrieveVisitorInstance(specPath, options = {}) {
+    const passingOpts = this.retrievePassingOptions();
+    const VisitorClz = this.retrieveVisitor(specPath);
+    const visitorOpts = {
+      ...passingOpts,
+      ...options
+    };
+    return new VisitorClz(visitorOpts);
+  }
+  toRefractedElement(specPath, element, 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 cloneDeep(element);
+    }
+    visit(element, visitor, options);
+    return visitor.element;
+  }
+}
+export default SpecificationVisitor;

package/src/refractor/visitors/Visitor.cjs

@@ -0,0 +1,31 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class Visitor {
+  element;
+  constructor(options = {}) {
+    Object.assign(this, options);
+  }
+  copyMetaAndAttributes(from, to) {
+    if (from.meta.length > 0 || to.meta.length > 0) {
+      to.meta = (0, _apidomCore.deepmerge)(to.meta, from.meta);
+      if ((0, _apidomCore.hasElementSourceMap)(from)) {
+        // avoid deep merging of source maps
+        to.meta.set('sourceMap', from.meta.get('sourceMap'));
+      }
+    }
+    if (from.attributes.length > 0 || from.meta.length > 0) {
+      to.attributes = (0, _apidomCore.deepmerge)(to.attributes, from.attributes);
+    }
+  }
+}
+var _default = exports.default = Visitor;

package/src/refractor/visitors/Visitor.mjs

@@ -0,0 +1,28 @@
+import { deepmerge, hasElementSourceMap } from '@speclynx/apidom-core';
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class Visitor {
+  element;
+  constructor(options = {}) {
+    Object.assign(this, options);
+  }
+  copyMetaAndAttributes(from, to) {
+    if (from.meta.length > 0 || to.meta.length > 0) {
+      to.meta = deepmerge(to.meta, from.meta);
+      if (hasElementSourceMap(from)) {
+        // avoid deep merging of source maps
+        to.meta.set('sourceMap', from.meta.get('sourceMap'));
+      }
+    }
+    if (from.attributes.length > 0 || from.meta.length > 0) {
+      to.attributes = deepmerge(to.attributes, from.attributes);
+    }
+  }
+}
+export default Visitor;

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

@@ -0,0 +1,42 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _ramdaAdjunct = require("ramda-adjunct");
+var _apidomCore = require("@speclynx/apidom-core");
+var _SpecificationVisitor = _interopRequireDefault(require("../SpecificationVisitor.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class AlternatingVisitor extends _SpecificationVisitor.default {
+  alternator;
+  constructor({
+    alternator,
+    ...rest
+  }) {
+    super({
+      ...rest
+    });
+    this.alternator = alternator || [];
+  }
+  enter(element) {
+    const functions = this.alternator.map(({
+      predicate,
+      specPath
+    }) => (0, _ramda.ifElse)(predicate, (0, _ramda.always)(specPath), _ramdaAdjunct.stubUndefined));
+    const specPath = (0, _ramdaAdjunct.dispatch)(functions)(element);
+    this.element = this.toRefractedElement(specPath, element);
+    return _apidomCore.BREAK;
+  }
+}
+var _default = exports.default = AlternatingVisitor;

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

@@ -0,0 +1,35 @@
+import { ifElse, always } from 'ramda';
+import { dispatch, stubUndefined } from 'ramda-adjunct';
+import { BREAK } from '@speclynx/apidom-core';
+import SpecificationVisitor from "../SpecificationVisitor.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class AlternatingVisitor extends SpecificationVisitor {
+  alternator;
+  constructor({
+    alternator,
+    ...rest
+  }) {
+    super({
+      ...rest
+    });
+    this.alternator = alternator || [];
+  }
+  enter(element) {
+    const functions = this.alternator.map(({
+      predicate,
+      specPath
+    }) => ifElse(predicate, always(specPath), stubUndefined));
+    const specPath = dispatch(functions)(element);
+    this.element = this.toRefractedElement(specPath, element);
+    return BREAK;
+  }
+}
+export default AlternatingVisitor;

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

@@ -0,0 +1,67 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _SpecificationVisitor = _interopRequireDefault(require("../SpecificationVisitor.cjs"));
+var _predicates = require("../../predicates.cjs");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class FixedFieldsVisitor extends _SpecificationVisitor.default {
+  specPath;
+  ignoredFields;
+  canSupportSpecificationExtensions = true;
+  specificationExtensionPredicate = _predicates.isOpenApiExtension;
+  constructor({
+    specPath,
+    ignoredFields,
+    canSupportSpecificationExtensions,
+    specificationExtensionPredicate,
+    ...rest
+  }) {
+    super({
+      ...rest
+    });
+    this.specPath = specPath;
+    this.ignoredFields = ignoredFields || [];
+    if (typeof canSupportSpecificationExtensions === 'boolean') {
+      this.canSupportSpecificationExtensions = canSupportSpecificationExtensions;
+    }
+    if (typeof specificationExtensionPredicate === 'function') {
+      this.specificationExtensionPredicate = specificationExtensionPredicate;
+    }
+  }
+  ObjectElement(objectElement) {
+    const specPath = this.specPath(objectElement);
+    const fields = this.retrieveFixedFields(specPath);
+
+    // @ts-ignore
+    objectElement.forEach((value, key, memberElement) => {
+      if ((0, _apidomCore.isStringElement)(key) && fields.includes((0, _apidomCore.toValue)(key)) && !this.ignoredFields.includes((0, _apidomCore.toValue)(key))) {
+        const fixedFieldElement = this.toRefractedElement([...specPath, 'fixedFields', (0, _apidomCore.toValue)(key)], value);
+        const newMemberElement = new _apidomCore.MemberElement((0, _apidomCore.cloneDeep)(key), fixedFieldElement);
+        this.copyMetaAndAttributes(memberElement, newMemberElement);
+        newMemberElement.classes.push('fixed-field');
+        this.element.content.push(newMemberElement);
+      } else if (this.canSupportSpecificationExtensions && this.specificationExtensionPredicate(memberElement)) {
+        const extensionElement = this.toRefractedElement(['document', 'extension'], memberElement);
+        this.element.content.push(extensionElement);
+      } else if (!this.ignoredFields.includes((0, _apidomCore.toValue)(key))) {
+        this.element.content.push((0, _apidomCore.cloneDeep)(memberElement));
+      }
+    });
+    this.copyMetaAndAttributes(objectElement, this.element);
+    return _apidomCore.BREAK;
+  }
+}
+var _default = exports.default = FixedFieldsVisitor;

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

@@ -0,0 +1,60 @@
+import { isStringElement, MemberElement, BREAK, cloneDeep, toValue } from '@speclynx/apidom-core';
+import SpecificationVisitor from "../SpecificationVisitor.mjs";
+import { isOpenApiExtension } from "../../predicates.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class FixedFieldsVisitor extends SpecificationVisitor {
+  specPath;
+  ignoredFields;
+  canSupportSpecificationExtensions = true;
+  specificationExtensionPredicate = isOpenApiExtension;
+  constructor({
+    specPath,
+    ignoredFields,
+    canSupportSpecificationExtensions,
+    specificationExtensionPredicate,
+    ...rest
+  }) {
+    super({
+      ...rest
+    });
+    this.specPath = specPath;
+    this.ignoredFields = ignoredFields || [];
+    if (typeof canSupportSpecificationExtensions === 'boolean') {
+      this.canSupportSpecificationExtensions = canSupportSpecificationExtensions;
+    }
+    if (typeof specificationExtensionPredicate === 'function') {
+      this.specificationExtensionPredicate = specificationExtensionPredicate;
+    }
+  }
+  ObjectElement(objectElement) {
+    const specPath = this.specPath(objectElement);
+    const fields = this.retrieveFixedFields(specPath);
+
+    // @ts-ignore
+    objectElement.forEach((value, key, memberElement) => {
+      if (isStringElement(key) && fields.includes(toValue(key)) && !this.ignoredFields.includes(toValue(key))) {
+        const fixedFieldElement = this.toRefractedElement([...specPath, 'fixedFields', toValue(key)], value);
+        const newMemberElement = new MemberElement(cloneDeep(key), fixedFieldElement);
+        this.copyMetaAndAttributes(memberElement, newMemberElement);
+        newMemberElement.classes.push('fixed-field');
+        this.element.content.push(newMemberElement);
+      } else if (this.canSupportSpecificationExtensions && this.specificationExtensionPredicate(memberElement)) {
+        const extensionElement = this.toRefractedElement(['document', 'extension'], memberElement);
+        this.element.content.push(extensionElement);
+      } else if (!this.ignoredFields.includes(toValue(key))) {
+        this.element.content.push(cloneDeep(memberElement));
+      }
+    });
+    this.copyMetaAndAttributes(objectElement, this.element);
+    return BREAK;
+  }
+}
+export default FixedFieldsVisitor;

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

@@ -0,0 +1,21 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramdaAdjunct = require("ramda-adjunct");
+var _PatternedFieldsVisitor = _interopRequireDefault(require("./PatternedFieldsVisitor.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class MapVisitor extends _PatternedFieldsVisitor.default {
+  constructor(options) {
+    super(options);
+    this.fieldPatternPredicate = _ramdaAdjunct.isNonEmptyString;
+  }
+}
+var _default = exports.default = MapVisitor;

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

@@ -0,0 +1,15 @@
+import { isNonEmptyString } from 'ramda-adjunct';
+import PatternedFieldsVisitor from "./PatternedFieldsVisitor.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class MapVisitor extends PatternedFieldsVisitor {
+  constructor(options) {
+    super(options);
+    this.fieldPatternPredicate = isNonEmptyString;
+  }
+}
+export default MapVisitor;

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

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _tsMixer = require("ts-mixer");
+var _ramda = require("ramda");
+var _apidomCore = require("@speclynx/apidom-core");
+var _FixedFieldsVisitor = _interopRequireDefault(require("./FixedFieldsVisitor.cjs"));
+var _PatternedFieldsVisitor = _interopRequireDefault(require("./PatternedFieldsVisitor.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class MixedFieldsVisitor extends (0, _tsMixer.Mixin)(_FixedFieldsVisitor.default, _PatternedFieldsVisitor.default) {
+  specPathFixedFields;
+  specPathPatternedFields;
+  constructor({
+    specPathFixedFields,
+    specPathPatternedFields,
+    ...rest
+  }) {
+    super({
+      ...rest
+    });
+    this.specPathFixedFields = specPathFixedFields;
+    this.specPathPatternedFields = specPathPatternedFields;
+  }
+  ObjectElement(objectElement) {
+    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, ...(0, _ramda.difference)(objectElement.keys(), fixedFields)];
+      _FixedFieldsVisitor.default.prototype.ObjectElement.call(this, objectElement);
+      this.specPath = this.specPathPatternedFields;
+      this.ignoredFields = fixedFields;
+      _PatternedFieldsVisitor.default.prototype.ObjectElement.call(this, objectElement);
+
+      // reorder this.element members by original objectElement keys
+      const objectElementKeys = objectElement.keys();
+      this.element.content.sort((a, b) => {
+        return objectElementKeys.indexOf((0, _apidomCore.toValue)(a.key)) - objectElementKeys.indexOf((0, _apidomCore.toValue)(b.key));
+      });
+    } catch (e) {
+      this.specPath = specPath;
+      throw e;
+    }
+    return _apidomCore.BREAK;
+  }
+}
+var _default = exports.default = MixedFieldsVisitor;