keq 2.5.5 → 2.6.1

package/.node-version

@@ -0,0 +1 @@
+v20.13.1

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 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.6.1](https://github.com/keq-request/keq/compare/v2.6.0...v2.6.1) (2024-05-28)
+
+
+### Bug Fixes
+
+* body should not be set when undefined ([0674870](https://github.com/keq-request/keq/commit/0674870e3adade4f7c5e7e8209322d52b501b8ce))
+
+## [2.6.0](https://github.com/keq-request/keq/compare/v2.5.5...v2.6.0) (2024-05-28)
+
+
+### Features
+
+* use .on(eventName, listener) add event listener ([500ef14](https://github.com/keq-request/keq/commit/500ef140b513d614c3454d0e9023dd501e5d1ef6))
+
+
+### Bug Fixes
+
+* esm import syntax ([c312146](https://github.com/keq-request/keq/commit/c312146ffeb456bcfb1e0e6e2f2a3c8c773e6003))
+* the body is undeifned when send plain/text request ([ed24ba6](https://github.com/keq-request/keq/commit/ed24ba6f5ef3a565fb3eb6be496be09ed0fa40f9))
+
 ## [2.5.5](https://github.com/keq-request/keq/compare/v2.5.4...v2.5.5) (2024-05-26)
 
 

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

@@ -2,12 +2,14 @@ import { URL } from 'whatwg-url';
 import type { KeqContextOptions, KeqRequestContext } from './types/keq-context.js';
 import type { KeqMiddleware } from './types/keq-middleware.js';
 import type { KeqRequestInit } from './types/keq-request-init.js';
+import { KeqEvents, KeqListeners } from './types/keq-events.js';
 /**
  * @description Keq 核心 API，发送请求必要的原子化的API
  */
 export declare class Core<T> {
     private requestPromise?;
     protected requestContext: Omit<KeqRequestContext, 'abort'>;
+    protected __listeners__: KeqListeners;
     protected __global__: Record<string, any>;
     protected __prepend_middlewares__: KeqMiddleware[];
     protected __append_middlewares__: KeqMiddleware[];
@@ -15,6 +17,7 @@ export declare class Core<T> {
     constructor(url: (URL | globalThis.URL), init: KeqRequestInit, global?: Record<string, any>);
     prependMiddlewares(...middlewares: KeqMiddleware[]): this;
     appendMiddlewares(...middlewares: KeqMiddleware[]): this;
+    on<K extends keyof KeqEvents>(event: K, listener: (data: KeqEvents[K]) => void): this;
     private run;
     end(): Promise<T>;
     /**

package/dist/esm/src/core.js

@@ -11,6 +11,7 @@ import mitt from 'mitt';
 export class Core {
     requestPromise;
     requestContext;
+    __listeners__ = {};
     __global__;
     __prepend_middlewares__ = [];
     __append_middlewares__ = [];
@@ -37,6 +38,11 @@ export class Core {
         this.__append_middlewares__.unshift(...middlewares);
         return this;
     }
+    on(event, listener) {
+        this.__listeners__[event] = this.__listeners__[event] || [];
+        this.__listeners__[event].push(listener);
+        return this;
+    }
     async run() {
         const headers = new Headers();
         for (const [key, value] of this.requestContext.headers.entries()) {
@@ -59,6 +65,12 @@ export class Core {
         };
         const options = shadowClone(this.__options__);
         const emitter = mitt();
+        for (const eventName in this.__listeners__) {
+            const listeners = this.__listeners__[eventName];
+            for (const listener of listeners) {
+                emitter.on(eventName, listener);
+            }
+        }
         const ctx = {
             [NEXT_INVOKED_PROPERTY]: {
                 finished: false,

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

@@ -63,6 +63,16 @@ function compileBody(ctx) {
         request.headers.delete('content-type');
         return form;
     }
+    if (body instanceof Buffer)
+        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);
 }
 export function fetchArgumentsMiddleware() {
     return async function fetchArgumentsMiddleware(ctx, next) {

package/dist/esm/src/middlewares/retry-middleware.js

@@ -50,6 +50,8 @@ export function retryMiddleware() {
                 break;
             }
             const delay = await retryDelay(i, err, ctx);
+            ctx.retry = { attempt: i, error: err, delay };
+            ctx.emitter.emit('retry', ctx);
             if (delay > 0)
                 await sleep(delay);
         }

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

@@ -1,11 +1,11 @@
-import { URL } from 'whatwg-url';
-import { ABORT_PROPERTY, NEXT_INVOKED_PROPERTY, OUTPUT_PROPERTY } from "../constant";
-import { KeqRequestBody } from './keq-request-body';
-import { KeqRequestMethod } from './keq-request-method';
-import { KeqOptionsParameter } from './keq-options.js';
 import { Emitter } from 'mitt';
-import { KeqEvents } from './keq-events.js';
-import { KeqGlobal } from './keq-global.js';
+import { URL } from 'whatwg-url';
+import { ABORT_PROPERTY, NEXT_INVOKED_PROPERTY, OUTPUT_PROPERTY } from "../constant.js";
+import type { KeqRequestBody } from './keq-request-body.js';
+import type { KeqRequestMethod } from './keq-request-method.js';
+import type { KeqOptionsParameter } from './keq-options.js';
+import type { KeqEvents } from './keq-events.js';
+import type { KeqGlobal } from './keq-global.js';
 export interface KeqContextOptions extends KeqOptionsParameter {
     [key: string]: any;
 }
@@ -57,6 +57,12 @@ export interface KeqContext {
     [OUTPUT_PROPERTY]?: any;
     /** share data between requests */
     global: KeqGlobal;
+    /** retry information, undefined is no retry */
+    retry?: {
+        attempt: number;
+        error: unknown | null;
+        delay: number;
+    };
     /** extends by middleware */
     [key: string]: any;
 }

package/dist/esm/src/types/keq-context.js

@@ -1 +1 @@
-import { ABORT_PROPERTY, NEXT_INVOKED_PROPERTY, OUTPUT_PROPERTY } from "../constant";
+import { ABORT_PROPERTY, NEXT_INVOKED_PROPERTY, OUTPUT_PROPERTY } from "../constant.js";

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

@@ -1,4 +1,8 @@
-import { KeqContext } from './keq-context.js';
+import type { KeqContext } from './keq-context.js';
 export interface KeqEvents {
     fetch: KeqContext;
+    retry: KeqContext;
 }
+export type KeqListeners = {
+    [K in keyof KeqEvents]?: ((data: KeqEvents[K]) => void)[];
+};

package/dist/esm/src/types/keq-flow-control.d.ts

@@ -1,4 +1,4 @@
-import { KeqContext } from './keq-context.js';
+import type { KeqContext } from './keq-context.js';
 export interface KeqFlowControl {
     mode: 'abort' | 'serial';
     signal: string | ((ctx: KeqContext) => string);

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

@@ -1,5 +1,5 @@
-import { queueAsPromised } from 'fastq';
-import { KeqNext } from './keq-next.js';
+import type { queueAsPromised } from 'fastq';
+import type { KeqNext } from './keq-next.js';
 export interface KeqGlobal {
     abortFlowControl?: Record<string, ((reason: any) => void) | undefined>;
     serialFlowControl?: Record<string, queueAsPromised<KeqNext, void>>;

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

@@ -1,3 +1,3 @@
-import { KeqContext } from './keq-context';
-import { KeqNext } from './keq-next';
+import type { KeqContext } from './keq-context.js';
+import type { KeqNext } from './keq-next.js';
 export type KeqMiddleware = (ctx: KeqContext, next: KeqNext) => Promise<void>;

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

@@ -1,9 +1,9 @@
-import { Keq } from "../keq.js";
-import { KeqFlowControl } from './keq-flow-control.js';
-import { KeqResolveMethod } from './keq-resolve-with-mode.js';
-import { KeqRetryDelay } from './keq-retry-delay';
-import { KeqRetryOn } from './keq-retry-on';
-import { KeqTimeout } from './keq-timeout.js';
+import type { Keq } from "../keq.js";
+import type { KeqFlowControl } from './keq-flow-control.js';
+import type { KeqResolveMethod } from './keq-resolve-with-mode.js';
+import type { KeqRetryDelay } from './keq-retry-delay.js';
+import type { KeqRetryOn } from './keq-retry-on.js';
+import type { KeqTimeout } from './keq-timeout.js';
 export interface KeqOptions<T> {
     /**
      * replace the default fetch api

package/dist/esm/src/types/keq-request-init.d.ts

@@ -1,2 +1,2 @@
-import { KeqRequestContext } from './keq-context';
+import type { KeqRequestContext } from './keq-context.js';
 export type KeqRequestInit = Partial<Omit<KeqRequestContext, 'url'>>;

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

@@ -1,8 +1,8 @@
-import { URL } from 'whatwg-url';
-import { Keq } from "../keq.js";
-import { KeqRouter } from "../router/keq-router.js";
-import { KeqMiddleware } from './keq-middleware';
-import { KeqRequestInit } from './keq-request-init';
+import type { URL } from 'whatwg-url';
+import type { KeqRouter } from "../router/keq-router.js";
+import type { Keq } from "../keq.js";
+import type { KeqMiddleware } from './keq-middleware.js';
+import type { KeqRequestInit } from './keq-request-init.js';
 type KeqRequestFn = <T = any>(url: string | URL | globalThis.URL) => Keq<T>;
 type GlobalURL = globalThis.URL;
 export interface KeqRequest {

package/dist/esm/src/types/keq-retry-delay.d.ts

@@ -1,2 +1,2 @@
-import { KeqContext } from './keq-context';
+import type { KeqContext } from './keq-context';
 export type KeqRetryDelay = number | ((attempt: number, error: unknown | null, ctx: KeqContext) => number | Promise<number>);

package/dist/esm/src/types/keq-retry-on.d.ts

@@ -1,2 +1,2 @@
-import { KeqContext } from './keq-context';
+import type { KeqContext } from './keq-context.js';
 export type KeqRetryOn = (attempt: number, error: unknown | null, ctx: KeqContext) => (boolean | Promise<boolean>);

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

@@ -1,2 +1,2 @@
-import { KeqContext } from './keq-context.js';
+import type { KeqContext } from './keq-context.js';
 export type KeqRoute = (ctx: KeqContext) => Promise<boolean> | boolean;

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

@@ -2,12 +2,14 @@ import { URL } from 'whatwg-url';
 import type { KeqContextOptions, KeqRequestContext } from './types/keq-context.js';
 import type { KeqMiddleware } from './types/keq-middleware.js';
 import type { KeqRequestInit } from './types/keq-request-init.js';
+import { KeqEvents, KeqListeners } from './types/keq-events.js';
 /**
  * @description Keq 核心 API，发送请求必要的原子化的API
  */
 export declare class Core<T> {
     private requestPromise?;
     protected requestContext: Omit<KeqRequestContext, 'abort'>;
+    protected __listeners__: KeqListeners;
     protected __global__: Record<string, any>;
     protected __prepend_middlewares__: KeqMiddleware[];
     protected __append_middlewares__: KeqMiddleware[];
@@ -15,6 +17,7 @@ export declare class Core<T> {
     constructor(url: (URL | globalThis.URL), init: KeqRequestInit, global?: Record<string, any>);
     prependMiddlewares(...middlewares: KeqMiddleware[]): this;
     appendMiddlewares(...middlewares: KeqMiddleware[]): this;
+    on<K extends keyof KeqEvents>(event: K, listener: (data: KeqEvents[K]) => void): this;
     private run;
     end(): Promise<T>;
     /**

package/dist/umd/src/core.js

@@ -26,6 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     class Core {
         requestPromise;
         requestContext;
+        __listeners__ = {};
         __global__;
         __prepend_middlewares__ = [];
         __append_middlewares__ = [];
@@ -52,6 +53,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
             this.__append_middlewares__.unshift(...middlewares);
             return this;
         }
+        on(event, listener) {
+            this.__listeners__[event] = this.__listeners__[event] || [];
+            this.__listeners__[event].push(listener);
+            return this;
+        }
         async run() {
             const headers = new Headers();
             for (const [key, value] of this.requestContext.headers.entries()) {
@@ -74,6 +80,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
             };
             const options = (0, shadow_clone_js_1.shadowClone)(this.__options__);
             const emitter = (0, mitt_1.default)();
+            for (const eventName in this.__listeners__) {
+                const listeners = this.__listeners__[eventName];
+                for (const listener of listeners) {
+                    emitter.on(eventName, listener);
+                }
+            }
             const ctx = {
                 [constant_js_1.NEXT_INVOKED_PROPERTY]: {
                     finished: false,

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

@@ -75,6 +75,16 @@
             request.headers.delete('content-type');
             return form;
         }
+        if (body instanceof Buffer)
+            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);
     }
     function fetchArgumentsMiddleware() {
         return async function fetchArgumentsMiddleware(ctx, next) {

package/dist/umd/src/middlewares/retry-middleware.js

@@ -62,6 +62,8 @@
                     break;
                 }
                 const delay = await retryDelay(i, err, ctx);
+                ctx.retry = { attempt: i, error: err, delay };
+                ctx.emitter.emit('retry', ctx);
                 if (delay > 0)
                     await sleep(delay);
             }

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

@@ -1,11 +1,11 @@
-import { URL } from 'whatwg-url';
-import { ABORT_PROPERTY, NEXT_INVOKED_PROPERTY, OUTPUT_PROPERTY } from "../constant";
-import { KeqRequestBody } from './keq-request-body';
-import { KeqRequestMethod } from './keq-request-method';
-import { KeqOptionsParameter } from './keq-options.js';
 import { Emitter } from 'mitt';
-import { KeqEvents } from './keq-events.js';
-import { KeqGlobal } from './keq-global.js';
+import { URL } from 'whatwg-url';
+import { ABORT_PROPERTY, NEXT_INVOKED_PROPERTY, OUTPUT_PROPERTY } from "../constant.js";
+import type { KeqRequestBody } from './keq-request-body.js';
+import type { KeqRequestMethod } from './keq-request-method.js';
+import type { KeqOptionsParameter } from './keq-options.js';
+import type { KeqEvents } from './keq-events.js';
+import type { KeqGlobal } from './keq-global.js';
 export interface KeqContextOptions extends KeqOptionsParameter {
     [key: string]: any;
 }
@@ -57,6 +57,12 @@ export interface KeqContext {
     [OUTPUT_PROPERTY]?: any;
     /** share data between requests */
     global: KeqGlobal;
+    /** retry information, undefined is no retry */
+    retry?: {
+        attempt: number;
+        error: unknown | null;
+        delay: number;
+    };
     /** extends by middleware */
     [key: string]: any;
 }

package/dist/umd/src/types/keq-context.js

@@ -4,10 +4,10 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "../constant"], factory);
+        define(["require", "exports", "../constant.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    const constant_1 = require("../constant");
+    const constant_js_1 = require("../constant.js");
 });

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

@@ -1,4 +1,8 @@
-import { KeqContext } from './keq-context.js';
+import type { KeqContext } from './keq-context.js';
 export interface KeqEvents {
     fetch: KeqContext;
+    retry: KeqContext;
 }
+export type KeqListeners = {
+    [K in keyof KeqEvents]?: ((data: KeqEvents[K]) => void)[];
+};

package/dist/umd/src/types/keq-flow-control.d.ts

@@ -1,4 +1,4 @@
-import { KeqContext } from './keq-context.js';
+import type { KeqContext } from './keq-context.js';
 export interface KeqFlowControl {
     mode: 'abort' | 'serial';
     signal: string | ((ctx: KeqContext) => string);

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

@@ -1,5 +1,5 @@
-import { queueAsPromised } from 'fastq';
-import { KeqNext } from './keq-next.js';
+import type { queueAsPromised } from 'fastq';
+import type { KeqNext } from './keq-next.js';
 export interface KeqGlobal {
     abortFlowControl?: Record<string, ((reason: any) => void) | undefined>;
     serialFlowControl?: Record<string, queueAsPromised<KeqNext, void>>;

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

@@ -1,3 +1,3 @@
-import { KeqContext } from './keq-context';
-import { KeqNext } from './keq-next';
+import type { KeqContext } from './keq-context.js';
+import type { KeqNext } from './keq-next.js';
 export type KeqMiddleware = (ctx: KeqContext, next: KeqNext) => Promise<void>;

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

@@ -1,9 +1,9 @@
-import { Keq } from "../keq.js";
-import { KeqFlowControl } from './keq-flow-control.js';
-import { KeqResolveMethod } from './keq-resolve-with-mode.js';
-import { KeqRetryDelay } from './keq-retry-delay';
-import { KeqRetryOn } from './keq-retry-on';
-import { KeqTimeout } from './keq-timeout.js';
+import type { Keq } from "../keq.js";
+import type { KeqFlowControl } from './keq-flow-control.js';
+import type { KeqResolveMethod } from './keq-resolve-with-mode.js';
+import type { KeqRetryDelay } from './keq-retry-delay.js';
+import type { KeqRetryOn } from './keq-retry-on.js';
+import type { KeqTimeout } from './keq-timeout.js';
 export interface KeqOptions<T> {
     /**
      * replace the default fetch api

package/dist/umd/src/types/keq-request-init.d.ts

@@ -1,2 +1,2 @@
-import { KeqRequestContext } from './keq-context';
+import type { KeqRequestContext } from './keq-context.js';
 export type KeqRequestInit = Partial<Omit<KeqRequestContext, 'url'>>;

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

@@ -1,8 +1,8 @@
-import { URL } from 'whatwg-url';
-import { Keq } from "../keq.js";
-import { KeqRouter } from "../router/keq-router.js";
-import { KeqMiddleware } from './keq-middleware';
-import { KeqRequestInit } from './keq-request-init';
+import type { URL } from 'whatwg-url';
+import type { KeqRouter } from "../router/keq-router.js";
+import type { Keq } from "../keq.js";
+import type { KeqMiddleware } from './keq-middleware.js';
+import type { KeqRequestInit } from './keq-request-init.js';
 type KeqRequestFn = <T = any>(url: string | URL | globalThis.URL) => Keq<T>;
 type GlobalURL = globalThis.URL;
 export interface KeqRequest {

package/dist/umd/src/types/keq-retry-delay.d.ts

@@ -1,2 +1,2 @@
-import { KeqContext } from './keq-context';
+import type { KeqContext } from './keq-context';
 export type KeqRetryDelay = number | ((attempt: number, error: unknown | null, ctx: KeqContext) => number | Promise<number>);

package/dist/umd/src/types/keq-retry-on.d.ts

@@ -1,2 +1,2 @@
-import { KeqContext } from './keq-context';
+import type { KeqContext } from './keq-context.js';
 export type KeqRetryOn = (attempt: number, error: unknown | null, ctx: KeqContext) => (boolean | Promise<boolean>);

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

@@ -1,2 +1,2 @@
-import { KeqContext } from './keq-context.js';
+import type { KeqContext } from './keq-context.js';
 export type KeqRoute = (ctx: KeqContext) => Promise<boolean> | boolean;

package/package.json

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