@loglayer/transport-pretty-terminal 5.0.2 → 6.0.0

package/dist/index.d.cts

@@ -3,6 +3,34 @@ import * as chalk from "chalk";
 import { ChalkInstance } from "chalk";
 
 //#region src/types.d.ts
+/**
+ * Minimal interface for a prepared SQLite statement.
+ * Compatible with better-sqlite3, bun:sqlite, and other synchronous SQLite bindings.
+ */
+interface SqliteStatement {
+  run(...params: unknown[]): unknown;
+  all(...params: unknown[]): unknown[];
+  get(...params: unknown[]): unknown;
+}
+/**
+ * Minimal interface for a SQLite database instance.
+ * Compatible with better-sqlite3, bun:sqlite, and other synchronous SQLite bindings.
+ *
+ * @example
+ * // Using bun:sqlite
+ * import { Database } from "bun:sqlite";
+ * getPrettyTerminal({ database: new Database(":memory:") });
+ *
+ * @example
+ * // Using better-sqlite3
+ * import Database from "better-sqlite3";
+ * getPrettyTerminal({ database: new Database(":memory:") });
+ */
+interface SqliteDatabaseInstance {
+  exec(sql: string): void;
+  prepare(sql: string): SqliteStatement;
+  close(): void;
+}
 /**
  * Represents a single log entry in the storage system.
  * Each entry contains metadata and the actual log content.
@@ -99,8 +127,12 @@ interface PrettyTerminalConfig extends LoggerlessTransportConfig {
   maxInlineLength?: number;
   /** Custom theme configuration for log display */
   theme?: PrettyTerminalTheme;
-  /** Path to SQLite file for persistent storage. If not provided, uses in-memory database */
-  logFile?: string;
+  /**
+   * SQLite database instance to use for log storage.
+   * The instance must implement `exec`, `prepare`, and `close`.
+   * Compatible with better-sqlite3, bun:sqlite, and other synchronous SQLite bindings.
+   */
+  database: SqliteDatabaseInstance;
   /** Whether the transport is enabled. If false, all operations will no-op. Defaults to true */
   enabled?: boolean;
   /** Whether to disable interactive mode (keyboard input and navigation). Useful when multiple applications need to print to the same terminal. Defaults to false */
@@ -147,7 +179,7 @@ declare class PrettyTerminalTransport extends LoggerlessTransport {
    * @param config - Configuration options for the transport
    * @throws Error if attempting to create multiple instances
    */
-  constructor(config?: PrettyTerminalConfig);
+  constructor(config: PrettyTerminalConfig);
   /**
    * Gets or creates the singleton instance of PrettyTerminalTransport.
    * This is the recommended way to obtain a transport instance.
@@ -155,7 +187,7 @@ declare class PrettyTerminalTransport extends LoggerlessTransport {
    * @param config - Configuration options for the transport
    * @returns The singleton instance of PrettyTerminalTransport
    */
-  static getInstance(config?: PrettyTerminalConfig): PrettyTerminalTransport;
+  static getInstance(config: PrettyTerminalConfig): PrettyTerminalTransport;
   /**
    * Generates a random ID for each log entry.
    * Uses base36 encoding for compact, readable IDs.
@@ -267,7 +299,7 @@ declare const nature: PrettyTerminalTheme;
 declare const pastel: PrettyTerminalTheme;
 //#endregion
 //#region src/index.d.ts
-declare function getPrettyTerminal(config?: PrettyTerminalConfig): PrettyTerminalTransport;
+declare function getPrettyTerminal(config: PrettyTerminalConfig): PrettyTerminalTransport;
 //#endregion
-export { ColorConfig, DetailedViewConfig, LogEntry, PrettyTerminalConfig, PrettyTerminalTheme, PrettyTerminalTransport, ViewConfig, chalk, getPrettyTerminal, moonlight, nature, neon, pastel, sunlight };
+export { ColorConfig, DetailedViewConfig, LogEntry, PrettyTerminalConfig, PrettyTerminalTheme, PrettyTerminalTransport, SqliteDatabaseInstance, SqliteStatement, ViewConfig, chalk, getPrettyTerminal, moonlight, nature, neon, pastel, sunlight };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -3,6 +3,34 @@ import * as chalk from "chalk";
 import { ChalkInstance } from "chalk";
 
 //#region src/types.d.ts
+/**
+ * Minimal interface for a prepared SQLite statement.
+ * Compatible with better-sqlite3, bun:sqlite, and other synchronous SQLite bindings.
+ */
+interface SqliteStatement {
+  run(...params: unknown[]): unknown;
+  all(...params: unknown[]): unknown[];
+  get(...params: unknown[]): unknown;
+}
+/**
+ * Minimal interface for a SQLite database instance.
+ * Compatible with better-sqlite3, bun:sqlite, and other synchronous SQLite bindings.
+ *
+ * @example
+ * // Using bun:sqlite
+ * import { Database } from "bun:sqlite";
+ * getPrettyTerminal({ database: new Database(":memory:") });
+ *
+ * @example
+ * // Using better-sqlite3
+ * import Database from "better-sqlite3";
+ * getPrettyTerminal({ database: new Database(":memory:") });
+ */
+interface SqliteDatabaseInstance {
+  exec(sql: string): void;
+  prepare(sql: string): SqliteStatement;
+  close(): void;
+}
 /**
  * Represents a single log entry in the storage system.
  * Each entry contains metadata and the actual log content.
@@ -99,8 +127,12 @@ interface PrettyTerminalConfig extends LoggerlessTransportConfig {
   maxInlineLength?: number;
   /** Custom theme configuration for log display */
   theme?: PrettyTerminalTheme;
-  /** Path to SQLite file for persistent storage. If not provided, uses in-memory database */
-  logFile?: string;
+  /**
+   * SQLite database instance to use for log storage.
+   * The instance must implement `exec`, `prepare`, and `close`.
+   * Compatible with better-sqlite3, bun:sqlite, and other synchronous SQLite bindings.
+   */
+  database: SqliteDatabaseInstance;
   /** Whether the transport is enabled. If false, all operations will no-op. Defaults to true */
   enabled?: boolean;
   /** Whether to disable interactive mode (keyboard input and navigation). Useful when multiple applications need to print to the same terminal. Defaults to false */
@@ -147,7 +179,7 @@ declare class PrettyTerminalTransport extends LoggerlessTransport {
    * @param config - Configuration options for the transport
    * @throws Error if attempting to create multiple instances
    */
-  constructor(config?: PrettyTerminalConfig);
+  constructor(config: PrettyTerminalConfig);
   /**
    * Gets or creates the singleton instance of PrettyTerminalTransport.
    * This is the recommended way to obtain a transport instance.
@@ -155,7 +187,7 @@ declare class PrettyTerminalTransport extends LoggerlessTransport {
    * @param config - Configuration options for the transport
    * @returns The singleton instance of PrettyTerminalTransport
    */
-  static getInstance(config?: PrettyTerminalConfig): PrettyTerminalTransport;
+  static getInstance(config: PrettyTerminalConfig): PrettyTerminalTransport;
   /**
    * Generates a random ID for each log entry.
    * Uses base36 encoding for compact, readable IDs.
@@ -267,7 +299,7 @@ declare const nature: PrettyTerminalTheme;
 declare const pastel: PrettyTerminalTheme;
 //#endregion
 //#region src/index.d.ts
-declare function getPrettyTerminal(config?: PrettyTerminalConfig): PrettyTerminalTransport;
+declare function getPrettyTerminal(config: PrettyTerminalConfig): PrettyTerminalTransport;
 //#endregion
-export { ColorConfig, DetailedViewConfig, LogEntry, PrettyTerminalConfig, PrettyTerminalTheme, PrettyTerminalTransport, ViewConfig, chalk, getPrettyTerminal, moonlight, nature, neon, pastel, sunlight };
+export { ColorConfig, DetailedViewConfig, LogEntry, PrettyTerminalConfig, PrettyTerminalTheme, PrettyTerminalTransport, SqliteDatabaseInstance, SqliteStatement, ViewConfig, chalk, getPrettyTerminal, moonlight, nature, neon, pastel, sunlight };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -3,8 +3,6 @@ import * as chalk from "chalk";
 import chalk$1 from "chalk";
 import wrap from "wrap-ansi";
 import truncate from "cli-truncate";
-import { resolve } from "node:path";
-import Database from "better-sqlite3";
 import keypress from "keypress";
 
 //#region src/vendor/utils.js
@@ -660,12 +658,7 @@ var LogRenderer = class {
 //#endregion
 //#region src/LogStorage.ts
 /**
-* LogStorage handles the persistence of log entries using SQLite.
-* Uses an in-memory database for fast access and temporary storage.
-*/
-/**
 * Handles storage and retrieval of log entries using SQLite.
-* Uses an in-memory database for optimal performance and automatic cleanup.
 *
 * The database schema includes:
 * - id: Unique identifier for each log
@@ -675,18 +668,9 @@ var LogRenderer = class {
 * - data: Optional structured data as JSON string
 */
 var LogStorage = class {
-	/** SQLite database instance */
 	db;
-	/**
-	* Creates a new LogStorage instance.
-	* Initializes a SQLite database and creates the logs table.
-	*
-	* @param logFile - Optional path to SQLite file for persistent storage.
-	*                 If not provided, uses in-memory database.
-	*                 Relative paths are resolved from the current working directory.
-	*/
-	constructor(logFile) {
-		this.db = new Database(logFile ? logFile.startsWith("/") ? logFile : resolve(process.cwd(), logFile) : ":memory:");
+	constructor(database) {
+		this.db = database;
 		this.initializeDatabase();
 	}
 	/**
@@ -1545,7 +1529,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends LoggerlessTr
 	* @param config - Configuration options for the transport
 	* @throws Error if attempting to create multiple instances
 	*/
-	constructor(config = {}) {
+	constructor(config) {
 		if (PrettyTerminalTransport.instance) throw new Error("PrettyTerminalTransport is a singleton. Use getPrettyTerminal() instead.");
 		super(config);
 		this.config = config;
@@ -1553,7 +1537,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends LoggerlessTr
 		const maxInlineDepth = config.maxInlineDepth || 4;
 		const maxInlineLength = config.maxInlineLength || 120;
 		const theme = config.theme || moonlight;
-		const logFile = config.logFile;
+		const database = config.database;
 		const simpleViewConfig = {
 			colors: {
 				trace: chalk$1.gray,
@@ -1600,7 +1584,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends LoggerlessTr
 				...theme.detailedView?.jsonColors
 			}
 		};
-		this.storage = new LogStorage(logFile);
+		this.storage = new LogStorage(database);
 		this.renderer = new LogRenderer(simpleViewConfig, detailedViewConfig, maxInlineDepth, maxInlineLength);
 		this.uiManager = new UIManager(this.renderer, this.storage, config.disableInteractiveMode);
 		PrettyTerminalTransport.instance = this;
@@ -1612,7 +1596,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends LoggerlessTr
 	* @param config - Configuration options for the transport
 	* @returns The singleton instance of PrettyTerminalTransport
 	*/
-	static getInstance(config = {}) {
+	static getInstance(config) {
 		if (!PrettyTerminalTransport.instance) PrettyTerminalTransport.instance = new PrettyTerminalTransport(config);
 		return PrettyTerminalTransport.instance;
 	}
@@ -1657,7 +1641,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends LoggerlessTr
 
 //#endregion
 //#region src/index.ts
-function getPrettyTerminal(config = {}) {
+function getPrettyTerminal(config) {
 	return PrettyTerminalTransport.getInstance(config);
 }