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

package/dist/helpers/logger-builder.helper.js

@@ -3,101 +3,265 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LoggerDtoBuilder = void 0;
 const logger_dto_1 = require("../models/logger.dto");
 const logger_constants_1 = require("../constants/logger.constants");
+/**
+ * LoggerDtoBuilder - Fluent builder for creating LoggerDto instances.
+ *
+ * Provides a chainable API for constructing logger data transfer objects with all necessary fields.
+ * Each setter method returns 'this' to enable method chaining. The builder pattern ensures
+ * consistent and readable construction of complex logger DTOs.
+ *
+ * @example
+ * ```typescript
+ * const dto = new LoggerDtoBuilder()
+ *   .setLevel('info')
+ *   .setTimestamp('2026-01-12T10:00:00.000Z')
+ *   .setAppName('MyApp')
+ *   .setComponentName('UserService')
+ *   .setAction('[USER_CREATE]')
+ *   .setMessage('User created successfully')
+ *   .setSessionId('sess-123')
+ *   .normalizeEmptyFields()
+ *   .build();
+ * ```
+ */
 class LoggerDtoBuilder {
     dto;
+    /**
+     * Creates a new LoggerDtoBuilder instance with an empty LoggerDto.
+     */
     constructor() {
         this.dto = new logger_dto_1.LoggerDto();
     }
+    /**
+     * Sets the log level.
+     *
+     * @param level - Log level (e.g., 'debug', 'info', 'warn', 'error')
+     * @returns This builder instance for method chaining
+     */
     setLevel(level) {
         this.dto.level = level;
         return this;
     }
+    /**
+     * Sets the timestamp for the log entry.
+     *
+     * @param timestamp - ISO 8601 formatted timestamp string
+     * @returns This builder instance for method chaining
+     */
     setTimestamp(timestamp) {
         this.dto.timestamp = timestamp;
         return this;
     }
+    /**
+     * Sets the application name.
+     *
+     * @param appName - Name of the application
+     * @returns This builder instance for method chaining
+     */
     setAppName(appName) {
         this.dto.appName = appName;
         return this;
     }
+    /**
+     * Sets the component name (optional).
+     * Only sets the value if componentName is provided.
+     *
+     * @param componentName - Name of the component or service
+     * @returns This builder instance for method chaining
+     */
     setComponentName(componentName) {
         if (componentName) {
             this.dto.componentName = componentName;
         }
         return this;
     }
+    /**
+     * Sets the action tag for the log entry.
+     *
+     * @param action - Action identifier (e.g., '[HTTP_REQUEST]', '[DB_QUERY]')
+     * @returns This builder instance for method chaining
+     */
     setAction(action) {
         this.dto.action = action;
         return this;
     }
+    /**
+     * Sets the log message.
+     *
+     * @param message - The log message content
+     * @returns This builder instance for method chaining
+     */
     setMessage(message) {
         this.dto.message = message;
         return this;
     }
+    /**
+     * Sets the instance identifier (typically hostname or container ID).
+     *
+     * @param instance - Instance identifier
+     * @returns This builder instance for method chaining
+     */
     setInstance(instance) {
         this.dto.instance = instance;
         return this;
     }
+    /**
+     * Sets the originating service name.
+     *
+     * @param originateServiceName - Name of the service that originated the log
+     * @returns This builder instance for method chaining
+     */
     setOriginateServiceName(originateServiceName) {
         this.dto.originateServiceName = originateServiceName;
         return this;
     }
+    /**
+     * Sets the record name or identifier.
+     *
+     * @param recordName - Record identifier (e.g., order ID, user ID)
+     * @returns This builder instance for method chaining
+     */
     setRecordName(recordName) {
         this.dto.recordName = recordName;
         return this;
     }
+    /**
+     * Sets the record type (e.g., 'detail', 'summary').
+     *
+     * @param recordType - Type of the log record
+     * @returns This builder instance for method chaining
+     */
     setRecordType(recordType) {
         this.dto.recordType = recordType;
         return this;
     }
+    /**
+     * Sets the session identifier.
+     *
+     * @param sessionId - Session ID for tracking user sessions
+     * @returns This builder instance for method chaining
+     */
     setSessionId(sessionId) {
         this.dto.sessionId = sessionId;
         return this;
     }
+    /**
+     * Sets the transaction identifier.
+     *
+     * @param transactionId - Transaction ID for tracking distributed transactions
+     * @returns This builder instance for method chaining
+     */
     setTransactionId(transactionId) {
         this.dto.transactionId = transactionId;
         return this;
     }
+    /**
+     * Sets the communication channel.
+     *
+     * @param channel - Channel identifier (e.g., 'web', 'mobile', 'api')
+     * @returns This builder instance for method chaining
+     */
     setChannel(channel) {
         this.dto.channel = channel;
         return this;
     }
+    /**
+     * Sets the component version.
+     *
+     * @param componentVersion - Version of the component (e.g., '1.0.0')
+     * @returns This builder instance for method chaining
+     */
     setComponentVersion(componentVersion) {
         this.dto.componentVersion = componentVersion;
         return this;
     }
+    /**
+     * Sets the use case name.
+     *
+     * @param useCase - Name of the use case being executed
+     * @returns This builder instance for method chaining
+     */
     setUseCase(useCase) {
         this.dto.useCase = useCase;
         return this;
     }
+    /**
+     * Sets the use case step.
+     *
+     * @param useCaseStep - Specific step within the use case
+     * @returns This builder instance for method chaining
+     */
     setUseCaseStep(useCaseStep) {
         this.dto.useCaseStep = useCaseStep;
         return this;
     }
+    /**
+     * Sets the user identifier.
+     *
+     * @param user - User identifier (e.g., email, username, user ID)
+     * @returns This builder instance for method chaining
+     */
     setUser(user) {
         this.dto.user = user;
         return this;
     }
+    /**
+     * Sets the device identifier(s).
+     *
+     * @param device - Single device identifier or array of identifiers
+     * @returns This builder instance for method chaining
+     */
     setDevice(device) {
         this.dto.device = device;
         return this;
     }
+    /**
+     * Sets the public identifier(s).
+     *
+     * @param public_ - Single public identifier or array of identifiers
+     * @returns This builder instance for method chaining
+     */
     setPublic(public_) {
         this.dto.public = public_;
         return this;
     }
+    /**
+     * Sets the application result description.
+     *
+     * @param appResult - Result description (e.g., 'Success', 'Failed')
+     * @returns This builder instance for method chaining
+     */
     setAppResult(appResult) {
         this.dto.appResult = appResult;
         return this;
     }
+    /**
+     * Sets the application result code.
+     *
+     * @param appResultCode - Result code (e.g., '200', '500', 'ERR_001')
+     * @returns This builder instance for method chaining
+     */
     setAppResultCode(appResultCode) {
         this.dto.appResultCode = appResultCode;
         return this;
     }
+    /**
+     * Sets the service processing time in milliseconds.
+     *
+     * @param serviceTime - Processing duration in milliseconds
+     * @returns This builder instance for method chaining
+     */
     setServiceTime(serviceTime) {
         this.dto.serviceTime = serviceTime;
         return this;
     }
+    /**
+     * Sets the error stack trace (optional).
+     * Only sets the value if stack is provided and not empty.
+     *
+     * @param stack - Array of stack trace lines
+     * @returns This builder instance for method chaining
+     */
     setStack(stack) {
         if (stack) {
             this.dto.stack = stack;
@@ -105,7 +269,21 @@ class LoggerDtoBuilder {
         return this;
     }
     /**
-     * Replace empty strings with 'none'
+     * Normalizes empty string fields by replacing them with DEFAULT_VALUES.NONE ('none').
+     *
+     * Iterates through all DTO properties and replaces any empty string values
+     * with the default 'none' value for consistency in log output.
+     *
+     * @returns This builder instance for method chaining
+     *
+     * @example
+     * ```typescript
+     * const dto = new LoggerDtoBuilder()
+     *   .setLevel('info')
+     *   .setMessage('')  // Empty string
+     *   .normalizeEmptyFields()  // Converts empty string to 'none'
+     *   .build();
+     * ```
      */
     normalizeEmptyFields() {
         Object.keys(this.dto).forEach((key) => {
@@ -117,7 +295,21 @@ class LoggerDtoBuilder {
         return this;
     }
     /**
-     * Merge additional options into the DTO
+     * Merges additional options into the DTO.
+     *
+     * Takes an optional object of additional fields and merges them into the DTO.
+     * Empty string values in the options are normalized to DEFAULT_VALUES.NONE.
+     *
+     * @param opt - Optional record of additional fields to merge
+     * @returns This builder instance for method chaining
+     *
+     * @example
+     * ```typescript
+     * const dto = new LoggerDtoBuilder()
+     *   .setLevel('info')
+     *   .mergeOptions({ broker: 'kafka', customField: 'value' })
+     *   .build();
+     * ```
      */
     mergeOptions(opt) {
         if (opt) {
@@ -131,6 +323,19 @@ class LoggerDtoBuilder {
         }
         return this;
     }
+    /**
+     * Builds and returns the final LoggerDto instance.
+     *
+     * @returns The constructed LoggerDto object
+     *
+     * @example
+     * ```typescript
+     * const dto = new LoggerDtoBuilder()
+     *   .setLevel('info')
+     *   .setMessage('Test message')
+     *   .build();
+     * ```
+     */
     build() {
         return this.dto;
     }

package/dist/helpers/logger-builder.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger-builder.helper.js","sourceRoot":"","sources":["../../src/helpers/logger-builder.helper.ts"],"names":[],"mappings":";;;AAAA,qDAAiD;AACjD,oEAA+D;AAE/D,MAAa,gBAAgB;IACnB,GAAG,CAAY;IAEvB;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,sBAAS,EAAE,CAAC;IAC7B,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY,CAAC,SAAiB;QAC5B,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB,CAAC,aAAsB;QACrC,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,aAAa,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,MAAc;QACtB,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,WAAW,CAAC,QAAgB;QAC1B,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uBAAuB,CAAC,oBAA4B;QAClD,IAAI,CAAC,GAAG,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,UAAkB;QAC9B,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,UAAkB;QAC9B,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY,CAAC,SAAiB;QAC5B,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB,CAAC,aAAqB;QACpC,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,aAAa,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mBAAmB,CAAC,gBAAwB;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,WAAmB;QAChC,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,MAAyB;QACjC,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,OAA0B;QAClC,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY,CAAC,SAAiB;QAC5B,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB,CAAC,aAAqB;QACpC,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,aAAa,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,WAAmB;QAChC,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,KAAgB;QACvB,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC9C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,iCAAc,CAAC,IAAI,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,GAA6B;QACxC,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,aAAa,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACzC,IAAI,OAAO,aAAa,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC;oBACxE,aAAa,CAAC,GAAG,CAAC,GAAG,iCAAc,CAAC,IAAI,CAAC;gBAC3C,CAAC;YACH,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;CACF;AA9JD,4CA8JC"}
+{"version":3,"file":"logger-builder.helper.js","sourceRoot":"","sources":["../../src/helpers/logger-builder.helper.ts"],"names":[],"mappings":";;;AAAA,qDAAiD;AACjD,oEAA+D;AAE/D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,gBAAgB;IACnB,GAAG,CAAY;IAEvB;;OAEG;IACH;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,sBAAS,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,SAAiB;QAC5B,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,aAAsB;QACrC,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,aAAa,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,MAAc;QACtB,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,QAAgB;QAC1B,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,uBAAuB,CAAC,oBAA4B;QAClD,IAAI,CAAC,GAAG,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,UAAkB;QAC9B,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,UAAkB;QAC9B,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,SAAiB;QAC5B,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,aAAqB;QACpC,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,aAAa,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,gBAAwB;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,WAAmB;QAChC,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,MAAyB;QACjC,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,OAA0B;QAClC,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,SAAiB;QAC5B,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,aAAqB;QACpC,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,aAAa,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,WAAmB;QAChC,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,KAAgB;QACvB,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB;QAClB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC9C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,iCAAc,CAAC,IAAI,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,GAA6B;QACxC,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,aAAa,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACzC,IAAI,OAAO,aAAa,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC;oBACxE,aAAa,CAAC,GAAG,CAAC,GAAG,iCAAc,CAAC,IAAI,CAAC;gBAC3C,CAAC;YACH,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;CACF;AAtVD,4CAsVC"}

package/dist/helpers/message-formatter.helper.d.ts

@@ -1,20 +1,87 @@
 /**
- * Format a message of any type to string
- * Optimized for common cases (strings) for better performance
+ * Formats a message of any type to string representation.
+ *
+ * Optimized for performance with fast paths for common cases (strings, numbers).
+ * Handles various input types:
+ * - Strings: returned as-is (fast path)
+ * - Numbers: converted to string
+ * - Functions: executed and result converted to string
+ * - null/undefined: returns empty string
+ * - Objects: JSON stringified with sensitive field masking
+ *
+ * @param message - The message to format (can be any type)
+ * @returns String representation of the message
+ *
+ * @example
+ * ```typescript
+ * formatMessage('Hello'); // "Hello"
+ * formatMessage(123); // "123"
+ * formatMessage({ key: 'value' }); // "{\"key\":\"value\"}"
+ * formatMessage(null); // ""
+ * formatMessage(() => 'computed'); // "computed"
+ * ```
  */
 export declare function formatMessage(message: any): string;
 /**
- * Set value or return default 'none'
- * Optimized for performance with faster checks
+ * Returns the provided value or the default 'none' string if the value is empty.
+ *
+ * Optimized for performance with faster checks. Returns DEFAULT_VALUES.NONE if:
+ * - value is undefined
+ * - value is an empty string
+ * - value has length of 0
+ *
+ * @param value - The value to check (optional string)
+ * @returns The original value if non-empty, or DEFAULT_VALUES.NONE ('none')
+ *
+ * @example
+ * ```typescript
+ * setValueOrDefault('test'); // "test"
+ * setValueOrDefault(''); // "none"
+ * setValueOrDefault(undefined); // "none"
+ * setValueOrDefault('  '); // "  " (whitespace is considered non-empty)
+ * ```
  */
 export declare function setValueOrDefault(value?: string): string;
 /**
- * Truncate message if it exceeds max length
- * Optimized with early return for messages within limit
+ * Truncates a message if it exceeds the specified maximum length.
+ *
+ * Optimized with early return for messages within the limit. Adds '...' to indicate truncation.
+ * Uses DEFAULT_VALUES.MAX_MESSAGE_LENGTH as the default limit.
+ *
+ * @param message - The message string to truncate
+ * @param maxLength - Maximum allowed length (default: DEFAULT_VALUES.MAX_MESSAGE_LENGTH)
+ * @returns The original message if within limit, or truncated message with '...' appended
+ *
+ * @example
+ * ```typescript
+ * truncateMessage('Short', 100); // "Short"
+ * truncateMessage('A very long message...', 10); // "A very lon..."
+ * truncateMessage('Hello World'); // Uses default max length
+ * ```
  */
 export declare function truncateMessage(message: string, maxLength?: number): string;
 /**
- * Merge broker option into LoggerOpt
+ * Merges broker information into a LoggerOpt object.
+ *
+ * Creates a new object with the broker field merged in. If opt is provided,
+ * spreads its properties and adds/overwrites the broker field. If opt is undefined,
+ * creates a new object with only the broker field.
+ *
+ * @param opt - Optional configuration object to merge with
+ * @param broker - Broker identifier to add to the configuration
+ * @returns New object with broker field merged in
+ *
+ * @example
+ * ```typescript
+ * // With existing options
+ * const opts = { customField: 'value' };
+ * mergeBrokerOption(opts, 'kafka');
+ * // Result: { customField: 'value', broker: 'kafka' }
+ *
+ * // Without existing options
+ * mergeBrokerOption(undefined, 'rabbitmq');
+ * // Result: { broker: 'rabbitmq' }
+ * ```
  */
 export declare function mergeBrokerOption<T extends {
     broker?: string;

package/dist/helpers/message-formatter.helper.js

@@ -40,8 +40,27 @@ exports.mergeBrokerOption = mergeBrokerOption;
 const logger_constants_1 = require("../constants/logger.constants");
 const logUtil = __importStar(require("./log.helper"));
 /**
- * Format a message of any type to string
- * Optimized for common cases (strings) for better performance
+ * Formats a message of any type to string representation.
+ *
+ * Optimized for performance with fast paths for common cases (strings, numbers).
+ * Handles various input types:
+ * - Strings: returned as-is (fast path)
+ * - Numbers: converted to string
+ * - Functions: executed and result converted to string
+ * - null/undefined: returns empty string
+ * - Objects: JSON stringified with sensitive field masking
+ *
+ * @param message - The message to format (can be any type)
+ * @returns String representation of the message
+ *
+ * @example
+ * ```typescript
+ * formatMessage('Hello'); // "Hello"
+ * formatMessage(123); // "123"
+ * formatMessage({ key: 'value' }); // "{\"key\":\"value\"}"
+ * formatMessage(null); // ""
+ * formatMessage(() => 'computed'); // "computed"
+ * ```
  */
 function formatMessage(message) {
     // Fast path for most common case
@@ -63,15 +82,43 @@ function formatMessage(message) {
     return logUtil.logStringify(message);
 }
 /**
- * Set value or return default 'none'
- * Optimized for performance with faster checks
+ * Returns the provided value or the default 'none' string if the value is empty.
+ *
+ * Optimized for performance with faster checks. Returns DEFAULT_VALUES.NONE if:
+ * - value is undefined
+ * - value is an empty string
+ * - value has length of 0
+ *
+ * @param value - The value to check (optional string)
+ * @returns The original value if non-empty, or DEFAULT_VALUES.NONE ('none')
+ *
+ * @example
+ * ```typescript
+ * setValueOrDefault('test'); // "test"
+ * setValueOrDefault(''); // "none"
+ * setValueOrDefault(undefined); // "none"
+ * setValueOrDefault('  '); // "  " (whitespace is considered non-empty)
+ * ```
  */
 function setValueOrDefault(value) {
     return (value && value.length > 0) ? value : logger_constants_1.DEFAULT_VALUES.NONE;
 }
 /**
- * Truncate message if it exceeds max length
- * Optimized with early return for messages within limit
+ * Truncates a message if it exceeds the specified maximum length.
+ *
+ * Optimized with early return for messages within the limit. Adds '...' to indicate truncation.
+ * Uses DEFAULT_VALUES.MAX_MESSAGE_LENGTH as the default limit.
+ *
+ * @param message - The message string to truncate
+ * @param maxLength - Maximum allowed length (default: DEFAULT_VALUES.MAX_MESSAGE_LENGTH)
+ * @returns The original message if within limit, or truncated message with '...' appended
+ *
+ * @example
+ * ```typescript
+ * truncateMessage('Short', 100); // "Short"
+ * truncateMessage('A very long message...', 10); // "A very lon..."
+ * truncateMessage('Hello World'); // Uses default max length
+ * ```
  */
 function truncateMessage(message, maxLength = logger_constants_1.DEFAULT_VALUES.MAX_MESSAGE_LENGTH) {
     // Fast path: most messages are within limit
@@ -81,7 +128,27 @@ function truncateMessage(message, maxLength = logger_constants_1.DEFAULT_VALUES.
     return message.substring(0, maxLength) + '...';
 }
 /**
- * Merge broker option into LoggerOpt
+ * Merges broker information into a LoggerOpt object.
+ *
+ * Creates a new object with the broker field merged in. If opt is provided,
+ * spreads its properties and adds/overwrites the broker field. If opt is undefined,
+ * creates a new object with only the broker field.
+ *
+ * @param opt - Optional configuration object to merge with
+ * @param broker - Broker identifier to add to the configuration
+ * @returns New object with broker field merged in
+ *
+ * @example
+ * ```typescript
+ * // With existing options
+ * const opts = { customField: 'value' };
+ * mergeBrokerOption(opts, 'kafka');
+ * // Result: { customField: 'value', broker: 'kafka' }
+ *
+ * // Without existing options
+ * mergeBrokerOption(undefined, 'rabbitmq');
+ * // Result: { broker: 'rabbitmq' }
+ * ```
  */
 function mergeBrokerOption(opt, broker) {
     if (opt) {

package/dist/helpers/message-formatter.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"message-formatter.helper.js","sourceRoot":"","sources":["../../src/helpers/message-formatter.helper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,sCAsBC;AAMD,8CAEC;AAMD,0CAMC;AAKD,8CAQC;AA9DD,oEAA+D;AAC/D,sDAAwC;AAExC;;;GAGG;AACH,SAAgB,aAAa,CAAC,OAAY;IACxC,iCAAiC;IACjC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,qBAAqB;IACrB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;IAED,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED,wBAAwB;IACxB,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,sCAAsC;IACtC,OAAO,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;AACvC,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,iCAAc,CAAC,IAAI,CAAC;AACnE,CAAC;AAED;;;GAGG;AACH,SAAgB,eAAe,CAAC,OAAe,EAAE,YAAoB,iCAAc,CAAC,kBAAkB;IACpG,4CAA4C;IAC5C,IAAI,OAAO,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC;AACjD,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAC/B,GAAkB,EAClB,MAAe;IAEf,IAAI,GAAG,EAAE,CAAC;QACR,OAAO,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,CAAC;IAC5B,CAAC;IACD,OAAO,EAAE,MAAM,EAAO,CAAC;AACzB,CAAC"}
+{"version":3,"file":"message-formatter.helper.js","sourceRoot":"","sources":["../../src/helpers/message-formatter.helper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,sCAsBC;AAqBD,8CAEC;AAmBD,0CAMC;AAyBD,8CAQC;AAjID,oEAA+D;AAC/D,sDAAwC;AAExC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,aAAa,CAAC,OAAY;IACxC,iCAAiC;IACjC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,qBAAqB;IACrB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;IAED,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED,wBAAwB;IACxB,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,sCAAsC;IACtC,OAAO,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,iCAAc,CAAC,IAAI,CAAC;AACnE,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,eAAe,CAAC,OAAe,EAAE,YAAoB,iCAAc,CAAC,kBAAkB;IACpG,4CAA4C;IAC5C,IAAI,OAAO,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,iBAAiB,CAC/B,GAAkB,EAClB,MAAe;IAEf,IAAI,GAAG,EAAE,CAAC;QACR,OAAO,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,CAAC;IAC5B,CAAC;IACD,OAAO,EAAE,MAAM,EAAO,CAAC;AACzB,CAAC"}

package/dist/helpers/time-performance.helper.d.ts

@@ -1,7 +1,68 @@
+/**
+ * TimeDiff - High-resolution timer for measuring elapsed time.
+ *
+ * Uses Node.js performance API to provide precise time measurements in milliseconds.
+ * Useful for tracking operation duration, performance monitoring, and logging service times.
+ *
+ * @example
+ * ```typescript
+ * const timer = new TimeDiff();
+ * await someOperation();
+ * const duration = timer.diff();
+ * console.log(`Operation took ${duration}ms`);
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using static start method
+ * const timer = TimeDiff.start();
+ * processData();
+ * console.log(`Elapsed: ${timer.end()}ms`);
+ * ```
+ */
 export declare class TimeDiff {
     private startTime;
+    /**
+     * Creates a new TimeDiff instance and starts the timer.
+     * The start time is captured immediately using high-resolution performance timer.
+     */
     constructor();
+    /**
+     * Static factory method to create and start a new timer instance.
+     *
+     * @returns A new TimeDiff instance with the timer started
+     *
+     * @example
+     * ```typescript
+     * const timer = TimeDiff.start();
+     * ```
+     */
     static start(): TimeDiff;
+    /**
+     * Calculates and returns the elapsed time since the timer was started.
+     * Returns the duration in milliseconds with 3 decimal places precision.
+     *
+     * @returns Elapsed time in milliseconds (e.g., 123.456)
+     *
+     * @example
+     * ```typescript
+     * const timer = new TimeDiff();
+     * await operation();
+     * const ms = timer.diff(); // e.g., 150.234
+     * ```
+     */
     diff(): number;
+    /**
+     * Alias for diff() method. Returns the elapsed time since the timer was started.
+     *
+     * @returns Elapsed time in milliseconds
+     *
+     * @example
+     * ```typescript
+     * const timer = TimeDiff.start();
+     * processData();
+     * const duration = timer.end();
+     * ```
+     */
     end(): number;
 }