@loglayer/transport-pretty-terminal 5.0.2 → 6.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Theo Gravity
+Copyright (c) 2026 Theo Gravity / [Disaresta](https://disaresta.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -3,6 +3,7 @@
 [![NPM Version](https://img.shields.io/npm/v/%40loglayer%2Ftransport-pretty-terminal)](https://www.npmjs.com/package/@loglayer/transport-pretty-terminal)
 [![NPM Downloads](https://img.shields.io/npm/dm/%40loglayer%2Ftransport-pretty-terminal)](https://www.npmjs.com/package/@loglayer/transport-pretty-terminal)
 [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+[![Bun](https://img.shields.io/badge/Bun-compatible-F9F1E1?logo=bun)](https://bun.sh)
 
 A transport for the [LogLayer](https://loglayer.dev) logging library that pretty-prints logs printed in the terminal.
 
@@ -27,4 +28,68 @@ Use [Simple Pretty terminal](https://loglayer.dev/transports/simple-pretty-termi
 
 ## Installation
 
-Visit the [Pretty Terminal docs](https://loglayer.dev/transports/pretty-terminal) for installation and usage.
+### Node.js
+
+```bash
+npm install loglayer @loglayer/transport-pretty-terminal serialize-error better-sqlite3
+```
+
+### Bun
+
+Bun has a built-in SQLite module — `better-sqlite3` is not needed. Pass a `bun:sqlite` `Database` via the `database` option (see usage below).
+
+```bash
+bun add loglayer @loglayer/transport-pretty-terminal serialize-error
+```
+
+## Usage
+
+### Node.js
+
+```typescript
+import Database from 'better-sqlite3';
+import { LogLayer, ConsoleTransport } from 'loglayer';
+import { getPrettyTerminal } from '@loglayer/transport-pretty-terminal';
+import { serializeError } from 'serialize-error';
+
+const log = new LogLayer({
+  errorSerializer: serializeError,
+  transport: [
+    new ConsoleTransport({
+      // Use console logging in non-development environments
+      enabled: process.env.NODE_ENV !== 'development',
+    }),
+    getPrettyTerminal({
+      database: new Database(':memory:'),
+      // Only enable Pretty Terminal in development
+      enabled: process.env.NODE_ENV === 'development',
+    }),
+  ],
+});
+```
+
+### Bun
+
+```typescript
+import { Database } from 'bun:sqlite';
+import { LogLayer, ConsoleTransport } from 'loglayer';
+import { getPrettyTerminal } from '@loglayer/transport-pretty-terminal';
+import { serializeError } from 'serialize-error';
+
+const log = new LogLayer({
+  errorSerializer: serializeError,
+  transport: [
+    new ConsoleTransport({
+      // Use console logging in non-development environments
+      enabled: process.env.NODE_ENV !== 'development',
+    }),
+    getPrettyTerminal({
+      database: new Database(':memory:'),
+      // Only enable Pretty Terminal in development
+      enabled: process.env.NODE_ENV === 'development',
+    }),
+  ],
+});
+```
+
+For full documentation visit the [Pretty Terminal docs](https://loglayer.dev/transports/pretty-terminal).

package/dist/index.cjs

@@ -33,9 +33,6 @@ let wrap_ansi = require("wrap-ansi");
 wrap_ansi = __toESM(wrap_ansi);
 let cli_truncate = require("cli-truncate");
 cli_truncate = __toESM(cli_truncate);
-let node_path = require("node:path");
-let better_sqlite3 = require("better-sqlite3");
-better_sqlite3 = __toESM(better_sqlite3);
 let keypress = require("keypress");
 keypress = __toESM(keypress);
 
@@ -692,12 +689,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
@@ -707,18 +699,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 better_sqlite3.default(logFile ? logFile.startsWith("/") ? logFile : (0, node_path.resolve)(process.cwd(), logFile) : ":memory:");
+	constructor(database) {
+		this.db = database;
 		this.initializeDatabase();
 	}
 	/**
@@ -1577,7 +1560,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends _loglayer_tr
 	* @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;
@@ -1585,7 +1568,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends _loglayer_tr
 		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.default.gray,
@@ -1632,7 +1615,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends _loglayer_tr
 				...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;
@@ -1644,7 +1627,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends _loglayer_tr
 	* @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;
 	}
@@ -1689,7 +1672,7 @@ var PrettyTerminalTransport = class PrettyTerminalTransport extends _loglayer_tr
 
 //#endregion
 //#region src/index.ts
-function getPrettyTerminal(config = {}) {
+function getPrettyTerminal(config) {
 	return PrettyTerminalTransport.getInstance(config);
 }