unnbound-logger-sdk 2.0.5 → 2.0.7

package/README.md

@@ -357,12 +357,12 @@ new UnnboundLogger(options?: LoggerOptions)
 
 #### Methods
 
-- `log(level: LogLevel, message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void`
-- `error(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void`
-- `warn(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void`
-- `info(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void`
-- `debug(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void`
-- `httpRequest(req: Request, options?: HttpRequestLogOptions): string`
-- `httpResponse(res: Response, req: Request, options: HttpResponseLogOptions): void`
-- `sftpTransaction(operation: SftpOperation, options?: SftpTransactionLogOptions): void`
-- `dbQueryTransaction(query: DbQuery, options?: DbQueryTransactionLogOptions): void`
+- `log(level: LogLevel, message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log`
+- `error(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log`
+- `warn(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log`
+- `info(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log`
+- `debug(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log`
+- `httpRequest(req: Request, options?: HttpRequestLogOptions): HttpRequestLog`
+- `httpResponse(res: Response, req: Request, options: HttpResponseLogOptions): HttpResponseLog`
+- `sftpTransaction(operation: SftpOperation, options?: SftpTransactionLogOptions): SftpTransactionLog`
+- `dbQueryTransaction(query: DbQuery, options?: DbQueryTransactionLogOptions): DbQueryTransactionLog`

package/dist/unnbound-logger.d.ts

@@ -1,4 +1,4 @@
-import { LogLevel, LoggerOptions, GeneralLogOptions, HttpRequestLogOptions, HttpResponseLogOptions, SftpTransactionLogOptions, DbQueryTransactionLogOptions } from './types';
+import { LogLevel, LoggerOptions, GeneralLogOptions, HttpRequestLogOptions, HttpResponseLogOptions, SftpTransactionLogOptions, DbQueryTransactionLogOptions, Log, HttpRequestLog, HttpResponseLog, SftpTransactionLog, DbQueryTransactionLog } from './types';
 import { Request, Response, NextFunction } from 'express';
 import { InternalAxiosRequestConfig } from 'axios';
 declare module 'axios' {
@@ -37,31 +37,31 @@ export declare class UnnboundLogger {
      * @param message - Log message
      * @param options - Additional logging options
      */
-    log(level: LogLevel, message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void;
+    log(level: LogLevel, message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
     /**
      * Logs an error message
      * @param message - Error message or object
      * @param options - Additional logging options
      */
-    error(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void;
+    error(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
     /**
      * Logs a warning message
      * @param message - Warning message
      * @param options - Additional logging options
      */
-    warn(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void;
+    warn(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
     /**
      * Logs an info message
      * @param message - Info message
      * @param options - Additional logging options
      */
-    info(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void;
+    info(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
     /**
      * Logs a debug message
      * @param message - Debug message
      * @param options - Additional logging options
      */
-    debug(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): void;
+    debug(message: string | Error | Record<string, unknown>, options?: GeneralLogOptions): Log;
     /**
      * Constructs the full URL from request information
      * @param req - Express request object
@@ -74,14 +74,14 @@ export declare class UnnboundLogger {
      * @param options - Additional logging options
      * @returns The request ID for correlating with the response
      */
-    httpRequest(req: Request, options?: HttpRequestLogOptions): string;
+    httpRequest(req: Request, options?: HttpRequestLogOptions): HttpRequestLog;
     /**
      * Logs an HTTP response
      * @param res - Express response object
      * @param req - Express request object
      * @param options - Additional logging options
      */
-    httpResponse(res: Response, req: Request, options?: HttpResponseLogOptions): void;
+    httpResponse(res: Response, req: Request, options?: HttpResponseLogOptions): HttpResponseLog;
     /**
      * Logs an SFTP transaction
      * @param operation - SFTP operation details
@@ -96,7 +96,7 @@ export declare class UnnboundLogger {
         bytesTransferred?: number;
         filesListed?: number;
         sourcePath?: string;
-    }, options?: SftpTransactionLogOptions): void;
+    }, options?: SftpTransactionLogOptions): SftpTransactionLog;
     /**
      * Logs a database query transaction
      * @param query - Database query details
@@ -109,7 +109,7 @@ export declare class UnnboundLogger {
         status: 'success' | 'failure';
         rowsReturned?: number;
         rowsAffected?: number;
-    }, options?: DbQueryTransactionLogOptions): void;
+    }, options?: DbQueryTransactionLogOptions): DbQueryTransactionLog;
     traceMiddleware: (req: Request, res: Response, next: NextFunction) => void;
     axiosTraceMiddleware: {
         onFulfilled: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig;

package/dist/unnbound-logger.js

@@ -32,7 +32,7 @@ class UnnboundLogger {
             res.setHeader(this.traceHeaderKey, traceId);
             trace_context_1.traceContext.run(traceId, () => {
                 // Log the incoming request
-                const requestId = this.httpRequest(req, { traceId });
+                const reqLog = this.httpRequest(req, { traceId });
                 // Capture response body for logging
                 const originalSend = res.send;
                 res.send = function (body) {
@@ -41,7 +41,7 @@ class UnnboundLogger {
                 };
                 // Log the response when it finishes
                 res.on('finish', () => {
-                    this.httpResponse(res, req, { requestId, traceId });
+                    this.httpResponse(res, req, { requestId: reqLog.requestId, traceId });
                 });
                 next();
             });
@@ -178,6 +178,7 @@ class UnnboundLogger {
             level: 'info',
             base: {}, // Disable all default base fields (pid, hostname)
             timestamp: false, // Let CloudWatch handle timestamps
+            messageKey: 'messages', // Change message field from 'msg' to 'messages'
             formatters: {
                 level: (label) => {
                     return { level: label };
@@ -213,7 +214,7 @@ class UnnboundLogger {
         const traceId = options.traceId || trace_context_1.traceContext.getTraceId() || (0, uuid_1.v4)();
         const requestId = options.requestId || (0, uuid_1.v4)();
         let logEntry;
-        const { traceId: optionTraceId, requestId: optionRequestId, ...restOptions } = options;
+        const { traceId: optionTraceId, requestId: optionRequestId, level: optionLevel, ...restOptions } = options;
         const baseEntry = {
             logId,
             type: 'general',
@@ -251,7 +252,10 @@ class UnnboundLogger {
                 ...restOptions,
             };
         }
-        this.logger[level](logEntry);
+        // Separate the message from the log data and explicitly exclude any level field
+        const { message: logMessage, level: excludedLevel, ...logData } = logEntry;
+        this.logger[level](logData, logMessage);
+        return logEntry;
     }
     /**
      * Logs an error message
@@ -259,7 +263,7 @@ class UnnboundLogger {
      * @param options - Additional logging options
      */
     error(message, options = {}) {
-        this.log('error', message, options);
+        return this.log('error', message, options);
     }
     /**
      * Logs a warning message
@@ -267,7 +271,7 @@ class UnnboundLogger {
      * @param options - Additional logging options
      */
     warn(message, options = {}) {
-        this.log('warn', message, options);
+        return this.log('warn', message, options);
     }
     /**
      * Logs an info message
@@ -275,7 +279,7 @@ class UnnboundLogger {
      * @param options - Additional logging options
      */
     info(message, options = {}) {
-        this.log('info', message, options);
+        return this.log('info', message, options);
     }
     /**
      * Logs a debug message
@@ -283,7 +287,7 @@ class UnnboundLogger {
      * @param options - Additional logging options
      */
     debug(message, options = {}) {
-        this.log('debug', message, options);
+        return this.log('debug', message, options);
     }
     /**
      * Constructs the full URL from request information
@@ -342,8 +346,8 @@ class UnnboundLogger {
                 body: (0, logger_utils_1.safeJsonParse)(req.body),
             },
         };
-        this.log(options.level || 'info', logEntry);
-        return requestId;
+        const result = this.log(options.level || 'info', logEntry);
+        return result;
     }
     /**
      * Logs an HTTP response
@@ -386,7 +390,8 @@ class UnnboundLogger {
                 body: (0, logger_utils_1.safeJsonParse)(res.locals.body),
             },
         };
-        this.log(level, logEntry);
+        const result = this.log(level, logEntry);
+        return result;
     }
     /**
      * Logs an SFTP transaction
@@ -410,7 +415,8 @@ class UnnboundLogger {
             duration,
             sftp: operation,
         };
-        this.log(level, logEntry);
+        const result = this.log(level, logEntry);
+        return result;
     }
     /**
      * Logs a database query transaction
@@ -434,7 +440,8 @@ class UnnboundLogger {
             duration,
             db: query,
         };
-        this.log(level, logEntry);
+        const result = this.log(level, logEntry);
+        return result;
     }
 }
 exports.UnnboundLogger = UnnboundLogger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unnbound-logger-sdk",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "A structured logging library with TypeScript support using Pino. Provides consistent, well-typed logging with automatic logId, workflowId, traceId, and deploymentId tracking across operational contexts.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",