@eggjs/router 2.0.1 → 3.0.1

package/dist/commonjs/index.d.ts

@@ -0,0 +1,7 @@
+import { Router } from './Router.js';
+export type * from './types.js';
+export * from './Layer.js';
+export * from './Router.js';
+export * from './EggRouter.js';
+export declare const KoaRouter: typeof Router;
+export default Router;

package/dist/commonjs/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KoaRouter = void 0;
+const Router_js_1 = require("./Router.js");
+__exportStar(require("./Layer.js"), exports);
+__exportStar(require("./Router.js"), exports);
+__exportStar(require("./EggRouter.js"), exports);
+exports.KoaRouter = Router_js_1.Router;
+exports.default = Router_js_1.Router;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSwyQ0FBcUM7QUFHckMsNkNBQTJCO0FBQzNCLDhDQUE0QjtBQUM1QixpREFBK0I7QUFFbEIsUUFBQSxTQUFTLEdBQUcsa0JBQU0sQ0FBQztBQUNoQyxrQkFBZSxrQkFBTSxDQUFDIn0=

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/types.d.ts

@@ -0,0 +1,18 @@
+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/dist/commonjs/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/esm/EggRouter.d.ts

@@ -0,0 +1,102 @@
+import { RegisterOptions, Router, RouterMethod, RouterOptions } from './Router.js';
+import { MiddlewareFunc, ResourcesController } from './types.js';
+interface Application {
+    controller: Record<string, any>;
+}
+/**
+ * FIXME: move these patch into @eggjs/router
+ */
+export declare class EggRouter extends Router {
+    readonly app: Application;
+    /**
+     * @class
+     * @param {Object} opts - Router options.
+     * @param {Application} app - Application object.
+     */
+    constructor(opts: RouterOptions, app: Application);
+    verb(method: RouterMethod | RouterMethod[], nameOrPath: string | RegExp | (string | RegExp)[], pathOrMiddleware: string | RegExp | (string | RegExp)[] | MiddlewareFunc, ...middleware: (MiddlewareFunc | string)[]): this;
+    head(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    head(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    options(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    options(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    get(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    get(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    put(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    put(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    patch(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    patch(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    post(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    post(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    delete(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    delete(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    all(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    all(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
+    register(path: string | RegExp | (string | RegExp)[], methods: string[], middleware: MiddlewareFunc | string | (MiddlewareFunc | string | ResourcesController)[], opts?: RegisterOptions): import("./Layer.js").Layer | import("./Layer.js").Layer[];
+    /**
+     * 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(prefix: string, controller: string | ResourcesController): Router;
+    resources(prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): Router;
+    resources(name: string, prefix: string, controller: string | ResourcesController): Router;
+    resources(name: string, prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): Router;
+    /**
+     * @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: string, params?: Record<string, string | number | (string | number)[]>): string;
+    /**
+     * @alias to url()
+     */
+    pathFor(name: string, params?: Record<string, string | number | (string | number)[]>): string;
+}
+export {};

package/dist/esm/EggRouter.js

@@ -0,0 +1,228 @@
+import assert from 'node:assert';
+import { encodeURIComponent as safeEncodeURIComponent } from 'utility';
+import inflection from 'inflection';
+import methods from 'methods';
+import { Router } from './Router.js';
+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
+ */
+export class EggRouter extends Router {
+    app;
+    /**
+     * @class
+     * @param {Object} opts - Router options.
+     * @param {Application} app - Application object.
+     */
+    constructor(opts, app) {
+        super(opts);
+        this.app = app;
+    }
+    verb(method, nameOrPath, pathOrMiddleware, ...middleware) {
+        const { path, middlewares, options } = this._formatRouteParams(nameOrPath, pathOrMiddleware, middleware);
+        if (typeof method === 'string') {
+            method = [method];
+        }
+        this.register(path, method, middlewares, options);
+        return this;
+    }
+    head(nameOrPath, pathOrMiddleware, ...middlewares) {
+        return this.verb('head', nameOrPath, pathOrMiddleware, ...middlewares);
+    }
+    options(nameOrPath, pathOrMiddleware, ...middlewares) {
+        return this.verb('options', nameOrPath, pathOrMiddleware, ...middlewares);
+    }
+    get(nameOrPath, pathOrMiddleware, ...middlewares) {
+        return this.verb('get', nameOrPath, pathOrMiddleware, ...middlewares);
+    }
+    put(nameOrPath, pathOrMiddleware, ...middlewares) {
+        return this.verb('put', nameOrPath, pathOrMiddleware, ...middlewares);
+    }
+    patch(nameOrPath, pathOrMiddleware, ...middlewares) {
+        return this.verb('patch', nameOrPath, pathOrMiddleware, ...middlewares);
+    }
+    post(nameOrPath, pathOrMiddleware, ...middlewares) {
+        return this.verb('post', nameOrPath, pathOrMiddleware, ...middlewares);
+    }
+    delete(nameOrPath, pathOrMiddleware, ...middlewares) {
+        return this.verb('delete', nameOrPath, pathOrMiddleware, ...middlewares);
+    }
+    all(nameOrPath, pathOrMiddleware, ...middlewares) {
+        return this.verb(methods, nameOrPath, pathOrMiddleware, ...middlewares);
+    }
+    register(path, methods, middleware, opts) {
+        // patch register to support generator function middleware and string controller
+        middleware = Array.isArray(middleware) ? middleware : [middleware];
+        const middlewares = convertMiddlewares(middleware, this.app);
+        return super.register(path, methods, middlewares, opts);
+    }
+    resources(nameOrPath, pathOrMiddleware, ...middleware) {
+        const { path, middlewares, options } = this._formatRouteParams(nameOrPath, pathOrMiddleware, middleware);
+        // last argument is Controller object
+        const controller = resolveController(middlewares.pop(), this.app);
+        for (const key in REST_MAP) {
+            const action = controller[key];
+            if (!action)
+                continue;
+            const opts = REST_MAP[key];
+            let routeName;
+            if (opts.member) {
+                routeName = inflection.singularize(options.name ?? '');
+            }
+            else {
+                routeName = inflection.pluralize(options.name ?? '');
+            }
+            if (opts.namePrefix) {
+                routeName = opts.namePrefix + routeName;
+            }
+            const prefix = path.replace(/\/$/, '');
+            const urlPath = opts.suffix ? `${prefix}/${opts.suffix}` : prefix;
+            const method = Array.isArray(opts.method) ? opts.method : [opts.method];
+            this.register(urlPath, method, middlewares.concat(action), { name: routeName });
+        }
+        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(!(url instanceof RegExp), `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, ($0, key) => {
+                if (key in args) {
+                    const values = args[key];
+                    replacedParams.push(key);
+                    return safeEncodeURIComponent(Array.isArray(values) ? String(values[0]) : String(values));
+                }
+                return $0;
+            });
+            for (const key in args) {
+                if (replacedParams.includes(key)) {
+                    continue;
+                }
+                const values = args[key];
+                const encodedKey = safeEncodeURIComponent(key);
+                if (Array.isArray(values)) {
+                    for (const val of values) {
+                        queries.push(`${encodedKey}=${safeEncodeURIComponent(String(val))}`);
+                    }
+                }
+                else {
+                    queries.push(`${encodedKey}=${safeEncodeURIComponent(String(values))}`);
+                }
+            }
+        }
+        if (queries.length > 0) {
+            const queryStr = queries.join('&');
+            if (!url.includes('?')) {
+                url = `${url}?${queryStr}`;
+            }
+            else {
+                url = `${url}&${queryStr}`;
+            }
+        }
+        return url;
+    }
+    /**
+     * @alias to url()
+     */
+    pathFor(name, params) {
+        return this.url(name, params);
+    }
+}
+/**
+ * resolve controller from string to function
+ * @param {String|Function} controller input controller
+ * @param {Application} app egg application instance
+ */
+function resolveController(controller, app) {
+    if (typeof controller === 'string') {
+        // resolveController('foo.bar.Home', app)
+        const actions = controller.split('.');
+        let obj = app.controller;
+        actions.forEach(key => {
+            obj = obj[key];
+            if (!obj)
+                throw new Error(`app.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
+ */
+function convertMiddlewares(middlewares, app) {
+    // ensure controller is resolved
+    const controller = resolveController(middlewares.pop(), app);
+    return [...middlewares, controller];
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"EggRouter.js","sourceRoot":"","sources":["../../src/EggRouter.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,kBAAkB,IAAI,sBAAsB,EAAE,MAAM,SAAS,CAAC;AACvE,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAmB,MAAM,EAA+B,MAAM,aAAa,CAAC;AAUnF,MAAM,QAAQ,GAAmC;IAC/C,KAAK,EAAE;QACL,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,KAAK;KACd;IACD,GAAG,EAAE;QACH,UAAU,EAAE,MAAM;QAClB,MAAM,EAAE,IAAI;QACZ,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,KAAK;KACd;IACD,MAAM,EAAE;QACN,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,MAAM;KACf;IACD,IAAI,EAAE;QACJ,MAAM,EAAE,IAAI;QACZ,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,KAAK;KACd;IACD,IAAI,EAAE;QACJ,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,OAAO;QACnB,MAAM,EAAE,UAAU;QAClB,MAAM,EAAE,KAAK;KACd;IACD,MAAM,EAAE;QACN,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,EAAE;QACd,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,CAAE,OAAO,EAAE,KAAK,CAAE;KAC3B;IACD,OAAO,EAAE;QACP,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,UAAU;QACtB,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,QAAQ;KACjB;CACF,CAAC;AAMF;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,MAAM;IAC1B,GAAG,CAAc;IAE1B;;;;OAIG;IACH,YAAY,IAAmB,EAAE,GAAgB;QAC/C,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,IAAI,CAAC,MAAqC,EACxC,UAAiD,EACjD,gBAAwE,EACxE,GAAG,UAAuC;QAC1C,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC;QACzG,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,CAAE,MAAM,CAAE,CAAC;QACtB,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IAKD,IAAI,CAAC,UAAiD,EACpD,gBAAwE,EACxE,GAAG,WAAwC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAC;IACzE,CAAC;IAGD,OAAO,CAAC,UAAiD,EACvD,gBAAwE,EACxE,GAAG,WAAwC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAC;IAC5E,CAAC;IAGD,GAAG,CAAC,UAAiD,EACnD,gBAAwE,EACxE,GAAG,WAAwC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAC;IACxE,CAAC;IAGD,GAAG,CAAC,UAAiD,EACnD,gBAAwE,EACxE,GAAG,WAAwC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAC;IACxE,CAAC;IAGD,KAAK,CAAC,UAAiD,EACrD,gBAAwE,EACxE,GAAG,WAAwC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAC;IAC1E,CAAC;IAGD,IAAI,CAAC,UAAiD,EACpD,gBAAwE,EACxE,GAAG,WAAwC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAC;IACzE,CAAC;IAGD,MAAM,CAAC,UAAiD,EACtD,gBAAwE,EACxE,GAAG,WAAwC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAC;IAC3E,CAAC;IAGD,GAAG,CAAC,UAAiD,EACnD,gBAAwE,EACxE,GAAG,WAAwC;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAC;IAC1E,CAAC;IAED,QAAQ,CAAC,IAA2C,EAClD,OAAiB,EACjB,UAAuF,EACvF,IAAsB;QACtB,gFAAgF;QAChF,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAE,UAAU,CAAE,CAAC;QACrE,MAAM,WAAW,GAAG,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7D,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;IAkDD,SAAS,CAAC,UAA2B,EAAE,gBAAwE,EAC7G,GAAG,UAA6D;QAChE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC;QACzG,qCAAqC;QACrC,MAAM,UAAU,GAAG,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACnE,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAmB,CAAC;YACjD,IAAI,CAAC,MAAM;gBAAE,SAAS;YAEtB,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,SAAS,CAAC;YACd,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YACvD,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,SAAS,GAAG,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAC1C,CAAC;YACD,MAAM,MAAM,GAAI,IAAe,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;YAClE,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAE,CAAC;YAC1E,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,IAAY,EAAE,MAA8D;QAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QAEtB,MAAM,IAAI,GAAG,MAAM,CAAC;QACpB,IAAI,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC;QAErB,MAAM,CAAC,CAAC,CAAC,GAAG,YAAY,MAAM,CAAC,EAAE,gCAAgC,GAAG,iBAAiB,IAAI,GAAG,CAAC,CAAC;QAE9F,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAC9C,MAAM,cAAc,GAAa,EAAE,CAAC;YACpC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;gBAChD,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;oBAChB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;oBACzB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACzB,OAAO,sBAAsB,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC5F,CAAC;gBACD,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACjC,SAAS;gBACX,CAAC;gBACD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;gBACzB,MAAM,UAAU,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC;gBAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC1B,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;wBACzB,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,IAAI,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;oBACvE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,IAAI,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC1E,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,GAAG,GAAG,GAAG,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,GAAG,GAAG,GAAG,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,IAAY,EAAE,MAA8D;QAClF,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChC,CAAC;CACF;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,UAAyD,EAAE,GAAgB;IACpG,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,yCAAyC;QACzC,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC;QACzB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACpB,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACf,IAAI,CAAC,GAAG;gBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,UAAU,aAAa,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QACH,UAAU,GAAG,GAAU,CAAC;IAC1B,CAAC;IACD,8BAA8B;IAC9B,IAAI,CAAC,UAAU;QAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC1D,OAAO,UAAiB,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,kBAAkB,CAAC,WAA8D,EAAE,GAAgB;IAC1G,gCAAgC;IAChC,MAAM,UAAU,GAAG,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAG,EAAE,GAAG,CAAC,CAAC;IAC9D,OAAO,CAAE,GAAG,WAA+B,EAAE,UAAU,CAAE,CAAC;AAC5D,CAAC"}

package/dist/esm/Layer.d.ts

@@ -0,0 +1,114 @@
+import { type Key } from 'path-to-regexp';
+import type { MiddlewareFunc, MiddlewareFuncWithParamProperty, ParamMiddlewareFunc } from './types.js';
+export interface LayerOptions {
+    prefix?: string;
+    /** route name */
+    name?: string;
+    /** case sensitive (default: false) */
+    sensitive?: boolean;
+    /** require the trailing slash (default: false) */
+    strict?: boolean;
+    ignoreCaptures?: boolean;
+    end?: boolean;
+}
+export interface LayerURLOptions {
+    query?: string | object;
+}
+export declare class Layer {
+    readonly opts: LayerOptions;
+    readonly name?: string;
+    readonly methods: string[];
+    readonly stack: MiddlewareFuncWithParamProperty[];
+    path: string | RegExp;
+    regexp: RegExp;
+    paramNames: Key[];
+    /**
+     * 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|Function} middlewares Layer callback/middleware or series of.
+     * @param {Object=} opts optional params
+     * @param {String=} opts.name route name
+     * @param {String=} opts.sensitive case sensitive (default: false)
+     * @param {String=} opts.strict require the trailing slash (default: false)
+     * @private
+     */
+    constructor(path: string | RegExp, methods: string[], middlewares: MiddlewareFunc | MiddlewareFunc[], opts?: LayerOptions | string);
+    /**
+     * Returns whether request `path` matches route.
+     *
+     * @param {String} path path string
+     * @return {Boolean} matched or not
+     * @private
+     */
+    match(path: string): boolean;
+    /**
+     * Returns map of URL parameters for given `path` and `paramNames`.
+     *
+     * @param {String} _path path string
+     * @param {Array.<String>} captures captures strings
+     * @param {Object=} [existingParams] existing params
+     * @return {Object} params object
+     * @private
+     */
+    params(_path: string, captures: Array<string>, existingParams?: Record<string, string>): Record<string, string>;
+    /**
+     * Returns array of regexp url path captures.
+     *
+     * @param {String} path path string
+     * @return {Array.<String>} captures strings
+     * @private
+     */
+    captures(path: string): Array<string>;
+    /**
+     * Generate URL for route using given `params`.
+     *
+     * @example
+     *
+     * ```javascript
+     * var route = new Layer(['GET'], '/users/:id', fn);
+     *
+     * route.url(123); // => "/users/123"
+     * route.url('123'); // => "/users/123"
+     * route.url({ id: 123 }); // => "/users/123"
+     * ```
+     *
+     * @param {Object} params url parameters
+     * @param {Object} paramsOrOptions optional parameters
+     * @return {String} url string
+     * @private
+     */
+    url(params?: string | number | object, ...paramsOrOptions: (string | number | object | LayerURLOptions)[]): string;
+    /**
+     * Run validations on route named parameters.
+     *
+     * @example
+     *
+     * ```javascript
+     * router
+     *   .param('user', function (id, ctx, next) {
+     *     ctx.user = users[id];
+     *     if (!user) return ctx.status = 404;
+     *     next();
+     *   })
+     *   .get('/users/:user', function (ctx, next) {
+     *     ctx.body = ctx.user;
+     *   });
+     * ```
+     *
+     * @param {String} param param string
+     * @param {Function} fn middleware function
+     * @return {Layer} layer instance
+     * @private
+     */
+    param(param: string, fn: ParamMiddlewareFunc): Layer;
+    /**
+     * Prefix route path.
+     *
+     * @param {String} prefix prefix string
+     * @return {Layer} layer instance
+     * @private
+     */
+    setPrefix(prefix: string): Layer;
+}