fix: update createRouter config (#106)

Author: himself65

packages/better-call/src/router.test.ts

@@ -478,22 +478,26 @@ describe("error handling", () => {
 		);
 
 		let errorCaught = false;
+		let receivedRequest: Request | undefined;
 		const customResponse = new Response("Custom error response", {
 			status: 418,
 		});
 
 		const router = createRouter(
 			{ endpoint },
 			{
-				onError: (e) => {
+				onError: (error, request) => {
 					errorCaught = true;
+					receivedRequest = request;
 					return customResponse;
 				},
 			},
 		);
 
-		const response = await router.handler(new Request("http://localhost"));
+		const request = new Request("http://localhost");
+		const response = await router.handler(request);
 		expect(errorCaught).toBe(true);
+		expect(receivedRequest).toBe(request);
 		expect(response).toBe(customResponse);
 		expect(response.status).toBe(418);
 	});
@@ -517,7 +521,7 @@ describe("error handling", () => {
 		const router = createRouter(
 			{ endpoint },
 			{
-				onError: (e) => {
+				onError: (error, request) => {
 					errorCaught = true;
 					// Convert APIError to Response
 					return toResponse(apiError);
@@ -548,7 +552,7 @@ describe("error handling", () => {
 		const router = createRouter(
 			{ endpoint },
 			{
-				onError: (e) => {
+				onError: (error, request) => {
 					// Throw the error in the callback
 					throw newError;
 				},
@@ -930,6 +934,93 @@ describe("error handling", () => {
 	});
 });
 
+describe("onRequest and onResponse callbacks", () => {
+	it("should pass request to onRequest callback", async () => {
+		const endpoint = createEndpoint(
+			"/",
+			{
+				method: "GET",
+			},
+			async () => {
+				return "hello world";
+			},
+		);
+
+		let receivedRequest: Request | undefined;
+		const router = createRouter(
+			{ endpoint },
+			{
+				onRequest: (request) => {
+					receivedRequest = request;
+				},
+			},
+		);
+
+		const request = new Request("http://localhost");
+		await router.handler(request);
+		expect(receivedRequest).toBe(request);
+	});
+
+	it("should pass response and request to onResponse callback", async () => {
+		const endpoint = createEndpoint(
+			"/",
+			{
+				method: "GET",
+			},
+			async () => {
+				return "hello world";
+			},
+		);
+
+		let receivedResponse: Response | undefined;
+		let receivedRequest: Request | undefined;
+		const router = createRouter(
+			{ endpoint },
+			{
+				onResponse: (response, request) => {
+					receivedResponse = response;
+					receivedRequest = request;
+				},
+			},
+		);
+
+		const request = new Request("http://localhost");
+		await router.handler(request);
+		expect(receivedRequest).toBe(request);
+		expect(receivedResponse).toBeInstanceOf(Response);
+	});
+
+	it("should pass request to onError callback", async () => {
+		const endpoint = createEndpoint(
+			"/",
+			{
+				method: "GET",
+			},
+			async () => {
+				throw new Error("Test error");
+			},
+		);
+
+		let receivedError: unknown;
+		let receivedRequest: Request | undefined;
+		const router = createRouter(
+			{ endpoint },
+			{
+				onError: (error, request) => {
+					receivedError = error;
+					receivedRequest = request;
+				},
+			},
+		);
+
+		const request = new Request("http://localhost");
+		await router.handler(request);
+		expect(receivedRequest).toBe(request);
+		expect(receivedError).toBeInstanceOf(Error);
+		expect((receivedError as Error).message).toBe("Test error");
+	});
+});
+
 describe("base path", () => {
 	it("should work with base path", async () => {
 		const endpoint = createEndpoint(

packages/better-call/src/router.ts

@@ -12,7 +12,6 @@ import { getBody, isAPIError, isRequest } from "./utils";
 
 export interface RouterConfig {
 	throwError?: boolean;
-	onError?: (e: unknown) => void | Promise<void> | Response | Promise<Response>;
 	basePath?: string;
 	routerMiddleware?: Array<{
 		path: string;
@@ -27,11 +26,21 @@ export interface RouterConfig {
 	/**
 	 * A callback to run before any response
 	 */
-	onResponse?: (res: Response) => any | Promise<any>;
+	onResponse?: (response: Response, request: Request) => any | Promise<any>;
 	/**
 	 * A callback to run before any request
 	 */
-	onRequest?: (req: Request) => any | Promise<any>;
+	onRequest?: (request: Request) => any | Promise<any>;
+	/**
+	 * A callback to run when an error is thrown in the router or middleware.
+	 *
+	 * @param error - the error that was thrown in the router or middleware.
+	 * @returns a Response object that will be returned to the client.
+	 */
+	onError?: (
+		error: unknown,
+		request: Request,
+	) => void | Promise<void> | Response | Promise<Response>;
 	/**
 	 * List of allowed media types (MIME types) for the router
 	 *
@@ -250,7 +259,7 @@ export const createRouter = <
 		} catch (error) {
 			if (config?.onError) {
 				try {
-					const errorResponse = await config.onError(error);
+					const errorResponse = await config.onError(error, request);
 
 					if (errorResponse instanceof Response) {
 						return toResponse(errorResponse);
@@ -288,7 +297,7 @@ export const createRouter = <
 			}
 			const req = isRequest(onReq) ? onReq : request;
 			const res = await processRequest(req);
-			const onRes = await config?.onResponse?.(res);
+			const onRes = await config?.onResponse?.(res, req);
 			if (onRes instanceof Response) {
 				return onRes;
 			}