@eggjs/router 3.0.6 → 4.0.0-beta.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +0,0 @@
1
- import { Router } from './Router.js';
2
- export type * from './types.js';
3
- export * from './Layer.js';
4
- export * from './Router.js';
5
- export * from './EggRouter.js';
6
- export declare const KoaRouter: typeof Router;
7
- export default Router;
@@ -1,24 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- exports.KoaRouter = void 0;
18
- const Router_js_1 = require("./Router.js");
19
- __exportStar(require("./Layer.js"), exports);
20
- __exportStar(require("./Router.js"), exports);
21
- __exportStar(require("./EggRouter.js"), exports);
22
- exports.KoaRouter = Router_js_1.Router;
23
- exports.default = Router_js_1.Router;
24
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSwyQ0FBcUM7QUFHckMsNkNBQTJCO0FBQzNCLDhDQUE0QjtBQUM1QixpREFBK0I7QUFFbEIsUUFBQSxTQUFTLEdBQUcsa0JBQU0sQ0FBQztBQUNoQyxrQkFBZSxrQkFBTSxDQUFDIn0=
@@ -1,3 +0,0 @@
1
- {
2
- "type": "commonjs"
3
- }
@@ -1,18 +0,0 @@
1
- export type Next = () => Promise<void>;
2
- export type MiddlewareFunc = (ctx: any, next: Next) => Promise<void> | void;
3
- export type MiddlewareFuncWithParamProperty = MiddlewareFunc & {
4
- param?: string;
5
- };
6
- export type ParamMiddlewareFunc = (param: string, ctx: any, next: Next) => Promise<void> | void;
7
- export type MiddlewareFuncWithRouter<T> = MiddlewareFunc & {
8
- router: T;
9
- };
10
- export interface ResourcesController {
11
- index?: MiddlewareFunc;
12
- new?: MiddlewareFunc;
13
- create?: MiddlewareFunc;
14
- show?: MiddlewareFunc;
15
- edit?: MiddlewareFunc;
16
- update?: MiddlewareFunc;
17
- destroy?: MiddlewareFunc;
18
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9
@@ -1,104 +0,0 @@
1
- import { RegisterOptions, Router, RouterMethod, RouterOptions } from './Router.js';
2
- import { MiddlewareFunc, ResourcesController } from './types.js';
3
- interface Application {
4
- controller: Record<string, any>;
5
- }
6
- /**
7
- * FIXME: move these patch into @eggjs/router
8
- */
9
- export declare class EggRouter extends Router {
10
- readonly app: Application;
11
- /**
12
- * @class
13
- * @param {Object} opts - Router options.
14
- * @param {Application} app - Application object.
15
- */
16
- constructor(opts: RouterOptions, app: Application);
17
- verb(method: RouterMethod | RouterMethod[], nameOrPath: string | RegExp | (string | RegExp)[], pathOrMiddleware: string | RegExp | (string | RegExp)[] | MiddlewareFunc, ...middleware: (MiddlewareFunc | string)[]): this;
18
- head(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
19
- head(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
20
- options(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
21
- options(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
22
- get(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
23
- get(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
24
- put(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
25
- put(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
26
- patch(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
27
- patch(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
28
- post(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
29
- post(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
30
- delete(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
31
- delete(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
32
- all(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
33
- all(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): Router;
34
- register(path: string | RegExp | (string | RegExp)[], methods: string[], middleware: MiddlewareFunc | string | (MiddlewareFunc | string | ResourcesController)[], opts?: RegisterOptions): import("./Layer.js").Layer | import("./Layer.js").Layer[];
35
- /**
36
- * restful router api
37
- * @param {String} name - Router name
38
- * @param {String} prefix - url prefix
39
- * @param {Function} middleware - middleware or controller
40
- * @example
41
- * ```js
42
- * app.resources('/posts', 'posts')
43
- * app.resources('posts', '/posts', 'posts')
44
- * app.resources('posts', '/posts', app.role.can('user'), app.controller.posts)
45
- * app.resources('posts', '/posts', middleware1, middleware2, app.controller.posts)
46
- * ```
47
- *
48
- * Examples:
49
- *
50
- * ```js
51
- * app.resources('/posts', 'posts')
52
- * ```
53
- *
54
- * yield router mapping
55
- *
56
- * Method | Path | Route Name | Controller.Action
57
- * -------|-----------------|----------------|-----------------------------
58
- * GET | /posts | posts | app.controller.posts.index
59
- * GET | /posts/new | new_post | app.controller.posts.new
60
- * GET | /posts/:id | post | app.controller.posts.show
61
- * GET | /posts/:id/edit | edit_post | app.controller.posts.edit
62
- * POST | /posts | posts | app.controller.posts.create
63
- * PATCH | /posts/:id | post | app.controller.posts.update
64
- * DELETE | /posts/:id | post | app.controller.posts.destroy
65
- *
66
- * app.router.url can generate url based on arguments
67
- * ```js
68
- * app.router.url('posts')
69
- * => /posts
70
- * app.router.url('post', { id: 1 })
71
- * => /posts/1
72
- * app.router.url('new_post')
73
- * => /posts/new
74
- * app.router.url('edit_post', { id: 1 })
75
- * => /posts/1/edit
76
- * ```
77
- * @return {Router} return route object.
78
- * @since 1.0.0
79
- */
80
- resources(prefix: string, controller: string | ResourcesController): Router;
81
- resources(prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): Router;
82
- resources(name: string, prefix: string, controller: string | ResourcesController): Router;
83
- resources(name: string, prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): Router;
84
- resources(nameOrPath: string | RegExp, ...middleware: (MiddlewareFunc | string | ResourcesController)[]): Router;
85
- /**
86
- * @param {String} name - Router name
87
- * @param {Object} params - more parameters
88
- * @example
89
- * ```js
90
- * router.url('edit_post', { id: 1, name: 'foo', page: 2 })
91
- * => /posts/1/edit?name=foo&page=2
92
- * router.url('posts', { name: 'foo&1', page: 2 })
93
- * => /posts?name=foo%261&page=2
94
- * ```
95
- * @return {String} url by path name and query params.
96
- * @since 1.0.0
97
- */
98
- url(name: string, params?: Record<string, string | number | (string | number)[]>): string;
99
- /**
100
- * @alias to url()
101
- */
102
- pathFor(name: string, params?: Record<string, string | number | (string | number)[]>): string;
103
- }
104
- export {};
@@ -1,237 +0,0 @@
1
- import assert from 'node:assert';
2
- import { encodeURIComponent as safeEncodeURIComponent } from 'utility';
3
- import inflection from 'inflection';
4
- import methods from 'methods';
5
- import { isGeneratorFunction } from 'is-type-of';
6
- import { Router } from './Router.js';
7
- const REST_MAP = {
8
- index: {
9
- suffix: '',
10
- method: 'GET',
11
- },
12
- new: {
13
- namePrefix: 'new_',
14
- member: true,
15
- suffix: 'new',
16
- method: 'GET',
17
- },
18
- create: {
19
- suffix: '',
20
- method: 'POST',
21
- },
22
- show: {
23
- member: true,
24
- suffix: ':id',
25
- method: 'GET',
26
- },
27
- edit: {
28
- member: true,
29
- namePrefix: 'edit_',
30
- suffix: ':id/edit',
31
- method: 'GET',
32
- },
33
- update: {
34
- member: true,
35
- namePrefix: '',
36
- suffix: ':id',
37
- method: ['PATCH', 'PUT'],
38
- },
39
- destroy: {
40
- member: true,
41
- namePrefix: 'destroy_',
42
- suffix: ':id',
43
- method: 'DELETE',
44
- },
45
- };
46
- /**
47
- * FIXME: move these patch into @eggjs/router
48
- */
49
- export class EggRouter extends Router {
50
- app;
51
- /**
52
- * @class
53
- * @param {Object} opts - Router options.
54
- * @param {Application} app - Application object.
55
- */
56
- constructor(opts, app) {
57
- super(opts);
58
- this.app = app;
59
- }
60
- verb(method, nameOrPath, pathOrMiddleware, ...middleware) {
61
- const { path, middlewares, options } = this._formatRouteParams(nameOrPath, pathOrMiddleware, middleware);
62
- if (typeof method === 'string') {
63
- method = [method];
64
- }
65
- this.register(path, method, middlewares, options);
66
- return this;
67
- }
68
- head(nameOrPath, pathOrMiddleware, ...middlewares) {
69
- return this.verb('head', nameOrPath, pathOrMiddleware, ...middlewares);
70
- }
71
- options(nameOrPath, pathOrMiddleware, ...middlewares) {
72
- return this.verb('options', nameOrPath, pathOrMiddleware, ...middlewares);
73
- }
74
- get(nameOrPath, pathOrMiddleware, ...middlewares) {
75
- return this.verb('get', nameOrPath, pathOrMiddleware, ...middlewares);
76
- }
77
- put(nameOrPath, pathOrMiddleware, ...middlewares) {
78
- return this.verb('put', nameOrPath, pathOrMiddleware, ...middlewares);
79
- }
80
- patch(nameOrPath, pathOrMiddleware, ...middlewares) {
81
- return this.verb('patch', nameOrPath, pathOrMiddleware, ...middlewares);
82
- }
83
- post(nameOrPath, pathOrMiddleware, ...middlewares) {
84
- return this.verb('post', nameOrPath, pathOrMiddleware, ...middlewares);
85
- }
86
- delete(nameOrPath, pathOrMiddleware, ...middlewares) {
87
- return this.verb('delete', nameOrPath, pathOrMiddleware, ...middlewares);
88
- }
89
- all(nameOrPath, pathOrMiddleware, ...middlewares) {
90
- return this.verb(methods, nameOrPath, pathOrMiddleware, ...middlewares);
91
- }
92
- register(path, methods, middleware, opts) {
93
- // patch register to support bind ctx function middleware and string controller
94
- middleware = Array.isArray(middleware) ? middleware : [middleware];
95
- for (const mw of middleware) {
96
- if (isGeneratorFunction(mw)) {
97
- throw new TypeError(methods.toString() + ' `' + path + '`: Please use async function instead of generator function');
98
- }
99
- }
100
- const middlewares = convertMiddlewares(middleware, this.app);
101
- return super.register(path, methods, middlewares, opts);
102
- }
103
- resources(nameOrPath, pathOrMiddleware, ...middleware) {
104
- const { path, middlewares, options } = this._formatRouteParams(nameOrPath, pathOrMiddleware, middleware);
105
- // last argument is Controller object
106
- const controller = resolveController(middlewares.pop(), this.app);
107
- for (const key in REST_MAP) {
108
- const action = controller[key];
109
- if (!action)
110
- continue;
111
- const opts = REST_MAP[key];
112
- let routeName;
113
- if (opts.member) {
114
- routeName = inflection.singularize(options.name ?? '');
115
- }
116
- else {
117
- routeName = inflection.pluralize(options.name ?? '');
118
- }
119
- if (opts.namePrefix) {
120
- routeName = opts.namePrefix + routeName;
121
- }
122
- const prefix = path.replace(/\/$/, '');
123
- const urlPath = opts.suffix ? `${prefix}/${opts.suffix}` : prefix;
124
- const method = Array.isArray(opts.method) ? opts.method : [opts.method];
125
- this.register(urlPath, method, middlewares.concat(action), { name: routeName });
126
- }
127
- return this;
128
- }
129
- /**
130
- * @param {String} name - Router name
131
- * @param {Object} params - more parameters
132
- * @example
133
- * ```js
134
- * router.url('edit_post', { id: 1, name: 'foo', page: 2 })
135
- * => /posts/1/edit?name=foo&page=2
136
- * router.url('posts', { name: 'foo&1', page: 2 })
137
- * => /posts?name=foo%261&page=2
138
- * ```
139
- * @return {String} url by path name and query params.
140
- * @since 1.0.0
141
- */
142
- url(name, params) {
143
- const route = this.route(name);
144
- if (!route)
145
- return '';
146
- const args = params;
147
- let url = route.path;
148
- assert(!(url instanceof RegExp), `Can't get the url for regExp ${url} for by name '${name}'`);
149
- const queries = [];
150
- if (typeof args === 'object' && args !== null) {
151
- const replacedParams = [];
152
- url = url.replace(/:([a-zA-Z_]\w*)/g, ($0, key) => {
153
- if (key in args) {
154
- const values = args[key];
155
- replacedParams.push(key);
156
- return safeEncodeURIComponent(Array.isArray(values) ? String(values[0]) : String(values));
157
- }
158
- return $0;
159
- });
160
- for (const key in args) {
161
- if (replacedParams.includes(key)) {
162
- continue;
163
- }
164
- const values = args[key];
165
- const encodedKey = safeEncodeURIComponent(key);
166
- if (Array.isArray(values)) {
167
- for (const val of values) {
168
- queries.push(`${encodedKey}=${safeEncodeURIComponent(String(val))}`);
169
- }
170
- }
171
- else {
172
- queries.push(`${encodedKey}=${safeEncodeURIComponent(String(values))}`);
173
- }
174
- }
175
- }
176
- if (queries.length > 0) {
177
- const queryStr = queries.join('&');
178
- if (!url.includes('?')) {
179
- url = `${url}?${queryStr}`;
180
- }
181
- else {
182
- url = `${url}&${queryStr}`;
183
- }
184
- }
185
- return url;
186
- }
187
- /**
188
- * @alias to url()
189
- */
190
- pathFor(name, params) {
191
- return this.url(name, params);
192
- }
193
- }
194
- /**
195
- * resolve controller from string to function
196
- * @param {String|Function} controller input controller
197
- * @param {Application} app egg application instance
198
- */
199
- function resolveController(controller, app) {
200
- if (typeof controller === 'string') {
201
- // resolveController('foo.bar.Home', app)
202
- const actions = controller.split('.');
203
- let obj = app.controller;
204
- actions.forEach(key => {
205
- obj = obj[key];
206
- if (!obj)
207
- throw new Error(`app.controller.${controller} not exists`);
208
- });
209
- controller = obj;
210
- }
211
- // ensure controller is exists
212
- if (!controller)
213
- throw new Error('controller not exists');
214
- return controller;
215
- }
216
- /**
217
- * 1. ensure controller(last argument) support string
218
- * - [url, controller]: app.get('/home', 'home');
219
- * - [name, url, controller(string)]: app.get('posts', '/posts', 'posts.list');
220
- * - [name, url, controller]: app.get('posts', '/posts', app.controller.posts.list);
221
- * - [name, url(regexp), controller]: app.get('regRouter', /\/home\/index/, 'home.index');
222
- * - [name, url, middleware, [...], controller]: `app.get(/user/:id', hasLogin, canGetUser, 'user.show');`
223
- *
224
- * 2. bind ctx to controller `this`
225
- *
226
- * @param {Array} middlewares middlewares and controller(last middleware)
227
- * @param {Application} app egg application instance
228
- */
229
- function convertMiddlewares(middlewares, app) {
230
- // ensure controller is resolved
231
- const controller = resolveController(middlewares.pop(), app);
232
- function wrappedController(ctx, next) {
233
- return controller.apply(ctx, [ctx, next]);
234
- }
235
- return [...middlewares, wrappedController];
236
- }
237
- //# 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,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,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,+EAA+E;QAC/E,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAE,UAAU,CAAE,CAAC;QACrE,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;YAC5B,IAAI,mBAAmB,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,SAAS,CACjB,OAAO,CAAC,QAAQ,EAAE,GAAG,IAAI,GAAG,IAAI,GAAG,4DAA4D,CAChG,CAAC;YACJ,CAAC;QACH,CAAC;QACD,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;IAoDD,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,SAAS,iBAAiB,CAAC,GAAQ,EAAE,IAAU;QAC7C,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAE,GAAG,EAAE,IAAI,CAAE,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,CAAE,GAAG,WAA+B,EAAE,iBAAiB,CAAE,CAAC;AACnE,CAAC"}
@@ -1,114 +0,0 @@
1
- import { type Key } from 'path-to-regexp';
2
- import type { MiddlewareFunc, MiddlewareFuncWithParamProperty, ParamMiddlewareFunc } from './types.js';
3
- export interface LayerOptions {
4
- prefix?: string;
5
- /** route name */
6
- name?: string;
7
- /** case sensitive (default: false) */
8
- sensitive?: boolean;
9
- /** require the trailing slash (default: false) */
10
- strict?: boolean;
11
- ignoreCaptures?: boolean;
12
- end?: boolean;
13
- }
14
- export interface LayerURLOptions {
15
- query?: string | object;
16
- }
17
- export declare class Layer {
18
- readonly opts: LayerOptions;
19
- readonly name?: string;
20
- readonly methods: string[];
21
- readonly stack: MiddlewareFuncWithParamProperty[];
22
- path: string | RegExp;
23
- regexp: RegExp;
24
- paramNames: Key[];
25
- /**
26
- * Initialize a new routing Layer with given `method`, `path`, and `middleware`.
27
- *
28
- * @param {String|RegExp} path Path string or regular expression.
29
- * @param {Array} methods Array of HTTP verbs.
30
- * @param {Array|Function} middlewares Layer callback/middleware or series of.
31
- * @param {Object=} opts optional params
32
- * @param {String=} opts.name route name
33
- * @param {String=} opts.sensitive case sensitive (default: false)
34
- * @param {String=} opts.strict require the trailing slash (default: false)
35
- * @private
36
- */
37
- constructor(path: string | RegExp, methods: string[], middlewares: MiddlewareFunc | MiddlewareFunc[], opts?: LayerOptions | string);
38
- /**
39
- * Returns whether request `path` matches route.
40
- *
41
- * @param {String} path path string
42
- * @return {Boolean} matched or not
43
- * @private
44
- */
45
- match(path: string): boolean;
46
- /**
47
- * Returns map of URL parameters for given `path` and `paramNames`.
48
- *
49
- * @param {String} _path path string
50
- * @param {Array.<String>} captures captures strings
51
- * @param {Object=} [existingParams] existing params
52
- * @return {Object} params object
53
- * @private
54
- */
55
- params(_path: string, captures: Array<string>, existingParams?: Record<string, string>): Record<string, string>;
56
- /**
57
- * Returns array of regexp url path captures.
58
- *
59
- * @param {String} path path string
60
- * @return {Array.<String>} captures strings
61
- * @private
62
- */
63
- captures(path: string): Array<string>;
64
- /**
65
- * Generate URL for route using given `params`.
66
- *
67
- * @example
68
- *
69
- * ```javascript
70
- * var route = new Layer(['GET'], '/users/:id', fn);
71
- *
72
- * route.url(123); // => "/users/123"
73
- * route.url('123'); // => "/users/123"
74
- * route.url({ id: 123 }); // => "/users/123"
75
- * ```
76
- *
77
- * @param {Object} params url parameters
78
- * @param {Object} paramsOrOptions optional parameters
79
- * @return {String} url string
80
- * @private
81
- */
82
- url(params?: string | number | object, ...paramsOrOptions: (string | number | object | LayerURLOptions)[]): string;
83
- /**
84
- * Run validations on route named parameters.
85
- *
86
- * @example
87
- *
88
- * ```javascript
89
- * router
90
- * .param('user', function (id, ctx, next) {
91
- * ctx.user = users[id];
92
- * if (!user) return ctx.status = 404;
93
- * next();
94
- * })
95
- * .get('/users/:user', function (ctx, next) {
96
- * ctx.body = ctx.user;
97
- * });
98
- * ```
99
- *
100
- * @param {String} param param string
101
- * @param {Function} fn middleware function
102
- * @return {Layer} layer instance
103
- * @private
104
- */
105
- param(param: string, fn: ParamMiddlewareFunc): Layer;
106
- /**
107
- * Prefix route path.
108
- *
109
- * @param {String} prefix prefix string
110
- * @return {Layer} layer instance
111
- * @private
112
- */
113
- setPrefix(prefix: string): Layer;
114
- }