fix: use express types and add request context middleware

Author: cyber-hari

README.md

@@ -291,12 +291,9 @@ res.status(HttpStatusCodes.BAD_REQUEST).send("Invalid payload");
 - `requestId(options?): Middleware`
 - `responseTime(options?): Middleware`
 - `timeout(timeoutMs?: number): Middleware`
+- `setupRequestContext: void`
 - `errorHandler(options?): Middleware`
-- `cors(options?): Middleware`
 - `validateRequest(schema, location?): Middleware`
-- `rateLimit(options?): Middleware`
-- `securityHeaders(options?): Middleware`
-- `basicAuth(validator, realm?): Middleware`
 
 **Example:**
 ```ts

package-lock.json

@@ -22,8 +22,7 @@
     "pretest": "npm run compile",
     "dryrun": "npm pack --dry-run",
     "test": "cross-env LOGGER_LEVEL=silent jest",
-    "test:coverage": "cross-env LOGGER_LEVEL=silent jest --coverage",
-    "ver": "echo $npm_package_version"
+    "test:coverage": "cross-env LOGGER_LEVEL=silent jest --coverage"
   },
   "keywords": [
     "utils",
@@ -46,6 +45,7 @@
     "catbee"
   ],
   "dependencies": {
+    "@types/express": "^5.0.3",
     "abort-controller": "^3.0.0",
     "pino": "^9.7.0",
     "reflect-metadata": "^0.2.2"

package.json

@@ -15,12 +15,7 @@ export const Config = {
     /**
      * Name of the logger instance (defaults to npm package name).
      */
-    name: Env.get('LOGGER_NAME', Env.get('npm_package_name', '@catbee/utils')),
-
-    /**
-     * Whether to use ISO 8601 timestamps in logs.
-     */
-    isoTimestamp: Env.getBoolean('LOGGER_ISO_TIMESTAMP', false)
+    name: Env.get('LOGGER_NAME', Env.get('npm_package_name', '@catbee/utils'))
   },
 
   Http: {

src/config.ts

@@ -1,24 +1,8 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
+import type { RequestHandler, Router } from 'express';
 import 'reflect-metadata';
 
-// --- Sample Express interfaces for type safety ---
-interface Request {
-  query: any;
-  params: any;
-  body?: any;
-  [key: string]: any;
-}
-interface Response {
-  json: (body: any) => void;
-  headersSent: boolean;
-  [key: string]: any;
-}
-type NextFunction = (err?: any) => void;
-type RequestHandler = (req: Request, res: Response, next: NextFunction) => any;
-interface Router {
-  [method: string]: (path: string, ...handlers: RequestHandler[]) => void;
-}
 // --- End sample Express interfaces ---
 
 const ROUTES_KEY = Symbol('routes');

src/utils/decorators.utils.ts

@@ -378,7 +378,7 @@ export function withErrorHandling<T extends (...args: any[]) => Promise<any>>(
       }
 
       // Log the original error (consider using a proper logger)
-      getLogger().error('Caught error in handler:', error);
+      getLogger().error({ error }, 'Caught error in handler');
 
       // Extract status code if it exists, otherwise use 500
       let status = HttpStatusCodes.INTERNAL_SERVER_ERROR;

src/utils/exception.utils.ts

@@ -44,13 +44,10 @@ function setupLogger(): void {
         }
         return '***';
       }
-    }
+    },
+    timestamp: stdTimeFunctions.isoTime
   };
 
-  if (Config.Logger.isoTimestamp) {
-    logParams.timestamp = stdTimeFunctions.isoTime;
-  }
-
   _global[GLOBAL_LOGGER_KEY] = pino(logParams);
   _global[GLOBAL_LOGGER_KEY].debug('Logger initialized');
 }
@@ -122,7 +119,7 @@ export function logError(error: Error | unknown, message?: string, context?: Rec
   const errObj = error instanceof Error ? error : new Error(String(error));
   const logContext = {
     ...context,
-    err: errObj
+    error: errObj
   };
 
   logger.error(logContext, message || errObj.message);