@eggjs/router 4.0.0-beta.20 → 4.0.0-beta.21

package/dist/index.d.ts

@@ -1,9 +1,7 @@
-import { MiddlewareFunc, MiddlewareFuncWithParamProperty, MiddlewareFuncWithRouter, Next, ParamMiddlewareFunc, ResourcesController } from "./types-DvonNcgV.js";
-import { Layer, LayerOptions, LayerURLOptions } from "./Layer-Br45DupW.js";
-import { AllowedMethodsOptions, MatchedResult, RegisterOptions, Router, RouterMethod, RouterOptions } from "./Router-BGI5feOg.js";
-import { EggRouter } from "./EggRouter-DcO6PAYI.js";
-
-//#region src/index.d.ts
-declare const KoaRouter: typeof Router;
-//#endregion
-export { AllowedMethodsOptions, EggRouter, KoaRouter, Layer, LayerOptions, LayerURLOptions, MatchedResult, MiddlewareFunc, MiddlewareFuncWithParamProperty, MiddlewareFuncWithRouter, Next, ParamMiddlewareFunc, RegisterOptions, ResourcesController, Router, RouterMethod, RouterOptions, Router as default };
+import { Router } from './Router.ts';
+export type * from './types.ts';
+export * from './Layer.ts';
+export * from './Router.ts';
+export * from './EggRouter.ts';
+export declare const KoaRouter: typeof Router;
+export default Router;

package/dist/index.js

@@ -1,11 +1,7 @@
-import { Layer } from "./Layer-CPiRgFSm.js";
-import "./types-CxAOQAAb.js";
-import { Router } from "./Router-CWrZ5wcC.js";
-import { EggRouter } from "./EggRouter-DvjBpJdR.js";
-
-//#region src/index.ts
-const KoaRouter = Router;
-var src_default = Router;
-
-//#endregion
-export { EggRouter, KoaRouter, Layer, Router, src_default as default };
+import { Router } from "./Router.js";
+export * from "./Layer.js";
+export * from "./Router.js";
+export * from "./EggRouter.js";
+export const KoaRouter = Router;
+export default Router;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUdyQyxjQUFjLFlBQVksQ0FBQztBQUMzQixjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGdCQUFnQixDQUFDO0FBRS9CLE1BQU0sQ0FBQyxNQUFNLFNBQVMsR0FBRyxNQUFNLENBQUM7QUFDaEMsZUFBZSxNQUFNLENBQUMifQ==

package/dist/types.d.ts

@@ -1,2 +1,18 @@
-import { MiddlewareFunc, MiddlewareFuncWithParamProperty, MiddlewareFuncWithRouter, Next, ParamMiddlewareFunc, ResourcesController } from "./types-DvonNcgV.js";
-export { MiddlewareFunc, MiddlewareFuncWithParamProperty, MiddlewareFuncWithRouter, Next, ParamMiddlewareFunc, ResourcesController };
+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/types.js

@@ -1,3 +1,2 @@
-import "./types-CxAOQAAb.js";
-
-export {  };
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eggjs/router",
-  "version": "4.0.0-beta.20",
+  "version": "4.0.0-beta.21",
   "engines": {
     "node": ">=22.18.0"
   },
@@ -39,9 +39,9 @@
     "tsdown": "^0.15.4",
     "typescript": "^5.9.3",
     "vitest": "4.0.0-beta.16",
-    "@eggjs/koa": "3.1.0-beta.20",
-    "@eggjs/supertest": "9.0.0-beta.20",
-    "@eggjs/tsconfig": "3.1.0-beta.20"
+    "@eggjs/koa": "3.1.0-beta.21",
+    "@eggjs/supertest": "9.0.0-beta.21",
+    "@eggjs/tsconfig": "3.1.0-beta.21"
   },
   "license": "MIT",
   "files": [
@@ -66,7 +66,7 @@
     "lint": "oxlint --type-aware",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
-    "build": "tsdown",
+    "build": "tsdown && rimraf dist && tsc -b --clean && tsc",
     "prebench": "npm run build",
     "bench": "cd bench && make"
   }

package/dist/EggRouter-DcO6PAYI.d.ts

@@ -1,108 +0,0 @@
-import { MiddlewareFunc, ResourcesController } from "./types-DvonNcgV.js";
-import { Layer } from "./Layer-Br45DupW.js";
-import { RegisterOptions, Router, RouterMethod, RouterOptions } from "./Router-BGI5feOg.js";
-
-//#region src/EggRouter.d.ts
-interface Application {
-  controller: Record<string, any>;
-}
-/**
- * FIXME: move these patch into @eggjs/router
- */
-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): Layer | 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)
-   * app.resources('posts', '/posts', middleware1, middleware2, 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;
-  resources(nameOrPath: string | RegExp, ...middleware: (MiddlewareFunc | 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;
-}
-//#endregion
-export { EggRouter };

package/dist/EggRouter-DvjBpJdR.js

@@ -1,208 +0,0 @@
-import { Router } from "./Router-CWrZ5wcC.js";
-import assert from "node:assert";
-import { encodeURIComponent } from "utility";
-import inflection from "inflection";
-import methods from "methods";
-import { isGeneratorFunction } from "is-type-of";
-
-//#region src/EggRouter.ts
-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
-*/
-var EggRouter = class 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$1, middleware, opts) {
-		middleware = Array.isArray(middleware) ? middleware : [middleware];
-		for (const mw of middleware) if (isGeneratorFunction(mw)) throw new TypeError(methods$1.toString() + " `" + path + "`: Please use async function instead of generator function");
-		const middlewares = convertMiddlewares(middleware, this.app);
-		return super.register(path, methods$1, middlewares, opts);
-	}
-	resources(nameOrPath, pathOrMiddleware, ...middleware) {
-		const { path, middlewares, options } = this._formatRouteParams(nameOrPath, pathOrMiddleware, middleware);
-		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 encodeURIComponent(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 = encodeURIComponent(key);
-				if (Array.isArray(values)) for (const val of values) queries.push(`${encodedKey}=${encodeURIComponent(String(val))}`);
-				else queries.push(`${encodedKey}=${encodeURIComponent(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") {
-		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;
-	}
-	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. bind ctx to controller `this`
-*
-* @param  {Array} middlewares middlewares and controller(last middleware)
-* @param  {Application} app  egg application instance
-*/
-function convertMiddlewares(middlewares, app) {
-	const controller = resolveController(middlewares.pop(), app);
-	function wrappedController(ctx, next) {
-		return controller.apply(ctx, [ctx, next]);
-	}
-	return [...middlewares, wrappedController];
-}
-
-//#endregion
-export { EggRouter };

package/dist/Layer-Br45DupW.d.ts

@@ -1,118 +0,0 @@
-import { MiddlewareFunc, MiddlewareFuncWithParamProperty, ParamMiddlewareFunc } from "./types-DvonNcgV.js";
-import { Key } from "path-to-regexp";
-
-//#region src/Layer.d.ts
-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;
-}
-interface LayerURLOptions {
-  query?: string | object;
-}
-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;
-}
-//#endregion
-export { Layer, LayerOptions, LayerURLOptions };