clear-router 2.5.0 → 2.5.2

package/dist/koa/index.d.cts

@@ -1,4 +1,4 @@
-import { d as ApiResourceMiddleware, f as ControllerAction, m as HttpMethod, n as ClearRequest, p as ControllerHandler, r as Route, t as CoreRouter } from "../router-A-9JuZPi.cjs";
+import { d as ApiResourceMiddleware, f as ControllerAction, m as HttpMethod, n as ClearRequest, p as ControllerHandler, r as Route, t as CoreRouter } from "../router-CS_2XQ7I.cjs";
 import Koa from "koa";
 import Router$1 from "@koa/router";
 
@@ -31,31 +31,115 @@ declare class Router extends CoreRouter {
   private static readBody;
   private static sendReturnValue;
   /**
-   * Adds a new route to the router with the specified HTTP methods, path, handler, and optional middlewares.
+   * Adds a new route to the router.
+   *
+   * @param methods
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static add(methods: HttpMethod | HttpMethod[], path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Adds a new API resource route to the router for the specified base path and controller.
+   * Define a resourceful API controller with standard CRUD routes
+   *
+   * @param basePath
+   * @param controller
+   * @param options
    */
   static apiResource(basePath: string, controller: any, options?: {
     only?: ControllerAction[];
     except?: ControllerAction[];
     middlewares?: ApiResourceMiddleware<Middleware>;
   }): void;
+  /**
+   * Define a GET route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static get(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define a POST route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static post(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define a PUT route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static put(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define a DELETE route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static delete(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define a PATCH route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static patch(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define an OPTIONS route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static options(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Adds a new HEAD route to the router.
+   *
+   * @param this
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static head(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Defines a group of routes with a common prefix.
+   *
+   * @param prefix
+   * @param callback
+   * @param middlewares
+   */
   static group(prefix: string, callback: () => void | Promise<void>, middlewares?: Middleware[]): Promise<void>;
+  /**
+   * Apply middlewares to a group of routes defined within the callback
+   *
+   * @param middlewares  - Middleware or array of middlewares to apply
+   * @param callback     - Function that defines the routes to which the middlewares will be applied
+   */
   static middleware(middlewares: Middleware[], callback: () => void): void;
+  /**
+   * Get all defined routes, optionally organized by path or method
+   */
   static allRoutes(): Array<Route<HttpContext, Middleware, Handler>>;
+  /**
+   * @param type  - 'path' to get routes organized by path
+   */
   static allRoutes(type: 'path'): Record<string, Route<HttpContext, Middleware, Handler>>;
+  /**
+   * @param type  - 'method' to get routes organized by method
+   */
   static allRoutes(type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<HttpContext, Middleware, Handler>> };
   /**
-   * Applies the registered routes to a @koa/router instance.
+   * Apply the defined routes to a @koa/router instance
+   *
+   * @param router  @koa/router instance
+   * @returns    The  @koa/router instance with the applied routes
    */
   static apply(router: KoaRouterApp): KoaRouterApp;
 }

package/dist/koa/index.d.mts

@@ -1,4 +1,4 @@
-import { d as ApiResourceMiddleware, f as ControllerAction, m as HttpMethod, n as ClearRequest, p as ControllerHandler, r as Route, t as CoreRouter } from "../router-CVeqd7Ro.mjs";
+import { d as ApiResourceMiddleware, f as ControllerAction, m as HttpMethod, n as ClearRequest, p as ControllerHandler, r as Route, t as CoreRouter } from "../router-_w2VzMQF.mjs";
 import Koa from "koa";
 import Router$1 from "@koa/router";
 
@@ -31,31 +31,115 @@ declare class Router extends CoreRouter {
   private static readBody;
   private static sendReturnValue;
   /**
-   * Adds a new route to the router with the specified HTTP methods, path, handler, and optional middlewares.
+   * Adds a new route to the router.
+   *
+   * @param methods
+   * @param path
+   * @param handler
+   * @param middlewares
    */
   static add(methods: HttpMethod | HttpMethod[], path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
   /**
-   * Adds a new API resource route to the router for the specified base path and controller.
+   * Define a resourceful API controller with standard CRUD routes
+   *
+   * @param basePath
+   * @param controller
+   * @param options
    */
   static apiResource(basePath: string, controller: any, options?: {
     only?: ControllerAction[];
     except?: ControllerAction[];
     middlewares?: ApiResourceMiddleware<Middleware>;
   }): void;
+  /**
+   * Define a GET route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static get(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define a POST route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static post(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define a PUT route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static put(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define a DELETE route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static delete(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define a PATCH route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static patch(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Define an OPTIONS route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static options(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Adds a new HEAD route to the router.
+   *
+   * @param this
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
   static head(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): void;
+  /**
+   * Defines a group of routes with a common prefix.
+   *
+   * @param prefix
+   * @param callback
+   * @param middlewares
+   */
   static group(prefix: string, callback: () => void | Promise<void>, middlewares?: Middleware[]): Promise<void>;
+  /**
+   * Apply middlewares to a group of routes defined within the callback
+   *
+   * @param middlewares  - Middleware or array of middlewares to apply
+   * @param callback     - Function that defines the routes to which the middlewares will be applied
+   */
   static middleware(middlewares: Middleware[], callback: () => void): void;
+  /**
+   * Get all defined routes, optionally organized by path or method
+   */
   static allRoutes(): Array<Route<HttpContext, Middleware, Handler>>;
+  /**
+   * @param type  - 'path' to get routes organized by path
+   */
   static allRoutes(type: 'path'): Record<string, Route<HttpContext, Middleware, Handler>>;
+  /**
+   * @param type  - 'method' to get routes organized by method
+   */
   static allRoutes(type: 'method'): { [method in Uppercase<HttpMethod>]?: Array<Route<HttpContext, Middleware, Handler>> };
   /**
-   * Applies the registered routes to a @koa/router instance.
+   * Apply the defined routes to a @koa/router instance
+   *
+   * @param router  @koa/router instance
+   * @returns    The  @koa/router instance with the applied routes
    */
   static apply(router: KoaRouterApp): KoaRouterApp;
 }

package/dist/koa/index.mjs

@@ -1,4 +1,4 @@
-import { t as CoreRouter } from "../router-Dxc8FQOl.mjs";
+import { t as CoreRouter } from "../router-BReOXz-F.mjs";
 import { n as resolveResponseMeta, t as isFetchResponse } from "../responses-HOePPAl8.mjs";
 
 //#region src/koa/router.ts
@@ -56,41 +56,113 @@ var Router = class Router extends CoreRouter {
 		return ctx.body;
 	}
 	/**
-	* Adds a new route to the router with the specified HTTP methods, path, handler, and optional middlewares.
+	* Adds a new route to the router.
+	*
+	* @param methods
+	* @param path
+	* @param handler
+	* @param middlewares
 	*/
 	static add(methods, path, handler, middlewares) {
 		super.add(methods, path, handler, middlewares);
 	}
 	/**
-	* Adds a new API resource route to the router for the specified base path and controller.
+	* Define a resourceful API controller with standard CRUD routes
+	*
+	* @param basePath
+	* @param controller
+	* @param options
 	*/
 	static apiResource(basePath, controller, options) {
 		super.apiResource(basePath, controller, options);
 	}
+	/**
+	* Define a GET route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static get(path, handler, middlewares) {
 		super.get(path, handler, middlewares);
 	}
+	/**
+	* Define a POST route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static post(path, handler, middlewares) {
 		super.post(path, handler, middlewares);
 	}
+	/**
+	* Define a PUT route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static put(path, handler, middlewares) {
 		super.put(path, handler, middlewares);
 	}
+	/**
+	* Define a DELETE route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static delete(path, handler, middlewares) {
 		super.delete(path, handler, middlewares);
 	}
+	/**
+	* Define a PATCH route 
+	* 
+	* @param path 
+	* @param handler 
+	* @param middlewares 
+	*/
 	static patch(path, handler, middlewares) {
 		super.patch(path, handler, middlewares);
 	}
+	/**
+	* Define an OPTIONS route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static options(path, handler, middlewares) {
 		super.options(path, handler, middlewares);
 	}
+	/**
+	* Adds a new HEAD route to the router.
+	*
+	* @param this
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
 	static head(path, handler, middlewares) {
 		super.head(path, handler, middlewares);
 	}
+	/**
+	* Defines a group of routes with a common prefix.
+	*
+	* @param prefix
+	* @param callback
+	* @param middlewares
+	*/
 	static async group(prefix, callback, middlewares) {
 		await super.group(prefix, callback, middlewares);
 	}
+	/**
+	* Apply middlewares to a group of routes defined within the callback
+	* 
+	* @param middlewares  - Middleware or array of middlewares to apply
+	* @param callback     - Function that defines the routes to which the middlewares will be applied
+	*/
 	static middleware(middlewares, callback) {
 		super.middleware(middlewares, callback);
 	}
@@ -98,7 +170,10 @@ var Router = class Router extends CoreRouter {
 		return super.allRoutes(type);
 	}
 	/**
-	* Applies the registered routes to a @koa/router instance.
+	* Apply the defined routes to a @koa/router instance
+	* 
+	* @param router  @koa/router instance
+	* @returns    The  @koa/router instance with the applied routes
 	*/
 	static apply(router) {
 		for (const route of this.routes) {

package/dist/{router-Dxc8FQOl.mjs → router-BReOXz-F.mjs}

@@ -244,7 +244,7 @@ var CoreRouter = class {
 		return null;
 	}
 	/**
-	* Adds a new route to the router with the specified methods, path, handler, and middlewares.
+	* Adds a new route to the router.
 	* 
 	* @param this 
 	* @param methods 
@@ -274,8 +274,7 @@ var CoreRouter = class {
 		}
 	}
 	/**
-	* Adds a new API resource route to the router for the specified base path and controller, with 
-	* options to include/exclude specific actions and apply middlewares.
+	* Define a resourceful API controller with standard CRUD routes.
 	* 
 	* @param this 
 	* @param basePath 
@@ -318,7 +317,7 @@ var CoreRouter = class {
 		}
 	}
 	/**
-	* Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new GET route to the router.
 	* 
 	* @param this          The router instance.
 	* @param path          The path for the GET route.
@@ -329,7 +328,7 @@ var CoreRouter = class {
 		this.add("get", path, handler, middlewares);
 	}
 	/**
-	* Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new POST route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -340,7 +339,7 @@ var CoreRouter = class {
 		this.add("post", path, handler, middlewares);
 	}
 	/**
-	* Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new PUT route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -351,7 +350,7 @@ var CoreRouter = class {
 		this.add("put", path, handler, middlewares);
 	}
 	/**
-	* Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new DELETE route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -362,7 +361,7 @@ var CoreRouter = class {
 		this.add("delete", path, handler, middlewares);
 	}
 	/**
-	* Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new PATCH route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -373,7 +372,7 @@ var CoreRouter = class {
 		this.add("patch", path, handler, middlewares);
 	}
 	/**
-	* Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new OPTIONS route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -384,7 +383,7 @@ var CoreRouter = class {
 		this.add("options", path, handler, middlewares);
 	}
 	/**
-	* Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new HEAD route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -395,8 +394,7 @@ var CoreRouter = class {
 		this.add("head", path, handler, middlewares);
 	}
 	/**
-	* Defines a group of routes with a common prefix and optional middlewares, allowing for better 
-	* organization and reuse of route configurations.
+	* Defines a group of routes with a common prefix.
 	* 
 	* @param this 
 	* @param prefix 

package/dist/{router-Cxi21bzi.cjs → router-CHg0pZUO.cjs}

@@ -244,7 +244,7 @@ var CoreRouter = class {
 		return null;
 	}
 	/**
-	* Adds a new route to the router with the specified methods, path, handler, and middlewares.
+	* Adds a new route to the router.
 	* 
 	* @param this 
 	* @param methods 
@@ -274,8 +274,7 @@ var CoreRouter = class {
 		}
 	}
 	/**
-	* Adds a new API resource route to the router for the specified base path and controller, with 
-	* options to include/exclude specific actions and apply middlewares.
+	* Define a resourceful API controller with standard CRUD routes.
 	* 
 	* @param this 
 	* @param basePath 
@@ -318,7 +317,7 @@ var CoreRouter = class {
 		}
 	}
 	/**
-	* Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new GET route to the router.
 	* 
 	* @param this          The router instance.
 	* @param path          The path for the GET route.
@@ -329,7 +328,7 @@ var CoreRouter = class {
 		this.add("get", path, handler, middlewares);
 	}
 	/**
-	* Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new POST route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -340,7 +339,7 @@ var CoreRouter = class {
 		this.add("post", path, handler, middlewares);
 	}
 	/**
-	* Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new PUT route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -351,7 +350,7 @@ var CoreRouter = class {
 		this.add("put", path, handler, middlewares);
 	}
 	/**
-	* Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new DELETE route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -362,7 +361,7 @@ var CoreRouter = class {
 		this.add("delete", path, handler, middlewares);
 	}
 	/**
-	* Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new PATCH route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -373,7 +372,7 @@ var CoreRouter = class {
 		this.add("patch", path, handler, middlewares);
 	}
 	/**
-	* Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new OPTIONS route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -384,7 +383,7 @@ var CoreRouter = class {
 		this.add("options", path, handler, middlewares);
 	}
 	/**
-	* Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+	* Adds a new HEAD route to the router.
 	* 
 	* @param this 
 	* @param path 
@@ -395,8 +394,7 @@ var CoreRouter = class {
 		this.add("head", path, handler, middlewares);
 	}
 	/**
-	* Defines a group of routes with a common prefix and optional middlewares, allowing for better 
-	* organization and reuse of route configurations.
+	* Defines a group of routes with a common prefix.
 	* 
 	* @param this 
 	* @param prefix 

package/dist/{router-A-9JuZPi.d.cts → router-CS_2XQ7I.d.cts}

@@ -211,7 +211,7 @@ declare abstract class CoreRouter {
   static configure(this: any, options?: RouterConfig): void;
   protected static resolveMethodOverride(this: any, method: string, headers: Headers | Record<string, any>, body: unknown): HttpMethod | null;
   /**
-   * Adds a new route to the router with the specified methods, path, handler, and middlewares.
+   * Adds a new route to the router.
    *
    * @param this
    * @param methods
@@ -221,8 +221,7 @@ declare abstract class CoreRouter {
    */
   static add(this: any, methods: HttpMethod | HttpMethod[], path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new API resource route to the router for the specified base path and controller, with
-   * options to include/exclude specific actions and apply middlewares.
+   * Define a resourceful API controller with standard CRUD routes.
    *
    * @param this
    * @param basePath
@@ -235,7 +234,7 @@ declare abstract class CoreRouter {
     middlewares?: ApiResourceMiddleware<any>;
   }): void;
   /**
-   * Adds a new GET route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new GET route to the router.
    *
    * @param this          The router instance.
    * @param path          The path for the GET route.
@@ -244,7 +243,7 @@ declare abstract class CoreRouter {
    */
   static get(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new POST route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new POST route to the router.
    *
    * @param this
    * @param path
@@ -253,7 +252,7 @@ declare abstract class CoreRouter {
    */
   static post(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new PUT route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new PUT route to the router.
    *
    * @param this
    * @param path
@@ -262,7 +261,7 @@ declare abstract class CoreRouter {
    */
   static put(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new DELETE route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new DELETE route to the router.
    *
    * @param this
    * @param path
@@ -271,7 +270,7 @@ declare abstract class CoreRouter {
    */
   static delete(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new PATCH route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new PATCH route to the router.
    *
    * @param this
    * @param path
@@ -280,7 +279,7 @@ declare abstract class CoreRouter {
    */
   static patch(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new OPTIONS route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new OPTIONS route to the router.
    *
    * @param this
    * @param path
@@ -289,7 +288,7 @@ declare abstract class CoreRouter {
    */
   static options(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Adds a new HEAD route to the router with the specified path, handler, and optional middlewares.
+   * Adds a new HEAD route to the router.
    *
    * @param this
    * @param path
@@ -298,8 +297,7 @@ declare abstract class CoreRouter {
    */
   static head(this: any, path: string, handler: any, middlewares?: any[] | any): void;
   /**
-   * Defines a group of routes with a common prefix and optional middlewares, allowing for better
-   * organization and reuse of route configurations.
+   * Defines a group of routes with a common prefix.
    *
    * @param this
    * @param prefix