keq 2.1.0 → 2.1.2

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.1.2](https://github.com/keq-request/keq/compare/v2.1.1...v2.1.2) (2024-01-17)
+
+
+### Bug Fixes
+
+* unable send request when parentheses exit in pathname ([24c81ff](https://github.com/keq-request/keq/commit/24c81ffdde71919163a09778aa15ae6106427d45))
+
+## [2.1.1](https://github.com/keq-request/keq/compare/v2.1.0...v2.1.1) (2024-01-09)
+
+
+### Bug Fixes
+
+* should not throw error when query is undefined ([515fa20](https://github.com/keq-request/keq/commit/515fa2090a03eb60ed8e7d0e575ce44dd8bce12b))
+
 ## [2.1.0](https://github.com/keq-request/keq/compare/v2.0.8...v2.1.0) (2024-01-05)
 
 

package/README.md

@@ -150,24 +150,20 @@ await request
 ### Request routing parameters
 
 The `.params()` method accepts key and value, which when used for the request with routing parameters.
-The follwing will produce the path `/search/keq`.
 
 ```javascript
 import { request } from "keq";
 
 await request
-  .get("/search/:searchKey")
-  .params("searchKey", "keq");
-```
-
-Or as a single object:
-
-```javascript
-import { request } from "keq";
-
-await request
-  .get("/search/:searchKey")
-  .params({ searchKey: "keq" });
+  // request to /users/jack/books/kafka
+  .get("/users/:userName/books/{bookName}")
+  .params("userName", 'jack');
+  .params("bookName", "kafka");
+  // or invoke with an object
+  .params({
+    "userName": "jack",
+    "bookName": "kafka"
+  })
 ```
 
 ### JSON Request

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

@@ -3,6 +3,7 @@ import { Core } from './core';
 import { KeqFlowControlMode, KeqFlowControlSignal } from './types/keq-flow-control.js';
 import { KeqMiddleware } from './types/keq-middleware';
 import { KeqBuildInOptions, KeqOptions, KeqOptionsWithFullResponse, KeqOptionsWithoutFullResponse } from './types/keq-options';
+import { KeqQueryValue } from './types/keq-query-value.js';
 import { KeqRequestBody } from './types/keq-request-body';
 import { KeqRetryDelay } from './types/keq-retry-delay';
 import { KeqRetryOn } from './types/keq-retry-on';
@@ -29,8 +30,8 @@ export declare class Keq<T> extends Core<T> {
     /**
      * Set request query/searchParams
      */
-    query(key: Record<string, string | number | string[] | number[] | undefined>): this;
-    query(key: string, value: string | number | string[] | number[] | undefined): this;
+    query(key: Record<string, KeqQueryValue | KeqQueryValue[]>): this;
+    query(key: string, value: KeqQueryValue | KeqQueryValue[]): this;
     /**
      * Set request route params
      */

package/dist/esm/src/keq.js

@@ -44,25 +44,32 @@ export class Keq extends Core {
         return this;
     }
     query(key, value) {
-        if (typeof key === 'string' && Array.isArray(value)) {
-            for (const item of value) {
-                this.requestContext.url.searchParams.append(key, String(item));
-            }
-        }
-        else if (typeof key === 'string' && typeof value === 'string') {
-            this.requestContext.url.searchParams.append(key, value);
-        }
-        else if (typeof key === 'object') {
+        if (typeof key === 'object') {
             for (const [k, v] of Object.entries(key)) {
                 if (v === undefined)
                     continue;
                 this.query(k, v);
             }
+            return this;
         }
-        else {
-            throw new Exception('please set query value');
+        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) {
+                // skip
+            }
+            else {
+                console.warn(`query value type is invalid, key: ${key}`);
+            }
+            return this;
         }
-        return this;
+        throw new TypeError('typeof key is invalid');
     }
     params(key, value) {
         if (typeof key === 'string') {

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

@@ -1,11 +1,10 @@
-import { compile } from 'path-to-regexp';
 import { URL } from 'whatwg-url';
 import { Exception } from "../exception/exception";
+import { compilePathnameTemplate } from "../util/compile-pathname-template.js";
 function compileUrl(obj, routeParams) {
     const url = new URL(typeof obj === 'string' ? obj : obj.href);
     try {
-        const toPath = compile(url.pathname, { encode: encodeURIComponent });
-        url.pathname = toPath(routeParams);
+        url.pathname = compilePathnameTemplate(url.pathname, routeParams);
     }
     catch (e) {
         throw new Exception(`Cannot compile the params in ${url.pathname}, Because ${e?.message}.`);

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

@@ -0,0 +1 @@
+export type KeqQueryValue = string | number | bigint | undefined;

package/dist/esm/src/types/keq-query-value.js

@@ -0,0 +1 @@
+export {};

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

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

package/dist/esm/src/util/compile-pathname-template.js

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

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

@@ -3,6 +3,7 @@ import { Core } from './core';
 import { KeqFlowControlMode, KeqFlowControlSignal } from './types/keq-flow-control.js';
 import { KeqMiddleware } from './types/keq-middleware';
 import { KeqBuildInOptions, KeqOptions, KeqOptionsWithFullResponse, KeqOptionsWithoutFullResponse } from './types/keq-options';
+import { KeqQueryValue } from './types/keq-query-value.js';
 import { KeqRequestBody } from './types/keq-request-body';
 import { KeqRetryDelay } from './types/keq-retry-delay';
 import { KeqRetryOn } from './types/keq-retry-on';
@@ -29,8 +30,8 @@ export declare class Keq<T> extends Core<T> {
     /**
      * Set request query/searchParams
      */
-    query(key: Record<string, string | number | string[] | number[] | undefined>): this;
-    query(key: string, value: string | number | string[] | number[] | undefined): this;
+    query(key: Record<string, KeqQueryValue | KeqQueryValue[]>): this;
+    query(key: string, value: KeqQueryValue | KeqQueryValue[]): this;
     /**
      * Set request route params
      */

package/dist/umd/src/keq.js

@@ -56,25 +56,32 @@
             return this;
         }
         query(key, value) {
-            if (typeof key === 'string' && Array.isArray(value)) {
-                for (const item of value) {
-                    this.requestContext.url.searchParams.append(key, String(item));
-                }
-            }
-            else if (typeof key === 'string' && typeof value === 'string') {
-                this.requestContext.url.searchParams.append(key, value);
-            }
-            else if (typeof key === 'object') {
+            if (typeof key === 'object') {
                 for (const [k, v] of Object.entries(key)) {
                     if (v === undefined)
                         continue;
                     this.query(k, v);
                 }
+                return this;
             }
-            else {
-                throw new exception_1.Exception('please set query value');
+            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) {
+                    // skip
+                }
+                else {
+                    console.warn(`query value type is invalid, key: ${key}`);
+                }
+                return this;
             }
-            return this;
+            throw new TypeError('typeof key is invalid');
         }
         params(key, value) {
             if (typeof key === 'string') {

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

@@ -4,20 +4,19 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "path-to-regexp", "whatwg-url", "../exception/exception"], factory);
+        define(["require", "exports", "whatwg-url", "../exception/exception", "../util/compile-pathname-template.js"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.fetchArgumentsMiddleware = void 0;
-    const path_to_regexp_1 = require("path-to-regexp");
     const whatwg_url_1 = require("whatwg-url");
     const exception_1 = require("../exception/exception");
+    const compile_pathname_template_js_1 = require("../util/compile-pathname-template.js");
     function compileUrl(obj, routeParams) {
         const url = new whatwg_url_1.URL(typeof obj === 'string' ? obj : obj.href);
         try {
-            const toPath = (0, path_to_regexp_1.compile)(url.pathname, { encode: encodeURIComponent });
-            url.pathname = toPath(routeParams);
+            url.pathname = (0, compile_pathname_template_js_1.compilePathnameTemplate)(url.pathname, routeParams);
         }
         catch (e) {
             throw new exception_1.Exception(`Cannot compile the params in ${url.pathname}, Because ${e?.message}.`);

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

@@ -0,0 +1 @@
+export type KeqQueryValue = string | number | bigint | undefined;

package/dist/umd/src/types/keq-query-value.js

@@ -0,0 +1,12 @@
+(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 });
+});

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

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

package/dist/umd/src/util/compile-pathname-template.js

@@ -0,0 +1,29 @@
+(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.compilePathnameTemplate = void 0;
+    function compilePathnameTemplate(template, params) {
+        return template
+            .replace(/(^|\/)(?::([^/]+)|{([^/]+)}|%7B([^/]+)%7D)(?=$|\/)/g, (_, prefix, group1, group2, group3) => {
+            if (group1 && params[group1]) {
+                return `${prefix}${encodeURIComponent(params[group1])}`;
+            }
+            else if (group2 && params[group2]) {
+                return `${prefix}${encodeURIComponent(params[group2])}`;
+            }
+            else if (group3 && params[group3]) {
+                return `${prefix}${encodeURIComponent(params[group3])}`;
+            }
+            return _;
+        });
+    }
+    exports.compilePathnameTemplate = compilePathnameTemplate;
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keq",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "Request API write by Typescript for flexibility, readability, and a low learning curve.",
   "keywords": [
     "request",
@@ -44,7 +44,6 @@
     "fastq": "^1.16.0",
     "minimatch": "^9.0.3",
     "object.fromentries": "^2.0.7",
-    "path-to-regexp": "^6.2.1",
     "ts-custom-error": "^3.3.1",
     "whatwg-url": "^14.0.0"
   },