@eggjs/router 2.1.0 → 2.2.0

package/README.md

@@ -28,16 +28,18 @@ Router core component for [Egg.js](https://github.com/eggjs).
       - [Router.url(path, params \[, options\]) ⇒ String](#routerurlpath-params--options--string)
   - [Tests](#tests)
   - [License](#license)
+  - [Contributors](#contributors)
 
 <a name="exp_module_egg-router--Router"></a>
 
 ### Router ⏏
+
 **Kind**: Exported class
 <a name="new_module_egg-router--Router_new"></a>
 
 #### new Router([opts])
-Create a new router.
 
+Create a new router.
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -62,9 +64,11 @@ app
   .use(router.routes())
   .use(router.allowedMethods());
 ```
+
 <a name="module_egg-router--Router+get|put|post|patch|delete|del"></a>
 
 #### router.get|put|post|patch|delete|del ⇒ <code>Router</code>
+
 Create `router.verb()` methods, where *verb* is one of the HTTP verbs such
 as `router.get()` or `router.post()`.
 
@@ -188,12 +192,14 @@ used to convert paths to regular expressions.
 <a name="module_egg-router--Router+routes"></a>
 
 #### router.routes ⇒ <code>function</code>
+
 Returns router middleware which dispatches a route matching the request.
 
 **Kind**: instance property of <code>[Router](#exp_module_egg-router--Router)</code>
 <a name="module_egg-router--Router+use"></a>
 
 #### router.use([path], middleware) ⇒ <code>Router</code>
+
 Use given middleware.
 
 Middleware run in the order they are defined by `.use()`. They are invoked
@@ -209,6 +215,7 @@ sequentially, requests start at the first middleware and work their way
 | [...] | <code>function</code> |
 
 **Example**
+
 ```javascript
 // session middleware will run before authorize
 router
@@ -223,9 +230,11 @@ router.use(['/users', '/admin'], userAuth());
 
 app.use(router.routes());
 ```
+
 <a name="module_egg-router--Router+prefix"></a>
 
 #### router.prefix(prefix) ⇒ <code>Router</code>
+
 Set the path prefix for a Router instance that was already initialized.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
@@ -235,12 +244,15 @@ Set the path prefix for a Router instance that was already initialized.
 | prefix | <code>String</code> |
 
 **Example**
+
 ```javascript
 router.prefix('/things/:thing_id')
 ```
+
 <a name="module_egg-router--Router+allowedMethods"></a>
 
 #### router.allowedMethods([options]) ⇒ <code>function</code>
+
 Returns separate middleware for responding to `OPTIONS` requests with
 an `Allow` header containing the allowed methods, as well as responding
 with `405 Method Not Allowed` and `501 Not Implemented` as appropriate.
@@ -255,6 +267,7 @@ with `405 Method Not Allowed` and `501 Not Implemented` as appropriate.
 | [options.methodNotAllowed] | <code>function</code> | throw the returned value in place of the default MethodNotAllowed error |
 
 **Example**
+
 ```javascript
 var Koa = require('koa');
 var Router = require('egg-router');
@@ -283,9 +296,11 @@ app.use(router.allowedMethods({
   methodNotAllowed: () => new Boom.methodNotAllowed()
 }));
 ```
+
 <a name="module_egg-router--Router+redirect"></a>
 
 #### router.redirect(source, destination, [code]) ⇒ <code>Router</code>
+
 Redirect `source` to `destination` URL with optional 30x status `code`.
 
 Both `source` and `destination` can be route names.
@@ -314,6 +329,7 @@ router.all('/login', ctx => {
 <a name="module_egg-router--Router+route"></a>
 
 #### router.route(name) ⇒ <code>Layer</code> &#124; <code>false</code>
+
 Lookup route with given `name`.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
@@ -325,6 +341,7 @@ Lookup route with given `name`.
 <a name="module_egg-router--Router+url"></a>
 
 #### router.url(name, params, [options]) ⇒ <code>String</code> &#124; <code>Error</code>
+
 Generate URL for route. Takes a route name and map of named `params`.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
@@ -337,6 +354,7 @@ Generate URL for route. Takes a route name and map of named `params`.
 | [options.query] | <code>Object</code> &#124; <code>String</code> | query options |
 
 **Example**
+
 ```javascript
 router.get('user', '/users/:id', (ctx, next) => {
   // ...
@@ -359,9 +377,11 @@ router.url('user', { id: 3 }, { query: { limit: 1 } });
 router.url('user', { id: 3 }, { query: "limit=1" });
 // => "/users/3?limit=1"
 ```
+
 <a name="module_egg-router--Router+param"></a>
 
 #### router.param(param, middleware) ⇒ <code>Router</code>
+
 Run middleware for named route parameters. Useful for auto-loading or
 validation.
 
@@ -373,6 +393,7 @@ validation.
 | middleware | <code>function</code> |
 
 **Example**
+
 ```javascript
 router
   .param('user', (id, ctx, next) => {
@@ -391,9 +412,11 @@ router
   // /users/3 => {"id": 3, "name": "Alex"}
   // /users/3/friends => [{"id": 4, "name": "TJ"}]
 ```
+
 <a name="module_egg-router--Router.url"></a>
 
 #### Router.url(path, params [, options]) ⇒ <code>String</code>
+
 Generate URL from url pattern and given `params`.
 
 **Kind**: static method of <code>[Router](#exp_module_egg-router--Router)</code>
@@ -406,6 +429,7 @@ Generate URL from url pattern and given `params`.
 | [options.query] | <code>Object</code> &#124; <code>String</code> | query options |
 
 **Example**
+
 ```javascript
 var url = Router.url('/users/:id', {id: 1});
 // => "/users/1"
@@ -421,3 +445,9 @@ Run tests using `npm test`.
 ## License
 
 [MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/router)](https://github.com/eggjs/router/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/lib/layer.js

@@ -1,7 +1,8 @@
 'use strict';
 
 const debug = require('util').debuglog('egg-router:layer');
-const pathToRegExp = require('path-to-regexp');
+const assert = require('assert');
+const pathToRegexpModule = require('path-to-regexp');
 const uri = require('urijs');
 const utility = require('utility');
 
@@ -16,10 +17,15 @@ 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 {Object=} opts.pathToRegexpModule custom path-to-regexp module
    * @private
    */
   constructor(path, methods, middleware, opts) {
     this.opts = opts || {};
+    this._pathToRegexpModule = this.opts.pathToRegexpModule || pathToRegexpModule;
+    // support path-to-regexp@8 and path-to-regexp@1
+    this._pathToRegexp = this._pathToRegexpModule.pathToRegexp || this._pathToRegexpModule;
+    assert(typeof this._pathToRegexp === 'function', 'opts.pathToRegexpModule.pathToRegexp must be a function');
     this.name = this.opts.name || null;
     this.methods = [];
     this.paramNames = [];
@@ -44,11 +50,22 @@ module.exports = class Layer {
     }, this);
 
     this.path = path;
-    this.regexp = pathToRegExp(path, this.paramNames, this.opts);
-
+    const { regexp, keys } = this._convertPathToRegexp(path, this.opts);
+    this.regexp = regexp;
+    this.paramNames = keys;
     debug('defined route %s %s', this.methods, this.opts.prefix + this.path);
   }
 
+  _convertPathToRegexp(path, options) {
+    let regexp = this._pathToRegexp(path, [], options);
+    const keys = regexp.keys;
+    if (regexp.regexp) {
+      // support path-to-regexp@8
+      regexp = regexp.regexp;
+    }
+    return { regexp, keys };
+  }
+
   /**
    * Returns whether request `path` matches route.
    *
@@ -112,7 +129,7 @@ module.exports = class Layer {
   url(params, options) {
     let args = params;
     const url = this.path.replace(/\(\.\*\)/g, '');
-    const toPath = pathToRegExp.compile(url);
+    const toPath = this._pathToRegexpModule.compile(url);
 
     if (typeof params !== 'object') {
       args = Array.prototype.slice.call(arguments);
@@ -122,7 +139,7 @@ module.exports = class Layer {
       }
     }
 
-    const tokens = pathToRegExp.parse(url);
+    const tokens = this._pathToRegexpModule.parse(url);
     let replace = {};
 
     if (args instanceof Array) {
@@ -209,7 +226,9 @@ module.exports = class Layer {
     if (this.path) {
       this.path = prefix + this.path;
       this.paramNames = [];
-      this.regexp = pathToRegExp(this.path, this.paramNames, this.opts);
+      const { regexp, keys } = this._convertPathToRegexp(this.path, this.opts);
+      this.regexp = regexp;
+      this.paramNames = keys;
     }
 
     return this;

package/lib/router.js

@@ -8,6 +8,7 @@ const debug = require('util').debuglog('egg-router');
 const compose = require('koa-compose');
 const HttpError = require('http-errors');
 const methods = require('methods');
+const pathToRegexpModule = require('path-to-regexp');
 const Layer = require('./layer');
 
 /**
@@ -86,6 +87,7 @@ class Router {
    * @param {Function} middleware middleware function
    * @return {Router} router instance
    */
+
   use(/* path, middleware */) {
     const router = this;
     const middleware = Array.prototype.slice.call(arguments);
@@ -172,7 +174,9 @@ class Router {
 
       ctx.router = router;
 
-      if (!matched.route) return next();
+      if (!matched.route) {
+        return next();
+      }
 
       const matchedLayers = matched.pathAndMethod;
       const layerChain = matchedLayers.reduce(function(memo, layer) {
@@ -303,6 +307,7 @@ class Router {
    * @return {Router} router instance
    * @private
    */
+
   all(name, path/* , middleware */) {
     let middleware;
 
@@ -394,6 +399,7 @@ class Router {
       strict: opts.strict || this.opts.strict || false,
       prefix: opts.prefix || this.opts.prefix || '',
       ignoreCaptures: opts.ignoreCaptures,
+      pathToRegexpModule: this.opts.pathToRegexpModule,
     });
 
     if (this.opts.prefix) {
@@ -462,6 +468,7 @@ class Router {
    * @param {Object|String} [options.query] query options
    * @return {String|Error} string or error instance
    */
+
   url(name/* , params */) {
     const route = this.route(name);
 
@@ -497,14 +504,16 @@ class Router {
     for (let len = layers.length, i = 0; i < len; i++) {
       layer = layers[i];
 
-      debug('test %s %s', layer.path, layer.regexp);
+      debug('test %s %o', layer.path, layer.regexp);
 
       if (layer.match(path)) {
         matched.path.push(layer);
 
         if (layer.methods.length === 0 || layer.methods.includes(method)) {
           matched.pathAndMethod.push(layer);
-          if (layer.methods.length) matched.route = true;
+          if (layer.methods.length) {
+            matched.route = true;
+          }
         }
         // if (layer.methods.length === 0) {
         //   matched.pathAndMethod.push(layer);
@@ -563,7 +572,7 @@ class Router {
  * Match URL patterns to callback functions or controller actions using `router.verb()`,
  * where **verb** is one of the HTTP verbs such as `router.get()` or `router.post()`.
  *
- * Additionaly, `router.all()` can be used to match against all methods.
+ * Additionally, `router.all()` can be used to match against all methods.
  *
  * ```javascript
  * router
@@ -706,7 +715,7 @@ Router.prototype.del = Router.prototype.delete;
  * @example
  *
  * ```javascript
- * var url = Router.url('/users/:id', {id: 1});
+ * var url = Router.url('/users/:id', { id: 1 });
  * // => "/users/1"
  * ```
  *
@@ -714,9 +723,10 @@ Router.prototype.del = Router.prototype.delete;
  * @param {Object} params url parameters
  * @return {String} url string
  */
+
 Router.url = function(path/* , params */) {
   const args = Array.prototype.slice.call(arguments, 1);
-  return Layer.prototype.url.apply({ path }, args);
+  return Layer.prototype.url.apply({ path, _pathToRegexpModule: pathToRegexpModule }, args);
 };
 
 Router.prototype.middleware = Router.prototype.routes;

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "@eggjs/router",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "engines": {
     "node": ">= 8.5.0"
   },
   "publishConfig": {
-    "access": "public",
-    "tag": "latest-2"
+    "access": "public"
   },
   "description": "Router middleware for egg/koa. Provides RESTful resource routing.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/eggjs/egg-router.git"
+    "url": "git@github.com:eggjs/router.git"
   },
   "bugs": {
     "url": "https://github.com/eggjs/egg/issues"
@@ -46,7 +45,8 @@
     "koa": "^2.7.0",
     "mocha": "^2.0.1",
     "should": "^6.0.3",
-    "supertest": "^1.0.1"
+    "supertest": "^1.0.1",
+    "path-to-regexp-v8": "npm:path-to-regexp@8"
   },
   "scripts": {
     "test-local": "egg-bin test",