@eqxjs/nest-logger 3.1.0-beta.13 → 3.1.0-beta.14

package/dist/constants/action-message.constant.d.ts

@@ -1,16 +1,187 @@
+/**
+ * ActionMessage - Provides standardized action tags for consistent logging across the application.
+ *
+ * This class contains static methods that return predefined action tags used for categorizing
+ * and filtering log entries. Using these constants ensures consistency in log formatting and
+ * makes it easier to search and analyze logs.
+ *
+ * @example
+ * ```typescript
+ * import { ActionMessage } from '@eqxjs/nest-logger';
+ *
+ * // Use in logging
+ * logger.info('Processing message', ActionMessage.consume());
+ * logger.info('Request received', ActionMessage.httpRequest());
+ * logger.error('Operation failed', ActionMessage.exception());
+ * ```
+ */
 export declare class ActionMessage {
+    /**
+     * Returns the action tag for message consumption in progress.
+     * Used when starting to consume a message from a queue or broker.
+     *
+     * @returns The string '[CONSUMING]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Starting to consume', ActionMessage.consume());
+     * ```
+     */
     static consume(): string;
+    /**
+     * Returns the action tag for completed message consumption.
+     * Used when a message has been successfully consumed from a queue or broker.
+     *
+     * @returns The string '[CONSUMED]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Message consumed', ActionMessage.consumed());
+     * ```
+     */
     static consumed(): string;
+    /**
+     * Returns the action tag for message production in progress.
+     * Used when starting to produce/publish a message to a queue or broker.
+     *
+     * @returns The string '[PRODUCING]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Publishing message', ActionMessage.produce());
+     * ```
+     */
     static produce(): string;
+    /**
+     * Returns the action tag for completed message production.
+     * Used when a message has been successfully produced/published.
+     *
+     * @returns The string '[PRODUCED]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Message published', ActionMessage.produced());
+     * ```
+     */
     static produced(): string;
+    /**
+     * Returns the action tag for HTTP request operations.
+     * Used when receiving or sending HTTP requests.
+     *
+     * @returns The string '[HTTP_REQUEST]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('HTTP request received', ActionMessage.httpRequest());
+     * ```
+     */
     static httpRequest(): string;
+    /**
+     * Returns the action tag for HTTP response operations.
+     * Used when sending or receiving HTTP responses.
+     *
+     * @returns The string '[HTTP_RESPONSE]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Sending response', ActionMessage.httpResponse());
+     * ```
+     */
     static httpResponse(): string;
+    /**
+     * Returns the action tag for WebSocket message reception.
+     * Used when receiving messages via WebSocket.
+     *
+     * @returns The string '[WS_RECEIVED]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('WebSocket message received', ActionMessage.wsRecv());
+     * ```
+     */
     static wsRecv(): string;
+    /**
+     * Returns the action tag for WebSocket message sending.
+     * Used when sending messages via WebSocket.
+     *
+     * @returns The string '[WS_SENT]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('WebSocket message sent', ActionMessage.wsSent());
+     * ```
+     */
     static wsSent(): string;
+    /**
+     * Returns the action tag for database request operations.
+     * Used when initiating database queries or operations.
+     *
+     * @returns The string '[DB_REQUEST]'
+     *
+     * @example
+     * ```typescript
+     * logger.debug('Executing query', ActionMessage.dbRequest());
+     * ```
+     */
     static dbRequest(): string;
+    /**
+     * Returns the action tag for database response operations.
+     * Used when receiving results from database queries or operations.
+     *
+     * @returns The string '[DB_RESPONSE]'
+     *
+     * @example
+     * ```typescript
+     * logger.debug('Query completed', ActionMessage.dbResponse());
+     * ```
+     */
     static dbResponse(): string;
+    /**
+     * Returns the action tag for application logic operations.
+     * Used for business logic processing and internal operations.
+     *
+     * @returns The string '[APP_LOGIC]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Processing business logic', ActionMessage.appLogic());
+     * ```
+     */
     static appLogic(): string;
+    /**
+     * Returns the action tag for inbound operations.
+     * Used when receiving data from external services or systems.
+     *
+     * @returns The string '[INBOUND]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Receiving data', ActionMessage.inbound());
+     * ```
+     */
     static inbound(): string;
+    /**
+     * Returns the action tag for outbound operations.
+     * Used when sending data to external services or systems.
+     *
+     * @returns The string '[OUTBOUND]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Sending data to external API', ActionMessage.outbound());
+     * ```
+     */
     static outbound(): string;
+    /**
+     * Returns the action tag for exception/error conditions.
+     * Used when logging exceptions, errors, or failure scenarios.
+     *
+     * @returns The string '[EXCEPTION]'
+     *
+     * @example
+     * ```typescript
+     * logger.error('Operation failed', ActionMessage.exception());
+     * ```
+     */
     static exception(): string;
 }

package/dist/constants/action-message.constant.js

@@ -1,46 +1,217 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActionMessage = void 0;
+/**
+ * ActionMessage - Provides standardized action tags for consistent logging across the application.
+ *
+ * This class contains static methods that return predefined action tags used for categorizing
+ * and filtering log entries. Using these constants ensures consistency in log formatting and
+ * makes it easier to search and analyze logs.
+ *
+ * @example
+ * ```typescript
+ * import { ActionMessage } from '@eqxjs/nest-logger';
+ *
+ * // Use in logging
+ * logger.info('Processing message', ActionMessage.consume());
+ * logger.info('Request received', ActionMessage.httpRequest());
+ * logger.error('Operation failed', ActionMessage.exception());
+ * ```
+ */
 class ActionMessage {
+    /**
+     * Returns the action tag for message consumption in progress.
+     * Used when starting to consume a message from a queue or broker.
+     *
+     * @returns The string '[CONSUMING]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Starting to consume', ActionMessage.consume());
+     * ```
+     */
     static consume() {
         return `[CONSUMING]`;
     }
+    /**
+     * Returns the action tag for completed message consumption.
+     * Used when a message has been successfully consumed from a queue or broker.
+     *
+     * @returns The string '[CONSUMED]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Message consumed', ActionMessage.consumed());
+     * ```
+     */
     static consumed() {
         return `[CONSUMED]`;
     }
+    /**
+     * Returns the action tag for message production in progress.
+     * Used when starting to produce/publish a message to a queue or broker.
+     *
+     * @returns The string '[PRODUCING]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Publishing message', ActionMessage.produce());
+     * ```
+     */
     static produce() {
         return `[PRODUCING]`;
     }
+    /**
+     * Returns the action tag for completed message production.
+     * Used when a message has been successfully produced/published.
+     *
+     * @returns The string '[PRODUCED]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Message published', ActionMessage.produced());
+     * ```
+     */
     static produced() {
         return `[PRODUCED]`;
     }
+    /**
+     * Returns the action tag for HTTP request operations.
+     * Used when receiving or sending HTTP requests.
+     *
+     * @returns The string '[HTTP_REQUEST]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('HTTP request received', ActionMessage.httpRequest());
+     * ```
+     */
     static httpRequest() {
         return `[HTTP_REQUEST]`;
     }
+    /**
+     * Returns the action tag for HTTP response operations.
+     * Used when sending or receiving HTTP responses.
+     *
+     * @returns The string '[HTTP_RESPONSE]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Sending response', ActionMessage.httpResponse());
+     * ```
+     */
     static httpResponse() {
         return `[HTTP_RESPONSE]`;
     }
+    /**
+     * Returns the action tag for WebSocket message reception.
+     * Used when receiving messages via WebSocket.
+     *
+     * @returns The string '[WS_RECEIVED]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('WebSocket message received', ActionMessage.wsRecv());
+     * ```
+     */
     static wsRecv() {
         return `[WS_RECEIVED]`;
     }
+    /**
+     * Returns the action tag for WebSocket message sending.
+     * Used when sending messages via WebSocket.
+     *
+     * @returns The string '[WS_SENT]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('WebSocket message sent', ActionMessage.wsSent());
+     * ```
+     */
     static wsSent() {
         return `[WS_SENT]`;
     }
+    /**
+     * Returns the action tag for database request operations.
+     * Used when initiating database queries or operations.
+     *
+     * @returns The string '[DB_REQUEST]'
+     *
+     * @example
+     * ```typescript
+     * logger.debug('Executing query', ActionMessage.dbRequest());
+     * ```
+     */
     static dbRequest() {
         return `[DB_REQUEST]`;
     }
+    /**
+     * Returns the action tag for database response operations.
+     * Used when receiving results from database queries or operations.
+     *
+     * @returns The string '[DB_RESPONSE]'
+     *
+     * @example
+     * ```typescript
+     * logger.debug('Query completed', ActionMessage.dbResponse());
+     * ```
+     */
     static dbResponse() {
         return `[DB_RESPONSE]`;
     }
+    /**
+     * Returns the action tag for application logic operations.
+     * Used for business logic processing and internal operations.
+     *
+     * @returns The string '[APP_LOGIC]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Processing business logic', ActionMessage.appLogic());
+     * ```
+     */
     static appLogic() {
         return `[APP_LOGIC]`;
     }
+    /**
+     * Returns the action tag for inbound operations.
+     * Used when receiving data from external services or systems.
+     *
+     * @returns The string '[INBOUND]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Receiving data', ActionMessage.inbound());
+     * ```
+     */
     static inbound() {
         return `[INBOUND]`;
     }
+    /**
+     * Returns the action tag for outbound operations.
+     * Used when sending data to external services or systems.
+     *
+     * @returns The string '[OUTBOUND]'
+     *
+     * @example
+     * ```typescript
+     * logger.info('Sending data to external API', ActionMessage.outbound());
+     * ```
+     */
     static outbound() {
         return `[OUTBOUND]`;
     }
+    /**
+     * Returns the action tag for exception/error conditions.
+     * Used when logging exceptions, errors, or failure scenarios.
+     *
+     * @returns The string '[EXCEPTION]'
+     *
+     * @example
+     * ```typescript
+     * logger.error('Operation failed', ActionMessage.exception());
+     * ```
+     */
     static exception() {
         return '[EXCEPTION]';
     }

package/dist/constants/action-message.constant.js.map

@@ -1 +1 @@
-{"version":3,"file":"action-message.constant.js","sourceRoot":"","sources":["../../src/constants/action-message.constant.ts"],"names":[],"mappings":";;;AAAA,MAAa,aAAa;IACjB,MAAM,CAAC,OAAO;QACnB,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,MAAM,CAAC,OAAO;QACnB,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEM,MAAM,CAAC,YAAY;QACxB,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,MAAM;QAClB,OAAO,eAAe,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,MAAM;QAClB,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,SAAS;QACrB,OAAO,cAAc,CAAC;IACxB,CAAC;IAEM,MAAM,CAAC,UAAU;QACtB,OAAO,eAAe,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,QAAQ;QACpB,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,OAAO;QACnB,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,MAAM,CAAC,QAAQ;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,MAAM,CAAC,SAAS;QACrB,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAxDD,sCAwDC"}
+{"version":3,"file":"action-message.constant.js","sourceRoot":"","sources":["../../src/constants/action-message.constant.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,aAAa;IACxB;;;;;;;;;;OAUG;IACI,MAAM,CAAC,OAAO;QACnB,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,QAAQ;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,OAAO;QACnB,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,QAAQ;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,WAAW;QACvB,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,YAAY;QACxB,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,MAAM;QAClB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,MAAM;QAClB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,SAAS;QACrB,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,UAAU;QACtB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,QAAQ;QACpB,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,OAAO;QACnB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,QAAQ;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,SAAS;QACrB,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAlND,sCAkNC"}

package/dist/core/formatters/logger.formatter.d.ts

@@ -3,17 +3,124 @@ import { LoggerDto } from '../../models/logger.dto';
 import { LoggerOpt } from '../../interfaces/logger-opt.interface';
 import { DataM, DataM1I, DataM2I, DataM3I } from '../../interfaces/data.interface';
 type MessageType = 'M1' | 'M2' | 'M3';
+/**
+ * LoggerFormat - Format-specific logger for M1, M2, and M3 message protocols.
+ *
+ * Provides logging capabilities for different message formats used in distributed systems:
+ * - **M1**: Message broker/queue operations (Kafka, RabbitMQ, etc.)
+ * - **M2**: HTTP/protocol operations (REST APIs, GraphQL, etc.)
+ * - **M3**: Service-to-service operations (gRPC, internal services, databases, etc.)
+ *
+ * Each format requires specific data structures with appropriate header and metadata fields.
+ *
+ * @example
+ * ```typescript
+ * // M1 Format
+ * const loggerM1 = new LoggerFormat(baseLogger, 'M1');
+ * loggerM1.info('order.topic', '[CONSUMING]', dataM1, 'Processing order');
+ *
+ * // M2 Format
+ * const loggerM2 = new LoggerFormat(baseLogger, 'M2');
+ * loggerM2.info('api.users', '[HTTP_REQUEST]', dataM2, 'User creation');
+ *
+ * // M3 Format
+ * const loggerM3 = new LoggerFormat(baseLogger, 'M3');
+ * loggerM3.debug('db.users', '[DB_REQUEST]', dataM3, 'Query users');
+ * ```
+ */
 export declare class LoggerFormat {
     protected readonly messageType: MessageType;
     private logger;
+    /**
+     * Creates a new LoggerFormat instance.
+     *
+     * @param logger - BaseAppLogger instance for actual logging
+     * @param messageType - Message format type ('M1', 'M2', or 'M3')
+     */
     constructor(logger: BaseAppLogger, messageType: MessageType);
+    /**
+     * Internal method to handle log level checking and routing.
+     *
+     * @param level - Log level
+     * @param topic - Topic identifier
+     * @param action - Action tag
+     * @param data - Message data
+     * @param message - Optional message text
+     * @param opt - Optional configuration
+     * @private
+     */
     private logMethod;
+    /**
+     * Logs a debug-level message for detailed diagnostic information.
+     *
+     * @param topic - Topic or identifier (e.g., 'payment.topic', 'api.users')
+     * @param action - Action tag (e.g., '[CONSUMING]', '[HTTP_REQUEST]')
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional descriptive message
+     * @param opt - Optional logging configuration
+     */
     debug(topic: string, action: string, data: any, message?: string, opt?: LoggerOpt): void;
+    /**
+     * Logs an info-level message for general information.
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional descriptive message
+     * @param opt - Optional logging configuration
+     */
     info(topic: string, action: string, data: any, message?: string, opt?: LoggerOpt): void;
+    /**
+     * Logs an info-level message (alias for info method).
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional descriptive message
+     * @param opt - Optional logging configuration
+     */
     log(topic: string, action: string, data: any, message?: string, opt?: LoggerOpt): void;
+    /**
+     * Logs an error-level message for error conditions.
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag (typically '[EXCEPTION]')
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional error message
+     * @param opt - Optional logging configuration
+     */
     error(topic: string, action: string, data: any, message?: string, opt?: LoggerOpt): void;
+    /**
+     * Logs a warning-level message for potentially harmful situations.
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional warning message
+     * @param opt - Optional logging configuration
+     */
     warn(topic: string, action: string, data: any, message?: string, opt?: LoggerOpt): void;
+    /**
+     * Logs a verbose-level message for most detailed information.
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional verbose message
+     * @param opt - Optional logging configuration
+     */
     verbose(topic: string, action: string, data: any, message?: string, opt?: LoggerOpt): void;
+    /**
+     * Routes the message to the appropriate format-specific logger (M1/M2/M3).
+     *
+     * @param serverity - Log severity level
+     * @param action - Action tag
+     * @param message - Log message
+     * @param data - Message data
+     * @param topic - Topic identifier
+     * @param opt - Optional configuration
+     * @public
+     */
     messageLog(serverity: string, action: string, message: any, data: DataM, topic: string, opt?: LoggerOpt): void;
     summarySuccess(topic: string, appResult: string, appResultCode: string, serviceTime: number, data: DataM, opt?: LoggerOpt): LoggerDto;
     summaryError(topic: string, appResult: string, appResultCode: string, serviceTime: number, data: DataM, stack?: string[], opt?: LoggerOpt): LoggerDto;

package/dist/core/formatters/logger.formatter.js

@@ -37,36 +37,143 @@ exports.LoggerFormat = void 0;
 const logger_constants_1 = require("../../constants/logger.constants");
 const message_formatter_helper_1 = require("../../helpers/message-formatter.helper");
 const logUtil = __importStar(require("../../helpers/log.helper"));
+/**
+ * LoggerFormat - Format-specific logger for M1, M2, and M3 message protocols.
+ *
+ * Provides logging capabilities for different message formats used in distributed systems:
+ * - **M1**: Message broker/queue operations (Kafka, RabbitMQ, etc.)
+ * - **M2**: HTTP/protocol operations (REST APIs, GraphQL, etc.)
+ * - **M3**: Service-to-service operations (gRPC, internal services, databases, etc.)
+ *
+ * Each format requires specific data structures with appropriate header and metadata fields.
+ *
+ * @example
+ * ```typescript
+ * // M1 Format
+ * const loggerM1 = new LoggerFormat(baseLogger, 'M1');
+ * loggerM1.info('order.topic', '[CONSUMING]', dataM1, 'Processing order');
+ *
+ * // M2 Format
+ * const loggerM2 = new LoggerFormat(baseLogger, 'M2');
+ * loggerM2.info('api.users', '[HTTP_REQUEST]', dataM2, 'User creation');
+ *
+ * // M3 Format
+ * const loggerM3 = new LoggerFormat(baseLogger, 'M3');
+ * loggerM3.debug('db.users', '[DB_REQUEST]', dataM3, 'Query users');
+ * ```
+ */
 class LoggerFormat {
     messageType;
     logger;
+    /**
+     * Creates a new LoggerFormat instance.
+     *
+     * @param logger - BaseAppLogger instance for actual logging
+     * @param messageType - Message format type ('M1', 'M2', or 'M3')
+     */
     constructor(logger, messageType) {
         this.messageType = messageType;
         this.logger = logger;
     }
+    /**
+     * Internal method to handle log level checking and routing.
+     *
+     * @param level - Log level
+     * @param topic - Topic identifier
+     * @param action - Action tag
+     * @param data - Message data
+     * @param message - Optional message text
+     * @param opt - Optional configuration
+     * @private
+     */
     logMethod(level, topic, action, data, message, opt) {
         if (!logUtil.isLevelEnable(level))
             return;
         this.writeLogCommon(level, topic, action, data, message, opt);
     }
+    /**
+     * Logs a debug-level message for detailed diagnostic information.
+     *
+     * @param topic - Topic or identifier (e.g., 'payment.topic', 'api.users')
+     * @param action - Action tag (e.g., '[CONSUMING]', '[HTTP_REQUEST]')
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional descriptive message
+     * @param opt - Optional logging configuration
+     */
     debug(topic, action, data, message, opt) {
         this.logMethod(logger_constants_1.LOG_LEVELS.DEBUG, topic, action, data, message, opt);
     }
+    /**
+     * Logs an info-level message for general information.
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional descriptive message
+     * @param opt - Optional logging configuration
+     */
     info(topic, action, data, message, opt) {
         this.logMethod(logger_constants_1.LOG_LEVELS.INFO, topic, action, data, message, opt);
     }
+    /**
+     * Logs an info-level message (alias for info method).
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional descriptive message
+     * @param opt - Optional logging configuration
+     */
     log(topic, action, data, message, opt) {
         this.logMethod(logger_constants_1.LOG_LEVELS.INFO, topic, action, data, message, opt);
     }
+    /**
+     * Logs an error-level message for error conditions.
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag (typically '[EXCEPTION]')
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional error message
+     * @param opt - Optional logging configuration
+     */
     error(topic, action, data, message, opt) {
         this.logMethod(logger_constants_1.LOG_LEVELS.ERROR, topic, action, data, message, opt);
     }
+    /**
+     * Logs a warning-level message for potentially harmful situations.
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional warning message
+     * @param opt - Optional logging configuration
+     */
     warn(topic, action, data, message, opt) {
         this.logMethod(logger_constants_1.LOG_LEVELS.WARN, topic, action, data, message, opt);
     }
+    /**
+     * Logs a verbose-level message for most detailed information.
+     *
+     * @param topic - Topic or identifier
+     * @param action - Action tag
+     * @param data - Message data (DataM1I, DataM2I, or DataM3I)
+     * @param message - Optional verbose message
+     * @param opt - Optional logging configuration
+     */
     verbose(topic, action, data, message, opt) {
         this.logMethod(logger_constants_1.LOG_LEVELS.VERBOSE, topic, action, data, message, opt);
     }
+    /**
+     * Routes the message to the appropriate format-specific logger (M1/M2/M3).
+     *
+     * @param serverity - Log severity level
+     * @param action - Action tag
+     * @param message - Log message
+     * @param data - Message data
+     * @param topic - Topic identifier
+     * @param opt - Optional configuration
+     * @public
+     */
     messageLog(serverity, action, message, data, topic, opt) {
         switch (this.messageType) {
             case 'M1':