devdad-express-utils 1.0.0 → 1.1.0

package/README.md

@@ -5,11 +5,11 @@ A collection of reusable utilities for Express.js applications, including error
 ## Installation
 
 ```bash
-npm install express-utils
+npm install devdad-express-utils
 # or
-yarn add express-utils
+yarn add devdad-express-utils
 # or
-pnpm add express-utils
+pnpm add devdad-express-utils
 ```
 
 ## Usage
@@ -18,7 +18,7 @@ pnpm add express-utils
 
 ```typescript
 import express from "express";
-import { errorHandler, AppError } from "express-utils";
+import { errorHandler, AppError } from "devdad-express-utils";
 
 const app = express();
 
@@ -34,7 +34,7 @@ throw new AppError("Something went wrong", 400);
 ### Async Route Wrapping
 
 ```typescript
-import { catchAsync } from "express-utils";
+import { catchAsync } from "devdad-express-utils";
 
 const getUsers = catchAsync(async (req, res, next) => {
   const users = await User.find();
@@ -47,7 +47,7 @@ app.get("/users", getUsers);
 ### Custom Error Class
 
 ```typescript
-import { AppError } from "express-utils";
+import { AppError } from "devdad-express-utils";
 
 throw new AppError("Validation failed", 400, ["Email is required"]);
 ```
@@ -55,10 +55,10 @@ throw new AppError("Validation failed", 400, ["Email is required"]);
 #### JavaScript Usage
 
 ```javascript
-const { AppError, catchAsync, errorHandler } = require("express-utils");
+const { AppError, catchAsync, errorHandler } = require("devdad-express-utils");
 
 // Or with ES modules
-import { AppError, catchAsync, errorHandler } from "express-utils";
+import { AppError, catchAsync, errorHandler } from "devdad-express-utils";
 ```
 
 ## Error Handling Patterns
@@ -89,7 +89,7 @@ throw new AppError("Database connection failed", 500);
 
 ```javascript
 const express = require("express");
-const { AppError, catchAsync, errorHandler } = require("express-utils");
+const { AppError, catchAsync, errorHandler } = require("devdad-express-utils");
 
 const app = express();
 
@@ -110,10 +110,10 @@ app.use(errorHandler);
 #### JavaScript Usage
 
 ```javascript
-const { AppError, catchAsync, errorHandler } = require("express-utils");
+const { AppError, catchAsync, errorHandler } = require("devdad-express-utils");
 
 // Or with ES modules
-import { AppError, catchAsync, errorHandler } from "express-utils";
+import { AppError, catchAsync, errorHandler } from "devdad-express-utils";
 ```
 
 ## API

package/dist/AppError.d.ts

@@ -1,7 +1,17 @@
+/**
+ * Custom error class for application errors.
+ * Extends the built-in Error class with additional properties for status code, status, and operational flag.
+ */
 export declare class AppError extends Error {
     readonly statusCode: number;
     readonly status: "fail" | "error";
     readonly isOperational: true;
     readonly errors?: string[];
+    /**
+     * Creates an instance of AppError.
+     * @param {string} message - The error message.
+     * @param {number} statusCode - The HTTP status code.
+     * @param {string[]} [errors=[]] - Optional array of additional error messages.
+     */
     constructor(message: string, statusCode: number, errors?: string[]);
 }

package/dist/AppError.js

@@ -1,8 +1,18 @@
+/**
+ * Custom error class for application errors.
+ * Extends the built-in Error class with additional properties for status code, status, and operational flag.
+ */
 export class AppError extends Error {
     statusCode;
     status;
     isOperational;
     errors;
+    /**
+     * Creates an instance of AppError.
+     * @param {string} message - The error message.
+     * @param {number} statusCode - The HTTP status code.
+     * @param {string[]} [errors=[]] - Optional array of additional error messages.
+     */
     constructor(message, statusCode, errors = []) {
         super(message);
         this.statusCode = statusCode;

package/dist/catchAsync.d.ts

@@ -1,2 +1,7 @@
 import type { NextFunction, Request, Response } from "express";
+/**
+ * Higher-order function to catch asynchronous errors in Express route handlers.
+ * @param {(req: Request, res: Response, next: NextFunction) => Promise<any>} fn - The async route handler.
+ * @returns {(req: Request, res: Response, next: NextFunction) => void} - The wrapped handler that catches errors.
+ */
 export declare const catchAsync: (fn: (req: Request, res: Response, next: NextFunction) => Promise<any>) => (req: Request, res: Response, next: NextFunction) => void;

package/dist/catchAsync.js

@@ -1,4 +1,9 @@
 //#region Catch Async Handler
+/**
+ * Higher-order function to catch asynchronous errors in Express route handlers.
+ * @param {(req: Request, res: Response, next: NextFunction) => Promise<any>} fn - The async route handler.
+ * @returns {(req: Request, res: Response, next: NextFunction) => void} - The wrapped handler that catches errors.
+ */
 export const catchAsync = (fn) => (req, res, next) => {
     fn(req, res, next).catch(next);
 };

package/dist/errorHandler.d.ts

@@ -1,3 +1,10 @@
 import { Request, Response, NextFunction } from "express";
+/**
+ * Global error handler middleware for Express.
+ * @param {any} err - The error object.
+ * @param {Request} req - The Express request object.
+ * @param {Response} res - The Express response object.
+ * @param {NextFunction} next - The Express next function.
+ */
 declare const errorHandler: (err: any, req: Request, res: Response, next: NextFunction) => void;
 export { errorHandler };

package/dist/errorHandler.js

@@ -1,4 +1,9 @@
 import { AppError } from "./AppError.js";
+/**
+ * Sends detailed error information in development mode.
+ * @param {any} err - The error object.
+ * @param {Response} res - The Express response object.
+ */
 const sendErrorDev = (err, res) => {
     res.status(err.statusCode || 500).json({
         status: err.status || "error",
@@ -8,6 +13,11 @@ const sendErrorDev = (err, res) => {
         stack: err.stack,
     });
 };
+/**
+ * Sends error information in production mode.
+ * @param {AppError} err - The AppError instance.
+ * @param {Response} res - The Express response object.
+ */
 const sendErrorProd = (err, res) => {
     // Operational, trusted error → send to client
     if (err.isOperational) {
@@ -26,6 +36,13 @@ const sendErrorProd = (err, res) => {
         });
     }
 };
+/**
+ * Global error handler middleware for Express.
+ * @param {any} err - The error object.
+ * @param {Request} req - The Express request object.
+ * @param {Response} res - The Express response object.
+ * @param {NextFunction} next - The Express next function.
+ */
 const errorHandler = (err, req, res, next) => {
     err.statusCode = err.statusCode || 500;
     err.status = err.status || "error";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devdad-express-utils",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Reusable Express.js utilities for error handling, async wrapping, and more",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,7 +14,8 @@
     "express",
     "utilities",
     "error-handling",
-    "typescript"
+    "typescript",
+    "javascript"
   ],
   "author": "Oliver Metz",
   "license": "ISC",