@nicollasfrazao/liguelead-log-service 1.0.0

package/dist/services/log.service.d.ts

@@ -0,0 +1,224 @@
+import { Request, Response } from "express";
+import { LogType } from "../types/log.type";
+import { LogContextType } from "../types/log.context.type";
+/**
+ * Class LogService
+ *
+ * Responsible for logging messages with different severity levels
+ *
+ * @property {LogServiceConfigInterface} config
+ * @property {LogStorageService} logStorageService
+ * @property {string} correlationId
+ * @property {Promise<void>} writeQueue
+ */
+export declare class LogService {
+    /**
+     * @var {LogServiceConfigInterface}
+     */
+    private static config;
+    /**
+     * @var {string}
+     */
+    private static correlationId;
+    /**
+     * @var {LogStorageService|null}
+     */
+    private static logStorageService;
+    /**
+     * @var {Promise<void>}
+     */
+    private static writeQueue;
+    /**
+     * Sets the correlation ID for log entries
+     *
+     * @param {string} correlationId
+     *
+     * @returns {void}
+     */
+    static setCorrelationId(correlationId?: string): void;
+    /**
+     * Gets the current correlation ID
+     *
+     * @returns {string} The current correlation ID
+     */
+    static getCorrelationId(): string;
+    /**
+     * Determines if a log message should be logged based on its level
+     *
+     * @param {LogType['level']} level The level of the log message
+     *
+     * @returns {boolean} True if the message should be logged, false otherwise
+     */
+    private static shouldLog;
+    /**
+     * Formats the log data into a string
+     *
+     * @param {LogType} data The log data to format
+     *
+     * @returns {string} The formatted log string
+     */
+    static formatLog(data: LogType): string;
+    /**
+     * Gets the current timestamp
+     *
+     * @returns {string} The current timestamp
+     */
+    private static getTimestamp;
+    /**
+     * Colorizes the log text based on the log level
+     *
+     * @param {LogType['level']} data The log level
+     *
+     * @returns {string} The colorized log text
+     */
+    private static colorizeLogOutput;
+    /**
+     * Creates a log entry
+     *
+     * @param {LogType['level']} level The log level
+     * @param {string} message The log message
+     * @param {LogContextType} context The log context
+     *
+     * @returns {LogType} The created log entry
+     */
+    private static createLogEntry;
+    /**
+     * Logs an informational message
+     *
+     * @param {string} message The log message
+     * @param {LogContextType} context The log context
+     *
+     * @returns {void}
+     */
+    static info(message: string, context?: LogContextType): void;
+    /**
+     * Logs a warning message
+     *
+     * @param {string} message The warning message
+     * @param {LogContextType} context The log context
+     *
+     * @returns {void}
+     */
+    static warn(message: string, context?: LogContextType): void;
+    /**
+     * Logs an error message
+     *
+     * @param {string} message The error message
+     * @param {LogContextType} context The log context
+     *
+     * @returns {void}
+     */
+    static error(message: string, context?: LogContextType): void;
+    /**
+     * Logs a debug message
+     *
+     * @param {string} message The debug message
+     * @param {LogContextType} context The log context
+     *
+     * @returns {void}
+     */
+    static debug(message: string, context: LogContextType): void;
+    /**
+     * Function to sanitize sensitive data
+     *
+     * @param {any} body
+     *
+     * @returns {any}
+     */
+    static sanitizeBody(body: any): any;
+    /**
+     * Get the client IP address from the request
+     *
+     * @param {Request} request The Express request object
+     *
+     * @returns {string} The client IP address
+     */
+    static getClientIp(request?: Request): string;
+    /**
+     * Writes log data to the configured destinations (console, storage, or both)
+     *
+     * @param {LogType} data The log data to write
+     *
+     * @returns {void}
+     */
+    private static writeLog;
+    /**
+     * Initializes the LoggingStorageService if not already initialized
+     *
+     * @returns {void}
+     */
+    private static initializeLogStorageService;
+    /**
+     * Writes log data to the appropriate storage (file or S3)
+     *
+     * @param {LogType} data The log data to write
+     *
+     * @returns {Promise<void>}
+     */
+    private static writeToStorage;
+    /**
+     * Writes log data to the console with appropriate color coding
+     *
+     * @param {LogType} data The log data to write
+     *
+     * @returns {void}
+     */
+    private static writeToConsole;
+    /**
+     * Helper method to execute request calls with logging
+     *
+     * @param {() => Promise<any>} requestCall - The request call function
+     * @param {string} requestMethod - The HTTP method (GET, POST, etc.)
+     * @param {string} requestUrl - The request endpoint URL
+     * @param {string} requestName - The name of the external request for logging purposes
+     * @param {any} requestBody - The request body (if applicable)
+     * @param {Request} requestOrigin - The original Express request
+     *
+     * @returns {Promise<T>} - The request response
+     */
+    static executeRequestWithLogging<T>(requestCall: () => Promise<any>, requestMethod: string, requestUrl: string, requestName?: string, requestBody?: any, requestOrigin?: Request): Promise<T>;
+    /**
+     * Logs an external request call
+     *
+     * @param {string} requestMethod
+     * @param {string} requestUrl
+     * @param {string} requestName
+     * @param {Request} requestOrigin
+     * @param {any} requestBody
+     * @param {number} statusCode
+     * @param {number} duration
+     * @param {any} responseBody
+     * @param {Error} error
+     *
+     * @returns {void}
+     */
+    private static logExternalRequestCall;
+    /**
+     * Creates a log context from an Express request
+     *
+     * @param {Request} request The Express request
+     * @param {Partial<LogContextType>} additionalData Additional data to include in the context
+     *
+     * @returns {LogContextType} The created log context
+     */
+    static createContextFromRequest(request: Request, additionalData?: Partial<LogContextType>): LogContextType;
+    /**
+     * Creates a log context from an Express response
+     *
+     * @param {Request} request The Express request object
+     * @param {Response} response The Express response object
+     * @param {Partial<LogContextType>} additionalData Additional data to include in the context
+     *
+     * @returns {LogContextType} The created log context
+     */
+    static createContextFromResponse(request: Request, response: Response, additionalData?: Partial<LogContextType>): LogContextType;
+    /**
+     * Creates a log context from arbitrary data
+     *
+     * @param {Partial<LogContextType>} data The data to create the context from
+     *
+     * @returns {LogContextType} The created log context
+     */
+    static createContextFromData(data?: Partial<LogContextType>): LogContextType;
+}
+//# sourceMappingURL=log.service.d.ts.map

package/dist/services/log.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.service.d.ts","sourceRoot":"","sources":["../../src/services/log.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAK5C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAG3D;;;;;;;;;GASG;AACH,qBAAa,UAAU;IAErB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM,CAAoD;IAEzE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAEhD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAkC;IAElE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU,CAAoC;IAE7D;;;;;;OAMG;WACW,gBAAgB,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI;IAK5D;;;;OAIG;WACW,gBAAgB,IAAI,MAAM;IAKxC;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,SAAS;IAmBxB;;;;;;OAMG;WACW,SAAS,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM;IAK9C;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;IAO3B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IA4BhC;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAgB7B;;;;;;;OAOG;WACW,IAAI,CAChB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,IAAI;IAcP;;;;;;;OAOG;WACW,IAAI,CAChB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,IAAI;IAcP;;;;;;;OAOG;WACW,KAAK,CACjB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,IAAI;IAcP;;;;;;;OAOG;WACW,KAAK,CACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,cAAc,GACtB,IAAI;IAcP;;;;;;OAMG;WACW,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG;IAkH1C;;;;;;OAMG;WACW,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM;IAWpD;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ;IAmCvB;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,2BAA2B;IAgB1C;;;;;;OAMG;mBACkB,cAAc;IASnC;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAqB7B;;;;;;;;;;;OAWG;WACiB,yBAAyB,CAAC,CAAC,EAC7C,WAAW,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,EAC/B,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,WAAW,CAAC,EAAE,MAAM,EACpB,WAAW,CAAC,EAAE,GAAG,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,CAAC;IA6Cb;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IA8DrC;;;;;;;OAOG;WACW,wBAAwB,CACpC,OAAO,EAAE,OAAO,EAChB,cAAc,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GACvC,cAAc;IA8CjB;;;;;;;;OAQG;WACW,yBAAyB,CACrC,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,QAAQ,EAClB,cAAc,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GACvC,cAAc;IAuDjB;;;;;;OAMG;WACW,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc;CASpF"}