clear-router 2.4.0 → 2.5.1

package/dist/koa/index.mjs

@@ -0,0 +1,243 @@
+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
+/**
+* @class clear-router Koa Router
+* @description Laravel-style routing system for Koa using @koa/router and shared clear-router core
+* @author 3m1n3nc3
+* @repository https://github.com/toneflix/clear-router
+*/
+var Router = class Router extends CoreRouter {
+	static routerStateNamespace = "clear-router:koa";
+	static bodyCache = /* @__PURE__ */ new WeakMap();
+	static async readBodyCached(ctx) {
+		if (this.bodyCache.has(ctx)) {
+			const cached = this.bodyCache.get(ctx) || {};
+			ctx.request.getBody = () => cached;
+			return cached;
+		}
+		let body = ctx.request.body && typeof ctx.request.body === "object" ? ctx.request.body : {};
+		if (!Object.keys(body).length && !["GET", "HEAD"].includes(ctx.method.toUpperCase())) body = await this.readBody(ctx);
+		ctx.request.getBody = () => body;
+		this.bodyCache.set(ctx, body);
+		return body;
+	}
+	static async readBody(ctx) {
+		const contentType = String(ctx.get("content-type") || "").toLowerCase();
+		const chunks = [];
+		for await (const chunk of ctx.req) chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+		const raw = Buffer.concat(chunks).toString("utf8");
+		if (!raw) return {};
+		if (contentType.includes("application/json")) return JSON.parse(raw);
+		if (contentType.includes("application/x-www-form-urlencoded")) return Object.fromEntries(new URLSearchParams(raw));
+		return {};
+	}
+	static async sendReturnValue(ctx, value, method, path) {
+		if (ctx.respond === false || ctx.headerSent) return value;
+		const meta = resolveResponseMeta(value, {
+			headers: ctx.headers,
+			method,
+			path,
+			status: ctx.status && ctx.status !== 404 ? ctx.status : void 0
+		});
+		if (!meta) return void 0;
+		ctx.status = meta.status;
+		if (isFetchResponse(meta.body)) {
+			meta.body.headers.forEach((headerValue, key) => {
+				ctx.set(key, headerValue);
+			});
+			ctx.status = meta.body.status;
+			ctx.body = Buffer.from(await meta.body.arrayBuffer());
+			return ctx.body;
+		}
+		if (meta.contentType) ctx.type = meta.contentType;
+		ctx.body = meta.isEmpty ? null : meta.body;
+		return ctx.body;
+	}
+	/**
+	* 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);
+	}
+	/**
+	* 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);
+	}
+	static allRoutes(type) {
+		return super.allRoutes(type);
+	}
+	/**
+	* 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) {
+			let handlerFunction = null;
+			let instance = null;
+			try {
+				const resolved = this.resolveHandler(route);
+				handlerFunction = resolved.handlerFunction;
+				instance = resolved.instance;
+			} catch (error) {
+				console.error(`[ROUTES] Error setting up route ${route.path}:`, error.message);
+				throw error;
+			}
+			if (!handlerFunction) continue;
+			for (const method of route.methods) {
+				const allowedMethods = [
+					"get",
+					"post",
+					"put",
+					"delete",
+					"patch",
+					"options",
+					"head"
+				];
+				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) => {
+					const ctx = context;
+					const reqBody = await Router.readBodyCached(ctx);
+					const override = Router.resolveMethodOverride(ctx.method, ctx.headers, reqBody);
+					if (method === "post" && override && override !== "post") return next();
+					const inst = instance ?? route;
+					Router.bindRequestToInstance(ctx, inst, route, {
+						body: reqBody,
+						query: ctx.query,
+						params: ctx.params ?? {}
+					});
+					const result = handlerFunction(ctx, inst.clearRequest);
+					const resolved = await Promise.resolve(result);
+					return Router.sendReturnValue(ctx, resolved, method, route.path);
+				});
+				if ([
+					"put",
+					"patch",
+					"delete"
+				].includes(method)) router.post(route.path, ...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();
+					const inst = instance ?? route;
+					Router.bindRequestToInstance(ctx, inst, route, {
+						body: reqBody,
+						query: ctx.query,
+						params: ctx.params ?? {}
+					});
+					const result = handlerFunction(ctx, inst.clearRequest);
+					const resolved = await Promise.resolve(result);
+					return Router.sendReturnValue(ctx, resolved, method, route.path);
+				});
+			}
+		}
+		return router;
+	}
+};
+
+//#endregion
+export { Router };

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

@@ -144,6 +144,11 @@ var CoreRouter = class {
 				ctx.reply.code(204).send();
 				return;
 			}
+			if (ctx?.set && "status" in ctx) {
+				ctx.set("Allow", allow);
+				ctx.status = 204;
+				ctx.body = null;
+			}
 		};
 	}
 	static config = { methodOverride: {
@@ -239,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 
@@ -269,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 
@@ -313,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.
@@ -324,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 
@@ -335,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 
@@ -346,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 
@@ -357,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 
@@ -368,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 
@@ -379,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 
@@ -390,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-C-c43ybe.cjs → router-CHg0pZUO.cjs}

@@ -144,6 +144,11 @@ var CoreRouter = class {
 				ctx.reply.code(204).send();
 				return;
 			}
+			if (ctx?.set && "status" in ctx) {
+				ctx.set("Allow", allow);
+				ctx.status = 204;
+				ctx.body = null;
+			}
 		};
 	}
 	static config = { methodOverride: {
@@ -239,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 
@@ -269,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 
@@ -313,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.
@@ -324,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 
@@ -335,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 
@@ -346,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 
@@ -357,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 
@@ -368,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 
@@ -379,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 
@@ -390,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

package/dist/{router-CVeqd7Ro.d.mts → router-_w2VzMQF.d.mts}

@@ -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

package/dist/types/koa.d.mts

@@ -0,0 +1,22 @@
+import { ControllerHandler } from "./basic.mjs";
+import { ClearRequest } from "./ClearRequest.mjs";
+import Koa from "koa";
+import Router from "@koa/router";
+
+//#region types/koa.d.ts
+interface RequestWithGetBody extends Koa.Request {
+  getBody: () => Record<string, any>;
+  body?: any;
+}
+interface HttpContext extends Koa.Context {
+  request: RequestWithGetBody;
+  params: Record<string, any>;
+  query: Record<string, any>;
+}
+type RouteHandler = (ctx: HttpContext, req: ClearRequest) => any | Promise<any>;
+type Handler = RouteHandler | ControllerHandler;
+type NextFunction = Koa.Next;
+type Middleware = Koa.Middleware<any, any>;
+type KoaRouterApp = Router<any, any>;
+//#endregion
+export { Handler, HttpContext, KoaRouterApp, Middleware, NextFunction, RequestWithGetBody, RouteHandler };

package/dist/types/koa.mjs

@@ -0,0 +1 @@
+export {  };