clear-router 2.5.13 → 2.6.0

package/dist/koa/index.mjs

@@ -1,5 +1,5 @@
 import "../bindings-XLDXFpHZ.mjs";
-import { t as CoreRouter } from "../router-CPmZcbU0.mjs";
+import { t as CoreRouter } from "../router-DSq9dtuQ.mjs";
 import { n as resolveResponseMeta, t as isFetchResponse } from "../responses-BvETUeDL.mjs";
 
 //#region src/koa/router.ts
@@ -68,7 +68,7 @@ var Router = class Router extends CoreRouter {
 	* @param middlewares
 	*/
 	static add(methods, path, handler, middlewares) {
-		super.add(methods, path, handler, middlewares);
+		return super.add(methods, path, handler, middlewares);
 	}
 	/**
 	* Define a resourceful API controller with standard CRUD routes
@@ -88,7 +88,7 @@ var Router = class Router extends CoreRouter {
 	* @param middlewares
 	*/
 	static get(path, handler, middlewares) {
-		super.get(path, handler, middlewares);
+		return super.get(path, handler, middlewares);
 	}
 	/**
 	* Define a POST route
@@ -98,7 +98,7 @@ var Router = class Router extends CoreRouter {
 	* @param middlewares
 	*/
 	static post(path, handler, middlewares) {
-		super.post(path, handler, middlewares);
+		return super.post(path, handler, middlewares);
 	}
 	/**
 	* Define a PUT route
@@ -108,7 +108,7 @@ var Router = class Router extends CoreRouter {
 	* @param middlewares
 	*/
 	static put(path, handler, middlewares) {
-		super.put(path, handler, middlewares);
+		return super.put(path, handler, middlewares);
 	}
 	/**
 	* Define a DELETE route
@@ -118,7 +118,7 @@ var Router = class Router extends CoreRouter {
 	* @param middlewares
 	*/
 	static delete(path, handler, middlewares) {
-		super.delete(path, handler, middlewares);
+		return super.delete(path, handler, middlewares);
 	}
 	/**
 	* Define a PATCH route 
@@ -128,7 +128,7 @@ var Router = class Router extends CoreRouter {
 	* @param middlewares 
 	*/
 	static patch(path, handler, middlewares) {
-		super.patch(path, handler, middlewares);
+		return super.patch(path, handler, middlewares);
 	}
 	/**
 	* Define an OPTIONS route
@@ -138,7 +138,7 @@ var Router = class Router extends CoreRouter {
 	* @param middlewares
 	*/
 	static options(path, handler, middlewares) {
-		super.options(path, handler, middlewares);
+		return super.options(path, handler, middlewares);
 	}
 	/**
 	* Adds a new HEAD route to the router.
@@ -149,7 +149,7 @@ var Router = class Router extends CoreRouter {
 	* @param middlewares
 	*/
 	static head(path, handler, middlewares) {
-		super.head(path, handler, middlewares);
+		return super.head(path, handler, middlewares);
 	}
 	/**
 	* Defines a group of routes with a common prefix.
@@ -173,6 +173,9 @@ var Router = class Router extends CoreRouter {
 	static allRoutes(type) {
 		return super.allRoutes(type);
 	}
+	static route(name) {
+		return super.route(name);
+	}
 	/**
 	* Apply the defined routes to a @koa/router instance
 	* 
@@ -212,7 +215,7 @@ var Router = class Router extends CoreRouter {
 				];
 				if (method === "options" && route.methods.length > 1) continue;
 				if (!allowedMethods.includes(method)) throw new Error(`Invalid HTTP method: ${method} for route: ${route.path}`);
-				router[method](route.path, ...route.middlewares || [], async (context, next) => {
+				for (const registrationPath of route.registrationPaths) router[method](registrationPath, ...route.middlewares || [], async (context, next) => {
 					const ctx = context;
 					const reqBody = await Router.readBodyCached(ctx);
 					const override = Router.resolveMethodOverride(ctx.method, ctx.headers, reqBody);
@@ -233,7 +236,7 @@ var Router = class Router extends CoreRouter {
 					"put",
 					"patch",
 					"delete"
-				].includes(method)) router.post(route.path, ...route.middlewares || [], async (context, next) => {
+				].includes(method)) for (const registrationPath of route.registrationPaths) router.post(registrationPath, ...route.middlewares || [], async (context, next) => {
 					const ctx = context;
 					const reqBody = await Router.readBodyCached(ctx);
 					if (Router.resolveMethodOverride(ctx.method, ctx.headers, reqBody) !== method) return next();

package/dist/{router-DiKqUyvk.d.mts → router-Bk8mXRu1.d.mts}

@@ -135,6 +135,11 @@ req: Request$1) => any | Promise<any>;
 type Handler = RouteHandler | ControllerHandler;
 //#endregion
 //#region src/Route.d.ts
+interface RouteParameter {
+  name: string;
+  field?: string;
+  optional: boolean;
+}
 declare class Route<X = any, M = Middleware | Middleware$1, H = any> {
   ctx: X;
   body: RequestData;
@@ -143,13 +148,23 @@ declare class Route<X = any, M = Middleware | Middleware$1, H = any> {
   clearRequest: ClearRequest;
   methods: HttpMethod[];
   path: string;
+  registrationPaths: string[];
+  parameters: RouteParameter[];
+  routeName?: string;
   handler: H;
   middlewares: M[];
   controllerName?: string;
   actionName?: string;
   handlerType: 'function' | 'controller';
   middlewareCount: number;
-  constructor(methods: HttpMethod[], path: string, handler: H, middlewares?: M[]);
+  constructor(methods: HttpMethod[], path: string, handler: H, middlewares?: M[], options?: {
+    registrationPaths?: string[];
+    parameters?: RouteParameter[];
+    onName?: (name: string, route: Route<X, M, H>, previousName?: string) => void;
+  });
+  private onName?;
+  name(name: string): this;
+  toPath(params?: RequestData): string;
 }
 //#endregion
 //#region src/ClearRequest.d.ts
@@ -274,6 +289,7 @@ declare abstract class CoreRouter {
     routes: Array<Route<any, any, any>>;
     routesByPathMethod: Record<string, Route<any, any, any>>;
     routesByMethod: { [method in Uppercase<HttpMethod>]?: Array<Route<any, any, any>> };
+    routesByName: Record<string, Route<any, any, any>>;
     prefix: string;
     groupMiddlewares: any[];
     globalMiddlewares: any[];
@@ -300,6 +316,7 @@ declare abstract class CoreRouter {
   static routes: Array<Route<any, any, any>>;
   static routesByPathMethod: Record<string, Route<any, any, any>>;
   static routesByMethod: { [method in Uppercase<HttpMethod>]?: Array<Route<any, any, any>> };
+  static routesByName: Record<string, Route<any, any, any>>;
   static prefix: string;
   static groupMiddlewares: any[];
   static globalMiddlewares: any[];
@@ -316,6 +333,13 @@ declare abstract class CoreRouter {
    * @returns     The normalized path.
    */
   static normalizePath(path: string): string;
+  protected static parseRouteParameters(path: string): Array<{
+    name: string;
+    field?: string;
+    optional: boolean;
+  }>;
+  protected static expandRoutePath(path: string): string[];
+  protected static routeRegistrationPaths(path: string): string[];
   /**
    * Configures the router with the given options, such as method override settings.
    *
@@ -334,7 +358,7 @@ declare abstract class CoreRouter {
    * @param handler
    * @param middlewares
    */
-  static add(methods: HttpMethod | HttpMethod[], path: string, handler: any, middlewares?: any[] | any): void;
+  static add(methods: HttpMethod | HttpMethod[], path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
   /**
    * Define a resourceful API controller with standard CRUD routes.
    *
@@ -356,7 +380,7 @@ declare abstract class CoreRouter {
    * @param handler       The handler function for the GET route.
    * @param middlewares   Optional middlewares to apply to the GET route.
    */
-  static get(path: string, handler: any, middlewares?: any[] | any): void;
+  static get(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
   /**
    * Adds a new POST route to the router.
    *
@@ -365,7 +389,7 @@ declare abstract class CoreRouter {
    * @param handler
    * @param middlewares
    */
-  static post(path: string, handler: any, middlewares?: any[] | any): void;
+  static post(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
   /**
    * Adds a new PUT route to the router.
    *
@@ -374,7 +398,7 @@ declare abstract class CoreRouter {
    * @param handler
    * @param middlewares
    */
-  static put(path: string, handler: any, middlewares?: any[] | any): void;
+  static put(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
   /**
    * Adds a new DELETE route to the router.
    *
@@ -383,7 +407,7 @@ declare abstract class CoreRouter {
    * @param handler
    * @param middlewares
    */
-  static delete(path: string, handler: any, middlewares?: any[] | any): void;
+  static delete(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
   /**
    * Adds a new PATCH route to the router.
    *
@@ -392,7 +416,7 @@ declare abstract class CoreRouter {
    * @param handler
    * @param middlewares
    */
-  static patch(path: string, handler: any, middlewares?: any[] | any): void;
+  static patch(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
   /**
    * Adds a new OPTIONS route to the router.
    *
@@ -401,7 +425,7 @@ declare abstract class CoreRouter {
    * @param handler
    * @param middlewares
    */
-  static options(path: string, handler: any, middlewares?: any[] | any): void;
+  static options(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
   /**
    * Adds a new HEAD route to the router.
    *
@@ -410,7 +434,7 @@ declare abstract class CoreRouter {
    * @param handler
    * @param middlewares
    */
-  static head(path: string, handler: any, middlewares?: any[] | any): void;
+  static head(path: string, handler: any, middlewares?: any[] | any): Route<any, any, any>;
   /**
    * Defines a group of routes with a common prefix.
    *
@@ -445,6 +469,9 @@ declare abstract class CoreRouter {
    * @param type  - 'method' to get routes organized by method
    */
   static allRoutes(type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<any, any, any>> };
+  static allRoutes(type: 'name'): Record<string, Route<any, any, any>>;
+  static route(name: string): Route<any, any, any> | undefined;
+  static url(name: string, params?: Record<string, any>): string | undefined;
   protected static resolveHandler(route: Route<any, any, any>): {
     handlerFunction: ((ctx: any, req: Request$1) => any | Promise<any>) | null;
     instance: Controller<any> | null;

package/dist/{router-D9H9-T27.cjs → router-CAnd539U.cjs}

@@ -10,21 +10,49 @@ var Route = class {
 	clearRequest;
 	methods;
 	path;
+	registrationPaths;
+	parameters;
+	routeName;
 	handler;
 	middlewares;
 	controllerName;
 	actionName;
 	handlerType;
 	middlewareCount;
-	constructor(methods, path, handler, middlewares = []) {
+	constructor(methods, path, handler, middlewares = [], options = {}) {
 		this.methods = methods;
 		this.path = path;
+		this.registrationPaths = options.registrationPaths || [path];
+		this.parameters = options.parameters || [];
 		this.handler = handler;
 		this.middlewares = middlewares;
 		this.handlerType = Array.isArray(handler) ? "controller" : "function";
 		this.middlewareCount = middlewares.length;
 		this.controllerName = Array.isArray(handler) ? handler[0]?.name : void 0;
 		this.actionName = Array.isArray(handler) ? handler[1] : typeof handler === "function" ? handler.constructor.name ?? handler.name : void 0;
+		this.onName = options.onName;
+	}
+	onName;
+	name(name) {
+		const previousName = this.routeName;
+		this.routeName = name;
+		this.onName?.(name, this, previousName);
+		return this;
+	}
+	toPath(params = {}) {
+		return this.path.replace(/\/?\{([^{}]+)\}/g, (segment, raw) => {
+			const optional = raw.endsWith("?");
+			const [rawName, rawField] = (optional ? raw.slice(0, -1) : raw).split(":", 2);
+			const name = rawName.trim();
+			const field = rawField?.trim();
+			const value = params[name];
+			const resolved = field && value && typeof value === "object" ? value[field] : value;
+			if (typeof resolved === "undefined" || resolved === null || resolved === "") {
+				if (optional) return "";
+				throw new Error(`Missing required route parameter: ${name}`);
+			}
+			return `${segment.startsWith("/") ? "/" : ""}${encodeURIComponent(String(resolved))}`;
+		}) || "/";
 	}
 };
 
@@ -107,6 +135,7 @@ var CoreRouter = class {
 			routes: [],
 			routesByPathMethod: {},
 			routesByMethod: {},
+			routesByName: {},
 			prefix: "",
 			groupMiddlewares: [],
 			globalMiddlewares: []
@@ -123,6 +152,7 @@ var CoreRouter = class {
 			"routes",
 			"routesByPathMethod",
 			"routesByMethod",
+			"routesByName",
 			"prefix",
 			"groupMiddlewares",
 			"globalMiddlewares"
@@ -255,6 +285,7 @@ var CoreRouter = class {
 	static routes = [];
 	static routesByPathMethod = {};
 	static routesByMethod = {};
+	static routesByName = {};
 	static prefix = "";
 	static groupMiddlewares = [];
 	static globalMiddlewares = [];
@@ -306,6 +337,7 @@ var CoreRouter = class {
 		if (!Array.isArray(this.routes)) this.routes = [];
 		if (!this.routesByPathMethod || typeof this.routesByPathMethod !== "object") this.routesByPathMethod = {};
 		if (!this.routesByMethod || typeof this.routesByMethod !== "object") this.routesByMethod = {};
+		if (!this.routesByName || typeof this.routesByName !== "object") this.routesByName = {};
 		if (typeof this.prefix !== "string") this.prefix = "";
 		if (!Array.isArray(this.groupMiddlewares)) this.groupMiddlewares = [];
 		if (!Array.isArray(this.globalMiddlewares)) this.globalMiddlewares = [];
@@ -320,6 +352,47 @@ var CoreRouter = class {
 	static normalizePath(path) {
 		return "/" + path.split("/").filter(Boolean).join("/");
 	}
+	static parseRouteParameters(path) {
+		const parameters = [];
+		const seen = /* @__PURE__ */ new Set();
+		const pattern = /\{([^{}]+)\}/g;
+		let match;
+		while ((match = pattern.exec(path)) !== null) {
+			const raw = match[1].trim();
+			const optional = raw.endsWith("?");
+			const [name, field] = (optional ? raw.slice(0, -1) : raw).split(":", 2).map((part) => part.trim());
+			if (!name || seen.has(name)) continue;
+			seen.add(name);
+			parameters.push({
+				name,
+				field: field || void 0,
+				optional
+			});
+		}
+		return parameters;
+	}
+	static expandRoutePath(path) {
+		let paths = [""];
+		const segments = this.normalizePath(path).split("/").filter(Boolean);
+		for (const segment of segments) {
+			const match = segment.match(/^\{([^{}]+)\}$/);
+			if (!match) {
+				paths = paths.map((current) => `${current}/${segment}`);
+				continue;
+			}
+			const raw = match[1].trim();
+			const optional = raw.endsWith("?");
+			const [rawName] = (optional ? raw.slice(0, -1) : raw).split(":", 2);
+			const name = rawName.trim();
+			if (!name) continue;
+			const parameterSegment = `/:${name}`;
+			paths = optional ? paths.flatMap((current) => [current, `${current}${parameterSegment}`]) : paths.map((current) => `${current}${parameterSegment}`);
+		}
+		return paths.map((path) => path || "/");
+	}
+	static routeRegistrationPaths(path) {
+		return this.expandRoutePath(path);
+	}
 	/**
 	* Configures the router with the given options, such as method override settings.
 	* 
@@ -393,11 +466,20 @@ var CoreRouter = class {
 		methods = Array.isArray(methods) ? methods : [methods];
 		middlewares = middlewares ? Array.isArray(middlewares) ? middlewares : [middlewares] : void 0;
 		const fullPath = this.normalizePath(`${activePrefix}/${path}`);
+		const registrationPaths = this.routeRegistrationPaths(fullPath);
+		const parameters = this.parseRouteParameters(fullPath);
 		const route = new Route(methods.includes("options") ? methods : methods.concat("options"), fullPath, handler, [
 			...this.globalMiddlewares,
 			...activeGroupMiddlewares,
 			...middlewares || []
-		]);
+		], {
+			registrationPaths,
+			parameters,
+			onName: (name, route, previousName) => {
+				if (previousName && this.routesByName[previousName] === route) delete this.routesByName[previousName];
+				this.routesByName[name] = route;
+			}
+		});
 		if (!methods.includes("options") && !this.routesByPathMethod[`OPTIONS ${fullPath}`]) this.options(path, this.createDefaultOptionsHandler());
 		this.routes.push(route);
 		for (const method of methods.map((m) => m.toUpperCase())) {
@@ -405,6 +487,7 @@ var CoreRouter = class {
 			if (!this.routesByMethod[method]) this.routesByMethod[method] = [];
 			this.routesByMethod[method].push(route);
 		}
+		return route;
 	}
 	/**
 	* Define a resourceful API controller with standard CRUD routes.
@@ -458,7 +541,7 @@ var CoreRouter = class {
 	* @param middlewares   Optional middlewares to apply to the GET route.
 	*/
 	static get(path, handler, middlewares) {
-		this.add("get", path, handler, middlewares);
+		return this.add("get", path, handler, middlewares);
 	}
 	/**
 	* Adds a new POST route to the router.
@@ -469,7 +552,7 @@ var CoreRouter = class {
 	* @param middlewares 
 	*/
 	static post(path, handler, middlewares) {
-		this.add("post", path, handler, middlewares);
+		return this.add("post", path, handler, middlewares);
 	}
 	/**
 	* Adds a new PUT route to the router.
@@ -480,7 +563,7 @@ var CoreRouter = class {
 	* @param middlewares 
 	*/
 	static put(path, handler, middlewares) {
-		this.add("put", path, handler, middlewares);
+		return this.add("put", path, handler, middlewares);
 	}
 	/**
 	* Adds a new DELETE route to the router.
@@ -491,7 +574,7 @@ var CoreRouter = class {
 	* @param middlewares 
 	*/
 	static delete(path, handler, middlewares) {
-		this.add("delete", path, handler, middlewares);
+		return this.add("delete", path, handler, middlewares);
 	}
 	/**
 	* Adds a new PATCH route to the router.
@@ -502,7 +585,7 @@ var CoreRouter = class {
 	* @param middlewares 
 	*/
 	static patch(path, handler, middlewares) {
-		this.add("patch", path, handler, middlewares);
+		return this.add("patch", path, handler, middlewares);
 	}
 	/**
 	* Adds a new OPTIONS route to the router.
@@ -513,7 +596,7 @@ var CoreRouter = class {
 	* @param middlewares 
 	*/
 	static options(path, handler, middlewares) {
-		this.add("options", path, handler, middlewares);
+		return this.add("options", path, handler, middlewares);
 	}
 	/**
 	* Adds a new HEAD route to the router.
@@ -524,7 +607,7 @@ var CoreRouter = class {
 	* @param middlewares 
 	*/
 	static head(path, handler, middlewares) {
-		this.add("head", path, handler, middlewares);
+		return this.add("head", path, handler, middlewares);
 	}
 	/**
 	* Defines a group of routes with a common prefix.
@@ -566,8 +649,16 @@ var CoreRouter = class {
 		this.ensureState();
 		if (type === "method") return this.routesByMethod;
 		if (type === "path") return this.routesByPathMethod;
+		if (type === "name") return this.routesByName;
 		return this.routes.filter((e) => e.methods.length > 1 || e.methods[0] !== "options");
 	}
+	static route(name) {
+		this.ensureState();
+		return this.routesByName[name];
+	}
+	static url(name, params) {
+		return this.route(name)?.toPath(params);
+	}
 	static resolveHandler(route) {
 		let handlerFunction;
 		let instance = null;
@@ -634,8 +725,7 @@ var CoreRouter = class {
 				designTokens
 			});
 			if (pluginArgs) return handlerFunction(...pluginArgs);
-			if (!metadata) return handlerFunction(ctx, ctx.clearRequest);
-			if (!tokens.length) return handlerFunction(ctx, ctx.clearRequest);
+			if (!metadata || !tokens.length) return handlerFunction(ctx, ctx.clearRequest);
 			const args = [];
 			for (const token of tokens) {
 				const resolved = await require_bindings.Container.resolve(token, ctx, Boolean(this.config.container?.autoDiscover));