@serhii.mazur/directus-gu-logs 1.0.1

package/README.MD

@@ -0,0 +1,53 @@
+# 📦 Custom Directus Logs Utility
+
+A lightweight utility class for logging errors, creating activity logs, and sending notifications in Directus extensions.
+
+## 📋 Requirements:
+
+### 1. Logs Collection (logs)
+
+You need to create a collection named `logs` with the following fields:
+
+| Field Name      | Type     | Description              |
+| --------------- | -------- | ------------------------ |
+| `collection`    | string   | Name of the collection   |
+| `date_created`  | datetime | Timestamp of the log     |
+| `extension`     | string   | Extension identifier     |
+| `function_name` | string   | Name of the function     |
+| `error`         | code     | Error message/code block |
+
+### 2. Global Collection (global)
+
+Add the following field to the `global` collection:
+
+| Field Name         | Type                 | Description                       |
+| ------------------ | -------------------- | --------------------------------- |
+| `notice_recipient` | m2o → directus_users | Recipient for error notifications |
+
+This recipient will be used to send internal notifications when errors occur.
+
+## 🚀 Features
+
+-   Save error logs to the logs collection
+
+-   Create Directus activity records
+
+-   Send internal Directus notifications
+
+## 📦 Installation
+
+```bash
+npm install @serhii.mazur/directus-gu-logs
+```
+
+## 🧩 Usage
+
+```ts
+import { Logs } from "@serhii.mazur/directus-gu-logs";
+
+const logs = new Logs(context, "logs", "my-extension");
+
+await logs.printLogs("myFunction", "message");
+await logs.createActivity("create", "collection", "id", "comment");
+await logs.createNotification("An error occurred");
+```

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { ApiExtensionContext } from "@directus/extensions";
+import type { PrimaryKey } from "@directus/types";
+export declare class Logs {
+    protected context: ApiExtensionContext;
+    protected collectionName: string;
+    protected extension: string;
+    constructor(context: ApiExtensionContext, collectionName?: string, extension?: string);
+    private getSchema;
+    private createOne;
+    printLogs(functionName: string, error: string): Promise<void>;
+    createActivity(action: "create" | "update" | "delete" | undefined, collection: string, id: PrimaryKey, comment?: string): Promise<void>;
+    createNotification(message?: string): Promise<void>;
+}

package/dist/index.js

@@ -0,0 +1,83 @@
+export class Logs {
+    constructor(context, collectionName = "logs", extension = "unknown") {
+        this.context = context;
+        this.collectionName = collectionName;
+        this.extension = extension;
+    }
+    async getSchema() {
+        return await this.context.getSchema();
+    }
+    async createOne(data) {
+        const schema = await this.getSchema();
+        const itemsService = new this.context.services.ItemsService(this.collectionName, {
+            database: this.context.database,
+            schema,
+        });
+        return await itemsService.createOne(data);
+    }
+    async printLogs(functionName, error) {
+        const data = {
+            collection: this.collectionName,
+            date_created: new Date().toISOString(),
+            extension: this.extension,
+            function_name: functionName,
+            error,
+        };
+        try {
+            await this.createOne(data);
+            console.error(`🚀 [${this.extension}] ${functionName}:`, error);
+        }
+        catch (error) {
+            console.error("❌ Failed to save logs:", error);
+        }
+    }
+    async createActivity(action = "create", collection, id, comment = "") {
+        try {
+            const schema = await this.getSchema();
+            const services = this.context.services;
+            const accountability = services.accountability;
+            const activityService = new services.ActivityService({
+                schema: schema,
+                accountability: accountability,
+                knex: this.context.database,
+            });
+            await activityService.createOne({
+                action,
+                comment,
+                user: accountability?.user ?? null,
+                collection,
+                ip: accountability?.ip ?? null,
+                user_agent: accountability?.userAgent ?? null,
+                origin: accountability?.origin ?? null,
+                item: id,
+            });
+        }
+        catch (error) {
+            console.error("❌ Failed to create activity log:", error);
+        }
+    }
+    async createNotification(message = "") {
+        try {
+            const schema = await this.getSchema();
+            const { database, services } = this.context;
+            const globalSettings = await database.select("notice_recipient").from("global").first();
+            const recipient = globalSettings?.notice_recipient;
+            if (!recipient) {
+                this.printLogs(this.extension, "No recipient defined in global settings");
+                return;
+            }
+            const notificationService = new services.NotificationsService({ schema });
+            await notificationService.createOne({
+                recipient,
+                sender: recipient,
+                subject: "Directus Error Notification",
+                message,
+                collection: null,
+                item: null,
+            });
+        }
+        catch (error) {
+            console.error("❌ Failed to create notification:", error);
+        }
+    }
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+	"name": "@serhii.mazur/directus-gu-logs",
+	"version": "1.0.1",
+	"description": "Helper class Logs for using in Directus extensions",
+	"type": "module",
+	"main": "./dist/index.js",
+	"scripts": {
+		"build": "tsc",
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"author": "Serhii Mazur",
+	"license": "ISC",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/SerhiiMazurBeetroot/directus-gu-logs.git"
+	},
+	"devDependencies": {
+		"typescript": "^5.0.0"
+	},
+	"dependencies": {
+		"@directus/extensions": "^3.0.4",
+		"@directus/types": "^13.1.0",
+		"pino": "^9.6.0",
+		"vue-router": "^4.5.0"
+	},
+	"directories": {
+		"doc": "docs"
+	},
+	"types": "./dist/index.d.ts",
+	"bugs": {
+		"url": "https://github.com/SerhiiMazurBeetroot/directus-gu-logs/issues"
+	},
+	"homepage": "https://github.com/SerhiiMazurBeetroot/directus-gu-logs#readme"
+}

package/src/index.ts

@@ -0,0 +1,114 @@
+import { ApiExtensionContext } from "@directus/extensions";
+import type { PrimaryKey } from "@directus/types";
+
+interface LogEntry {
+	collection: string;
+	date_created: string;
+	extension: string;
+	function_name: string;
+	error: string;
+}
+
+export class Logs {
+	protected context: ApiExtensionContext;
+	protected collectionName: string;
+	protected extension: string;
+
+	constructor(context: ApiExtensionContext, collectionName = "logs", extension = "unknown") {
+		this.context = context;
+		this.collectionName = collectionName;
+		this.extension = extension;
+	}
+
+	private async getSchema() {
+		return await this.context.getSchema();
+	}
+
+	private async createOne(data: Record<string, any>) {
+		const schema = await this.getSchema();
+
+		const itemsService = new this.context.services.ItemsService(this.collectionName, {
+			database: this.context.database,
+			schema,
+		});
+
+		return await itemsService.createOne(data);
+	}
+
+	async printLogs(functionName: string, error: string) {
+		const data: LogEntry = {
+			collection: this.collectionName,
+			date_created: new Date().toISOString(),
+			extension: this.extension,
+			function_name: functionName,
+			error,
+		};
+
+		try {
+			await this.createOne(data);
+			console.error(`🚀 [${this.extension}] ${functionName}:`, error);
+		} catch (error) {
+			console.error("❌ Failed to save logs:", error);
+		}
+	}
+
+	async createActivity(
+		action: "create" | "update" | "delete" = "create",
+		collection: string,
+		id: PrimaryKey,
+		comment: string = ""
+	) {
+		try {
+			const schema = await this.getSchema();
+			const services = this.context.services;
+			const accountability = services.accountability;
+
+			const activityService = new services.ActivityService({
+				schema: schema,
+				accountability: accountability,
+				knex: this.context.database,
+			});
+
+			await activityService.createOne({
+				action,
+				comment,
+				user: accountability?.user ?? null,
+				collection,
+				ip: accountability?.ip ?? null,
+				user_agent: accountability?.userAgent ?? null,
+				origin: accountability?.origin ?? null,
+				item: id,
+			});
+		} catch (error) {
+			console.error("❌ Failed to create activity log:", error);
+		}
+	}
+
+	async createNotification(message = "") {
+		try {
+			const schema = await this.getSchema();
+			const { database, services } = this.context;
+
+			const globalSettings = await database.select("notice_recipient").from("global").first();
+			const recipient = globalSettings?.notice_recipient;
+
+			if (!recipient) {
+				this.printLogs(this.extension, "No recipient defined in global settings");
+				return;
+			}
+
+			const notificationService = new services.NotificationsService({ schema });
+
+			await notificationService.createOne({
+				recipient,
+				sender: recipient,
+				subject: "Directus Error Notification",
+				message,
+				collection: null,
+				item: null,
+			});
+		} catch (error) {
+			console.error("❌ Failed to create notification:", error);
+		}
+	}
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+	"compilerOptions": {
+		"target": "ES2020",
+		"module": "ES2020",
+		"moduleResolution": "Node",
+		"outDir": "./dist",
+		"declaration": true,
+		"esModuleInterop": true,
+		"strict": true
+	},
+	"include": ["src"]
+}