@koa/router 13.1.1 → 15.0.0

package/dist/types.d.mts

@@ -0,0 +1,3 @@
+import 'koa';
+export { A as AllowedMethodsOptions, H as HttpMethod, default as Layer, L as LayerOptions, M as MatchResult, d as RouterContext, e as RouterMiddleware, a as RouterOptions, b as RouterParameterContext, c as RouterParameterMiddleware, U as UrlOptions } from './layer.mjs';
+import 'path-to-regexp';

package/dist/types.d.ts

@@ -0,0 +1,3 @@
+import 'koa';
+export { A as AllowedMethodsOptions, H as HttpMethod, default as Layer, L as LayerOptions, M as MatchResult, d as RouterContext, e as RouterMiddleware, a as RouterOptions, b as RouterParameterContext, c as RouterParameterMiddleware, U as UrlOptions } from './layer.js';
+import 'path-to-regexp';

package/dist/types.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/types.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

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": "15.0.0",
   "author": "Alex Mingoia <talk@alexmingoia.com>",
   "bugs": {
     "url": "https://github.com/koajs/router/issues",
@@ -21,34 +21,53 @@
     }
   ],
   "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": "^6.3.0"
+    "path-to-regexp": "^8.3.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",
-    "fixpack": "^4.0.0",
-    "husky": "^8.0.3",
-    "jsdoc-to-markdown": "^8.0.0",
-    "koa": "^2.15.3",
-    "lint-staged": "^14.0.1",
-    "mocha": "^10.7.3",
-    "nyc": "^17.0.0",
-    "remark-cli": "11",
-    "remark-preset-github": "^4.0.4",
-    "supertest": "^7.0.0",
-    "xo": "0.53.1"
+    "@commitlint/cli": "^20.1.0",
+    "@commitlint/config-conventional": "^20.0.0",
+    "@types/debug": "^4.1.12",
+    "@types/jsonwebtoken": "^9.0.7",
+    "@types/koa": "^3.0.1",
+    "@types/node": "^24.10.1",
+    "@types/supertest": "^6.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.48.0",
+    "@typescript-eslint/parser": "^8.48.0",
+    "c8": "^10.1.3",
+    "chalk": "^5.4.1",
+    "eslint": "^9.39.1",
+    "eslint-plugin-unicorn": "^62.0.0",
+    "husky": "^9.1.7",
+    "joi": "^18.0.2",
+    "jsonwebtoken": "^9.0.2",
+    "koa": "^3.1.1",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.7.1",
+    "rimraf": "^6.1.2",
+    "supertest": "^7.1.4",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
   },
   "engines": {
-    "node": ">= 18"
+    "node": ">= 20"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
   },
   "files": [
-    "lib"
+    "dist",
+    "LICENSE",
+    "README.md"
   ],
   "homepage": "https://github.com/koajs/router",
   "keywords": [
@@ -58,19 +77,28 @@
     "router"
   ],
   "license": "MIT",
-  "main": "lib/router.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/koajs/router.git"
   },
   "scripts": {
-    "bench": "make -C bench",
-    "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",
+    "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",
+    "prebuild": "rimraf dist",
+    "build": "tsup",
+    "prepublishOnly": "npm run build"
   }
 }

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,240 +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)
-   * @returns {Layer}
-   * @private
-   */
-  constructor(path, methods, middleware, opts = {}) {
-    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');
-    }
-
-    // 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.regexp = pathToRegexp(path, this.paramNames, this.opts);
-  }
-
-  /**
-   * 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;
-    }
-
-    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;
-      this.paramNames = [];
-      this.regexp = pathToRegexp(this.path, this.paramNames, this.opts);
-    }
-
-    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;
-  }
-}