swagger-client 3.19.11 → 3.20.0

package/es/execute/index.js

@@ -240,7 +240,7 @@ export function buildRequest(options) {
   }
   if (req.cookies) {
     // even if no cookies were defined, we need to remove
-    // the cookies key from our request, or many many legacy
+    // the cookies key from our request, or many legacy
     // tests will break.
     delete req.cookies;
   }

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

@@ -63,7 +63,7 @@ export default function buildRequest(options, req) {
         // contentType that has been explicitly set
         if (requestContentType === 'application/x-www-form-urlencoded' || requestContentType === 'multipart/form-data') {
           if (typeof requestBody === 'object') {
-            const encoding = (requestBodyDef.content[requestContentType] || {}).encoding || {};
+            const encoding = requestBodyDef.content[requestContentType]?.encoding ?? {};
             req.form = {};
             Object.keys(requestBody).forEach(k => {
               req.form[k] = {

package/es/http/index.js

@@ -182,6 +182,29 @@ const SEPARATORS = {
   pipes: '|'
 };
 
+/**
+ * Specialized sub-class of File class, that only
+ * accepts string data and retain this data in `data`
+ * public property throughout the lifecycle of its instances.
+ *
+ * This sub-class is exclusively used only when Encoding Object
+ * is defined within the Media Type Object (OpenAPI 3.x.y).
+ */
+class FileWithData extends File {
+  constructor(data) {
+    let name = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+    let options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+    super([data], name, options);
+    this.data = data;
+  }
+  valueOf() {
+    return this.data;
+  }
+  toString() {
+    return this.valueOf();
+  }
+}
+
 // Formats a key-value and returns an array of key-value pairs.
 //
 // Return value example 1: [['color', 'blue']]
@@ -230,13 +253,21 @@ function formatKeyValue(key, input) {
         allowReserved
       });
     }
-    if (encoding.contentType) {
-      if (encoding.contentType === 'application/json') {
-        // If value is a string, assume value is already a JSON string
+    if (typeof encoding.contentType === 'string') {
+      if (encoding.contentType.startsWith('application/json')) {
+        // if value is a string, assume value is already a JSON string
         const json = typeof value === 'string' ? value : JSON.stringify(value);
-        return [[encodedKey, encodeFn(json)]];
+        const encodedJson = encodeFn(json);
+        const file = new FileWithData(encodedJson, 'blob', {
+          type: encoding.contentType
+        });
+        return [[encodedKey, file]];
       }
-      return [[encodedKey, encodeFn(value.toString())]];
+      const encodedData = encodeFn(String(value));
+      const blob = new FileWithData(encodedData, 'blob', {
+        type: encoding.contentType
+      });
+      return [[encodedKey, blob]];
     }
 
     // Primitive
@@ -357,7 +388,11 @@ export function encodeFormOrQuery(data) {
   const encodedQuery = Object.keys(data).reduce((result, parameterName) => {
     // eslint-disable-next-line no-restricted-syntax
     for (const [key, value] of formatKeyValue(parameterName, data[parameterName])) {
-      result[key] = value;
+      if (value instanceof FileWithData) {
+        result[key] = value.valueOf();
+      } else {
+        result[key] = value;
+      }
     }
     return result;
   }, {});

package/lib/execute/index.js

@@ -256,7 +256,7 @@ function buildRequest(options) {
   }
   if (req.cookies) {
     // even if no cookies were defined, we need to remove
-    // the cookies key from our request, or many many legacy
+    // the cookies key from our request, or many legacy
     // tests will break.
     delete req.cookies;
   }

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

@@ -68,7 +68,8 @@ function buildRequest(options, req) {
         // contentType that has been explicitly set
         if (requestContentType === 'application/x-www-form-urlencoded' || requestContentType === 'multipart/form-data') {
           if (typeof requestBody === 'object') {
-            const encoding = (requestBodyDef.content[requestContentType] || {}).encoding || {};
+            var _requestBodyDef$conte, _requestBodyDef$conte2;
+            const encoding = (_requestBodyDef$conte = (_requestBodyDef$conte2 = requestBodyDef.content[requestContentType]) === null || _requestBodyDef$conte2 === void 0 ? void 0 : _requestBodyDef$conte2.encoding) !== null && _requestBodyDef$conte !== void 0 ? _requestBodyDef$conte : {};
             req.form = {};
             Object.keys(requestBody).forEach(k => {
               req.form[k] = {

package/lib/http/index.js

@@ -189,6 +189,27 @@ const SEPARATORS = {
   pipes: '|'
 };
 
+/**
+ * Specialized sub-class of File class, that only
+ * accepts string data and retain this data in `data`
+ * public property throughout the lifecycle of its instances.
+ *
+ * This sub-class is exclusively used only when Encoding Object
+ * is defined within the Media Type Object (OpenAPI 3.x.y).
+ */
+class FileWithData extends _formdataNode.File {
+  constructor(data, name = '', options = {}) {
+    super([data], name, options);
+    this.data = data;
+  }
+  valueOf() {
+    return this.data;
+  }
+  toString() {
+    return this.valueOf();
+  }
+}
+
 // Formats a key-value and returns an array of key-value pairs.
 //
 // Return value example 1: [['color', 'blue']]
@@ -236,13 +257,21 @@ function formatKeyValue(key, input, skipEncoding = false) {
         allowReserved
       });
     }
-    if (encoding.contentType) {
-      if (encoding.contentType === 'application/json') {
-        // If value is a string, assume value is already a JSON string
+    if (typeof encoding.contentType === 'string') {
+      if (encoding.contentType.startsWith('application/json')) {
+        // if value is a string, assume value is already a JSON string
         const json = typeof value === 'string' ? value : JSON.stringify(value);
-        return [[encodedKey, encodeFn(json)]];
+        const encodedJson = encodeFn(json);
+        const file = new FileWithData(encodedJson, 'blob', {
+          type: encoding.contentType
+        });
+        return [[encodedKey, file]];
       }
-      return [[encodedKey, encodeFn(value.toString())]];
+      const encodedData = encodeFn(String(value));
+      const blob = new FileWithData(encodedData, 'blob', {
+        type: encoding.contentType
+      });
+      return [[encodedKey, blob]];
     }
 
     // Primitive
@@ -362,7 +391,11 @@ function encodeFormOrQuery(data) {
   const encodedQuery = Object.keys(data).reduce((result, parameterName) => {
     // eslint-disable-next-line no-restricted-syntax
     for (const [key, value] of formatKeyValue(parameterName, data[parameterName])) {
-      result[key] = value;
+      if (value instanceof FileWithData) {
+        result[key] = value.valueOf();
+      } else {
+        result[key] = value;
+      }
     }
     return result;
   }, {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-client",
-  "version": "3.19.11",
+  "version": "3.20.0",
   "description": "SwaggerJS - a collection of interfaces for OAI specs",
   "browser": {
     "./src/http/fold-formdata-to-request.node.js": "./src/http/fold-formdata-to-request.browser.js",
@@ -84,8 +84,8 @@
     "cross-env": "=7.0.3",
     "eslint": "^8.42.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-prettier": "=8.8.0",
-    "eslint-plugin-import": "=2.27.5",
+    "eslint-config-prettier": "=8.9.0",
+    "eslint-plugin-import": "=2.28.0",
     "eslint-plugin-prettier": "=5.0.0",
     "expect": "^29.0.3",
     "fetch-mock": "=9.11.0",
@@ -106,7 +106,7 @@
     "rimraf": "=5.0.1",
     "source-map-explorer": "^2.5.3",
     "terser-webpack-plugin": "^5.0.3",
-    "webpack": "=5.88.1",
+    "webpack": "=5.88.2",
     "webpack-bundle-size-analyzer": "=3.1.0",
     "webpack-cli": "=5.1.4",
     "webpack-stats-plugin": "=1.1.3",
@@ -114,10 +114,10 @@
   },
   "dependencies": {
     "@babel/runtime-corejs3": "^7.20.13",
-    "@swagger-api/apidom-core": ">=0.71.0 <1.0.0",
-    "@swagger-api/apidom-json-pointer": ">=0.71.0 <1.0.0",
-    "@swagger-api/apidom-ns-openapi-3-1": ">=0.71.0 <1.0.0",
-    "@swagger-api/apidom-reference": ">=0.71.1 <1.0.0",
+    "@swagger-api/apidom-core": ">=0.74.1 <1.0.0",
+    "@swagger-api/apidom-json-pointer": ">=0.74.1 <1.0.0",
+    "@swagger-api/apidom-ns-openapi-3-1": ">=0.74.1 <1.0.0",
+    "@swagger-api/apidom-reference": ">=0.74.1 <1.0.0",
     "cookie": "~0.5.0",
     "cross-fetch": "^3.1.5",
     "deepmerge": "~4.3.0",