@cepseudo/adonis-audit-log 1.0.0 → 1.2.0

package/build/providers/audit_provider.js

@@ -9,41 +9,60 @@
 */
 import { AuditService } from '../src/audit_service.js';
 import { AuditErrorLogger } from '../src/error_logger.js';
+import RequestLoggerMiddleware from '../middleware/request_logger.js';
+const defaultConfig = {
+    enabled: true,
+    requestLog: {
+        enabled: true,
+        excludeRoutes: [],
+        excludeMethods: ['OPTIONS'],
+        logBody: false,
+        logQuery: true,
+        sanitizeFields: ['password', 'token', 'secret'],
+    },
+    errorLog: {
+        enabled: true,
+        excludeStatusCodes: [404],
+        includeStack: true,
+    },
+    auditLog: {
+        enabled: true,
+    },
+    retention: {
+        requestLogs: 30,
+        errorLogs: 90,
+        auditLogs: 365,
+    },
+};
 export default class AuditProvider {
     app;
     constructor(app) {
         this.app = app;
     }
     register() {
+        // Register AuditService
         this.app.container.singleton('audit', () => {
-            const config = this.app.config.get('audit', {
-                enabled: true,
-                requestLog: {
-                    enabled: true,
-                    excludeRoutes: [],
-                    excludeMethods: ['OPTIONS'],
-                    logBody: false,
-                    logQuery: true,
-                    sanitizeFields: ['password', 'token', 'secret'],
-                },
-                errorLog: {
-                    enabled: true,
-                    excludeStatusCodes: [404],
-                    includeStack: true,
-                },
-                auditLog: {
-                    enabled: true,
-                },
-                retention: {
-                    requestLogs: 30,
-                    errorLogs: 90,
-                    auditLogs: 365,
-                },
-            });
+            const config = this.app.config.get('audit', defaultConfig);
             return new AuditService(config);
         });
+        // Register RequestLoggerMiddleware
+        this.app.container.bind(RequestLoggerMiddleware, () => {
+            const config = this.app.config.get('audit', defaultConfig);
+            return new RequestLoggerMiddleware(config);
+        });
     }
     async boot() {
+        // Get the database service from the app container
+        const db = (await this.app.container.make('lucid.db'));
+        // Import and configure models with the database adapter
+        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');
+        // Use the default adapter from Lucid
+        const adapter = db.modelAdapter();
+        AuditLog.$adapter = adapter;
+        RequestLog.$adapter = adapter;
+        ErrorLog.$adapter = adapter;
         const config = this.app.config.get('audit');
         if (config) {
             AuditErrorLogger.init(config);

package/build/services/main.d.ts

@@ -1,3 +1,27 @@
-import { AuditService } from '../src/audit_service.js';
-declare let audit: AuditService;
+/**
+ * Audit service proxy that provides the same interface as AuditService
+ * but lazy-loads from the container
+ */
+declare const audit: {
+    log(actionType: string, metadata?: Record<string, unknown>): Promise<import("../index.js").AuditLog | null>;
+    logAsync(actionType: string, metadata?: Record<string, unknown>): void;
+    logChange(actionType: string, options: {
+        userId?: number | null;
+        targetId?: number | string;
+        changes: Record<string, {
+            from: unknown;
+            to: unknown;
+        }>;
+        extra?: Record<string, unknown>;
+    }): Promise<import("../index.js").AuditLog | null>;
+    logChangeAsync(actionType: string, options: {
+        userId?: number | null;
+        targetId?: number | string;
+        changes: Record<string, {
+            from: unknown;
+            to: unknown;
+        }>;
+        extra?: Record<string, unknown>;
+    }): void;
+};
 export { audit as default };

package/build/services/main.js

@@ -3,13 +3,40 @@
 | Audit Service Singleton
 |--------------------------------------------------------------------------
 |
-| This file exports the audit service singleton that can be imported
-| anywhere in the application.
+| This file exports a proxy to the audit service that lazy-loads from
+| the container when first accessed.
 |
 */
 import app from '@adonisjs/core/services/app';
-let audit;
-await app.booted(async () => {
-    audit = await app.container.make('audit');
-});
+let auditService = null;
+async function getAuditService() {
+    if (!auditService) {
+        auditService = await app.container.make('audit');
+    }
+    return auditService;
+}
+/**
+ * Audit service proxy that provides the same interface as AuditService
+ * but lazy-loads from the container
+ */
+const audit = {
+    async log(actionType, metadata = {}) {
+        const service = await getAuditService();
+        return service.log(actionType, metadata);
+    },
+    logAsync(actionType, metadata = {}) {
+        getAuditService()
+            .then((service) => service.logAsync(actionType, metadata))
+            .catch((err) => console.error('[AuditService] Failed to log async:', err));
+    },
+    async logChange(actionType, options) {
+        const service = await getAuditService();
+        return service.logChange(actionType, options);
+    },
+    logChangeAsync(actionType, options) {
+        getAuditService()
+            .then((service) => service.logChangeAsync(actionType, options))
+            .catch((err) => console.error('[AuditService] Failed to log change async:', err));
+    },
+};
 export { audit as default };

package/build/stubs/config.stub

@@ -1,40 +1,41 @@
-{{{
-  exports({
-    to: app.configPath('audit.ts')
-  })
-}}}
-import { defineConfig } from '@cepseudo/adonis-audit-log'
-
-export default defineConfig({
-  // Enable/disable all logging
-  enabled: true,
-
-  // Request logging options
-  requestLog: {
-    enabled: true,
-    excludeRoutes: ['/health', '/metrics'],
-    excludeMethods: ['OPTIONS'],
-    logBody: false,
-    logQuery: true,
-    sanitizeFields: ['password', 'token', 'secret'],
-  },
-
-  // Error logging options
-  errorLog: {
-    enabled: true,
-    excludeStatusCodes: [404],
-    includeStack: true,
-  },
-
-  // Audit log options
-  auditLog: {
-    enabled: true,
-  },
-
-  // Retention (days) - for cleanup job
-  retention: {
-    requestLogs: 30,
-    errorLogs: 90,
-    auditLogs: 365,
-  },
-})
+{{{
+  exports({
+    to: app.configPath('audit.ts')
+  })
+}}}
+import { defineConfig } from '@cepseudo/adonis-audit-log'
+
+export default defineConfig({
+  // Enable/disable all logging
+  enabled: true,
+
+  // Request logging options
+  requestLog: {
+    enabled: true,
+    excludeRoutes: ['/health', '/metrics'],
+    excludeMethods: ['OPTIONS'],
+    logBody: false,
+    logQuery: true,
+    sanitizeFields: ['password', 'token', 'secret'],
+  },
+
+  // Error logging options
+  errorLog: {
+    enabled: true,
+    excludeStatusCodes: [404],
+    includeStack: true,
+  },
+
+  // Audit log options
+  auditLog: {
+    enabled: true,
+  },
+
+  // Retention in days (0 = unlimited, no cleanup)
+  // Run "node ace audit:cleanup" to delete old logs
+  retention: {
+    requestLogs: 30,
+    errorLogs: 90,
+    auditLogs: 0, // Keep forever
+  },
+})

package/build/stubs/migrations/create_audit_logs_table.stub

@@ -1,24 +1,27 @@
-{{#var tableName = 'audit_logs'}}
-{{#var migrationName = 'create_' + tableName + '_table'}}
-import { BaseSchema } from '@adonisjs/lucid/schema'
-
-export default class extends BaseSchema {
-  protected tableName = '{{ tableName }}'
-
-  async up() {
-    this.schema.createTable(this.tableName, (table) => {
-      table.increments('id')
-      table.string('action_type').notNullable().index()
-      table.jsonb('metadata').notNullable().defaultTo('{}')
-      table.integer('user_id').unsigned().nullable().references('id').inTable('users').onDelete('SET NULL')
-      table.timestamp('created_at').notNullable().defaultTo(this.now())
-
-      table.index(['created_at'])
-      table.index(['user_id'])
-    })
-  }
-
-  async down() {
-    this.schema.dropTable(this.tableName)
-  }
-}
+{{{
+  exports({
+    to: app.makePath(migration.folder, migration.fileName)
+  })
+}}}
+import { BaseSchema } from '@adonisjs/lucid/schema'
+
+export default class extends BaseSchema {
+  protected tableName = 'audit_logs'
+
+  async up() {
+    this.schema.createTable(this.tableName, (table) => {
+      table.increments('id')
+      table.string('action_type').notNullable().index()
+      table.jsonb('metadata').notNullable().defaultTo('{}')
+      table.integer('user_id').unsigned().nullable().references('id').inTable('users').onDelete('SET NULL')
+      table.timestamp('created_at').notNullable().defaultTo(this.now())
+
+      table.index(['created_at'])
+      table.index(['user_id'])
+    })
+  }
+
+  async down() {
+    this.schema.dropTable(this.tableName)
+  }
+}

package/build/stubs/migrations/create_error_logs_table.stub

@@ -1,31 +1,34 @@
-{{#var tableName = 'error_logs'}}
-{{#var migrationName = 'create_' + tableName + '_table'}}
-import { BaseSchema } from '@adonisjs/lucid/schema'
-
-export default class extends BaseSchema {
-  protected tableName = '{{ tableName }}'
-
-  async up() {
-    this.schema.createTable(this.tableName, (table) => {
-      table.increments('id')
-      table.string('error_type').notNullable()
-      table.text('message').notNullable()
-      table.text('stack').nullable()
-      table.string('url', 2048).nullable()
-      table.string('method', 10).nullable()
-      table.integer('status_code').nullable()
-      table.integer('user_id').unsigned().nullable().references('id').inTable('users').onDelete('SET NULL')
-      table.jsonb('context').nullable()
-      table.timestamp('created_at').notNullable().defaultTo(this.now())
-
-      table.index(['created_at'])
-      table.index(['user_id'])
-      table.index(['error_type'])
-      table.index(['status_code'])
-    })
-  }
-
-  async down() {
-    this.schema.dropTable(this.tableName)
-  }
-}
+{{{
+  exports({
+    to: app.makePath(migration.folder, migration.fileName)
+  })
+}}}
+import { BaseSchema } from '@adonisjs/lucid/schema'
+
+export default class extends BaseSchema {
+  protected tableName = 'error_logs'
+
+  async up() {
+    this.schema.createTable(this.tableName, (table) => {
+      table.increments('id')
+      table.string('error_type').notNullable()
+      table.text('message').notNullable()
+      table.text('stack').nullable()
+      table.string('url', 2048).nullable()
+      table.string('method', 10).nullable()
+      table.integer('status_code').nullable()
+      table.integer('user_id').unsigned().nullable().references('id').inTable('users').onDelete('SET NULL')
+      table.jsonb('context').nullable()
+      table.timestamp('created_at').notNullable().defaultTo(this.now())
+
+      table.index(['created_at'])
+      table.index(['user_id'])
+      table.index(['error_type'])
+      table.index(['status_code'])
+    })
+  }
+
+  async down() {
+    this.schema.dropTable(this.tableName)
+  }
+}

package/build/stubs/migrations/create_request_logs_table.stub

@@ -1,33 +1,36 @@
-{{#var tableName = 'request_logs'}}
-{{#var migrationName = 'create_' + tableName + '_table'}}
-import { BaseSchema } from '@adonisjs/lucid/schema'
-
-export default class extends BaseSchema {
-  protected tableName = '{{ tableName }}'
-
-  async up() {
-    this.schema.createTable(this.tableName, (table) => {
-      table.increments('id')
-      table.string('method', 10).notNullable()
-      table.string('url', 2048).notNullable()
-      table.string('route_name').nullable()
-      table.integer('status_code').notNullable()
-      table.integer('response_time_ms').notNullable()
-      table.string('ip', 45).nullable()
-      table.string('user_agent', 512).nullable()
-      table.integer('user_id').unsigned().nullable().references('id').inTable('users').onDelete('SET NULL')
-      table.jsonb('request_body').nullable()
-      table.jsonb('request_query').nullable()
-      table.timestamp('created_at').notNullable().defaultTo(this.now())
-
-      table.index(['created_at'])
-      table.index(['user_id'])
-      table.index(['status_code'])
-      table.index(['method'])
-    })
-  }
-
-  async down() {
-    this.schema.dropTable(this.tableName)
-  }
-}
+{{{
+  exports({
+    to: app.makePath(migration.folder, migration.fileName)
+  })
+}}}
+import { BaseSchema } from '@adonisjs/lucid/schema'
+
+export default class extends BaseSchema {
+  protected tableName = 'request_logs'
+
+  async up() {
+    this.schema.createTable(this.tableName, (table) => {
+      table.increments('id')
+      table.string('method', 10).notNullable()
+      table.string('url', 2048).notNullable()
+      table.string('route_name').nullable()
+      table.integer('status_code').notNullable()
+      table.integer('response_time_ms').notNullable()
+      table.string('ip', 45).nullable()
+      table.string('user_agent', 512).nullable()
+      table.integer('user_id').unsigned().nullable().references('id').inTable('users').onDelete('SET NULL')
+      table.jsonb('request_body').nullable()
+      table.jsonb('request_query').nullable()
+      table.timestamp('created_at').notNullable().defaultTo(this.now())
+
+      table.index(['created_at'])
+      table.index(['user_id'])
+      table.index(['status_code'])
+      table.index(['method'])
+    })
+  }
+
+  async down() {
+    this.schema.dropTable(this.tableName)
+  }
+}

package/package.json

@@ -1,102 +1,104 @@
-{
-  "name": "@cepseudo/adonis-audit-log",
-  "description": "Simple audit logging for AdonisJS 6",
-  "version": "1.0.0",
-  "engines": {
-    "node": ">=20.6.0"
-  },
-  "type": "module",
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
-  "files": [
-    "build/src",
-    "build/providers",
-    "build/stubs",
-    "build/services",
-    "build/middleware",
-    "build/index.d.ts",
-    "build/index.js",
-    "build/configure.d.ts",
-    "build/configure.js"
-  ],
-  "exports": {
-    ".": "./build/index.js",
-    "./services/main": "./build/services/main.js",
-    "./middleware/request_logger": "./build/middleware/request_logger.js",
-    "./providers/audit_provider": "./build/providers/audit_provider.js",
-    "./types": "./build/src/types.js"
-  },
-  "scripts": {
-    "clean": "del-cli build",
-    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint .",
-    "format": "prettier --write .",
-    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
-    "pretest": "npm run lint",
-    "test": "c8 npm run quick:test",
-    "prebuild": "npm run lint && npm run clean",
-    "build": "tsc",
-    "postbuild": "npm run copy:templates",
-    "release": "np",
-    "version": "npm run build",
-    "prepublishOnly": "npm run build"
-  },
-  "keywords": [
-    "adonisjs",
-    "audit",
-    "logging",
-    "audit-log",
-    "request-logging"
-  ],
-  "author": "",
-  "license": "MIT",
-  "devDependencies": {
-    "@adonisjs/assembler": "^7.8.2",
-    "@adonisjs/core": "^6.12.0",
-    "@adonisjs/eslint-config": "2.0.0-beta.7",
-    "@adonisjs/lucid": "^21.0.0",
-    "@adonisjs/prettier-config": "^1.4.0",
-    "@adonisjs/tsconfig": "^1.3.0",
-    "@japa/assert": "^3.0.0",
-    "@japa/runner": "^3.1.4",
-    "@swc/core": "^1.6.3",
-    "@types/luxon": "^3.7.1",
-    "@types/node": "^20.14.5",
-    "c8": "^10.1.2",
-    "copyfiles": "^2.4.1",
-    "del-cli": "^5.1.0",
-    "eslint": "^9.15.0",
-    "np": "^10.0.6",
-    "prettier": "^3.3.2",
-    "ts-node-maintained": "^10.9.4",
-    "typescript": "^5.4.5"
-  },
-  "peerDependencies": {
-    "@adonisjs/core": "^6.2.0",
-    "@adonisjs/lucid": "^21.0.0"
-  },
-  "publishConfig": {
-    "access": "public",
-    "tag": "latest"
-  },
-  "np": {
-    "message": "chore(release): %s",
-    "tag": "latest",
-    "branch": "main",
-    "anyBranch": false
-  },
-  "c8": {
-    "reporter": [
-      "text",
-      "html"
-    ],
-    "exclude": [
-      "tests/**"
-    ]
-  },
-  "prettier": "@adonisjs/prettier-config",
-  "dependencies": {
-    "luxon": "^3.7.2"
-  }
-}
+{
+  "name": "@cepseudo/adonis-audit-log",
+  "description": "Simple audit logging for AdonisJS 6",
+  "version": "1.2.0",
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "type": "module",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "files": [
+    "build/src",
+    "build/providers",
+    "build/stubs",
+    "build/services",
+    "build/middleware",
+    "build/commands",
+    "build/index.d.ts",
+    "build/index.js",
+    "build/configure.d.ts",
+    "build/configure.js"
+  ],
+  "exports": {
+    ".": "./build/index.js",
+    "./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/main.js",
+    "./types": "./build/src/types.js"
+  },
+  "scripts": {
+    "clean": "del-cli build",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" \"commands/*.json\" build",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
+    "pretest": "npm run lint",
+    "test": "c8 npm run quick:test",
+    "prebuild": "npm run lint && npm run clean",
+    "build": "tsc",
+    "postbuild": "npm run copy:templates",
+    "release": "np",
+    "version": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "adonisjs",
+    "audit",
+    "logging",
+    "audit-log",
+    "request-logging"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/core": "^6.12.0",
+    "@adonisjs/eslint-config": "2.0.0-beta.7",
+    "@adonisjs/lucid": "^21.0.0",
+    "@adonisjs/prettier-config": "^1.4.0",
+    "@adonisjs/tsconfig": "^1.3.0",
+    "@japa/assert": "^3.0.0",
+    "@japa/runner": "^3.1.4",
+    "@swc/core": "^1.6.3",
+    "@types/luxon": "^3.7.1",
+    "@types/node": "^20.14.5",
+    "c8": "^10.1.2",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^9.15.0",
+    "np": "^10.0.6",
+    "prettier": "^3.3.2",
+    "ts-node-maintained": "^10.9.4",
+    "typescript": "^5.4.5"
+  },
+  "peerDependencies": {
+    "@adonisjs/core": "^6.2.0",
+    "@adonisjs/lucid": "^21.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "np": {
+    "message": "chore(release): %s",
+    "tag": "latest",
+    "branch": "main",
+    "anyBranch": false
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "dependencies": {
+    "luxon": "^3.7.2"
+  }
+}