swagger-client 3.27.2 → 3.27.4

package/lib/http/serializers/request/index.js

@@ -0,0 +1,117 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.encodeFormOrQuery = encodeFormOrQuery;
+exports.serializeRequest = serializeRequest;
+var _qs = _interopRequireDefault(require("qs"));
+var _format = _interopRequireDefault(require("./format.js"));
+var _file = require("./file.js");
+function buildFormData(reqForm) {
+  /**
+   * Build a new FormData instance, support array as field value
+   * OAS2.0 - when collectionFormat is multi
+   * OAS3.0 - when explode of Encoding Object is true
+   *
+   * This function explicitly handles Buffers (for backward compatibility)
+   * if provided as a values to FormData. FormData can only handle USVString
+   * or Blob.
+   *
+   * @param {Object} reqForm - ori req.form
+   * @return {FormData} - new FormData instance
+   */
+  return Object.entries(reqForm).reduce((formData, [name, input]) => {
+    // eslint-disable-next-line no-restricted-syntax
+    for (const [key, value] of (0, _format.default)(name, input, true)) {
+      if (Array.isArray(value)) {
+        // eslint-disable-next-line no-restricted-syntax
+        for (const v of value) {
+          if (ArrayBuffer.isView(v)) {
+            const blob = new Blob([v]);
+            formData.append(key, blob);
+          } else {
+            formData.append(key, v);
+          }
+        }
+      } else if (ArrayBuffer.isView(value)) {
+        const blob = new Blob([value]);
+        formData.append(key, blob);
+      } else {
+        formData.append(key, value);
+      }
+    }
+    return formData;
+  }, new FormData());
+}
+
+// Encodes an object using appropriate serializer.
+function encodeFormOrQuery(data) {
+  /**
+   * Encode parameter names and values
+   * @param {Object} result - parameter names and values
+   * @param {string} parameterName - Parameter name
+   * @return {object} encoded parameter names and values
+   */
+  const encodedQuery = Object.keys(data).reduce((result, parameterName) => {
+    // eslint-disable-next-line no-restricted-syntax
+    for (const [key, value] of (0, _format.default)(parameterName, data[parameterName])) {
+      if (value instanceof _file.FileWithData) {
+        result[key] = value.valueOf();
+      } else {
+        result[key] = value;
+      }
+    }
+    return result;
+  }, {});
+  return _qs.default.stringify(encodedQuery, {
+    encode: false,
+    indices: false
+  }) || '';
+}
+
+// If the request has a `query` object, merge it into the request.url, and delete the object
+// If file and/or multipart, also create FormData instance
+function serializeRequest(req = {}) {
+  const {
+    url = '',
+    query,
+    form
+  } = req;
+  const joinSearch = (...strs) => {
+    const search = strs.filter(a => a).join('&'); // Only truthy value
+    return search ? `?${search}` : ''; // Only add '?' if there is a str
+  };
+  if (form) {
+    const hasFile = Object.keys(form).some(key => {
+      const {
+        value
+      } = form[key];
+      return (0, _file.isFile)(value) || (0, _file.isArrayOfFile)(value);
+    });
+    const contentType = req.headers['content-type'] || req.headers['Content-Type'];
+    if (hasFile || /multipart\/form-data/i.test(contentType)) {
+      const formdata = buildFormData(req.form);
+      req.formdata = formdata;
+      req.body = formdata;
+    } else {
+      req.body = encodeFormOrQuery(form);
+    }
+    delete req.form;
+  }
+  if (query) {
+    const [baseUrl, oriSearch] = url.split('?');
+    let newStr = '';
+    if (oriSearch) {
+      const oriQuery = _qs.default.parse(oriSearch);
+      const keysToRemove = Object.keys(query);
+      keysToRemove.forEach(key => delete oriQuery[key]);
+      newStr = _qs.default.stringify(oriQuery, {
+        encode: true
+      });
+    }
+    const finalStr = joinSearch(newStr, encodeFormOrQuery(query));
+    req.url = baseUrl + finalStr;
+    delete req.query;
+  }
+  return req;
+}

package/lib/http/serializers/response/index.js

@@ -0,0 +1,63 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.serializeHeaders = serializeHeaders;
+exports.serializeResponse = serializeResponse;
+exports.shouldDownloadAsText = void 0;
+var _jsYaml = _interopRequireDefault(require("js-yaml"));
+const shouldDownloadAsText = (contentType = '') => /(json|xml|yaml|text)\b/.test(contentType);
+exports.shouldDownloadAsText = shouldDownloadAsText;
+function parseBody(body, contentType) {
+  if (contentType && (contentType.indexOf('application/json') === 0 || contentType.indexOf('+json') > 0)) {
+    return JSON.parse(body);
+  }
+  return _jsYaml.default.load(body);
+}
+function serializeHeaderValue(value) {
+  const isMulti = value.includes(', ');
+  return isMulti ? value.split(', ') : value;
+}
+
+// Serialize headers into a hash, where mutliple-headers result in an array.
+//
+// eg: Cookie: one
+//     Cookie: two
+//  =  { Cookie: [ "one", "two" ]
+function serializeHeaders(headers = {}) {
+  if (typeof headers.entries !== 'function') return {};
+  return Array.from(headers.entries()).reduce((acc, [header, value]) => {
+    acc[header] = serializeHeaderValue(value);
+    return acc;
+  }, {});
+}
+
+// Serialize the response, returns a promise with headers and the body part of the hash
+function serializeResponse(oriRes, url, {
+  loadSpec = false
+} = {}) {
+  const res = {
+    ok: oriRes.ok,
+    url: oriRes.url || url,
+    status: oriRes.status,
+    statusText: oriRes.statusText,
+    headers: serializeHeaders(oriRes.headers)
+  };
+  const contentType = res.headers['content-type'];
+  const useText = loadSpec || shouldDownloadAsText(contentType);
+  const getBody = useText ? oriRes.text : oriRes.blob || oriRes.buffer;
+  return getBody.call(oriRes).then(body => {
+    res.text = body;
+    res.data = body;
+    if (useText) {
+      try {
+        const obj = parseBody(body, contentType);
+        res.body = obj;
+        res.obj = obj;
+      } catch (e) {
+        res.parseError = e;
+      }
+    }
+    return res;
+  });
+}

package/lib/index.js

@@ -6,65 +6,66 @@ exports.__esModule = true;
 exports.helpers = exports.default = void 0;
 var _constants = require("./constants.js");
 var _index = _interopRequireWildcard(require("./http/index.js"));
-var _index2 = require("./resolver/index.js");
-var _index3 = require("./subtree-resolver/index.js");
-var _index4 = _interopRequireDefault(require("./resolver/strategies/generic/index.js"));
-var _index5 = _interopRequireWildcard(require("./resolver/strategies/openapi-2/index.js"));
-var _index6 = _interopRequireDefault(require("./resolver/strategies/openapi-3-0/index.js"));
-var _index7 = _interopRequireDefault(require("./resolver/strategies/openapi-3-1-apidom/index.js"));
+var _index2 = require("./http/serializers/response/index.js");
+var _index3 = require("./resolver/index.js");
+var _index4 = require("./subtree-resolver/index.js");
+var _index5 = _interopRequireDefault(require("./resolver/strategies/generic/index.js"));
+var _index6 = _interopRequireWildcard(require("./resolver/strategies/openapi-2/index.js"));
+var _index7 = _interopRequireDefault(require("./resolver/strategies/openapi-3-0/index.js"));
+var _index8 = _interopRequireDefault(require("./resolver/strategies/openapi-3-1-apidom/index.js"));
 var _interfaces = require("./interfaces.js");
-var _index8 = require("./execute/index.js");
-var _index9 = require("./helpers/index.js");
+var _index9 = require("./execute/index.js");
+var _index10 = require("./helpers/index.js");
 var _openapiPredicates = require("./helpers/openapi-predicates.js");
-var _index10 = _interopRequireDefault(require("./resolver/apidom/reference/resolve/resolvers/http-swagger-client/index.js"));
-var _index11 = _interopRequireDefault(require("./resolver/apidom/reference/parse/parsers/json/index.js"));
-var _index12 = _interopRequireDefault(require("./resolver/apidom/reference/parse/parsers/yaml-1-2/index.js"));
-var _index13 = _interopRequireDefault(require("./resolver/apidom/reference/parse/parsers/openapi-json-3-1/index.js"));
-var _index14 = _interopRequireDefault(require("./resolver/apidom/reference/parse/parsers/openapi-yaml-3-1/index.js"));
-var _index15 = _interopRequireDefault(require("./resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/index.js"));
+var _index11 = _interopRequireDefault(require("./resolver/apidom/reference/resolve/resolvers/http-swagger-client/index.js"));
+var _index12 = _interopRequireDefault(require("./resolver/apidom/reference/parse/parsers/json/index.js"));
+var _index13 = _interopRequireDefault(require("./resolver/apidom/reference/parse/parsers/yaml-1-2/index.js"));
+var _index14 = _interopRequireDefault(require("./resolver/apidom/reference/parse/parsers/openapi-json-3-1/index.js"));
+var _index15 = _interopRequireDefault(require("./resolver/apidom/reference/parse/parsers/openapi-yaml-3-1/index.js"));
+var _index16 = _interopRequireDefault(require("./resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/index.js"));
 /* eslint-disable camelcase */
 
 Swagger.http = _index.default;
 Swagger.makeHttp = _index.makeHttp.bind(null, Swagger.http);
 Swagger.resolveStrategies = {
-  'openapi-3-1-apidom': _index7.default,
-  'openapi-3-0': _index6.default,
-  'openapi-2-0': _index5.default,
-  generic: _index4.default
+  'openapi-3-1-apidom': _index8.default,
+  'openapi-3-0': _index7.default,
+  'openapi-2-0': _index6.default,
+  generic: _index5.default
 };
-Swagger.resolve = (0, _index2.makeResolve)({
+Swagger.resolve = (0, _index3.makeResolve)({
   strategies: [Swagger.resolveStrategies['openapi-3-1-apidom'], Swagger.resolveStrategies['openapi-3-0'], Swagger.resolveStrategies['openapi-2-0'], Swagger.resolveStrategies.generic]
 });
-Swagger.resolveSubtree = (0, _index3.makeResolveSubtree)({
+Swagger.resolveSubtree = (0, _index4.makeResolveSubtree)({
   strategies: [Swagger.resolveStrategies['openapi-3-1-apidom'], Swagger.resolveStrategies['openapi-3-0'], Swagger.resolveStrategies['openapi-2-0'], Swagger.resolveStrategies.generic]
 });
-Swagger.execute = _index8.execute;
+Swagger.execute = _index9.execute;
 Swagger.serializeRes = _index.serializeRes;
-Swagger.serializeHeaders = _index.serializeHeaders;
-Swagger.clearCache = _index5.clearCache;
+Swagger.serializeHeaders = _index2.serializeHeaders;
+Swagger.clearCache = _index6.clearCache;
 Swagger.makeApisTagOperation = _interfaces.makeApisTagOperation;
-Swagger.buildRequest = _index8.buildRequest;
+Swagger.buildRequest = _index9.buildRequest;
 Swagger.helpers = {
-  opId: _index9.opId
+  opId: _index10.opId
 };
-Swagger.getBaseUrl = _index8.baseUrl;
+Swagger.getBaseUrl = _index9.baseUrl;
 Swagger.apidom = {
   resolve: {
     resolvers: {
-      HttpResolverSwaggerClient: _index10.default
+      HttpResolverSwaggerClient: _index11.default
     }
   },
   parse: {
     parsers: {
-      JsonParser: _index11.default,
-      YamlParser: _index12.default,
-      OpenApiJson3_1Parser: _index13.default,
-      OpenApiYaml3_1Parser: _index14.default
+      JsonParser: _index12.default,
+      YamlParser: _index13.default,
+      OpenApiJson3_1Parser: _index14.default,
+      OpenApiYaml3_1Parser: _index15.default
     }
   },
   dereference: {
     strategies: {
-      OpenApi3_1SwaggerClientDereferenceStrategy: _index15.default
+      OpenApi3_1SwaggerClientDereferenceStrategy: _index16.default
     }
   }
 };
@@ -130,7 +131,7 @@ Swagger.prototype.applyDefaults = function applyDefaults() {
     spec
   } = this;
   const specUrl = this.url;
-  if ((0, _openapiPredicates.isOpenAPI2)(spec) && (0, _index9.isHttpUrl)(specUrl)) {
+  if ((0, _openapiPredicates.isOpenAPI2)(spec) && (0, _index10.isHttpUrl)(specUrl)) {
     const parsed = new URL(specUrl);
     if (!spec.host) {
       spec.host = parsed.host;

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

@@ -0,0 +1,7 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomError = require("@swagger-api/apidom-error");
+class SchemaRefError extends _apidomError.ApiDOMStructuredError {}
+var _default = exports.default = SchemaRefError;

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

@@ -13,8 +13,8 @@ var _$anchor = require("@swagger-api/apidom-reference/dereference/strategies/ope
 var _uri = require("@swagger-api/apidom-reference/dereference/strategies/openapi-3-1/selectors/uri");
 var _toPath = _interopRequireDefault(require("../utils/to-path.js"));
 var _getRootCause = _interopRequireDefault(require("../utils/get-root-cause.js"));
-var _refs = _interopRequireDefault(require("../../../../../../../specmap/lib/refs.js"));
-var _index = require("../errors/index.js");
+var _refs = _interopRequireDefault(require("../../../../../../specmap/lib/refs.js"));
+var _SchemaRefError = _interopRequireDefault(require("../errors/SchemaRefError.js"));
 /* eslint-disable camelcase */
 
 const {
@@ -663,11 +663,12 @@ const OpenApi3_1SwaggerClientDereferenceVisitor = _openapi.OpenApi3_1Dereference
       } catch (error) {
         var _this$basePath6, _this$options$derefer9;
         const rootCause = (0, _getRootCause.default)(error);
-        const wrappedError = new _index.SchemaRefError(`Could not resolve reference: ${rootCause.message}`, {
+        const wrappedError = new _SchemaRefError.default(`Could not resolve reference: ${rootCause.message}`, {
           baseDoc: this.reference.uri,
           $ref: (0, _apidomCore.toValue)(referencingElement.$ref),
-          fullPath: (_this$basePath6 = this.basePath) != null ? _this$basePath6 : [...(0, _toPath.default)([...ancestors, parent, referencingElement]), '$ref']
-        }, rootCause);
+          fullPath: (_this$basePath6 = this.basePath) != null ? _this$basePath6 : [...(0, _toPath.default)([...ancestors, parent, referencingElement]), '$ref'],
+          cause: rootCause
+        });
         (_this$options$derefer9 = this.options.dereference.dereferenceOpts) == null || (_this$options$derefer9 = _this$options$derefer9.errors) == null || _this$options$derefer9.push == null || _this$options$derefer9.push(wrappedError);
         return undefined;
       }

package/lib/{specmap → resolver/specmap}/helpers.js

@@ -7,7 +7,7 @@ exports.generateAbsoluteRefPatches = generateAbsoluteRefPatches;
 exports.isFreelyNamed = isFreelyNamed;
 var _traverse = _interopRequireDefault(require("traverse"));
 var _empty = require("@swagger-api/apidom-reference/configuration/empty");
-var _constants = require("../constants.js");
+var _constants = require("../../constants.js");
 // This will match if the direct parent's key exactly matches an item.
 const freelyNamedKeyParents = ['properties'];
 

package/lib/{specmap → resolver/specmap}/lib/refs.js

@@ -4,17 +4,14 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
+var _apidomError = require("@swagger-api/apidom-error");
 var _empty = require("@swagger-api/apidom-reference/configuration/empty");
-require("../../helpers/fetch-polyfill.node.js");
+require("../../../helpers/fetch-polyfill.node.js");
 var _index = _interopRequireDefault(require("./index.js"));
-var _createError = _interopRequireDefault(require("./create-error.js"));
 var _helpers = require("../helpers.js");
-var _constants = require("../../constants.js");
+var _constants = require("../../../constants.js");
 const ABSOLUTE_URL_REGEXP = /^([a-z]+:\/\/|\/\/)/i;
-const JSONRefError = (0, _createError.default)('JSONRefError', function cb(message, extra, oriError) {
-  this.originalError = oriError;
-  Object.assign(this, extra || {});
-});
+class JSONRefError extends _apidomError.ApiDOMStructuredError {}
 const docCache = {};
 const specmapRefs = new WeakMap();
 const skipResolutionTestFns = [
@@ -230,7 +227,10 @@ function wrapError(e, extra) {
   } else {
     message = e.message;
   }
-  return new JSONRefError(`Could not resolve reference: ${message}`, extra, e);
+  return new JSONRefError(`Could not resolve reference: ${message}`, {
+    ...extra,
+    cause: e
+  });
 }
 
 /**

package/lib/resolver/strategies/generic/index.js

@@ -6,7 +6,7 @@ exports.clearCache = clearCache;
 exports.default = void 0;
 var _resolve = _interopRequireDefault(require("./resolve.js"));
 var _normalize = _interopRequireDefault(require("./normalize.js"));
-var _index = require("../../../specmap/index.js");
+var _index = require("../../specmap/index.js");
 function clearCache() {
   _index.plugins.refs.clearCache();
 }

package/lib/resolver/strategies/generic/resolve.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 exports.__esModule = true;
 exports.default = resolveGenericStrategy;
-var _index = _interopRequireWildcard(require("../../../specmap/index.js"));
+var _index = _interopRequireWildcard(require("../../specmap/index.js"));
 var _normalize = _interopRequireDefault(require("./normalize.js"));
 var _index2 = require("../../utils/index.js");
 var optionsUtil = _interopRequireWildcard(require("../../utils/options.js"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-client",
-  "version": "3.27.2",
+  "version": "3.27.4",
   "description": "SwaggerJS - a collection of interfaces for OAI specs",
   "browser": {
     "./src/helpers/btoa.node.js": "./src/helpers/btoa.browser.js",
@@ -122,6 +122,7 @@
     "js-yaml": "^4.1.0",
     "node-abort-controller": "^3.1.1",
     "node-fetch-commonjs": "^3.3.2",
+    "openapi-path-templating": "^1.5.1",
     "qs": "^6.10.2",
     "traverse": "=0.6.8"
   },

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

@@ -1,7 +0,0 @@
-import createError from '../../../../../../../specmap/lib/create-error.js';
-
-// eslint-disable-next-line import/prefer-default-export
-export const SchemaRefError = createError('SchemaRefError', function cb(message, extra, oriError) {
-  this.originalError = oriError;
-  Object.assign(this, extra || {});
-});

package/es/specmap/lib/create-error.js

@@ -1,17 +0,0 @@
-export default function createErrorType(name, init) {
-  function E(...args) {
-    if (!Error.captureStackTrace) {
-      this.stack = new Error().stack;
-    } else {
-      Error.captureStackTrace(this, this.constructor);
-    }
-    [this.message] = args;
-    if (init) {
-      init.apply(this, args);
-    }
-  }
-  E.prototype = new Error();
-  E.prototype.name = name;
-  E.prototype.constructor = E;
-  return E;
-}

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

@@ -1,11 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.SchemaRefError = void 0;
-var _createError = _interopRequireDefault(require("../../../../../../../specmap/lib/create-error.js"));
-// eslint-disable-next-line import/prefer-default-export
-const SchemaRefError = exports.SchemaRefError = (0, _createError.default)('SchemaRefError', function cb(message, extra, oriError) {
-  this.originalError = oriError;
-  Object.assign(this, extra || {});
-});

package/lib/specmap/lib/create-error.js

@@ -1,21 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = createErrorType;
-function createErrorType(name, init) {
-  function E(...args) {
-    if (!Error.captureStackTrace) {
-      this.stack = new Error().stack;
-    } else {
-      Error.captureStackTrace(this, this.constructor);
-    }
-    [this.message] = args;
-    if (init) {
-      init.apply(this, args);
-    }
-  }
-  E.prototype = new Error();
-  E.prototype.name = name;
-  E.prototype.constructor = E;
-  return E;
-}