keq 2.6.9 → 2.7.0

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.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)
+
+
+### Performance Improvements
+
+* optimize the error message of the wrong header ([92f4aa6](https://github.com/keq-request/keq/commit/92f4aa6d58d258521ee0a2913a8cfb52597e9ed8))
+
 ## [2.6.9](https://github.com/keq-request/keq/compare/v2.6.8...v2.6.9) (2024-06-24)
 
 

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

@@ -9,7 +9,7 @@ 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[];

package/dist/esm/src/core.js

@@ -5,6 +5,7 @@ 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 +50,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/keq.js

@@ -11,6 +11,7 @@ import { assignKeqRequestBody } from './util/assign-keq-request-body.js';
 import { base64Encode } from './util/base64.js';
 import { fixContentType } from './util/fix-content-type.js';
 import { getUniqueCodeIdentifier } from './util/get-unique-code-identifier.js';
+import { isValidHeaderValue } from './util/is-valid-header-value.js';
 /**
  * @description Keq 扩展 API，人性化的常用的API
  */
@@ -35,10 +36,16 @@ export class Keq extends Core {
             });
         }
         else if (typeof headersOrName === 'string' && value) {
+            if (!isValidHeaderValue(value)) {
+                throw new Exception(`[Invalid header] Key: ${headersOrName} Value: ${value}`);
+            }
             this.requestContext.headers.set(headersOrName, value);
         }
         else if (typeof headersOrName === 'object') {
             for (const [key, value] of Object.entries(headersOrName)) {
+                if (!isValidHeaderValue(value)) {
+                    throw new Exception(`[Invalid header] Key: ${key} Value: ${value}`);
+                }
                 this.requestContext.headers.set(key, value);
             }
         }

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

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

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

@@ -16,7 +16,7 @@ type PickKeqOperationsProperty<T extends KeqOperations, P extends keyof T, X ext
         [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>;

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

@@ -0,0 +1,2 @@
+import { URL } from 'whatwg-url';
+export declare function compileUrl(obj: string | URL | globalThis.URL, routeParams: Record<string, string | number>): URL;

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

@@ -1,4 +1,5 @@
-export function compilePathnameTemplate(template, params) {
+import { URL } from 'whatwg-url';
+function compilePathnameTemplate(template, params) {
     return template
         .replace(/(^|\/)(?::([^/]+)|{([^/]+)}|%7B([^/]+)%7D)(?=$|\/)/g, (_, prefix, group1, group2, group3) => {
         if (group1 && params[group1]) {
@@ -13,3 +14,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/esm/src/util/is-valid-header-value.d.ts

@@ -0,0 +1 @@
+export declare function isValidHeaderValue(str: any): boolean;

package/dist/esm/src/util/is-valid-header-value.js

@@ -0,0 +1,4 @@
+export function isValidHeaderValue(str) {
+    const regex = /^[\t\x20-\x7E\x80-\xFF]*$/;
+    return regex.test(str);
+}

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

@@ -9,7 +9,7 @@ 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[];

package/dist/umd/src/core.js

@@ -7,7 +7,7 @@ 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", "whatwg-url", "./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";
@@ -20,6 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     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
      */
@@ -64,10 +65,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
                 headers.append(key, value);
             }
             const requestContext = {
-                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),
+                get __url__() {
+                    return (0, compile_url_js_1.compileUrl)(this.url, this.routeParams);
+                },
+                method: this.requestContext.method,
+                headers,
                 body: (0, clone_body_js_1.cloneBody)(this.requestContext.body),
                 cache: this.requestContext.cache,
                 credentials: this.requestContext.credentials,

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/assign-keq-request-body.js", "./util/base64.js", "./util/fix-content-type.js", "./util/get-unique-code-identifier.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/assign-keq-request-body.js", "./util/base64.js", "./util/fix-content-type.js", "./util/get-unique-code-identifier.js", "./util/is-valid-header-value.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -23,6 +23,7 @@
     const base64_js_1 = require("./util/base64.js");
     const fix_content_type_js_1 = require("./util/fix-content-type.js");
     const get_unique_code_identifier_js_1 = require("./util/get-unique-code-identifier.js");
+    const is_valid_header_value_js_1 = require("./util/is-valid-header-value.js");
     /**
      * @description Keq 扩展 API，人性化的常用的API
      */
@@ -47,10 +48,16 @@
                 });
             }
             else if (typeof headersOrName === 'string' && value) {
+                if (!(0, is_valid_header_value_js_1.isValidHeaderValue)(value)) {
+                    throw new exception_js_1.Exception(`[Invalid header] Key: ${headersOrName} Value: ${value}`);
+                }
                 this.requestContext.headers.set(headersOrName, value);
             }
             else if (typeof headersOrName === 'object') {
                 for (const [key, value] of Object.entries(headersOrName)) {
+                    if (!(0, is_valid_header_value_js_1.isValidHeaderValue)(value)) {
+                        throw new exception_js_1.Exception(`[Invalid header] Key: ${key} Value: ${value}`);
+                    }
                     this.requestContext.headers.set(key, value);
                 }
             }

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

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

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

@@ -16,7 +16,7 @@ type PickKeqOperationsProperty<T extends KeqOperations, P extends keyof T, X ext
         [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>;

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

@@ -0,0 +1,2 @@
+import { URL } from 'whatwg-url';
+export declare function compileUrl(obj: string | URL | globalThis.URL, routeParams: Record<string, string | number>): URL;

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

@@ -4,12 +4,13 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports"], factory);
+        define(["require", "exports", "whatwg-url"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.compilePathnameTemplate = void 0;
+    exports.compileUrl = void 0;
+    const whatwg_url_1 = require("whatwg-url");
     function compilePathnameTemplate(template, params) {
         return template
             .replace(/(^|\/)(?::([^/]+)|{([^/]+)}|%7B([^/]+)%7D)(?=$|\/)/g, (_, prefix, group1, group2, group3) => {
@@ -25,5 +26,10 @@
             return _;
         });
     }
-    exports.compilePathnameTemplate = compilePathnameTemplate;
+    function compileUrl(obj, routeParams) {
+        const url = new whatwg_url_1.URL(typeof obj === 'string' ? obj : obj.href);
+        url.pathname = compilePathnameTemplate(url.pathname, routeParams);
+        return url;
+    }
+    exports.compileUrl = compileUrl;
 });

package/dist/umd/src/util/is-valid-header-value.d.ts

@@ -0,0 +1 @@
+export declare function isValidHeaderValue(str: any): boolean;

package/dist/umd/src/util/is-valid-header-value.js

@@ -0,0 +1,18 @@
+(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.isValidHeaderValue = void 0;
+    function isValidHeaderValue(str) {
+        const regex = /^[\t\x20-\x7E\x80-\xFF]*$/;
+        return regex.test(str);
+    }
+    exports.isValidHeaderValue = isValidHeaderValue;
+});

package/package.json

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

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;