@koa/router 13.1.1 → 14.0.0

package/HISTORY.md

@@ -0,0 +1,187 @@
+# History
+
+**[History has moved to the Releases tab of GitHub](https://github.com/koajs/router/releases).**
+
+
+## Log
+
+
+## 9.0.0 / 2020-04-09
+
+* Update `path-to-regexp`. Migration path: change usage of `'*'` in routes to `(.*)` or `:splat*`.
+  * Example: `router.get('*', ....)` becomes `router.get('(.*)') ....)`
+
+
+## 8.0.0 / 2019-06-16
+
+**others**
+
+* [b5dd5e8](http://github.com/koajs/koa-router/commit/b5dd5e8f00e841b7061a62ab6228cbe96a999470)] - chore: rename to @koa/router (dead-horse)
+
+---
+
+Changelogs inherit from koa-router.
+
+
+## 7.4.0
+
+* Fix router.url() for multiple nested routers [#407](https://github.com/alexmingoia/koa-router/pull/407)
+* `layer.name` added to `ctx` at `ctx.routerName` during routing [#412](https://github.com/alexmingoia/koa-router/pull/412)
+* Router.use() was erroneously settings `(.*)` as a prefix to all routers nested with .use that did not pass an explicit prefix string as the first argument. This resulted in routes being matched that should not have been, included the running of multiple route handlers in error. [#369](https://github.com/alexmingoia/koa-router/issues/369) and [#410](https://github.com/alexmingoia/koa-router/issues/410) include information on this issue.
+
+
+## 7.3.0
+
+* Router#url() now accepts query parameters to add to generated urls [#396](https://github.com/alexmingoia/koa-router/pull/396)
+
+
+## 7.2.1
+
+* Respond to CORS preflights with 200, 0 length body [#359](https://github.com/alexmingoia/koa-router/issues/359)
+
+
+## 7.2.0
+
+* Fix a bug in Router#url and append Router object to ctx. [#350](https://github.com/alexmingoia/koa-router/pull/350)
+* Adds `_matchedRouteName` to context [#337](https://github.com/alexmingoia/koa-router/pull/337)
+* Respond to CORS preflights with 200, 0 length body [#359](https://github.com/alexmingoia/koa-router/issues/359)
+
+
+## 7.1.1
+
+* Fix bug where param handlers were run out of order [#282](https://github.com/alexmingoia/koa-router/pull/282)
+
+
+## 7.1.0
+
+* Backports: merge 5.4 work into the 7.x upstream. See 5.4.0 updates for more details.
+
+
+## 7.0.1
+
+* Fix: allowedMethods should be ctx.method not this.method [#215](https://github.com/alexmingoia/koa-router/pull/215)
+
+
+## 7.0.0
+
+* The API has changed to match the new promise-based middleware
+  signature of koa 2. See the
+  [koa 2.x readme](https://github.com/koajs/koa/tree/2.0.0-alpha.3) for more
+  information.
+* Middleware is now always run in the order declared by `.use()` (or `.get()`,
+  etc.), which matches Express 4 API.
+
+
+## 5.4.0
+
+* Expose matched route at `ctx._matchedRoute`.
+
+
+## 5.3.0
+
+* Register multiple routes with array of paths [#203](https://github.com/alexmingoia/koa-router/issue/143).
+* Improved router.url() [#143](https://github.com/alexmingoia/koa-router/pull/143)
+* Adds support for named routes and regular expressions
+  [#152](https://github.com/alexmingoia/koa-router/pull/152)
+* Add support for custom throw functions for 405 and 501 responses [#206](https://github.com/alexmingoia/koa-router/pull/206)
+
+
+## 5.2.3
+
+* Fix for middleware running twice when nesting routes [#184](https://github.com/alexmingoia/koa-router/issues/184)
+
+
+## 5.2.2
+
+* Register routes without params before those with params [#183](https://github.com/alexmingoia/koa-router/pull/183)
+* Fix for allowed methods [#182](https://github.com/alexmingoia/koa-router/issues/182)
+
+
+## 5.2.0
+
+* Add support for async/await. Resolves [#130](https://github.com/alexmingoia/koa-router/issues/130).
+* Add support for array of paths by Router#use(). Resolves [#175](https://github.com/alexmingoia/koa-router/issues/175).
+* Inherit param middleware when nesting routers. Fixes [#170](https://github.com/alexmingoia/koa-router/issues/170).
+* Default router middleware without path to root. Fixes [#161](https://github.com/alexmingoia/koa-router/issues/161), [#155](https://github.com/alexmingoia/koa-router/issues/155), [#156](https://github.com/alexmingoia/koa-router/issues/156).
+* Run nested router middleware after parent's. Fixes [#156](https://github.com/alexmingoia/koa-router/issues/156).
+* Remove dependency on koa-compose.
+
+
+## 5.1.1
+
+* Match routes in order they were defined. Fixes #131.
+
+
+## 5.1.0
+
+* Support mounting router middleware at a given path.
+
+
+## 5.0.1
+
+* Fix bug with missing parameters when nesting routers.
+
+
+## 5.0.0
+
+* Remove confusing API for extending koa app with router methods. Router#use()
+  does not have the same behavior as app#use().
+* Add support for nesting routes.
+* Remove support for regular expression routes to achieve nestable routers and
+  enable future trie-based routing optimizations.
+
+
+## 4.3.2
+
+* Do not send 405 if route matched but status is 404. Fixes #112, closes #114.
+
+
+## 4.3.1
+
+* Do not run middleware if not yielded to by previous middleware. Fixes #115.
+
+
+## 4.3.0
+
+* Add support for router prefixes.
+* Add MIT license.
+
+
+## 4.2.0
+
+* Fixed issue with router middleware being applied even if no route was
+  matched.
+* Router.url - new static method to generate url from url pattern and data
+
+
+## 4.1.0
+
+Private API changed to separate context parameter decoration from route
+matching. `Router#match` and `Route#match` are now pure functions that return
+an array of routes that match the URL path.
+
+For modules using this private API that need to determine if a method and path
+match a route, `route.methods` must be checked against the routes returned from
+`router.match()`:
+
+```javascript
+var matchedRoute = router.match(path).filter(function (route) {
+  return ~route.methods.indexOf(method);
+}).shift();
+```
+
+
+## 4.0.0
+
+405, 501, and OPTIONS response handling was moved into separate middleware
+`router.allowedMethods()`. This resolves incorrect 501 or 405 responses when
+using multiple routers.
+
+### Breaking changes
+
+4.x is mostly backwards compatible with 3.x, except for the following:
+
+* Instantiating a router with `new` and `app` returns the router instance,
+  whereas 3.x returns the router middleware. When creating a router in 4.x, the
+  only time router middleware is returned is when creating using the
+  `Router(app)` signature (with `app` and without `new`).

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;

package/lib/router.js

@@ -51,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 || [
@@ -164,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
         });
       }
     }
@@ -379,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);
@@ -395,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;
   }
@@ -454,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) {
@@ -471,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);
     }
@@ -574,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);
 
@@ -811,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.1",
+  "version": "14.0.0",
   "author": "Alex Mingoia <talk@alexmingoia.com>",
   "bugs": {
     "url": "https://github.com/koajs/router/issues",
@@ -24,28 +24,28 @@
     "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"
@@ -65,9 +65,10 @@
   },
   "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",
     "pretest": "npm run lint",
     "test": "mocha test/**/*.js",