backend-error 1.0.4 → 1.1.1

package/README.md

@@ -1,33 +1,58 @@
-# Backend-error
+# backend-error
 
-BackendError is a lightweight utility for structured and user-aware error handling in Node.js backends. It helps distinguish operational errors from unexpected crashes, and supports standardized error responses across services.
+![npm](https://img.shields.io/npm/v/backend-error)
+![downloads](https://img.shields.io/npm/dm/backend-error)
+![license](https://img.shields.io/npm/l/backend-error)
 
-[![GitHub package.json version (master)](https://img.shields.io/github/package-json/v/eriksturesson/backendError/master)](https://github.com/eriksturesson/backendError)
-[![npm](https://img.shields.io/npm/dy/backend-error?label=npm%20downloads)](https://www.npmjs.com/package/backend-error)
+`backend-error` is a lightweight Node.js / TypeScript utility that formats all errors—custom or native—into standardized HTTP responses with correct status codes and user-friendly messages. The `httpErrorFormatter` ensures secure, consistent error output by controlling what is exposed to the frontend.
 
-## Installation
+---
+
+## 📦 Installation
 
 ```bash
 npm install backend-error
 ```
 
-## 🔥 Custom BackendError class
-
-Use `BackendError` class for standardized backend error handling:
+---
 
-## Usage
+## 🚀 Throw `BackendError`, catch with `httpErrorFormatter`
 
 ```ts
-import { BackendError } from "backend-error";
+import { BackendError, httpErrorFormatter } from "backend-error";
 
-throw BackendError.BadRequest("Missing required field");
+app.post("/signup", async (req, res) => {
+  try {
+    const auth = req.headers.authorization;
+    const { email, id } = req.body;
+    if (!auth) throw BackendError.Unauthorized("Missing auth token"); // 401, showUser:true
+    if (!email) throw BackendError.BadRequest("Email is required"); // 400, showUser:true
+    const user = await getUser(req.params.id);
+    if (!user) throw BackendError.NotFound("User not found"); // 404, showUser:true
+
+    // Normal logic...
+  } catch (err) {
+    const { status, body } = httpErrorFormatter(err); // Handles BackendError and native Error safely
+    res.status(status).json(body);
+  }
+});
 ```
 
-Or construct it manually for full control:
+✅ No manual showUser checks — handled automatically by the formatter  
+✅ Returns generic 500 for critical or unknown errors (or if `showUser` is false)  
+✅ Formatter supports both BackendError instances and native Error objects
+
+> The httpErrorFormatter inspects any error, formats it consistently, and decides what message is safe to show to users.
+
+---
+
+## ✨ Custom BackendError creation
+
+If you prefer, create your own error with full control including custom metadata:
 
 ```ts
 const error = new BackendError({
-  message: "Something went terribly wrong",
+  message: "Something went wrong",
   severity: "critical",
   showUser: true,
   code: 500,
@@ -35,35 +60,37 @@ const error = new BackendError({
 });
 ```
 
-Properties available:
+### Selected BackendError options
 
-- `message`: The error message
+- `message`: Error message
 - `code`: HTTP status code
-- `isOperational`: Marks it as a handled error (vs. crash)
-- `showUser`: Whether frontend should show the message
+- `showUser`: Whether to expose the message to frontend clients
 - `severity`: "info" | "warning" | "error" | "critical"
-- `data`: Additional metadata (optional and anything accepted)
+- `data`: Optional metadata
 
-## 🧠 Example where you also import `httpErrorFormatter`:
+---
+
+## ⚙️ Static error helpers
 
 ```ts
-import { BackendError, httpErrorFormatter } from "backend-error";
-try {
-  const user = null;
-  if (!user) throw BackendError.NotFound("User not found");
-  res.json(user);
-} catch (err) {
-  const { status, body, message, showUser } = await httpErrorFormatter(err);
-  res.status(status).json(body);
-}
+BackendError.BadRequest("..."); // 400, showUser: true
+BackendError.Unauthorized("..."); // 401, showUser: true
+BackendError.Forbidden("..."); // 403, showUser: true
+BackendError.NotFound("..."); // 404, showUser: true
+BackendError.Conflict("..."); // 409, showUser: true
+BackendError.UnprocessableEntity("..."); // 422, showUser: true
+BackendError.Internal("..."); // 500, showUser: false
+BackendError.ServiceUnavailable("..."); // 503, showUser: false
 ```
 
-## 🧠 Example of manual showUser handling (done automatically in httpErrorFormatter above)
+---
+
+## 🧠 Manual error handling (if not using `httpErrorFormatter`)
 
 ```ts
 import { BackendError } from "backend-error";
 
-app.get("/user/:id", async (req, res, next) => {
+app.get("/user/:id", async (req, res) => {
   try {
     const user = null;
     if (!user) throw BackendError.NotFound("User not found");
@@ -78,24 +105,13 @@ app.get("/user/:id", async (req, res, next) => {
 });
 ```
 
-## Available static error constructors
-
-- `BackendError.BadRequest(message: string)` // 400, showUser: true
-- `BackendError.Unauthorized(message: string)` // 401, showUser: true
-- `BackendError.Forbidden(message: string)` // 403, showUser: true
-- `BackendError.NotFound(message: string)` // 404, showUser: true
-- `BackendError.Conflict(message: string)` // 409, showUser: true
-- `BackendError.UnprocessableEntity(message: string)`// 422, showUser: true
-- `BackendError.Internal(message: string)` // 500, showUser: false
-- `BackendError.ServiceUnavailable(message: string)` // 503, showUser: false
+---
 
 ## 🧩 Types
 
 ```ts
 export type Severity = "info" | "warning" | "error" | "critical";
-```
 
-```ts
 export interface BackendErrorOptions {
   message: string;
   isOperational?: boolean;
@@ -106,14 +122,38 @@ export interface BackendErrorOptions {
 }
 ```
 
-> 💬 Tip: This package doesn't handle headers or CORS. If you're building an API for browsers, remember to configure CORS separately.
-
 ---
 
-## 🌐 Repo
+## 🎨 Works well with [error-drawings](https://www.npmjs.com/package/error-drawings)
 
-[https://github.com/eriksturesson/backendError](https://github.com/eriksturesson/backendError)
+![GitHub package.json version (master)](https://img.shields.io/github/package-json/v/eriksturesson/errorDrawings/master)
+![npm downloads](https://img.shields.io/npm/dy/error-drawings?label=npm%20downloads)
+
+```bash
+npm install error-drawings
+```
+
+Use for dev-friendly terminal logs — with a bit of dramatic flair for critical errors:
+
+```ts
+import { BackendError, httpErrorFormatter } from "backend-error";
+import drawLog from "error-drawings";
+
+try {
+  throw BackendError.Forbidden("No access to resource");
+} catch (err) {
+  const isCritical = !(err instanceof BackendError && err.isOperational) || err.code >= 500;
+  if (isCritical) drawLog(err); // Dramatic terminal art for critical errors!
+
+  const { status, body } = httpErrorFormatter(err);
+  res.status(status).json(body);
+}
+```
 
 ---
 
+## 🌐 Repo
+
+[GitHub](https://github.com/eriksturesson/backendError)
+
 Created by [@eriksturesson](https://eriksturesson.se)

package/dist/core/httpErrorFormatter.d.ts

@@ -1,8 +1,6 @@
-export declare function httpErrorFormatter({ err, }: {
-    err: unknown;
-}): Promise<{
+export declare function httpErrorFormatter(err: unknown): {
     status: number;
     body: Record<string, any>;
     showUser: boolean;
     message: string;
-}>;
+};

package/dist/core/httpErrorFormatter.js

@@ -10,81 +10,43 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.httpErrorFormatter = void 0;
 var BackendError_1 = require("./BackendError");
 function isValidStatusCode(code) {
     return typeof code === "number" && Number.isInteger(code) && code >= 100 && code <= 599;
 }
-function httpErrorFormatter(_a) {
-    var err = _a.err;
-    return __awaiter(this, void 0, void 0, function () {
-        var status_1, showUser_1, message_1, body_1, status, message, showUser, maybeStatus, body;
-        return __generator(this, function (_b) {
-            // Handle your custom BackendError type
-            if (err instanceof BackendError_1.BackendError) {
-                status_1 = isValidStatusCode(err.code) ? err.code : 400;
-                showUser_1 = typeof err.showUser === "boolean" ? err.showUser : status_1 < 500;
-                message_1 = err.message || "Error";
-                body_1 = showUser_1
-                    ? __assign(__assign({ message: message_1 }, (err.data !== undefined && { data: err.data })), { code: status_1, severity: err.severity }) : { message: "Internal Server Error" };
-                return [2 /*return*/, { status: status_1, body: body_1, showUser: showUser_1, message: message_1 }];
-            }
-            status = 500;
-            message = "Internal Server Error";
-            showUser = false;
-            if (err instanceof Error) {
-                message = err.message;
-                maybeStatus = err.status || err.code;
-                if (isValidStatusCode(maybeStatus)) {
-                    status = maybeStatus;
-                    showUser = status < 500; // show message for 4xx errors by default
-                }
-            }
-            else if (typeof err === "string") {
-                message = err;
-                status = 400;
-                showUser = true;
-            }
-            body = showUser ? { message: message } : { message: "Internal Server Error" };
-            return [2 /*return*/, { status: status, body: body, showUser: showUser, message: message }];
-        });
-    });
+function httpErrorFormatter(err) {
+    // Handle your custom BackendError type
+    if (err instanceof BackendError_1.BackendError) {
+        var status_1 = isValidStatusCode(err.code) ? err.code : 400;
+        // If developer explicitly set showUser, trust that; otherwise default: true for 4xx, false for 5xx
+        var showUser_1 = typeof err.showUser === "boolean" ? err.showUser : status_1 < 500;
+        var message_1 = err.message || "Error";
+        // If showUser is true, return detailed info including data, code, severity; else generic message
+        var body_1 = showUser_1
+            ? __assign(__assign({ message: message_1 }, (err.data !== undefined && { data: err.data })), { code: status_1, severity: err.severity }) : { message: "Internal Server Error" };
+        return { status: status_1, body: body_1, showUser: showUser_1, message: message_1 };
+    }
+    // Handle generic Error or string or unknown
+    var status = 500;
+    var message = "Internal Server Error";
+    var showUser = false;
+    if (err instanceof Error) {
+        message = err.message;
+        // Try to extract HTTP status code from common fields 'status' or 'code'
+        var maybeStatus = err.status || err.code;
+        if (isValidStatusCode(maybeStatus)) {
+            status = maybeStatus;
+            showUser = status < 500; // show message for 4xx errors by default
+        }
+    }
+    else if (typeof err === "string") {
+        message = err;
+        status = 400;
+        showUser = true;
+    }
+    var body = showUser ? { message: message } : { message: "Internal Server Error" };
+    return { status: status, body: body, showUser: showUser, message: message };
 }
 exports.httpErrorFormatter = httpErrorFormatter;

package/package.json

@@ -1,6 +1,21 @@
 {
+  "version": "1.1.1",
   "name": "backend-error",
   "license": "MIT",
+  "keywords": [
+    "error",
+    "error-handler",
+    "http-errors",
+    "express",
+    "firebase-functions",
+    "nodejs",
+    "api",
+    "backend",
+    "error-handling",
+    "http-status",
+    "custom-error",
+    "structured-error"
+  ],
   "maintainers": [
     "Erik Sturesson"
   ],
@@ -9,17 +24,7 @@
     "email": "hej@eriksturesson.se",
     "url": "https://eriksturesson.se"
   },
-  "version": "1.0.4",
   "description": "Simple Error handling library.",
-  "keywords": [
-    "error",
-    "fail",
-    "drawing",
-    "drawings",
-    "summarized",
-    "help",
-    "fun"
-  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/eriksturesson/backendError"