swagger-client 3.27.9 → 3.28.1

package/es/resolver/apidom/reference/resolve/resolvers/http-swagger-client/index.js

@@ -1,67 +1,69 @@
-import { ResolverError, HttpResolver } from '@swagger-api/apidom-reference/configuration/empty';
+import { ResolverError, HTTPResolver } from '@swagger-api/apidom-reference/configuration/empty';
 import '../../../../../../helpers/fetch-polyfill.node.js';
 import '../../../../../../helpers/abortcontroller-polyfill.node.js';
 import Http from '../../../../../../http/index.js';
-const HttpResolverSwaggerClient = HttpResolver.compose({
-  props: {
-    name: 'http-swagger-client',
-    swaggerHTTPClient: Http,
-    swaggerHTTPClientConfig: {}
-  },
-  init({
-    swaggerHTTPClient = this.swaggerHTTPClient
+class HTTPResolverSwaggerClient extends HTTPResolver {
+  swaggerHTTPClient = Http;
+  swaggerHTTPClientConfig;
+  constructor({
+    swaggerHTTPClient = Http,
+    swaggerHTTPClientConfig = {},
+    ...rest
   } = {}) {
+    super({
+      ...rest,
+      name: 'http-swagger-client'
+    });
     this.swaggerHTTPClient = swaggerHTTPClient;
-  },
-  methods: {
-    getHttpClient() {
-      return this.swaggerHTTPClient;
-    },
-    async read(file) {
-      const client = this.getHttpClient();
-      const controller = new AbortController();
-      const {
-        signal
-      } = controller;
-      const timeoutID = setTimeout(() => {
-        controller.abort();
-      }, this.timeout);
-      const credentials = this.getHttpClient().withCredentials || this.withCredentials ? 'include' : 'same-origin';
-      const redirect = this.redirects === 0 ? 'error' : 'follow';
-      const follow = this.redirects > 0 ? this.redirects : undefined;
-      try {
-        const response = await client({
-          url: file.uri,
-          signal,
-          userFetch: async (resource, options) => {
-            let res = await fetch(resource, options);
-            try {
-              // undici supports mutations
-              res.headers.delete('Content-Type');
-            } catch {
-              // Fetch API has guards which prevent mutations
-              res = new Response(res.body, {
-                ...res,
-                headers: new Headers(res.headers)
-              });
-              res.headers.delete('Content-Type');
-            }
-            return res;
-          },
-          credentials,
-          redirect,
-          follow,
-          ...this.swaggerHTTPClientConfig
-        });
-        return response.text.arrayBuffer();
-      } catch (error) {
-        throw new ResolverError(`Error downloading "${file.uri}"`, {
-          cause: error
-        });
-      } finally {
-        clearTimeout(timeoutID);
-      }
+    this.swaggerHTTPClientConfig = swaggerHTTPClientConfig;
+  }
+  getHttpClient() {
+    return this.swaggerHTTPClient;
+  }
+  async read(file) {
+    const client = this.getHttpClient();
+    const controller = new AbortController();
+    const {
+      signal
+    } = controller;
+    const timeoutID = setTimeout(() => {
+      controller.abort();
+    }, this.timeout);
+    const credentials = this.getHttpClient().withCredentials || this.withCredentials ? 'include' : 'same-origin';
+    const redirect = this.redirects === 0 ? 'error' : 'follow';
+    const follow = this.redirects > 0 ? this.redirects : undefined;
+    try {
+      const response = await client({
+        url: file.uri,
+        signal,
+        userFetch: async (resource, options) => {
+          let res = await fetch(resource, options);
+          try {
+            // undici supports mutations
+            res.headers.delete('Content-Type');
+          } catch {
+            // Fetch API has guards which prevent mutations
+            res = new Response(res.body, {
+              ...res,
+              headers: new Headers(res.headers)
+            });
+            res.headers.delete('Content-Type');
+          }
+          return res;
+        },
+        credentials,
+        redirect,
+        follow,
+        ...this.swaggerHTTPClientConfig
+      });
+      return response.text.arrayBuffer();
+    } catch (error) {
+      throw new ResolverError(`Error downloading "${file.uri}"`, {
+        cause: error
+      });
+    } finally {
+      clearTimeout(timeoutID);
     }
   }
-});
-export default HttpResolverSwaggerClient;
+}
+export default HTTPResolverSwaggerClient;

package/es/resolver/strategies/openapi-3-1-apidom/resolve.js

@@ -4,16 +4,16 @@ import { compile as jsonPointerCompile, evaluate as jsonPointerEvaluate, Evaluat
 import { mediaTypes, OpenApi3_1Element } from '@swagger-api/apidom-ns-openapi-3-1';
 import { dereferenceApiDOM, url, ReferenceSet, Reference, options as referenceOptions } from '@swagger-api/apidom-reference/configuration/empty';
 import BinaryParser from '@swagger-api/apidom-reference/parse/parsers/binary';
-import OpenApi3_1ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/openapi-3-1';
+import OpenAPI3_1ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/openapi-3-1';
 import { DEFAULT_BASE_URL } from '../../../constants.js';
 import * as optionsUtil from '../../utils/options.js';
 import normalize from './normalize.js';
-import HttpResolverSwaggerClient from '../../apidom/reference/resolve/resolvers/http-swagger-client/index.js';
-import JsonParser from '../../apidom/reference/parse/parsers/json/index.js';
-import YamlParser from '../../apidom/reference/parse/parsers/yaml-1-2/index.js';
-import OpenApiJson3_1Parser from '../../apidom/reference/parse/parsers/openapi-json-3-1/index.js';
-import OpenApiYaml3_1Parser from '../../apidom/reference/parse/parsers/openapi-yaml-3-1/index.js';
-import OpenApi3_1SwaggerClientDereferenceStrategy from '../../apidom/reference/dereference/strategies/openapi-3-1-swagger-client/index.js';
+import HTTPResolverSwaggerClient from '../../apidom/reference/resolve/resolvers/http-swagger-client/index.js';
+import JSONParser from '../../apidom/reference/parse/parsers/json/index.js';
+import YAMLParser from '../../apidom/reference/parse/parsers/yaml-1-2/index.js';
+import OpenAPIJSON3_1Parser from '../../apidom/reference/parse/parsers/openapi-json-3-1/index.js';
+import OpenAPIYAML3_1Parser from '../../apidom/reference/parse/parsers/openapi-yaml-3-1/index.js';
+import OpenAPI3_1SwaggerClientDereferenceStrategy from '../../apidom/reference/dereference/strategies/openapi-3-1-swagger-client/index.js';
 export const circularReplacer = refElement => {
   const $refBaseURI = toValue(refElement.meta.get('baseURI'));
   const referencingElement = refElement.meta.get('referencingElement');
@@ -68,14 +68,14 @@ const resolveOpenAPI31Strategy = async options => {
     const fragmentElement = jsonPointerEvaluate(jsonPointer, openApiElement);
 
     // prepare reference set for dereferencing
-    const openApiElementReference = Reference({
+    const openApiElementReference = new Reference({
       uri: baseURI,
       value: openApiParseResultElement
     });
-    const refSet = ReferenceSet({
+    const refSet = new ReferenceSet({
       refs: [openApiElementReference]
     });
-    if (jsonPointer !== '') refSet.rootRef = null; // reset root reference as we want fragment to become the root reference
+    if (jsonPointer !== '') refSet.rootRef = undefined; // reset root reference as we want fragment to become the root reference
 
     // prepare ancestors; needed for cases where fragment is not OpenAPI element
     const ancestors = [new Set([fragmentElement])];
@@ -89,7 +89,7 @@ const resolveOpenAPI31Strategy = async options => {
          * then below baseURI check will make sure that constant HTTPS URL is used as baseURI.
          */
         baseURI: `${baseURI}${jsonPointerURI}`,
-        resolvers: [HttpResolverSwaggerClient({
+        resolvers: [new HTTPResolverSwaggerClient({
           timeout: timeout || 10000,
           redirects: redirects || 10
         })],
@@ -99,30 +99,30 @@ const resolveOpenAPI31Strategy = async options => {
             responseInterceptor
           }
         },
-        strategies: [OpenApi3_1ResolveStrategy()]
+        strategies: [new OpenAPI3_1ResolveStrategy()]
       },
       parse: {
         mediaType: mediaTypes.latest(),
-        parsers: [OpenApiJson3_1Parser({
+        parsers: [new OpenAPIJSON3_1Parser({
           allowEmpty: false,
           sourceMap: false
-        }), OpenApiYaml3_1Parser({
+        }), new OpenAPIYAML3_1Parser({
           allowEmpty: false,
           sourceMap: false
-        }), JsonParser({
+        }), new JSONParser({
           allowEmpty: false,
           sourceMap: false
-        }), YamlParser({
+        }), new YAMLParser({
           allowEmpty: false,
           sourceMap: false
-        }), BinaryParser({
+        }), new BinaryParser({
           allowEmpty: false,
           sourceMap: false
         })]
       },
       dereference: {
         maxDepth: 100,
-        strategies: [OpenApi3_1SwaggerClientDereferenceStrategy({
+        strategies: [new OpenAPI3_1SwaggerClientDereferenceStrategy({
           allowMetaPatches,
           useCircularStructures,
           parameterMacro,

package/lib/index.js

@@ -52,7 +52,7 @@ Swagger.getBaseUrl = _index9.baseUrl;
 Swagger.apidom = {
   resolve: {
     resolvers: {
-      HttpResolverSwaggerClient: _index11.default
+      HTTPResolverSwaggerClient: _index11.default
     }
   },
   parse: {

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

@@ -8,137 +8,99 @@ var _apidomCore = require("@swagger-api/apidom-core");
 var _empty = require("@swagger-api/apidom-reference/configuration/empty");
 var _openapi = _interopRequireDefault(require("@swagger-api/apidom-reference/dereference/strategies/openapi-3-1"));
 var _apidomNsOpenapi = _interopRequireWildcard(require("@swagger-api/apidom-ns-openapi-3-1"));
-var _dereference = _interopRequireDefault(require("./visitors/dereference.js"));
-var _parameters = _interopRequireDefault(require("./visitors/parameters.js"));
-var _properties = _interopRequireDefault(require("./visitors/properties.js"));
-var _allOf = _interopRequireDefault(require("./visitors/all-of.js"));
+var _root = _interopRequireDefault(require("./visitors/root.js"));
 /* eslint-disable camelcase */
 
 const visitAsync = _apidomCore.visit[Symbol.for('nodejs.util.promisify.custom')];
-const mergeAllVisitorsAsync = _apidomCore.mergeAllVisitors[Symbol.for('nodejs.util.promisify.custom')];
-const OpenApi3_1SwaggerClientDereferenceStrategy = _openapi.default.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 _openapi.default {
+  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 = (0, _apidomCore.createNamespace)(_apidomNsOpenapi.default);
-      const immutableRefSet = (_options$dereference$ = options.dereference.refSet) != null ? _options$dereference$ : (0, _empty.ReferenceSet)();
-      const mutableRefsSet = (0, _empty.ReferenceSet)();
-      let refSet = immutableRefSet;
-      let reference;
-      if (!immutableRefSet.has(file.uri)) {
-        reference = (0, _empty.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 => (0, _empty.Reference)({
-          ...ref,
-          value: (0, _apidomCore.cloneDeep)(ref.value)
-        })).forEach(ref => mutableRefsSet.add(ref));
-        reference = mutableRefsSet.find(ref => ref.uri === file.uri);
-        refSet = mutableRefsSet;
-      }
-
-      // create main dereference visitor
-      const dereferenceVisitor = (0, _dereference.default)({
-        reference,
-        namespace,
-        options,
-        allowMetaPatches: this.allowMetaPatches,
-        ancestors: this.ancestors
+  }
+  async dereference(file, options) {
+    var _options$dereference$;
+    const namespace = (0, _apidomCore.createNamespace)(_apidomNsOpenapi.default);
+    const immutableRefSet = (_options$dereference$ = options.dereference.refSet) != null ? _options$dereference$ : new _empty.ReferenceSet();
+    const mutableRefsSet = new _empty.ReferenceSet();
+    let refSet = immutableRefSet;
+    let reference;
+    if (!immutableRefSet.has(file.uri)) {
+      reference = new _empty.Reference({
+        uri: file.uri,
+        value: file.parseResult
       });
-      visitors.push(dereferenceVisitor);
-
-      // create parameter macro visitor (if necessary)
-      if (typeof this.parameterMacro === 'function') {
-        const parameterMacroVisitor = (0, _parameters.default)({
-          parameterMacro: this.parameterMacro,
-          options
-        });
-        visitors.push(parameterMacroVisitor);
-      }
-
-      // create model property macro visitor (if necessary)
-      if (typeof this.modelPropertyMacro === 'function') {
-        const modelPropertyMacroVisitor = (0, _properties.default)({
-          modelPropertyMacro: this.modelPropertyMacro,
-          options
-        });
-        visitors.push(modelPropertyMacroVisitor);
-      }
-
-      // create allOf visitor (if necessary)
-      if (this.mode !== 'strict') {
-        const allOfVisitor = (0, _allOf.default)({
-          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: _apidomNsOpenapi.getNodeType
-      });
-      const dereferencedElement = await visitAsync(refSet.rootRef.value, rootVisitor, {
-        keyMap: _apidomNsOpenapi.keyMap,
-        nodeTypeGetter: _apidomNsOpenapi.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 _empty.Reference({
+        ...ref,
+        value: (0, _apidomCore.cloneDeep)(ref.value)
+      })).forEach(ref => mutableRefsSet.add(ref));
+      reference = mutableRefsSet.find(ref => ref.uri === file.uri);
+      refSet = mutableRefsSet;
+    }
+    const rootVisitor = new _root.default({
+      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: _apidomNsOpenapi.keyMap,
+      nodeTypeGetter: _apidomNsOpenapi.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 => (0, _empty.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 _empty.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;
   }
-});
-var _default = exports.default = OpenApi3_1SwaggerClientDereferenceStrategy;
+}
+var _default = exports.default = OpenAPI3_1SwaggerClientDereferenceStrategy;
 /* eslint-enable camelcase */

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

@@ -5,86 +5,83 @@ exports.__esModule = true;
 exports.default = void 0;
 var _apidomCore = require("@swagger-api/apidom-core");
 var _apidomNsOpenapi = require("@swagger-api/apidom-ns-openapi-3-1");
-var _compose = _interopRequireDefault(require("../utils/compose.js"));
 var _toPath = _interopRequireDefault(require("../utils/to-path.js"));
-const AllOfVisitor = (0, _compose.default)({
-  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 (!(0, _apidomCore.isArrayElement)(schemaElement.allOf)) {
-          var _this$options$derefer;
-          const error = new TypeError('allOf must be an array');
-          error.fullPath = [...(0, _toPath.default)([...ancestors, parent, schemaElement]), 'allOf'];
-          (_this$options$derefer = this.options.dereference.dereferenceOpts) == null || (_this$options$derefer = _this$options$derefer.errors) == null || _this$options$derefer.push == null || _this$options$derefer.push(error);
-          return undefined;
-        }
+      // collect error and return if allOf keyword is not an array
+      if (!(0, _apidomCore.isArrayElement)(schemaElement.allOf)) {
+        var _this$options$derefer;
+        const error = new TypeError('allOf must be an array');
+        error.fullPath = [...(0, _toPath.default)([...ancestors, parent, schemaElement]), 'allOf'];
+        (_this$options$derefer = this.options.dereference.dereferenceOpts) == null || (_this$options$derefer = _this$options$derefer.errors) == null || _this$options$derefer.push == null || _this$options$derefer.push(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(_apidomNsOpenapi.isSchemaElement);
-        if (!includesSchemaElementOnly) {
-          var _this$options$derefer2;
-          const error = new TypeError('Elements in allOf must be objects');
-          error.fullPath = [...(0, _toPath.default)([...ancestors, parent, schemaElement]), 'allOf'];
-          (_this$options$derefer2 = this.options.dereference.dereferenceOpts) == null || (_this$options$derefer2 = _this$options$derefer2.errors) == null || _this$options$derefer2.push == null || _this$options$derefer2.push(error);
-          return undefined;
-        }
-        while (schemaElement.hasKey('allOf')) {
-          const {
-            allOf
-          } = schemaElement;
-          schemaElement.remove('allOf');
-          const allOfMerged = _apidomCore.deepmerge.all([...allOf.content, schemaElement]);
+      // collect errors if allOf keyword contains anything else than Schema Object
+      const includesSchemaElementOnly = schemaElement.allOf.content.every(_apidomNsOpenapi.isSchemaElement);
+      if (!includesSchemaElementOnly) {
+        var _this$options$derefer2;
+        const error = new TypeError('Elements in allOf must be objects');
+        error.fullPath = [...(0, _toPath.default)([...ancestors, parent, schemaElement]), 'allOf'];
+        (_this$options$derefer2 = this.options.dereference.dereferenceOpts) == null || (_this$options$derefer2 = _this$options$derefer2.errors) == null || _this$options$derefer2.push == null || _this$options$derefer2.push(error);
+        return undefined;
+      }
+      while (schemaElement.hasKey('allOf')) {
+        const {
+          allOf
+        } = schemaElement;
+        schemaElement.remove('allOf');
+        const allOfMerged = _apidomCore.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;
   }
-});
+}
 var _default = exports.default = AllOfVisitor;