@cepseudo/adonis-audit-log 1.0.0 → 1.1.0

package/README.md

@@ -26,7 +26,7 @@ This will:
 
 1. Publish migrations to `database/migrations/`
 2. Publish config to `config/audit.ts`
-3. Register the provider in `adonisrc.ts`
+3. Register the provider and command in `adonisrc.ts`
 
 Then run the migrations:
 
@@ -62,10 +62,11 @@ export default defineConfig({
     enabled: true,
   },
 
+  // Retention in days (0 = unlimited)
   retention: {
     requestLogs: 30,
     errorLogs: 90,
-    auditLogs: 365,
+    auditLogs: 0, // Keep forever
   },
 })
 ```
@@ -120,6 +121,16 @@ export default class HttpExceptionHandler extends ExceptionHandler {
 }
 ```
 
+### Log Cleanup
+
+Delete old logs based on retention configuration:
+
+```bash
+node ace audit:cleanup
+```
+
+Set retention to `0` for unlimited retention (logs won't be deleted).
+
 ## Database Schema
 
 The package creates three tables:

package/build/commands/audit_cleanup.d.ts

@@ -0,0 +1,8 @@
+import { BaseCommand } from '@adonisjs/core/ace';
+import { CommandOptions } from '@adonisjs/core/types/ace';
+export default class AuditCleanup extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    static options: CommandOptions;
+    run(): Promise<void>;
+}

package/build/commands/audit_cleanup.js

@@ -0,0 +1,64 @@
+/*
+|--------------------------------------------------------------------------
+| Audit Cleanup Command
+|--------------------------------------------------------------------------
+|
+| Command to delete old audit logs based on retention configuration.
+| Run with: node ace audit:cleanup
+|
+*/
+import { BaseCommand } from '@adonisjs/core/ace';
+import { DateTime } from 'luxon';
+export default class AuditCleanup extends BaseCommand {
+    static commandName = 'audit:cleanup';
+    static description = 'Delete old audit logs based on retention configuration';
+    static options = {
+        startApp: true,
+    };
+    async run() {
+        const { default: AuditLog } = await import('../src/models/audit_log.js');
+        const { default: RequestLog } = await import('../src/models/request_log.js');
+        const { default: ErrorLog } = await import('../src/models/error_log.js');
+        const config = this.app.config.get('audit');
+        if (!config) {
+            this.logger.error('Audit config not found. Make sure config/audit.ts exists.');
+            return;
+        }
+        const retention = config.retention;
+        let totalDeleted = 0;
+        // Cleanup audit logs
+        if (retention.auditLogs > 0) {
+            const cutoff = DateTime.now().minus({ days: retention.auditLogs });
+            const deleted = await AuditLog.query().where('createdAt', '<', cutoff.toJSDate()).delete();
+            const count = Array.isArray(deleted) ? deleted.length : deleted;
+            this.logger.info(`Deleted ${count} audit logs older than ${retention.auditLogs} days`);
+            totalDeleted += count;
+        }
+        else {
+            this.logger.info('Audit logs: retention unlimited (skipped)');
+        }
+        // Cleanup request logs
+        if (retention.requestLogs > 0) {
+            const cutoff = DateTime.now().minus({ days: retention.requestLogs });
+            const deleted = await RequestLog.query().where('createdAt', '<', cutoff.toJSDate()).delete();
+            const count = Array.isArray(deleted) ? deleted.length : deleted;
+            this.logger.info(`Deleted ${count} request logs older than ${retention.requestLogs} days`);
+            totalDeleted += count;
+        }
+        else {
+            this.logger.info('Request logs: retention unlimited (skipped)');
+        }
+        // Cleanup error logs
+        if (retention.errorLogs > 0) {
+            const cutoff = DateTime.now().minus({ days: retention.errorLogs });
+            const deleted = await ErrorLog.query().where('createdAt', '<', cutoff.toJSDate()).delete();
+            const count = Array.isArray(deleted) ? deleted.length : deleted;
+            this.logger.info(`Deleted ${count} error logs older than ${retention.errorLogs} days`);
+            totalDeleted += count;
+        }
+        else {
+            this.logger.info('Error logs: retention unlimited (skipped)');
+        }
+        this.logger.success(`Cleanup complete. Total deleted: ${totalDeleted}`);
+    }
+}

package/build/configure.js

@@ -49,10 +49,12 @@ export async function configure(command) {
             fileName: `${timestamp3}_create_error_logs_table.ts`,
         },
     });
-    // Register provider in adonisrc.ts
+    // Register provider and command in adonisrc.ts
     await codemods.updateRcFile((rcFile) => {
         rcFile.addProvider('@cepseudo/adonis-audit-log/providers/audit_provider');
+        rcFile.addCommand('@cepseudo/adonis-audit-log/commands');
     });
     command.logger.success('Audit log package configured successfully!');
     command.logger.info('Run "node ace migration:run" to create the audit tables.');
+    command.logger.info('Use "node ace audit:cleanup" to delete old logs based on retention config.');
 }

package/build/stubs/config.stub

@@ -31,10 +31,11 @@ export default defineConfig({
     enabled: true,
   },
 
-  // Retention (days) - for cleanup job
+  // Retention in days (0 = unlimited, no cleanup)
+  // Run "node ace audit:cleanup" to delete old logs
   retention: {
     requestLogs: 30,
     errorLogs: 90,
-    auditLogs: 365,
+    auditLogs: 0, // Keep forever
   },
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cepseudo/adonis-audit-log",
   "description": "Simple audit logging for AdonisJS 6",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "engines": {
     "node": ">=20.6.0"
   },
@@ -14,6 +14,7 @@
     "build/stubs",
     "build/services",
     "build/middleware",
+    "build/commands",
     "build/index.d.ts",
     "build/index.js",
     "build/configure.d.ts",
@@ -24,6 +25,7 @@
     "./services/main": "./build/services/main.js",
     "./middleware/request_logger": "./build/middleware/request_logger.js",
     "./providers/audit_provider": "./build/providers/audit_provider.js",
+    "./commands": "./build/commands/audit_cleanup.js",
     "./types": "./build/src/types.js"
   },
   "scripts": {