devdad-express-utils 1.6.0 → 1.7.1

package/README.md

@@ -54,29 +54,71 @@ throw new AppError("Validation failed", 400, ["Email is required"]);
 
 ### Response Formatting
 
-Standardize API responses with consistent JSON structure.
+Standardize API responses with consistent JSON structure and intelligent auto-sending.
 
 ```typescript
-import { sendSuccess, sendError, sendPaginated } from "devdad-express-utils";
+import { sendSuccess, sendError, send } from "devdad-express-utils";
 
-// Success response
+// Basic success response (auto-sends - no send() needed)
 sendSuccess(res, { id: 1, name: "John" }, "User fetched", 200);
 
-// Chain additional response methods
-sendSuccess(res, { id: 1, name: "John" })
+// Chain native Express methods (use send() when done chaining)
+sendSuccess(res, { id: 1, name: "John" }, "User fetched", 200)
   .cookie("session", "abc123")
   .setHeader("X-Custom", "value");
+send(res); // Send when ready
 
-// Error response
+// Error response (sends immediately)
 sendError(res, "User not found", 404);
 ```
 
+#### Response Format
+
+All responses include a `success` field by default:
+
+**Success Response:**
+
+```json
+{
+  "status": "success",
+  "success": true,
+  "message": "User fetched",
+  "data": { "id": 1, "name": "John" }
+}
+```
+
+**Error Response:**
+
+```json
+{
+  "status": "error",
+  "success": false,
+  "message": "User not found"
+}
+```
+
+#### Method Chaining
+
+`sendSuccess` returns the Express response object for native chaining:
+
+```typescript
+sendSuccess(res, { token: "abc123" }, "Login successful", 200)
+  .cookie("authToken", "abc123", { httpOnly: true })
+  .header("X-Rate-Limit-Remaining", "99")
+  .status(201); // Can even override status
+send(res); // Send the prepared response
+```
+
 ### Database Connection
 
 MongoDB connection utility with automatic reconnection, exponential backoff, and configurable retry logic.
 
 ```typescript
-import { connectDB, getDBStatus, resetDBConnection } from "devdad-express-utils";
+import {
+  connectDB,
+  getDBStatus,
+  resetDBConnection,
+} from "devdad-express-utils";
 
 // Connect to MongoDB (ensure MONGO_URI is set in environment)
 await connectDB();
@@ -215,20 +257,50 @@ errorHandler(err: any, req: Request, res: Response, next: NextFunction) => void
 
 ### sendSuccess
 
-Sends a standardized success response. Returns the Response object for method chaining.
+Prepares a standardized success response and returns response object for chaining.
 
 ```typescript
 sendSuccess(res: Response, data: any, message?: string, statusCode?: number) => Response
 ```
 
+**Features:**
+- Includes `success: true` field by default
+- **Auto-sends** when no chaining detected (no `send()` needed)
+- Returns Express response object for native method chaining
+- Use `send()` when chaining methods (explicit control)
+- No magic - intelligent and predictable
+
 ### sendError
 
-Sends a standardized error response.
+Sends a standardized error response immediately.
 
 ```typescript
 sendError(res: Response, message: string, statusCode?: number, data?: any) => void
 ```
 
+**Features:**
+- Includes `success: false` field by default
+- Sends response immediately (no chaining needed for errors)
+- Supports optional error data
+
+### send
+
+Sends the prepared success response from `sendSuccess`. Only needed when chaining methods.
+
+```typescript
+send(res: Response) => void
+```
+
+**Features:**
+- Sends the response prepared by `sendSuccess`
+- **Only needed when chaining** (.cookie(), .header(), etc.)
+- Basic usage: sendSuccess() auto-sends, no send() needed
+- Explicit control over when response is sent
+
+**When to Use:**
+- ❌ Basic: `sendSuccess(res, data)` → NO send() needed
+- ✅ Chaining: `sendSuccess(res, data).cookie(...)` → send() needed
+
 ### connectDB
 
 Connects to MongoDB with retry logic and automatic reconnection.

package/dist/index.d.ts

@@ -2,5 +2,5 @@ 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 { sendSuccess, sendError, send } from "./responseFormatter.js";
 export { default as connectDB, getDBStatus, DatabaseConnection, } from "./DatabaseConnection.js";

package/dist/index.js

@@ -2,5 +2,5 @@ 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 { sendSuccess, sendError, send } from "./responseFormatter.js";
 export { default as connectDB, getDBStatus, DatabaseConnection, } from "./DatabaseConnection.js";

package/dist/responseFormatter.d.ts

@@ -1,18 +1,76 @@
 import { Response } from "express";
 /**
- * Sends a success response.
+ * Sends a success response with intelligent auto-sending behavior.
+ *
+ * Features:
+ * - Includes success: true field by default
+ * - **Auto-sends** when no chaining detected (no send() needed)
+ * - Returns Express response object for native method chaining
+ * - Use send() only when chaining methods (.cookie(), .header(), etc.)
+ * - Clean and predictable approach
+ *
  * @param {Response} res - Express response object.
  * @param {any} data - Response data.
  * @param {string} [message='Success'] - Response message.
  * @param {number} [statusCode=200] - HTTP status code.
  * @returns {Response} The Express response object for chaining.
+ *
+ * @example
+ * // Basic usage (auto-sends - no send() needed)
+ * sendSuccess(res, { userId: 123 }, "Login successful");
+ *
+ * @example
+ * // Chain methods and send manually
+ * sendSuccess(res, { userId: 123 }, "Login successful", 200)
+ *   .cookie("authToken", "xyz789", { httpOnly: true })
+ *   .header("X-Custom", "value");
+ * send(res); // Send prepared response
+ *
+ * @example
+ * // Your exact use case
+ * sendSuccess(res, { accesstoken, refreshToken, user }, "Login Successful", 200)
+ *   .cookie("accessToken", accesstoken, HTTP_OPTIONS)
+ *   .cookie("refreshToken", refreshToken, HTTP_OPTIONS);
+ * send(res); // Send when ready
  */
 export declare const sendSuccess: (res: Response, data: any, message?: string, statusCode?: number) => Response;
 /**
- * Sends an error response.
+ * Sends the prepared success response.
+ * Use this only when chaining methods (.cookie(), .header(), etc.).
+ * For basic usage, sendSuccess() auto-sends and you don't need this.
+ *
+ * @param {Response} res - Express response object.
+ * @returns {void}
+ *
+ * @example
+ * // Only needed when chaining methods
+ * sendSuccess(res, data, "Success", 200)
+ *   .cookie("session", "abc123")
+ *   .header("X-Custom", "value");
+ * send(res); // Send when ready
+ */
+export declare const send: (res: Response) => void;
+/**
+ * Sends an error response immediately.
+ *
+ * Features:
+ * - Includes success: false field by default
+ * - Sends response immediately (no chaining needed)
+ * - Supports optional error data
+ *
  * @param {Response} res - Express response object.
  * @param {string} message - Error message.
  * @param {number} [statusCode=400] - HTTP status code.
  * @param {any} [data] - Additional error data.
+ *
+ * @example
+ * // Basic error
+ * sendError(res, "User not found", 404);
+ *
+ * @example
+ * // Error with additional data
+ * sendError(res, "Validation failed", 400, {
+ *   errors: ["Email is required", "Password too short"]
+ * });
  */
 export declare const sendError: (res: Response, message: string, statusCode?: number, data?: any) => void;

package/dist/responseFormatter.js

@@ -1,29 +1,101 @@
 /**
- * Sends a success response.
+ * Sends a success response with intelligent auto-sending behavior.
+ *
+ * Features:
+ * - Includes success: true field by default
+ * - **Auto-sends** when no chaining detected (no send() needed)
+ * - Returns Express response object for native method chaining
+ * - Use send() only when chaining methods (.cookie(), .header(), etc.)
+ * - Clean and predictable approach
+ *
  * @param {Response} res - Express response object.
  * @param {any} data - Response data.
  * @param {string} [message='Success'] - Response message.
  * @param {number} [statusCode=200] - HTTP status code.
  * @returns {Response} The Express response object for chaining.
+ *
+ * @example
+ * // Basic usage (auto-sends - no send() needed)
+ * sendSuccess(res, { userId: 123 }, "Login successful");
+ *
+ * @example
+ * // Chain methods and send manually
+ * sendSuccess(res, { userId: 123 }, "Login successful", 200)
+ *   .cookie("authToken", "xyz789", { httpOnly: true })
+ *   .header("X-Custom", "value");
+ * send(res); // Send prepared response
+ *
+ * @example
+ * // Your exact use case
+ * sendSuccess(res, { accesstoken, refreshToken, user }, "Login Successful", 200)
+ *   .cookie("accessToken", accesstoken, HTTP_OPTIONS)
+ *   .cookie("refreshToken", refreshToken, HTTP_OPTIONS);
+ * send(res); // Send when ready
  */
 export const sendSuccess = (res, data, message = "Success", statusCode = 200) => {
     const response = {
         status: "success",
+        success: true,
         message,
         data,
     };
-    return res.status(statusCode).json(response);
+    // Set status and store response for later sending
+    res.status(statusCode);
+    res._responseData = response;
+    // Auto-send unless chaining is detected (using setImmediate to check)
+    setImmediate(() => {
+        if (!res._responseSent && res._responseData) {
+            res._responseSent = true;
+            res.json(res._responseData);
+        }
+    });
+    return res;
 };
 /**
- * Sends an error response.
+ * Sends the prepared success response.
+ * Use this only when chaining methods (.cookie(), .header(), etc.).
+ * For basic usage, sendSuccess() auto-sends and you don't need this.
+ *
+ * @param {Response} res - Express response object.
+ * @returns {void}
+ *
+ * @example
+ * // Only needed when chaining methods
+ * sendSuccess(res, data, "Success", 200)
+ *   .cookie("session", "abc123")
+ *   .header("X-Custom", "value");
+ * send(res); // Send when ready
+ */
+export const send = (res) => {
+    res.json(res._responseData);
+};
+/**
+ * Sends an error response immediately.
+ *
+ * Features:
+ * - Includes success: false field by default
+ * - Sends response immediately (no chaining needed)
+ * - Supports optional error data
+ *
  * @param {Response} res - Express response object.
  * @param {string} message - Error message.
  * @param {number} [statusCode=400] - HTTP status code.
  * @param {any} [data] - Additional error data.
+ *
+ * @example
+ * // Basic error
+ * sendError(res, "User not found", 404);
+ *
+ * @example
+ * // Error with additional data
+ * sendError(res, "Validation failed", 400, {
+ *   errors: ["Email is required", "Password too short"]
+ * });
  */
 export const sendError = (res, message, statusCode = 400, data) => {
     const response = {
         status: "error",
+        success: false,
         message,
         ...(data && { data }),
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devdad-express-utils",
-  "version": "1.6.0",
+  "version": "1.7.1",
   "description": "Reusable Express.js utilities for error handling, async wrapping, and more",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",