@tahminator/sapling 1.0.4 → 1.1.1

package/dist/src/annotation/index.d.ts

@@ -1,4 +1,3 @@
 export * from "./controller";
 export * from "./injectable";
 export * from "./route";
-export * from "../helper/sapling";

package/dist/src/annotation/index.js

@@ -1,4 +1,3 @@
 export * from "./controller";
 export * from "./injectable";
 export * from "./route";
-export * from "../helper/sapling";

package/dist/src/helper/error.d.ts

@@ -0,0 +1,10 @@
+import { HttpStatus } from "../enum";
+/**
+ * Ensure that you define a middleware that can handle this error.
+ *
+ * @see {@link Sapling.loadResponseStatusErrorMiddleware}
+ */
+export declare class ResponseStatusError extends Error {
+    readonly status: HttpStatus;
+    constructor(status: HttpStatus, message?: string);
+}

package/dist/src/helper/error.js

@@ -0,0 +1,17 @@
+import { HttpStatus } from "../enum";
+/**
+ * Ensure that you define a middleware that can handle this error.
+ *
+ * @see {@link Sapling.loadResponseStatusErrorMiddleware}
+ */
+export class ResponseStatusError extends Error {
+    constructor(status, message) {
+        super(message !== null && message !== void 0 ? message : "Something went wrong.");
+        this.status = status;
+        Object.setPrototypeOf(this, new.target.prototype);
+        this.name = `HttpError(${HttpStatus[status]})`;
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, ResponseStatusError);
+        }
+    }
+}

package/dist/src/helper/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./redirect";
 export * from "./response";
+export * from "./error";
+export * from "./sapling";

package/dist/src/helper/index.js

@@ -1,2 +1,4 @@
 export * from "./redirect";
 export * from "./response";
+export * from "./error";
+export * from "./sapling";

package/dist/src/helper/sapling.d.ts

@@ -1,5 +1,6 @@
 import e, { Router } from "express";
 import { Class, ExpressMiddlewareFn } from "../types";
+import { ResponseStatusError } from "./error";
 /**
  * Collection of utility functions which are essential for Sapling to function.
  */
@@ -45,6 +46,29 @@ export 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(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/src/helper/sapling.js

@@ -1,5 +1,6 @@
 import e from "express";
 import { _ControllerRegistry } from "../annotation/controller";
+import { ResponseStatusError } from "./error";
 let settings = {
     serialize: JSON.stringify,
     deserialize: JSON.parse,
@@ -81,6 +82,38 @@ export class Sapling {
         app.use(e.text({ type: "application/json" }));
         app.use(this.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.
      *

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@tahminator/sapling",
-  "version": "1.0.4",
+  "version": "1.1.1",
   "description": "A library to help you write cleaner Express.js code",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc"
+    "build": "rm -rf dist && tsc"
   },
   "keywords": [],
   "author": "",