sasai-common-utils 1.0.26 → 1.0.28

package/index.d.ts

@@ -0,0 +1,88 @@
+import { AxiosInstance } from "axios";
+import { Logger } from "winston";
+import { NextFunction, Request, Response } from "express";
+import { Logger as WinstonLogger } from "winston";
+
+// Extend the Winston Logger to include custom methods
+export interface ExtendedLogger extends WinstonLogger {
+    logError: (data: Record<string, any>, req?: Record<string, any>) => void;
+    logInfo: (message: string, data?: Record<string, any>) => void;
+    logDebug: (message: string, data?: Record<string, any>) => void;
+}
+
+// Export the logger with the extended type
+export const logger: ExtendedLogger;
+/**
+ * Logger configuration options.
+ */
+export interface LoggerConfig {
+    level?: string;
+    SERVICE_NAME?: string;
+    DEBUG_MODE?: string;
+    LOG_LEVEL?: string;
+}
+
+/**
+ * Context provider type for custom context setup.
+ */
+export type ContextProvider = () => Record<string, any>;
+
+/**
+ * Logs information-level messages.
+ * @param message The message to log.
+ * @param data Additional data to include in the log.
+ */
+export function logInfo(message: string, data?: Record<string, any>): void;
+
+/**
+ * Logs error-level messages.
+ * @param error The error object or message to log.
+ * @param data Additional data to include in the log.
+ */
+export function logError(error: Error | string, data?: Record<string, any>): void;
+
+/**
+ * Logs debug-level messages.
+ * @param message The message to log.
+ * @param data Additional data to include in the log.
+ */
+export function logDebug(message: string, data?: Record<string, any>): void;
+
+/**
+ * A shared logger instance configured with the provided settings.
+ */
+// export const logger: Logger;
+
+/**
+ * Creates a new logger instance.
+ * @param config Optional configuration for the logger.
+ */
+export function createLogger(config?: LoggerConfig): Logger;
+
+/**
+ * Sets a context provider for adding custom context to logs.
+ * @param provider A function that returns custom context as an object.
+ */
+export function setContextProvider(provider: ContextProvider): void;
+
+/**
+ * Middleware to log Express API requests and responses.
+ */
+export function logExpressApis(logger: Logger): void;
+
+/**
+ * Attaches Axios request and response interceptors for logging.
+ * @param axiosInstance An Axios instance.
+ * @param logger A logger instance.
+ * @param apmTracing An object containing APM trace ID and span ID.
+ */
+export function attachAxiosLogger(
+    axiosInstance: AxiosInstance,
+    logger: Logger,
+    apmTracing?: Record<string, any>
+): void;
+
+/**
+ * Utility functions (future scope).
+ */
+export const utils: Record<string, any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sasai-common-utils",
-  "version": "1.0.26",
+  "version": "1.0.28",
   "description": "Reusable utility library for common logging and other shared features.",
   "main": "src/index.js",
   "scripts": {

package/src/features/logger/index.js

@@ -85,6 +85,7 @@ if (globalConfig.DEBUG_MODE === DEBUG_MODES.FILE) {
         data.class = "";
         data.message = {};
         data.message.step = data?.step;
+        data.message.message = message
         data.message.method = data?.method?.toUpperCase() ?? "";
         if(data?.method){
             delete data.method;

package/src/features/logger/redact.js

@@ -17,15 +17,21 @@ function redactObject(obj) {
 			this.update("[REDACTED]");
 		}
 		if (this.key === "message" && typeof this.node === "string") {
-                const parsedMessage = JSON.parse(this?.node); // Try to parse the message JSON string
-                if (Object.keys(parsedMessage?.headers).length ) {
+			let parsedMessage
+			try {
+				parsedMessage = JSON.parse(this?.node);
+				if (Object.keys(parsedMessage?.headers).length ) {
                     parsedMessage.headers.authorization = "[REDACTED]"; 
 					parsedMessage.headers.Authorization = "[REDACTED]"; 
                 }
 				if (parsedMessage?.responseHeaders) {
                     parsedMessage.responseHeaders.authorization = "[REDACTED]"; 
 					parsedMessage.responseHeaders.Authorization = "[REDACTED]"; 
-                }
+                } 
+			} catch (error) {
+				parsedMessage = {}; 
+			}
+
                 this.update(JSON.stringify(parsedMessage)); // Update with the redacted string
         }
 	});