response-standardizer 1.1.1 → 1.1.3

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { Request, Response } from "express";
 import { RestResponseFunctions, RestMiddlewareFunctions } from "./types.js";
 declare global {
     namespace Express {
@@ -22,3 +23,4 @@ export declare const error: (message: string, meta?: any) => void;
 export declare const warn: (message: string, meta?: any) => void;
 export declare const info: (message: string, meta?: any) => void;
 export declare const log: (level: "INFO" | "WARN" | "ERROR", message: string, meta?: any) => void;
+export declare const handleRestException: (req: Request, res: Response, err: Error) => void;

package/dist/index.js

@@ -2,6 +2,7 @@ import { generateRequestId, getTimestamp } from "./utils.js";
 import axios from "axios";
 import jwt from "jsonwebtoken";
 import path from "path";
+import { ServiceException } from "./service.exception.js";
 let KEYCLOAK_PUBLIC_KEY = null;
 export const initKeycloak = async (config) => {
     const KEYCLOAK_SERVICE = config.service ?? "localhost";
@@ -51,24 +52,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
     });
@@ -95,20 +95,17 @@ const responseHandlerMiddleware = (req, res, next) => {
     res.json = function (data) {
         if (res.statusCode > 204) {
             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
+                    timestamp: getTimestamp()
                 }
             };
             return oldJson(response);
         }
-        return oldJson(data?.data);
+        return oldJson(data);
     };
     res.send = function (data) {
         if (res.statusCode === 204) {
@@ -166,3 +163,22 @@ export const log = (level, message, meta) => {
     // چاپ لاگ
     console.log(`${color}[${timestamp}][${location}][${level}] ${message}${metaStr}${colors.RESET}`);
 };
+export const handleRestException = (req, res, err) => {
+    if (err instanceof ServiceException) {
+        if (err?.status === 401) {
+            RestResponse.unauthorized(req, res, err.message);
+        }
+        else if (err?.status === 403) {
+            RestResponse.accessDenied(req, res, err.message);
+        }
+        else if (err?.status === 400) {
+            RestResponse.validationError(req, res, err.errors);
+        }
+        else if (err?.status === 500) {
+            RestResponse.exceptionError(req, res, err.message);
+        }
+    }
+    else if (err instanceof Error) {
+        RestResponse.exceptionError(req, res, err.message);
+    }
+};

package/dist/service.exception.d.ts

@@ -0,0 +1,5 @@
+export declare class ServiceException extends Error {
+    status: number;
+    errors: any;
+    constructor(message: string, status?: number, errors?: any);
+}

package/dist/service.exception.js

@@ -0,0 +1,8 @@
+export class ServiceException extends Error {
+    constructor(message, status = 400, errors = null) {
+        super(message);
+        this.name = "ServiceException";
+        this.status = status;
+        this.errors = errors;
+    }
+}

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.1",
+  "version": "1.1.3",
   "description": "Express middleware to standardize API responses",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -1,9 +1,10 @@
 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";
 import path from "path";
+import { ServiceException } from "./service.exception.js";
 declare global {
   namespace Express {
     interface Response {
@@ -71,22 +72,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 +98,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 +108,6 @@ const exceptionError = (
     message = "Internal server error"
 ) => {
     res.status(500).json({
-        data: null,
         message,
         errors
     });
@@ -147,21 +145,18 @@ const responseHandlerMiddleware = (
     res.json = function (data: any) {
         if(res.statusCode > 204){
             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
+                    timestamp: getTimestamp()
                 }
             };
 
             return oldJson(response);
         }
-        return oldJson(data?.data);
+        return oldJson(data);
     };
 
     res.send = function (data: any) {
@@ -226,4 +221,20 @@ export const log = (level: "INFO" | "WARN" | "ERROR", message: string, meta?: an
 
     // چاپ لاگ
     console.log(`${color}[${timestamp}][${location}][${level}] ${message}${metaStr}${colors.RESET}`);
-};
+};
+
+export const handleRestException = (req: Request, res: Response, err: Error) => {
+    if(err instanceof ServiceException){
+        if(err?.status === 401){
+            RestResponse.unauthorized(req, res, err.message)
+        }else if(err?.status === 403){
+            RestResponse.accessDenied(req, res, err.message)
+        }else if(err?.status === 400){
+            RestResponse.validationError(req, res, err.errors)
+        }else if(err?.status === 500){
+            RestResponse.exceptionError(req, res, err.message)
+        }
+    }else if(err instanceof Error){
+        RestResponse.exceptionError(req, res, err.message)
+    }
+}

package/src/service.exception.ts

@@ -0,0 +1,10 @@
+export class ServiceException extends Error {
+    status: number;
+    errors: any
+    constructor(message: string, status: number = 400, errors: any = null) {
+        super(message);
+        this.name = "ServiceException";
+        this.status = status;
+        this.errors = errors;
+    }
+}

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,

package/src/utils.ts

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