@eggjs/router 3.0.5 → 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.
@@ -0,0 +1,21 @@
1
+ //#region src/types.d.ts
2
+ type Next = () => Promise<void>;
3
+ type MiddlewareFunc = (ctx: any, next: Next) => Promise<void> | void;
4
+ type MiddlewareFuncWithParamProperty = MiddlewareFunc & {
5
+ param?: string;
6
+ };
7
+ type ParamMiddlewareFunc = (param: string, ctx: any, next: Next) => Promise<void> | void;
8
+ type MiddlewareFuncWithRouter<T> = MiddlewareFunc & {
9
+ router: T;
10
+ };
11
+ interface ResourcesController {
12
+ index?: MiddlewareFunc;
13
+ new?: MiddlewareFunc;
14
+ create?: MiddlewareFunc;
15
+ show?: MiddlewareFunc;
16
+ edit?: MiddlewareFunc;
17
+ update?: MiddlewareFunc;
18
+ destroy?: MiddlewareFunc;
19
+ }
20
+ //#endregion
21
+ export { MiddlewareFunc, MiddlewareFuncWithParamProperty, MiddlewareFuncWithRouter, Next, ParamMiddlewareFunc, ResourcesController };
package/dist/types.js ADDED
@@ -0,0 +1 @@
1
+ export { };
package/package.json CHANGED
@@ -1,20 +1,19 @@
1
1
  {
2
2
  "name": "@eggjs/router",
3
- "version": "3.0.5",
3
+ "version": "4.0.0-beta.16",
4
4
  "engines": {
5
- "node": ">= 18.19.0"
6
- },
7
- "publishConfig": {
8
- "access": "public"
5
+ "node": ">=22.18.0"
9
6
  },
10
7
  "description": "Router middleware for egg/koa. Provides RESTful resource routing.",
11
8
  "repository": {
12
9
  "type": "git",
13
- "url": "https://github.com/eggjs/egg-router.git"
10
+ "url": "git://github.com/eggjs/egg.git",
11
+ "directory": "packages/router"
14
12
  },
15
13
  "bugs": {
16
14
  "url": "https://github.com/eggjs/egg/issues"
17
15
  },
16
+ "homepage": "https://github.com/eggjs/egg/tree/next/packages/router",
18
17
  "author": "eggjs",
19
18
  "keywords": [
20
19
  "koa",
@@ -25,68 +24,50 @@
25
24
  "dependencies": {
26
25
  "http-errors": "^2.0.0",
27
26
  "inflection": "^3.0.0",
28
- "is-type-of": "^2.1.0",
27
+ "is-type-of": "^2.2.0",
29
28
  "koa-compose": "^4.1.0",
30
29
  "methods": "^1.1.2",
31
- "path-to-regexp": "^1.1.1",
30
+ "path-to-regexp": "^1.9.0",
32
31
  "urijs": "^1.19.11",
33
- "utility": "^2.1.0"
32
+ "utility": "^2.5.0"
34
33
  },
35
34
  "devDependencies": {
36
- "@eggjs/koa": "^2.18.1",
37
- "@eggjs/tsconfig": "^1.3.3",
35
+ "@types/http-errors": "^2.0.4",
38
36
  "@types/koa-compose": "^3.2.8",
39
37
  "@types/methods": "^1.1.4",
40
- "@types/mocha": "^10.0.6",
41
- "@types/supertest": "^6.0.2",
42
38
  "@types/urijs": "^1.19.25",
43
- "egg-bin": "6",
44
- "eslint": "8",
45
- "eslint-config-egg": "13",
46
- "git-contributor": "^2.1.5",
47
- "supertest": "^1.0.1",
48
- "tshy": "^1.15.1",
49
- "tshy-after": "^1.0.0",
50
- "typescript": "^5.4.5"
51
- },
52
- "scripts": {
53
- "lint": "eslint src test --ext ts",
54
- "pretest": "npm run lint -- --fix && npm run prepublishOnly",
55
- "test": "egg-bin test",
56
- "test-local": "egg-bin test",
57
- "preci": "npm run lint && npm run prepublishOnly",
58
- "ci": "egg-bin cov",
59
- "contributor": "git-contributor",
60
- "prepublishOnly": "tshy && tshy-after",
61
- "bench": "cd bench && make"
39
+ "tsdown": "^0.15.4",
40
+ "typescript": "5.9.2",
41
+ "vitest": "4.0.0-beta.13",
42
+ "@eggjs/koa": "3.1.0-beta.16",
43
+ "@eggjs/supertest": "9.0.0-beta.16",
44
+ "@eggjs/tsconfig": "3.1.0-beta.16"
62
45
  },
63
46
  "license": "MIT",
64
47
  "files": [
65
- "dist",
66
- "src"
48
+ "dist"
67
49
  ],
68
50
  "type": "module",
69
- "tshy": {
70
- "exports": {
71
- "./package.json": "./package.json",
72
- ".": "./src/index.ts"
73
- }
74
- },
75
51
  "exports": {
76
- "./package.json": "./package.json",
77
- ".": {
78
- "import": {
79
- "source": "./src/index.ts",
80
- "types": "./dist/esm/index.d.ts",
81
- "default": "./dist/esm/index.js"
82
- },
83
- "require": {
84
- "source": "./src/index.ts",
85
- "types": "./dist/commonjs/index.d.ts",
86
- "default": "./dist/commonjs/index.js"
87
- }
88
- }
52
+ ".": "./dist/index.js",
53
+ "./EggRouter": "./dist/EggRouter.js",
54
+ "./Layer": "./dist/Layer.js",
55
+ "./Router": "./dist/Router.js",
56
+ "./types": "./dist/types.js",
57
+ "./package.json": "./package.json"
58
+ },
59
+ "publishConfig": {
60
+ "access": "public"
89
61
  },
90
- "main": "./dist/commonjs/index.js",
91
- "types": "./dist/commonjs/index.d.ts"
92
- }
62
+ "main": "./dist/index.js",
63
+ "types": "./dist/index.d.ts",
64
+ "module": "./dist/index.js",
65
+ "scripts": {
66
+ "lint": "oxlint --type-aware",
67
+ "typecheck": "tsc --noEmit",
68
+ "test": "vitest run",
69
+ "build": "tsdown",
70
+ "prebench": "npm run build",
71
+ "bench": "cd bench && make"
72
+ }
73
+ }
@@ -1,102 +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
- * ```
46
- *
47
- * Examples:
48
- *
49
- * ```js
50
- * app.resources('/posts', 'posts')
51
- * ```
52
- *
53
- * yield router mapping
54
- *
55
- * Method | Path | Route Name | Controller.Action
56
- * -------|-----------------|----------------|-----------------------------
57
- * GET | /posts | posts | app.controller.posts.index
58
- * GET | /posts/new | new_post | app.controller.posts.new
59
- * GET | /posts/:id | post | app.controller.posts.show
60
- * GET | /posts/:id/edit | edit_post | app.controller.posts.edit
61
- * POST | /posts | posts | app.controller.posts.create
62
- * PATCH | /posts/:id | post | app.controller.posts.update
63
- * DELETE | /posts/:id | post | app.controller.posts.destroy
64
- *
65
- * app.router.url can generate url based on arguments
66
- * ```js
67
- * app.router.url('posts')
68
- * => /posts
69
- * app.router.url('post', { id: 1 })
70
- * => /posts/1
71
- * app.router.url('new_post')
72
- * => /posts/new
73
- * app.router.url('edit_post', { id: 1 })
74
- * => /posts/1/edit
75
- * ```
76
- * @return {Router} return route object.
77
- * @since 1.0.0
78
- */
79
- resources(prefix: string, controller: string | ResourcesController): Router;
80
- resources(prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): Router;
81
- resources(name: string, prefix: string, controller: string | ResourcesController): Router;
82
- resources(name: string, prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): Router;
83
- /**
84
- * @param {String} name - Router name
85
- * @param {Object} params - more parameters
86
- * @example
87
- * ```js
88
- * router.url('edit_post', { id: 1, name: 'foo', page: 2 })
89
- * => /posts/1/edit?name=foo&page=2
90
- * router.url('posts', { name: 'foo&1', page: 2 })
91
- * => /posts?name=foo%261&page=2
92
- * ```
93
- * @return {String} url by path name and query params.
94
- * @since 1.0.0
95
- */
96
- url(name: string, params?: Record<string, string | number | (string | number)[]>): string;
97
- /**
98
- * @alias to url()
99
- */
100
- pathFor(name: string, params?: Record<string, string | number | (string | number)[]>): string;
101
- }
102
- export {};
@@ -1,244 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.EggRouter = void 0;
7
- const node_assert_1 = __importDefault(require("node:assert"));
8
- const utility_1 = require("utility");
9
- const inflection_1 = __importDefault(require("inflection"));
10
- const methods_1 = __importDefault(require("methods"));
11
- const is_type_of_1 = require("is-type-of");
12
- const Router_js_1 = require("./Router.js");
13
- const REST_MAP = {
14
- index: {
15
- suffix: '',
16
- method: 'GET',
17
- },
18
- new: {
19
- namePrefix: 'new_',
20
- member: true,
21
- suffix: 'new',
22
- method: 'GET',
23
- },
24
- create: {
25
- suffix: '',
26
- method: 'POST',
27
- },
28
- show: {
29
- member: true,
30
- suffix: ':id',
31
- method: 'GET',
32
- },
33
- edit: {
34
- member: true,
35
- namePrefix: 'edit_',
36
- suffix: ':id/edit',
37
- method: 'GET',
38
- },
39
- update: {
40
- member: true,
41
- namePrefix: '',
42
- suffix: ':id',
43
- method: ['PATCH', 'PUT'],
44
- },
45
- destroy: {
46
- member: true,
47
- namePrefix: 'destroy_',
48
- suffix: ':id',
49
- method: 'DELETE',
50
- },
51
- };
52
- /**
53
- * FIXME: move these patch into @eggjs/router
54
- */
55
- class EggRouter extends Router_js_1.Router {
56
- app;
57
- /**
58
- * @class
59
- * @param {Object} opts - Router options.
60
- * @param {Application} app - Application object.
61
- */
62
- constructor(opts, app) {
63
- super(opts);
64
- this.app = app;
65
- }
66
- verb(method, nameOrPath, pathOrMiddleware, ...middleware) {
67
- const { path, middlewares, options } = this._formatRouteParams(nameOrPath, pathOrMiddleware, middleware);
68
- if (typeof method === 'string') {
69
- method = [method];
70
- }
71
- this.register(path, method, middlewares, options);
72
- return this;
73
- }
74
- head(nameOrPath, pathOrMiddleware, ...middlewares) {
75
- return this.verb('head', nameOrPath, pathOrMiddleware, ...middlewares);
76
- }
77
- options(nameOrPath, pathOrMiddleware, ...middlewares) {
78
- return this.verb('options', nameOrPath, pathOrMiddleware, ...middlewares);
79
- }
80
- get(nameOrPath, pathOrMiddleware, ...middlewares) {
81
- return this.verb('get', nameOrPath, pathOrMiddleware, ...middlewares);
82
- }
83
- put(nameOrPath, pathOrMiddleware, ...middlewares) {
84
- return this.verb('put', nameOrPath, pathOrMiddleware, ...middlewares);
85
- }
86
- patch(nameOrPath, pathOrMiddleware, ...middlewares) {
87
- return this.verb('patch', nameOrPath, pathOrMiddleware, ...middlewares);
88
- }
89
- post(nameOrPath, pathOrMiddleware, ...middlewares) {
90
- return this.verb('post', nameOrPath, pathOrMiddleware, ...middlewares);
91
- }
92
- delete(nameOrPath, pathOrMiddleware, ...middlewares) {
93
- return this.verb('delete', nameOrPath, pathOrMiddleware, ...middlewares);
94
- }
95
- all(nameOrPath, pathOrMiddleware, ...middlewares) {
96
- return this.verb(methods_1.default, nameOrPath, pathOrMiddleware, ...middlewares);
97
- }
98
- register(path, methods, middleware, opts) {
99
- // patch register to support bind ctx function middleware and string controller
100
- middleware = Array.isArray(middleware) ? middleware : [middleware];
101
- for (const mw of middleware) {
102
- if ((0, is_type_of_1.isGeneratorFunction)(mw)) {
103
- throw new TypeError(methods.toString() + ' `' + path + '`: Please use async function instead of generator function');
104
- }
105
- }
106
- const middlewares = convertMiddlewares(middleware, this.app);
107
- return super.register(path, methods, middlewares, opts);
108
- }
109
- resources(nameOrPath, pathOrMiddleware, ...middleware) {
110
- const { path, middlewares, options } = this._formatRouteParams(nameOrPath, pathOrMiddleware, middleware);
111
- // last argument is Controller object
112
- const controller = resolveController(middlewares.pop(), this.app);
113
- for (const key in REST_MAP) {
114
- const action = controller[key];
115
- if (!action)
116
- continue;
117
- const opts = REST_MAP[key];
118
- let routeName;
119
- if (opts.member) {
120
- routeName = inflection_1.default.singularize(options.name ?? '');
121
- }
122
- else {
123
- routeName = inflection_1.default.pluralize(options.name ?? '');
124
- }
125
- if (opts.namePrefix) {
126
- routeName = opts.namePrefix + routeName;
127
- }
128
- const prefix = path.replace(/\/$/, '');
129
- const urlPath = opts.suffix ? `${prefix}/${opts.suffix}` : prefix;
130
- const method = Array.isArray(opts.method) ? opts.method : [opts.method];
131
- this.register(urlPath, method, middlewares.concat(action), { name: routeName });
132
- }
133
- return this;
134
- }
135
- /**
136
- * @param {String} name - Router name
137
- * @param {Object} params - more parameters
138
- * @example
139
- * ```js
140
- * router.url('edit_post', { id: 1, name: 'foo', page: 2 })
141
- * => /posts/1/edit?name=foo&page=2
142
- * router.url('posts', { name: 'foo&1', page: 2 })
143
- * => /posts?name=foo%261&page=2
144
- * ```
145
- * @return {String} url by path name and query params.
146
- * @since 1.0.0
147
- */
148
- url(name, params) {
149
- const route = this.route(name);
150
- if (!route)
151
- return '';
152
- const args = params;
153
- let url = route.path;
154
- (0, node_assert_1.default)(!(url instanceof RegExp), `Can't get the url for regExp ${url} for by name '${name}'`);
155
- const queries = [];
156
- if (typeof args === 'object' && args !== null) {
157
- const replacedParams = [];
158
- url = url.replace(/:([a-zA-Z_]\w*)/g, ($0, key) => {
159
- if (key in args) {
160
- const values = args[key];
161
- replacedParams.push(key);
162
- return (0, utility_1.encodeURIComponent)(Array.isArray(values) ? String(values[0]) : String(values));
163
- }
164
- return $0;
165
- });
166
- for (const key in args) {
167
- if (replacedParams.includes(key)) {
168
- continue;
169
- }
170
- const values = args[key];
171
- const encodedKey = (0, utility_1.encodeURIComponent)(key);
172
- if (Array.isArray(values)) {
173
- for (const val of values) {
174
- queries.push(`${encodedKey}=${(0, utility_1.encodeURIComponent)(String(val))}`);
175
- }
176
- }
177
- else {
178
- queries.push(`${encodedKey}=${(0, utility_1.encodeURIComponent)(String(values))}`);
179
- }
180
- }
181
- }
182
- if (queries.length > 0) {
183
- const queryStr = queries.join('&');
184
- if (!url.includes('?')) {
185
- url = `${url}?${queryStr}`;
186
- }
187
- else {
188
- url = `${url}&${queryStr}`;
189
- }
190
- }
191
- return url;
192
- }
193
- /**
194
- * @alias to url()
195
- */
196
- pathFor(name, params) {
197
- return this.url(name, params);
198
- }
199
- }
200
- exports.EggRouter = EggRouter;
201
- /**
202
- * resolve controller from string to function
203
- * @param {String|Function} controller input controller
204
- * @param {Application} app egg application instance
205
- */
206
- function resolveController(controller, app) {
207
- if (typeof controller === 'string') {
208
- // resolveController('foo.bar.Home', app)
209
- const actions = controller.split('.');
210
- let obj = app.controller;
211
- actions.forEach(key => {
212
- obj = obj[key];
213
- if (!obj)
214
- throw new Error(`app.controller.${controller} not exists`);
215
- });
216
- controller = obj;
217
- }
218
- // ensure controller is exists
219
- if (!controller)
220
- throw new Error('controller not exists');
221
- return controller;
222
- }
223
- /**
224
- * 1. ensure controller(last argument) support string
225
- * - [url, controller]: app.get('/home', 'home');
226
- * - [name, url, controller(string)]: app.get('posts', '/posts', 'posts.list');
227
- * - [name, url, controller]: app.get('posts', '/posts', app.controller.posts.list);
228
- * - [name, url(regexp), controller]: app.get('regRouter', /\/home\/index/, 'home.index');
229
- * - [name, url, middleware, [...], controller]: `app.get(/user/:id', hasLogin, canGetUser, 'user.show');`
230
- *
231
- * 2. bind ctx to controller `this`
232
- *
233
- * @param {Array} middlewares middlewares and controller(last middleware)
234
- * @param {Application} app egg application instance
235
- */
236
- function convertMiddlewares(middlewares, app) {
237
- // ensure controller is resolved
238
- const controller = resolveController(middlewares.pop(), app);
239
- function wrappedController(ctx, next) {
240
- return controller.apply(ctx, [ctx, next]);
241
- }
242
- return [...middlewares, wrappedController];
243
- }
244
- //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"EggRouter.js","sourceRoot":"","sources":["../../src/EggRouter.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAiC;AACjC,qCAAuE;AACvE,4DAAoC;AACpC,sDAA8B;AAC9B,2CAAiD;AACjD,2CAAmF;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,MAAa,SAAU,SAAQ,kBAAM;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,iBAAO,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,IAAA,gCAAmB,EAAC,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;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,oBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,SAAS,GAAG,oBAAU,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,IAAA,qBAAM,EAAC,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,IAAA,4BAAsB,EAAC,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,IAAA,4BAAsB,EAAC,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,IAAA,4BAAsB,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;oBACvE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,IAAI,IAAA,4BAAsB,EAAC,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;AAnPD,8BAmPC;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
- }