clear-router 2.6.1 → 2.6.3

package/dist/{router-B90hsOKM.d.cts → router-BITqScD_.d.cts}

@@ -49,6 +49,11 @@ type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
 type RequestData = Record<string, any>;
 type ApiResourceMiddleware<M = any> = M | M[] | { [K in ControllerAction]?: M | M[] };
 interface RouterConfig {
+  /**
+   * When enabled, API param name will be infered from the route path.
+   * So instead of getting /api/users/:id, we will now get /api/users/:user
+   */
+  inferParamName?: boolean;
   /**
    * Configuration for method override functionality, allowing clients to use a
    * specific header or body parameter to override the HTTP method.
@@ -326,6 +331,23 @@ declare abstract class CoreRouter {
   private static readonly pluginArgumentResolversKey;
   private static requestProvider?;
   private static responseProvider?;
+  static config: RouterConfig;
+  protected static groupContext: AsyncLocalStorage<{
+    prefix: string;
+    groupMiddlewares: any[];
+  }>;
+  protected static pluginRequestContext: AsyncLocalStorage<ClearRouterPluginRequestContext>;
+  static routes: Set<Route<any, any, any>>;
+  static routesByPathMethod: Map<string, Route<any, any, any>>;
+  static routesByMethod: Map<"GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD", Route<any, any, any>[]>;
+  static routesByName: Map<string, Route<any, any, any>>;
+  static prefix: string;
+  static groupMiddlewares: any[];
+  static globalMiddlewares: any[];
+  /**
+   * Resets the router to it's default state
+   */
+  static reset(): typeof CoreRouter;
   protected static createBaseConfig(): RouterConfig;
   protected static mergeConfig(target: RouterConfig, source?: RouterConfig): RouterConfig;
   protected static getDefaultConfig(): RouterConfig;
@@ -340,17 +362,16 @@ declare abstract class CoreRouter {
       prefix: string;
       groupMiddlewares: any[];
     }>;
-    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>>;
+    routes: Set<never>;
+    routesByPathMethod: Map<any, any>;
+    routesByMethod: Map<any, any>;
+    routesByName: Map<any, any>;
     prefix: string;
     groupMiddlewares: any[];
     globalMiddlewares: any[];
   };
   protected static bindStateAccessors(): void;
   protected static createDefaultOptionsHandler(): any;
-  static config: RouterConfig;
   static configureDefaults(options?: RouterConfig): void;
   /**
    * Use a registered plugin
@@ -362,18 +383,6 @@ declare abstract class CoreRouter {
    */
   static use<Options = any>(plugin: ClearRouterPluginInput<Options>, options?: Options): Promise<void>;
   protected static pluginsReady(): Promise<void>;
-  protected static groupContext: AsyncLocalStorage<{
-    prefix: string;
-    groupMiddlewares: any[];
-  }>;
-  protected static pluginRequestContext: AsyncLocalStorage<ClearRouterPluginRequestContext>;
-  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[];
   protected static getCurrentPluginRequestContext(): ClearRouterPluginRequestContext | undefined;
   protected static createPluginRequestContext(ctx: any): ClearRouterPluginRequestContext;
   protected static createPluginBind(): PluginBind;
@@ -538,6 +547,7 @@ declare abstract class CoreRouter {
    * @param provider
    */
   static setResponseProvider(provider: typeof Response$2): void;
+  private static hasPackageInstalled;
   /**
    * Provide a class that will overide the base Response instance
    *

package/dist/{router-BfYAFCqD.d.mts → router-Cs8cC5zd.d.mts}

@@ -49,6 +49,11 @@ type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
 type RequestData = Record<string, any>;
 type ApiResourceMiddleware<M = any> = M | M[] | { [K in ControllerAction]?: M | M[] };
 interface RouterConfig {
+  /**
+   * When enabled, API param name will be infered from the route path.
+   * So instead of getting /api/users/:id, we will now get /api/users/:user
+   */
+  inferParamName?: boolean;
   /**
    * Configuration for method override functionality, allowing clients to use a
    * specific header or body parameter to override the HTTP method.
@@ -326,6 +331,23 @@ declare abstract class CoreRouter {
   private static readonly pluginArgumentResolversKey;
   private static requestProvider?;
   private static responseProvider?;
+  static config: RouterConfig;
+  protected static groupContext: AsyncLocalStorage<{
+    prefix: string;
+    groupMiddlewares: any[];
+  }>;
+  protected static pluginRequestContext: AsyncLocalStorage<ClearRouterPluginRequestContext>;
+  static routes: Set<Route<any, any, any>>;
+  static routesByPathMethod: Map<string, Route<any, any, any>>;
+  static routesByMethod: Map<"GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" | "HEAD", Route<any, any, any>[]>;
+  static routesByName: Map<string, Route<any, any, any>>;
+  static prefix: string;
+  static groupMiddlewares: any[];
+  static globalMiddlewares: any[];
+  /**
+   * Resets the router to it's default state
+   */
+  static reset(): typeof CoreRouter;
   protected static createBaseConfig(): RouterConfig;
   protected static mergeConfig(target: RouterConfig, source?: RouterConfig): RouterConfig;
   protected static getDefaultConfig(): RouterConfig;
@@ -340,17 +362,16 @@ declare abstract class CoreRouter {
       prefix: string;
       groupMiddlewares: any[];
     }>;
-    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>>;
+    routes: Set<never>;
+    routesByPathMethod: Map<any, any>;
+    routesByMethod: Map<any, any>;
+    routesByName: Map<any, any>;
     prefix: string;
     groupMiddlewares: any[];
     globalMiddlewares: any[];
   };
   protected static bindStateAccessors(): void;
   protected static createDefaultOptionsHandler(): any;
-  static config: RouterConfig;
   static configureDefaults(options?: RouterConfig): void;
   /**
    * Use a registered plugin
@@ -362,18 +383,6 @@ declare abstract class CoreRouter {
    */
   static use<Options = any>(plugin: ClearRouterPluginInput<Options>, options?: Options): Promise<void>;
   protected static pluginsReady(): Promise<void>;
-  protected static groupContext: AsyncLocalStorage<{
-    prefix: string;
-    groupMiddlewares: any[];
-  }>;
-  protected static pluginRequestContext: AsyncLocalStorage<ClearRouterPluginRequestContext>;
-  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[];
   protected static getCurrentPluginRequestContext(): ClearRouterPluginRequestContext | undefined;
   protected static createPluginRequestContext(ctx: any): ClearRouterPluginRequestContext;
   protected static createPluginBind(): PluginBind;
@@ -538,6 +547,7 @@ declare abstract class CoreRouter {
    * @param provider
    */
   static setResponseProvider(provider: typeof Response$2): void;
+  private static hasPackageInstalled;
   /**
    * Provide a class that will overide the base Response instance
    *

package/dist/{router-BJYHBKMY.cjs → router-DJvP-A5M.cjs}

@@ -1,5 +1,6 @@
 const require_bindings = require('./bindings-CLsZjOEy.cjs');
 let node_async_hooks = require("node:async_hooks");
+let node_module = require("node:module");
 
 //#region src/Route.ts
 var Route = class {
@@ -74,8 +75,43 @@ var CoreRouter = class {
 	static pluginArgumentResolversKey = Symbol.for("clear-router:plugin-argument-resolvers");
 	static requestProvider;
 	static responseProvider;
+	static config = {
+		inferParamName: false,
+		methodOverride: {
+			enabled: true,
+			bodyKeys: ["_method"],
+			headerKeys: ["x-http-method"]
+		},
+		container: {
+			enabled: false,
+			autoDiscover: false
+		}
+	};
+	static groupContext = new node_async_hooks.AsyncLocalStorage();
+	static pluginRequestContext = new node_async_hooks.AsyncLocalStorage();
+	static routes = /* @__PURE__ */ new Set([]);
+	static routesByPathMethod = /* @__PURE__ */ new Map();
+	static routesByMethod = /* @__PURE__ */ new Map();
+	static routesByName = /* @__PURE__ */ new Map();
+	static prefix = "";
+	static groupMiddlewares = [];
+	static globalMiddlewares = [];
+	/**
+	* Resets the router to it's default state
+	*/
+	static reset() {
+		this.routes.clear();
+		this.prefix = "";
+		this.groupMiddlewares = [];
+		this.globalMiddlewares = [];
+		this.routesByPathMethod.clear();
+		this.routesByMethod.clear();
+		this.routesByName.clear();
+		return this;
+	}
 	static createBaseConfig() {
 		return {
+			inferParamName: false,
 			methodOverride: {
 				enabled: true,
 				bodyKeys: ["_method"],
@@ -103,6 +139,7 @@ var CoreRouter = class {
 		const g = globalThis;
 		if (!g[this.defaultConfigKey]) g[this.defaultConfigKey] = this.createBaseConfig();
 		return {
+			inferParamName: g[this.defaultConfigKey].inferParamName,
 			methodOverride: { ...g[this.defaultConfigKey].methodOverride },
 			container: { ...g[this.defaultConfigKey].container }
 		};
@@ -134,10 +171,10 @@ var CoreRouter = class {
 		return {
 			config: this.getDefaultConfig(),
 			groupContext: new node_async_hooks.AsyncLocalStorage(),
-			routes: [],
-			routesByPathMethod: {},
-			routesByMethod: {},
-			routesByName: {},
+			routes: /* @__PURE__ */ new Set([]),
+			routesByPathMethod: /* @__PURE__ */ new Map(),
+			routesByMethod: /* @__PURE__ */ new Map(),
+			routesByName: /* @__PURE__ */ new Map(),
 			prefix: "",
 			groupMiddlewares: [],
 			globalMiddlewares: []
@@ -211,17 +248,6 @@ var CoreRouter = class {
 			}
 		};
 	}
-	static config = {
-		methodOverride: {
-			enabled: true,
-			bodyKeys: ["_method"],
-			headerKeys: ["x-http-method"]
-		},
-		container: {
-			enabled: false,
-			autoDiscover: false
-		}
-	};
 	static configureDefaults(options) {
 		const g = globalThis;
 		const defaults = this.mergeConfig(g[this.defaultConfigKey] || this.createBaseConfig(), options);
@@ -282,15 +308,6 @@ var CoreRouter = class {
 		if (!pending.length) return;
 		await Promise.all(pending);
 	}
-	static groupContext = new node_async_hooks.AsyncLocalStorage();
-	static pluginRequestContext = new node_async_hooks.AsyncLocalStorage();
-	static routes = [];
-	static routesByPathMethod = {};
-	static routesByMethod = {};
-	static routesByName = {};
-	static prefix = "";
-	static groupMiddlewares = [];
-	static globalMiddlewares = [];
 	static getCurrentPluginRequestContext() {
 		return this.pluginRequestContext.getStore();
 	}
@@ -336,10 +353,10 @@ var CoreRouter = class {
 			headerKeys: ["x-http-method"]
 		} };
 		if (!this.groupContext) this.groupContext = new node_async_hooks.AsyncLocalStorage();
-		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 (!this.routes || Array.isArray(this.routes)) this.routes = new Set(this.routes ?? []);
+		if (!this.routesByPathMethod) this.routesByPathMethod = /* @__PURE__ */ new Map();
+		if (!this.routesByMethod) this.routesByMethod = /* @__PURE__ */ new Map();
+		if (!this.routesByName) this.routesByName = /* @__PURE__ */ new Map();
 		if (typeof this.prefix !== "string") this.prefix = "";
 		if (!Array.isArray(this.groupMiddlewares)) this.groupMiddlewares = [];
 		if (!Array.isArray(this.globalMiddlewares)) this.globalMiddlewares = [];
@@ -410,13 +427,15 @@ var CoreRouter = class {
 			if (typeof container.enabled === "boolean") this.config.container.enabled = container.enabled;
 			if (typeof container.autoDiscover === "boolean") this.config.container.autoDiscover = container.autoDiscover;
 		}
+		if (options?.inferParamName) this.config.inferParamName = options?.inferParamName;
 		const override = options?.methodOverride;
-		if (!override) return;
-		if (typeof override.enabled === "boolean") this.config.methodOverride.enabled = override.enabled;
-		const bodyKeys = override.bodyKeys;
-		if (typeof bodyKeys !== "undefined") this.config.methodOverride.bodyKeys = (Array.isArray(bodyKeys) ? bodyKeys : [bodyKeys]).map((e) => String(e).trim()).filter(Boolean);
-		const headerKeys = override.headerKeys;
-		if (typeof headerKeys !== "undefined") this.config.methodOverride.headerKeys = (Array.isArray(headerKeys) ? headerKeys : [headerKeys]).map((e) => String(e).trim().toLowerCase()).filter(Boolean);
+		if (override) {
+			if (typeof override.enabled === "boolean") this.config.methodOverride.enabled = override.enabled;
+			const bodyKeys = override.bodyKeys;
+			if (typeof bodyKeys !== "undefined") this.config.methodOverride.bodyKeys = (Array.isArray(bodyKeys) ? bodyKeys : [bodyKeys]).map((e) => String(e).trim()).filter(Boolean);
+			const headerKeys = override.headerKeys;
+			if (typeof headerKeys !== "undefined") this.config.methodOverride.headerKeys = (Array.isArray(headerKeys) ? headerKeys : [headerKeys]).map((e) => String(e).trim().toLowerCase()).filter(Boolean);
+		}
 	}
 	static resolveMethodOverride(method, headers, body) {
 		this.ensureState();
@@ -478,16 +497,16 @@ var CoreRouter = class {
 			registrationPaths,
 			parameters,
 			onName: (name, route, previousName) => {
-				if (previousName && this.routesByName[previousName] === route) delete this.routesByName[previousName];
-				this.routesByName[name] = route;
+				if (previousName && this.routesByName.get(previousName) === route) this.routesByName.delete(previousName);
+				this.routesByName.set(name, route);
 			}
 		});
-		if (!methods.includes("options") && !this.routesByPathMethod[`OPTIONS ${fullPath}`]) this.options(path, this.createDefaultOptionsHandler());
-		this.routes.push(route);
+		if (!methods.includes("options") && !this.routesByPathMethod.get(`OPTIONS ${fullPath}`)) this.options(path, this.createDefaultOptionsHandler());
+		this.routes.add(route);
 		for (const method of methods.map((m) => m.toUpperCase())) {
-			this.routesByPathMethod[`${method} ${fullPath}`] = route;
-			if (!this.routesByMethod[method]) this.routesByMethod[method] = [];
-			this.routesByMethod[method].push(route);
+			this.routesByPathMethod.set(`${method} ${fullPath}`, route);
+			if (!this.routesByMethod.has(method)) this.routesByMethod.set(method, []);
+			this.routesByMethod.get(method)?.push(route);
 		}
 		return route;
 	}
@@ -500,6 +519,11 @@ var CoreRouter = class {
 	* @param options 
 	*/
 	static apiResource(basePath, controller, options) {
+		let paramName = "id";
+		if (!!this.config.inferParamName && this.hasPackageInstalled("@h3ravel/support")) {
+			const { str } = (0, node_module.createRequire)(require("url").pathToFileURL(__filename).href)("@h3ravel/support");
+			paramName = str(basePath).singular().afterLast("/").toString();
+		}
 		const actions = {
 			index: {
 				method: "get",
@@ -507,7 +531,7 @@ var CoreRouter = class {
 			},
 			show: {
 				method: "get",
-				path: "/:id"
+				path: `/:${paramName}`
 			},
 			create: {
 				method: "post",
@@ -515,11 +539,11 @@ var CoreRouter = class {
 			},
 			update: {
 				method: "put",
-				path: "/:id"
+				path: `/:${paramName}`
 			},
 			destroy: {
 				method: "delete",
-				path: "/:id"
+				path: `/:${paramName}`
 			}
 		};
 		const only = options?.only || Object.keys(actions);
@@ -530,7 +554,8 @@ var CoreRouter = class {
 			if (typeof preController[action] === "function") {
 				const { method, path } = actions[action];
 				const actionMiddlewares = typeof options?.middlewares === "object" && !Array.isArray(options.middlewares) ? options.middlewares[action] : options?.middlewares;
-				this.add(method, `${basePath}${path}`, [controller, action], Array.isArray(actionMiddlewares) ? actionMiddlewares : actionMiddlewares ? [actionMiddlewares] : void 0);
+				const name = `${basePath}${path}`.replace(/\{(\w+):[^}]+\}/g, "$1").replace(/\/|:|[{}]/g, ".").replace(/\.{2,}/g, ".").replace(/^\.|\.$/g, "");
+				this.add(method, `${basePath}${path}`, [controller, action], Array.isArray(actionMiddlewares) ? actionMiddlewares : actionMiddlewares ? [actionMiddlewares] : void 0).name(name + "." + action.toLowerCase());
 			}
 		}
 	}
@@ -649,14 +674,14 @@ var CoreRouter = class {
 	}
 	static allRoutes(type) {
 		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");
+		if (type === "method") return Object.fromEntries(this.routesByMethod.entries());
+		if (type === "path") return Object.fromEntries(this.routesByPathMethod.entries());
+		if (type === "name") return Object.fromEntries(this.routesByName.entries());
+		return Array.from(this.routes).filter((e) => e.methods.length > 1 || e.methods[0] !== "options");
 	}
 	static route(name) {
 		this.ensureState();
-		return this.routesByName[name];
+		return this.routesByName.get(name);
 	}
 	static url(name, params) {
 		return this.route(name)?.toPath(params);
@@ -677,6 +702,14 @@ var CoreRouter = class {
 	static setResponseProvider(provider) {
 		this.responseProvider = provider;
 	}
+	static hasPackageInstalled(name) {
+		try {
+			(0, node_module.createRequire)(require("url").pathToFileURL(__filename).href).resolve(name, { paths: [process.cwd()] });
+			return true;
+		} catch {
+			return false;
+		}
+	}
 	static initializeInstance(provider, args) {
 		const isRequest = [
 			"CoreRequest",

package/dist/types/basic.d.mts

@@ -17,6 +17,11 @@ type ControllerAction = 'index' | 'show' | 'create' | 'update' | 'destroy';
 type RequestData = Record<string, any>;
 type ApiResourceMiddleware<M = any> = M | M[] | { [K in ControllerAction]?: M | M[] };
 interface RouterConfig {
+  /**
+   * When enabled, API param name will be infered from the route path.
+   * So instead of getting /api/users/:id, we will now get /api/users/:user
+   */
+  inferParamName?: boolean;
   /**
    * Configuration for method override functionality, allowing clients to use a
    * specific header or body parameter to override the HTTP method.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clear-router",
-  "version": "2.6.1",
+  "version": "2.6.3",
   "description": "Laravel-style routing for Node.js with support for Express, H3, Fastify, Hono, and Koa, including CommonJS, ESM, and TypeScript support.",
   "keywords": [
     "h3",
@@ -88,6 +88,7 @@
     "h3": "^2.0.1-rc.16",
     "hono": "^4.0.0",
     "koa": "^3.0.0",
+    "@h3ravel/support": "^0.15.11",
     "reflect-metadata": "^0.2.2"
   },
   "peerDependenciesMeta": {
@@ -109,6 +110,9 @@
     "koa": {
       "optional": true
     },
+    "@h3ravel/support": {
+      "optional": true
+    },
     "reflect-metadata": {
       "optional": true
     }