@rabbit-company/logger 5.3.0 → 5.5.0

package/README.md

@@ -49,6 +49,9 @@ logger.error("Database connection failed", {
 	db: "primary",
 });
 
+// Dynamic log levels
+logger.log(Levels.WARN, "High memory usage detected", { usage: "85%" });
+
 // Audit logging
 logger.audit("User login", {
 	userId: "usr_123",
@@ -96,13 +99,18 @@ The console transport supports extensive datetime formatting:
 - `{type}`: Log level (INFO, ERROR, etc.)
 - `{message}`: The log message
 
+#### Metadata Placeholders:
+
+- `{metadata}`: JSON-stringified metadata (if provided)
+- `{metadata-ml}`: Multi-line JSON-formatted metadata (if provided)
+
 ```js
 import { ConsoleTransport } from "@rabbit-company/logger";
 
 // Custom format examples
-new ConsoleTransport("[{datetime-local}] {type} {message}");
-new ConsoleTransport("{time} | {type} | {message}", false);
-new ConsoleTransport("EPOCH:{ms} {message}");
+new ConsoleTransport("[{datetime-local}] {type} {message} {metadata}");
+new ConsoleTransport("{time} | {type} | {message} | {metadata}", false);
+new ConsoleTransport("EPOCH:{ms} - {message} - {metadata}");
 ```
 
 ## Transports 🚚
@@ -115,7 +123,7 @@ import { ConsoleTransport } from "@rabbit-company/logger";
 const logger = new Logger({
 	transports: [
 		new ConsoleTransport(
-			"[{time-local}] {type} {message}", // Custom format
+			"[{time-local}] {type} {message} {metadata}", // Custom format
 			true // Enable colors
 		),
 	],
@@ -203,7 +211,7 @@ Full API documentation is available in the [TypeScript definitions](https://gith
 
 ```js
 new ConsoleTransport(
-	"{type} - {date} - {message}", // Custom format
+	"{type} - {date} - {message} - {metadata}", // Custom format
 	false // Disable colors
 );
 ```

package/module/logger.d.ts

@@ -186,26 +186,30 @@ export interface Transport {
  * - `{type}`: Log level name (e.g., "INFO", "ERROR")
  * - `{message}`: The actual log message content
  *
+ * ## Metadata Placeholders
+ * - `{metadata}`: JSON-stringified metadata (if provided)
+ * - `{metadata-ml}`: Multi-line JSON-formatted metadata (if provided)
+ *
  * @property {Transport[]} [transports=[ConsoleTransport]] - Array of transports to use
  *
  * @example <caption>Default Format</caption>
  * {
- *   format: "[{datetime-local}] {type} {message}"
+ *   format: "[{datetime-local}] {type} {message} {metadata}"
  * }
  *
  * @example <caption>UTC Time Format</caption>
  * {
- *   format: "[{datetime} UTC] {type}: {message}"
+ *   format: "[{datetime} UTC] {type}: {message} {metadata}"
  * }
  *
  * @example <caption>Detailed Local Format</caption>
  * {
- *   format: "{date-local} {time-local} [{type}] {message}"
+ *   format: "{date-local} {time-local} [{type}] {message} {metadata}"
  * }
  *
  * @example <caption>Epoch Timestamp</caption>
  * {
- *   format: "{ms} - {type} - {message}"
+ *   format: "{ms} - {type} - {message} - {metadata}"
  * }
  */
 export interface LoggerConfig {
@@ -213,7 +217,7 @@ export interface LoggerConfig {
 	level?: Levels;
 	/** Enable colored output (default: true) */
 	colors?: boolean;
-	/** Format string using placeholders (default: "[{datetime-local}] {type} {message}") */
+	/** Format string using placeholders (default: "[{datetime-local}] {type} {message} {metadata}") */
 	format?: string;
 	/** Array of transports to use (default: [ConsoleTransport]) */
 	transports?: Transport[];
@@ -524,6 +528,21 @@ export declare class Logger {
 	 * @param entry The log entry to process
 	 */
 	private processEntry;
+	/**
+	 * Logs a message at the specified level with optional metadata.
+	 *
+	 * This is the primary logging method that all other level-specific methods
+	 * (error, warn, info, etc.) delegate to. It provides fine-grained control
+	 * over the log level and is useful for dynamic logging scenarios.
+	 *
+	 * @param level - The severity level for this log entry (use Levels enum)
+	 * @param message - The log message to record
+	 * @param metadata - Optional structured data to attach to the log entry
+	 *
+	 * @example
+	 * logger.log(Levels.ERROR, "Database connection failed", { error: error.stack });
+	 */
+	log(level: Levels, message: string, metadata?: Record<string, any>): void;
 	/**
 	 * Logs an error message (highest severity)
 	 * @param message The error message
@@ -642,7 +661,7 @@ export declare class Logger {
  * @example
  * // Custom format with local timestamps
  * const transport = new ConsoleTransport(
- *   "[{datetime-local}] {type} - {message}",
+ *   "[{datetime-local}] {type} - {message} {metadata}",
  *   true
  * );
  */
@@ -667,7 +686,11 @@ export declare class ConsoleTransport implements Transport {
 	 * - `{type}`: Log level name (e.g., "INFO")
 	 * - `{message}`: The log message content
 	 *
-	 * @default "[{datetime-local}] {type} {message}"
+	 * ### Metadata Placeholders
+	 * - `{metadata}`: JSON-stringified metadata (if provided)
+	 * - `{metadata-ml}`: Multi-line JSON-formatted metadata (if provided)
+	 *
+	 * @default "[{datetime-local}] {type} {message} {metadata}"
 	 *
 	 * @param colors Enable ANSI color output. When disabled:
 	 *   - Improves performance in non-TTY environments
@@ -676,11 +699,11 @@ export declare class ConsoleTransport implements Transport {
 	 *
 	 * @example
 	 * // UTC format example
-	 * new ConsoleTransport("{date} {time} [{type}] {message}");
+	 * new ConsoleTransport("{date} {time} [{type}] {message} {metadata}");
 	 *
 	 * @example
 	 * // Local time with colors disabled
-	 * new ConsoleTransport("{time-local} - {message}", false);
+	 * new ConsoleTransport("{time-local} - {message} {metadata}", false);
 	 */
 	constructor(format?: string, colors?: boolean);
 	/**

package/module/logger.js

@@ -47,7 +47,7 @@ var LevelColors = {
   [7 /* SILLY */]: "\x1B[90m" /* BRIGHT_BLACK */
 };
 // src/formatters/consoleFormatter.ts
-function formatConsoleMessage(message, logLevel, format, colorsEnabled) {
+function formatConsoleMessage(message, logLevel, metadata, format, colorsEnabled) {
   const now = new Date;
   const type = Levels[logLevel];
   const utcFormats = {
@@ -64,22 +64,36 @@ function formatConsoleMessage(message, logLevel, format, colorsEnabled) {
     "{date-local}": now.toLocaleDateString("sv-SE"),
     "{full-local}": now.toString()
   };
+  const metadataFormats = {};
+  if (metadata) {
+    metadataFormats["{metadata}"] = JSON.stringify(metadata);
+    metadataFormats["{metadata-ml}"] = JSON.stringify(metadata, null, 2);
+    if (colorsEnabled) {
+      const color = LevelColors[logLevel];
+      const colorize = (text) => color + text + "\x1B[0m" /* RESET */;
+      for (const key in metadataFormats) {
+        metadataFormats[key] = colorize(metadataFormats[key]);
+      }
+    }
+  } else {
+    format = format.replace(/{metadata(-ml)?}/g, "");
+  }
   let coloredType = type;
   let coloredMessage = message;
   if (colorsEnabled) {
     const color = LevelColors[logLevel];
     const colorize = (text) => "\x1B[90m" /* BRIGHT_BLACK */ + text + "\x1B[0m" /* RESET */;
-    Object.keys(utcFormats).forEach((key) => {
+    for (const key in utcFormats) {
       utcFormats[key] = colorize(utcFormats[key]);
-    });
-    Object.keys(localFormats).forEach((key) => {
+    }
+    for (const key in localFormats) {
       localFormats[key] = colorize(localFormats[key]);
-    });
+    }
     coloredType = "\x1B[1m" /* BOLD */ + color + type + "\x1B[0m" /* RESET */;
     coloredMessage = color + message + "\x1B[0m" /* RESET */;
   }
   let output = format;
-  const allFormats = { ...utcFormats, ...localFormats };
+  const allFormats = { ...utcFormats, ...localFormats, ...metadataFormats };
   for (const [placeholder, value] of Object.entries(allFormats)) {
     output = output.replace(new RegExp(placeholder, "g"), value);
   }
@@ -90,12 +104,12 @@ function formatConsoleMessage(message, logLevel, format, colorsEnabled) {
 class ConsoleTransport {
   format;
   colors;
-  constructor(format = "[{datetime-local}] {type} {message}", colors = true) {
+  constructor(format = "[{datetime-local}] {type} {message} {metadata}", colors = true) {
     this.format = format;
     this.colors = colors;
   }
   log(entry) {
-    console.info(formatConsoleMessage(entry.message, entry.level, this.format, this.colors));
+    console.info(formatConsoleMessage(entry.message, entry.level, entry.metadata, this.format, this.colors));
   }
 }
 
@@ -129,29 +143,32 @@ class Logger {
       transport.log(entry);
     }
   }
+  log(level, message, metadata) {
+    this.processEntry(this.createLogEntry(message, level, metadata));
+  }
   error(message, metadata) {
-    this.processEntry(this.createLogEntry(message, 0 /* ERROR */, metadata));
+    this.log(0 /* ERROR */, message, metadata);
   }
   warn(message, metadata) {
-    this.processEntry(this.createLogEntry(message, 1 /* WARN */, metadata));
+    this.log(1 /* WARN */, message, metadata);
   }
   audit(message, metadata) {
-    this.processEntry(this.createLogEntry(message, 2 /* AUDIT */, metadata));
+    this.log(2 /* AUDIT */, message, metadata);
   }
   info(message, metadata) {
-    this.processEntry(this.createLogEntry(message, 3 /* INFO */, metadata));
+    this.log(3 /* INFO */, message, metadata);
   }
   http(message, metadata) {
-    this.processEntry(this.createLogEntry(message, 4 /* HTTP */, metadata));
+    this.log(4 /* HTTP */, message, metadata);
   }
   debug(message, metadata) {
-    this.processEntry(this.createLogEntry(message, 5 /* DEBUG */, metadata));
+    this.log(5 /* DEBUG */, message, metadata);
   }
   verbose(message, metadata) {
-    this.processEntry(this.createLogEntry(message, 6 /* VERBOSE */, metadata));
+    this.log(6 /* VERBOSE */, message, metadata);
   }
   silly(message, metadata) {
-    this.processEntry(this.createLogEntry(message, 7 /* SILLY */, metadata));
+    this.log(7 /* SILLY */, message, metadata);
   }
   addTransport(transport) {
     this.transports.push(transport);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rabbit-company/logger",
-	"version": "5.3.0",
+	"version": "5.5.0",
 	"description": "A simple and lightweight logger",
 	"main": "./module/logger.js",
 	"type": "module",