response-standardizer 1.2.2 → 1.2.3

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import { Request, Response } from "express";
+import { RestResponseFunctions, RestMiddlewareFunctions } from "./types";
+declare global {
+    namespace Express {
+        interface Response {
+            json: (data: any) => Response;
+            send: (data?: any) => Response;
+            locals: {
+                requestId: string;
+                [key: string]: any;
+            };
+        }
+    }
+}
+export declare const initKeycloak: (config: {
+    service?: string;
+    realm?: string;
+}) => Promise<void>;
+export declare const protect: (allowedRoles?: string[]) => (req: any, res: any, next: any) => void;
+export declare const RestResponse: RestResponseFunctions;
+export declare const RestMiddleware: RestMiddlewareFunctions;
+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;
+export declare const handleValidationException: (error: any) => never;
+export declare class ServiceException extends Error {
+    status: number;
+    errors: any;
+    constructor(message: string, status?: number, errors?: any);
+}

package/dist/types.d.ts

@@ -0,0 +1,40 @@
+import { Request, Response, NextFunction } from "express";
+export interface StandardResponse<T = any> {
+    code: number;
+    message: string;
+    errors: Record<string, string[]> | null;
+    meta: {
+        requestId: string;
+        timestamp: string;
+    };
+}
+export interface PaginationMeta {
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+export interface Pagination<T> {
+    data: T[];
+    meta: PaginationMeta;
+}
+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) => 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;
+    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;
+    token?: string;
+}

package/dist/utils.d.ts

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

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "response-standardizer",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Express middleware to standardize API responses",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "type": "commonjs",
   "scripts": {
     "build": "tsc",
     "prepare": "npm run build"

package/tsconfig.json

@@ -6,9 +6,10 @@
     "rootDir": "src",
     "outDir": "dist",
     "strict": true,
+    "declaration": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": true
   },
   "include": ["src/**/*"]
-}
+}