@eggjs/router 2.0.1 → 2.1.1

package/README.md

@@ -3,36 +3,42 @@
 Router core component for [Egg.js](https://github.com/eggjs).
 
 > **This repository is a fork of [koa-router](https://github.com/alexmingoia/koa-router).** with some additional features.
-
-> And thanks for the greate work of @alexmingoia and the original team.
+> And thanks for the great work of @alexmingoia and the original team.
 
 ## API Reference
 
-* [egg-router](#module_egg-router)
-    * [Router](#exp_module_egg-router--Router) ⏏
-        * [new Router([opts])](#new_module_egg-router--Router_new)
-        * _instance_
-            * [.get|put|post|patch|delete|del](#module_egg-router--Router+get|put|post|patch|delete|del) ⇒ <code>Router</code>
-            * [.routes](#module_egg-router--Router+routes) ⇒ <code>function</code>
-            * [.use([path], middleware)](#module_egg-router--Router+use) ⇒ <code>Router</code>
-            * [.prefix(prefix)](#module_egg-router--Router+prefix) ⇒ <code>Router</code>
-            * [.allowedMethods([options])](#module_egg-router--Router+allowedMethods) ⇒ <code>function</code>
-            * [.redirect(source, destination, [code])](#module_egg-router--Router+redirect) ⇒ <code>Router</code>
-            * [.route(name)](#module_egg-router--Router+route) ⇒ <code>Layer</code> &#124; <code>false</code>
-            * [.url(name, params, [options])](#module_egg-router--Router+url) ⇒ <code>String</code> &#124; <code>Error</code>
-            * [.param(param, middleware)](#module_egg-router--Router+param) ⇒ <code>Router</code>
-        * _static_
-            * [.url(path, params)](#module_egg-router--Router.url) ⇒ <code>String</code>
+- [@eggjs/router](#eggjsrouter)
+  - [API Reference](#api-reference)
+    - [Router ⏏](#router-)
+      - [new Router(\[opts\])](#new-routeropts)
+      - [router.get|put|post|patch|delete|del ⇒ Router](#routergetputpostpatchdeletedel--router)
+      - [Named routes](#named-routes)
+      - [Multiple middleware](#multiple-middleware)
+    - [Nested routers](#nested-routers)
+      - [Router prefixes](#router-prefixes)
+      - [URL parameters](#url-parameters)
+      - [router.routes ⇒ function](#routerroutes--function)
+      - [router.use(\[path\], middleware) ⇒ Router](#routerusepath-middleware--router)
+      - [router.prefix(prefix) ⇒ Router](#routerprefixprefix--router)
+      - [router.allowedMethods(\[options\]) ⇒ function](#routerallowedmethodsoptions--function)
+      - [router.redirect(source, destination, \[code\]) ⇒ Router](#routerredirectsource-destination-code--router)
+      - [router.route(name) ⇒ Layer | false](#routerroutename--layer--false)
+      - [router.url(name, params, \[options\]) ⇒ String | Error](#routerurlname-params-options--string--error)
+      - [router.param(param, middleware) ⇒ Router](#routerparamparam-middleware--router)
+      - [Router.url(path, params \[, options\]) ⇒ String](#routerurlpath-params--options--string)
+  - [Tests](#tests)
+  - [License](#license)
 
 <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 |
 | --- | --- | --- |
@@ -57,9 +63,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()`.
 
@@ -183,12 +191,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
@@ -204,6 +214,7 @@ sequentially, requests start at the first middleware and work their way
 | [...] | <code>function</code> |
 
 **Example**
+
 ```javascript
 // session middleware will run before authorize
 router
@@ -218,9 +229,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>
@@ -230,12 +243,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.
@@ -250,6 +266,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');
@@ -278,9 +295,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.
@@ -309,6 +328,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>
@@ -320,6 +340,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>
@@ -332,6 +353,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) => {
   // ...
@@ -354,9 +376,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.
 
@@ -368,6 +392,7 @@ validation.
 | middleware | <code>function</code> |
 
 **Example**
+
 ```javascript
 router
   .param('user', (id, ctx, next) => {
@@ -386,9 +411,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>
@@ -401,6 +428,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"
@@ -412,3 +440,7 @@ const url = Router.url('/users/:id', {id: 1}, {query: { active: true }});
 ## Tests
 
 Run tests using `npm test`.
+
+## License
+
+[MIT](LICENSE)

package/lib/egg_router.js

@@ -1,11 +1,10 @@
 'use strict';
 
-const is = require('is-type-of');
-const Router = require('./router');
 const utility = require('utility');
 const inflection = require('inflection');
 const assert = require('assert');
 const utils = require('./utils');
+const Router = require('./router');
 
 const METHODS = [ 'head', 'options', 'get', 'put', 'patch', 'post', 'delete' ];
 
@@ -138,6 +137,7 @@ class EggRouter extends Router {
    * @return {Router} return route object.
    * @since 1.0.0
    */
+
   resources(...args) {
     const splited = spliteAndResolveRouterParams({ args, app: this.app });
     const middlewares = splited.middlewares;
@@ -198,7 +198,7 @@ class EggRouter extends Router {
     const args = params;
     let url = route.path;
 
-    assert(!is.regExp(url), `Can't get the url for regExp ${url} for by name '${name}'`);
+    assert(!(url instanceof RegExp), `Can't get the url for regExp ${url} for by name '${name}'`);
 
     const queries = [];
     if (typeof args === 'object' && args !== null) {
@@ -263,7 +263,7 @@ class EggRouter extends Router {
 function spliteAndResolveRouterParams({ args, app }) {
   let prefix;
   let middlewares;
-  if (args.length >= 3 && (is.string(args[1]) || is.regExp(args[1]))) {
+  if (args.length >= 3 && (typeof args[1] === 'string' || args[1] instanceof RegExp)) {
     // app.get(name, url, [...middleware], controller)
     prefix = args.slice(0, 2);
     middlewares = args.slice(2);
@@ -285,7 +285,7 @@ function spliteAndResolveRouterParams({ args, app }) {
  * @return {Function} controller function
  */
 function resolveController(controller, app) {
-  if (is.string(controller)) {
+  if (typeof controller === 'string') {
     const actions = controller.split('.');
     let obj = app.controller;
     actions.forEach(key => {

package/lib/layer.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const debug = require('debug')('egg-router:layer');
+const debug = require('util').debuglog('egg-router:layer');
 const pathToRegExp = require('path-to-regexp');
 const uri = require('urijs');
 const utility = require('utility');

package/lib/router.js

@@ -4,7 +4,7 @@
  * RESTful resource routing middleware for eggjs.
  */
 
-const debug = require('debug')('egg-router');
+const debug = require('util').debuglog('egg-router');
 const compose = require('koa-compose');
 const HttpError = require('http-errors');
 const methods = require('methods');

package/lib/utils.js

@@ -1,18 +1,34 @@
 'use strict';
 
 const convert = require('koa-convert');
-const is = require('is-type-of');
 const co = require('co');
 
+function isGeneratorFunction(obj) {
+  return obj
+    && obj.constructor
+    && obj.constructor.name === 'GeneratorFunction';
+}
+
 module.exports = {
   async callFn(fn, args, ctx) {
     args = args || [];
-    if (!is.function(fn)) return;
-    if (is.generatorFunction(fn)) fn = co.wrap(fn);
+    if (typeof fn !== 'function') return;
+    if (isGeneratorFunction(fn)) fn = co.wrap(fn);
     return ctx ? fn.call(ctx, ...args) : fn(...args);
   },
 
   middleware(fn) {
-    return is.generatorFunction(fn) ? convert(fn) : fn;
+    return isGeneratorFunction(fn) ? convert(fn) : fn;
+  },
+
+  isGeneratorFunction,
+  isAsyncFunction(obj) {
+    return obj
+      && obj.constructor
+      && obj.constructor.name === 'AsyncFunction';
+  },
+  isPromise(obj) {
+    return obj
+      && typeof obj.then === 'function';
   },
 };

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "@eggjs/router",
-  "version": "2.0.1",
+  "version": "2.1.1",
+  "engines": {
+    "node": ">= 8.5.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest-2"
+  },
   "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"
@@ -22,20 +29,17 @@
   ],
   "dependencies": {
     "co": "^4.6.0",
-    "debug": "^3.1.0",
     "http-errors": "^1.3.1",
     "inflection": "^1.12.0",
-    "is-type-of": "^1.2.1",
     "koa-compose": "^3.0.0",
     "koa-convert": "^1.2.0",
     "methods": "^1.0.1",
-    "path-to-regexp": "^1.1.1",
+    "path-to-regexp": "^1.9.0",
     "urijs": "^1.19.0",
     "utility": "^1.15.0"
   },
   "devDependencies": {
     "egg-bin": "^4.10.0",
-    "egg-ci": "^1.11.0",
     "eslint": "^5.13.0",
     "eslint-config-egg": "^7.1.0",
     "expect.js": "^0.3.1",
@@ -50,12 +54,5 @@
     "ci": "npm run lint && egg-bin cov",
     "lint": "eslint ."
   },
-  "ci": {
-    "type": "github",
-    "version": "8, 10, 11"
-  },
-  "engines": {
-    "node": ">= 8"
-  },
   "license": "MIT"
 }

package/History.md

@@ -1,187 +0,0 @@
-
-2.0.1 / 2021-07-12
-==================
-
-**fixes**
-  * [[`2c44ec0`](http://github.com/eggjs/egg-router/commit/2c44ec0bdeff1e8f46d899ed4386d1e28a93a854)] - fix: ensure ctx._matchedRoute and ctx._matchedRouteName to be correct (#7) (Yiyu He <<dead_horse@qq.com>>)
-
-2.0.0 / 2019-02-14
-==================
-
-**features**
-  * [[`f0b29ec`](https://github.com/eggjs/egg-router/commit/f0b29ec34df32ba9d872f6318f4febd2b4ef9359)] - refactor: use class instead prototype (#4) (fengmk2 <<fengmk2@gmail.com>>)
-
-1.2.0 / 2019-02-13
-==================
-
-**features**
-  * [[`1a0036a`](http://github.com/eggjs/egg-router/commit/1a0036a64a023b6b7993fecffe8062d5d0150971)] - feat: add routerPath to respond to routerName (#2) (Khaidi Chu <<i@2333.moe>>)
-
-**others**
-  * [[`ff723fd`](http://github.com/eggjs/egg-router/commit/ff723fd03630ec49d5fe861abf129a583d214d22)] - chore: add koa-router license (#3) (fengmk2 <<fengmk2@gmail.com>>)
-
-1.1.0 / 2019-01-30
-==================
-
-**features**
-  * [[`b318dd5`](http://github.com/eggjs/egg-router/commit/b318dd5ff2eea60013ed62b2a435f803c12bf20f)] - feat: add egg-router (dead-horse <<dead_horse@qq.com>>)
-
-**fixes**
-  * [[`b3db7b4`](http://github.com/eggjs/egg-router/commit/b3db7b41988d3bf1b4e885ed76b3a8165c1d3b1d)] - fix: add missing dependencies koa-convert (dead-horse <<dead_horse@qq.com>>)
-  * [[`c280336`](http://github.com/eggjs/egg-router/commit/c2803368a8256bc9504ae3c821eefeb9d1fcbc4d)] - fix: only support node@8 (dead-horse <<dead_horse@qq.com>>)
-  * [[`7a887a2`](http://github.com/eggjs/egg-router/commit/7a887a252445e602c2ea7e1c6f4cde52a433644d)] - fix: update license (dead-horse <<dead_horse@qq.com>>)
-
-**others**
-  * [[`ae40168`](http://github.com/eggjs/egg-router/commit/ae4016862fb8bdaf30e730a9278fbb1455d8b75d)] - docs: clean doc (dead-horse <<dead_horse@qq.com>>)
-  * [[`e4f21a8`](http://github.com/eggjs/egg-router/commit/e4f21a8ed6dfd72c4d6f4a13bbda9a4e90b0401c)] - chore: fix history (dead-horse <<dead_horse@qq.com>>)
-
-1.0.0 / 2019-01-30
-==================
-
-**others**
-  * [[`d6496e0`](http://github.com/eggjs/egg-router/commit/d6496e09be6b0f91dcb96611f31ec5ab6ad8ac78)] - refactor: rename to @eggjs/router (dead-horse <<dead_horse@qq.com>>)
-
--------------------------------
-
-# Release History 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`).