response-standardizer 1.1.3 → 1.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.js +8 -1
  2. package/dist/types.d.ts +8 -4
  3. package/package.json +1 -1
  4. package/src/index.ts +8 -1
  5. package/src/types.ts +8 -5
package/dist/index.js CHANGED
@@ -79,6 +79,9 @@ const unauthorized = (req, res, message = "Unauthorized") => {
79
79
  const accessDenied = (req, res, message = "Access denied") => {
80
80
  res.status(403).json({ message });
81
81
  };
82
+ const notFound = (req, res, message = "Not found") => {
83
+ res.status(404).json({ message });
84
+ };
82
85
  export const RestResponse = {
83
86
  success,
84
87
  paginate,
@@ -87,7 +90,8 @@ export const RestResponse = {
87
90
  validationError,
88
91
  exceptionError,
89
92
  unauthorized,
90
- accessDenied
93
+ accessDenied,
94
+ notFound
91
95
  };
92
96
  const responseHandlerMiddleware = (req, res, next) => {
93
97
  const oldJson = res.json.bind(res);
@@ -177,6 +181,9 @@ export const handleRestException = (req, res, err) => {
177
181
  else if (err?.status === 500) {
178
182
  RestResponse.exceptionError(req, res, err.message);
179
183
  }
184
+ else if (err?.status === 404) {
185
+ RestResponse.notFound(req, res, err.message);
186
+ }
180
187
  }
181
188
  else if (err instanceof Error) {
182
189
  RestResponse.exceptionError(req, res, err.message);
package/dist/types.d.ts CHANGED
@@ -8,12 +8,15 @@ export interface StandardResponse<T = any> {
8
8
  timestamp: string;
9
9
  };
10
10
  }
11
- export interface Pagination<T> {
12
- data: T[];
11
+ export interface PaginationMeta {
13
12
  total: number;
14
13
  page: number;
15
- perPage: number;
16
- pageCount: number;
14
+ limit: number;
15
+ totalPages: number;
16
+ }
17
+ export interface Pagination<T> {
18
+ data: T[];
19
+ meta: PaginationMeta;
17
20
  }
18
21
  export type ErrorFields = Record<string, string[]>;
19
22
  export type Middleware = (req: Request, res: Response, next: NextFunction) => void;
@@ -29,6 +32,7 @@ export interface RestResponseFunctions {
29
32
  exceptionError: (req: Request, res: Response, errors: any, message?: string) => void;
30
33
  unauthorized: (req: Request, res: Response, message?: string) => void;
31
34
  accessDenied: (req: Request, res: Response, message?: string) => void;
35
+ notFound: (req: Request, res: Response, message?: string) => void;
32
36
  }
33
37
  export interface AuthRequest extends Request {
34
38
  user?: any;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "response-standardizer",
3
- "version": "1.1.3",
3
+ "version": "1.1.5",
4
4
  "description": "Express middleware to standardize API responses",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/index.ts CHANGED
@@ -121,6 +121,10 @@ const accessDenied = (req: Request, res: Response, message = "Access denied") =>
121
121
  res.status(403).json({ message });
122
122
  };
123
123
 
124
+ const notFound = (req: Request, res: Response, message = "Not found") => {
125
+ res.status(404).json({ message });
126
+ };
127
+
124
128
  export const RestResponse: RestResponseFunctions = {
125
129
  success,
126
130
  paginate,
@@ -129,7 +133,8 @@ export const RestResponse: RestResponseFunctions = {
129
133
  validationError,
130
134
  exceptionError,
131
135
  unauthorized,
132
- accessDenied
136
+ accessDenied,
137
+ notFound
133
138
  };
134
139
 
135
140
 
@@ -233,6 +238,8 @@ export const handleRestException = (req: Request, res: Response, err: Error) =>
233
238
  RestResponse.validationError(req, res, err.errors)
234
239
  }else if(err?.status === 500){
235
240
  RestResponse.exceptionError(req, res, err.message)
241
+ }else if(err?.status === 404){
242
+ RestResponse.notFound(req, res, err.message)
236
243
  }
237
244
  }else if(err instanceof Error){
238
245
  RestResponse.exceptionError(req, res, err.message)
package/src/types.ts CHANGED
@@ -9,13 +9,15 @@ export interface StandardResponse<T = any> {
9
9
  timestamp: string;
10
10
  };
11
11
  }
12
-
13
- export interface Pagination<T>{
14
- data: T[];
12
+ export interface PaginationMeta{
15
13
  total: number;
16
14
  page: number;
17
- perPage: number;
18
- pageCount: number;
15
+ limit: number;
16
+ totalPages: number;
17
+ }
18
+ export interface Pagination<T>{
19
+ data: T[];
20
+ meta: PaginationMeta
19
21
  }
20
22
 
21
23
  export type ErrorFields = Record<string, string[]>;
@@ -48,6 +50,7 @@ export interface RestResponseFunctions {
48
50
  ) => void;
49
51
  unauthorized: (req: Request, res: Response, message?: string) => void;
50
52
  accessDenied: (req: Request, res: Response, message?: string) => void;
53
+ notFound: (req: Request, res: Response, message?: string) => void;
51
54
  }
52
55
 
53
56
  export interface AuthRequest extends Request {