@rabbit-company/logger 2.0.1 → 2.1.1

package/module/logger.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Represents a logger utility for logging messages with different log levels.
+ */
+export default class Logger {
+	static "__#1@#NDJson": string;
+	/**
+	 * Indicates whether NDJson is enabled.
+	 * @type {boolean}
+	 */
+	static NDJson: boolean;
+	/**
+	 * The log level of the logger.
+	 * @type {number}
+	 */
+	static level: number;
+	/**
+	 * Indicates whether colors are enabled for log messages.
+	 * @type {boolean}
+	 */
+	static colors: boolean;
+	/**
+	 * Defines log levels and their associated numeric values.
+	 * @type {Object}
+	 */
+	static levels: any;
+	static "__#1@#levels": {
+			0: string;
+			1: string;
+			2: string;
+			3: string;
+			4: string;
+			5: string;
+			6: string;
+	};
+	/**
+	 * Parses the log message to ensure it is a string.
+	 * @param {*} message - The log message.
+	 * @returns {string | null} - The parsed log message or null if the message is undefined.
+	 */
+	static parseMessage(message: any): string | null;
+	/**
+	 * Formats the log message with timestamp and log level.
+	 * @param {string} message - The log message.
+	 * @param {number} logLevel - The log level.
+	 * @returns {string} - The formatted log message.
+	 */
+	static formatMessage(message: string, logLevel: number): string;
+	/**
+	 * Processes and logs a message with the specified log level.
+	 * @param {*} message - The log message.
+	 * @param {number} level - The log level.
+	 */
+	static "__#1@#processMessage"(message: any, level: number): void;
+	/**
+	 * Logs an error message.
+	 * @param {*} message - The error message.
+	 */
+	static error(message: any): void;
+	/**
+	 * Logs a warning message.
+	 * @param {*} message - The warning message.
+	 */
+	static warn(message: any): void;
+	/**
+	 * Logs an informational message.
+	 * @param {*} message - The informational message.
+	 */
+	static info(message: any): void;
+	/**
+	 * Logs an HTTP-related message.
+	 * @param {*} message - The HTTP-related message.
+	 */
+	static http(message: any): void;
+	/**
+	 * Logs a verbose message.
+	 * @param {*} message - The verbose message.
+	 */
+	static verbose(message: any): void;
+	/**
+	 * Logs a debug message.
+	 * @param {*} message - The debug message.
+	 */
+	static debug(message: any): void;
+	/**
+	 * Logs a silly message.
+	 * @param {*} message - The silly message.
+	 */
+	static silly(message: any): void;
+	/**
+	 * Appends a message to NDJson format.
+	 * @param {string} message - The message to append.
+	 * @param {number} logLevel - The log level associated with the message.
+	 */
+	static putNDJson(message: string, logLevel: number): void;
+	/**
+	 * Gets the NDJson log.
+	 * @returns {string} - The NDJson log.
+	 */
+	static getNDJson(): string;
+}

package/module/logger.js

@@ -418,6 +418,11 @@ var source_default = chalk;
 // module/logger.js
 var _NDJson, _levels, _processMessage, processMessage_fn;
 var Logger = class {
+  /**
+   * Parses the log message to ensure it is a string.
+   * @param {*} message - The log message.
+   * @returns {string | null} - The parsed log message or null if the message is undefined.
+   */
   static parseMessage(message) {
     if (typeof message === "undefined")
       return null;
@@ -425,6 +430,12 @@ var Logger = class {
       message = JSON.stringify(message);
     return message;
   }
+  /**
+   * Formats the log message with timestamp and log level.
+   * @param {string} message - The log message.
+   * @param {number} logLevel - The log level.
+   * @returns {string} - The formatted log message.
+   */
   static formatMessage(message, logLevel) {
     let type = __privateGet(this, _levels)[logLevel];
     let date = (/* @__PURE__ */ new Date()).toISOString().split(".")[0].replace("T", " ");
@@ -463,31 +474,68 @@ var Logger = class {
     }
     return `[${date}] ${type} ${message}`;
   }
+  /**
+   * Logs an error message.
+   * @param {*} message - The error message.
+   */
   static error(message) {
     __privateMethod(this, _processMessage, processMessage_fn).call(this, message, 0);
   }
+  /**
+   * Logs a warning message.
+   * @param {*} message - The warning message.
+   */
   static warn(message) {
     __privateMethod(this, _processMessage, processMessage_fn).call(this, message, 1);
   }
+  /**
+   * Logs an informational message.
+   * @param {*} message - The informational message.
+   */
   static info(message) {
     __privateMethod(this, _processMessage, processMessage_fn).call(this, message, 2);
   }
+  /**
+   * Logs an HTTP-related message.
+   * @param {*} message - The HTTP-related message.
+   */
   static http(message) {
     __privateMethod(this, _processMessage, processMessage_fn).call(this, message, 3);
   }
+  /**
+   * Logs a verbose message.
+   * @param {*} message - The verbose message.
+   */
   static verbose(message) {
     __privateMethod(this, _processMessage, processMessage_fn).call(this, message, 4);
   }
+  /**
+   * Logs a debug message.
+   * @param {*} message - The debug message.
+   */
   static debug(message) {
     __privateMethod(this, _processMessage, processMessage_fn).call(this, message, 5);
   }
+  /**
+   * Logs a silly message.
+   * @param {*} message - The silly message.
+   */
   static silly(message) {
     __privateMethod(this, _processMessage, processMessage_fn).call(this, message, 6);
   }
+  /**
+   * Appends a message to NDJson format.
+   * @param {string} message - The message to append.
+   * @param {number} logLevel - The log level associated with the message.
+   */
   static putNDJson(message, logLevel) {
     let separator = __privateGet(this, _NDJson).length !== 0 ? "\n" : "";
     __privateSet(this, _NDJson, __privateGet(this, _NDJson) + (separator + JSON.stringify({ "time": (/* @__PURE__ */ new Date()).toISOString(), "level": logLevel, "msg": message })));
   }
+  /**
+   * Gets the NDJson log.
+   * @returns {string} - The NDJson log.
+   */
   static getNDJson() {
     return __privateGet(this, _NDJson);
   }
@@ -515,11 +563,32 @@ processMessage_fn = function(message, level2) {
       break;
   }
 };
+/**
+ * Processes and logs a message with the specified log level.
+ * @param {*} message - The log message.
+ * @param {number} level - The log level.
+ */
 __privateAdd(Logger, _processMessage);
 __privateAdd(Logger, _NDJson, "");
+/**
+ * Indicates whether NDJson is enabled.
+ * @type {boolean}
+ */
 __publicField(Logger, "NDJson", false);
+/**
+ * The log level of the logger.
+ * @type {number}
+ */
 __publicField(Logger, "level", 2);
+/**
+ * Indicates whether colors are enabled for log messages.
+ * @type {boolean}
+ */
 __publicField(Logger, "colors", true);
+/**
+ * Defines log levels and their associated numeric values.
+ * @type {Object}
+ */
 __publicField(Logger, "levels", {
   error: 0,
   warn: 1,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rabbit-company/logger",
-	"version": "2.0.1",
+	"version": "2.1.1",
 	"description": "Simple logger",
 	"main": "./src/logger.js",
 	"browser": "./module/logger.js",
@@ -15,7 +15,9 @@
 	},
 	"files": [
 		"module/logger.js",
-		"src/logger.js"
+		"module/logger.d.ts",
+		"src/logger.js",
+		"src/logger.d.ts"
 	],
 	"repository": {
 		"type": "git",
@@ -35,6 +37,6 @@
 		"@rabbit-company/rabbit-builder": "^1.0.5"
 	},
 	"dependencies": {
-		"chalk": "^5.2.0"
+		"chalk": "^5.3.0"
 	}
 }

package/src/logger.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Represents a logger utility for logging messages with different log levels.
+ */
+export default class Logger {
+	static "__#1@#NDJson": string;
+	/**
+	 * Indicates whether NDJson is enabled.
+	 * @type {boolean}
+	 */
+	static NDJson: boolean;
+	/**
+	 * The log level of the logger.
+	 * @type {number}
+	 */
+	static level: number;
+	/**
+	 * Indicates whether colors are enabled for log messages.
+	 * @type {boolean}
+	 */
+	static colors: boolean;
+	/**
+	 * Defines log levels and their associated numeric values.
+	 * @type {Object}
+	 */
+	static levels: any;
+	static "__#1@#levels": {
+			0: string;
+			1: string;
+			2: string;
+			3: string;
+			4: string;
+			5: string;
+			6: string;
+	};
+	/**
+	 * Parses the log message to ensure it is a string.
+	 * @param {*} message - The log message.
+	 * @returns {string | null} - The parsed log message or null if the message is undefined.
+	 */
+	static parseMessage(message: any): string | null;
+	/**
+	 * Formats the log message with timestamp and log level.
+	 * @param {string} message - The log message.
+	 * @param {number} logLevel - The log level.
+	 * @returns {string} - The formatted log message.
+	 */
+	static formatMessage(message: string, logLevel: number): string;
+	/**
+	 * Processes and logs a message with the specified log level.
+	 * @param {*} message - The log message.
+	 * @param {number} level - The log level.
+	 */
+	static "__#1@#processMessage"(message: any, level: number): void;
+	/**
+	 * Logs an error message.
+	 * @param {*} message - The error message.
+	 */
+	static error(message: any): void;
+	/**
+	 * Logs a warning message.
+	 * @param {*} message - The warning message.
+	 */
+	static warn(message: any): void;
+	/**
+	 * Logs an informational message.
+	 * @param {*} message - The informational message.
+	 */
+	static info(message: any): void;
+	/**
+	 * Logs an HTTP-related message.
+	 * @param {*} message - The HTTP-related message.
+	 */
+	static http(message: any): void;
+	/**
+	 * Logs a verbose message.
+	 * @param {*} message - The verbose message.
+	 */
+	static verbose(message: any): void;
+	/**
+	 * Logs a debug message.
+	 * @param {*} message - The debug message.
+	 */
+	static debug(message: any): void;
+	/**
+	 * Logs a silly message.
+	 * @param {*} message - The silly message.
+	 */
+	static silly(message: any): void;
+	/**
+	 * Appends a message to NDJson format.
+	 * @param {string} message - The message to append.
+	 * @param {number} logLevel - The log level associated with the message.
+	 */
+	static putNDJson(message: string, logLevel: number): void;
+	/**
+	 * Gets the NDJson log.
+	 * @returns {string} - The NDJson log.
+	 */
+	static getNDJson(): string;
+}

package/src/logger.js

@@ -1,13 +1,34 @@
 import chalk from 'chalk';
 
+/**
+ * Represents a logger utility for logging messages with different log levels.
+ */
 export default class Logger{
 
 	static #NDJson = '';
+
+  /**
+   * Indicates whether NDJson is enabled.
+   * @type {boolean}
+   */
 	static NDJson = false;
 
+  /**
+   * The log level of the logger.
+   * @type {number}
+   */
 	static level = 2;
+
+  /**
+   * Indicates whether colors are enabled for log messages.
+   * @type {boolean}
+   */
 	static colors = true;
 
+  /**
+   * Defines log levels and their associated numeric values.
+   * @type {Object}
+   */
 	static levels = {
 		error: 0,
 		warn: 1,
@@ -28,12 +49,23 @@ export default class Logger{
 		6: 'SILLY'
 	}
 
+  /**
+   * Parses the log message to ensure it is a string.
+   * @param {*} message - The log message.
+   * @returns {string | null} - The parsed log message or null if the message is undefined.
+   */
 	static parseMessage(message){
 		if(typeof(message) === 'undefined') return null;
 		if(typeof(message) === 'object') message = JSON.stringify(message);
 		return message;
 	}
 
+  /**
+   * Formats the log message with timestamp and log level.
+   * @param {string} message - The log message.
+   * @param {number} logLevel - The log level.
+   * @returns {string} - The formatted log message.
+   */
 	static formatMessage(message, logLevel){
 		let type = this.#levels[logLevel];
 		let date = new Date().toISOString().split('.')[0].replace('T', ' ');
@@ -76,6 +108,11 @@ export default class Logger{
 		return `[${date}] ${type} ${message}`;
 	}
 
+  /**
+   * Processes and logs a message with the specified log level.
+   * @param {*} message - The log message.
+   * @param {number} level - The log level.
+   */
 	static #processMessage(message, level){
 		if(this.level < level) return;
 		message = this.parseMessage(message);
@@ -95,39 +132,77 @@ export default class Logger{
 		}
 	}
 
+
+  /**
+   * Logs an error message.
+   * @param {*} message - The error message.
+   */
 	static error(message){
 		this.#processMessage(message, 0);
 	}
 
+  /**
+   * Logs a warning message.
+   * @param {*} message - The warning message.
+   */
 	static warn(message){
 		this.#processMessage(message, 1);
 	}
 
+  /**
+   * Logs an informational message.
+   * @param {*} message - The informational message.
+   */
 	static info(message){
 		this.#processMessage(message, 2);
 	}
 
+  /**
+   * Logs an HTTP-related message.
+   * @param {*} message - The HTTP-related message.
+   */
 	static http(message){
 		this.#processMessage(message, 3);
 	}
 
+  /**
+   * Logs a verbose message.
+   * @param {*} message - The verbose message.
+   */
 	static verbose(message){
 		this.#processMessage(message, 4);
 	}
 
+  /**
+   * Logs a debug message.
+   * @param {*} message - The debug message.
+   */
 	static debug(message){
 		this.#processMessage(message, 5);
 	}
 
+  /**
+   * Logs a silly message.
+   * @param {*} message - The silly message.
+   */
 	static silly(message){
 		this.#processMessage(message, 6);
 	}
 
+  /**
+   * Appends a message to NDJson format.
+   * @param {string} message - The message to append.
+   * @param {number} logLevel - The log level associated with the message.
+   */
 	static putNDJson(message, logLevel){
 		let separator = (this.#NDJson.length !== 0) ? '\n' : '';
 		this.#NDJson += separator + JSON.stringify({ 'time': new Date().toISOString(), 'level': logLevel, 'msg': message });
 	}
 
+  /**
+   * Gets the NDJson log.
+   * @returns {string} - The NDJson log.
+   */
 	static getNDJson(){
 		return this.#NDJson;
 	}