keq 2.8.10 → 3.0.0-alpha.1

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.11](https://github.com/keq-request/keq/compare/v2.8.10...v2.8.11) (2025-06-05)
+
+
+### Bug Fixes
+
+* ensure proper cleanup of abort flow control function ([fc5ad5e](https://github.com/keq-request/keq/commit/fc5ad5ea34a1fcbd83a65f4906750113a424780d))
+
 ## [2.8.10](https://github.com/keq-request/keq/compare/v2.8.9...v2.8.10) (2024-12-26)
 
 

package/dist/esm/src/core.js

@@ -105,6 +105,22 @@ export class Core {
                 }
             },
         };
+        Object.defineProperty(ctx, 'identifier', {
+            value: this.__identifier__,
+            writable: false,
+        });
+        Object.defineProperty(ctx, 'request', {
+            value: requestContext,
+            writable: false,
+        });
+        Object.defineProperty(ctx, 'emitter', {
+            value: emitter,
+            writable: false,
+        });
+        Object.defineProperty(ctx, 'global', {
+            value: this.__global__,
+            writable: false,
+        });
         const middleware = composeMiddleware([...this.__prepend_middlewares__, ...this.__append_middlewares__]);
         await middleware(ctx, async function emptyNext() { });
         const output = ctx[OUTPUT_PROPERTY];

package/dist/esm/src/keq.d.ts

@@ -5,11 +5,11 @@ import { KeqFlowControlMode, KeqFlowControlSignal } from './types/keq-flow-contr
 import type { KeqRetryOn, KeqRetryDelay } from './types/keq-retry.js';
 import type { KeqMiddleware } from './types/keq-middleware.js';
 import type { KeqOptionsParameter, KeqOptionsReturnType } from './types/keq-options.js';
-import type { KeqQueryValue } from './types/keq-query-value.js';
 import type { CommonContentType, ShorthandContentType } from './types/content-type.js';
 import type { KeqContextOptions } from './types/keq-context.js';
 import type { ExtractFields, ExtractFiles, KeqBaseOperation, KeqOperation } from './types/keq-operation.js';
 import type { KeqContextRequestBody } from './types/keq-context-request.js';
+import { KeqQueryObject, KeqQueryValue } from './types/keq-query-value.js';
 /**
  * @description Keq 扩展 API，人性化的常用的API
  */
@@ -34,8 +34,8 @@ export declare class Keq<OUTPUT, OPERATION extends Omit<KeqOperation, 'responseB
      */
     query<K extends 'strict'>(key: OPERATION['requestQuery']): this;
     query<K extends 'strict', T extends keyof OPERATION['requestQuery']>(key: T, value: OPERATION['requestQuery'][T]): this;
-    query(key: Record<string, KeqQueryValue | KeqQueryValue[]>): this;
-    query(key: string, value: KeqQueryValue | KeqQueryValue[]): this;
+    query(key: KeqQueryObject): this;
+    query(key: string, value: KeqQueryValue): this;
     /**
      * Set request route params
      */

package/dist/esm/src/keq.js

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import qs from 'qs';
 import { Core } from './core.js';
 import { Exception } from './exception/exception.js';
 import { InvalidArgumentsExceptions } from './exception/invalid-arguments.exception.js';
@@ -15,6 +16,7 @@ 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';
+import { isObject } from './is/is-object.js';
 /**
  * @description Keq 扩展 API，人性化的常用的API
  */
@@ -55,29 +57,17 @@ export class Keq extends Core {
         return this;
     }
     query(key, value) {
-        if (typeof key === 'object') {
-            for (const [k, v] of Object.entries(key)) {
-                if (v === undefined)
-                    continue;
-                this.query(k, v);
+        if (isObject(key)) {
+            const obj = qs.parse(qs.stringify(key, { encode: false, arrayFormat: 'brackets' }), { depth: 0 });
+            for (const [k, v] of Object.entries(obj)) {
+                for (const item of Array.isArray(v) ? v : [v]) {
+                    this.requestContext.url.searchParams.append(k, item);
+                }
             }
             return this;
         }
         if (typeof key === 'string') {
-            if (Array.isArray(value)) {
-                for (const item of value) {
-                    this.query(key, item);
-                }
-            }
-            else if (typeof value === 'string' || typeof value === 'number' || typeof value === 'bigint') {
-                this.requestContext.url.searchParams.append(key, String(value));
-            }
-            else if (value === 'undefined' || value === null || value === undefined) {
-                // skip
-            }
-            else {
-                console.warn(`query value type(${typeof value}) is invalid, key: ${key}`);
-            }
+            this.query({ [key]: value });
             return this;
         }
         throw new TypeError('typeof key is invalid');
@@ -92,7 +82,7 @@ export class Keq extends Core {
             }
         }
         else {
-            throw new Exception('please set params value');
+            throw new TypeError('Invalid Arguments for .params()');
         }
         return this;
     }

package/dist/esm/src/middlewares/abort-flow-control-middleware.js

@@ -13,12 +13,15 @@ export function abortFlowControlMiddleware() {
             const reason = new DOMException('The previous request was not completed, so keq flowControl abort this request.', 'AbortError');
             abort(reason);
         }
-        ctx.global.abortFlowControl[key] = ctx.abort.bind(ctx);
+        const fn = ctx.abort.bind(ctx);
+        ctx.global.abortFlowControl[key] = fn;
         try {
             await next();
         }
         finally {
-            ctx.global.abortFlowControl[key] = undefined;
+            if (ctx.global.abortFlowControl[key] === fn) {
+                ctx.global.abortFlowControl[key] = undefined;
+            }
         }
     };
 }

package/dist/esm/src/types/keq-context.d.ts

@@ -51,16 +51,6 @@ export interface KeqContext {
      * share data between requests
      */
     readonly global: KeqGlobal;
-    /**
-     * retry information, undefined is no retry
-     *
-     * @deprecated
-     */
-    retry?: {
-        attempt: number;
-        error: unknown | null;
-        delay: number;
-    };
     /**
      * Fetch API Arguments
      */

package/dist/esm/src/types/keq-operation.d.ts

@@ -2,13 +2,12 @@
 /// <reference types="node" />
 import { ExtractProperty } from './extract-property.js';
 import { KeqContextRequestMethod } from './keq-context-request.js';
+import { KeqQueryObject } from './keq-query-value.js';
 export interface KeqOperation {
     requestParams: {
         [key: string]: string | number;
     };
-    requestQuery: {
-        [key: string]: string | string[] | number;
-    };
+    requestQuery: KeqQueryObject;
     requestHeaders: {
         [key: string]: string | number;
     };
@@ -32,9 +31,7 @@ export interface KeqBaseOperation extends KeqOperation {
     requestParams: {
         [key: string]: string;
     };
-    requestQuery: {
-        [key: string]: string | string[];
-    };
+    requestQuery: KeqQueryObject;
     requestHeaders: {
         'content-type': string;
         cookie: string;

package/dist/esm/src/types/keq-query-value.d.ts

@@ -1 +1,6 @@
-export type KeqQueryValue = string | number | bigint | undefined;
+export type KeqQueryPrimitive = string | number | null | bigint | undefined;
+export type KeqQueryObject = {
+    [Key in string]: KeqQueryValue | undefined;
+};
+export type KeqQueryArray = KeqQueryValue[];
+export type KeqQueryValue = KeqQueryPrimitive | KeqQueryArray | KeqQueryObject;

package/dist/esm/src/util/compile-url.js

@@ -2,15 +2,15 @@ function compilePathnameTemplate(template, params) {
     return template
         .replace(/(^|\/)(?::([^/]+)|{([^/]+)}|%7B([^/]+)%7D)(?=$|\/)/g, (_, prefix, group1, group2, group3) => {
         if (group1 && params[group1]) {
-            return `${prefix}${encodeURIComponent(params[group1])}`;
+            return `${prefix}${params[group1]}`;
         }
         else if (group2 && params[group2]) {
-            return `${prefix}${encodeURIComponent(params[group2])}`;
+            return `${prefix}${params[group2]}`;
         }
         else if (group3 && params[group3]) {
-            return `${prefix}${encodeURIComponent(params[group3])}`;
+            return `${prefix}${params[group3]}`;
         }
-        return _;
+        return '';
     });
 }
 export function compileUrl(obj, routeParams) {

package/dist/umd/src/core.js

@@ -120,6 +120,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
                     }
                 },
             };
+            Object.defineProperty(ctx, 'identifier', {
+                value: this.__identifier__,
+                writable: false,
+            });
+            Object.defineProperty(ctx, 'request', {
+                value: requestContext,
+                writable: false,
+            });
+            Object.defineProperty(ctx, 'emitter', {
+                value: emitter,
+                writable: false,
+            });
+            Object.defineProperty(ctx, 'global', {
+                value: this.__global__,
+                writable: false,
+            });
             const middleware = (0, compose_middleware_js_1.composeMiddleware)([...this.__prepend_middlewares__, ...this.__append_middlewares__]);
             await middleware(ctx, async function emptyNext() { });
             const output = ctx[constant_js_1.OUTPUT_PROPERTY];

package/dist/umd/src/keq.d.ts

@@ -5,11 +5,11 @@ import { KeqFlowControlMode, KeqFlowControlSignal } from './types/keq-flow-contr
 import type { KeqRetryOn, KeqRetryDelay } from './types/keq-retry.js';
 import type { KeqMiddleware } from './types/keq-middleware.js';
 import type { KeqOptionsParameter, KeqOptionsReturnType } from './types/keq-options.js';
-import type { KeqQueryValue } from './types/keq-query-value.js';
 import type { CommonContentType, ShorthandContentType } from './types/content-type.js';
 import type { KeqContextOptions } from './types/keq-context.js';
 import type { ExtractFields, ExtractFiles, KeqBaseOperation, KeqOperation } from './types/keq-operation.js';
 import type { KeqContextRequestBody } from './types/keq-context-request.js';
+import { KeqQueryObject, KeqQueryValue } from './types/keq-query-value.js';
 /**
  * @description Keq 扩展 API，人性化的常用的API
  */
@@ -34,8 +34,8 @@ export declare class Keq<OUTPUT, OPERATION extends Omit<KeqOperation, 'responseB
      */
     query<K extends 'strict'>(key: OPERATION['requestQuery']): this;
     query<K extends 'strict', T extends keyof OPERATION['requestQuery']>(key: T, value: OPERATION['requestQuery'][T]): this;
-    query(key: Record<string, KeqQueryValue | KeqQueryValue[]>): this;
-    query(key: string, value: KeqQueryValue | KeqQueryValue[]): this;
+    query(key: KeqQueryObject): this;
+    query(key: string, value: KeqQueryValue): this;
     /**
      * Set request route params
      */

package/dist/umd/src/keq.js

@@ -1,10 +1,13 @@
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 (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", "./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);
+        define(["require", "exports", "qs", "./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", "./is/is-object.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -12,6 +15,7 @@
     exports.Keq = void 0;
     /* eslint-disable @typescript-eslint/no-unused-vars */
     /* eslint-disable @typescript-eslint/no-explicit-any */
+    const qs_1 = __importDefault(require("qs"));
     const core_js_1 = require("./core.js");
     const exception_js_1 = require("./exception/exception.js");
     const invalid_arguments_exception_js_1 = require("./exception/invalid-arguments.exception.js");
@@ -27,6 +31,7 @@
     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");
+    const is_object_js_1 = require("./is/is-object.js");
     /**
      * @description Keq 扩展 API，人性化的常用的API
      */
@@ -67,29 +72,17 @@
             return this;
         }
         query(key, value) {
-            if (typeof key === 'object') {
-                for (const [k, v] of Object.entries(key)) {
-                    if (v === undefined)
-                        continue;
-                    this.query(k, v);
+            if ((0, is_object_js_1.isObject)(key)) {
+                const obj = qs_1.default.parse(qs_1.default.stringify(key, { encode: false, arrayFormat: 'brackets' }), { depth: 0 });
+                for (const [k, v] of Object.entries(obj)) {
+                    for (const item of Array.isArray(v) ? v : [v]) {
+                        this.requestContext.url.searchParams.append(k, item);
+                    }
                 }
                 return this;
             }
             if (typeof key === 'string') {
-                if (Array.isArray(value)) {
-                    for (const item of value) {
-                        this.query(key, item);
-                    }
-                }
-                else if (typeof value === 'string' || typeof value === 'number' || typeof value === 'bigint') {
-                    this.requestContext.url.searchParams.append(key, String(value));
-                }
-                else if (value === 'undefined' || value === null || value === undefined) {
-                    // skip
-                }
-                else {
-                    console.warn(`query value type(${typeof value}) is invalid, key: ${key}`);
-                }
+                this.query({ [key]: value });
                 return this;
             }
             throw new TypeError('typeof key is invalid');
@@ -104,7 +97,7 @@
                 }
             }
             else {
-                throw new exception_js_1.Exception('please set params value');
+                throw new TypeError('Invalid Arguments for .params()');
             }
             return this;
         }

package/dist/umd/src/middlewares/abort-flow-control-middleware.js

@@ -25,12 +25,15 @@
                 const reason = new DOMException('The previous request was not completed, so keq flowControl abort this request.', 'AbortError');
                 abort(reason);
             }
-            ctx.global.abortFlowControl[key] = ctx.abort.bind(ctx);
+            const fn = ctx.abort.bind(ctx);
+            ctx.global.abortFlowControl[key] = fn;
             try {
                 await next();
             }
             finally {
-                ctx.global.abortFlowControl[key] = undefined;
+                if (ctx.global.abortFlowControl[key] === fn) {
+                    ctx.global.abortFlowControl[key] = undefined;
+                }
             }
         };
     }

package/dist/umd/src/types/keq-context.d.ts

@@ -51,16 +51,6 @@ export interface KeqContext {
      * share data between requests
      */
     readonly global: KeqGlobal;
-    /**
-     * retry information, undefined is no retry
-     *
-     * @deprecated
-     */
-    retry?: {
-        attempt: number;
-        error: unknown | null;
-        delay: number;
-    };
     /**
      * Fetch API Arguments
      */

package/dist/umd/src/types/keq-operation.d.ts

@@ -2,13 +2,12 @@
 /// <reference types="node" />
 import { ExtractProperty } from './extract-property.js';
 import { KeqContextRequestMethod } from './keq-context-request.js';
+import { KeqQueryObject } from './keq-query-value.js';
 export interface KeqOperation {
     requestParams: {
         [key: string]: string | number;
     };
-    requestQuery: {
-        [key: string]: string | string[] | number;
-    };
+    requestQuery: KeqQueryObject;
     requestHeaders: {
         [key: string]: string | number;
     };
@@ -32,9 +31,7 @@ export interface KeqBaseOperation extends KeqOperation {
     requestParams: {
         [key: string]: string;
     };
-    requestQuery: {
-        [key: string]: string | string[];
-    };
+    requestQuery: KeqQueryObject;
     requestHeaders: {
         'content-type': string;
         cookie: string;

package/dist/umd/src/types/keq-query-value.d.ts

@@ -1 +1,6 @@
-export type KeqQueryValue = string | number | bigint | undefined;
+export type KeqQueryPrimitive = string | number | null | bigint | undefined;
+export type KeqQueryObject = {
+    [Key in string]: KeqQueryValue | undefined;
+};
+export type KeqQueryArray = KeqQueryValue[];
+export type KeqQueryValue = KeqQueryPrimitive | KeqQueryArray | KeqQueryObject;

package/dist/umd/src/util/compile-url.js

@@ -14,15 +14,15 @@
         return template
             .replace(/(^|\/)(?::([^/]+)|{([^/]+)}|%7B([^/]+)%7D)(?=$|\/)/g, (_, prefix, group1, group2, group3) => {
             if (group1 && params[group1]) {
-                return `${prefix}${encodeURIComponent(params[group1])}`;
+                return `${prefix}${params[group1]}`;
             }
             else if (group2 && params[group2]) {
-                return `${prefix}${encodeURIComponent(params[group2])}`;
+                return `${prefix}${params[group2]}`;
             }
             else if (group3 && params[group3]) {
-                return `${prefix}${encodeURIComponent(params[group3])}`;
+                return `${prefix}${params[group3]}`;
             }
-            return _;
+            return '';
         });
     }
     function compileUrl(obj, routeParams) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keq",
-  "version": "2.8.10",
+  "version": "3.0.0-alpha.1",
   "description": "Request API write by Typescript for flexibility, readability, and a low learning curve.",
   "keywords": [
     "request",
@@ -45,7 +45,9 @@
     "fastq": "^1.17.1",
     "minimatch": "^9.0.4",
     "mitt": "^3.0.1",
-    "ts-custom-error": "^3.3.1"
+    "qs": "^6.13.1",
+    "ts-custom-error": "^3.3.1",
+    "type-fest": "^4.30.2"
   },
   "devDependencies": {
     "@buka/eslint-config": "^2.1.1",
@@ -55,12 +57,14 @@
     "@types/clone": "^2.1.4",
     "@types/minimatch": "^5.1.2",
     "@types/node": "^20.14.1",
+    "@types/qs": "^6.9.17",
     "eslint": "^9.13.0",
     "husky": "^9.1.6",
     "is-ci": "^3.0.1",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-mock": "^29.7.0",
+    "semantic-release": "^24.2.8",
     "standard-version": "^9.5.0",
     "ts-jest": "^29.1.5",
     "ts-node": "^10.9.2",
@@ -68,8 +72,8 @@
     "typescript": "5.4.5",
     "typescript-transform-paths": "^3.5.1"
   },
-  "packageManager": "pnpm@9.15.1",
+  "packageManager": "pnpm@10.15.1+sha256.8c53af02ae3ec1fb0ae75377f8d4d6217c2d7cbe6f03c16350cabf7493de6eff",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   }
 }