clear-router 2.7.6 → 2.8.0

package/dist/koa/index.mjs

@@ -1,262 +1,3 @@
-import "../bindings-XLDXFpHZ.mjs";
-import { t as CoreRouter } from "../router-Dc9w86Wn.mjs";
-import { n as resolveResponseMeta, t as isFetchResponse } from "../responses-BvETUeDL.mjs";
+import Router from "./router.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/arkstack-tmp/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;
-		meta.headers?.forEach((headerValue, key) => {
-			ctx.set(key, headerValue);
-		});
-		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) {
-		return 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) {
-		return super.get(path, handler, middlewares);
-	}
-	/**
-	* Define a POST route
-	*
-	* @param path
-	* @param handler
-	* @param middlewares
-	*/
-	static post(path, handler, middlewares) {
-		return super.post(path, handler, middlewares);
-	}
-	/**
-	* Define a PUT route
-	*
-	* @param path
-	* @param handler
-	* @param middlewares
-	*/
-	static put(path, handler, middlewares) {
-		return super.put(path, handler, middlewares);
-	}
-	/**
-	* Define a DELETE route
-	*
-	* @param path
-	* @param handler
-	* @param middlewares
-	*/
-	static delete(path, handler, middlewares) {
-		return super.delete(path, handler, middlewares);
-	}
-	/**
-	* Define a PATCH route 
-	* 
-	* @param path 
-	* @param handler 
-	* @param middlewares 
-	*/
-	static patch(path, handler, middlewares) {
-		return super.patch(path, handler, middlewares);
-	}
-	/**
-	* Define an OPTIONS route
-	*
-	* @param path
-	* @param handler
-	* @param middlewares
-	*/
-	static options(path, handler, middlewares) {
-		return 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) {
-		return 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);
-	}
-	static route(name) {
-		return super.route(name);
-	}
-	/**
-	* 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 Array.from(this.routes)) {
-			let handlerFunction = null;
-			let instance = null;
-			let bindingTarget;
-			let bindingMethod;
-			let bindingHandler;
-			let bindingMetadata;
-			try {
-				const resolved = this.resolveHandler(route);
-				handlerFunction = resolved.handlerFunction;
-				instance = resolved.instance;
-				bindingTarget = resolved.bindingTarget;
-				bindingMethod = resolved.bindingMethod;
-				bindingHandler = resolved.bindingHandler;
-				bindingMetadata = resolved.bindingMetadata;
-			} 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}`);
-				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);
-					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 ?? {},
-						method
-					});
-					const result = await Router.callHandler(handlerFunction, ctx, bindingTarget, bindingMethod, bindingHandler, bindingMetadata);
-					const resolved = await Promise.resolve(result);
-					const outgoing = typeof resolved === "undefined" && ctx.clearResponse?.sent ? ctx.clearResponse : resolved;
-					return Router.sendReturnValue(ctx, outgoing, method, route.path);
-				});
-				if ([
-					"put",
-					"patch",
-					"delete"
-				].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();
-					const inst = instance ?? route;
-					Router.bindRequestToInstance(ctx, inst, route, {
-						body: reqBody,
-						query: ctx.query,
-						params: ctx.params ?? {},
-						method
-					});
-					const result = await Router.callHandler(handlerFunction, ctx, bindingTarget, bindingMethod, bindingHandler, bindingMetadata);
-					const resolved = await Promise.resolve(result);
-					const outgoing = typeof resolved === "undefined" && ctx.clearResponse?.sent ? ctx.clearResponse : resolved;
-					return Router.sendReturnValue(ctx, outgoing, method, route.path);
-				});
-			}
-		}
-		return router;
-	}
-};
-
-//#endregion
 export { Router };

package/dist/koa/router.cjs

@@ -0,0 +1,261 @@
+const require_router = require('../core/router.cjs');
+const require_responses = require('../core/responses.cjs');
+
+//#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/arkstack-tmp/clear-router
+*/
+var Router = class Router extends require_router.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 = require_responses.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;
+		meta.headers?.forEach((headerValue, key) => {
+			ctx.set(key, headerValue);
+		});
+		if (require_responses.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) {
+		return 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) {
+		return super.apiResource(basePath, controller, options);
+	}
+	/**
+	* Define a GET route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
+	static get(path, handler, middlewares) {
+		return super.get(path, handler, middlewares);
+	}
+	/**
+	* Define a POST route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
+	static post(path, handler, middlewares) {
+		return super.post(path, handler, middlewares);
+	}
+	/**
+	* Define a PUT route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
+	static put(path, handler, middlewares) {
+		return super.put(path, handler, middlewares);
+	}
+	/**
+	* Define a DELETE route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
+	static delete(path, handler, middlewares) {
+		return super.delete(path, handler, middlewares);
+	}
+	/**
+	* Define a PATCH route 
+	* 
+	* @param path 
+	* @param handler 
+	* @param middlewares 
+	*/
+	static patch(path, handler, middlewares) {
+		return super.patch(path, handler, middlewares);
+	}
+	/**
+	* Define an OPTIONS route
+	*
+	* @param path
+	* @param handler
+	* @param middlewares
+	*/
+	static options(path, handler, middlewares) {
+		return 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) {
+		return 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);
+	}
+	static route(name) {
+		return super.route(name);
+	}
+	/**
+	* 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.orderedRoutes()) {
+			let handlerFunction = null;
+			let instance = null;
+			let bindingTarget;
+			let bindingMethod;
+			let bindingHandler;
+			let bindingMetadata;
+			try {
+				const resolved = this.resolveHandler(route);
+				handlerFunction = resolved.handlerFunction;
+				instance = resolved.instance;
+				bindingTarget = resolved.bindingTarget;
+				bindingMethod = resolved.bindingMethod;
+				bindingHandler = resolved.bindingHandler;
+				bindingMetadata = resolved.bindingMetadata;
+			} 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}`);
+				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);
+					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 ?? {},
+						method
+					});
+					const result = await Router.callHandler(handlerFunction, ctx, bindingTarget, bindingMethod, bindingHandler, bindingMetadata);
+					const resolved = await Promise.resolve(result);
+					const outgoing = typeof resolved === "undefined" && ctx.clearResponse?.sent ? ctx.clearResponse : resolved;
+					return Router.sendReturnValue(ctx, outgoing, method, route.path);
+				});
+				if ([
+					"put",
+					"patch",
+					"delete"
+				].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();
+					const inst = instance ?? route;
+					Router.bindRequestToInstance(ctx, inst, route, {
+						body: reqBody,
+						query: ctx.query,
+						params: ctx.params ?? {},
+						method
+					});
+					const result = await Router.callHandler(handlerFunction, ctx, bindingTarget, bindingMethod, bindingHandler, bindingMetadata);
+					const resolved = await Promise.resolve(result);
+					const outgoing = typeof resolved === "undefined" && ctx.clearResponse?.sent ? ctx.clearResponse : resolved;
+					return Router.sendReturnValue(ctx, outgoing, method, route.path);
+				});
+			}
+		}
+		return router;
+	}
+};
+
+//#endregion
+exports.default = Router;

package/dist/koa/router.d.cts

@@ -0,0 +1,136 @@
+import { ApiResourceMiddleware, ControllerAction, HttpMethod } from "../types/basic.cjs";
+import { Handler, HttpContext, KoaRouterApp, Middleware } from "../types/koa.cjs";
+import { Route } from "../Route.cjs";
+import { ResourceRoutes } from "../ResourceRoutes.cjs";
+import { CoreRouter } from "../core/router.cjs";
+
+//#region src/koa/router.d.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/arkstack-tmp/clear-router
+ */
+declare class Router extends CoreRouter {
+  protected static routerStateNamespace: string;
+  private static readonly bodyCache;
+  private static readBodyCached;
+  private static readBody;
+  private static sendReturnValue;
+  /**
+   * 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): Route<HttpContext, Middleware, Handler>;
+  /**
+   * 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>;
+  }): ResourceRoutes<HttpContext, Middleware, Handler>;
+  /**
+   * Define a GET route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static get(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): Route<HttpContext, Middleware, Handler>;
+  /**
+   * Define a POST route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static post(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): Route<HttpContext, Middleware, Handler>;
+  /**
+   * Define a PUT route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static put(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): Route<HttpContext, Middleware, Handler>;
+  /**
+   * Define a DELETE route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static delete(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): Route<HttpContext, Middleware, Handler>;
+  /**
+   * Define a PATCH route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static patch(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): Route<HttpContext, Middleware, Handler>;
+  /**
+   * Define an OPTIONS route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static options(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): Route<HttpContext, Middleware, Handler>;
+  /**
+   * 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): Route<HttpContext, Middleware, Handler>;
+  /**
+   * 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>> };
+  static allRoutes(type: 'name'): Record<string, Route<HttpContext, Middleware, Handler>>;
+  static route(name: string): Route<HttpContext, Middleware, Handler> | undefined;
+  /**
+   * 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;
+}
+//#endregion
+export { Router };