@theshelf/logging 0.2.0 → 0.3.0

package/README.md

@@ -16,6 +16,7 @@ Currently, there are three drivers available:
 * **Void** - dummy driver that doesn't log anything (suited for testing).
 * **Memory** - in memory logging (suited for testing).
 * **Console** - driver based on the Node.js console.
+* **Database** - driver that logs messages into a database.
 
 ## How to use
 
@@ -56,10 +57,24 @@ No configuration options.
 
 No configuration options.
 
+#### Database driver
+
+The database driver requires a [database](https://github.com/MaskingTechnology/theshelf/tree/main/packages/database) from @theshelf and a table name (record type) to log messages into.
+
+```ts
+import { database } from './your-database-instance';
+
+const recordType = 'logs';
+const driver = new DatabaseDriver(database, recordType);
+
+const logger = new Logger(driver);
+```
+
 ### Operations
 
 ```ts
-import logger from '@theshelf/logging';
+// Log debug
+await logger.logDebug(message);
 
 // Log info
 await logger.logInfo(message);
@@ -70,8 +85,8 @@ await logger.logWarn(message);
 // Log error
 await logger.logError(message);
 
-// Log debug information
-await logger.logDebug(message);
+// Log fatal
+await logger.logFatal(message);
 
 // Log multiple messages (works for all levels)
 await logger.logInfo(message1, message2, ...);

package/dist/drivers/Database.d.ts

@@ -0,0 +1,12 @@
+import type Database from '@theshelf/database';
+import type { RecordType } from '@theshelf/database';
+import type { Driver } from '../definitions/interfaces.js';
+export default class DatabaseDriver implements Driver {
+    #private;
+    constructor(database: Database, recordType: RecordType);
+    logDebug(message: string): Promise<void>;
+    logInfo(message: string): Promise<void>;
+    logWarn(message: string): Promise<void>;
+    logError(message: string): Promise<void>;
+    logFatal(message: string): Promise<void>;
+}

package/dist/drivers/Database.js

@@ -0,0 +1,31 @@
+export default class DatabaseDriver {
+    #database;
+    #recordType;
+    constructor(database, recordType) {
+        this.#recordType = recordType;
+        this.#database = database;
+    }
+    logDebug(message) {
+        return this.#logRecord('DEBUG', message);
+    }
+    logInfo(message) {
+        return this.#logRecord('INFO', message);
+    }
+    logWarn(message) {
+        return this.#logRecord('WARN', message);
+    }
+    logError(message) {
+        return this.#logRecord('ERROR', message);
+    }
+    logFatal(message) {
+        return this.#logRecord('FATAL', message);
+    }
+    async #logRecord(level, message) {
+        const data = {
+            timestamp: new Date().toISOString(),
+            level,
+            message
+        };
+        await this.#database.createRecord(this.#recordType, data);
+    }
+}

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export type * from './definitions/constants.js';
 export type * from './definitions/interfaces.js';
 export { default as LogError } from './errors/LogError.js';
 export { default as ConsoleDriver } from './drivers/Console.js';
+export { default as DatabaseDriver } from './drivers/Database.js';
 export { default as MemoryDriver } from './drivers/Memory.js';
 export { default as VoidDriver } from './drivers/Void.js';
 export { default } from './Logger.js';

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from './definitions/constants.js';
 export { default as LogError } from './errors/LogError.js';
 export { default as ConsoleDriver } from './drivers/Console.js';
+export { default as DatabaseDriver } from './drivers/Database.js';
 export { default as MemoryDriver } from './drivers/Memory.js';
 export { default as VoidDriver } from './drivers/Void.js';
 export { default } from './Logger.js';

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@theshelf/logging",
   "private": false,
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
   "repository": {
-    "url": "https://github.com/MaskingTechnology/theshelf"
+    "url": "git+https://github.com/MaskingTechnology/theshelf.git"
   },
   "scripts": {
     "build": "tsc",
@@ -20,5 +20,13 @@
     "dist"
   ],
   "types": "dist/index.d.ts",
-  "exports": "./dist/index.js"
+  "exports": "./dist/index.js",
+  "peerDependencies": {
+    "@theshelf/database": "^0.3.0"
+  },
+  "peerDependenciesMeta": {
+    "@theshelf/database": {
+      "optional": true
+    }
+  }
 }