@elchinabilov/nestjs-audit-logs 1.0.0 → 1.0.2

package/README.md

@@ -3,18 +3,22 @@
 NestJS audit log module for TypeORM with CLS context support.
 
 ## Features
+
 - TypeORM entity and service for storing audit logs
 - Interceptor that captures request metadata
 - Decorator for per-route metadata
 - CLS integration via `nestjs-cls` (installed automatically)
 
 ## Installation
+
 ```bash
 npm install @elchinabilov/nestjs-audit-logs
 ```
 
 ## Peer dependencies
+
 Make sure your app has these installed:
+
 - `@nestjs/common`
 - `@nestjs/core`
 - `@nestjs/typeorm`
@@ -27,9 +31,10 @@ Make sure your app has these installed:
 ## Usage
 
 ### 1) Import the module
+
 ```ts
-import { Module } from '@nestjs/common';
-import { AuditLogModule } from '@elchinabilov/nestjs-audit-logs';
+import { Module } from "@nestjs/common";
+import { AuditLogModule } from "@elchinabilov/nestjs-audit-logs";
 
 @Module({
   imports: [AuditLogModule],
@@ -38,11 +43,12 @@ export class AppModule {}
 ```
 
 ### 2) Ensure the entity is registered
+
 If you use `autoLoadEntities: true`, it will be picked up automatically. Otherwise, add `AuditLogEntity` to your TypeORM entities.
 
 ```ts
-import { TypeOrmModule } from '@nestjs/typeorm';
-import { AuditLogEntity } from '@elchinabilov/nestjs-audit-logs';
+import { TypeOrmModule } from "@nestjs/typeorm";
+import { AuditLogEntity } from "@elchinabilov/nestjs-audit-logs";
 
 TypeOrmModule.forRoot({
   // ...
@@ -51,6 +57,7 @@ TypeOrmModule.forRoot({
 ```
 
 ### 3) Register the interceptor
+
 You can apply it globally or per-controller.
 
 ```ts
@@ -66,6 +73,7 @@ providers: [
 ```
 
 ### 4) Add metadata (optional)
+
 ```ts
 import { AuditLog } from '@elchinabilov/nestjs-audit-logs';
 
@@ -75,26 +83,46 @@ findAll() {}
 ```
 
 ### 5) Set CLS values
+
 The interceptor reads `userId`, `role`, `ip`, and `requestId` from the CLS context. Populate these values in a guard, middleware, or interceptor before the audit interceptor runs.
 
 ```ts
-import { Injectable, NestMiddleware } from '@nestjs/common';
-import { ClsService } from 'nestjs-cls';
+import { ExecutionContext, Injectable } from "@nestjs/common";
+import { AuthGuard } from "@nestjs/passport";
+import { ClsService } from "nestjs-cls";
+import { v4 as uuid } from "uuid";
 
 @Injectable()
-export class AuditContextMiddleware implements NestMiddleware {
-  constructor(private readonly cls: ClsService) {}
-
-  use(req: any, res: any, next: () => void) {
-    this.cls.set('userId', req.user?.id);
-    this.cls.set('role', req.user?.role);
-    this.cls.set('ip', req.ip);
-    this.cls.set('requestId', req.headers['x-request-id']);
-    next();
+export class JwtAuthGuard extends AuthGuard("jwt") {
+  constructor(
+    // Add this line
+    private readonly cls: ClsService
+  ) {
+    super();
+  }
+
+  canActivate(context: ExecutionContext) {
+    // ...
+  }
+
+  // Add this code block
+  handleRequest(err, user, info, context: ExecutionContext) {
+    const req = context.switchToHttp().getRequest();
+
+    if (user) {
+      this.cls.set("userId", user.id);
+      this.cls.set("role", user.role?.name);
+    }
+
+    this.cls.set("ip", req.ip);
+    this.cls.set("requestId", uuid());
+
+    return user;
   }
 }
 ```
 
 ## Notes
+
 - The module calls `ClsModule.forRoot({ global: true, middleware: { mount: true } })` internally.
 - Logs are stored in the `audit_logs` table.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@elchinabilov/nestjs-audit-logs",
-	"version": "1.0.0",
+	"version": "1.0.2",
 	"description": "NestJS audit log module with TypeORM and CLS context",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",