keq 2.3.2 → 2.3.4

package/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 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.3.4](https://github.com/keq-request/keq/compare/v2.3.3...v2.3.4) (2024-05-14)
+
+
+### Bug Fixes
+
+* avoid repeatedly defining response causing errors to be throw ([fc4d0ab](https://github.com/keq-request/keq/commit/fc4d0abf47a35e894fb31f9284e4fa3947c99383))
+* missing typescript definition ([fff9046](https://github.com/keq-request/keq/commit/fff9046a5d10d264d4aeef918aaeb986056abd67))
+
+
+### Performance Improvements
+
+* baseOrigin(origin) return this ([d50773c](https://github.com/keq-request/keq/commit/d50773c00eeaf87850c1ee621dc75d920d6897ba))
+* use http://127.0.0.1 as baseOrigin in nodejs ([22f0202](https://github.com/keq-request/keq/commit/22f0202c21c83d128f86f9c0270b124018ce515d))
+
+## [2.3.3](https://github.com/keq-request/keq/compare/v2.3.2...v2.3.3) (2024-05-10)
+
+
+### Bug Fixes
+
+* the error thrown when the request timeout is not DOMException ([7c84d8f](https://github.com/keq-request/keq/commit/7c84d8fe40e26713d478d443fbdb9a9d71d99ba9))
+
+
+### Performance Improvements
+
+* upgrade dependencies ([090e244](https://github.com/keq-request/keq/commit/090e24449f055e185dde1d3972c8f5e9c637fb20))
+
 ## [2.3.2](https://github.com/keq-request/keq/compare/v2.3.1...v2.3.2) (2024-04-23)
 
 

package/README.md

@@ -556,6 +556,11 @@ const body = await customRequest.get("http://test.com");
 
 > The gloabl request instance is created by `request.create()` too.
 
+ option          | description
+:----------------|:---------------
+ initMiddlewares | `fetch`, `retry`, `flowController` are all implemented by middleware. you can customize the init middlewares to change behavior.
+ baseOrigin      | When sending a request without an `origin`, `origin` will set to `window.location.origin` in the browser and `"http://127.0.0.1"` in NodeJS.
+
 <!-- usage -->
 
 <!-- addition -->

package/dist/esm/src/core.js

@@ -71,7 +71,7 @@ export class Core {
         };
         const middleware = composeMiddleware([...this.__prepend_middlewares__, ...this.__append_middlewares__]);
         // eslint-disable-next-line @typescript-eslint/no-empty-function
-        await middleware(ctx, async () => { });
+        await middleware(ctx, async function emptyNext() { });
         const output = ctx[OUTPUT_PROPERTY];
         if (ctx.options.resolveWithFullResponse || ctx.options.resolveWith === 'response') {
             return ctx.response;

package/dist/esm/src/create-request.js

@@ -12,8 +12,14 @@ import { KeqRouter } from './router/keq-router.js';
 import { timeoutMiddleware } from './middlewares/timeout-middleware.js';
 export function createRequest(options) {
     let baseOrigin = options?.baseOrigin;
-    if (isBrowser() && !baseOrigin)
-        baseOrigin = location.origin;
+    if (!baseOrigin) {
+        if (isBrowser()) {
+            baseOrigin = location.origin;
+        }
+        else {
+            baseOrigin = 'http://127.0.0.1';
+        }
+    }
     const appendMiddlewares = options?.initMiddlewares ? [...options.initMiddlewares] : [
         serialFlowControlMiddleware(),
         abortFlowControlMiddleware(),
@@ -44,6 +50,7 @@ export function createRequest(options) {
     };
     request.baseOrigin = (origin) => {
         baseOrigin = origin;
+        return request;
     };
     request.useRouter = function useRouter() {
         return router;

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

@@ -1,5 +1,5 @@
 export function abortFlowControlMiddleware() {
-    return async (ctx, next) => {
+    return async function abortFlowControlMiddleware(ctx, next) {
         if (!ctx.options.flowControl || ctx.options.flowControl.mode !== 'abort') {
             await next();
             return;
@@ -15,7 +15,7 @@ export function abortFlowControlMiddleware() {
             ctx.global.abortFlowControl = {};
         if (ctx.global.abortFlowControl[key]) {
             const abortController = ctx.global.abortFlowControl[key];
-            abortController.abort('abort flow control');
+            abortController.abort(new DOMException('The previous request was not completed, so keq flowControl abort this request.', 'AbortError'));
         }
         const abortController = new AbortController();
         ctx.global.abortFlowControl[key] = abortController;

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

@@ -64,7 +64,7 @@ function compileBody(ctx) {
     }
 }
 export function fetchArgumentsMiddleware() {
-    return async (ctx, next) => {
+    return async function fetchArgumentsMiddleware(ctx, next) {
         const request = ctx.request;
         const url = compileUrl(request.url, request.routeParams);
         if (!request.headers.has('Content-Type') && request.body) {

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

@@ -3,7 +3,7 @@ import { Exception } from "../exception/exception";
  * Send Request
  */
 export function fetchMiddleware() {
-    return async (ctx) => {
+    return async function fetchMiddleware(ctx) {
         const fetchArguments = ctx.fetchArguments;
         if (!fetchArguments) {
             throw new Exception('fetchArguments is required');

package/dist/esm/src/middlewares/proxy-response-middleware.js

@@ -1,11 +1,11 @@
 export function proxyResponseMiddleware() {
-    return async (ctx, next) => {
+    return async function proxyResponseMiddleware(ctx, next) {
         await next();
         const res = ctx.res;
-        if (res) {
+        if (res && !('response' in ctx)) {
             Object.defineProperty(ctx, 'response', {
                 get() {
-                    return res.clone();
+                    return ctx.res?.clone();
                 },
             });
         }

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

@@ -2,7 +2,7 @@ function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
 export function retryMiddleware() {
-    return async (ctx, next) => {
+    return async function retryMiddleware(ctx, next) {
         const retryTimes = (Number(ctx.options.retryTimes) || 0) + 1;
         const retryDelay = ctx.options.retryDelay || 10;
         const retryOn = ctx.options.retryOn;

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

@@ -1,6 +1,6 @@
 import * as fastq from 'fastq';
 export function serialFlowControlMiddleware() {
-    return async (ctx, next) => {
+    return async function serialFlowControlMiddleware(ctx, next) {
         if (!ctx.options.flowControl || ctx.options.flowControl.mode !== 'serial') {
             await next();
             return;

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

@@ -1,5 +1,5 @@
 export function timeoutMiddleware() {
-    return async (ctx, next) => {
+    return async function timeoutMiddleware(ctx, next) {
         if (!ctx.options.timeout || ctx.options.timeout.millisecond <= 0) {
             await next();
             return;
@@ -11,9 +11,11 @@ export function timeoutMiddleware() {
         }
         const timeoutSignal = new AbortController();
         ctx.request.signal = timeoutSignal.signal;
+        const millisecond = ctx.options.timeout.millisecond;
         setTimeout(() => {
-            timeoutSignal.abort('timeout');
-        }, ctx.options.timeout.millisecond);
+            const err = new DOMException(`keq request timeout(${millisecond}ms)`, 'AbortError');
+            timeoutSignal.abort(err);
+        }, millisecond);
         await next();
     };
 }

package/dist/umd/src/core.js

@@ -83,7 +83,7 @@
             };
             const middleware = (0, compose_middleware_1.composeMiddleware)([...this.__prepend_middlewares__, ...this.__append_middlewares__]);
             // eslint-disable-next-line @typescript-eslint/no-empty-function
-            await middleware(ctx, async () => { });
+            await middleware(ctx, async function emptyNext() { });
             const output = ctx[constant_1.OUTPUT_PROPERTY];
             if (ctx.options.resolveWithFullResponse || ctx.options.resolveWith === 'response') {
                 return ctx.response;

package/dist/umd/src/create-request.js

@@ -24,8 +24,14 @@
     const timeout_middleware_js_1 = require("./middlewares/timeout-middleware.js");
     function createRequest(options) {
         let baseOrigin = options?.baseOrigin;
-        if ((0, is_browser_1.isBrowser)() && !baseOrigin)
-            baseOrigin = location.origin;
+        if (!baseOrigin) {
+            if ((0, is_browser_1.isBrowser)()) {
+                baseOrigin = location.origin;
+            }
+            else {
+                baseOrigin = 'http://127.0.0.1';
+            }
+        }
         const appendMiddlewares = options?.initMiddlewares ? [...options.initMiddlewares] : [
             (0, serial_flow_control_middleware_js_1.serialFlowControlMiddleware)(),
             (0, abort_flow_control_middleware_js_1.abortFlowControlMiddleware)(),
@@ -56,6 +62,7 @@
         };
         request.baseOrigin = (origin) => {
             baseOrigin = origin;
+            return request;
         };
         request.useRouter = function useRouter() {
             return router;

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

@@ -11,7 +11,7 @@
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.abortFlowControlMiddleware = void 0;
     function abortFlowControlMiddleware() {
-        return async (ctx, next) => {
+        return async function abortFlowControlMiddleware(ctx, next) {
             if (!ctx.options.flowControl || ctx.options.flowControl.mode !== 'abort') {
                 await next();
                 return;
@@ -27,7 +27,7 @@
                 ctx.global.abortFlowControl = {};
             if (ctx.global.abortFlowControl[key]) {
                 const abortController = ctx.global.abortFlowControl[key];
-                abortController.abort('abort flow control');
+                abortController.abort(new DOMException('The previous request was not completed, so keq flowControl abort this request.', 'AbortError'));
             }
             const abortController = new AbortController();
             ctx.global.abortFlowControl[key] = abortController;

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

@@ -76,7 +76,7 @@
         }
     }
     function fetchArgumentsMiddleware() {
-        return async (ctx, next) => {
+        return async function fetchArgumentsMiddleware(ctx, next) {
             const request = ctx.request;
             const url = compileUrl(request.url, request.routeParams);
             if (!request.headers.has('Content-Type') && request.body) {

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

@@ -15,7 +15,7 @@
      * Send Request
      */
     function fetchMiddleware() {
-        return async (ctx) => {
+        return async function fetchMiddleware(ctx) {
             const fetchArguments = ctx.fetchArguments;
             if (!fetchArguments) {
                 throw new exception_1.Exception('fetchArguments is required');

package/dist/umd/src/middlewares/proxy-response-middleware.js

@@ -11,13 +11,13 @@
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.proxyResponseMiddleware = void 0;
     function proxyResponseMiddleware() {
-        return async (ctx, next) => {
+        return async function proxyResponseMiddleware(ctx, next) {
             await next();
             const res = ctx.res;
-            if (res) {
+            if (res && !('response' in ctx)) {
                 Object.defineProperty(ctx, 'response', {
                     get() {
-                        return res.clone();
+                        return ctx.res?.clone();
                     },
                 });
             }

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

@@ -14,7 +14,7 @@
         return new Promise((resolve) => setTimeout(resolve, ms));
     }
     function retryMiddleware() {
-        return async (ctx, next) => {
+        return async function retryMiddleware(ctx, next) {
             const retryTimes = (Number(ctx.options.retryTimes) || 0) + 1;
             const retryDelay = ctx.options.retryDelay || 10;
             const retryOn = ctx.options.retryOn;

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

@@ -35,7 +35,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     exports.serialFlowControlMiddleware = void 0;
     const fastq = __importStar(require("fastq"));
     function serialFlowControlMiddleware() {
-        return async (ctx, next) => {
+        return async function serialFlowControlMiddleware(ctx, next) {
             if (!ctx.options.flowControl || ctx.options.flowControl.mode !== 'serial') {
                 await next();
                 return;

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

@@ -11,7 +11,7 @@
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.timeoutMiddleware = void 0;
     function timeoutMiddleware() {
-        return async (ctx, next) => {
+        return async function timeoutMiddleware(ctx, next) {
             if (!ctx.options.timeout || ctx.options.timeout.millisecond <= 0) {
                 await next();
                 return;
@@ -23,9 +23,11 @@
             }
             const timeoutSignal = new AbortController();
             ctx.request.signal = timeoutSignal.signal;
+            const millisecond = ctx.options.timeout.millisecond;
             setTimeout(() => {
-                timeoutSignal.abort('timeout');
-            }, ctx.options.timeout.millisecond);
+                const err = new DOMException(`keq request timeout(${millisecond}ms)`, 'AbortError');
+                timeoutSignal.abort(err);
+            }, millisecond);
             await next();
         };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keq",
-  "version": "2.3.2",
+  "version": "2.3.4",
   "description": "Request API write by Typescript for flexibility, readability, and a low learning curve.",
   "keywords": [
     "request",
@@ -40,25 +40,25 @@
     "test": "jest"
   },
   "dependencies": {
+    "@types/whatwg-url": "^11.0.4",
     "clone": "^2.1.2",
     "fastq": "^1.17.1",
-    "minimatch": "^9.0.3",
-    "object.fromentries": "^2.0.7",
+    "minimatch": "^9.0.4",
+    "object.fromentries": "^2.0.8",
     "ts-custom-error": "^3.3.1",
     "whatwg-url": "^14.0.0"
   },
   "devDependencies": {
-    "@buka/eslint-config": "^1.6.0",
-    "@commitlint/cli": "^18.6.1",
-    "@commitlint/config-conventional": "^18.6.2",
+    "@buka/eslint-config": "^1.6.4",
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
     "@jest/globals": "^29.7.0",
-    "@rushstack/eslint-patch": "^1.7.2",
+    "@rushstack/eslint-patch": "^1.10.2",
     "@types/clone": "^2.1.4",
     "@types/minimatch": "^5.1.2",
-    "@types/node": "^20.11.20",
-    "@types/whatwg-url": "^11.0.4",
-    "@typescript-eslint/eslint-plugin": "^7.0.2",
-    "@typescript-eslint/parser": "^7.0.2",
+    "@types/node": "^20.12.7",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
     "eslint": "^8.57.0",
     "husky": "^9.0.11",
     "is-ci": "^3.0.1",
@@ -68,7 +68,7 @@
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "ts-patch": "^3.1.2",
-    "typescript": "^5.3.3",
+    "typescript": "^5.4.5",
     "typescript-transform-paths": "^3.4.7"
   },
   "packageManager": "pnpm@8.6.4",