response-standardizer 1.1.2 → 1.1.4

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";
@@ -78,6 +79,9 @@ const unauthorized = (req, res, message = "Unauthorized") => {
 const accessDenied = (req, res, message = "Access denied") => {
     res.status(403).json({ message });
 };
+const notFound = (req, res, message = "Not found") => {
+    res.status(404).json({ message });
+};
 export const RestResponse = {
     success,
     paginate,
@@ -86,7 +90,8 @@ export const RestResponse = {
     validationError,
     exceptionError,
     unauthorized,
-    accessDenied
+    accessDenied,
+    notFound
 };
 const responseHandlerMiddleware = (req, res, next) => {
     const oldJson = res.json.bind(res);
@@ -162,3 +167,25 @@ 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?.status === 404) {
+            RestResponse.notFound(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

@@ -29,6 +29,7 @@ export interface RestResponseFunctions {
     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;
+    notFound: (req: Request, res: Response, message?: string) => void;
 }
 export interface AuthRequest extends Request {
     user?: any;

package/package.json

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

package/src/index.ts

@@ -4,6 +4,7 @@ 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 {
@@ -120,6 +121,10 @@ const accessDenied = (req: Request, res: Response, message = "Access denied") =>
     res.status(403).json({ message });
 };
 
+const notFound = (req: Request, res: Response, message = "Not found") => {
+    res.status(404).json({ message });
+};
+
 export const RestResponse: RestResponseFunctions = {
     success,
     paginate,
@@ -128,7 +133,8 @@ export const RestResponse: RestResponseFunctions = {
     validationError,
     exceptionError,
     unauthorized,
-    accessDenied
+    accessDenied,
+    notFound
 };
 
 
@@ -220,4 +226,22 @@ 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?.status === 404){
+            RestResponse.notFound(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

@@ -48,6 +48,7 @@ export interface RestResponseFunctions {
     ) => void;
     unauthorized: (req: Request, res: Response, message?: string) => void;
     accessDenied: (req: Request, res: Response, message?: string) => void;
+    notFound: (req: Request, res: Response, message?: string) => void;
 }
 
 export interface AuthRequest extends 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();
-}
+}