@eggjs/router 2.0.0 → 3.0.0

package/src/index.ts

@@ -0,0 +1,7 @@
+import { Router } from './Router.js';
+
+export * from './Router.js';
+export * from './EggRouter.js';
+
+export const KoaRouter = Router;
+export default Router;

package/src/types.ts

@@ -0,0 +1,15 @@
+export type Next = () => Promise<void>;
+export type MiddlewareFunc = (ctx: any, next: Next) => Promise<void> | void;
+export type MiddlewareFuncWithParamProperty = MiddlewareFunc & { param?: string };
+export type ParamMiddlewareFunc = (param: string, ctx: any, next: Next) => Promise<void> | void;
+export type MiddlewareFuncWithRouter<T> = MiddlewareFunc & { router: T };
+
+export interface ResourcesController {
+  index?: MiddlewareFunc;
+  new?: MiddlewareFunc;
+  create?: MiddlewareFunc;
+  show?: MiddlewareFunc;
+  edit?: MiddlewareFunc;
+  update?: MiddlewareFunc;
+  destroy?: MiddlewareFunc;
+}

package/History.md

@@ -1,181 +0,0 @@
-
-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`).

package/index.js

@@ -1,10 +0,0 @@
-'use strict';
-
-const KoaRouter = require('./lib/router');
-const EggRouter = require('./lib/egg_router');
-
-// for compact
-module.exports = KoaRouter;
-module.exports.KoaRouter = KoaRouter;
-module.exports.EggRouter = EggRouter;
-

package/lib/egg_router.js

@@ -1,327 +0,0 @@
-'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 METHODS = [ 'head', 'options', 'get', 'put', 'patch', 'post', 'delete' ];
-
-const REST_MAP = {
-  index: {
-    suffix: '',
-    method: 'GET',
-  },
-  new: {
-    namePrefix: 'new_',
-    member: true,
-    suffix: 'new',
-    method: 'GET',
-  },
-  create: {
-    suffix: '',
-    method: 'POST',
-  },
-  show: {
-    member: true,
-    suffix: ':id',
-    method: 'GET',
-  },
-  edit: {
-    member: true,
-    namePrefix: 'edit_',
-    suffix: ':id/edit',
-    method: 'GET',
-  },
-  update: {
-    member: true,
-    namePrefix: '',
-    suffix: ':id',
-    method: [ 'PATCH', 'PUT' ],
-  },
-  destroy: {
-    member: true,
-    namePrefix: 'destroy_',
-    suffix: ':id',
-    method: 'DELETE',
-  },
-};
-
-/**
- * FIXME: move these patch into @eggjs/router
- */
-class EggRouter extends Router {
-
-  /**
-   * @constructor
-   * @param {Object} opts - Router options.
-   * @param {Application} app - Application object.
-   */
-  constructor(opts, app) {
-    super(opts);
-    this.app = app;
-    this.patchRouterMethod();
-  }
-
-  patchRouterMethod() {
-    // patch router methods to support generator function middleware and string controller
-    METHODS.concat([ 'all' ]).forEach(method => {
-      this[method] = (...args) => {
-        const splited = spliteAndResolveRouterParams({ args, app: this.app });
-        // format and rebuild params
-        args = splited.prefix.concat(splited.middlewares);
-        return super[method](...args);
-      };
-    });
-  }
-
-  /**
-   * Create and register a route.
-   * @param {String} path - url path
-   * @param {Array} methods - Array of HTTP verbs
-   * @param {Array} middlewares -
-   * @param {Object} opts -
-   * @return {Route} this
-   */
-  register(path, methods, middlewares, opts) {
-    // patch register to support generator function middleware and string controller
-    middlewares = Array.isArray(middlewares) ? middlewares : [ middlewares ];
-    middlewares = convertMiddlewares(middlewares, this.app);
-    path = Array.isArray(path) ? path : [ path ];
-    path.forEach(p => super.register(p, methods, middlewares, opts));
-    return this;
-  }
-
-  /**
-   * restful router api
-   * @param {String} name - Router name
-   * @param {String} prefix - url prefix
-   * @param {Function} middleware - middleware or controller
-   * @example
-   * ```js
-   * app.resources('/posts', 'posts')
-   * app.resources('posts', '/posts', 'posts')
-   * app.resources('posts', '/posts', app.role.can('user'), app.controller.posts)
-   * ```
-   *
-   * Examples:
-   *
-   * ```js
-   * app.resources('/posts', 'posts')
-   * ```
-   *
-   * yield router mapping
-   *
-   * Method | Path            | Route Name     | Controller.Action
-   * -------|-----------------|----------------|-----------------------------
-   * GET    | /posts          | posts          | app.controller.posts.index
-   * GET    | /posts/new      | new_post       | app.controller.posts.new
-   * GET    | /posts/:id      | post           | app.controller.posts.show
-   * GET    | /posts/:id/edit | edit_post      | app.controller.posts.edit
-   * POST   | /posts          | posts          | app.controller.posts.create
-   * PATCH  | /posts/:id      | post           | app.controller.posts.update
-   * DELETE | /posts/:id      | post           | app.controller.posts.destroy
-   *
-   * app.router.url can generate url based on arguments
-   * ```js
-   * app.router.url('posts')
-   * => /posts
-   * app.router.url('post', { id: 1 })
-   * => /posts/1
-   * app.router.url('new_post')
-   * => /posts/new
-   * app.router.url('edit_post', { id: 1 })
-   * => /posts/1/edit
-   * ```
-   * @return {Router} return route object.
-   * @since 1.0.0
-   */
-  resources(...args) {
-    const splited = spliteAndResolveRouterParams({ args, app: this.app });
-    const middlewares = splited.middlewares;
-    // last argument is Controller object
-    const controller = splited.middlewares.pop();
-
-    let name = '';
-    let prefix = '';
-    if (splited.prefix.length === 2) {
-      // router.get('users', '/users')
-      name = splited.prefix[0];
-      prefix = splited.prefix[1];
-    } else {
-      // router.get('/users')
-      prefix = splited.prefix[0];
-    }
-
-    for (const key in REST_MAP) {
-      const action = controller[key];
-      if (!action) continue;
-
-      const opts = REST_MAP[key];
-      let formatedName;
-      if (opts.member) {
-        formatedName = inflection.singularize(name);
-      } else {
-        formatedName = inflection.pluralize(name);
-      }
-      if (opts.namePrefix) {
-        formatedName = opts.namePrefix + formatedName;
-      }
-      prefix = prefix.replace(/\/$/, '');
-      const path = opts.suffix ? `${prefix}/${opts.suffix}` : prefix;
-      const method = Array.isArray(opts.method) ? opts.method : [ opts.method ];
-      this.register(path, method, middlewares.concat(action), { name: formatedName });
-    }
-
-    return this;
-  }
-
-  /**
-   * @param {String} name - Router name
-   * @param {Object} params - more parameters
-   * @example
-   * ```js
-   * router.url('edit_post', { id: 1, name: 'foo', page: 2 })
-   * => /posts/1/edit?name=foo&page=2
-   * router.url('posts', { name: 'foo&1', page: 2 })
-   * => /posts?name=foo%261&page=2
-   * ```
-   * @return {String} url by path name and query params.
-   * @since 1.0.0
-   */
-  url(name, params) {
-    const route = this.route(name);
-    if (!route) return '';
-
-    const args = params;
-    let url = route.path;
-
-    assert(!is.regExp(url), `Can't get the url for regExp ${url} for by name '${name}'`);
-
-    const queries = [];
-    if (typeof args === 'object' && args !== null) {
-      const replacedParams = [];
-      url = url.replace(/:([a-zA-Z_]\w*)/g, function($0, key) {
-        if (utility.has(args, key)) {
-          const values = args[key];
-          replacedParams.push(key);
-          return utility.encodeURIComponent(Array.isArray(values) ? values[0] : values);
-        }
-        return $0;
-      });
-
-      for (const key in args) {
-        if (replacedParams.includes(key)) {
-          continue;
-        }
-
-        const values = args[key];
-        const encodedKey = utility.encodeURIComponent(key);
-        if (Array.isArray(values)) {
-          for (const val of values) {
-            queries.push(`${encodedKey}=${utility.encodeURIComponent(val)}`);
-          }
-        } else {
-          queries.push(`${encodedKey}=${utility.encodeURIComponent(values)}`);
-        }
-      }
-    }
-
-    if (queries.length > 0) {
-      const queryStr = queries.join('&');
-      if (!url.includes('?')) {
-        url = `${url}?${queryStr}`;
-      } else {
-        url = `${url}&${queryStr}`;
-      }
-    }
-
-    return url;
-  }
-
-  pathFor(name, params) {
-    return this.url(name, params);
-  }
-}
-
-/**
- * 1. split (name, url, ...middleware, controller) to
- * {
- *   prefix: [name, url]
- *   middlewares [...middleware, controller]
- * }
- *
- * 2. resolve controller from string to function
- *
- * @param  {Object} options inputs
- * @param {Object} options.args router params
- * @param {Object} options.app egg application instance
- * @return {Object} prefix and middlewares
- */
-function spliteAndResolveRouterParams({ args, app }) {
-  let prefix;
-  let middlewares;
-  if (args.length >= 3 && (is.string(args[1]) || is.regExp(args[1]))) {
-    // app.get(name, url, [...middleware], controller)
-    prefix = args.slice(0, 2);
-    middlewares = args.slice(2);
-  } else {
-    // app.get(url, [...middleware], controller)
-    prefix = args.slice(0, 1);
-    middlewares = args.slice(1);
-  }
-  // resolve controller
-  const controller = middlewares.pop();
-  middlewares.push(resolveController(controller, app));
-  return { prefix, middlewares };
-}
-
-/**
- * resolve controller from string to function
- * @param  {String|Function} controller input controller
- * @param  {Application} app egg application instance
- * @return {Function} controller function
- */
-function resolveController(controller, app) {
-  if (is.string(controller)) {
-    const actions = controller.split('.');
-    let obj = app.controller;
-    actions.forEach(key => {
-      obj = obj[key];
-      if (!obj) throw new Error(`controller '${controller}' not exists`);
-    });
-    controller = obj;
-  }
-  // ensure controller is exists
-  if (!controller) throw new Error('controller not exists');
-  return controller;
-}
-
-/**
- * 1. ensure controller(last argument) support string
- * - [url, controller]: app.get('/home', 'home');
- * - [name, url, controller(string)]: app.get('posts', '/posts', 'posts.list');
- * - [name, url, controller]: app.get('posts', '/posts', app.controller.posts.list);
- * - [name, url(regexp), controller]: app.get('regRouter', /\/home\/index/, 'home.index');
- * - [name, url, middleware, [...], controller]: `app.get(/user/:id', hasLogin, canGetUser, 'user.show');`
- *
- * 2. make middleware support generator function
- *
- * @param  {Array} middlewares middlewares and controller(last middleware)
- * @param  {Application} app  egg application instance
- * @return {Array} middlewares
- */
-function convertMiddlewares(middlewares, app) {
-  // ensure controller is resolved
-  const controller = resolveController(middlewares.pop(), app);
-  // make middleware support generator function
-  middlewares = middlewares.map(utils.middleware);
-  const wrappedController = (ctx, next) => {
-    return utils.callFn(controller, [ ctx, next ], ctx);
-  };
-  return middlewares.concat([ wrappedController ]);
-}
-
-module.exports = EggRouter;