node-ansi-logger 1.9.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Luligu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# NodeStorage
+
+AnsiLogger is a lightweight, customizable color logger for Node.js. 
+
+## Features
+
+- Simple and intuitive API for data logging.
+- Customizable colors and apperance.
+- It is also possible to pass a top level logger (like Homebridge or Matter logger) and AnsiLogger will use it 
+for output instead of console.
+- Includes also a fully customizable stringify funtions with colors.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js installed on your machine.
+- node-ansi-logger has no dependencies!
+
+### Installation
+
+To get started with AnsiLogger in your package
+
+```bash
+npm install node-ansi-logger
+```
+
+# Usage
+
+## Initializing AnsiLogger:
+
+Create an instance of AnsiLogger.
+
+```
+import { AnsiLogger, AnsiLoggerParams, LogLevel } from 'node-ansi-logger';
+```
+
+```
+const log = new AnsiLogger({logName: '<your name>'}); // Eventually other params in AnsiLoggerParams
+```
+
+To import the stringify functions
+```
+import { stringify, payloadStringify, colorStringify, mqttStringify, debugStringify } from 'node-ansi-logger';
+```
+
+## Using the logger:
+
+```
+log.debug('Debug message...', ...parameters);
+log.info('Info message...', ...parameters);
+log.warn('Warning message', ...parameters);
+log.error('Error message', ...parameters);
+log(LogLevel.WARN, 'Warning message', ...parameters)
+```
+
+## Using the logger with colors inside the message:
+
+```
+log.debug(`Debug message ${YELLOW}with yellow part${db}`, ...);
+```
+
+## Using the logger internal timer:
+```
+log.startTimer('Time sensitive code started')
+log.stopTimer('Time sensitive code finished')
+```
+
+## Using the stringify function:
+```
+stringify({...})
+colorStringify({...})
+```
+
+# Screenshot
+
+![Example Image](https://github.com/Luligu/node-ansi-logger/blob/main/Screenshot.png)
+
+# Contributing
+
+Contributions to AnsiLogger are welcome.
+
+# License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './logger.js';
+export * from './stringify.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './logger.js';
+export * from './stringify.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}

package/dist/logger.d.ts

@@ -0,0 +1,186 @@
+/**
+ * This file contains the class CustomLogger.
+ *
+ * @file logger.ts
+ * @author Luca Liguori
+ * @date 2023-06-01
+ * @version 1.8.8
+ *
+ * All rights reserved.
+ *
+ */
+export declare const RESET = "\u001B[40;0m";
+export declare const BRIGHT = "\u001B[1m";
+export declare const DIM = "\u001B[2m";
+export declare const UNDERLINE = "\u001B[4m";
+export declare const UNDERLINEOFF = "\u001B[24m";
+export declare const BLINK = "\u001B[5m";
+export declare const BLINKOFF = "\u001B[25m";
+export declare const REVERSE = "\u001B[7m";
+export declare const REVERSEOFF = "\u001B[27m";
+export declare const HIDDEN = "\u001B[8m";
+export declare const HIDDENOFF = "\u001B[28m";
+export declare const CURSORSAVE = "\u001B[s";
+export declare const CURSORRESTORE = "\u001B[u";
+export declare const BLACK = "\u001B[30m";
+export declare const RED = "\u001B[31m";
+export declare const GREEN = "\u001B[32m";
+export declare const YELLOW = "\u001B[33m";
+export declare const BLUE = "\u001B[34m";
+export declare const MAGENTA = "\u001B[35m";
+export declare const CYAN = "\u001B[36m";
+export declare const LIGHT_GREY = "\u001B[37m";
+export declare const GREY = "\u001B[90m";
+export declare const WHITE = "\u001B[97m";
+export declare const db = "\u001B[38;5;247m";
+export declare const nf = "\u001B[38;5;255m";
+export declare const wr = "\u001B[38;5;220m";
+export declare const er = "\u001B[38;5;9m";
+export declare const rs = "\u001B[40;0m";
+export declare const rk = "\u001B[K";
+export declare const dn = "\u001B[38;5;33m";
+export declare const gn = "\u001B[38;5;35m";
+export declare const idn = "\u001B[48;5;21m\u001B[38;5;255m";
+export declare const ign = "\u001B[48;5;22m\u001B[38;5;255m";
+export declare const zb = "\u001B[38;5;207m";
+export declare const hk = "\u001B[38;5;79m";
+export declare const pl = "\u001B[32m";
+export declare const id = "\u001B[37;44m";
+export declare const or = "\u001B[38;5;208m";
+/**
+ * LogLevel enumeration to specify the logging level.
+ */
+export declare const enum LogLevel {
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error",
+    DEBUG = "debug"
+}
+/**
+ * Logger interface for custom loggers that can be passed to AnsiLogger for output instead of console output.
+ */
+export interface Logger {
+    debug: (...data: any[]) => void;
+    info: (...data: any[]) => void;
+    warn: (...data: any[]) => void;
+    error: (...data: any[]) => void;
+    log: (level: LogLevel, message: string, ...parameters: any[]) => void;
+}
+/**
+ * TimestampFormat enumeration to specify the format of timestamps in log messages.
+ */
+export declare const enum TimestampFormat {
+    ISO = 0,
+    LOCAL_DATE = 1,
+    LOCAL_TIME = 2,
+    LOCAL_DATE_TIME = 3,
+    TIME_MILLIS = 4,
+    HOMEBRIDGE = 5,
+    CUSTOM = 6
+}
+/**
+ * Parameters for configuring an AnsiLogger instance.
+ */
+export interface AnsiLoggerParams {
+    hbLog?: Logger;
+    logName?: string;
+    logDebug?: boolean;
+    logWithColors?: boolean;
+    logTimestampFormat?: TimestampFormat;
+    logCustomTimestampFormat?: string;
+}
+/**
+ * AnsiLogger provides a customizable logging utility with ANSI color support.
+ * It allows for various configurations such as enabling debug logs, customizing log name, and more.
+ */
+export declare class AnsiLogger {
+    private logName;
+    private logTimestampFormat;
+    private logCustomTimestampFormat;
+    private hbLog;
+    private logStartTime;
+    private logWithColors;
+    private logDebug;
+    private params;
+    /**
+     * Constructs a new AnsiLogger instance with optional configuration parameters.
+     * @param {AnsiLoggerParams} optionalParams - Configuration options for the logger.
+     */
+    constructor(optionalParams: AnsiLoggerParams);
+    /**
+     * Sets the name of the logger.
+     * @param {string} name - The new name for the logger.
+     */
+    setLogName(name: string): void;
+    /**
+     * Enables or disables debug logging.
+     * @param {boolean} logDebug - Flag to enable or disable debug logging.
+     */
+    setLogDebug(logDebug: boolean): void;
+    /**
+     * Enables or disables logging with ANSI colors.
+     * @param {boolean} logWithColors - Flag to enable or disable ANSI color logging.
+     */
+    setlogWithColors(logWithColors: boolean): void;
+    /**
+     * Sets the timestamp format for log messages.
+     * @param {TimestampFormat} format - The timestamp format to use.
+     */
+    setLogTimestampFormat(format: TimestampFormat): void;
+    /**
+     * Sets a custom timestamp format for log messages.
+     * @param {string} format - The custom timestamp format string.
+     */
+    setLogCustomTimestampFormat(format: string): void;
+    /**
+     * Starts a timer with an optional message.
+     * @param {string} message - The message to log when starting the timer.
+     */
+    startTimer(message: string): void;
+    /**
+     * Stops the timer started by startTimer and logs the elapsed time.
+     * @param {string} message - The message to log along with the elapsed time.
+     */
+    stopTimer(message: string): void;
+    private formatCustomTimestamp;
+    private getTimestamp;
+    /**
+     * Logs a message with a specific level (e.g., info, warn, error, debug) and additional parameters.
+     * This method formats the log message with ANSI colors based on the log level and other logger settings.
+     * It supports dynamic parameters for more detailed and formatted logging.
+     *
+     * @param {LogLevel} level - The severity level of the log message.
+     * @param {string} message - The primary log message to be displayed.
+     * @param {...any[]} parameters - Additional parameters to be logged. Supports any number of parameters.
+     */
+    log(level: LogLevel, message: string, ...parameters: any[]): void;
+    /**
+     * Logs an informational message. This is a convenience method that delegates to the `log` method with the `LogLevel.INFO` level.
+     *
+     * @param {string} message - The informational message to log.
+     * @param {...any[]} parameters - Additional parameters to be included in the log message. Supports any number of parameters.
+     */
+    info(message: string, ...parameters: any[]): void;
+    /**
+     * Logs a warning message. This is a convenience method that delegates to the `log` method with the `LogLevel.WARN` level.
+     *
+     * @param {string} message - The warning message to log.
+     * @param {...any[]} parameters - Additional parameters to be included in the log message. Supports any number of parameters.
+     */
+    warn(message: string, ...parameters: any[]): void;
+    /**
+     * Logs an error message. This is a convenience method that delegates to the `log` method with the `LogLevel.ERROR` level.
+     *
+     * @param {string} message - The error message to log.
+     * @param {...any[]} parameters - Additional parameters to be included in the log message. Supports any number of parameters.
+     */
+    error(message: string, ...parameters: any[]): void;
+    /**
+     * Logs a debug message if debug logging is enabled. This is a convenience method that delegates to the `log` method with the `LogLevel.DEBUG` level.
+     *
+     * @param {string} message - The debug message to log.
+     * @param {...any[]} parameters - Additional parameters to be included in the log message. Supports any number of parameters.
+     */
+    debug(message: string, ...parameters: any[]): void;
+}
+//# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAGH,eAAO,MAAM,KAAK,iBAAe,CAAC;AAClC,eAAO,MAAM,MAAM,cAAY,CAAC;AAChC,eAAO,MAAM,GAAG,cAAY,CAAC;AAC7B,eAAO,MAAM,SAAS,cAAY,CAAC;AACnC,eAAO,MAAM,YAAY,eAAa,CAAC;AACvC,eAAO,MAAM,KAAK,cAAY,CAAC;AAC/B,eAAO,MAAM,QAAQ,eAAa,CAAC;AACnC,eAAO,MAAM,OAAO,cAAY,CAAC;AACjC,eAAO,MAAM,UAAU,eAAa,CAAC;AACrC,eAAO,MAAM,MAAM,cAAY,CAAC;AAChC,eAAO,MAAM,SAAS,eAAa,CAAC;AACpC,eAAO,MAAM,UAAU,aAAW,CAAC;AACnC,eAAO,MAAM,aAAa,aAAW,CAAC;AAEtC,eAAO,MAAM,KAAK,eAAa,CAAC;AAChC,eAAO,MAAM,GAAG,eAAa,CAAC;AAC9B,eAAO,MAAM,KAAK,eAAa,CAAC;AAChC,eAAO,MAAM,MAAM,eAAa,CAAC;AACjC,eAAO,MAAM,IAAI,eAAa,CAAC;AAC/B,eAAO,MAAM,OAAO,eAAa,CAAC;AAClC,eAAO,MAAM,IAAI,eAAa,CAAC;AAC/B,eAAO,MAAM,UAAU,eAAa,CAAC;AACrC,eAAO,MAAM,IAAI,eAAa,CAAC;AAC/B,eAAO,MAAM,KAAK,eAAa,CAAC;AAGhC,eAAO,MAAM,EAAE,qBAAmB,CAAC;AACnC,eAAO,MAAM,EAAE,qBAAmB,CAAC;AACnC,eAAO,MAAM,EAAE,qBAAmB,CAAC;AACnC,eAAO,MAAM,EAAE,mBAAiB,CAAC;AACjC,eAAO,MAAM,EAAE,iBAAe,CAAC;AAC/B,eAAO,MAAM,EAAE,aAAW,CAAC;AAG3B,eAAO,MAAM,EAAE,oBAAkB,CAAC;AAClC,eAAO,MAAM,EAAE,oBAAkB,CAAC;AAClC,eAAO,MAAM,GAAG,oCAAgC,CAAC;AACjD,eAAO,MAAM,GAAG,oCAAgC,CAAC;AACjD,eAAO,MAAM,EAAE,qBAAmB,CAAC;AACnC,eAAO,MAAM,EAAE,oBAAkB,CAAC;AAClC,eAAO,MAAM,EAAE,eAAa,CAAC;AAC7B,eAAO,MAAM,EAAE,kBAAgB,CAAC;AAChC,eAAO,MAAM,EAAE,qBAAmB,CAAC;AAGnC;;GAEG;AACH,0BAAkB,QAAQ;IACxB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IAErB,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAEhC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAE/B,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAE/B,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAEhC,GAAG,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;CACvE;AAED;;GAEG;AACH,0BAAkB,eAAe;IAC/B,GAAG,IAAA;IACH,UAAU,IAAA;IACV,UAAU,IAAA;IACV,eAAe,IAAA;IACf,WAAW,IAAA;IACX,UAAU,IAAA;IACV,MAAM,IAAA;CACP;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kBAAkB,CAAC,EAAE,eAAe,CAAC;IACrC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,wBAAwB,CAAS;IACzC,OAAO,CAAC,KAAK,CAAqB;IAClC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,aAAa,CAAU;IAC/B,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,MAAM,CAAmB;IAEjC;;;OAGG;gBACS,cAAc,EAAE,gBAAgB;IAoB5C;;;OAGG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIrC;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;IAI3C;;;OAGG;IACI,gBAAgB,CAAC,aAAa,EAAE,OAAO,GAAG,IAAI;IAIrD;;;OAGG;IACI,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAI3D;;;OAGG;IACI,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIxD;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAKxC;;;OAGG;IACI,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAWvC,OAAO,CAAC,qBAAqB;IAkB7B,OAAO,CAAC,YAAY;IAgCpB;;;;;;;;OAQG;IAEI,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI;IAwDxE;;;;;OAKG;IAEI,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI;IAIxD;;;;;OAKG;IAEI,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI;IAIxD;;;;;OAKG;IAEI,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI;IAIzD;;;;;OAKG;IAEI,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI;CAK1D"}

package/dist/logger.js

@@ -0,0 +1,347 @@
+/**
+ * This file contains the class CustomLogger.
+ *
+ * @file logger.ts
+ * @author Luca Liguori
+ * @date 2023-06-01
+ * @version 1.8.8
+ *
+ * All rights reserved.
+ *
+ */
+// ANSI color codes and styles are defined here for use in the logger
+export const RESET = '\x1b[40;0m';
+export const BRIGHT = '\x1b[1m';
+export const DIM = '\x1b[2m';
+export const UNDERLINE = '\x1b[4m';
+export const UNDERLINEOFF = '\x1b[24m';
+export const BLINK = '\x1b[5m';
+export const BLINKOFF = '\x1b[25m';
+export const REVERSE = '\x1b[7m';
+export const REVERSEOFF = '\x1b[27m';
+export const HIDDEN = '\x1b[8m';
+export const HIDDENOFF = '\x1b[28m';
+export const CURSORSAVE = '\x1b[s';
+export const CURSORRESTORE = '\x1b[u';
+export const BLACK = '\x1b[30m';
+export const RED = '\x1b[31m';
+export const GREEN = '\x1b[32m';
+export const YELLOW = '\x1b[33m';
+export const BLUE = '\x1b[34m';
+export const MAGENTA = '\x1b[35m';
+export const CYAN = '\x1b[36m';
+export const LIGHT_GREY = '\x1b[37m';
+export const GREY = '\x1b[90m';
+export const WHITE = '\x1b[97m';
+// ANSI color codes short form to use in the logger
+export const db = '\x1b[38;5;247m'; // Debug
+export const nf = '\x1b[38;5;255m'; // Info
+export const wr = '\x1b[38;5;220m'; // Warn
+export const er = '\x1b[38;5;9m'; // Error
+export const rs = '\x1b[40;0m'; // Reset colors to default foreground and background
+export const rk = '\x1b[K'; // Erase from cursor
+// Used internally for: homebridge-mqtt-accessories and matterbridge-mqtt-accessories
+export const dn = '\x1b[38;5;33m'; // Display name device
+export const gn = '\x1b[38;5;35m'; // Display name group
+export const idn = '\x1b[48;5;21m\x1b[38;5;255m'; // Inverted display name device
+export const ign = '\x1b[48;5;22m\x1b[38;5;255m'; // Inverted display name group
+export const zb = '\x1b[38;5;207m'; // Zigbee
+export const hk = '\x1b[38;5;79m'; // Homekit
+export const pl = '\x1b[32m'; // payload
+export const id = '\x1b[37;44m'; // id or ieee_address or UUID
+export const or = '\x1b[38;5;208m'; // history
+/**
+ * AnsiLogger provides a customizable logging utility with ANSI color support.
+ * It allows for various configurations such as enabling debug logs, customizing log name, and more.
+ */
+export class AnsiLogger {
+    logName;
+    logTimestampFormat;
+    logCustomTimestampFormat;
+    hbLog;
+    logStartTime;
+    logWithColors;
+    logDebug;
+    params;
+    /**
+     * Constructs a new AnsiLogger instance with optional configuration parameters.
+     * @param {AnsiLoggerParams} optionalParams - Configuration options for the logger.
+     */
+    constructor(optionalParams) {
+        this.params = Object.assign({
+            hbLog: undefined,
+            logName: 'NodeAnsiLogger',
+            logDebug: true,
+            logWithColors: true,
+            logTimestampFormat: 3 /* TimestampFormat.LOCAL_DATE_TIME */,
+            logCustomTimestampFormat: 'yyyy-MM-dd HH:mm:ss',
+        }, optionalParams);
+        this.hbLog = this.params.hbLog;
+        this.logName = this.params.logName;
+        this.logDebug = this.params.logDebug;
+        this.logWithColors = this.params.logWithColors;
+        this.logTimestampFormat = this.params.logTimestampFormat;
+        this.logCustomTimestampFormat = this.params.logCustomTimestampFormat;
+        this.logStartTime = 0;
+    }
+    /**
+     * Sets the name of the logger.
+     * @param {string} name - The new name for the logger.
+     */
+    setLogName(name) {
+        this.logName = name;
+    }
+    /**
+     * Enables or disables debug logging.
+     * @param {boolean} logDebug - Flag to enable or disable debug logging.
+     */
+    setLogDebug(logDebug) {
+        this.logDebug = logDebug;
+    }
+    /**
+     * Enables or disables logging with ANSI colors.
+     * @param {boolean} logWithColors - Flag to enable or disable ANSI color logging.
+     */
+    setlogWithColors(logWithColors) {
+        this.logWithColors = logWithColors;
+    }
+    /**
+     * Sets the timestamp format for log messages.
+     * @param {TimestampFormat} format - The timestamp format to use.
+     */
+    setLogTimestampFormat(format) {
+        this.logTimestampFormat = format;
+    }
+    /**
+     * Sets a custom timestamp format for log messages.
+     * @param {string} format - The custom timestamp format string.
+     */
+    setLogCustomTimestampFormat(format) {
+        this.logCustomTimestampFormat = format;
+    }
+    /**
+     * Starts a timer with an optional message.
+     * @param {string} message - The message to log when starting the timer.
+     */
+    startTimer(message) {
+        this.logStartTime = Date.now();
+        this.info(`Timer started ${message}`);
+    }
+    /**
+     * Stops the timer started by startTimer and logs the elapsed time.
+     * @param {string} message - The message to log along with the elapsed time.
+     */
+    stopTimer(message) {
+        if (this.logStartTime !== 0) {
+            const timePassed = Date.now() - this.logStartTime;
+            this.info(`Timer stoppped at ${timePassed} ms ${message}`);
+        }
+        this.logStartTime = 0;
+    }
+    // This function formats a date object into a custom string format.
+    // For simplicity, it only handles years, months, days, hours, minutes, and seconds
+    // with this format 'yyyy-MM-dd HH:mm:ss'
+    formatCustomTimestamp(date, formatString) {
+        const year = date.getFullYear();
+        const month = date.getMonth() + 1; // getMonth() returns 0-11
+        const day = date.getDate();
+        const hours = date.getHours();
+        const minutes = date.getMinutes();
+        const seconds = date.getSeconds();
+        // Replace format tokens with actual values. Add more as needed.
+        return formatString
+            .replace('yyyy', year.toString())
+            .replace('MM', month.toString().padStart(2, '0'))
+            .replace('dd', day.toString().padStart(2, '0'))
+            .replace('HH', hours.toString().padStart(2, '0'))
+            .replace('mm', minutes.toString().padStart(2, '0'))
+            .replace('ss', seconds.toString().padStart(2, '0'));
+    }
+    getTimestamp() {
+        if (this.logStartTime !== 0) {
+            const timePassed = Date.now() - this.logStartTime;
+            return `Timer:    ${timePassed.toString().padStart(7, ' ')} ms`;
+        }
+        else {
+            let timestamp;
+            switch (this.logTimestampFormat) {
+                case 1 /* TimestampFormat.LOCAL_DATE */:
+                    timestamp = new Date().toLocaleDateString();
+                    break;
+                case 2 /* TimestampFormat.LOCAL_TIME */:
+                    timestamp = new Date().toLocaleTimeString();
+                    break;
+                case 5 /* TimestampFormat.HOMEBRIDGE */:
+                case 3 /* TimestampFormat.LOCAL_DATE_TIME */:
+                    timestamp = new Date().toLocaleString();
+                    break;
+                case 0 /* TimestampFormat.ISO */:
+                    timestamp = new Date().toISOString();
+                    break;
+                case 4 /* TimestampFormat.TIME_MILLIS */:
+                    // eslint-disable-next-line max-len
+                    timestamp = `${new Date().getHours().toString().padStart(2, '0')}:${new Date().getMinutes().toString().padStart(2, '0')}:${new Date().getSeconds().toString().padStart(2, '0')}.${new Date().getMilliseconds().toString().padStart(3, '0')}`;
+                    break;
+                case 6 /* TimestampFormat.CUSTOM */:
+                    timestamp = this.formatCustomTimestamp(new Date(), this.logCustomTimestampFormat);
+                    break;
+            }
+            return timestamp;
+        }
+    }
+    /**
+     * Logs a message with a specific level (e.g., info, warn, error, debug) and additional parameters.
+     * This method formats the log message with ANSI colors based on the log level and other logger settings.
+     * It supports dynamic parameters for more detailed and formatted logging.
+     *
+     * @param {LogLevel} level - The severity level of the log message.
+     * @param {string} message - The primary log message to be displayed.
+     * @param {...any[]} parameters - Additional parameters to be logged. Supports any number of parameters.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    log(level, message, ...parameters) {
+        const ts = '\x1b[38;5;249m'; // TimeStamp  White medium
+        const ln = '\x1b[38;5;31m'; // LogName    Cyan
+        const s1ln = '\x1b[38;5;0;48;5;31m'; // Highlight  LogName Black on Cyan
+        const s2ln = '\x1b[38;5;0;48;5;255m'; // Highlight  LogName Black on White
+        const s3ln = '\x1b[38;5;0;48;5;220m'; // Highlight  LogName Black on Yellow
+        const s4ln = '\x1b[38;5;0;48;5;9m'; // Highlight  LogName Black on Red
+        if (this.hbLog !== undefined) {
+            this.hbLog[level](message, ...parameters);
+        }
+        else {
+            if (this.logWithColors) {
+                let logNameColor = ln;
+                if (typeof message !== 'string' || message.startsWith === undefined) {
+                    logNameColor = ln;
+                }
+                else if (message.startsWith('****')) {
+                    logNameColor = s4ln;
+                    message = message.slice(4);
+                }
+                else if (message.startsWith('***')) {
+                    logNameColor = s3ln;
+                    message = message.slice(3);
+                }
+                else if (message.startsWith('**')) {
+                    logNameColor = s2ln;
+                    message = message.slice(2);
+                }
+                else if (message.startsWith('*')) {
+                    logNameColor = s1ln;
+                    message = message.slice(1);
+                }
+                switch (level) {
+                    case "debug" /* LogLevel.DEBUG */:
+                        if (this.logDebug) {
+                            // eslint-disable-next-line no-console
+                            console.log(`${rs}${ts}[${this.getTimestamp()}] ${logNameColor}[${this.logName}]${rs}${db}`, message, ...parameters, rs + rk);
+                        }
+                        break;
+                    case "info" /* LogLevel.INFO */:
+                        // eslint-disable-next-line no-console
+                        console.log(`${rs}${ts}[${this.getTimestamp()}] ${logNameColor}[${this.logName}]${rs}${nf}`, message, ...parameters, rs + rk);
+                        break;
+                    case "warn" /* LogLevel.WARN */:
+                        // eslint-disable-next-line no-console
+                        console.log(`${rs}${ts}[${this.getTimestamp()}] ${logNameColor}[${this.logName}]${rs}${wr}`, message, ...parameters, rs + rk);
+                        break;
+                    case "error" /* LogLevel.ERROR */:
+                        // eslint-disable-next-line no-console
+                        console.log(`${rs}${ts}[${this.getTimestamp()}] ${logNameColor}[${this.logName}]${rs}${er}`, message, ...parameters, rs + rk);
+                        break;
+                }
+            }
+            else {
+                // eslint-disable-next-line no-console
+                console.log(`${rs}[${this.getTimestamp()}] [${this.logName}] [${level}] ${message}`, ...parameters);
+            }
+        }
+    }
+    /**
+     * Logs an informational message. This is a convenience method that delegates to the `log` method with the `LogLevel.INFO` level.
+     *
+     * @param {string} message - The informational message to log.
+     * @param {...any[]} parameters - Additional parameters to be included in the log message. Supports any number of parameters.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    info(message, ...parameters) {
+        this.log("info" /* LogLevel.INFO */, message, ...parameters);
+    }
+    /**
+     * Logs a warning message. This is a convenience method that delegates to the `log` method with the `LogLevel.WARN` level.
+     *
+     * @param {string} message - The warning message to log.
+     * @param {...any[]} parameters - Additional parameters to be included in the log message. Supports any number of parameters.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    warn(message, ...parameters) {
+        this.log("warn" /* LogLevel.WARN */, message, ...parameters);
+    }
+    /**
+     * Logs an error message. This is a convenience method that delegates to the `log` method with the `LogLevel.ERROR` level.
+     *
+     * @param {string} message - The error message to log.
+     * @param {...any[]} parameters - Additional parameters to be included in the log message. Supports any number of parameters.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    error(message, ...parameters) {
+        this.log("error" /* LogLevel.ERROR */, message, ...parameters);
+    }
+    /**
+     * Logs a debug message if debug logging is enabled. This is a convenience method that delegates to the `log` method with the `LogLevel.DEBUG` level.
+     *
+     * @param {string} message - The debug message to log.
+     * @param {...any[]} parameters - Additional parameters to be included in the log message. Supports any number of parameters.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    debug(message, ...parameters) {
+        if (this.logDebug) {
+            this.log("debug" /* LogLevel.DEBUG */, message, ...parameters);
+        }
+    }
+}
+/*
+    \x1b[0m - Reset (clear color)
+    \x1b[1m - Bold
+    \x1b[3m - Italic
+    \x1b[4m - Underline
+    \x1b[K  - Erase the line from cursor
+
+    \x1b[30m - Black
+    \x1b[31m - Red
+    \x1b[32m - Green
+    \x1b[33m - Yellow
+    \x1b[34m - Blue
+    \x1b[35m - Magenta
+    \x1b[36m - Cyan
+    \x1b[37m - White
+
+    \x1b[90-97m - Bright
+
+    \x1b[40m - Black background
+    \x1b[41m - Red background
+    \x1b[42m - Green background
+    \x1b[43m - Yellow background
+    \x1b[44m - Blue background
+    \x1b[45m - Magenta background
+    \x1b[46m - Cyan background
+    \x1b[47m - White background
+
+    \x1b[100-107m - Bright background
+
+    \x1b[38;2;255;105;50m // Orange
+
+    RGB foreground
+    \x1b[38;2;<R>;<G>;<B>m
+
+    RGB background
+    \x1b[48;2;<R>;<G>;<B>m
+
+    256 colors foreground
+    \x1b[38;5;<FG COLOR>m
+
+    256 colors background
+    \x1b[48;5;<BG COLOR>m
+*/
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,qEAAqE;AACrE,MAAM,CAAC,MAAM,KAAK,GAAG,YAAY,CAAC;AAClC,MAAM,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC;AAChC,MAAM,CAAC,MAAM,GAAG,GAAG,SAAS,CAAC;AAC7B,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAC;AACnC,MAAM,CAAC,MAAM,YAAY,GAAG,UAAU,CAAC;AACvC,MAAM,CAAC,MAAM,KAAK,GAAG,SAAS,CAAC;AAC/B,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAU,CAAC;AACnC,MAAM,CAAC,MAAM,OAAO,GAAG,SAAS,CAAC;AACjC,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAC;AACrC,MAAM,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC;AAChC,MAAM,CAAC,MAAM,SAAS,GAAG,UAAU,CAAC;AACpC,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC;AACnC,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC;AAEtC,MAAM,CAAC,MAAM,KAAK,GAAG,UAAU,CAAC;AAChC,MAAM,CAAC,MAAM,GAAG,GAAG,UAAU,CAAC;AAC9B,MAAM,CAAC,MAAM,KAAK,GAAG,UAAU,CAAC;AAChC,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,CAAC;AACjC,MAAM,CAAC,MAAM,IAAI,GAAG,UAAU,CAAC;AAC/B,MAAM,CAAC,MAAM,OAAO,GAAG,UAAU,CAAC;AAClC,MAAM,CAAC,MAAM,IAAI,GAAG,UAAU,CAAC;AAC/B,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAC;AACrC,MAAM,CAAC,MAAM,IAAI,GAAG,UAAU,CAAC;AAC/B,MAAM,CAAC,MAAM,KAAK,GAAG,UAAU,CAAC;AAEhC,mDAAmD;AACnD,MAAM,CAAC,MAAM,EAAE,GAAG,gBAAgB,CAAC,CAAiB,QAAQ;AAC5D,MAAM,CAAC,MAAM,EAAE,GAAG,gBAAgB,CAAC,CAAiB,OAAO;AAC3D,MAAM,CAAC,MAAM,EAAE,GAAG,gBAAgB,CAAC,CAAiB,OAAO;AAC3D,MAAM,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,CAAmB,QAAQ;AAC5D,MAAM,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,CAAqB,oDAAoD;AACxG,MAAM,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAyB,oBAAoB;AAExE,qFAAqF;AACrF,MAAM,CAAC,MAAM,EAAE,GAAG,eAAe,CAAC,CAAkB,sBAAsB;AAC1E,MAAM,CAAC,MAAM,EAAE,GAAG,eAAe,CAAC,CAAkB,qBAAqB;AACzE,MAAM,CAAC,MAAM,GAAG,GAAG,6BAA6B,CAAC,CAAG,+BAA+B;AACnF,MAAM,CAAC,MAAM,GAAG,GAAG,6BAA6B,CAAC,CAAG,8BAA8B;AAClF,MAAM,CAAC,MAAM,EAAE,GAAG,gBAAgB,CAAC,CAAiB,SAAS;AAC7D,MAAM,CAAC,MAAM,EAAE,GAAG,eAAe,CAAC,CAAkB,UAAU;AAC9D,MAAM,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC,CAAuB,UAAU;AAC9D,MAAM,CAAC,MAAM,EAAE,GAAG,aAAa,CAAC,CAAoB,6BAA6B;AACjF,MAAM,CAAC,MAAM,EAAE,GAAG,gBAAgB,CAAC,CAAiB,UAAU;AAsD9D;;;GAGG;AACH,MAAM,OAAO,UAAU;IACb,OAAO,CAAS;IAChB,kBAAkB,CAAkB;IACpC,wBAAwB,CAAS;IACjC,KAAK,CAAqB;IAC1B,YAAY,CAAS;IACrB,aAAa,CAAU;IACvB,QAAQ,CAAU;IAClB,MAAM,CAAmB;IAEjC;;;OAGG;IACH,YAAY,cAAgC;QAE1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;YAC1B,KAAK,EAAE,SAAS;YAChB,OAAO,EAAE,gBAAgB;YACzB,QAAQ,EAAE,IAAI;YACd,aAAa,EAAE,IAAI;YACnB,kBAAkB,yCAAiC;YACnD,wBAAwB,EAAE,qBAAqB;SAChD,EAAE,cAAc,CAAC,CAAC;QAEnB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAQ,CAAC;QACpC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAS,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,aAAc,CAAC;QAChD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAmB,CAAC;QAC1D,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,MAAM,CAAC,wBAAyB,CAAC;QACtE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,IAAY;QAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,QAAiB;QAClC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,aAAsB;QAC5C,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAAC,MAAuB;QAClD,IAAI,CAAC,kBAAkB,GAAG,MAAM,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,2BAA2B,CAAC,MAAc;QAC/C,IAAI,CAAC,wBAAwB,GAAG,MAAM,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,OAAe;QAC/B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,iBAAiB,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,OAAe;QAC9B,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,qBAAqB,UAAU,OAAO,OAAO,EAAE,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;IACxB,CAAC;IAED,mEAAmE;IACnE,mFAAmF;IACnF,yCAAyC;IACjC,qBAAqB,CAAC,IAAU,EAAE,YAAoB;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,0BAA0B;QAC7D,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAElC,gEAAgE;QAChE,OAAO,YAAY;aAChB,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;aAChC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;aAChD,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;aAC9C,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;aAChD,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;aAClD,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;IAEO,YAAY;QAClB,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;YAClD,OAAO,aAAa,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,IAAI,SAAiB,CAAC;YACtB,QAAQ,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAChC;oBACE,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,kBAAkB,EAAE,CAAC;oBAC5C,MAAM;gBACR;oBACE,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,kBAAkB,EAAE,CAAC;oBAC5C,MAAM;gBACR,wCAAgC;gBAChC;oBACE,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,CAAC;oBACxC,MAAM;gBACR;oBACE,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;oBACrC,MAAM;gBACR;oBACE,mCAAmC;oBACnC,SAAS,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,eAAe,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;oBAC7O,MAAM;gBACR;oBACE,SAAS,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,IAAI,EAAE,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;oBAClF,MAAM;YACV,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,8DAA8D;IACvD,GAAG,CAAC,KAAe,EAAE,OAAe,EAAE,GAAG,UAAiB;QAC/D,MAAM,EAAE,GAAG,gBAAgB,CAAC,CAAiB,0BAA0B;QACvE,MAAM,EAAE,GAAG,eAAe,CAAC,CAAkB,kBAAkB;QAE/D,MAAM,IAAI,GAAG,sBAAsB,CAAC,CAAS,mCAAmC;QAChF,MAAM,IAAI,GAAG,uBAAuB,CAAC,CAAQ,oCAAoC;QACjF,MAAM,IAAI,GAAG,uBAAuB,CAAC,CAAQ,qCAAqC;QAClF,MAAM,IAAI,GAAG,qBAAqB,CAAC,CAAU,kCAAkC;QAE/E,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,IAAI,YAAY,GAAG,EAAE,CAAC;gBACtB,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;oBACpE,YAAY,GAAG,EAAE,CAAC;gBACpB,CAAC;qBAAM,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBACtC,YAAY,GAAG,IAAI,CAAC;oBACpB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC7B,CAAC;qBAAM,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrC,YAAY,GAAG,IAAI,CAAC;oBACpB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC7B,CAAC;qBAAM,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpC,YAAY,GAAG,IAAI,CAAC;oBACpB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC7B,CAAC;qBAAM,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBACnC,YAAY,GAAG,IAAI,CAAC;oBACpB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC7B,CAAC;gBACD,QAAQ,KAAK,EAAE,CAAC;oBACd;wBACE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;4BAClB,sCAAsC;4BACtC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,IAAI,CAAC,YAAY,EAAE,KAAK,YAAY,IAAI,IAAI,CAAC,OAAO,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;wBAChI,CAAC;wBACD,MAAM;oBACR;wBACE,sCAAsC;wBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,IAAI,CAAC,YAAY,EAAE,KAAK,YAAY,IAAI,IAAI,CAAC,OAAO,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;wBAC9H,MAAM;oBACR;wBACE,sCAAsC;wBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,IAAI,CAAC,YAAY,EAAE,KAAK,YAAY,IAAI,IAAI,CAAC,OAAO,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;wBAC9H,MAAM;oBACR;wBACE,sCAAsC;wBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,IAAI,CAAC,YAAY,EAAE,KAAK,YAAY,IAAI,IAAI,CAAC,OAAO,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;wBAC9H,MAAM;gBACV,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,sCAAsC;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC,OAAO,MAAM,KAAK,KAAK,OAAO,EAAE,EAAE,GAAG,UAAU,CAAC,CAAC;YACtG,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,8DAA8D;IACvD,IAAI,CAAC,OAAe,EAAE,GAAG,UAAiB;QAC/C,IAAI,CAAC,GAAG,6BAAgB,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,8DAA8D;IACvD,IAAI,CAAC,OAAe,EAAE,GAAG,UAAiB;QAC/C,IAAI,CAAC,GAAG,6BAAgB,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,8DAA8D;IACvD,KAAK,CAAC,OAAe,EAAE,GAAG,UAAiB;QAChD,IAAI,CAAC,GAAG,+BAAiB,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACH,8DAA8D;IACvD,KAAK,CAAC,OAAe,EAAE,GAAG,UAAiB;QAChD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,+BAAiB,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0CE"}

package/dist/stringify.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file contains the functions stringify.
+ *
+ * @file stringify.ts
+ * @author Luca Liguori
+ * @date 2023-07-23
+ * @version 1.4.1
+ *
+ * All rights reserved.
+ *
+*/
+export declare function payloadStringify(payload: object): string;
+export declare function colorStringify(payload: object): string;
+export declare function historyStringify(payload: object): string;
+export declare function mqttStringify(payload: object): string;
+export declare function debugStringify(payload: object): string;
+export declare function stringify(payload: object, enableColors?: boolean, colorPayload?: number, colorKey?: number, colorString?: number, colorNumber?: number, colorBoolean?: number, colorUndefined?: number, keyQuote?: string, stringQuote?: string): string;
+//# sourceMappingURL=stringify.d.ts.map

package/dist/stringify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringify.d.ts","sourceRoot":"","sources":["../src/stringify.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAExD;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAExD;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,UAAQ,EAAE,YAAY,SAAM,EAAE,QAAQ,SAAM,EAAE,WAAW,SAAK,EAAE,WAAW,SAAM,EACtI,YAAY,SAAM,EAAE,cAAc,SAAI,EAAE,QAAQ,SAAK,EAAE,WAAW,SAAO,GAAG,MAAM,CA4CnF"}

package/dist/stringify.js

@@ -0,0 +1,81 @@
+/**
+ * This file contains the functions stringify.
+ *
+ * @file stringify.ts
+ * @author Luca Liguori
+ * @date 2023-07-23
+ * @version 1.4.1
+ *
+ * All rights reserved.
+ *
+*/
+export function payloadStringify(payload) {
+    return stringify(payload, false, 0, 0, 0, 0, 0, 0, '"', '"');
+}
+export function colorStringify(payload) {
+    return stringify(payload, true, 255, 255, 35, 220, 159, 1);
+}
+export function historyStringify(payload) {
+    return stringify(payload, true, 0, 208, 247, 247, 247, 247);
+}
+export function mqttStringify(payload) {
+    return stringify(payload, true, 69, 247);
+}
+export function debugStringify(payload) {
+    return stringify(payload, true, 247, 247);
+}
+export function stringify(payload, enableColors = false, colorPayload = 255, colorKey = 255, colorString = 35, colorNumber = 220, colorBoolean = 159, colorUndefined = 1, keyQuote = '', stringQuote = '\'') {
+    const clr = (color) => {
+        return enableColors ? `\x1b[38;5;${color}m` : '';
+    };
+    const reset = () => {
+        return enableColors ? '\x1b[0m' : '';
+    };
+    const isArray = Array.isArray(payload);
+    let string = `${reset()}${clr(colorPayload)}` + (isArray ? '[ ' : '{ ');
+    Object.entries(payload).forEach(([key, value], index) => {
+        if (index > 0) {
+            string += ', ';
+        }
+        let newValue = '';
+        newValue = value;
+        //console.log(typeof newValue, key, value);
+        if (value === null) {
+            newValue = `${clr(colorUndefined)}null${reset()}`;
+        }
+        else if (typeof newValue === 'string') {
+            newValue = `${clr(colorString)}${stringQuote}${newValue}${stringQuote}${reset()}`;
+        }
+        else if (typeof newValue === 'number') {
+            newValue = `${clr(colorNumber)}${newValue}${reset()}`;
+        }
+        else if (typeof newValue === 'boolean') {
+            newValue = `${clr(colorBoolean)}${newValue}${reset()}`;
+        }
+        else if (typeof newValue === 'undefined') {
+            newValue = `${clr(colorUndefined)}undefined${reset()}`;
+        }
+        else if (typeof newValue === 'object') {
+            if (Object.keys(newValue).length < 100) {
+                newValue = stringify(newValue, enableColors, colorPayload, colorKey, colorString, colorNumber, colorBoolean, colorUndefined, keyQuote, stringQuote);
+            }
+            else {
+                newValue = '{...}';
+            }
+        }
+        else if (typeof newValue === 'bigint') {
+            newValue = `${clr(colorNumber + 1)}${newValue}${reset()}`;
+        }
+        else {
+            throw new Error('Stringify unknown type');
+        }
+        if (isArray) {
+            string += `${newValue}`;
+        }
+        else {
+            string += `${clr(colorKey)}${keyQuote}${key}${keyQuote}${reset()}: ${newValue}`;
+        }
+    });
+    return string += ` ${clr(colorPayload)}` + (isArray ? ']' : '}') + `${reset()}`;
+}
+//# sourceMappingURL=stringify.js.map

package/dist/stringify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringify.js","sourceRoot":"","sources":["../src/stringify.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,MAAM,UAAU,gBAAgB,CAAC,OAAe;IAC9C,OAAO,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAe;IAC5C,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAe;IAC9C,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAAe;IAC3C,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAe;IAC5C,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAAe,EAAE,YAAY,GAAG,KAAK,EAAE,YAAY,GAAG,GAAG,EAAE,QAAQ,GAAG,GAAG,EAAE,WAAW,GAAG,EAAE,EAAE,WAAW,GAAG,GAAG,EACtI,YAAY,GAAG,GAAG,EAAE,cAAc,GAAG,CAAC,EAAE,QAAQ,GAAG,EAAE,EAAE,WAAW,GAAG,IAAI;IACzE,MAAM,GAAG,GAAG,CAAC,KAAa,EAAE,EAAE;QAC5B,OAAO,YAAY,CAAC,CAAC,CAAC,aAAa,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACnD,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,GAAG,EAAE;QACjB,OAAO,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IACvC,CAAC,CAAC;IACF,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,IAAI,MAAM,GAAG,GAAG,KAAK,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACxE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE;QACtD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,MAAM,IAAI,IAAI,CAAC;QACjB,CAAC;QACD,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,QAAQ,GAAG,KAAK,CAAC;QACjB,2CAA2C;QAC3C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,QAAQ,GAAG,GAAG,GAAG,CAAC,cAAc,CAAC,OAAO,KAAK,EAAE,EAAE,CAAC;QACpD,CAAC;aAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACxC,QAAQ,GAAG,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,KAAK,EAAE,EAAE,CAAC;QACpF,CAAC;aAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACxC,QAAQ,GAAG,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,QAAQ,GAAG,KAAK,EAAE,EAAE,CAAC;QACxD,CAAC;aAAM,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzC,QAAQ,GAAG,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,QAAQ,GAAG,KAAK,EAAE,EAAE,CAAC;QACzD,CAAC;aAAM,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;YAC3C,QAAQ,GAAG,GAAG,GAAG,CAAC,cAAc,CAAC,YAAY,KAAK,EAAE,EAAE,CAAC;QACzD,CAAC;aAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACxC,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBACvC,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;YACtJ,CAAC;iBAAM,CAAC;gBACN,QAAQ,GAAG,OAAO,CAAC;YACrB,CAAC;QACH,CAAC;aAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACxC,QAAQ,GAAG,GAAG,GAAG,CAAC,WAAW,GAAG,CAAC,CAAC,GAAG,QAAQ,GAAG,KAAK,EAAE,EAAE,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,QAAQ,EAAE,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,QAAQ,GAAG,GAAG,GAAG,QAAQ,GAAG,KAAK,EAAE,KAAK,QAAQ,EAAE,CAAC;QAClF,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,IAAI,IAAI,GAAG,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,KAAK,EAAE,EAAE,CAAC;AAClF,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "node-ansi-logger",
+  "version": "1.9.1",
+  "description": "Enhanced Color-Coded Logging for Node.js",
+  "author": "https://github.com/Luligu",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Luligu/node-ansi-logger"
+  },
+  "bugs": {
+    "url": "https://github.com/Luligu/node-ansi-logger/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.js",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "test": "jest",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch",
+    "lint": "eslint src/**.ts",
+    "lint:fix": "eslint src/**.ts --fix",
+    "clean": "rimraf tsconfig.tsbuildinfo ./dist",
+    "cleanBuild": "npm run clean && tsc",
+    "deepClean": "rimraf tsconfig.tsbuildinfo package-lock.json ./dist ./node_modules",
+    "prepublishOnly": "npm run lint && npm run cleanBuild",
+    "checkDependencies": "npx npm-check-updates",
+    "updateDependencies": "npx npm-check-updates -u"
+  },
+  "keywords": [
+    "node-ansi-logger",
+    "ansi escape",
+    "color",
+    "logger"
+  ],
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.19",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
+  }
+}