keq 2.6.10 → 2.7.1

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.7.1](https://github.com/keq-request/keq/compare/v2.7.0...v2.7.1) (2024-07-20)
+
+
+### Performance Improvements
+
+* remove whatwg-url because mosts browsers had support ([6877d79](https://github.com/keq-request/keq/commit/6877d79e95721ea76adcf54013c1909b0dec98a3))
+
+## [2.7.0](https://github.com/keq-request/keq/compare/v2.6.10...v2.7.0) (2024-07-05)
+
+
+### Features
+
+* add ctx.request.__url__ that return a url merged routeParams ([896c029](https://github.com/keq-request/keq/commit/896c0293e8a0bd0243cd81b780ea2f9e09cbfeea))
+
+
+### Bug Fixes
+
+* the default parameter of KeqRequest ([d7939d2](https://github.com/keq-request/keq/commit/d7939d2f2e1f79e719db3c663658c05586be10cf))
+
 ## [2.6.10](https://github.com/keq-request/keq/compare/v2.6.9...v2.6.10) (2024-06-27)
 
 

package/README.md

@@ -508,6 +508,7 @@ Keq's context object has many parameters. The following lists all the built-in c
 | :------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `context.request`                | Includes request options for [Fetch API][Fetch MDN].                                                                                                                                                                              |
 | `context.request.url`            | [URL][URL MDN] Class                                                                                                                                                                                                              |
+| `context.request.__url__`            | Readonly [URL][URL MDN] Class that merged routeParams                                                                                                                                                                                                              |
 | `context.request.method`         | One of 'get', 'post', 'put', 'patch', 'head', 'delete'.                                                                                                                                                                           |
 | `context.request.body`           | Object, Array, string or undefined.                                                                                                                                                                                               |
 | `context.request.headers`        | The [`Headers`][Headers MDN] Object.                                                                                                                                                                                              |

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

@@ -1,4 +1,3 @@
-import { URL } from 'whatwg-url';
 import type { KeqContextOptions } from './types/keq-context.js';
 import type { KeqMiddleware } from './types/keq-middleware.js';
 import type { KeqInit } from './types/keq-init.js';
@@ -9,13 +8,13 @@ import type { KeqContextRequest } from './types/keq-context-request.js';
  */
 export declare class Core<OUTPUT> {
     private requestPromise?;
-    protected requestContext: Omit<KeqContextRequest, 'abort'>;
+    protected requestContext: Omit<KeqContextRequest, 'abort' | '__url__'>;
     protected __listeners__: KeqListeners;
     protected __global__: Record<string, any>;
     protected __prepend_middlewares__: KeqMiddleware[];
     protected __append_middlewares__: KeqMiddleware[];
     protected __options__: KeqContextOptions;
-    constructor(url: (URL | globalThis.URL), init: KeqInit, global?: Record<string, any>);
+    constructor(url: URL, init: KeqInit, 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;

package/dist/esm/src/core.js

@@ -1,10 +1,10 @@
 import mitt from 'mitt';
-import { URL } from 'whatwg-url';
 import { Exception } from './exception/exception.js';
 import { cloneBody } from './util/clone-body.js';
 import { ABORT_PROPERTY, NEXT_INVOKED_PROPERTY, OUTPUT_PROPERTY } from './constant.js';
 import { composeMiddleware } from './util/compose-middleware.js';
 import { shallowClone } from './util/shallow-clone.js';
+import { compileUrl } from './util/compile-url.js';
 /**
  * @description Keq 核心 API，发送请求必要的原子化的API
  */
@@ -49,10 +49,13 @@ export class Core {
             headers.append(key, value);
         }
         const requestContext = {
-            method: this.requestContext.method,
             url: new URL(this.requestContext.url.href),
-            headers,
             routeParams: shallowClone(this.requestContext.routeParams),
+            get __url__() {
+                return compileUrl(this.url, this.routeParams);
+            },
+            method: this.requestContext.method,
+            headers,
             body: cloneBody(this.requestContext.body),
             cache: this.requestContext.cache,
             credentials: this.requestContext.credentials,

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

@@ -1,5 +1,4 @@
 /* eslint-disable @typescript-eslint/no-unsafe-return */
-import { URL } from 'whatwg-url';
 import { isBrowser } from './is/is-browser.js';
 import { Keq } from './keq.js';
 import { abortFlowControlMiddleware } from './middlewares/abort-flow-control-middleware.js';

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

@@ -1,18 +1,6 @@
-import { URL } from 'whatwg-url';
 import { Exception } from '../exception/exception.js';
-import { compilePathnameTemplate } from '../util/compile-pathname-template.js';
 import { ABORT_PROPERTY } from '../constant.js';
 import { isBuffer } from "../is/is-buffer.js";
-function compileUrl(obj, routeParams) {
-    const url = new URL(typeof obj === 'string' ? obj : obj.href);
-    try {
-        url.pathname = compilePathnameTemplate(url.pathname, routeParams);
-    }
-    catch (e) {
-        throw new Exception(`Cannot compile the params in ${url.pathname}, Because ${e?.message}.`);
-    }
-    return url.href;
-}
 function inferContentTypeByBody(body) {
     if (!body)
         return 'text/plain';
@@ -78,7 +66,7 @@ function compileBody(ctx) {
 export function fetchArgumentsMiddleware() {
     return async function fetchArgumentsMiddleware(ctx, next) {
         const request = ctx.request;
-        const url = compileUrl(request.url, request.routeParams);
+        const url = ctx.request.__url__.href;
         if (!request.headers.has('Content-Type') && request.body) {
             request.headers.set('Content-Type', inferContentTypeByBody(ctx.request.body));
         }

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

@@ -1,11 +1,11 @@
-import { URL } from 'whatwg-url';
 export type KeqContextRequestMethod = 'get' | 'post' | 'put' | 'delete' | 'head' | 'patch';
 export type KeqContextRequestBody = object | Array<any> | string | undefined;
 export interface KeqContextRequest {
-    url: URL | globalThis.URL;
+    url: URL;
+    routeParams: Record<string, string>;
+    readonly __url__: Readonly<URL>;
     method: KeqContextRequestMethod;
     headers: Headers;
-    routeParams: Record<string, string>;
     body: KeqContextRequestBody;
     cache?: RequestCache;
     credentials?: RequestCredentials;

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

@@ -1,26 +1,22 @@
 import { FlattenOperations, KeqOperation, KeqOperations } from './keq-operation.js';
-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 { KeqInit } from './keq-init.js';
-type GlobalURL = globalThis.URL;
 interface KeqRequestFn<OPERATIONS extends Record<string, KeqOperation>> {
     <Path extends keyof OPERATIONS>(url: Path): Keq<OPERATIONS[Path]['responseBody'], OPERATIONS[Path]>;
     <OUTPUT = any>(url: string): Keq<OUTPUT>;
     <OUTPUT = any>(url: URL): Keq<OUTPUT>;
-    <OUTPUT = any>(url: GlobalURL): Keq<OUTPUT>;
 }
 type PickKeqOperationsProperty<T extends KeqOperations, P extends keyof T, X extends keyof KeqOperation> = T extends {
     [Path in keyof T as Path extends P ? Path : never]: {
         [Method in keyof T[Path] as T[Path][Method] extends KeqOperation ? Method : never]: infer R;
     };
 } ? R extends KeqOperation ? R[X] : never : never;
-export interface KeqRequest<OPERATIONS extends KeqOperations> {
+export interface KeqRequest<OPERATIONS extends KeqOperations = KeqOperations> {
     <Path extends keyof OPERATIONS>(url: Path, init: Omit<KeqInit, 'global'>): Keq<Exclude<PickKeqOperationsProperty<OPERATIONS, Path, 'responseBody'>, undefined>>;
     <OUTPUT = any>(url: string, init: Omit<KeqInit, 'global'>): Keq<OUTPUT>;
     <OUTPUT = any>(url: URL, init: Omit<KeqInit, 'global'>): Keq<OUTPUT>;
-    <OUTPUT = any>(url: GlobalURL, init: Omit<KeqInit, 'global'>): Keq<OUTPUT>;
     baseOrigin: (baseOrigin: string) => void;
     get: KeqRequestFn<FlattenOperations<OPERATIONS, 'get'>>;
     post: KeqRequestFn<FlattenOperations<OPERATIONS, 'post'>>;

package/dist/esm/src/util/compile-url.d.ts

@@ -0,0 +1 @@
+export declare function compileUrl(obj: string | URL, routeParams: Record<string, string | number>): URL;

package/dist/esm/src/util/{compile-pathname-template.js → compile-url.js}

@@ -1,4 +1,4 @@
-export function compilePathnameTemplate(template, params) {
+function compilePathnameTemplate(template, params) {
     return template
         .replace(/(^|\/)(?::([^/]+)|{([^/]+)}|%7B([^/]+)%7D)(?=$|\/)/g, (_, prefix, group1, group2, group3) => {
         if (group1 && params[group1]) {
@@ -13,3 +13,8 @@ export function compilePathnameTemplate(template, params) {
         return _;
     });
 }
+export function compileUrl(obj, routeParams) {
+    const url = new URL(typeof obj === 'string' ? obj : obj.href);
+    url.pathname = compilePathnameTemplate(url.pathname, routeParams);
+    return url;
+}

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

@@ -1,4 +1,3 @@
-import { URL } from 'whatwg-url';
 import type { KeqContextOptions } from './types/keq-context.js';
 import type { KeqMiddleware } from './types/keq-middleware.js';
 import type { KeqInit } from './types/keq-init.js';
@@ -9,13 +8,13 @@ import type { KeqContextRequest } from './types/keq-context-request.js';
  */
 export declare class Core<OUTPUT> {
     private requestPromise?;
-    protected requestContext: Omit<KeqContextRequest, 'abort'>;
+    protected requestContext: Omit<KeqContextRequest, 'abort' | '__url__'>;
     protected __listeners__: KeqListeners;
     protected __global__: Record<string, any>;
     protected __prepend_middlewares__: KeqMiddleware[];
     protected __append_middlewares__: KeqMiddleware[];
     protected __options__: KeqContextOptions;
-    constructor(url: (URL | globalThis.URL), init: KeqInit, global?: Record<string, any>);
+    constructor(url: URL, init: KeqInit, 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;

package/dist/umd/src/core.js

@@ -7,19 +7,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "mitt", "whatwg-url", "./exception/exception.js", "./util/clone-body.js", "./constant.js", "./util/compose-middleware.js", "./util/shallow-clone.js"], factory);
+        define(["require", "exports", "mitt", "./exception/exception.js", "./util/clone-body.js", "./constant.js", "./util/compose-middleware.js", "./util/shallow-clone.js", "./util/compile-url.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.Core = void 0;
     const mitt_1 = __importDefault(require("mitt"));
-    const whatwg_url_1 = require("whatwg-url");
     const exception_js_1 = require("./exception/exception.js");
     const clone_body_js_1 = require("./util/clone-body.js");
     const constant_js_1 = require("./constant.js");
     const compose_middleware_js_1 = require("./util/compose-middleware.js");
     const shallow_clone_js_1 = require("./util/shallow-clone.js");
+    const compile_url_js_1 = require("./util/compile-url.js");
     /**
      * @description Keq 核心 API，发送请求必要的原子化的API
      */
@@ -42,7 +42,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
                 routeParams: {},
                 body: undefined,
                 ...init,
-                url: new whatwg_url_1.URL(url.href),
+                url: new URL(url.href),
             };
         }
         prependMiddlewares(...middlewares) {
@@ -64,10 +64,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
                 headers.append(key, value);
             }
             const requestContext = {
+                url: new URL(this.requestContext.url.href),
+                routeParams: (0, shallow_clone_js_1.shallowClone)(this.requestContext.routeParams),
+                get __url__() {
+                    return (0, compile_url_js_1.compileUrl)(this.url, this.routeParams);
+                },
                 method: this.requestContext.method,
-                url: new whatwg_url_1.URL(this.requestContext.url.href),
                 headers,
-                routeParams: (0, shallow_clone_js_1.shallowClone)(this.requestContext.routeParams),
                 body: (0, clone_body_js_1.cloneBody)(this.requestContext.body),
                 cache: this.requestContext.cache,
                 credentials: this.requestContext.credentials,

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

@@ -4,14 +4,13 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "whatwg-url", "./is/is-browser.js", "./keq.js", "./middlewares/abort-flow-control-middleware.js", "./middlewares/fetch-arguments-middleware.js", "./middlewares/fetch-middleware.js", "./middlewares/proxy-response-middleware.js", "./middlewares/retry-middleware.js", "./middlewares/serial-flow-control-middleware.js", "./router/keq-router.js", "./middlewares/timeout-middleware.js"], factory);
+        define(["require", "exports", "./is/is-browser.js", "./keq.js", "./middlewares/abort-flow-control-middleware.js", "./middlewares/fetch-arguments-middleware.js", "./middlewares/fetch-middleware.js", "./middlewares/proxy-response-middleware.js", "./middlewares/retry-middleware.js", "./middlewares/serial-flow-control-middleware.js", "./router/keq-router.js", "./middlewares/timeout-middleware.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.createRequest = void 0;
     /* eslint-disable @typescript-eslint/no-unsafe-return */
-    const whatwg_url_1 = require("whatwg-url");
     const is_browser_js_1 = require("./is/is-browser.js");
     const keq_js_1 = require("./keq.js");
     const abort_flow_control_middleware_js_1 = require("./middlewares/abort-flow-control-middleware.js");
@@ -49,9 +48,9 @@
         const global = {};
         const formatUrl = (url) => {
             if (typeof url === 'string') {
-                return new whatwg_url_1.URL(url, baseOrigin);
+                return new URL(url, baseOrigin);
             }
-            return new whatwg_url_1.URL(url.href);
+            return new URL(url.href);
         };
         const router = new keq_router_js_1.KeqRouter(prependMiddlewares);
         const request = function (url, init) {

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

@@ -4,27 +4,15 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "whatwg-url", "../exception/exception.js", "../util/compile-pathname-template.js", "../constant.js", "../is/is-buffer.js"], factory);
+        define(["require", "exports", "../exception/exception.js", "../constant.js", "../is/is-buffer.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.fetchArgumentsMiddleware = void 0;
-    const whatwg_url_1 = require("whatwg-url");
     const exception_js_1 = require("../exception/exception.js");
-    const compile_pathname_template_js_1 = require("../util/compile-pathname-template.js");
     const constant_js_1 = require("../constant.js");
     const is_buffer_js_1 = require("../is/is-buffer.js");
-    function compileUrl(obj, routeParams) {
-        const url = new whatwg_url_1.URL(typeof obj === 'string' ? obj : obj.href);
-        try {
-            url.pathname = (0, compile_pathname_template_js_1.compilePathnameTemplate)(url.pathname, routeParams);
-        }
-        catch (e) {
-            throw new exception_js_1.Exception(`Cannot compile the params in ${url.pathname}, Because ${e?.message}.`);
-        }
-        return url.href;
-    }
     function inferContentTypeByBody(body) {
         if (!body)
             return 'text/plain';
@@ -90,7 +78,7 @@
     function fetchArgumentsMiddleware() {
         return async function fetchArgumentsMiddleware(ctx, next) {
             const request = ctx.request;
-            const url = compileUrl(request.url, request.routeParams);
+            const url = ctx.request.__url__.href;
             if (!request.headers.has('Content-Type') && request.body) {
                 request.headers.set('Content-Type', inferContentTypeByBody(ctx.request.body));
             }

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

@@ -1,11 +1,11 @@
-import { URL } from 'whatwg-url';
 export type KeqContextRequestMethod = 'get' | 'post' | 'put' | 'delete' | 'head' | 'patch';
 export type KeqContextRequestBody = object | Array<any> | string | undefined;
 export interface KeqContextRequest {
-    url: URL | globalThis.URL;
+    url: URL;
+    routeParams: Record<string, string>;
+    readonly __url__: Readonly<URL>;
     method: KeqContextRequestMethod;
     headers: Headers;
-    routeParams: Record<string, string>;
     body: KeqContextRequestBody;
     cache?: RequestCache;
     credentials?: RequestCredentials;

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

@@ -1,26 +1,22 @@
 import { FlattenOperations, KeqOperation, KeqOperations } from './keq-operation.js';
-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 { KeqInit } from './keq-init.js';
-type GlobalURL = globalThis.URL;
 interface KeqRequestFn<OPERATIONS extends Record<string, KeqOperation>> {
     <Path extends keyof OPERATIONS>(url: Path): Keq<OPERATIONS[Path]['responseBody'], OPERATIONS[Path]>;
     <OUTPUT = any>(url: string): Keq<OUTPUT>;
     <OUTPUT = any>(url: URL): Keq<OUTPUT>;
-    <OUTPUT = any>(url: GlobalURL): Keq<OUTPUT>;
 }
 type PickKeqOperationsProperty<T extends KeqOperations, P extends keyof T, X extends keyof KeqOperation> = T extends {
     [Path in keyof T as Path extends P ? Path : never]: {
         [Method in keyof T[Path] as T[Path][Method] extends KeqOperation ? Method : never]: infer R;
     };
 } ? R extends KeqOperation ? R[X] : never : never;
-export interface KeqRequest<OPERATIONS extends KeqOperations> {
+export interface KeqRequest<OPERATIONS extends KeqOperations = KeqOperations> {
     <Path extends keyof OPERATIONS>(url: Path, init: Omit<KeqInit, 'global'>): Keq<Exclude<PickKeqOperationsProperty<OPERATIONS, Path, 'responseBody'>, undefined>>;
     <OUTPUT = any>(url: string, init: Omit<KeqInit, 'global'>): Keq<OUTPUT>;
     <OUTPUT = any>(url: URL, init: Omit<KeqInit, 'global'>): Keq<OUTPUT>;
-    <OUTPUT = any>(url: GlobalURL, init: Omit<KeqInit, 'global'>): Keq<OUTPUT>;
     baseOrigin: (baseOrigin: string) => void;
     get: KeqRequestFn<FlattenOperations<OPERATIONS, 'get'>>;
     post: KeqRequestFn<FlattenOperations<OPERATIONS, 'post'>>;

package/dist/umd/src/util/compile-url.d.ts

@@ -0,0 +1 @@
+export declare function compileUrl(obj: string | URL, routeParams: Record<string, string | number>): URL;

package/dist/umd/src/util/{compile-pathname-template.js → compile-url.js}

@@ -9,7 +9,7 @@
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.compilePathnameTemplate = void 0;
+    exports.compileUrl = void 0;
     function compilePathnameTemplate(template, params) {
         return template
             .replace(/(^|\/)(?::([^/]+)|{([^/]+)}|%7B([^/]+)%7D)(?=$|\/)/g, (_, prefix, group1, group2, group3) => {
@@ -25,5 +25,10 @@
             return _;
         });
     }
-    exports.compilePathnameTemplate = compilePathnameTemplate;
+    function compileUrl(obj, routeParams) {
+        const url = new URL(typeof obj === 'string' ? obj : obj.href);
+        url.pathname = compilePathnameTemplate(url.pathname, routeParams);
+        return url;
+    }
+    exports.compileUrl = compileUrl;
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keq",
-  "version": "2.6.10",
+  "version": "2.7.1",
   "description": "Request API write by Typescript for flexibility, readability, and a low learning curve.",
   "keywords": [
     "request",
@@ -40,12 +40,10 @@
     "test": "jest"
   },
   "dependencies": {
-    "@types/whatwg-url": "^11.0.5",
     "fastq": "^1.17.1",
     "minimatch": "^9.0.4",
     "mitt": "^3.0.1",
-    "ts-custom-error": "^3.3.1",
-    "whatwg-url": "^14.0.0"
+    "ts-custom-error": "^3.3.1"
   },
   "devDependencies": {
     "@buka/eslint-config": "^1.6.4",

package/dist/esm/src/util/compile-pathname-template.d.ts

@@ -1 +0,0 @@
-export declare function compilePathnameTemplate(template: string, params: Record<string, string | number>): string;

package/dist/umd/src/util/compile-pathname-template.d.ts

@@ -1 +0,0 @@
-export declare function compilePathnameTemplate(template: string, params: Record<string, string | number>): string;