response-standardizer 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { RestResponseFunctions, RestMiddlewareFunctions } from "./types.js";
+declare global {
+    namespace Express {
+        interface Response {
+            json: (data: any) => Response;
+            send: (data?: any) => Response;
+            locals: {
+                requestId: string;
+                [key: string]: any;
+            };
+        }
+    }
+}
+export declare const RestResponse: RestResponseFunctions;
+export declare const RestMiddleware: RestMiddlewareFunctions;

package/dist/index.js

@@ -0,0 +1,69 @@
+import { generateRequestId, getTimestamp } from "./utils.js";
+const success = (req, res, data, message = null) => {
+    res.status(200).json({ data, message });
+};
+const paginate = (req, res, data, pagination, message = null) => {
+    res.status(200).json({ data, message, pagination });
+};
+const created = (req, res, data, message = "Record created successfully") => {
+    res.status(201).json({ data, message });
+};
+const deleted = (req, res) => {
+    res.status(204).send();
+};
+const validationError = (req, res, errors, message = "Validation error") => {
+    res.status(400).json({ errors, message, data: null });
+};
+const exceptionError = (req, res, errors, message = "Internal server error") => {
+    res.status(500).json({
+        data: null,
+        message,
+        errors
+    });
+};
+const unauthorized = (req, res, message = "Unauthorized") => {
+    res.status(401).json({ message });
+};
+const accessDenied = (req, res, message = "Access denied") => {
+    res.status(403).json({ message });
+};
+export const RestResponse = {
+    success,
+    paginate,
+    created,
+    deleted,
+    validationError,
+    exceptionError,
+    unauthorized,
+    accessDenied
+};
+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);
+    };
+    res.send = function (data) {
+        if (res.statusCode === 204) {
+            return oldSend();
+        }
+        return oldSend(data);
+    };
+    res.locals.requestId = generateRequestId();
+    next();
+};
+export const RestMiddleware = {
+    responseHandlerMiddleware
+};

package/dist/types.d.ts

@@ -0,0 +1,34 @@
+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 {
+    total: number;
+    page: number;
+    perPage: number;
+    pageCount: number;
+}
+export type ErrorFields = Record<string, string[]>;
+export type Middleware = (req: Request, res: Response, next: NextFunction) => void;
+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;
+    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;
+    unauthorized: (req: Request, res: Response, message?: string) => void;
+    accessDenied: (req: Request, res: Response, message?: string) => void;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const generateRequestId: () => string;
+export declare const getTimestamp: () => string;

package/dist/utils.js

@@ -0,0 +1,7 @@
+import { v4 as uuidv4 } from "uuid";
+export const generateRequestId = () => {
+    return uuidv4();
+};
+export const getTimestamp = () => {
+    return new Date().toISOString();
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "response-standardizer",
+  "version": "1.0.0",
+  "description": "Express middleware to standardize API responses",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/dezhnevesht-archive-software/response-standardizer.git"
+  },
+  "author": "Hamid Atyabi",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://gitlab.com/dezhnevesht-archive-software/response-standardizer/issues"
+  },
+  "homepage": "https://gitlab.com/dezhnevesht-archive-software/response-standardizer#readme",
+  
+  "peerDependencies": {
+    "express": "^4 || ^5"
+  },
+
+  "dependencies": {
+    "uuid": "^9.0.1"
+  },
+
+  "devDependencies": {
+    "@types/express": "^5.0.5",
+    "@types/uuid": "^10.0.0",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.9.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,121 @@
+import { Request, Response, NextFunction } from "express";
+import { ErrorFields, PaginationMeta, StandardResponse, RestResponseFunctions, RestMiddlewareFunctions } from "./types.js";
+import { generateRequestId, getTimestamp } from "./utils.js";
+declare global {
+  namespace Express {
+    interface Response {
+      json: (data: any) => Response;
+      send: (data?: any) => Response;
+      locals: {
+        requestId: string;
+        [key: string]: any;
+      };
+    }
+  }
+}
+
+const success = <T>(req: Request, res: Response, data: T, message: string | null = null) => {
+    res.status(200).json({ data, message });
+};
+
+const paginate = <T>(
+    req: Request,
+    res: Response,
+    data: T,
+    pagination: PaginationMeta,
+    message: string | null = null
+) => {
+    res.status(200).json({ data, message, pagination });
+};
+
+const created = <T>(req: Request, res: Response, data: T, message = "Record created successfully") => {
+    res.status(201).json({ data, message });
+};
+
+const deleted = (req: Request, res: Response) => {
+    res.status(204).send();
+};
+
+const validationError = (
+    req: Request,
+    res: Response,
+    errors: ErrorFields,
+    message = "Validation error"
+) => {
+    res.status(400).json({ errors, message, data: null });
+};
+
+const exceptionError = (
+    req: Request,
+    res: Response,
+    errors: any,
+    message = "Internal server error"
+) => {
+    res.status(500).json({
+        data: null,
+        message,
+        errors
+    });
+};
+
+const unauthorized = (req: Request, res: Response, message = "Unauthorized") => {
+    res.status(401).json({ message });
+};
+
+const accessDenied = (req: Request, res: Response, message = "Access denied") => {
+    res.status(403).json({ message });
+};
+
+export const RestResponse: RestResponseFunctions = {
+    success,
+    paginate,
+    created,
+    deleted,
+    validationError,
+    exceptionError,
+    unauthorized,
+    accessDenied
+};
+
+
+const responseHandlerMiddleware = (
+    req: Request,
+    res: Response,
+    next: NextFunction
+) => {
+
+    const oldJson = res.json.bind(res);
+    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);
+    };
+
+    res.send = function (data: any) {
+        if (res.statusCode === 204) {
+            return oldSend();
+        }
+        return oldSend(data);
+    };
+
+    res.locals.requestId = generateRequestId();
+    next();
+};
+
+
+export const RestMiddleware: RestMiddlewareFunctions = {
+    responseHandlerMiddleware
+}

package/src/types.ts

@@ -0,0 +1,55 @@
+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 {
+    total: number;
+    page: number;
+    perPage: number;
+    pageCount: number;
+}
+
+export type ErrorFields = Record<string, string[]>;
+
+export type Middleware = (req: Request, res: Response, next: NextFunction) => void;
+
+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;
+    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;
+    unauthorized: (req: Request, res: Response, message?: string) => void;
+    accessDenied: (req: Request, res: Response, message?: string) => void;
+}

package/src/utils.ts

@@ -0,0 +1,9 @@
+import { v4 as uuidv4 } from "uuid";
+
+export const generateRequestId = () => {
+    return uuidv4();
+}
+
+export const getTimestamp = () => {
+    return new Date().toISOString();
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "declaration": true,
+    "outDir": "dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts"]
+}