@koa/router 13.1.0 → 14.0.0

package/README.md

@@ -3,7 +3,9 @@
 > Router middleware for [Koa](https://github.com/koajs/koa). Maintained by [Forward Email][forward-email] and [Lad][].
 
 [![build status](https://github.com/koajs/router/actions/workflows/ci.yml/badge.svg)](https://github.com/koajs/router/actions/workflows/ci.yml)
-[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
+
+<!-- [![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) -->
+
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
 [![license](https://img.shields.io/github/license/koajs/router.svg)](LICENSE)

package/lib/layer.js

@@ -13,6 +13,7 @@ module.exports = class Layer {
    * @param {String=} opts.name route name
    * @param {String=} opts.sensitive case sensitive (default: false)
    * @param {String=} opts.strict require the trailing slash (default: false)
+   * @param {Boolean=} opts.pathAsRegExp if true, treat `path` as a regular expression
    * @returns {Layer}
    * @private
    */
@@ -20,14 +21,12 @@ module.exports = class Layer {
     this.opts = opts;
     this.name = this.opts.name || null;
     this.methods = [];
-    this.paramNames = [];
-    this.stack = Array.isArray(middleware) ? middleware : [middleware];
-
     for (const method of methods) {
       const l = this.methods.push(method.toUpperCase());
       if (this.methods[l - 1] === 'GET') this.methods.unshift('HEAD');
     }
 
+    this.stack = Array.isArray(middleware) ? middleware : [middleware];
     // ensure middleware is a function
     for (let i = 0; i < this.stack.length; i++) {
       const fn = this.stack[i];
@@ -41,7 +40,20 @@ module.exports = class Layer {
     }
 
     this.path = path;
-    this.regexp = pathToRegexp(path, this.paramNames, this.opts);
+    this.paramNames = [];
+
+    if (this.opts.pathAsRegExp === true) {
+      this.regexp = new RegExp(path);
+    } else if (this.path) {
+      if ('strict' in this.opts) {
+        // path-to-regexp renamed strict to trailing in v8.1.0
+        this.opts.trailing = this.opts.strict !== true;
+      }
+
+      const { regexp, keys } = pathToRegexp(this.path, this.opts);
+      this.regexp = regexp;
+      this.paramNames = keys;
+    }
   }
 
   /**
@@ -116,13 +128,14 @@ module.exports = class Layer {
 
     const toPath = compile(url, { encode: encodeURIComponent, ...options });
     let replaced;
-
-    const tokens = parse(url);
+    const { tokens } = parse(url);
     let replace = {};
 
     if (Array.isArray(args)) {
       for (let len = tokens.length, i = 0, j = 0; i < len; i++) {
-        if (tokens[i].name) replace[tokens[i].name] = args[j++];
+        if (tokens[i].name) {
+          replace[tokens[i].name] = args[j++];
+        }
       }
     } else if (tokens.some((token) => token.name)) {
       replace = params;
@@ -130,6 +143,10 @@ module.exports = class Layer {
       options = params;
     }
 
+    for (const [key, value] of Object.entries(replace)) {
+      replace[key] = String(value);
+    }
+
     replaced = toPath(replace);
 
     if (options && options.query) {
@@ -212,8 +229,13 @@ module.exports = class Layer {
         this.path !== '/' || this.opts.strict === true
           ? `${prefix}${this.path}`
           : prefix;
-      this.paramNames = [];
-      this.regexp = pathToRegexp(this.path, this.paramNames, this.opts);
+      if (this.opts.pathAsRegExp === true || prefix instanceof RegExp) {
+        this.regexp = new RegExp(this.path);
+      } else if (this.path) {
+        const { regexp, keys } = pathToRegexp(this.path, this.opts);
+        this.regexp = regexp;
+        this.paramNames = keys;
+      }
     }
 
     return this;
@@ -231,6 +253,7 @@ module.exports = class Layer {
 
 function safeDecodeURIComponent(text) {
   try {
+    // TODO: take a look on `safeDecodeURIComponent` if we use it only with route params let's remove the `replace` method otherwise make it flexible.
     // @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#decoding_query_parameters_from_a_url
     return decodeURIComponent(text.replace(/\+/g, ' '));
   } catch {

package/lib/router.js

@@ -5,9 +5,8 @@
  * @link https://github.com/alexmingoia/koa-router
  */
 const http = require('node:http');
-const util = require('node:util');
 
-const debug = util.debuglog('koa-router');
+const debug = require('debug')('koa-router');
 
 const compose = require('koa-compose');
 const HttpError = require('http-errors');
@@ -52,7 +51,7 @@ class Router {
    * @constructor
    */
   constructor(opts = {}) {
-    if (!(this instanceof Router)) return new Router(opts); // eslint-disable-line no-constructor-return
+    if (!(this instanceof Router)) return new Router(opts);  
 
     this.opts = opts;
     this.methods = this.opts.methods || [
@@ -165,14 +164,14 @@ class Router {
           }
         }
       } else {
-        const keys = [];
-        pathToRegexp(router.opts.prefix || '', keys);
+        const { keys } = pathToRegexp(router.opts.prefix || '', router.opts);
         const routerPrefixHasParam = Boolean(
           router.opts.prefix && keys.length > 0
         );
         router.register(path || '([^/]*)', [], m, {
           end: false,
-          ignoreCaptures: !hasPath && !routerPrefixHasParam
+          ignoreCaptures: !hasPath && !routerPrefixHasParam,
+          pathAsRegExp: true
         });
       }
     }
@@ -380,7 +379,7 @@ class Router {
    * @returns {Router}
    */
   all(name, path, middleware) {
-    if (typeof path === 'string') {
+    if (typeof path === 'string' || path instanceof RegExp) {
       middleware = Array.prototype.slice.call(arguments, 2);
     } else {
       middleware = Array.prototype.slice.call(arguments, 1);
@@ -396,7 +395,12 @@ class Router {
     )
       throw new Error('You have to provide a path when adding an all handler');
 
-    this.register(path, methods, middleware, { name });
+    const opts = {
+      name,
+      pathAsRegExp: path instanceof RegExp
+    };
+
+    this.register(path, methods, middleware, { ...this.opts, ...opts });
 
     return this;
   }
@@ -455,10 +459,10 @@ class Router {
    * @returns {Layer}
    * @private
    */
-  register(path, methods, middleware, opts = {}) {
+  register(path, methods, middleware, newOpts = {}) {
     const router = this;
     const { stack } = this;
-
+    const opts = { ...this.opts, ...newOpts };
     // support array of paths
     if (Array.isArray(path)) {
       for (const curPath of path) {
@@ -472,12 +476,14 @@ class Router {
     const route = new Layer(path, methods, middleware, {
       end: opts.end === false ? opts.end : true,
       name: opts.name,
-      sensitive: opts.sensitive || this.opts.sensitive || false,
-      strict: opts.strict || this.opts.strict || false,
-      prefix: opts.prefix || this.opts.prefix || '',
-      ignoreCaptures: opts.ignoreCaptures
+      sensitive: opts.sensitive || false,
+      strict: opts.strict || false,
+      prefix: opts.prefix || '',
+      ignoreCaptures: opts.ignoreCaptures,
+      pathAsRegExp: opts.pathAsRegExp
     });
 
+    // if parent prefix exists, add prefix to new route
     if (this.opts.prefix) {
       route.setPrefix(this.opts.prefix);
     }
@@ -575,7 +581,6 @@ class Router {
 
       debug('test %s %s', layer.path, layer.regexp);
 
-      // eslint-disable-next-line unicorn/prefer-regexp-test
       if (layer.match(path)) {
         matched.path.push(layer);
 
@@ -812,14 +817,19 @@ for (const method of methods) {
         `You have to provide a path when adding a ${method} handler`
       );
 
-    this.register(path, [method], middleware, { name });
+    const opts = {
+      name,
+      pathAsRegExp: path instanceof RegExp
+    };
 
+    // pass opts to register call on verb methods
+    this.register(path, [method], middleware, { ...this.opts, ...opts });
     return this;
   };
 }
 
 // Alias for `router.delete()` because delete is a reserved word
-// eslint-disable-next-line dot-notation
+ 
 Router.prototype.del = Router.prototype['delete'];
 
 module.exports = Router;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@koa/router",
   "description": "Router middleware for koa. Maintained by Forward Email and Lad.",
-  "version": "13.1.0",
+  "version": "14.0.0",
   "author": "Alex Mingoia <talk@alexmingoia.com>",
   "bugs": {
     "url": "https://github.com/koajs/router/issues",
@@ -21,30 +21,31 @@
     }
   ],
   "dependencies": {
+    "debug": "^4.4.1",
     "http-errors": "^2.0.0",
     "koa-compose": "^4.1.0",
-    "path-to-regexp": "^6.3.0"
+    "path-to-regexp": "^8.2.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.7.2",
     "@commitlint/config-conventional": "^17.7.0",
     "@ladjs/env": "^4.0.0",
-    "eslint": "^8.39.0",
-    "eslint-config-xo-lass": "^2.0.1",
+    "chalk": "^5.4.1",
+    "eslint": "^9.32.0",
+    "eslint-plugin-unicorn": "^60.0.0",
     "fixpack": "^4.0.0",
-    "husky": "^8.0.3",
+    "husky": "^9.1.7",
     "jsdoc-to-markdown": "^8.0.0",
-    "koa": "^2.15.3",
+    "koa": "^3.0.1",
     "lint-staged": "^14.0.1",
-    "mocha": "^10.7.3",
+    "mocha": "^11.7.1",
     "nyc": "^17.0.0",
     "remark-cli": "11",
     "remark-preset-github": "^4.0.4",
-    "supertest": "^7.0.0",
-    "xo": "0.53.1"
+    "supertest": "^7.0.0"
   },
   "engines": {
-    "node": ">= 18"
+    "node": ">= 20"
   },
   "files": [
     "lib"
@@ -64,11 +65,12 @@
   },
   "scripts": {
     "bench": "make -C bench",
+    "benchmark": "node bench/run.js",
     "coverage": "nyc npm run test",
     "docs": "NODE_ENV=test jsdoc2md -t ./lib/API_tpl.hbs --src ./lib/*.js  >| API.md",
-    "lint": "xo --fix && remark . -qfo && fixpack",
+    "lint": "eslint . --fix && remark . -qfo && fixpack",
     "prepare": "husky install",
-    "prextest": "npm run lint",
+    "pretest": "npm run lint",
     "test": "mocha test/**/*.js",
     "test:watch": "mocha test/**/*.js --watch"
   }