devdad-express-utils 1.2.0 → 1.4.0

package/README.md

@@ -1,6 +1,6 @@
 # Express Utils
 
-A collection of reusable utilities for Express.js applications, including error handling, async route wrapping, custom error classes, and MongoDB connection management.
+A collection of reusable utilities for Express.js applications, including error handling, async route wrapping, custom error classes, MongoDB connection management, and Winston-based logging.
 
 ## Installation
 
@@ -98,6 +98,33 @@ const status = getDBStatus();
 console.log(status); // { isConnected: true, readyState: 1, host: '...', name: '...' }
 ```
 
+### Logging
+
+Winston-based logger with configurable service name and environment-aware transports.
+
+```typescript
+import { logger } from "devdad-express-utils";
+
+// Log messages at different levels
+logger.info("User logged in", { userId: 123 });
+logger.error("Database connection failed", { error: err.message });
+logger.debug("Processing request", { requestId: "abc-123" });
+```
+
+#### Configuration
+
+- **Service Name**: Set `SERVICE_NAME` environment variable to customize the service name in logs (defaults to "express-utils")
+- **Log Level**: "debug" in development, "info" in production
+- **Transports**:
+  - **Development**: Console (colored) + error.log + combined.log files
+  - **Production**: Console only (suitable for platforms like Railway)
+
+#### Log Files
+
+In development, logs are written to:
+- `error.log`: Error level and above
+- `combined.log`: All log levels
+
 ## Error Handling Patterns
 
 ### Using AppError
@@ -221,6 +248,14 @@ Gets the current MongoDB connection status.
 getDBStatus() => { isConnected: boolean; readyState: number; host: string; name: string; }
 ```
 
+### logger
+
+Winston logger instance with JSON formatting, timestamps, and error stack traces.
+
+```typescript
+logger: winston.Logger
+```
+
 ## Development
 
 ```bash

package/dist/errorHandler.js

@@ -1,4 +1,5 @@
 import { AppError } from "./AppError.js";
+import { logger } from "./logger.js";
 /**
  * Sends detailed error information in development mode.
  * @param {any} err - The error object.
@@ -29,7 +30,7 @@ const sendErrorProd = (err, res) => {
     }
     else {
         // Unknown error → hide details
-        console.error("ERROR", err);
+        logger.error("Unknown error occurred", err);
         res.status(500).json({
             status: "error",
             message: "Something went wrong!",
@@ -47,7 +48,7 @@ const errorHandler = (err, req, res, next) => {
     err.statusCode = err.statusCode || 500;
     err.status = err.status || "error";
     // Add this for Extra In-Depth Error Logging
-    console.error("Error details:", {
+    logger.error("Error details", {
         message: err.message,
         statusCode: err.statusCode,
         errors: err.errors,

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { AppError } from "./AppError.js";
 export { catchAsync } from "./catchAsync.js";
 export { errorHandler } from "./errorHandler.js";
+export { logger } from "./logger.js";
 export { sendSuccess, sendError } from "./responseFormatter.js";
-export { requireAuth } from "./authWrapper.js";
-export { default as connectDB, getDBStatus, DatabaseConnection } from "./DatabaseConnection.js";
+export { default as connectDB, getDBStatus, DatabaseConnection, } from "./DatabaseConnection.js";

package/dist/index.js

@@ -1,6 +1,6 @@
 export { AppError } from "./AppError.js";
 export { catchAsync } from "./catchAsync.js";
 export { errorHandler } from "./errorHandler.js";
+export { logger } from "./logger.js";
 export { sendSuccess, sendError } from "./responseFormatter.js";
-export { requireAuth } from "./authWrapper.js";
-export { default as connectDB, getDBStatus, DatabaseConnection } from "./DatabaseConnection.js";
+export { default as connectDB, getDBStatus, DatabaseConnection, } from "./DatabaseConnection.js";

package/dist/logger.d.ts

@@ -0,0 +1,2 @@
+import winston from "winston";
+export declare const logger: winston.Logger;

package/dist/logger.js

@@ -0,0 +1,15 @@
+import winston from "winston";
+export const logger = winston.createLogger({
+    level: process.env.NODE_ENV === "production" ? "info" : "debug",
+    format: winston.format.combine(winston.format.timestamp(), winston.format.errors({ stack: true }), winston.format.splat(), winston.format.json()),
+    defaultMeta: { service: process.env.SERVICE_NAME || "express-utils" },
+    transports: [
+        new winston.transports.Console({
+            format: winston.format.combine(winston.format.colorize(), winston.format.simple()),
+        }),
+        ...(process.env.NODE_ENV !== "production" ? [
+            new winston.transports.File({ filename: "error.log", level: "error" }),
+            new winston.transports.File({ filename: "combined.log" }),
+        ] : []),
+    ],
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devdad-express-utils",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "Reusable Express.js utilities for error handling, async wrapping, and more",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,7 +29,8 @@
     "@types/mongoose": "^5.11.96",
     "express": "^5.1.0",
     "jsonwebtoken": "^9.0.2",
-    "mongoose": "^9.0.0"
+    "mongoose": "^9.0.0",
+    "winston": "^3.17.0"
   },
   "devDependencies": {
     "@types/express": "^5.0.5",