clear-router 2.1.12 → 2.2.0

package/dist/express/index.d.cts

@@ -1,70 +1,32 @@
-import { a as Handler, c as Route, i as RouterConfig, n as ControllerAction, o as HttpContext, r as HttpMethod, s as Middleware, t as ApiResourceMiddleware } from "../basic-C_1O6RVq.cjs";
+import { a as Handler, c as Route, i as HttpMethod, n as ApiResourceMiddleware, o as HttpContext, r as ControllerAction, s as Middleware, t as CoreRouter } from "../router-CZIh1ZPJ.cjs";
 import { Router as Router$1 } from "express";
 
 //#region src/express/router.d.ts
 /**
- * @class clear-router
+ * @class clear-router Express Router
  * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
  * @author Refkinscallv
  * @author 3m1n3nc3
  * @repository https://github.com/toneflix/clear-router
  */
-declare class Router {
-  static config: RouterConfig;
-  private static readonly groupContext;
-  /**
-   * All registered routes
-   */
-  static routes: Array<Route<HttpContext, Middleware>>;
-  /**
-   * Mapping of routes by path and method for quick lookup.
-   */
-  static routesByPathMethod: Record<string, Route<HttpContext, Middleware>>;
-  /**
-   * Mapping of routes by method for quick lookup.
-   */
-  static routesByMethod: { [method in Uppercase<HttpMethod>]?: Array<Route<HttpContext, Middleware>> };
-  /**
-   * Current route prefix
-   */
-  static prefix: string;
-  /**
-   * Group-level middlewares
-   */
-  static groupMiddlewares: Middleware[];
-  /**
-   * Global-level middlewares
-   */
-  static globalMiddlewares: Middleware[];
-  /**
-   * Normalize path by removing duplicate slashes and ensuring leading slash
-   * @param path - Path to normalize
-   * @returns Normalized path
-   */
-  static normalizePath(path: string): string;
+declare class Router extends CoreRouter {
+  private static ensureRequestBodyAccessor;
   /**
-   * Configure router settings to modify behavior.
+   * Adds a new route to the router with the specified HTTP methods, path, handler, and optional middlewares.
    *
-   * @param options - Configuration options for the router
-   * @returns
+   * @param methods
+   * @param path
+   * @param handler
+   * @param middlewares
    */
-  static configure(options?: RouterConfig): void;
-  private static ensureRequestBodyAccessor;
-  private static resolveMethodOverride;
-  /**
-    * Add a route with specified HTTP methods, path, handler, and middlewares
-    * @param methods - HTTP method(s) for the route
-    * @param path - Route path
-    * @param handler - Route handler function or controller reference
-    * @param middlewares - Array of middleware functions
-    */
   static add(methods: HttpMethod | HttpMethod[], path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register RESTful API resource routes for a controller with optional action filtering
+   * Adds a new API resource route to the router for the specified base path and controller, with
+   * optional configuration for included/excluded actions and middlewares.
    *
-   * @param basePath - Base path for the resource
-   * @param controller - Controller object containing action methods
-   * @param options - Optional filtering options for actions
+   * @param basePath
+   * @param controller
+   * @param options
    */
   static apiResource(basePath: string, controller: any, options?: {
     only?: ControllerAction[];
@@ -72,84 +34,93 @@ declare class Router {
     middlewares?: ApiResourceMiddleware<Middleware>;
   }): void;
   /**
-   * Register a GET route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static get(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a POST route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static post(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a PUT route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static put(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a DELETE route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static delete(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a PATCH route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static patch(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register an OPTIONS route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static options(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a HEAD route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static head(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Group routes with a common prefix and middlewares
-   * @param prefix - URL prefix for grouped routes
-   * @param callback - Function containing route definitions
-   * @param middlewares - Middleware functions applied to all routes in group
+   * Defines a group of routes with a common prefix and optional middlewares, allowing for better
+   * organization and reuse of route configurations.
+   *
+   * @param prefix
+   * @param callback
+   * @param middlewares
    */
   static group(prefix: string, callback: () => void | Promise<void>, middlewares?: Middleware[]): Promise<void>;
   /**
-   * Apply global middlewares for the duration of the callback
-   * @param middlewares - Middleware functions
-   * @param callback - Function containing route definitions
+   * Adds global middlewares to the router, which will be applied to all routes.
+   *
+   * @param middlewares
+   * @param callback
    */
   static middleware(middlewares: Middleware[], callback: () => void): void;
   /**
-   * Get all registered routes with their information
-   * @returns Array of route information objects
+   * Retrieves all registered routes in the router, optionally organized by path or method.
+   *
+   * @param type
    */
-  static allRoutes(): Array<Route<HttpContext, Middleware>>;
-  static allRoutes(type: 'path'): Record<string, Route<HttpContext, Middleware>>;
-  static allRoutes(type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<HttpContext, Middleware>> };
+  static allRoutes(): Array<Route<HttpContext, Middleware, Handler>>;
+  static allRoutes(type: 'path'): Record<string, Route<HttpContext, Middleware, Handler>>;
+  static allRoutes(type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<HttpContext, Middleware, Handler>> };
   /**
-   * Apply all registered routes to the provided Express Router instance
-   * Handles controller-method binding and middleware application
-   * All errors are thrown to Express error handling middleware
+   * Applies the registered routes to the given Express router instance, setting up the necessary
+   * handlers and middlewares for each route.
    *
-   * @param router - Express Router instance
+   * @param router
    */
   static apply(router: Router$1): void;
   static apply(router: Router$1): Promise<void>;
-  private static bindRequestToInstance;
 }
 //#endregion
 export { Router };

package/dist/express/index.d.mts

@@ -1,70 +1,32 @@
-import { a as Handler, c as Route, i as RouterConfig, n as ControllerAction, o as HttpContext, r as HttpMethod, s as Middleware, t as ApiResourceMiddleware } from "../basic-cLeny2Zk.mjs";
+import { a as Handler, c as Route, i as HttpMethod, n as ApiResourceMiddleware, o as HttpContext, r as ControllerAction, s as Middleware, t as CoreRouter } from "../router-C1jVRytA.mjs";
 import { Router as Router$1 } from "express";
 
 //#region src/express/router.d.ts
 /**
- * @class clear-router
+ * @class clear-router Express Router
  * @description Laravel-style routing system for Express.js and H3 with support for CommonJS, ESM, and TypeScript
  * @author Refkinscallv
  * @author 3m1n3nc3
  * @repository https://github.com/toneflix/clear-router
  */
-declare class Router {
-  static config: RouterConfig;
-  private static readonly groupContext;
-  /**
-   * All registered routes
-   */
-  static routes: Array<Route<HttpContext, Middleware>>;
-  /**
-   * Mapping of routes by path and method for quick lookup.
-   */
-  static routesByPathMethod: Record<string, Route<HttpContext, Middleware>>;
-  /**
-   * Mapping of routes by method for quick lookup.
-   */
-  static routesByMethod: { [method in Uppercase<HttpMethod>]?: Array<Route<HttpContext, Middleware>> };
-  /**
-   * Current route prefix
-   */
-  static prefix: string;
-  /**
-   * Group-level middlewares
-   */
-  static groupMiddlewares: Middleware[];
-  /**
-   * Global-level middlewares
-   */
-  static globalMiddlewares: Middleware[];
-  /**
-   * Normalize path by removing duplicate slashes and ensuring leading slash
-   * @param path - Path to normalize
-   * @returns Normalized path
-   */
-  static normalizePath(path: string): string;
+declare class Router extends CoreRouter {
+  private static ensureRequestBodyAccessor;
   /**
-   * Configure router settings to modify behavior.
+   * Adds a new route to the router with the specified HTTP methods, path, handler, and optional middlewares.
    *
-   * @param options - Configuration options for the router
-   * @returns
+   * @param methods
+   * @param path
+   * @param handler
+   * @param middlewares
    */
-  static configure(options?: RouterConfig): void;
-  private static ensureRequestBodyAccessor;
-  private static resolveMethodOverride;
-  /**
-    * Add a route with specified HTTP methods, path, handler, and middlewares
-    * @param methods - HTTP method(s) for the route
-    * @param path - Route path
-    * @param handler - Route handler function or controller reference
-    * @param middlewares - Array of middleware functions
-    */
   static add(methods: HttpMethod | HttpMethod[], path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register RESTful API resource routes for a controller with optional action filtering
+   * Adds a new API resource route to the router for the specified base path and controller, with
+   * optional configuration for included/excluded actions and middlewares.
    *
-   * @param basePath - Base path for the resource
-   * @param controller - Controller object containing action methods
-   * @param options - Optional filtering options for actions
+   * @param basePath
+   * @param controller
+   * @param options
    */
   static apiResource(basePath: string, controller: any, options?: {
     only?: ControllerAction[];
@@ -72,84 +34,93 @@ declare class Router {
     middlewares?: ApiResourceMiddleware<Middleware>;
   }): void;
   /**
-   * Register a GET route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static get(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a POST route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static post(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a PUT route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static put(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a DELETE route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static delete(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a PATCH route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static patch(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register an OPTIONS route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static options(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Register a HEAD route
-   * @param path - Route path
-   * @param handler - Route handler
-   * @param middlewares - Middleware functions
+   * Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static head(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Group routes with a common prefix and middlewares
-   * @param prefix - URL prefix for grouped routes
-   * @param callback - Function containing route definitions
-   * @param middlewares - Middleware functions applied to all routes in group
+   * Defines a group of routes with a common prefix and optional middlewares, allowing for better
+   * organization and reuse of route configurations.
+   *
+   * @param prefix
+   * @param callback
+   * @param middlewares
    */
   static group(prefix: string, callback: () => void | Promise<void>, middlewares?: Middleware[]): Promise<void>;
   /**
-   * Apply global middlewares for the duration of the callback
-   * @param middlewares - Middleware functions
-   * @param callback - Function containing route definitions
+   * Adds global middlewares to the router, which will be applied to all routes.
+   *
+   * @param middlewares
+   * @param callback
    */
   static middleware(middlewares: Middleware[], callback: () => void): void;
   /**
-   * Get all registered routes with their information
-   * @returns Array of route information objects
+   * Retrieves all registered routes in the router, optionally organized by path or method.
+   *
+   * @param type
    */
-  static allRoutes(): Array<Route<HttpContext, Middleware>>;
-  static allRoutes(type: 'path'): Record<string, Route<HttpContext, Middleware>>;
-  static allRoutes(type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<HttpContext, Middleware>> };
+  static allRoutes(): Array<Route<HttpContext, Middleware, Handler>>;
+  static allRoutes(type: 'path'): Record<string, Route<HttpContext, Middleware, Handler>>;
+  static allRoutes(type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<HttpContext, Middleware, Handler>> };
   /**
-   * Apply all registered routes to the provided Express Router instance
-   * Handles controller-method binding and middleware application
-   * All errors are thrown to Express error handling middleware
+   * Applies the registered routes to the given Express router instance, setting up the necessary
+   * handlers and middlewares for each route.
    *
-   * @param router - Express Router instance
+   * @param router
    */
   static apply(router: Router$1): void;
   static apply(router: Router$1): Promise<void>;
-  private static bindRequestToInstance;
 }
 //#endregion
 export { Router };