backend-error 0.0.5

package/README.md

@@ -0,0 +1,146 @@
+<center>
+
+# Backend-error
+
+Simple logging
+
+<img alt="GitHub package.json version (master)" src="https://img.shields.io/github/package-json/v/eriksturesson/backendError/master">
+<img alt="npm" src="https://img.shields.io/npm/dy/@eriksturesson/backend-error?label=npm%20downloads">
+
+</center>
+
+## Installation
+
+```bash
+npm install @eriksturesson/backend-error
+```
+
+## 🔥 Custom BackendError class
+
+Use `BackendError` class for standardized backend error handling:
+
+## Usage
+
+```ts
+import { BackendError } from "@eriksturesson/backend-error";
+
+throw BackendError.BadRequest("Missing required field");
+```
+
+Or construct it manually for full control:
+
+```ts
+const error = new BackendError({
+  message: "Something went terribly wrong",
+  severity: "critical",
+  showUser: true,
+  code: 500,
+  data: { context: "PaymentService", id: 12345 },
+});
+```
+
+Properties available:
+
+- `message`: The error message
+- `code`: HTTP status code
+- `isOperational`: Marks it as a handled error (vs. crash)
+- `showUser`: Whether frontend should show the message
+- `severity`: "info" | "warning" | "error" | "critical"
+- `data`: Additional metadata (optional and anything accepted)
+
+You can extend it for custom domains too.
+
+## 🧠 Example: With Express + showUser handling
+
+```ts
+import { BackendError } from "@eriksturesson/backend-error";
+
+app.get("/user/:id", async (req, res, next) => {
+  try {
+    const user = null;
+    if (!user) throw BackendError.NotFound("User not found");
+    res.json(user);
+  } catch (err) {
+    if (err instanceof BackendError && err.showUser) {
+      res.status(err.code ?? 400).json({ error: err.message });
+    } else {
+      res.status(500).json({ error: "Internal Server Error" });
+    }
+    next(err);
+  }
+});
+```
+
+## 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
+
+## 🧩 httpErrorFormatter(error) – Format backend errors for HTTP responses
+
+This helper takes an Error (or BackendError) and returns a plain object with:
+
+✅ status – an HTTP status code (number)
+
+✅ body – a JSON.stringify'd string representing the error (already parsed)
+
+It’s designed to be simple and universal – you can use it with any framework (Azure Functions, Express, etc).
+
+🔧 Example usage
+
+```ts
+import { BackendError, httpErrorFormatter } from "@eriksturesson/backend-error";
+
+try {
+  throw BackendError.Internal("Something went very wrong."); // 👈 your static factory pattern
+} catch (err) {
+  const { status, body } = await httpErrorFormatter(err);
+
+  return {
+    status,
+    headers: {
+      ...getCorsHeaders(request.headers.get("origin")), // Add CORS headers yourself
+    },
+    body,
+  };
+}
+```
+
+⚠️ Important
+This function does not include any HTTP headers – especially no CORS headers.
+Why? Because every environment has different CORS rules.
+
+If you're using Azure Functions, Express, or something else, you'll need to add CORS manually:
+
+## 🧩 Types
+
+```ts
+export type Severity = "info" | "warning" | "error" | "critical";
+```
+
+```ts
+export interface BackendErrorOptions {
+  message: string;
+  isOperational?: boolean;
+  showUser?: boolean;
+  severity?: Severity;
+  code?: number;
+  data?: any;
+}
+```
+
+---
+
+## 🌐 Repo
+
+[https://github.com/eriksturesson/backendError](https://github.com/eriksturesson/cloud-logger)
+
+---
+
+Created by [@eriksturesson](https://eriksturesson.se)

package/dist/core/BackendError.d.ts

@@ -0,0 +1,17 @@
+import { BackendErrorOptions, Severity } from "../interfaces/Types";
+export declare class BackendError extends Error {
+    isOperational: boolean;
+    showUser: boolean;
+    severity: Severity;
+    code?: number;
+    data?: any;
+    constructor(options: BackendErrorOptions);
+    static BadRequest(msg: string): BackendError;
+    static Unauthorized(msg: string): BackendError;
+    static Forbidden(msg: string): BackendError;
+    static NotFound(msg: string): BackendError;
+    static Conflict(msg: string): BackendError;
+    static UnprocessableEntity(msg: string): BackendError;
+    static Internal(msg: string): BackendError;
+    static ServiceUnavailable(msg: string): BackendError;
+}

package/dist/core/BackendError.js

@@ -0,0 +1,60 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackendError = void 0;
+var BackendError = /** @class */ (function (_super) {
+    __extends(BackendError, _super);
+    function BackendError(options) {
+        var _this = this;
+        var _a, _b, _c;
+        _this = _super.call(this, options.message) || this;
+        _this.name = "BackendError";
+        _this.isOperational = (_a = options.isOperational) !== null && _a !== void 0 ? _a : true;
+        _this.showUser = (_b = options.showUser) !== null && _b !== void 0 ? _b : true;
+        _this.severity = (_c = options.severity) !== null && _c !== void 0 ? _c : "error";
+        _this.code = options.code;
+        _this.data = options.data;
+        Object.setPrototypeOf(_this, BackendError.prototype);
+        return _this;
+    }
+    BackendError.BadRequest = function (msg) {
+        return new BackendError({ message: msg, code: 400, severity: "warning", showUser: true });
+    };
+    BackendError.Unauthorized = function (msg) {
+        return new BackendError({ message: msg, code: 401, severity: "warning", showUser: true });
+    };
+    BackendError.Forbidden = function (msg) {
+        return new BackendError({ message: msg, code: 403, severity: "warning", showUser: true });
+    };
+    BackendError.NotFound = function (msg) {
+        return new BackendError({ message: msg, code: 404, severity: "warning", showUser: true });
+    };
+    BackendError.Conflict = function (msg) {
+        return new BackendError({ message: msg, code: 409, severity: "warning", showUser: true });
+    };
+    BackendError.UnprocessableEntity = function (msg) {
+        return new BackendError({ message: msg, code: 422, severity: "warning", showUser: true });
+    };
+    BackendError.Internal = function (msg) {
+        return new BackendError({ message: msg, code: 500, severity: "critical", showUser: false });
+    };
+    BackendError.ServiceUnavailable = function (msg) {
+        return new BackendError({ message: msg, code: 503, severity: "critical", showUser: false });
+    };
+    return BackendError;
+}(Error));
+exports.BackendError = BackendError;

package/dist/core/httpErrorFormatter.d.ts

@@ -0,0 +1,6 @@
+export declare function httpErrorFormatter({ err }: {
+    err: unknown;
+}): Promise<{
+    status: number;
+    body: string;
+}>;

package/dist/core/httpErrorFormatter.js

@@ -0,0 +1,62 @@
+"use strict";
+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 httpErrorFormatter(_a) {
+    var err = _a.err;
+    return __awaiter(this, void 0, void 0, function () {
+        var parsedCode, status_1, message;
+        return __generator(this, function (_b) {
+            if (err instanceof BackendError_1.BackendError && err.showUser) {
+                parsedCode = Number(err.code);
+                status_1 = Number.isInteger(parsedCode) ? parsedCode : 400;
+                return [2 /*return*/, {
+                        status: status_1,
+                        body: JSON.stringify(err),
+                    }];
+            }
+            message = err instanceof Error ? err.message : typeof err === "string" ? err : "Internal Server Error";
+            return [2 /*return*/, {
+                    status: 500,
+                    body: JSON.stringify({ message: message }),
+                }];
+        });
+    });
+}
+exports.httpErrorFormatter = httpErrorFormatter;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { BackendError } from "./core/BackendError";
+export { httpErrorFormatter } from "./core/httpErrorFormatter";
+export type { BackendErrorOptions, Severity } from "./interfaces/Types";

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.httpErrorFormatter = exports.BackendError = void 0;
+var BackendError_1 = require("./core/BackendError");
+Object.defineProperty(exports, "BackendError", { enumerable: true, get: function () { return BackendError_1.BackendError; } });
+var httpErrorFormatter_1 = require("./core/httpErrorFormatter");
+Object.defineProperty(exports, "httpErrorFormatter", { enumerable: true, get: function () { return httpErrorFormatter_1.httpErrorFormatter; } });

package/dist/interfaces/Types.d.ts

@@ -0,0 +1,9 @@
+export type Severity = "info" | "warning" | "error" | "critical";
+export interface BackendErrorOptions {
+    message: string;
+    isOperational?: boolean;
+    showUser?: boolean;
+    severity?: Severity;
+    code?: number;
+    data?: any;
+}

package/dist/interfaces/Types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "backend-error",
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "maintainers": [
+    "Erik Sturesson"
+  ],
+  "author": {
+    "name": "Erik Sturesson",
+    "email": "hej@eriksturesson.se",
+    "url": "https://eriksturesson.se"
+  },
+  "version": "0.0.5",
+  "description": "Logger library supporting multiple cloud platforms with simple error handling.",
+  "keywords": [
+    "error",
+    "fail",
+    "drawing",
+    "drawings",
+    "summarized",
+    "help",
+    "fun"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eriksturesson/backendError"
+  },
+  "bugs": {
+    "email": "hej@eriksturesson.se",
+    "url": "https://github.com/eriksturesson/backendError/issues"
+  },
+  "engines": {
+    "npm": "^10.0.0",
+    "node": "^22.0.0"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "ts-node src/test/test.ts"
+  },
+  "dependencies": {
+    "dotenv": "^16.5.0",
+    "npm": "^11.4.1",
+    "typescript": "^4.7.4"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.27"
+  }
+}