@koa/router 14.0.0 → 15.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@koa/router",
   "description": "Router middleware for koa. Maintained by Forward Email and Lad.",
-  "version": "14.0.0",
+  "version": "15.1.0",
   "author": "Alex Mingoia <talk@alexmingoia.com>",
   "bugs": {
     "url": "https://github.com/koajs/router/issues",
@@ -20,35 +20,69 @@
       "email": "imed-jaberi@outlook.com"
     }
   ],
+  "peerDependencies": {
+    "koa": "^2.0.0 || ^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "koa": {
+      "optional": false
+    }
+  },
   "dependencies": {
-    "debug": "^4.4.1",
-    "http-errors": "^2.0.0",
+    "debug": "^4.4.3",
+    "http-errors": "^2.0.1",
     "koa-compose": "^4.1.0",
-    "path-to-regexp": "^8.2.0"
+    "path-to-regexp": "^8.3.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.7.2",
-    "@commitlint/config-conventional": "^17.7.0",
-    "@ladjs/env": "^4.0.0",
+    "@commitlint/cli": "^20.2.0",
+    "@commitlint/config-conventional": "^20.2.0",
+    "@koa/bodyparser": "^6.0.0",
+    "@types/debug": "^4.1.12",
+    "@types/jsonwebtoken": "^9.0.7",
+    "@types/koa": "^3.0.1",
+    "@types/node": "^25.0.1",
+    "@types/supertest": "^6.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.49.0",
+    "@typescript-eslint/parser": "^8.49.0",
+    "c8": "^10.1.3",
     "chalk": "^5.4.1",
-    "eslint": "^9.32.0",
-    "eslint-plugin-unicorn": "^60.0.0",
-    "fixpack": "^4.0.0",
+    "eslint": "^9.39.1",
+    "eslint-plugin-unicorn": "^62.0.0",
     "husky": "^9.1.7",
-    "jsdoc-to-markdown": "^8.0.0",
-    "koa": "^3.0.1",
-    "lint-staged": "^14.0.1",
-    "mocha": "^11.7.1",
-    "nyc": "^17.0.0",
-    "remark-cli": "11",
-    "remark-preset-github": "^4.0.4",
-    "supertest": "^7.0.0"
+    "joi": "^18.0.2",
+    "jsonwebtoken": "^9.0.3",
+    "koa": "^3.1.1",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.7.4",
+    "rimraf": "^6.1.2",
+    "supertest": "^7.1.4",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
   },
   "engines": {
     "node": ">= 20"
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "import": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "require": "./dist/index.js"
+      }
+    }
+  },
   "files": [
-    "lib"
+    "dist",
+    "LICENSE",
+    "README.md"
   ],
   "homepage": "https://github.com/koajs/router",
   "keywords": [
@@ -58,20 +92,29 @@
     "router"
   ],
   "license": "MIT",
-  "main": "lib/router.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/koajs/router.git"
   },
   "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": "eslint . --fix && remark . -qfo && fixpack",
+    "bench": "TS_NODE_PROJECT=tsconfig.bench.json node --require ts-node/register bench/run.ts",
+    "benchmark": "npm run bench",
+    "bench:all": "TS_NODE_PROJECT=tsconfig.bench.json node --require ts-node/register bench/make.ts",
+    "benchmark:all": "npm run bench:all",
     "prepare": "husky install",
-    "pretest": "npm run lint",
-    "test": "mocha test/**/*.js",
-    "test:watch": "mocha test/**/*.js --watch"
+    "format": "prettier --write \"**/*.{ts,tsx,js,jsx,json,md,yml,yaml}\"",
+    "format:check": "prettier --check \"**/*.{ts,tsx,js,jsx,json,md,yml,yaml}\"",
+    "lint:ts": "eslint src test --ext .ts,.tsx --fix",
+    "lint": "npm run lint:ts",
+    "test:core": "TS_NODE_PROJECT=tsconfig.ts-node.json node --require ts-node/register --test test/*.test.ts test/**/*.test.ts",
+    "test:recipes": "TS_NODE_PROJECT=tsconfig.recipes.json node --require ts-node/register --test recipes/**/*.test.ts",
+    "pretest:all": "npm run lint",
+    "test:all": "TS_NODE_PROJECT=tsconfig.ts-node.json node --require ts-node/register --test test/*.test.ts test/**/*.test.ts recipes/**/*.test.ts",
+    "test:coverage": "c8 npm run test:all",
+    "ts:check": "tsc --noEmit --project tsconfig.typecheck.json",
+    "ts:check:test": "tsc --noEmit --project tsconfig.test.json",
+    "prebuild": "rimraf dist",
+    "build": "tsup",
+    "prepublishOnly": "npm run build"
   }
 }

package/HISTORY.md

@@ -1,187 +0,0 @@
-# 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/lib/API_tpl.hbs

@@ -1,7 +0,0 @@
-
-## API Reference
-{{#module name="koa-router"~}}
-  {{>body~}}
-  {{>member-index~}}
-  {{>members~}}
-{{/module~}}

package/lib/layer.js

@@ -1,262 +0,0 @@
-const { parse: parseUrl, format: formatUrl } = require('node:url');
-
-const { pathToRegexp, compile, parse } = require('path-to-regexp');
-
-module.exports = class Layer {
-  /**
-   * Initialize a new routing Layer with given `method`, `path`, and `middleware`.
-   *
-   * @param {String|RegExp} path Path string or regular expression.
-   * @param {Array} methods Array of HTTP verbs.
-   * @param {Array} middleware Layer callback/middleware or series of.
-   * @param {Object=} opts
-   * @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
-   */
-  constructor(path, methods, middleware, opts = {}) {
-    this.opts = opts;
-    this.name = this.opts.name || null;
-    this.methods = [];
-    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];
-      const type = typeof fn;
-      if (type !== 'function')
-        throw new Error(
-          `${methods.toString()} \`${
-            this.opts.name || path
-          }\`: \`middleware\` must be a function, not \`${type}\``
-        );
-    }
-
-    this.path = path;
-    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;
-    }
-  }
-
-  /**
-   * Returns whether request `path` matches route.
-   *
-   * @param {String} path
-   * @returns {Boolean}
-   * @private
-   */
-  match(path) {
-    return this.regexp.test(path);
-  }
-
-  /**
-   * Returns map of URL parameters for given `path` and `paramNames`.
-   *
-   * @param {String} path
-   * @param {Array.<String>} captures
-   * @param {Object=} params
-   * @returns {Object}
-   * @private
-   */
-  params(path, captures, params = {}) {
-    for (let len = captures.length, i = 0; i < len; i++) {
-      if (this.paramNames[i]) {
-        const c = captures[i];
-        if (c && c.length > 0)
-          params[this.paramNames[i].name] = c ? safeDecodeURIComponent(c) : c;
-      }
-    }
-
-    return params;
-  }
-
-  /**
-   * Returns array of regexp url path captures.
-   *
-   * @param {String} path
-   * @returns {Array.<String>}
-   * @private
-   */
-  captures(path) {
-    return this.opts.ignoreCaptures ? [] : path.match(this.regexp).slice(1);
-  }
-
-  /**
-   * Generate URL for route using given `params`.
-   *
-   * @example
-   *
-   * ```javascript
-   * const route = new Layer('/users/:id', ['GET'], fn);
-   *
-   * route.url({ id: 123 }); // => "/users/123"
-   * ```
-   *
-   * @param {Object} params url parameters
-   * @returns {String}
-   * @private
-   */
-  url(params, options) {
-    let args = params;
-    const url = this.path.replace(/\(\.\*\)/g, '');
-
-    if (typeof params !== 'object') {
-      args = Array.prototype.slice.call(arguments);
-      if (typeof args[args.length - 1] === 'object') {
-        options = args[args.length - 1];
-        args = args.slice(0, -1);
-      }
-    }
-
-    const toPath = compile(url, { encode: encodeURIComponent, ...options });
-    let replaced;
-    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++];
-        }
-      }
-    } else if (tokens.some((token) => token.name)) {
-      replace = params;
-    } else if (!options) {
-      options = params;
-    }
-
-    for (const [key, value] of Object.entries(replace)) {
-      replace[key] = String(value);
-    }
-
-    replaced = toPath(replace);
-
-    if (options && options.query) {
-      replaced = parseUrl(replaced);
-      if (typeof options.query === 'string') {
-        replaced.search = options.query;
-      } else {
-        replaced.search = undefined;
-        replaced.query = options.query;
-      }
-
-      return formatUrl(replaced);
-    }
-
-    return replaced;
-  }
-
-  /**
-   * Run validations on route named parameters.
-   *
-   * @example
-   *
-   * ```javascript
-   * router
-   *   .param('user', function (id, ctx, next) {
-   *     ctx.user = users[id];
-   *     if (!ctx.user) return ctx.status = 404;
-   *     next();
-   *   })
-   *   .get('/users/:user', function (ctx, next) {
-   *     ctx.body = ctx.user;
-   *   });
-   * ```
-   *
-   * @param {String} param
-   * @param {Function} middleware
-   * @returns {Layer}
-   * @private
-   */
-  param(param, fn) {
-    const { stack } = this;
-    const params = this.paramNames;
-    const middleware = function (ctx, next) {
-      return fn.call(this, ctx.params[param], ctx, next);
-    };
-
-    middleware.param = param;
-
-    const names = params.map(function (p) {
-      return p.name;
-    });
-
-    const x = names.indexOf(param);
-    if (x > -1) {
-      // iterate through the stack, to figure out where to place the handler fn
-      stack.some((fn, i) => {
-        // param handlers are always first, so when we find an fn w/o a param property, stop here
-        // if the param handler at this part of the stack comes after the one we are adding, stop here
-        if (!fn.param || names.indexOf(fn.param) > x) {
-          // inject this param handler right before the current item
-          stack.splice(i, 0, middleware);
-          return true; // then break the loop
-        }
-      });
-    }
-
-    return this;
-  }
-
-  /**
-   * Prefix route path.
-   *
-   * @param {String} prefix
-   * @returns {Layer}
-   * @private
-   */
-  setPrefix(prefix) {
-    if (this.path) {
-      this.path =
-        this.path !== '/' || this.opts.strict === true
-          ? `${prefix}${this.path}`
-          : prefix;
-      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;
-  }
-};
-
-/**
- * Safe decodeURIComponent, won't throw any error.
- * If `decodeURIComponent` error happen, just return the original value.
- *
- * @param {String} text
- * @returns {String} URL decode original string.
- * @private
- */
-
-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 {
-    return text;
-  }
-}