@erangamadhushan/express-advanced-error-kit 1.4.0 → 1.5.0

package/README.md

@@ -3,30 +3,32 @@
 Advanced TypeScript-based error handling middleware for Express.js.
 
 ![npm version](https://img.shields.io/npm/v/@erangamadhushan/express-advanced-error-kit)
-![npm downloads](https://img.shields.io/npm/dm/@erangamadhusha/express-advanced-error-kit)
-
-![CI](https://github.com/Erangamadhushan/express-advanced-error-kit/actions/workflows/ci.yml/badge.svg)
+![npm downloads](https://img.shields.io/npm/dm/@erangamadhushan/express-advanced-error-kit)
 
+---
 
-## Features
+## ✨ Features
 
 - Async handler wrapper
-- Custom ApiError class
+- Custom `ApiError` class
 - Global error middleware
-- 404 not found middleware
-- Production-safe stack hiding
+- 404 Not Found middleware
+- Logger integration (Pino, Winston, custom)
+- MongoDB duplicate key smart parsing
+- Zod validation error formatting
+- Production-safe stack handling
 - ESM + CommonJS support
-- Full TypeScript definitions
+- Full TypeScript support
 
 ---
 
-## Installation
+## 📦 Installation
 
 ```bash
 npm install @erangamadhushan/express-advanced-error-kit
 ```
 
-## Usage
+# 🚀 Quick Start
 
 ```ts
 import express from "express";
@@ -34,46 +36,116 @@ import {
   asyncHandler,
   ApiError,
   notFoundMiddleware,
-  errorMiddleware
+  errorMiddleware,
 } from "@erangamadhushan/express-advanced-error-kit";
 
 const app = express();
+app.use(express.json());
 
 app.get(
   "/error",
   asyncHandler(async () => {
     throw new ApiError("Something went wrong", 400);
-  })
+  }),
 );
 
 app.use(notFoundMiddleware);
-app.use(errorMiddleware);
+app.use(errorMiddleware());
 
 app.listen(5000);
+```
+
+# 🧠 Smart MongoDB Error Handling
+
+## Duplicate key errors are automatically formatted:
+
+```ts
+// Mongo duplicate key error
+{
+  code: 11000,
+  keyValue: { email: "test@example.com" }
+}
+```
 
+Response:
+
+```json
+{
+  "success": false,
+  "message": "email already exists"
+}
+```
+
+# 🧾 Zod Validation Formatting
+
+If using Zod:
+
+```ts
+throw new ZodError([...]);
 ```
 
-# Features
+Response:
+
+```json
+{
+  "success": false,
+  "message": "email: Invalid email"
+}
+```
 
-## Logger Integration (Production-Ready)
+# 🪵 Logger Integration
 
-### Usage Example
+Use any logger:
 
 ```ts
 import pino from "pino";
+
 const logger = pino();
 
 app.use(
   errorMiddleware({
     logger: logger.error.bind(logger),
-    showStack: true
-  })
+    showStack: false,
+  }),
 );
 ```
 
-### Now it supports:
+# 📚 Middleware Order (Important)
+
+```js
+app.use(routes);
+........
+........
+app.use(notFoundMiddleware);
+app.use(errorMiddleware());
+```
+
+# 🧩 Creating Custom Errors
+
+```ts
+throw new ApiError(404, "User not found");
+```
+
+Also You can extend it:
+```ts
+class ValidationError extends ApiError {
+  constructor(message: string) {
+    super(400, message);
+  }
+}
+```
+
+# ⚙️ Configuration Options
+```ts
+errorMiddleware({
+  logger?: (error: any) => void;
+  showStack?: boolean;
+});
+```
+
+# 🛡 Production Behavior
+
+- Stack traces hidden automatically in production
+- Clean JSON response format
+- Centralized error control
 
-- console
-- winston
-- pino
-- custom logger

package/dist/index.cjs

@@ -86,8 +86,6 @@ var errorMiddleware = (options = {}) => (err, req, res, next) => {
     statusCode = zodError.statusCode;
     message = zodError.message;
   }
-  statusCode = mongoError instanceof ApiError ? mongoError.statusCode : zodError instanceof ApiError ? zodError.statusCode : 500;
-  message = mongoError instanceof ApiError ? mongoError.message : zodError instanceof ApiError ? zodError.message : "Internal Server Error";
   res.status(statusCode).json({
     success: false,
     statusCode,

package/dist/index.js

@@ -57,8 +57,6 @@ var errorMiddleware = (options = {}) => (err, req, res, next) => {
     statusCode = zodError.statusCode;
     message = zodError.message;
   }
-  statusCode = mongoError instanceof ApiError ? mongoError.statusCode : zodError instanceof ApiError ? zodError.statusCode : 500;
-  message = mongoError instanceof ApiError ? mongoError.message : zodError instanceof ApiError ? zodError.message : "Internal Server Error";
   res.status(statusCode).json({
     success: false,
     statusCode,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erangamadhushan/express-advanced-error-kit",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Advanced TypeScript error handling middleware for Express applications.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -51,6 +51,7 @@
     "zod": "^4.3.6"
   },
   "dependencies": {
+    "dotenv": "^17.3.1",
     "zod": "^4.3.6"
   }
 }