@tahminator/sapling 1.5.28-beta.260afa93 → 1.5.28-beta.599ffb98

package/dist/index.cjs

@@ -310,6 +310,34 @@ var Sapling = class Sapling {
 		app.use(Sapling.json());
 	}
 	/**
+	* Register a middleware that will handle {@link ResponseStatusError}.
+	*
+	* This middleware will chain to the next middleware if it does not catch {@link ResponseStatusError}.
+	* You may still define middleware to handle all other errors in a separate `app.use` call.
+	*
+	* @example
+	* ```ts
+	* import express from "express";
+	* import { Sapling } from "@tahminator/sapling";
+	*
+	* const app = express();
+	*
+	* Sapling.loadResponseStatusErrorMiddleware(app, (err, req, res, next) => {
+	*   // `err` is guaranteed to be of type ResponseStatusError
+	*   res.status(err.status).json({
+	*     success: false,
+	*     message: err.message,
+	*   });
+	* });
+	* ```
+	*/
+	static loadResponseStatusErrorMiddleware(app, fn) {
+		app.use(((err, req, res, next) => {
+			if (err instanceof ResponseStatusError) fn(err, req, res, next);
+			else next(err);
+		}));
+	}
+	/**
 	* Serialize a value into a JSON string.
 	*
 	* This function is used in {@link ResponseEntity} to serialize the `body`.
@@ -650,14 +678,6 @@ function Controller({ prefix = "", deps = [] } = {}) {
 		const usedRoutes = /* @__PURE__ */ new Set();
 		_InjectableDeps.set(targetClass, deps);
 		const controllerInstance = _resolve(targetClass);
-		if (routes.reduce((prev, r) => {
-			if (r.method !== "USE") return prev;
-			const fn = controllerInstance[r.fnName];
-			return typeof fn === "function" && fn.length >= 4 ? prev + 1 : prev;
-		}, 0) > 1) throw new Error(`Invalid @MiddlewareClass class "${targetClass.name}":
-Multiple 4-arg @Middleware() error handlers were found.
-Express will not enter routers in error mode, so an error-middleware class must expose exactly one error handler.
-Split these into separate @MiddlewareClass classes, or merge the logic into a single method.`);
 		for (const { method, path, fnName } of routes) {
 			const fn = controllerInstance[fnName];
 			if (typeof fn !== "function") continue;
@@ -666,26 +686,6 @@ Split these into separate @MiddlewareClass classes, or merge the logic into a si
 			if (method !== "USE" && usedRoutes.has(routeKey)) throw new Error(`Duplicate route [${method}] "${path instanceof RegExp ? path.source : fp}" detected in controller "${target.name}"`);
 			if (method !== "USE") usedRoutes.add(routeKey);
 			const methodName = methodResolve[method];
-			if (method === "USE" && fn.length >= 4) {
-				const middlewareFn = async (err, request, response, next) => {
-					try {
-						const result = fn.bind(controllerInstance)(err, request, response, next);
-						if (result instanceof ResponseEntity) {
-							response.contentType("application/json").status(result.getStatusCode()).set(result.getHeaders()).send(Sapling.serialize(result.getBody()));
-							return;
-						}
-						if (result instanceof RedirectView) {
-							response.redirect(result.getUrl());
-							return;
-						}
-					} catch (e) {
-						console.error(e);
-						next(e);
-					}
-				};
-				_ControllerRegistry.set(targetClass, middlewareFn);
-				return;
-			}
 			router[methodName](fp, async (request, response, next) => {
 				const schemas = _getRequestSchemas(target, fnName);
 				if (schemas) {
@@ -694,6 +694,7 @@ Split these into separate @MiddlewareClass classes, or merge the logic into a si
 					if (schemas.query) request.query = await _parseOrThrow(schemas.query, request.query, "reqquery");
 				}
 				const result = await fn.bind(controllerInstance)(request, response, next);
+				if (method === "USE") return;
 				if (result instanceof ResponseEntity) {
 					response.contentType("application/json").status(result.getStatusCode()).set(result.getHeaders()).send(Sapling.serialize(result.getBody()));
 					return;
@@ -702,7 +703,7 @@ Split these into separate @MiddlewareClass classes, or merge the logic into a si
 					response.redirect(result.getUrl());
 					return;
 				}
-				if (method !== "USE" && !response.writableEnded) response.status(404).send(Html404ErrorPage(`Cannot ${methodName.toUpperCase()} ${path instanceof RegExp ? path.source : fp}`));
+				if (!response.writableEnded) response.status(404).send(Html404ErrorPage(`Cannot ${methodName.toUpperCase()} ${path instanceof RegExp ? path.source : fp}`));
 			});
 		}
 		_ControllerRegistry.set(targetClass, router);

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import e, { ErrorRequestHandler, NextFunction, Request, Response, Router } from "express";
+import e, { NextFunction, Request, Response, Router } from "express";
 
 //#region src/html/404.d.ts
 /**
@@ -29,7 +29,7 @@ type HttpHeaders = Record<string, string>;
 type ExpressMiddlewareFn = ($1: Request, $2: Response, $3: NextFunction) => void;
 //#endregion
 //#region src/annotation/controller.d.ts
-declare const _ControllerRegistry: WeakMap<Function, Router | ErrorRequestHandler>;
+declare const _ControllerRegistry: WeakMap<Function, Router>;
 type ControllerProps = {
   /**
    * Optional URL prefix applied to all routes in the controller. Defaults to "".
@@ -416,7 +416,7 @@ declare class Sapling {
    * app.use(router);
    * ```
    */
-  static resolve<TClass>(this: void, clazz: Class<TClass>): Router | ErrorRequestHandler;
+  static resolve<TClass>(this: void, clazz: Class<TClass>): Router;
   /**
    * Register this function as a middleware in order to utilize Sapling's `deserialize` function.
    *
@@ -443,6 +443,29 @@ declare class Sapling {
    * ```
    */
   static registerApp(app: e.Express): void;
+  /**
+   * Register a middleware that will handle {@link ResponseStatusError}.
+   *
+   * This middleware will chain to the next middleware if it does not catch {@link ResponseStatusError}.
+   * You may still define middleware to handle all other errors in a separate `app.use` call.
+   *
+   * @example
+   * ```ts
+   * import express from "express";
+   * import { Sapling } from "@tahminator/sapling";
+   *
+   * const app = express();
+   *
+   * Sapling.loadResponseStatusErrorMiddleware(app, (err, req, res, next) => {
+   *   // `err` is guaranteed to be of type ResponseStatusError
+   *   res.status(err.status).json({
+   *     success: false,
+   *     message: err.message,
+   *   });
+   * });
+   * ```
+   */
+  static loadResponseStatusErrorMiddleware(this: void, app: e.Express, fn: (err: ResponseStatusError, request: e.Request, response: e.Response, next: e.NextFunction) => void): void;
   /**
    * Serialize a value into a JSON string.
    *

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import e, { ErrorRequestHandler, NextFunction, Request, Response, Router } from "express";
+import e, { NextFunction, Request, Response, Router } from "express";
 
 //#region src/html/404.d.ts
 /**
@@ -29,7 +29,7 @@ type HttpHeaders = Record<string, string>;
 type ExpressMiddlewareFn = ($1: Request, $2: Response, $3: NextFunction) => void;
 //#endregion
 //#region src/annotation/controller.d.ts
-declare const _ControllerRegistry: WeakMap<Function, Router | ErrorRequestHandler>;
+declare const _ControllerRegistry: WeakMap<Function, Router>;
 type ControllerProps = {
   /**
    * Optional URL prefix applied to all routes in the controller. Defaults to "".
@@ -416,7 +416,7 @@ declare class Sapling {
    * app.use(router);
    * ```
    */
-  static resolve<TClass>(this: void, clazz: Class<TClass>): Router | ErrorRequestHandler;
+  static resolve<TClass>(this: void, clazz: Class<TClass>): Router;
   /**
    * Register this function as a middleware in order to utilize Sapling's `deserialize` function.
    *
@@ -443,6 +443,29 @@ declare class Sapling {
    * ```
    */
   static registerApp(app: e.Express): void;
+  /**
+   * Register a middleware that will handle {@link ResponseStatusError}.
+   *
+   * This middleware will chain to the next middleware if it does not catch {@link ResponseStatusError}.
+   * You may still define middleware to handle all other errors in a separate `app.use` call.
+   *
+   * @example
+   * ```ts
+   * import express from "express";
+   * import { Sapling } from "@tahminator/sapling";
+   *
+   * const app = express();
+   *
+   * Sapling.loadResponseStatusErrorMiddleware(app, (err, req, res, next) => {
+   *   // `err` is guaranteed to be of type ResponseStatusError
+   *   res.status(err.status).json({
+   *     success: false,
+   *     message: err.message,
+   *   });
+   * });
+   * ```
+   */
+  static loadResponseStatusErrorMiddleware(this: void, app: e.Express, fn: (err: ResponseStatusError, request: e.Request, response: e.Response, next: e.NextFunction) => void): void;
   /**
    * Serialize a value into a JSON string.
    *

package/dist/index.mjs

@@ -286,6 +286,34 @@ var Sapling = class Sapling {
 		app.use(Sapling.json());
 	}
 	/**
+	* Register a middleware that will handle {@link ResponseStatusError}.
+	*
+	* This middleware will chain to the next middleware if it does not catch {@link ResponseStatusError}.
+	* You may still define middleware to handle all other errors in a separate `app.use` call.
+	*
+	* @example
+	* ```ts
+	* import express from "express";
+	* import { Sapling } from "@tahminator/sapling";
+	*
+	* const app = express();
+	*
+	* Sapling.loadResponseStatusErrorMiddleware(app, (err, req, res, next) => {
+	*   // `err` is guaranteed to be of type ResponseStatusError
+	*   res.status(err.status).json({
+	*     success: false,
+	*     message: err.message,
+	*   });
+	* });
+	* ```
+	*/
+	static loadResponseStatusErrorMiddleware(app, fn) {
+		app.use(((err, req, res, next) => {
+			if (err instanceof ResponseStatusError) fn(err, req, res, next);
+			else next(err);
+		}));
+	}
+	/**
 	* Serialize a value into a JSON string.
 	*
 	* This function is used in {@link ResponseEntity} to serialize the `body`.
@@ -626,14 +654,6 @@ function Controller({ prefix = "", deps = [] } = {}) {
 		const usedRoutes = /* @__PURE__ */ new Set();
 		_InjectableDeps.set(targetClass, deps);
 		const controllerInstance = _resolve(targetClass);
-		if (routes.reduce((prev, r) => {
-			if (r.method !== "USE") return prev;
-			const fn = controllerInstance[r.fnName];
-			return typeof fn === "function" && fn.length >= 4 ? prev + 1 : prev;
-		}, 0) > 1) throw new Error(`Invalid @MiddlewareClass class "${targetClass.name}":
-Multiple 4-arg @Middleware() error handlers were found.
-Express will not enter routers in error mode, so an error-middleware class must expose exactly one error handler.
-Split these into separate @MiddlewareClass classes, or merge the logic into a single method.`);
 		for (const { method, path, fnName } of routes) {
 			const fn = controllerInstance[fnName];
 			if (typeof fn !== "function") continue;
@@ -642,26 +662,6 @@ Split these into separate @MiddlewareClass classes, or merge the logic into a si
 			if (method !== "USE" && usedRoutes.has(routeKey)) throw new Error(`Duplicate route [${method}] "${path instanceof RegExp ? path.source : fp}" detected in controller "${target.name}"`);
 			if (method !== "USE") usedRoutes.add(routeKey);
 			const methodName = methodResolve[method];
-			if (method === "USE" && fn.length >= 4) {
-				const middlewareFn = async (err, request, response, next) => {
-					try {
-						const result = fn.bind(controllerInstance)(err, request, response, next);
-						if (result instanceof ResponseEntity) {
-							response.contentType("application/json").status(result.getStatusCode()).set(result.getHeaders()).send(Sapling.serialize(result.getBody()));
-							return;
-						}
-						if (result instanceof RedirectView) {
-							response.redirect(result.getUrl());
-							return;
-						}
-					} catch (e) {
-						console.error(e);
-						next(e);
-					}
-				};
-				_ControllerRegistry.set(targetClass, middlewareFn);
-				return;
-			}
 			router[methodName](fp, async (request, response, next) => {
 				const schemas = _getRequestSchemas(target, fnName);
 				if (schemas) {
@@ -670,6 +670,7 @@ Split these into separate @MiddlewareClass classes, or merge the logic into a si
 					if (schemas.query) request.query = await _parseOrThrow(schemas.query, request.query, "reqquery");
 				}
 				const result = await fn.bind(controllerInstance)(request, response, next);
+				if (method === "USE") return;
 				if (result instanceof ResponseEntity) {
 					response.contentType("application/json").status(result.getStatusCode()).set(result.getHeaders()).send(Sapling.serialize(result.getBody()));
 					return;
@@ -678,7 +679,7 @@ Split these into separate @MiddlewareClass classes, or merge the logic into a si
 					response.redirect(result.getUrl());
 					return;
 				}
-				if (method !== "USE" && !response.writableEnded) response.status(404).send(Html404ErrorPage(`Cannot ${methodName.toUpperCase()} ${path instanceof RegExp ? path.source : fp}`));
+				if (!response.writableEnded) response.status(404).send(Html404ErrorPage(`Cannot ${methodName.toUpperCase()} ${path instanceof RegExp ? path.source : fp}`));
 			});
 		}
 		_ControllerRegistry.set(targetClass, router);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tahminator/sapling",
-  "version": "1.5.28-beta.260afa93",
+  "version": "1.5.28-beta.599ffb98",
   "author": "Tahmid Ahmed",
   "description": "A library to help you write cleaner Express.js code",
   "repository": {