@koa/router - npm Package Compare versions

Comparing version 10.0.0 to 11.0.2

lib/layer.js

@@ -0,3 +1,3 @@
+const { parse: parseUrl, format: formatUrl } = require('url');
 const { pathToRegexp, compile, parse } = require('path-to-regexp');
-const { parse: parseUrl, format: formatUrl } = require('url');
 
@@ -20,4 +20,4 @@ module.exports = Layer;
 
-function Layer(path, methods, middleware, opts) {
-  this.opts = opts || {};
+function Layer(path, methods, middleware, opts = {}) {
+  this.opts = opts;
   this.name = this.opts.name || null;
@@ -28,5 +28,5 @@ this.methods = [];
 
-  for(let i = 0; i < methods.length; i++) {
-    const l = this.methods.push(methods[i].toUpperCase());
-    if (this.methods[l-1] === 'GET') this.methods.unshift('HEAD');
+  for (const method of methods) {
+    const l = this.methods.push(method.toUpperCase());
+    if (this.methods[l - 1] === 'GET') this.methods.unshift('HEAD');
   }
@@ -37,6 +37,8 @@
     const fn = this.stack[i];
-    const type = (typeof fn);
+    const type = typeof fn;
     if (type !== 'function')
       throw new Error(
-        `${methods.toString()} \`${this.opts.name || path}\`: \`middleware\` must be a function, not \`${type}\``
+        `${methods.toString()} \`${
+          this.opts.name || path
+        }\`: \`middleware\` must be a function, not \`${type}\``
       );
@@ -47,3 +49,3 @@ }
   this.regexp = pathToRegexp(path, this.paramNames, this.opts);
-};
+}
 
@@ -67,3 +69,3 @@ /**
  * @param {Array.<String>} captures
- * @param {Object=} existingParams
+ * @param {Object=} params
  * @returns {Object}
@@ -73,9 +75,8 @@ * @private
 
-Layer.prototype.params = function (path, captures, existingParams) {
-  const params = existingParams || {};
-
-  for (let len = captures.length, i=0; i<len; i++) {
+Layer.prototype.params = function (path, captures, params = {}) {
+  for (let len = captures.length, i = 0; i < len; i++) {
     if (this.paramNames[i]) {
       const c = captures[i];
-      params[this.paramNames[i].name] = c ? safeDecodeURIComponent(c) : c;
+      if (c && c.length > 0)
+        params[this.paramNames[i].name] = c ? safeDecodeURIComponent(c) : c;
     }
@@ -119,7 +120,7 @@ }
 
-  if (typeof params != 'object') {
+  if (typeof params !== 'object') {
     args = Array.prototype.slice.call(arguments);
-    if (typeof args[args.length - 1] == 'object') {
+    if (typeof args[args.length - 1] === 'object') {
       options = args[args.length - 1];
-      args = args.slice(0, args.length - 1);
+      args = args.slice(0, -1);
     }
@@ -134,7 +135,7 @@ }
 
-  if (args instanceof Array) {
-    for (let len = tokens.length, i=0, j=0; i<len; i++) {
+  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)) {
+  } else if (tokens.some((token) => token.name)) {
     replace = params;
@@ -155,2 +156,3 @@ } else if (!options) {
     }
+
     return formatUrl(replaced);
@@ -171,3 +173,3 @@ }
  *     ctx.user = users[id];
- *     if (!user) return ctx.status = 404;
+ *     if (!ctx.user) return ctx.status = 404;
  *     next();
@@ -187,3 +189,3 @@ *   })
 Layer.prototype.param = function (param, fn) {
-  const stack = this.stack;
+  const { stack } = this;
   const params = this.paramNames;
@@ -193,2 +195,3 @@ const middleware = function (ctx, next) {
   };
+
   middleware.param = param;
@@ -227,3 +230,6 @@
   if (this.path) {
-    this.path = (this.path !== '/' || this.opts.strict === true) ? `${prefix}${this.path}` : prefix
+    this.path =
+      this.path !== '/' || this.opts.strict === true
+        ? `${prefix}${this.path}`
+        : prefix;
     this.paramNames = [];
@@ -248,5 +254,5 @@ this.regexp = pathToRegexp(this.path, this.paramNames, this.opts);
     return decodeURIComponent(text);
-  } catch (e) {
+  } catch {
     return text;
   }
 }

lib/router.js

@@ -8,9 +8,10 @@ /**
 
-const debug = require('debug')('koa-router');
 const compose = require('koa-compose');
 const HttpError = require('http-errors');
 const methods = require('methods');
+const { pathToRegexp } = require('path-to-regexp');
 const Layer = require('./layer');
-const { pathToRegexp } = require('path-to-regexp');
 
+const debug = require('debug')('koa-router');
+
 /**
@@ -47,10 +48,12 @@ * @module koa-router
  * @param {Object=} opts
+ * @param {Boolean=false} opts.exclusive only run last matched route's controller when there are multiple matches
  * @param {String=} opts.prefix prefix router paths
+ * @param {String|RegExp=} opts.host host for router match
  * @constructor
  */
 
-function Router(opts) {
+function Router(opts = {}) {
   if (!(this instanceof Router)) return new Router(opts);
 
-  this.opts = opts || {};
+  this.opts = opts;
   this.methods = this.opts.methods || [
@@ -65,6 +68,8 @@ 'HEAD',
   ];
+  this.exclusive = Boolean(this.opts.exclusive);
 
   this.params = {};
   this.stack = [];
-};
+  this.host = this.opts.host;
+}
 
@@ -78,3 +83,3 @@ /**
  *
- * Additionaly, `router.all()` can be used to match against all methods.
+ * Additionally, `router.all()` can be used to match against all methods.
  *
@@ -185,2 +190,20 @@ * ```javascript
  *
+ *
+ * ### Match host for each router instance
+ *
+ * ```javascript
+ * const router = new Router({
+ *    host: 'example.domain' // only match if request host exactly equal `example.domain`
+ * });
+ *
+ * ```
+ *
+ * OR host cloud be a regexp
+ *
+ * ```javascript
+ * const router = new Router({
+ *     host: /.*\.?example\.domain$/ // all host end with .example.domain would be matched
+ * });
+ * ```
+ *
  * @name get|put|post|patch|delete|del
@@ -194,6 +217,6 @@ * @memberof module:koa-router.prototype
 
-for (let i = 0; i < methods.length; i++) {
+for (const method_ of methods) {
   function setMethodVerb(method) {
-    Router.prototype[method] = function(name, path, middleware) {
-      if (typeof path === "string" || path instanceof RegExp) {
+    Router.prototype[method] = function (name, path, middleware) {
+      if (typeof path === 'string' || path instanceof RegExp) {
         middleware = Array.prototype.slice.call(arguments, 2);
@@ -206,13 +229,23 @@ } else {
 
-      this.register(path, [method], middleware, {
-        name: name
-      });
+      // Sanity check to ensure we have a viable path candidate (eg: string|regex|non-empty array)
+      if (
+        typeof path !== 'string' &&
+        !(path instanceof RegExp) &&
+        (!Array.isArray(path) || path.length === 0)
+      )
+        throw new Error(
+          `You have to provide a path when adding a ${method} handler`
+        );
 
+      this.register(path, [method], middleware, { name });
+
       return this;
     };
   }
-  setMethodVerb(methods[i]);
+
+  setMethodVerb(method_);
 }
 
 // Alias for `router.delete()` because delete is a reserved word
+// eslint-disable-next-line dot-notation
 Router.prototype.del = Router.prototype['delete'];
@@ -257,5 +290,4 @@
   if (Array.isArray(middleware[0]) && typeof middleware[0][0] === 'string') {
-    let arrPaths = middleware[0];
-    for (let i = 0; i < arrPaths.length; i++) {
-      const p = arrPaths[i];
+    const arrPaths = middleware[0];
+    for (const p of arrPaths) {
       router.use.apply(router, [p].concat(middleware.slice(1)));
@@ -270,8 +302,11 @@ }
 
-  for (let i = 0; i < middleware.length; i++) {
-    const m = middleware[i];
+  for (const m of middleware) {
     if (m.router) {
-      const cloneRouter = Object.assign(Object.create(Router.prototype), m.router, {
-        stack: m.router.stack.slice(0)
-      });
+      const cloneRouter = Object.assign(
+        Object.create(Router.prototype),
+        m.router,
+        {
+          stack: [...m.router.stack]
+        }
+      );
 
@@ -294,7 +329,7 @@ for (let j = 0; j < cloneRouter.stack.length; j++) {
           const routerParams = paramArr;
-          for (let j = 0; j < routerParams.length; j++) {
-            const key = routerParams[j];
+          for (const key of routerParams) {
             cloneRouter.param(key, router.params[key]);
           }
         }
+
         setRouterParams(Object.keys(router.params));
@@ -306,3 +341,6 @@ }
       const routerPrefixHasParam = router.opts.prefix && keys.length;
-      router.register(path || '([^\/]*)', [], m, { end: false, ignoreCaptures: !hasPath && !routerPrefixHasParam });
+      router.register(path || '([^/]*)', [], m, {
+        end: false,
+        ignoreCaptures: !hasPath && !routerPrefixHasParam
+      });
     }
@@ -349,5 +387,11 @@ }
 
-  let dispatch = function dispatch(ctx, next) {
+  const dispatch = function dispatch(ctx, next) {
     debug('%s %s', ctx.method, ctx.path);
 
+    const hostMatched = router.matchHost(ctx.host);
+
+    if (!hostMatched) {
+      return next();
+    }
+
     const path = router.opts.routerPath || ctx.routerPath || ctx.path;
@@ -367,4 +411,4 @@ const matched = router.match(path, ctx.method);
 
-    const matchedLayers = matched.pathAndMethod
-    const mostSpecificLayer = matchedLayers[matchedLayers.length - 1]
+    const matchedLayers = matched.pathAndMethod;
+    const mostSpecificLayer = matchedLayers[matchedLayers.length - 1];
     ctx._matchedRoute = mostSpecificLayer.path;
@@ -375,6 +419,12 @@ if (mostSpecificLayer.name) {
 
-    layerChain = matchedLayers.reduce(function(memo, layer) {
-      memo.push(function(ctx, next) {
+    layerChain = (
+      router.exclusive ? [mostSpecificLayer] : matchedLayers
+    ).reduce(function (memo, layer) {
+      memo.push(function (ctx, next) {
         ctx.captures = layer.captures(path, ctx.captures);
-        ctx.params = ctx.request.params = layer.params(path, ctx.captures, ctx.params);
+        ctx.params = ctx.request.params = layer.params(
+          path,
+          ctx.captures,
+          ctx.params
+        );
         ctx.routerPath = layer.path;
@@ -386,2 +436,3 @@ ctx.routerName = layer.name;
         }
+
         return next();
@@ -443,8 +494,7 @@ });
 
-Router.prototype.allowedMethods = function (options) {
-  options = options || {};
+Router.prototype.allowedMethods = function (options = {}) {
   const implemented = this.methods;
 
   return function allowedMethods(ctx, next) {
-    return next().then(function() {
+    return next().then(function () {
       const allowed = {};
@@ -465,5 +515,6 @@
           if (options.throw) {
-            let notImplementedThrowable = (typeof options.notImplemented === 'function')
-            ? options.notImplemented()  // set whatever the user returns from their function
-            : new HttpError.NotImplemented();
+            const notImplementedThrowable =
+              typeof options.notImplemented === 'function'
+                ? options.notImplemented() // set whatever the user returns from their function
+                : new HttpError.NotImplemented();
 
@@ -475,3 +526,3 @@ throw notImplementedThrowable;
           }
-        } else if (allowedArr.length) {
+        } else if (allowedArr.length > 0) {
           if (ctx.method === 'OPTIONS') {
@@ -483,5 +534,6 @@ ctx.status = 200;
             if (options.throw) {
-              let notAllowedThrowable = (typeof options.methodNotAllowed === 'function')
-              ? options.methodNotAllowed() // set whatever the user returns from their function
-              : new HttpError.MethodNotAllowed();
+              const notAllowedThrowable =
+                typeof options.methodNotAllowed === 'function'
+                  ? options.methodNotAllowed() // set whatever the user returns from their function
+                  : new HttpError.MethodNotAllowed();
 
@@ -508,3 +560,2 @@ throw notAllowedThrowable;
  * @returns {Router}
- * @private
  */
@@ -521,2 +572,10 @@
 
+  // Sanity check to ensure we have a viable path candidate (eg: string|regex|non-empty array)
+  if (
+    typeof path !== 'string' &&
+    !(path instanceof RegExp) &&
+    (!Array.isArray(path) || path.length === 0)
+  )
+    throw new Error('You have to provide a path when adding an all handler');
+
   this.register(path, methods, middleware, { name });
@@ -553,8 +612,17 @@
   // lookup source route by name
-  if (source[0] !== '/') source = this.url(source);
+  if (typeof source === 'symbol' || source[0] !== '/') {
+    source = this.url(source);
+    if (source instanceof Error) throw source;
+  }
 
   // lookup destination route by name
-  if (destination[0] !== '/' && !destination.includes('://')) destination = this.url(destination);
+  if (
+    typeof destination === 'symbol' ||
+    (destination[0] !== '/' && !destination.includes('://'))
+  ) {
+    destination = this.url(destination);
+    if (destination instanceof Error) throw destination;
+  }
 
-  return this.all(source, ctx => {
+  return this.all(source, (ctx) => {
     ctx.redirect(destination);
@@ -575,12 +643,9 @@ ctx.status = code || 301;
 
-Router.prototype.register = function (path, methods, middleware, opts) {
-  opts = opts || {};
-
+Router.prototype.register = function (path, methods, middleware, opts = {}) {
   const router = this;
-  const stack = this.stack;
+  const { stack } = this;
 
   // support array of paths
   if (Array.isArray(path)) {
-    for (let i = 0; i < path.length; i++) {
-      const curPath = path[i];
+    for (const curPath of path) {
       router.register.call(router, curPath, methods, middleware, opts);
@@ -598,3 +663,3 @@ }
     strict: opts.strict || this.opts.strict || false,
-    prefix: opts.prefix || this.opts.prefix || "",
+    prefix: opts.prefix || this.opts.prefix || '',
     ignoreCaptures: opts.ignoreCaptures
@@ -630,3 +695,3 @@ });
 
-  for (let len = routes.length, i=0; i<len; i++) {
+  for (let len = routes.length, i = 0; i < len; i++) {
     if (routes[i].name && routes[i].name === name) return routes[i];
@@ -681,3 +746,3 @@ }
 
-  return new Error(`No route found for name: ${name}`);
+  return new Error(`No route found for name: ${String(name)}`);
 };
@@ -709,2 +774,3 @@
 
+    // eslint-disable-next-line unicorn/prefer-regexp-test
     if (layer.match(path)) {
@@ -715,3 +781,3 @@ matched.path.push(layer);
         matched.pathAndMethod.push(layer);
-        if (layer.methods.length) matched.route = true;
+        if (layer.methods.length > 0) matched.route = true;
       }
@@ -725,2 +791,28 @@ }
 /**
+ * Match given `input` to allowed host
+ * @param {String} input
+ * @returns {boolean}
+ */
+
+Router.prototype.matchHost = function (input) {
+  const { host } = this;
+
+  if (!host) {
+    return true;
+  }
+
+  if (!input) {
+    return false;
+  }
+
+  if (typeof host === 'string') {
+    return input === host;
+  }
+
+  if (typeof host === 'object' && host instanceof RegExp) {
+    return host.test(input);
+  }
+};
+
+/**
  * Run middleware for named route parameters. Useful for auto-loading or
@@ -755,3 +847,3 @@ * validation.
 
-Router.prototype.param = function(param, middleware) {
+Router.prototype.param = function (param, middleware) {
   this.params[param] = middleware;
@@ -758,0 +850,0 @@ for (let i = 0; i < this.stack.length; i++) {

package.json

 {
   "name": "@koa/router",
-  "description": "Router middleware for koa. Provides RESTful resource routing.",
-  "version": "10.0.0",
+  "description": "Router middleware for koa. Maintained by Forward Email and Lad.",
+  "version": "11.0.2",
   "author": "Alex Mingoia <[e-mail]>",
@@ -10,22 +10,38 @@ "bugs": {
   },
+  "contributors": [
+    "Alex Mingoia <[e-mail]>",
+    "@koajs"
+  ],
   "dependencies": {
-    "debug": "^4.1.1",
-    "http-errors": "^1.7.3",
+    "debug": "^4.3.4",
+    "http-errors": "^2.0.0",
     "koa-compose": "^4.1.0",
     "methods": "^1.1.2",
-    "path-to-regexp": "^6.1.0"
+    "path-to-regexp": "^6.2.1"
   },
   "devDependencies": {
-    "@ladjs/env": "^1.0.0",
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
+    "@ladjs/env": "^3.0.0",
+    "ava": "^4.3.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.19.0",
+    "eslint-config-xo-lass": "^2.0.1",
     "expect.js": "^0.3.1",
-    "jsdoc-to-markdown": "^5.0.3",
-    "koa": "^2.11.0",
-    "mocha": "^7.0.1",
-    "nyc": "^15.0.0",
+    "fixpack": "^4.0.0",
+    "husky": "^8.0.1",
+    "jsdoc-to-markdown": "^7.1.1",
+    "koa": "^2.13.4",
+    "lint-staged": "^13.0.3",
+    "mocha": "^10.0.0",
+    "nyc": "^15.1.0",
+    "remark-cli": "^11.0.0",
+    "remark-preset-github": "^4.0.4",
     "should": "^13.2.3",
-    "supertest": "^4.0.2",
-    "wrk": "^1.2.0"
+    "supertest": "^6.2.4",
+    "wrk": "^1.2.1",
+    "xo": "^0.50.0"
   },
   "engines": {
-    "node": ">= 8.0.0"
+    "node": ">= 12"
   },
@@ -49,7 +65,11 @@ "files": [
   "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",
+    "prepare": "husky install",
+    "pretest": "npm run lint",
     "test": "mocha test/**/*.js",
-    "coverage": "nyc npm run test",
-    "bench": "make -C bench"
+    "test:watch": "mocha test/**/*.js --watch"
   }
 }

README.md

 # [@koa/router](https://github.com/koajs/router)
 
-> Router middleware for [Koa](https://github.com/koajs/koa).
+> Router middleware for [Koa](https://github.com/koajs/koa). Maintained by [Forward Email][forward-email] and [Lad][].
 
-[![NPM version](https://img.shields.io/npm/v/@koa/router.svg?style=flat)](https://npmjs.org/package/@koa/router) 
-[![NPM Downloads](https://img.shields.io/npm/dm/@koa/router.svg?style=flat)](https://npmjs.org/package/@koa/router) 
-[![Node.js Version](https://img.shields.io/node/v/@koa/router.svg?style=flat)](http://nodejs.org/download/)
-[![Build Status](https://img.shields.io/travis/koajs/router.svg?style=flat)](http://travis-ci.org/koajs/router)
-[![gitter](https://img.shields.io/gitter/room/koajs/koa.svg?style=flat)](https://gitter.im/koajs/koa)
+[![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)
+[![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)
 
+
+## Table of Contents
+
+* [Features](#features)
+* [Migrating to 7 / Koa 2](#migrating-to-7--koa-2)
+* [Install](#install)
+* [Typescript Support](#typescript-support)
+* [API Reference](#api-reference)
+* [Contributors](#contributors)
+* [License](#license)
+
+
+## Features
+
 * Express-style routing (`app.get`, `app.put`, `app.post`, etc.)
 * Named URL parameters
 * Named routes with URL generation
+* Match routes with specific host
 * Responds to `OPTIONS` requests with allowed methods
@@ -20,37 +35,52 @@ * Support for `405 Method Not Allowed` and `501 Not Implemented`
 
+
 ## Migrating to 7 / Koa 2
 
-- The API has changed to match the new promise-based middleware
+* 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()`,
+* Middleware is now always run in the order declared by `.use()` (or `.get()`,
   etc.), which matches Express 4 API.
 
-## Installation
 
-```bash
-# npm .. 
-npm i @koa/router
-# yarn .. 
-yarn add @koa/router
+## Install
+
+[npm][]:
+
+```sh
+npm install @koa/router
 ```
 
-## [API Reference](./API.md)
 
-## Contributing
+## Typescript Support
 
-Please submit all issues and pull requests to the [koajs/router](http://github.com/koajs/router) repository!
+```sh
+npm install @types/koa__router
+```
 
-## Support
 
-If you have any problem or suggestion please open an issue [here](https://github.com/koajs/router/issues).
+## API Reference
 
-## Call for Maintainers
+See [API Reference](./API.md) for more documentation.
 
-This module is forked from the original [koa-router](https://github.com/ZijianHe/koa-router) due to its lack of activity. `koa-router` is the most widely used router module in the Koa community and we need maintainers. If you're interested in fixing bugs or implementing new features feel free to open a pull request. We'll be adding active contributors as collaborators.
 
-Thanks to the original authors @alexmingoia and the original team for their great work.
+## Contributors
 
-### License
+| Name             |
+| ---------------- |
+| **Alex Mingoia** |
+| **@koajs**       |
 
-[MIT](LICENSE)
+
+## License
+
+[MIT](LICENSE) © Alex Mingoia
+
+
+##
+
+[forward-email]: https://forwardemail.net
+
+[lad]: https://lad.js.org
+
+[npm]: https//www.npmjs.com

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Lines of code

957

increased by9.62%

Number of medium maintenance alerts

0

decreased by-100%

Number of lines in readme file

86

increased by56.36%

Worsened metrics

Total package byte prevSize

32152

decreased by-9.69%

Dev dependency count

21

increased by133.33%

Number of package files

6

decreased by-14.29%