response-standardizer 1.1.0 → 1.1.2

package/dist/index.js

@@ -51,24 +51,23 @@ const role = (req, res, next, allowedRoles) => {
     }
     next();
 };
-const success = (req, res, data, message = null) => {
-    res.status(200).json({ data, message });
+const success = (req, res, data) => {
+    res.status(200).json(data);
 };
-const paginate = (req, res, data, pagination, message = null) => {
-    res.status(200).json({ data, message, pagination });
+const paginate = (req, res, data) => {
+    res.status(200).json(data);
 };
-const created = (req, res, data, message = "Record created successfully") => {
-    res.status(201).json({ data, message });
+const created = (req, res, data) => {
+    res.status(201).json(data);
 };
 const deleted = (req, res) => {
     res.status(204).send();
 };
 const validationError = (req, res, errors, message = "Validation error") => {
-    res.status(400).json({ errors, message, data: null });
+    res.status(400).json({ errors, message });
 };
 const exceptionError = (req, res, errors, message = "Internal server error") => {
     res.status(500).json({
-        data: null,
         message,
         errors
     });
@@ -93,19 +92,19 @@ const responseHandlerMiddleware = (req, res, next) => {
     const oldJson = res.json.bind(res);
     const oldSend = res.send.bind(res);
     res.json = function (data) {
-        const response = {
-            status: res.statusCode >= 200 && res.statusCode < 300 ? "success" : "error",
-            code: res.statusCode,
-            message: data?.message || res.locals.message || (res.statusCode < 300 ? "OK" : "Error"),
-            data: data?.data ?? null,
-            errors: data?.errors ?? null,
-            meta: {
-                requestId: res.locals.requestId || generateRequestId(),
-                timestamp: getTimestamp(),
-                pagination: data?.pagination ?? null
-            }
-        };
-        return oldJson(response);
+        if (res.statusCode > 204) {
+            const response = {
+                code: res.statusCode,
+                message: data?.message || res.locals.message || (res.statusCode < 300 ? "OK" : "Error"),
+                errors: data?.errors ?? null,
+                meta: {
+                    requestId: res.locals.requestId || generateRequestId(),
+                    timestamp: getTimestamp()
+                }
+            };
+            return oldJson(response);
+        }
+        return oldJson(data);
     };
     res.send = function (data) {
         if (res.statusCode === 204) {

package/dist/types.d.ts

@@ -1,17 +1,15 @@
 import { Request, Response, NextFunction } from "express";
 export interface StandardResponse<T = any> {
-    status: "success" | "error";
     code: number;
     message: string;
-    data: T | null;
     errors: Record<string, string[]> | null;
     meta: {
         requestId: string;
         timestamp: string;
-        pagination: PaginationMeta | null;
     };
 }
-export interface PaginationMeta {
+export interface Pagination<T> {
+    data: T[];
     total: number;
     page: number;
     perPage: number;
@@ -23,9 +21,9 @@ export interface RestMiddlewareFunctions {
     responseHandlerMiddleware: <T>(req: Request, res: Response, next: NextFunction) => void;
 }
 export interface RestResponseFunctions {
-    success: <T>(req: Request, res: Response, data: T, message?: string | null) => void;
-    paginate: <T>(req: Request, res: Response, data: T, pagination: PaginationMeta, message?: string | null) => void;
-    created: <T>(req: Request, res: Response, data: T, message?: string) => void;
+    success: <T>(req: Request, res: Response, data: T) => void;
+    paginate: <T>(req: Request, res: Response, data: Pagination<T>) => void;
+    created: <T>(req: Request, res: Response, data: T) => void;
     deleted: (req: Request, res: Response) => void;
     validationError: (req: Request, res: Response, errors: ErrorFields, message?: string) => void;
     exceptionError: (req: Request, res: Response, errors: any, message?: string) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "response-standardizer",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Express middleware to standardize API responses",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -1,5 +1,5 @@
 import { Request, Response, NextFunction } from "express";
-import { ErrorFields, PaginationMeta, StandardResponse, RestResponseFunctions, RestMiddlewareFunctions, AuthRequest } from "./types.js";
+import { ErrorFields, StandardResponse, RestResponseFunctions, RestMiddlewareFunctions, AuthRequest, Pagination } from "./types.js";
 import { generateRequestId, getTimestamp } from "./utils.js";
 import axios from "axios";
 import jwt, { TokenExpiredError } from "jsonwebtoken";
@@ -71,22 +71,20 @@ const role = (req: any, res: any, next: any, allowedRoles: string[]) => {
     }
     next()
 }
-const success = <T>(req: Request, res: Response, data: T, message: string | null = null) => {
-    res.status(200).json({ data, message });
+const success = <T>(req: Request, res: Response, data: T) => {
+    res.status(200).json(data);
 };
 
 const paginate = <T>(
     req: Request,
     res: Response,
-    data: T,
-    pagination: PaginationMeta,
-    message: string | null = null
+    data: Pagination<T>
 ) => {
-    res.status(200).json({ data, message, pagination });
+    res.status(200).json(data);
 };
 
-const created = <T>(req: Request, res: Response, data: T, message = "Record created successfully") => {
-    res.status(201).json({ data, message });
+const created = <T>(req: Request, res: Response, data: T) => {
+    res.status(201).json(data);
 };
 
 const deleted = (req: Request, res: Response) => {
@@ -99,7 +97,7 @@ const validationError = (
     errors: ErrorFields,
     message = "Validation error"
 ) => {
-    res.status(400).json({ errors, message, data: null });
+    res.status(400).json({ errors, message });
 };
 
 const exceptionError = (
@@ -109,7 +107,6 @@ const exceptionError = (
     message = "Internal server error"
 ) => {
     res.status(500).json({
-        data: null,
         message,
         errors
     });
@@ -145,20 +142,20 @@ const responseHandlerMiddleware = (
     const oldSend = res.send.bind(res);
 
     res.json = function (data: any) {
-        const response: StandardResponse = {
-            status: res.statusCode >= 200 && res.statusCode < 300 ? "success" : "error",
-            code: res.statusCode,
-            message: data?.message || res.locals.message || (res.statusCode < 300 ? "OK" : "Error"),
-            data: data?.data ?? null,
-            errors: data?.errors ?? null,
-            meta: {
-                requestId: res.locals.requestId || generateRequestId(),
-                timestamp: getTimestamp(),
-                pagination: data?.pagination ?? null
-            }
-        };
-
-        return oldJson(response);
+        if(res.statusCode > 204){
+            const response: StandardResponse = {
+                code: res.statusCode,
+                message: data?.message || res.locals.message || (res.statusCode < 300 ? "OK" : "Error"),
+                errors: data?.errors ?? null,
+                meta: {
+                    requestId: res.locals.requestId || generateRequestId(),
+                    timestamp: getTimestamp()
+                }
+            };
+
+            return oldJson(response);
+        }
+        return oldJson(data);
     };
 
     res.send = function (data: any) {

package/src/types.ts

@@ -1,19 +1,17 @@
 import { Request, Response, NextFunction } from "express";
 
 export interface StandardResponse<T = any> {
-    status: "success" | "error";
     code: number;
     message: string;
-    data: T | null;
     errors: Record<string, string[]> | null;
     meta: {
         requestId: string;
         timestamp: string;
-        pagination: PaginationMeta | null;
     };
 }
 
-export interface PaginationMeta {
+export interface Pagination<T>{
+    data: T[];
     total: number;
     page: number;
     perPage: number;
@@ -28,15 +26,13 @@ export interface RestMiddlewareFunctions {
     responseHandlerMiddleware: <T>(req: Request, res: Response, next: NextFunction) => void
 }
 export interface RestResponseFunctions {
-    success: <T>(req: Request, res: Response, data: T, message?: string | null) => void;
+    success: <T>(req: Request, res: Response, data: T) => void;
     paginate: <T>(
         req: Request,
         res: Response,
-        data: T,
-        pagination: PaginationMeta,
-        message?: string | null
+        data: Pagination<T>
     ) => void;
-    created: <T>(req: Request, res: Response, data: T, message?: string) => void;
+    created: <T>(req: Request, res: Response, data: T) => void;
     deleted: (req: Request, res: Response) => void;
     validationError: (
         req: Request,