keq 2.8.5 → 2.8.6

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.8.6](https://github.com/keq-request/keq/compare/v2.8.5...v2.8.6) (2024-10-25)
+
+
+### Bug Fixes
+
+* cannot send blob body ([ba7a14d](https://github.com/keq-request/keq/commit/ba7a14d10090aded2525789f0ef543564ce05434))
+* cannot send readableStream ([1b16142](https://github.com/keq-request/keq/commit/1b16142e84f08a7b5c300ba69f5c0036fdb1c9ef))
+
 ## [2.8.5](https://github.com/keq-request/keq/compare/v2.8.4...v2.8.5) (2024-10-25)
 
 

package/dist/esm/src/is/is-array-buffer.d.ts

@@ -0,0 +1 @@
+export declare function isArrayBuffer(body: any): body is ArrayBuffer;

package/dist/esm/src/is/is-array-buffer.js

@@ -0,0 +1,3 @@
+export function isArrayBuffer(body) {
+    return body instanceof ArrayBuffer;
+}

package/dist/esm/src/is/is-readable-stream.d.ts

@@ -0,0 +1 @@
+export declare function isReadableStream(body: any): body is ReadableStream;

package/dist/esm/src/is/is-readable-stream.js

@@ -0,0 +1,3 @@
+export function isReadableStream(body) {
+    return body instanceof ReadableStream;
+}

package/dist/esm/src/keq.js

@@ -12,6 +12,8 @@ import { mergeKeqRequestBody } from './util/merge-keq-request-body.js';
 import { base64Encode } from './util/base64.js';
 import { fixContentType } from './util/fix-content-type.js';
 import { isValidHeaderValue } from './util/is-valid-header-value.js';
+import { isReadableStream } from './is/is-readable-stream.js';
+import { isArrayBuffer } from './is/is-array-buffer.js';
 /**
  * @description Keq 扩展 API，人性化的常用的API
  */
@@ -124,6 +126,9 @@ export class Keq extends Core {
         else if (isFormData(value)) {
             this.setTypeIfEmpty('form-data');
         }
+        else if (isBlob(value) || isReadableStream(value) || isArrayBuffer(value)) {
+            // don't set content-type
+        }
         else if (typeof value === 'object') {
             this.setTypeIfEmpty('json');
         }

package/dist/esm/src/middlewares/fetch-arguments-middleware.js

@@ -1,6 +1,9 @@
 import { Exception } from '../exception/exception.js';
 import { ABORT_PROPERTY } from '../constant.js';
 import { isBuffer } from "../is/is-buffer.js";
+import { isBlob } from "../is/is-blob.js";
+import { isArrayBuffer } from "../is/is-array-buffer.js";
+import { isReadableStream } from "../is/is-readable-stream.js";
 function inferContentTypeByBody(body) {
     if (!body)
         return 'text/plain';
@@ -12,12 +15,29 @@ function compileBody(ctx) {
     const request = ctx.request;
     const body = request.body;
     const contentType = request.headers.get('Content-Type');
-    if (contentType === 'application/json' && body) {
+    if (body === undefined)
+        return;
+    if (body === null)
+        return 'null';
+    if (typeof body === 'string')
+        return body;
+    if (typeof body === 'number')
+        return String(body);
+    if (isBuffer(body))
+        return body;
+    if (isBlob(body))
+        return body;
+    if (isArrayBuffer(body))
+        return body;
+    if (isReadableStream(body))
+        return body;
+    if (contentType === 'application/json') {
         return typeof body === 'object' ? JSON.stringify(body) : body;
     }
-    else if (contentType === 'application/x-www-form-urlencoded' && body) {
-        if (Array.isArray(body))
-            return;
+    if (contentType === 'application/x-www-form-urlencoded') {
+        if (Array.isArray(body)) {
+            throw new Exception('application/x-www-form-urlencoded cannot send array');
+        }
         const params = new URLSearchParams();
         Object.entries(body).map(([key, value]) => {
             if (Array.isArray(value)) {
@@ -31,13 +51,10 @@ function compileBody(ctx) {
         });
         return params;
     }
-    else if (contentType === 'multipart/form-data') {
-        if (Array.isArray(ctx.request.body)) {
+    if (contentType === 'multipart/form-data') {
+        if (Array.isArray(body)) {
             throw new Exception('FormData cannot send array');
         }
-        if (!ctx.request.body)
-            return;
-        const body = ctx.request.body;
         const form = new FormData();
         for (const [key, value] of Object.entries(body)) {
             if (Array.isArray(value)) {
@@ -52,16 +69,8 @@ function compileBody(ctx) {
         request.headers.delete('content-type');
         return form;
     }
-    if (isBuffer(body))
-        return body;
-    if (body === undefined)
-        return body;
-    if (body === null)
-        return 'null';
-    if (typeof body === 'string')
-        return body;
-    if (typeof body === 'number')
-        return String(body);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return body;
 }
 export function fetchArgumentsMiddleware() {
     return async function fetchArgumentsMiddleware(ctx, next) {

package/dist/esm/src/util/merge-keq-request-body.js

@@ -1,6 +1,10 @@
+import { isBuffer } from "../is/is-buffer.js";
 import { Exception } from '../exception/exception.js';
 import { isFormData } from '../is/is-form-data.js';
 import { isUrlSearchParams } from '../is/is-url-search-params.js';
+import { isArrayBuffer } from "../is/is-array-buffer.js";
+import { isBlob } from "../is/is-blob.js";
+import { isReadableStream } from "../is/is-readable-stream.js";
 export function mergeKeqRequestBody(left, right) {
     if (right === undefined)
         return left;
@@ -9,6 +13,14 @@ export function mergeKeqRequestBody(left, right) {
     }
     if (left === null ||
         right === null ||
+        isBuffer(right) ||
+        isArrayBuffer(right) ||
+        isBlob(right) ||
+        isReadableStream(right) ||
+        isBuffer(left) ||
+        isArrayBuffer(left) ||
+        isBlob(left) ||
+        isReadableStream(left) ||
         Array.isArray(left) ||
         Array.isArray(right) ||
         (typeof left !== 'object' && left !== undefined) ||

package/dist/umd/src/is/is-array-buffer.d.ts

@@ -0,0 +1 @@
+export declare function isArrayBuffer(body: any): body is ArrayBuffer;

package/dist/umd/src/is/is-array-buffer.js

@@ -0,0 +1,17 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.isArrayBuffer = void 0;
+    function isArrayBuffer(body) {
+        return body instanceof ArrayBuffer;
+    }
+    exports.isArrayBuffer = isArrayBuffer;
+});

package/dist/umd/src/is/is-readable-stream.d.ts

@@ -0,0 +1 @@
+export declare function isReadableStream(body: any): body is ReadableStream;

package/dist/umd/src/is/is-readable-stream.js

@@ -0,0 +1,17 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.isReadableStream = void 0;
+    function isReadableStream(body) {
+        return body instanceof ReadableStream;
+    }
+    exports.isReadableStream = isReadableStream;
+});

package/dist/umd/src/keq.js

@@ -4,7 +4,7 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "./core.js", "./exception/exception.js", "./exception/invalid-arguments.exception.js", "./is/is-blob.js", "./is/is-file.js", "./is/is-form-data.js", "./is/is-headers.js", "./is/is-buffer.js", "./is/is-url-search-params.js", "./util/merge-keq-request-body.js", "./util/base64.js", "./util/fix-content-type.js", "./util/is-valid-header-value.js"], factory);
+        define(["require", "exports", "./core.js", "./exception/exception.js", "./exception/invalid-arguments.exception.js", "./is/is-blob.js", "./is/is-file.js", "./is/is-form-data.js", "./is/is-headers.js", "./is/is-buffer.js", "./is/is-url-search-params.js", "./util/merge-keq-request-body.js", "./util/base64.js", "./util/fix-content-type.js", "./util/is-valid-header-value.js", "./is/is-readable-stream.js", "./is/is-array-buffer.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -24,6 +24,8 @@
     const base64_js_1 = require("./util/base64.js");
     const fix_content_type_js_1 = require("./util/fix-content-type.js");
     const is_valid_header_value_js_1 = require("./util/is-valid-header-value.js");
+    const is_readable_stream_js_1 = require("./is/is-readable-stream.js");
+    const is_array_buffer_js_1 = require("./is/is-array-buffer.js");
     /**
      * @description Keq 扩展 API，人性化的常用的API
      */
@@ -136,6 +138,9 @@
             else if ((0, is_form_data_js_1.isFormData)(value)) {
                 this.setTypeIfEmpty('form-data');
             }
+            else if ((0, is_blob_js_1.isBlob)(value) || (0, is_readable_stream_js_1.isReadableStream)(value) || (0, is_array_buffer_js_1.isArrayBuffer)(value)) {
+                // don't set content-type
+            }
             else if (typeof value === 'object') {
                 this.setTypeIfEmpty('json');
             }

package/dist/umd/src/middlewares/fetch-arguments-middleware.js

@@ -4,7 +4,7 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "../exception/exception.js", "../constant.js", "../is/is-buffer.js"], factory);
+        define(["require", "exports", "../exception/exception.js", "../constant.js", "../is/is-buffer.js", "../is/is-blob.js", "../is/is-array-buffer.js", "../is/is-readable-stream.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -13,6 +13,9 @@
     const exception_js_1 = require("../exception/exception.js");
     const constant_js_1 = require("../constant.js");
     const is_buffer_js_1 = require("../is/is-buffer.js");
+    const is_blob_js_1 = require("../is/is-blob.js");
+    const is_array_buffer_js_1 = require("../is/is-array-buffer.js");
+    const is_readable_stream_js_1 = require("../is/is-readable-stream.js");
     function inferContentTypeByBody(body) {
         if (!body)
             return 'text/plain';
@@ -24,12 +27,29 @@
         const request = ctx.request;
         const body = request.body;
         const contentType = request.headers.get('Content-Type');
-        if (contentType === 'application/json' && body) {
+        if (body === undefined)
+            return;
+        if (body === null)
+            return 'null';
+        if (typeof body === 'string')
+            return body;
+        if (typeof body === 'number')
+            return String(body);
+        if ((0, is_buffer_js_1.isBuffer)(body))
+            return body;
+        if ((0, is_blob_js_1.isBlob)(body))
+            return body;
+        if ((0, is_array_buffer_js_1.isArrayBuffer)(body))
+            return body;
+        if ((0, is_readable_stream_js_1.isReadableStream)(body))
+            return body;
+        if (contentType === 'application/json') {
             return typeof body === 'object' ? JSON.stringify(body) : body;
         }
-        else if (contentType === 'application/x-www-form-urlencoded' && body) {
-            if (Array.isArray(body))
-                return;
+        if (contentType === 'application/x-www-form-urlencoded') {
+            if (Array.isArray(body)) {
+                throw new exception_js_1.Exception('application/x-www-form-urlencoded cannot send array');
+            }
             const params = new URLSearchParams();
             Object.entries(body).map(([key, value]) => {
                 if (Array.isArray(value)) {
@@ -43,13 +63,10 @@
             });
             return params;
         }
-        else if (contentType === 'multipart/form-data') {
-            if (Array.isArray(ctx.request.body)) {
+        if (contentType === 'multipart/form-data') {
+            if (Array.isArray(body)) {
                 throw new exception_js_1.Exception('FormData cannot send array');
             }
-            if (!ctx.request.body)
-                return;
-            const body = ctx.request.body;
             const form = new FormData();
             for (const [key, value] of Object.entries(body)) {
                 if (Array.isArray(value)) {
@@ -64,16 +81,8 @@
             request.headers.delete('content-type');
             return form;
         }
-        if ((0, is_buffer_js_1.isBuffer)(body))
-            return body;
-        if (body === undefined)
-            return body;
-        if (body === null)
-            return 'null';
-        if (typeof body === 'string')
-            return body;
-        if (typeof body === 'number')
-            return String(body);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return body;
     }
     function fetchArgumentsMiddleware() {
         return async function fetchArgumentsMiddleware(ctx, next) {

package/dist/umd/src/util/merge-keq-request-body.js

@@ -4,15 +4,19 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "../exception/exception.js", "../is/is-form-data.js", "../is/is-url-search-params.js"], factory);
+        define(["require", "exports", "../is/is-buffer.js", "../exception/exception.js", "../is/is-form-data.js", "../is/is-url-search-params.js", "../is/is-array-buffer.js", "../is/is-blob.js", "../is/is-readable-stream.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.mergeKeqRequestBody = void 0;
+    const is_buffer_js_1 = require("../is/is-buffer.js");
     const exception_js_1 = require("../exception/exception.js");
     const is_form_data_js_1 = require("../is/is-form-data.js");
     const is_url_search_params_js_1 = require("../is/is-url-search-params.js");
+    const is_array_buffer_js_1 = require("../is/is-array-buffer.js");
+    const is_blob_js_1 = require("../is/is-blob.js");
+    const is_readable_stream_js_1 = require("../is/is-readable-stream.js");
     function mergeKeqRequestBody(left, right) {
         if (right === undefined)
             return left;
@@ -21,6 +25,14 @@
         }
         if (left === null ||
             right === null ||
+            (0, is_buffer_js_1.isBuffer)(right) ||
+            (0, is_array_buffer_js_1.isArrayBuffer)(right) ||
+            (0, is_blob_js_1.isBlob)(right) ||
+            (0, is_readable_stream_js_1.isReadableStream)(right) ||
+            (0, is_buffer_js_1.isBuffer)(left) ||
+            (0, is_array_buffer_js_1.isArrayBuffer)(left) ||
+            (0, is_blob_js_1.isBlob)(left) ||
+            (0, is_readable_stream_js_1.isReadableStream)(left) ||
             Array.isArray(left) ||
             Array.isArray(right) ||
             (typeof left !== 'object' && left !== undefined) ||

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keq",
-  "version": "2.8.5",
+  "version": "2.8.6",
   "description": "Request API write by Typescript for flexibility, readability, and a low learning curve.",
   "keywords": [
     "request",

package/dist/esm/src/exception/overwrite-array-body.exception.d.ts

@@ -1,4 +0,0 @@
-import { Exception } from './exception.js';
-export declare class OverwriteArrayBodyException extends Exception {
-    constructor();
-}

package/dist/esm/src/exception/overwrite-array-body.exception.js

@@ -1,6 +0,0 @@
-import { Exception } from './exception.js';
-export class OverwriteArrayBodyException extends Exception {
-    constructor() {
-        super('Cannot merge or overwrite body, because it has been set as an array. Please use .body(arr) instead');
-    }
-}

package/dist/umd/src/exception/overwrite-array-body.exception.d.ts

@@ -1,4 +0,0 @@
-import { Exception } from './exception.js';
-export declare class OverwriteArrayBodyException extends Exception {
-    constructor();
-}

package/dist/umd/src/exception/overwrite-array-body.exception.js

@@ -1,20 +0,0 @@
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "./exception.js"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    exports.OverwriteArrayBodyException = void 0;
-    const exception_js_1 = require("./exception.js");
-    class OverwriteArrayBodyException extends exception_js_1.Exception {
-        constructor() {
-            super('Cannot merge or overwrite body, because it has been set as an array. Please use .body(arr) instead');
-        }
-    }
-    exports.OverwriteArrayBodyException = OverwriteArrayBodyException;
-});