swagger-client 3.27.2 → 3.27.3

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

@@ -0,0 +1,111 @@
+import qs from 'qs';
+import formatKeyValue from './format.js';
+import { isFile, isArrayOfFile, FileWithData } from './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 formatKeyValue(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.
+export 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 formatKeyValue(parameterName, data[parameterName])) {
+      if (value instanceof FileWithData) {
+        result[key] = value.valueOf();
+      } else {
+        result[key] = value;
+      }
+    }
+    return result;
+  }, {});
+  return qs.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
+export 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 isFile(value) || 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.parse(oriSearch);
+      const keysToRemove = Object.keys(query);
+      keysToRemove.forEach(key => delete oriQuery[key]);
+      newStr = qs.stringify(oriQuery, {
+        encode: true
+      });
+    }
+    const finalStr = joinSearch(newStr, encodeFormOrQuery(query));
+    req.url = baseUrl + finalStr;
+    delete req.query;
+  }
+  return req;
+}

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

@@ -0,0 +1,55 @@
+import jsYaml from 'js-yaml';
+export const shouldDownloadAsText = (contentType = '') => /(json|xml|yaml|text)\b/.test(contentType);
+function parseBody(body, contentType) {
+  if (contentType && (contentType.indexOf('application/json') === 0 || contentType.indexOf('+json') > 0)) {
+    return JSON.parse(body);
+  }
+  return jsYaml.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" ]
+export 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
+export 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/es/index.js

@@ -1,6 +1,7 @@
 /* eslint-disable camelcase */
 import { DEFAULT_OPENAPI_3_SERVER } from './constants.js';
-import Http, { makeHttp, serializeRes, serializeHeaders } from './http/index.js';
+import Http, { makeHttp, serializeRes } from './http/index.js';
+import { serializeHeaders } from './http/serializers/response/index.js';
 import { makeResolve } from './resolver/index.js';
 import { makeResolveSubtree } from './subtree-resolver/index.js';
 import genericResolveStrategy from './resolver/strategies/generic/index.js';

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

@@ -0,0 +1,3 @@
+import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
+class SchemaRefError extends ApiDOMStructuredError {}
+export default SchemaRefError;

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

@@ -9,8 +9,8 @@ import { isAnchor, uriToAnchor, evaluate as $anchorEvaluate } from '@swagger-api
 import { evaluate as uriEvaluate, EvaluationJsonSchemaUriError } from '@swagger-api/apidom-reference/dereference/strategies/openapi-3-1/selectors/uri';
 import toPath from '../utils/to-path.js';
 import getRootCause from '../utils/get-root-cause.js';
-import specMapMod from '../../../../../../../specmap/lib/refs.js';
-import { SchemaRefError } from '../errors/index.js';
+import specMapMod from '../../../../../../specmap/lib/refs.js';
+import SchemaRefError from '../errors/SchemaRefError.js';
 const {
   wrapError
 } = specMapMod;
@@ -660,8 +660,9 @@ const OpenApi3_1SwaggerClientDereferenceVisitor = OpenApi3_1DereferenceVisitor.c
         const wrappedError = new SchemaRefError(`Could not resolve reference: ${rootCause.message}`, {
           baseDoc: this.reference.uri,
           $ref: toValue(referencingElement.$ref),
-          fullPath: (_this$basePath6 = this.basePath) !== null && _this$basePath6 !== void 0 ? _this$basePath6 : [...toPath([...ancestors, parent, referencingElement]), '$ref']
-        }, rootCause);
+          fullPath: (_this$basePath6 = this.basePath) !== null && _this$basePath6 !== void 0 ? _this$basePath6 : [...toPath([...ancestors, parent, referencingElement]), '$ref'],
+          cause: rootCause
+        });
         (_this$options$derefer11 = this.options.dereference.dereferenceOpts) === null || _this$options$derefer11 === void 0 || (_this$options$derefer11 = _this$options$derefer11.errors) === null || _this$options$derefer11 === void 0 || (_this$options$derefer12 = _this$options$derefer11.push) === null || _this$options$derefer12 === void 0 || _this$options$derefer12.call(_this$options$derefer11, wrappedError);
         return undefined;
       }

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

@@ -1,6 +1,6 @@
 import traverse from 'traverse';
 import { url } from '@swagger-api/apidom-reference/configuration/empty';
-import { DEFAULT_BASE_URL } from '../constants.js';
+import { DEFAULT_BASE_URL } from '../../constants.js';
 
 // This will match if the direct parent's key exactly matches an item.
 const freelyNamedKeyParents = ['properties'];

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

@@ -1,15 +1,12 @@
 import jsYaml from 'js-yaml';
+import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
 import { url } from '@swagger-api/apidom-reference/configuration/empty';
-import '../../helpers/fetch-polyfill.node.js';
+import '../../../helpers/fetch-polyfill.node.js';
 import lib from './index.js';
-import createError from './create-error.js';
 import { isFreelyNamed, absolutifyPointer } from '../helpers.js';
-import { ACCEPT_HEADER_VALUE_FOR_DOCUMENTS } from '../../constants.js';
+import { ACCEPT_HEADER_VALUE_FOR_DOCUMENTS } from '../../../constants.js';
 const ABSOLUTE_URL_REGEXP = /^([a-z]+:\/\/|\/\/)/i;
-const JSONRefError = createError('JSONRefError', function cb(message, extra, oriError) {
-  this.originalError = oriError;
-  Object.assign(this, extra || {});
-});
+class JSONRefError extends ApiDOMStructuredError {}
 const docCache = {};
 const specmapRefs = new WeakMap();
 const skipResolutionTestFns = [
@@ -228,7 +225,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/es/resolver/strategies/generic/index.js

@@ -1,6 +1,6 @@
 import resolveGenericStrategy from './resolve.js';
 import normalize from './normalize.js';
-import { plugins } from '../../../specmap/index.js';
+import { plugins } from '../../specmap/index.js';
 export function clearCache() {
   plugins.refs.clearCache();
 }

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

@@ -1,4 +1,4 @@
-import mapSpec, { plugins } from '../../../specmap/index.js';
+import mapSpec, { plugins } from '../../specmap/index.js';
 import normalize from './normalize.js';
 import { makeFetchJSON } from '../../utils/index.js';
 import * as optionsUtil from '../../utils/options.js';

package/lib/execute/index.js

@@ -9,15 +9,16 @@ exports.execute = execute;
 exports.self = void 0;
 var _cookie = _interopRequireDefault(require("cookie"));
 var _isPlainObject = require("is-plain-object");
+var _apidomError = require("@swagger-api/apidom-error");
 var _empty = require("@swagger-api/apidom-reference/configuration/empty");
 var _constants = require("../constants.js");
-var _index = _interopRequireWildcard(require("../http/index.js"));
-var _createError = _interopRequireDefault(require("../specmap/lib/create-error.js"));
+var _index = _interopRequireDefault(require("../http/index.js"));
+var _index2 = require("../http/serializers/request/index.js");
 var _parameterBuilders = _interopRequireDefault(require("./swagger2/parameter-builders.js"));
 var OAS3_PARAMETER_BUILDERS = _interopRequireWildcard(require("./oas3/parameter-builders.js"));
 var _buildRequest = _interopRequireDefault(require("./oas3/build-request.js"));
 var _buildRequest2 = _interopRequireDefault(require("./swagger2/build-request.js"));
-var _index2 = require("../helpers/index.js");
+var _index3 = require("../helpers/index.js");
 var _openapiPredicates = require("../helpers/openapi-predicates.js");
 const arrayOrEmpty = ar => Array.isArray(ar) ? ar : [];
 
@@ -47,10 +48,7 @@ const parseURIReference = uriReference => {
     };
   }
 };
-const OperationNotFoundError = (0, _createError.default)('OperationNotFoundError', function cb(message, extra, oriError) {
-  this.originalError = oriError;
-  Object.assign(this, extra || {});
-});
+class OperationNotFoundError extends _apidomError.ApiDOMStructuredError {}
 const findParametersWithName = (name, parameters) => parameters.filter(p => p.name === name);
 
 // removes parameters that have duplicate 'in' and 'name' properties
@@ -94,7 +92,7 @@ function execute({
   const http = userHttp || fetch || _index.default; // Default to _our_ http
 
   if (pathName && method && !operationId) {
-    operationId = (0, _index2.idFromPathMethodLegacy)(pathName, method);
+    operationId = (0, _index3.idFromPathMethodLegacy)(pathName, method);
   }
   const request = self.buildRequest({
     spec,
@@ -164,7 +162,7 @@ function buildRequest(options) {
   if (userFetch) {
     req.userFetch = userFetch;
   }
-  const operationRaw = (0, _index2.getOperationRaw)(spec, operationId);
+  const operationRaw = (0, _index3.getOperationRaw)(spec, operationId);
   if (!operationRaw) {
     throw new OperationNotFoundError(`Operation ${operationId} not found`);
   }
@@ -281,8 +279,7 @@ function buildRequest(options) {
 
   // Will add the query object into the URL, if it exists
   // ... will also create a FormData instance, if multipart/form-data (eg: a file)
-  (0, _index.mergeInQueryOrForm)(req);
-  return req;
+  return (0, _index2.serializeRequest)(req);
 }
 const stripNonAlpha = str => str ? str.replace(/\W/g, '') : null;
 

package/lib/execute/oas3/build-request.js

@@ -68,11 +68,32 @@ function buildRequest(options, req) {
             const encoding = (_requestBodyDef$conte = (_requestBodyDef$conte2 = requestBodyDef.content[requestContentType]) == null ? void 0 : _requestBodyDef$conte2.encoding) != null ? _requestBodyDef$conte : {};
             req.form = {};
             Object.keys(requestBody).forEach(k => {
+              let value;
+              try {
+                value = JSON.parse(requestBody[k]);
+              } catch {
+                value = requestBody[k];
+              }
               req.form[k] = {
-                value: requestBody[k],
+                value,
                 encoding: encoding[k] || {}
               };
             });
+          } else if (typeof requestBody === 'string') {
+            var _requestBodyDef$conte3, _requestBodyDef$conte4;
+            const encoding = (_requestBodyDef$conte3 = (_requestBodyDef$conte4 = requestBodyDef.content[requestContentType]) == null ? void 0 : _requestBodyDef$conte4.encoding) != null ? _requestBodyDef$conte3 : {};
+            try {
+              req.form = {};
+              const form = JSON.parse(requestBody);
+              Object.entries(form).forEach(([key, value]) => {
+                req.form[key] = {
+                  value,
+                  encoding: encoding[key] || {}
+                };
+              });
+            } catch {
+              req.form = requestBody;
+            }
           } else {
             req.form = requestBody;
           }