clear-router 2.7.5 → 2.7.7

package/dist/fastify/router.d.cts

@@ -0,0 +1,129 @@
+import { ApiResourceMiddleware, ControllerAction, HttpMethod } from "../types/basic.cjs";
+import { FastifyApp, Handler, HttpContext, Middleware } from "../types/fastify.cjs";
+import { Route } from "../Route.cjs";
+import { CoreRouter } from "../core/router.cjs";
+
+//#region src/fastify/router.d.ts
+/**
+ * @class clear-router Fastify Router
+ * @description Laravel-style routing system for Fastify using 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 ensureRequestBodyAccessor;
+  private static sendReturnValue;
+  /**
+   * Add a route to the router
+   *
+   * @param methods       HTTP methods for the route
+   * @param path          Route path
+   * @param handler       Route handler function
+   * @param middlewares   Optional middlewares for the route
+   */
+  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     Base path for the resource
+   * @param controller   Controller class or instance
+   * @param options      Optional configuration for the resource
+   */
+  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): 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>;
+  /**
+   * Define a HEAD route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static head(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): Route<HttpContext, Middleware, Handler>;
+  /**
+   * Define a group of routes with a common prefix and optional middlewares
+   *
+   * @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
+   * @param callback
+   */
+  static middleware(middlewares: Middleware[], callback: () => void): void;
+  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 Fastify application instance
+   *
+   * @param app  - The Fastify application instance
+   * @returns    The Fastify application instance with the applied routes
+   */
+  static apply(app: FastifyApp): FastifyApp;
+}
+//#endregion
+export { Router };

package/dist/fastify/router.d.mts

@@ -0,0 +1,129 @@
+import { ApiResourceMiddleware, ControllerAction, HttpMethod } from "../types/basic.mjs";
+import { FastifyApp, Handler, HttpContext, Middleware } from "../types/fastify.mjs";
+import { Route } from "../Route.mjs";
+import { CoreRouter } from "../core/router.mjs";
+
+//#region src/fastify/router.d.ts
+/**
+ * @class clear-router Fastify Router
+ * @description Laravel-style routing system for Fastify using 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 ensureRequestBodyAccessor;
+  private static sendReturnValue;
+  /**
+   * Add a route to the router
+   *
+   * @param methods       HTTP methods for the route
+   * @param path          Route path
+   * @param handler       Route handler function
+   * @param middlewares   Optional middlewares for the route
+   */
+  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     Base path for the resource
+   * @param controller   Controller class or instance
+   * @param options      Optional configuration for the resource
+   */
+  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): 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>;
+  /**
+   * Define a HEAD route
+   *
+   * @param path
+   * @param handler
+   * @param middlewares
+   */
+  static head(path: string, handler: Handler, middlewares?: Middleware[] | Middleware): Route<HttpContext, Middleware, Handler>;
+  /**
+   * Define a group of routes with a common prefix and optional middlewares
+   *
+   * @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
+   * @param callback
+   */
+  static middleware(middlewares: Middleware[], callback: () => void): void;
+  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 Fastify application instance
+   *
+   * @param app  - The Fastify application instance
+   * @returns    The Fastify application instance with the applied routes
+   */
+  static apply(app: FastifyApp): FastifyApp;
+}
+//#endregion
+export { Router };

package/dist/fastify/router.mjs

@@ -0,0 +1,254 @@
+import { CoreRouter } from "../core/router.mjs";
+import { isFetchResponse, resolveResponseMeta, responseWasSent } from "../core/responses.mjs";
+
+//#region src/fastify/router.ts
+/**
+* @class clear-router Fastify Router
+* @description Laravel-style routing system for Fastify using shared clear-router core
+* @author 3m1n3nc3
+* @repository https://github.com/arkstack-tmp/clear-router
+*/
+var Router = class Router extends CoreRouter {
+	static routerStateNamespace = "clear-router:fastify";
+	static ensureRequestBodyAccessor(req) {
+		if (typeof req.getBody !== "function") req.getBody = () => req.body ?? {};
+	}
+	static async sendReturnValue(req, reply, value, method, path) {
+		if (responseWasSent(reply) || value === reply || responseWasSent(value)) return value;
+		const meta = resolveResponseMeta(value, {
+			headers: req.headers,
+			method,
+			path
+		});
+		if (!meta) return void 0;
+		reply.code(meta.status);
+		meta.headers?.forEach((headerValue, key) => {
+			reply.header(key, headerValue);
+		});
+		if (isFetchResponse(meta.body)) {
+			meta.body.headers.forEach((headerValue, key) => {
+				reply.header(key, headerValue);
+			});
+			reply.code(meta.body.status);
+			return reply.send(Buffer.from(await meta.body.arrayBuffer()));
+		}
+		if (meta.contentType) reply.type(meta.contentType);
+		if (meta.isEmpty) return reply.send();
+		return reply.send(meta.body);
+	}
+	/**
+	* Add a route to the router
+	* 
+	* @param methods       HTTP methods for the route
+	* @param path          Route path
+	* @param handler       Route handler function
+	* @param middlewares   Optional middlewares for the route
+	*/
+	static add(methods, path, handler, middlewares) {
+		return super.add(methods, path, handler, middlewares);
+	}
+	/**
+	* Define a resourceful API controller with standard CRUD routes
+	* 
+	* @param basePath     Base path for the resource
+	* @param controller   Controller class or instance
+	* @param options      Optional configuration for the resource
+	*/
+	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);
+	}
+	/**
+	* Define a HEAD route
+	* 
+	* @param path 
+	* @param handler 
+	* @param middlewares 
+	*/
+	static head(path, handler, middlewares) {
+		return super.head(path, handler, middlewares);
+	}
+	/**
+	* Define a group of routes with a common prefix and optional middlewares
+	* 
+	* @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 
+	* @param callback 
+	*/
+	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 Fastify application instance
+	* 
+	* @param app  - The Fastify application instance
+	* @returns    The Fastify application instance with the applied routes
+	*/
+	static apply(app) {
+		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) app.route({
+					method: method.toUpperCase(),
+					url: registrationPath,
+					preHandler: route.middlewares,
+					handler: async (req, reply) => {
+						Router.ensureRequestBodyAccessor(req);
+						const override = Router.resolveMethodOverride(req.method, req.headers, req.body);
+						if (method === "post" && override && override !== "post") return reply.code(404).send();
+						const ctx = {
+							req,
+							reply
+						};
+						const inst = instance ?? route;
+						Router.bindRequestToInstance(ctx, inst, route, {
+							body: ctx.req.getBody(),
+							query: ctx.req.query ?? {},
+							params: ctx.req.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(req, reply, outgoing, method, route.path);
+					}
+				});
+				if ([
+					"put",
+					"patch",
+					"delete"
+				].includes(method)) for (const registrationPath of route.registrationPaths) app.route({
+					method: "POST",
+					url: registrationPath,
+					preHandler: route.middlewares,
+					handler: async (req, reply) => {
+						Router.ensureRequestBodyAccessor(req);
+						if (Router.resolveMethodOverride(req.method, req.headers, req.body) !== method) return reply.code(404).send();
+						const ctx = {
+							req,
+							reply
+						};
+						const inst = instance ?? route;
+						Router.bindRequestToInstance(ctx, inst, route, {
+							body: ctx.req.getBody(),
+							query: ctx.req.query ?? {},
+							params: ctx.req.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(req, reply, outgoing, method, route.path);
+					}
+				});
+			}
+		}
+		return app;
+	}
+};
+
+//#endregion
+export { Router as default };