swagger-client 3.27.9 → 3.28.1

package/es/index.js

@@ -12,7 +12,7 @@ import { makeApisTagOperation } from './interfaces.js';
 import { execute, buildRequest, baseUrl } from './execute/index.js';
 import { opId, isHttpUrl } from './helpers/index.js';
 import { isOpenAPI2, isOpenAPI3 } from './helpers/openapi-predicates.js';
-import HttpResolverSwaggerClient from './resolver/apidom/reference/resolve/resolvers/http-swagger-client/index.js';
+import HTTPResolverSwaggerClient from './resolver/apidom/reference/resolve/resolvers/http-swagger-client/index.js';
 import JsonParser from './resolver/apidom/reference/parse/parsers/json/index.js';
 import YamlParser from './resolver/apidom/reference/parse/parsers/yaml-1-2/index.js';
 import OpenApiJson3_1Parser from './resolver/apidom/reference/parse/parsers/openapi-json-3-1/index.js';
@@ -45,7 +45,7 @@ Swagger.getBaseUrl = baseUrl;
 Swagger.apidom = {
   resolve: {
     resolvers: {
-      HttpResolverSwaggerClient
+      HTTPResolverSwaggerClient
     }
   },
   parse: {

package/es/resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/index.js

@@ -1,137 +1,99 @@
 /* eslint-disable camelcase */
-import { createNamespace, visit, mergeAllVisitors, cloneDeep } from '@swagger-api/apidom-core';
+import { createNamespace, visit, cloneDeep } from '@swagger-api/apidom-core';
 import { ReferenceSet, Reference } from '@swagger-api/apidom-reference/configuration/empty';
-import OpenApi3_1DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/openapi-3-1';
+import OpenAPI3_1DereferenceStrategy from '@swagger-api/apidom-reference/dereference/strategies/openapi-3-1';
 import openApi3_1Namespace, { getNodeType, keyMap } from '@swagger-api/apidom-ns-openapi-3-1';
-import OpenApi3_1SwaggerClientDereferenceVisitor from './visitors/dereference.js';
-import ParameterMacroVisitor from './visitors/parameters.js';
-import ModelPropertyMacroVisitor from './visitors/properties.js';
-import AllOfVisitor from './visitors/all-of.js';
+import RootVisitor from './visitors/root.js';
 const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
-const mergeAllVisitorsAsync = mergeAllVisitors[Symbol.for('nodejs.util.promisify.custom')];
-const OpenApi3_1SwaggerClientDereferenceStrategy = OpenApi3_1DereferenceStrategy.compose({
-  props: {
-    allowMetaPatches: false,
-    parameterMacro: null,
-    modelPropertyMacro: null,
-    mode: 'non-strict',
-    ancestors: null
-  },
-  init({
-    allowMetaPatches = this.allowMetaPatches,
-    parameterMacro = this.parameterMacro,
-    modelPropertyMacro = this.modelPropertyMacro,
-    mode = this.mode,
-    ancestors = []
+class OpenAPI3_1SwaggerClientDereferenceStrategy extends OpenAPI3_1DereferenceStrategy {
+  allowMetaPatches;
+  parameterMacro;
+  modelPropertyMacro;
+  mode;
+  ancestors;
+  constructor({
+    allowMetaPatches = false,
+    parameterMacro = null,
+    modelPropertyMacro = null,
+    mode = 'non-strict',
+    ancestors = [],
+    ...rest
   } = {}) {
+    super({
+      ...rest
+    });
     this.name = 'openapi-3-1-swagger-client';
     this.allowMetaPatches = allowMetaPatches;
     this.parameterMacro = parameterMacro;
     this.modelPropertyMacro = modelPropertyMacro;
     this.mode = mode;
     this.ancestors = [...ancestors];
-  },
-  methods: {
-    async dereference(file, options) {
-      var _options$dereference$;
-      const visitors = [];
-      const namespace = createNamespace(openApi3_1Namespace);
-      const immutableRefSet = (_options$dereference$ = options.dereference.refSet) !== null && _options$dereference$ !== void 0 ? _options$dereference$ : ReferenceSet();
-      const mutableRefsSet = ReferenceSet();
-      let refSet = immutableRefSet;
-      let reference;
-      if (!immutableRefSet.has(file.uri)) {
-        reference = Reference({
-          uri: file.uri,
-          value: file.parseResult
-        });
-        immutableRefSet.add(reference);
-      } else {
-        // pre-computed refSet was provided as configuration option
-        reference = immutableRefSet.find(ref => ref.uri === file.uri);
-      }
-
-      /**
-       * Clone refSet due the dereferencing process being mutable.
-       * We don't want to mutate the original refSet and the references.
-       */
-      if (options.dereference.immutable) {
-        immutableRefSet.refs.map(ref => Reference({
-          ...ref,
-          value: cloneDeep(ref.value)
-        })).forEach(ref => mutableRefsSet.add(ref));
-        reference = mutableRefsSet.find(ref => ref.uri === file.uri);
-        refSet = mutableRefsSet;
-      }
-
-      // create main dereference visitor
-      const dereferenceVisitor = OpenApi3_1SwaggerClientDereferenceVisitor({
-        reference,
-        namespace,
-        options,
-        allowMetaPatches: this.allowMetaPatches,
-        ancestors: this.ancestors
+  }
+  async dereference(file, options) {
+    var _options$dereference$;
+    const namespace = createNamespace(openApi3_1Namespace);
+    const immutableRefSet = (_options$dereference$ = options.dereference.refSet) !== null && _options$dereference$ !== void 0 ? _options$dereference$ : new ReferenceSet();
+    const mutableRefsSet = new ReferenceSet();
+    let refSet = immutableRefSet;
+    let reference;
+    if (!immutableRefSet.has(file.uri)) {
+      reference = new Reference({
+        uri: file.uri,
+        value: file.parseResult
       });
-      visitors.push(dereferenceVisitor);
-
-      // create parameter macro visitor (if necessary)
-      if (typeof this.parameterMacro === 'function') {
-        const parameterMacroVisitor = ParameterMacroVisitor({
-          parameterMacro: this.parameterMacro,
-          options
-        });
-        visitors.push(parameterMacroVisitor);
-      }
-
-      // create model property macro visitor (if necessary)
-      if (typeof this.modelPropertyMacro === 'function') {
-        const modelPropertyMacroVisitor = ModelPropertyMacroVisitor({
-          modelPropertyMacro: this.modelPropertyMacro,
-          options
-        });
-        visitors.push(modelPropertyMacroVisitor);
-      }
-
-      // create allOf visitor (if necessary)
-      if (this.mode !== 'strict') {
-        const allOfVisitor = AllOfVisitor({
-          options
-        });
-        visitors.push(allOfVisitor);
-      }
+      immutableRefSet.add(reference);
+    } else {
+      // pre-computed refSet was provided as configuration option
+      reference = immutableRefSet.find(ref => ref.uri === file.uri);
+    }
 
-      // establish root visitor by visitor merging
-      const rootVisitor = mergeAllVisitorsAsync(visitors, {
-        nodeTypeGetter: getNodeType
-      });
-      const dereferencedElement = await visitAsync(refSet.rootRef.value, rootVisitor, {
-        keyMap,
-        nodeTypeGetter: getNodeType
-      });
+    /**
+     * Clone refSet due the dereferencing process being mutable.
+     * We don't want to mutate the original refSet and the references.
+     */
+    if (options.dereference.immutable) {
+      immutableRefSet.refs.map(ref => new Reference({
+        ...ref,
+        value: cloneDeep(ref.value)
+      })).forEach(ref => mutableRefsSet.add(ref));
+      reference = mutableRefsSet.find(ref => ref.uri === file.uri);
+      refSet = mutableRefsSet;
+    }
+    const rootVisitor = new RootVisitor({
+      reference,
+      namespace,
+      options,
+      allowMetaPatches: this.allowMetaPatches,
+      ancestors: this.ancestors,
+      modelPropertyMacro: this.modelPropertyMacro,
+      mode: this.mode,
+      parameterMacro: this.parameterMacro
+    });
+    const dereferencedElement = await visitAsync(refSet.rootRef.value, rootVisitor, {
+      keyMap,
+      nodeTypeGetter: getNodeType
+    });
 
-      /**
-       * If immutable option is set, replay refs from the refSet.
-       */
-      if (options.dereference.immutable) {
-        mutableRefsSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => Reference({
-          ...ref,
-          uri: ref.uri.replace(/^immutable:\/\//, '')
-        })).forEach(ref => immutableRefSet.add(ref));
-        reference = immutableRefSet.find(ref => ref.uri === file.uri);
-        refSet = immutableRefSet;
-      }
+    /**
+     * If immutable option is set, replay refs from the refSet.
+     */
+    if (options.dereference.immutable) {
+      mutableRefsSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => new Reference({
+        ...ref,
+        uri: ref.uri.replace(/^immutable:\/\//, '')
+      })).forEach(ref => immutableRefSet.add(ref));
+    }
 
-      /**
-       * Release all memory if this refSet was not provided as an configuration option.
-       * If provided as configuration option, then provider is responsible for cleanup.
-       */
-      if (options.dereference.refSet === null) {
-        immutableRefSet.clean();
-      }
-      mutableRefsSet.clean();
-      return dereferencedElement;
+    /**
+     * Release all memory if this refSet was not provided as an configuration option.
+     * If provided as configuration option, then provider is responsible for cleanup.
+     */
+    if (options.dereference.refSet === null) {
+      immutableRefSet.clean();
     }
+    mutableRefsSet.clean();
+    return dereferencedElement;
   }
-});
-export default OpenApi3_1SwaggerClientDereferenceStrategy;
+}
+export default OpenAPI3_1SwaggerClientDereferenceStrategy;
 /* eslint-enable camelcase */

package/es/resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/visitors/all-of.js

@@ -1,85 +1,82 @@
 import { isArrayElement, deepmerge } from '@swagger-api/apidom-core';
 import { isSchemaElement } from '@swagger-api/apidom-ns-openapi-3-1';
-import compose from '../utils/compose.js';
 import toPath from '../utils/to-path.js';
-const AllOfVisitor = compose({
-  init({
-    options
-  }) {
-    this.options = options;
-  },
-  props: {
-    options: null,
-    SchemaElement: {
-      leave(schemaElement, key, parent, path, ancestors) {
-        // do nothing
-        if (typeof schemaElement.allOf === 'undefined') return undefined;
+class AllOfVisitor {
+  options;
+  SchemaElement = {
+    leave(schemaElement, key, parent, path, ancestors) {
+      // do nothing
+      if (typeof schemaElement.allOf === 'undefined') return undefined;
 
-        // collect error and return if allOf keyword is not an array
-        if (!isArrayElement(schemaElement.allOf)) {
-          var _this$options$derefer, _this$options$derefer2;
-          const error = new TypeError('allOf must be an array');
-          error.fullPath = [...toPath([...ancestors, parent, schemaElement]), 'allOf'];
-          (_this$options$derefer = this.options.dereference.dereferenceOpts) === null || _this$options$derefer === void 0 || (_this$options$derefer = _this$options$derefer.errors) === null || _this$options$derefer === void 0 || (_this$options$derefer2 = _this$options$derefer.push) === null || _this$options$derefer2 === void 0 || _this$options$derefer2.call(_this$options$derefer, error);
-          return undefined;
-        }
+      // collect error and return if allOf keyword is not an array
+      if (!isArrayElement(schemaElement.allOf)) {
+        var _this$options$derefer, _this$options$derefer2;
+        const error = new TypeError('allOf must be an array');
+        error.fullPath = [...toPath([...ancestors, parent, schemaElement]), 'allOf'];
+        (_this$options$derefer = this.options.dereference.dereferenceOpts) === null || _this$options$derefer === void 0 || (_this$options$derefer = _this$options$derefer.errors) === null || _this$options$derefer === void 0 || (_this$options$derefer2 = _this$options$derefer.push) === null || _this$options$derefer2 === void 0 || _this$options$derefer2.call(_this$options$derefer, error);
+        return undefined;
+      }
 
-        // remove allOf keyword if empty
-        if (schemaElement.allOf.isEmpty) {
-          schemaElement.remove('allOf');
-          return undefined;
-        }
+      // remove allOf keyword if empty
+      if (schemaElement.allOf.isEmpty) {
+        schemaElement.remove('allOf');
+        return undefined;
+      }
 
-        // collect errors if allOf keyword contains anything else than Schema Object
-        const includesSchemaElementOnly = schemaElement.allOf.content.every(isSchemaElement);
-        if (!includesSchemaElementOnly) {
-          var _this$options$derefer3, _this$options$derefer4;
-          const error = new TypeError('Elements in allOf must be objects');
-          error.fullPath = [...toPath([...ancestors, parent, schemaElement]), 'allOf'];
-          (_this$options$derefer3 = this.options.dereference.dereferenceOpts) === null || _this$options$derefer3 === void 0 || (_this$options$derefer3 = _this$options$derefer3.errors) === null || _this$options$derefer3 === void 0 || (_this$options$derefer4 = _this$options$derefer3.push) === null || _this$options$derefer4 === void 0 || _this$options$derefer4.call(_this$options$derefer3, error);
-          return undefined;
-        }
-        while (schemaElement.hasKey('allOf')) {
-          const {
-            allOf
-          } = schemaElement;
-          schemaElement.remove('allOf');
-          const allOfMerged = deepmerge.all([...allOf.content, schemaElement]);
+      // collect errors if allOf keyword contains anything else than Schema Object
+      const includesSchemaElementOnly = schemaElement.allOf.content.every(isSchemaElement);
+      if (!includesSchemaElementOnly) {
+        var _this$options$derefer3, _this$options$derefer4;
+        const error = new TypeError('Elements in allOf must be objects');
+        error.fullPath = [...toPath([...ancestors, parent, schemaElement]), 'allOf'];
+        (_this$options$derefer3 = this.options.dereference.dereferenceOpts) === null || _this$options$derefer3 === void 0 || (_this$options$derefer3 = _this$options$derefer3.errors) === null || _this$options$derefer3 === void 0 || (_this$options$derefer4 = _this$options$derefer3.push) === null || _this$options$derefer4 === void 0 || _this$options$derefer4.call(_this$options$derefer3, error);
+        return undefined;
+      }
+      while (schemaElement.hasKey('allOf')) {
+        const {
+          allOf
+        } = schemaElement;
+        schemaElement.remove('allOf');
+        const allOfMerged = deepmerge.all([...allOf.content, schemaElement]);
 
-          /**
-           * If there was not an original $$ref value, make sure to remove
-           * any $$ref value that may exist from the result of `allOf` merges.
-           */
-          if (!schemaElement.hasKey('$$ref')) {
-            allOfMerged.remove('$$ref');
-          }
+        /**
+         * If there was not an original $$ref value, make sure to remove
+         * any $$ref value that may exist from the result of `allOf` merges.
+         */
+        if (!schemaElement.hasKey('$$ref')) {
+          allOfMerged.remove('$$ref');
+        }
 
-          /**
-           * If there was an example keyword in the original schema,
-           * keep it instead of merging with example from other schema.
-           */
-          if (schemaElement.hasKey('example')) {
-            const member = allOfMerged.getMember('example');
-            if (member) {
-              member.value = schemaElement.get('example');
-            }
+        /**
+         * If there was an example keyword in the original schema,
+         * keep it instead of merging with example from other schema.
+         */
+        if (schemaElement.hasKey('example')) {
+          const member = allOfMerged.getMember('example');
+          if (member) {
+            member.value = schemaElement.get('example');
           }
+        }
 
-          /**
-           * If there was an examples keyword in the original schema,
-           * keep it instead of merging with examples from other schema.
-           */
-          if (schemaElement.hasKey('examples')) {
-            const member = allOfMerged.getMember('examples');
-            if (member) {
-              member.value = schemaElement.get('examples');
-            }
+        /**
+         * If there was an examples keyword in the original schema,
+         * keep it instead of merging with examples from other schema.
+         */
+        if (schemaElement.hasKey('examples')) {
+          const member = allOfMerged.getMember('examples');
+          if (member) {
+            member.value = schemaElement.get('examples');
           }
-          schemaElement.content = allOfMerged.content;
         }
-        return undefined;
+        schemaElement.content = allOfMerged.content;
       }
+      return undefined;
     }
+  };
+  constructor({
+    options
+  }) {
+    this.options = options;
   }
-});
+}
 export default AllOfVisitor;