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

package/dist/helpers/time-performance.helper.js

@@ -2,17 +2,78 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TimeDiff = void 0;
 const perf_hooks_1 = require("perf_hooks");
+/**
+ * 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`);
+ * ```
+ */
 class TimeDiff {
     startTime;
+    /**
+     * Creates a new TimeDiff instance and starts the timer.
+     * The start time is captured immediately using high-resolution performance timer.
+     */
     constructor() {
         this.startTime = perf_hooks_1.performance.now();
     }
+    /**
+     * 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() {
         return new 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() {
-        return Math.round(perf_hooks_1.performance.now() - this.startTime);
+        return parseFloat((perf_hooks_1.performance.now() - this.startTime).toFixed(3));
     }
+    /**
+     * 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() {
         return this.diff();
     }

package/dist/helpers/time-performance.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"time-performance.helper.js","sourceRoot":"","sources":["../../src/helpers/time-performance.helper.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAEzC,MAAa,QAAQ;IACX,SAAS,CAAS;IAE1B;QACE,IAAI,CAAC,SAAS,GAAG,wBAAW,CAAC,GAAG,EAAE,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,KAAK;QACjB,OAAO,IAAI,QAAQ,EAAE,CAAC;IACxB,CAAC;IAEM,IAAI;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,wBAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAEM,GAAG;QACR,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IACrB,CAAC;CACF;AAlBD,4BAkBC"}
+{"version":3,"file":"time-performance.helper.js","sourceRoot":"","sources":["../../src/helpers/time-performance.helper.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,QAAQ;IACX,SAAS,CAAS;IAE1B;;;OAGG;IACH;QACE,IAAI,CAAC,SAAS,GAAG,wBAAW,CAAC,GAAG,EAAE,CAAC;IACrC,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK;QACjB,OAAO,IAAI,QAAQ,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,IAAI;QACT,OAAO,UAAU,CAAC,CAAC,wBAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;OAWG;IACI,GAAG;QACR,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IACrB,CAAC;CACF;AAzDD,4BAyDC"}

package/dist/models/logger.dto.d.ts

@@ -1,28 +1,71 @@
+/**
+ * LoggerDto - Data Transfer Object for structured log entries.
+ *
+ * Represents a complete log record with all metadata fields used throughout the logging system.
+ * This DTO is used to standardize log format across different logger types and ensure
+ * consistent structure for log aggregation, analysis, and monitoring.
+ *
+ * @example
+ * ```typescript
+ * const dto = new LoggerDto();
+ * dto.level = 'info';
+ * dto.timestamp = '2026-01-12T10:00:00.000Z';
+ * dto.message = 'User logged in';
+ * dto.appName = 'MyApp';
+ * dto.sessionId = 'sess-123';
+ * ```
+ */
 export declare class LoggerDto {
+    /** Log level (e.g., 'debug', 'info', 'warn', 'error', 'verbose') */
     level: string;
+    /** ISO 8601 formatted timestamp of the log entry */
     timestamp: string;
+    /** Name of the application generating the log */
     appName: string;
+    /** Name of the component or service within the application */
     componentName: string;
+    /** Version of the component */
     componentVersion: string;
+    /** Device identifier(s) - can be a single string or array of strings */
     device: string | string[];
+    /** Action tag categorizing the log entry (e.g., '[HTTP_REQUEST]', '[DB_QUERY]') */
     action: string;
+    /** The main log message content */
     message: string;
+    /** Global unique identifier for the log entry */
     guid: string;
+    /** Instance identifier (hostname, container ID, or pod name) */
     instance: string;
+    /** Name of the service that originated the log */
     originateServiceName: string;
+    /** Record identifier (e.g., order ID, user ID, transaction reference) */
     recordName: string;
+    /** Type of record ('detail' for regular logs, 'summary' for aggregated logs) */
     recordType: string;
+    /** Session identifier for tracking user sessions */
     sessionId: string;
+    /** Transaction identifier for distributed tracing */
     transactionId: string;
+    /** Public identifier(s) - can be a single string or array */
     public: string | string[];
+    /** Message broker identifier (e.g., 'kafka', 'rabbitmq', 'redis') */
     broker: string;
+    /** Communication channel (e.g., 'web', 'mobile', 'api', 'queue') */
     channel: string;
+    /** Use case name being executed */
     useCase: string;
+    /** Specific step within the use case */
     useCaseStep: string;
+    /** User identifier (email, username, or user ID) */
     user: string;
+    /** Application result description (e.g., 'Success', 'Failed', 'Completed') */
     appResult: string;
+    /** Application result code (e.g., '200', '500', 'ERR_001') */
     appResultCode: string;
+    /** Service processing time in milliseconds */
     serviceTime: number;
+    /** Error stack trace as array of strings (populated for error logs) */
     stack: string[];
+    /** DateTime string (alternative timestamp format, optional) */
     dateTime?: string;
 }

package/dist/models/logger.dto.js

@@ -1,32 +1,75 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LoggerDto = void 0;
+/**
+ * LoggerDto - Data Transfer Object for structured log entries.
+ *
+ * Represents a complete log record with all metadata fields used throughout the logging system.
+ * This DTO is used to standardize log format across different logger types and ensure
+ * consistent structure for log aggregation, analysis, and monitoring.
+ *
+ * @example
+ * ```typescript
+ * const dto = new LoggerDto();
+ * dto.level = 'info';
+ * dto.timestamp = '2026-01-12T10:00:00.000Z';
+ * dto.message = 'User logged in';
+ * dto.appName = 'MyApp';
+ * dto.sessionId = 'sess-123';
+ * ```
+ */
 class LoggerDto {
+    /** Log level (e.g., 'debug', 'info', 'warn', 'error', 'verbose') */
     level;
+    /** ISO 8601 formatted timestamp of the log entry */
     timestamp;
+    /** Name of the application generating the log */
     appName;
+    /** Name of the component or service within the application */
     componentName;
+    /** Version of the component */
     componentVersion;
+    /** Device identifier(s) - can be a single string or array of strings */
     device;
+    /** Action tag categorizing the log entry (e.g., '[HTTP_REQUEST]', '[DB_QUERY]') */
     action;
+    /** The main log message content */
     message;
+    /** Global unique identifier for the log entry */
     guid;
+    /** Instance identifier (hostname, container ID, or pod name) */
     instance;
+    /** Name of the service that originated the log */
     originateServiceName;
+    /** Record identifier (e.g., order ID, user ID, transaction reference) */
     recordName;
+    /** Type of record ('detail' for regular logs, 'summary' for aggregated logs) */
     recordType;
+    /** Session identifier for tracking user sessions */
     sessionId;
+    /** Transaction identifier for distributed tracing */
     transactionId;
+    /** Public identifier(s) - can be a single string or array */
     public;
+    /** Message broker identifier (e.g., 'kafka', 'rabbitmq', 'redis') */
     broker;
+    /** Communication channel (e.g., 'web', 'mobile', 'api', 'queue') */
     channel;
+    /** Use case name being executed */
     useCase;
+    /** Specific step within the use case */
     useCaseStep;
+    /** User identifier (email, username, or user ID) */
     user;
+    /** Application result description (e.g., 'Success', 'Failed', 'Completed') */
     appResult;
+    /** Application result code (e.g., '200', '500', 'ERR_001') */
     appResultCode;
+    /** Service processing time in milliseconds */
     serviceTime;
+    /** Error stack trace as array of strings (populated for error logs) */
     stack;
+    /** DateTime string (alternative timestamp format, optional) */
     dateTime;
 }
 exports.LoggerDto = LoggerDto;

package/dist/models/logger.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.dto.js","sourceRoot":"","sources":["../../src/models/logger.dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,SAAS;IACpB,KAAK,CAAU;IACf,SAAS,CAAU;IACnB,OAAO,CAAU;IACjB,aAAa,CAAU;IACvB,gBAAgB,CAAU;IAC1B,MAAM,CAAqB;IAC3B,MAAM,CAAU;IAChB,OAAO,CAAU;IACjB,IAAI,CAAU;IACd,QAAQ,CAAU;IAClB,oBAAoB,CAAU;IAC9B,UAAU,CAAU;IACpB,UAAU,CAAU;IACpB,SAAS,CAAU;IACnB,aAAa,CAAU;IACvB,MAAM,CAAqB;IAC3B,MAAM,CAAU;IAChB,OAAO,CAAU;IAEjB,OAAO,CAAU;IACjB,WAAW,CAAU;IACrB,IAAI,CAAU;IAEd,SAAS,CAAU;IACnB,aAAa,CAAU;IACvB,WAAW,CAAU;IACrB,KAAK,CAAY;IAEjB,QAAQ,CAAU;CACnB;AA9BD,8BA8BC"}
+{"version":3,"file":"logger.dto.js","sourceRoot":"","sources":["../../src/models/logger.dto.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,SAAS;IACpB,oEAAoE;IACpE,KAAK,CAAU;IAEf,oDAAoD;IACpD,SAAS,CAAU;IAEnB,iDAAiD;IACjD,OAAO,CAAU;IAEjB,8DAA8D;IAC9D,aAAa,CAAU;IAEvB,+BAA+B;IAC/B,gBAAgB,CAAU;IAE1B,wEAAwE;IACxE,MAAM,CAAqB;IAE3B,mFAAmF;IACnF,MAAM,CAAU;IAEhB,mCAAmC;IACnC,OAAO,CAAU;IAEjB,iDAAiD;IACjD,IAAI,CAAU;IAEd,gEAAgE;IAChE,QAAQ,CAAU;IAElB,kDAAkD;IAClD,oBAAoB,CAAU;IAE9B,yEAAyE;IACzE,UAAU,CAAU;IAEpB,gFAAgF;IAChF,UAAU,CAAU;IAEpB,oDAAoD;IACpD,SAAS,CAAU;IAEnB,qDAAqD;IACrD,aAAa,CAAU;IAEvB,6DAA6D;IAC7D,MAAM,CAAqB;IAE3B,qEAAqE;IACrE,MAAM,CAAU;IAEhB,oEAAoE;IACpE,OAAO,CAAU;IAEjB,mCAAmC;IACnC,OAAO,CAAU;IAEjB,wCAAwC;IACxC,WAAW,CAAU;IAErB,oDAAoD;IACpD,IAAI,CAAU;IAEd,8EAA8E;IAC9E,SAAS,CAAU;IAEnB,8DAA8D;IAC9D,aAAa,CAAU;IAEvB,8CAA8C;IAC9C,WAAW,CAAU;IAErB,uEAAuE;IACvE,KAAK,CAAY;IAEjB,+DAA+D;IAC/D,QAAQ,CAAU;CACnB;AA9ED,8BA8EC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eqxjs/nest-logger",
-  "version": "3.1.0-beta.12",
+  "version": "3.1.0-beta.14",
   "description": "NestJS logger module for EQXJS",
   "author": "Atit Plangson",
   "license": "ISC",