@nest-toolbox/typeorm-audit-log 1.8.1

package/dist/audit-log.entity.js

@@ -0,0 +1,89 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLog = void 0;
+const typeorm_1 = require("typeorm");
+/**
+ * Entity for storing audit log entries.
+ * Tracks all changes to entities decorated with @Auditable().
+ */
+let AuditLog = class AuditLog {
+};
+exports.AuditLog = AuditLog;
+__decorate([
+    (0, typeorm_1.PrimaryGeneratedColumn)('uuid'),
+    __metadata("design:type", String)
+], AuditLog.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 255 }),
+    __metadata("design:type", String)
+], AuditLog.prototype, "entityName", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 255 }),
+    __metadata("design:type", String)
+], AuditLog.prototype, "entityId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'varchar',
+        length: 10,
+    }),
+    __metadata("design:type", String)
+], AuditLog.prototype, "action", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 255, nullable: true }),
+    __metadata("design:type", Object)
+], AuditLog.prototype, "userId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 255, nullable: true }),
+    __metadata("design:type", Object)
+], AuditLog.prototype, "userName", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'jsonb', nullable: true })
+    // biome-ignore lint/suspicious/noExplicitAny: values can be any type
+    ,
+    __metadata("design:type", Object)
+], AuditLog.prototype, "oldValues", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'jsonb', nullable: true })
+    // biome-ignore lint/suspicious/noExplicitAny: values can be any type
+    ,
+    __metadata("design:type", Object)
+], AuditLog.prototype, "newValues", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'jsonb', nullable: true }),
+    __metadata("design:type", Object)
+], AuditLog.prototype, "diff", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'jsonb', nullable: true })
+    // biome-ignore lint/suspicious/noExplicitAny: metadata can contain any value
+    ,
+    __metadata("design:type", Object)
+], AuditLog.prototype, "metadata", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 45, nullable: true }),
+    __metadata("design:type", Object)
+], AuditLog.prototype, "ip", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 500, nullable: true }),
+    __metadata("design:type", Object)
+], AuditLog.prototype, "userAgent", void 0);
+__decorate([
+    (0, typeorm_1.CreateDateColumn)(),
+    __metadata("design:type", Date)
+], AuditLog.prototype, "timestamp", void 0);
+exports.AuditLog = AuditLog = __decorate([
+    (0, typeorm_1.Entity)('audit_logs'),
+    (0, typeorm_1.Index)(['entityName', 'entityId']),
+    (0, typeorm_1.Index)(['userId']),
+    (0, typeorm_1.Index)(['timestamp']),
+    (0, typeorm_1.Index)(['entityName', 'timestamp'])
+], AuditLog);
+//# sourceMappingURL=audit-log.entity.js.map

package/dist/audit-log.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-log.entity.js","sourceRoot":"","sources":["../src/audit-log.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAA0F;AAG1F;;;GAGG;AAMI,IAAM,QAAQ,GAAd,MAAM,QAAQ;CAiFpB,CAAA;AAjFY,4BAAQ;AAEnB;IADC,IAAA,gCAAsB,EAAC,MAAM,CAAC;;oCACnB;AAMZ;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;4CACrB;AAMpB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;0CACvB;AASlB;IAJC,IAAA,gBAAM,EAAC;QACN,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,EAAE;KACX,CAAC;;wCACmB;AAMrB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wCAClC;AAMvB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;0CAChC;AAOzB;IAFC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC1C,qEAAqE;;;2CAC9B;AAOvC;IAFC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC1C,qEAAqE;;;2CAC9B;AAMvC;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sCAChB;AAO1B;IAFC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC1C,6EAA6E;;;0CACvC;AAMtC;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oCACrC;AAMnB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CAC/B;AAM1B;IADC,IAAA,0BAAgB,GAAE;8BACP,IAAI;2CAAC;mBAhFN,QAAQ;IALpB,IAAA,gBAAM,EAAC,YAAY,CAAC;IACpB,IAAA,eAAK,EAAC,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACjC,IAAA,eAAK,EAAC,CAAC,QAAQ,CAAC,CAAC;IACjB,IAAA,eAAK,EAAC,CAAC,WAAW,CAAC,CAAC;IACpB,IAAA,eAAK,EAAC,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;GACtB,QAAQ,CAiFpB"}

package/dist/audit-log.module.d.ts

@@ -0,0 +1,56 @@
+import { type DynamicModule, type OnModuleInit } from '@nestjs/common';
+import type { DataSource } from 'typeorm';
+import { AuditLogService } from './audit-log.service';
+import { AuditLogSubscriber } from './audit-log.subscriber';
+import type { AuditLogModuleAsyncOptions, AuditLogModuleOptions } from './types';
+/**
+ * AuditLogModule provides automatic audit logging for TypeORM entities.
+ *
+ * @example Basic usage
+ * ```typescript
+ * @Module({
+ *   imports: [
+ *     TypeOrmModule.forRoot({...}),
+ *     AuditLogModule.forRoot({
+ *       retentionDays: 90,
+ *       excludeFields: ['password', 'token'],
+ *     }),
+ *   ],
+ * })
+ * export class AppModule implements NestModule {
+ *   configure(consumer: MiddlewareConsumer) {
+ *     consumer.apply(AuditContextMiddleware).forRoutes('*');
+ *   }
+ * }
+ * ```
+ *
+ * @example Async configuration
+ * ```typescript
+ * AuditLogModule.forRootAsync({
+ *   imports: [ConfigModule],
+ *   useFactory: (config: ConfigService) => ({
+ *     retentionDays: config.get('AUDIT_RETENTION_DAYS'),
+ *     async: config.get('AUDIT_ASYNC') === 'true',
+ *   }),
+ *   inject: [ConfigService],
+ * })
+ * ```
+ */
+export declare class AuditLogModule implements OnModuleInit {
+    private readonly dataSource;
+    private readonly subscriber;
+    private readonly auditLogService;
+    constructor(dataSource: DataSource, subscriber: AuditLogSubscriber, auditLogService: AuditLogService);
+    /**
+     * Initialize the module: register subscriber with DataSource and inject service.
+     */
+    onModuleInit(): void;
+    /**
+     * Configure the module with static options.
+     */
+    static forRoot(options?: AuditLogModuleOptions): DynamicModule;
+    /**
+     * Configure the module with async options (factory, useClass, useExisting).
+     */
+    static forRootAsync(options: AuditLogModuleAsyncOptions): DynamicModule;
+}

package/dist/audit-log.module.js

@@ -0,0 +1,130 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var AuditLogModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogModule = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("@nestjs/typeorm");
+const audit_log_entity_1 = require("./audit-log.entity");
+const audit_log_service_1 = require("./audit-log.service");
+const audit_log_subscriber_1 = require("./audit-log.subscriber");
+const constants_1 = require("./constants");
+/**
+ * Default module options.
+ */
+const DEFAULT_OPTIONS = {
+    storage: 'database',
+    retentionDays: 0,
+    excludeFields: [],
+    excludeEntities: [],
+    async: false,
+    batchSize: 1,
+};
+/**
+ * AuditLogModule provides automatic audit logging for TypeORM entities.
+ *
+ * @example Basic usage
+ * ```typescript
+ * @Module({
+ *   imports: [
+ *     TypeOrmModule.forRoot({...}),
+ *     AuditLogModule.forRoot({
+ *       retentionDays: 90,
+ *       excludeFields: ['password', 'token'],
+ *     }),
+ *   ],
+ * })
+ * export class AppModule implements NestModule {
+ *   configure(consumer: MiddlewareConsumer) {
+ *     consumer.apply(AuditContextMiddleware).forRoutes('*');
+ *   }
+ * }
+ * ```
+ *
+ * @example Async configuration
+ * ```typescript
+ * AuditLogModule.forRootAsync({
+ *   imports: [ConfigModule],
+ *   useFactory: (config: ConfigService) => ({
+ *     retentionDays: config.get('AUDIT_RETENTION_DAYS'),
+ *     async: config.get('AUDIT_ASYNC') === 'true',
+ *   }),
+ *   inject: [ConfigService],
+ * })
+ * ```
+ */
+let AuditLogModule = AuditLogModule_1 = class AuditLogModule {
+    constructor(dataSource, subscriber, auditLogService) {
+        this.dataSource = dataSource;
+        this.subscriber = subscriber;
+        this.auditLogService = auditLogService;
+    }
+    /**
+     * Initialize the module: register subscriber with DataSource and inject service.
+     */
+    onModuleInit() {
+        // Register the subscriber with TypeORM DataSource
+        this.subscriber.registerWithDataSource(this.dataSource);
+        // Inject the service into the subscriber
+        this.subscriber.setAuditLogService(this.auditLogService);
+    }
+    /**
+     * Configure the module with static options.
+     */
+    static forRoot(options = {}) {
+        const mergedOptions = Object.assign(Object.assign({}, DEFAULT_OPTIONS), options);
+        return {
+            module: AuditLogModule_1,
+            imports: [typeorm_1.TypeOrmModule.forFeature([audit_log_entity_1.AuditLog])],
+            providers: [
+                {
+                    provide: constants_1.AUDIT_LOG_OPTIONS,
+                    useValue: mergedOptions,
+                },
+                audit_log_service_1.AuditLogService,
+                audit_log_subscriber_1.AuditLogSubscriber,
+            ],
+            exports: [audit_log_service_1.AuditLogService, audit_log_subscriber_1.AuditLogSubscriber],
+            global: true,
+        };
+    }
+    /**
+     * Configure the module with async options (factory, useClass, useExisting).
+     */
+    static forRootAsync(options) {
+        var _a, _b;
+        return {
+            module: AuditLogModule_1,
+            imports: [...((_a = options.imports) !== null && _a !== void 0 ? _a : []), typeorm_1.TypeOrmModule.forFeature([audit_log_entity_1.AuditLog])],
+            providers: [
+                {
+                    provide: constants_1.AUDIT_LOG_OPTIONS,
+                    useFactory: async (...args) => {
+                        const config = options.useFactory ? await options.useFactory(...args) : {};
+                        return Object.assign(Object.assign({}, DEFAULT_OPTIONS), config);
+                    },
+                    inject: (_b = options.inject) !== null && _b !== void 0 ? _b : [],
+                },
+                audit_log_service_1.AuditLogService,
+                audit_log_subscriber_1.AuditLogSubscriber,
+            ],
+            exports: [audit_log_service_1.AuditLogService, audit_log_subscriber_1.AuditLogSubscriber],
+            global: true,
+        };
+    }
+};
+exports.AuditLogModule = AuditLogModule;
+exports.AuditLogModule = AuditLogModule = AuditLogModule_1 = __decorate([
+    (0, common_1.Module)({}),
+    __metadata("design:paramtypes", [Function, audit_log_subscriber_1.AuditLogSubscriber,
+        audit_log_service_1.AuditLogService])
+], AuditLogModule);
+//# sourceMappingURL=audit-log.module.js.map

package/dist/audit-log.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-log.module.js","sourceRoot":"","sources":["../src/audit-log.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2CAA+E;AAC/E,6CAAgD;AAEhD,yDAA8C;AAC9C,2DAAsD;AACtD,iEAA4D;AAC5D,2CAAgD;AAGhD;;GAEG;AACH,MAAM,eAAe,GAA0B;IAC7C,OAAO,EAAE,UAAU;IACnB,aAAa,EAAE,CAAC;IAChB,aAAa,EAAE,EAAE;IACjB,eAAe,EAAE,EAAE;IACnB,KAAK,EAAE,KAAK;IACZ,SAAS,EAAE,CAAC;CACb,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEI,IAAM,cAAc,sBAApB,MAAM,cAAc;IACzB,YACmB,UAAsB,EACtB,UAA8B,EAC9B,eAAgC;QAFhC,eAAU,GAAV,UAAU,CAAY;QACtB,eAAU,GAAV,UAAU,CAAoB;QAC9B,oBAAe,GAAf,eAAe,CAAiB;IAChD,CAAC;IAEJ;;OAEG;IACH,YAAY;QACV,kDAAkD;QAClD,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,yCAAyC;QACzC,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,UAAiC,EAAE;QAChD,MAAM,aAAa,mCAAQ,eAAe,GAAK,OAAO,CAAE,CAAC;QAEzD,OAAO;YACL,MAAM,EAAE,gBAAc;YACtB,OAAO,EAAE,CAAC,uBAAa,CAAC,UAAU,CAAC,CAAC,2BAAQ,CAAC,CAAC,CAAC;YAC/C,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,6BAAiB;oBAC1B,QAAQ,EAAE,aAAa;iBACxB;gBACD,mCAAe;gBACf,yCAAkB;aACnB;YACD,OAAO,EAAE,CAAC,mCAAe,EAAE,yCAAkB,CAAC;YAC9C,MAAM,EAAE,IAAI;SACb,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,OAAmC;;QACrD,OAAO;YACL,MAAM,EAAE,gBAAc;YACtB,OAAO,EAAE,CAAC,GAAG,CAAC,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC,EAAE,uBAAa,CAAC,UAAU,CAAC,CAAC,2BAAQ,CAAC,CAAC,CAAC;YAC3E,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,6BAAiB;oBAC1B,UAAU,EAAE,KAAK,EAAE,GAAG,IAAe,EAAE,EAAE;wBACvC,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC3E,uCAAY,eAAe,GAAK,MAAM,EAAG;oBAC3C,CAAC;oBACD,MAAM,EAAE,MAAA,OAAO,CAAC,MAAM,mCAAI,EAAE;iBAC7B;gBACD,mCAAe;gBACf,yCAAkB;aACnB;YACD,OAAO,EAAE,CAAC,mCAAe,EAAE,yCAAkB,CAAC;YAC9C,MAAM,EAAE,IAAI;SACb,CAAC;IACJ,CAAC;CACF,CAAA;AA9DY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,eAAM,EAAC,EAAE,CAAC;+CAIsB,yCAAkB;QACb,mCAAe;GAJxC,cAAc,CA8D1B"}

package/dist/audit-log.service.d.ts

@@ -0,0 +1,43 @@
+import type { Repository } from 'typeorm';
+import { AuditLog } from './audit-log.entity';
+import type { IAuditLogService } from './audit-log.subscriber';
+import type { AuditLogModuleOptions, FindAllOptions, FindByEntityOptions, FindByUserOptions, LogParams, PaginatedResult } from './types';
+/**
+ * Service for logging and querying audit entries.
+ * Captures entity changes with user attribution, diff calculation,
+ * and request context (IP, user agent, metadata).
+ *
+ * @example
+ * ```typescript
+ * // Query audit history for an entity
+ * const history = await auditLogService.findByEntity('User', '123');
+ *
+ * // Query changes made by a specific user
+ * const userChanges = await auditLogService.findByUser('user-456', {
+ *   since: new Date('2024-01-01'),
+ * });
+ * ```
+ */
+export declare class AuditLogService implements IAuditLogService {
+    private readonly repo;
+    private readonly options;
+    constructor(repo: Repository<AuditLog>, options: AuditLogModuleOptions);
+    /**
+     * Log an audit entry for an entity change.
+     * Automatically captures user context from AsyncLocalStorage.
+     * Applies @AuditIgnore and @AuditMask decorators from the entity.
+     */
+    log(params: LogParams): Promise<void>;
+    /**
+     * Find audit logs for a specific entity.
+     */
+    findByEntity(entityName: string, entityId: string, options?: FindByEntityOptions): Promise<AuditLog[]>;
+    /**
+     * Find audit logs by user ID.
+     */
+    findByUser(userId: string, options?: FindByUserOptions): Promise<AuditLog[]>;
+    /**
+     * Find all audit logs with optional filters and pagination.
+     */
+    findAll(options?: FindAllOptions): Promise<PaginatedResult<AuditLog>>;
+}

package/dist/audit-log.service.js

@@ -0,0 +1,177 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogService = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("@nestjs/typeorm");
+const audit_context_1 = require("./audit-context");
+const audit_log_entity_1 = require("./audit-log.entity");
+const constants_1 = require("./constants");
+const diff_1 = require("./utils/diff");
+const mask_1 = require("./utils/mask");
+/**
+ * Service for logging and querying audit entries.
+ * Captures entity changes with user attribution, diff calculation,
+ * and request context (IP, user agent, metadata).
+ *
+ * @example
+ * ```typescript
+ * // Query audit history for an entity
+ * const history = await auditLogService.findByEntity('User', '123');
+ *
+ * // Query changes made by a specific user
+ * const userChanges = await auditLogService.findByUser('user-456', {
+ *   since: new Date('2024-01-01'),
+ * });
+ * ```
+ */
+let AuditLogService = class AuditLogService {
+    constructor(repo, options) {
+        this.repo = repo;
+        this.options = options;
+    }
+    /**
+     * Log an audit entry for an entity change.
+     * Automatically captures user context from AsyncLocalStorage.
+     * Applies @AuditIgnore and @AuditMask decorators from the entity.
+     */
+    async log(params) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        const context = (0, audit_context_1.getAuditContext)();
+        // Get entity class for decorator metadata
+        const entityClass = (_b = (_a = params.entity) === null || _a === void 0 ? void 0 : _a.constructor) !== null && _b !== void 0 ? _b : null;
+        // Get all excluded fields (global + @AuditIgnore)
+        const excludeFields = (0, mask_1.getAllExcludedFields)(entityClass, (_c = this.options.excludeFields) !== null && _c !== void 0 ? _c : []);
+        // Calculate diff between old and new values using deep-diff
+        const diff = (0, diff_1.calculateDiff)(params.oldValues, params.entity, excludeFields);
+        // Apply masking and exclusions to values
+        const oldValues = (0, mask_1.applyMaskAndExclusions)(params.oldValues, entityClass, (_d = this.options.excludeFields) !== null && _d !== void 0 ? _d : []);
+        const newValues = (0, mask_1.applyMaskAndExclusions)(params.entity, entityClass, (_e = this.options.excludeFields) !== null && _e !== void 0 ? _e : []);
+        // Create audit log entry
+        const entry = this.repo.create({
+            entityName: params.entityName,
+            entityId: params.entityId,
+            action: params.action,
+            userId: (_f = context === null || context === void 0 ? void 0 : context.userId) !== null && _f !== void 0 ? _f : null,
+            userName: (_g = context === null || context === void 0 ? void 0 : context.userName) !== null && _g !== void 0 ? _g : null,
+            oldValues,
+            newValues,
+            diff,
+            ip: (_h = context === null || context === void 0 ? void 0 : context.ip) !== null && _h !== void 0 ? _h : null,
+            userAgent: (_j = context === null || context === void 0 ? void 0 : context.userAgent) !== null && _j !== void 0 ? _j : null,
+            metadata: (_k = context === null || context === void 0 ? void 0 : context.metadata) !== null && _k !== void 0 ? _k : null,
+        });
+        // Save the audit log
+        if (this.options.async) {
+            // Fire and forget for async mode
+            this.repo.save(entry).catch((error) => {
+                console.error('[AuditLogService] Failed to save audit log:', error);
+            });
+        }
+        else {
+            await this.repo.save(entry);
+        }
+    }
+    /**
+     * Find audit logs for a specific entity.
+     */
+    async findByEntity(entityName, entityId, options) {
+        const query = this.repo
+            .createQueryBuilder('audit')
+            .where('audit.entityName = :entityName', { entityName })
+            .andWhere('audit.entityId = :entityId', { entityId });
+        if (options === null || options === void 0 ? void 0 : options.since) {
+            query.andWhere('audit.timestamp >= :since', { since: options.since });
+        }
+        if (options === null || options === void 0 ? void 0 : options.until) {
+            query.andWhere('audit.timestamp <= :until', { until: options.until });
+        }
+        if (options === null || options === void 0 ? void 0 : options.action) {
+            query.andWhere('audit.action = :action', { action: options.action });
+        }
+        query.orderBy('audit.timestamp', 'DESC');
+        if (options === null || options === void 0 ? void 0 : options.limit) {
+            query.take(options.limit);
+        }
+        return query.getMany();
+    }
+    /**
+     * Find audit logs by user ID.
+     */
+    async findByUser(userId, options) {
+        const query = this.repo.createQueryBuilder('audit').where('audit.userId = :userId', { userId });
+        if (options === null || options === void 0 ? void 0 : options.since) {
+            query.andWhere('audit.timestamp >= :since', { since: options.since });
+        }
+        if (options === null || options === void 0 ? void 0 : options.until) {
+            query.andWhere('audit.timestamp <= :until', { until: options.until });
+        }
+        if (options === null || options === void 0 ? void 0 : options.entityName) {
+            query.andWhere('audit.entityName = :entityName', { entityName: options.entityName });
+        }
+        if (options === null || options === void 0 ? void 0 : options.action) {
+            query.andWhere('audit.action = :action', { action: options.action });
+        }
+        query.orderBy('audit.timestamp', 'DESC');
+        if (options === null || options === void 0 ? void 0 : options.limit) {
+            query.take(options.limit);
+        }
+        return query.getMany();
+    }
+    /**
+     * Find all audit logs with optional filters and pagination.
+     */
+    async findAll(options) {
+        var _a, _b;
+        const page = (_a = options === null || options === void 0 ? void 0 : options.page) !== null && _a !== void 0 ? _a : 1;
+        const limit = (_b = options === null || options === void 0 ? void 0 : options.limit) !== null && _b !== void 0 ? _b : 50;
+        const skip = (page - 1) * limit;
+        const query = this.repo.createQueryBuilder('audit');
+        if (options === null || options === void 0 ? void 0 : options.since) {
+            query.andWhere('audit.timestamp >= :since', { since: options.since });
+        }
+        if (options === null || options === void 0 ? void 0 : options.until) {
+            query.andWhere('audit.timestamp <= :until', { until: options.until });
+        }
+        if (options === null || options === void 0 ? void 0 : options.entityName) {
+            query.andWhere('audit.entityName = :entityName', { entityName: options.entityName });
+        }
+        if (options === null || options === void 0 ? void 0 : options.entityId) {
+            query.andWhere('audit.entityId = :entityId', { entityId: options.entityId });
+        }
+        if (options === null || options === void 0 ? void 0 : options.userId) {
+            query.andWhere('audit.userId = :userId', { userId: options.userId });
+        }
+        if (options === null || options === void 0 ? void 0 : options.action) {
+            query.andWhere('audit.action = :action', { action: options.action });
+        }
+        query.orderBy('audit.timestamp', 'DESC');
+        const [items, total] = await query.skip(skip).take(limit).getManyAndCount();
+        return {
+            items,
+            total,
+            page,
+            limit,
+            totalPages: Math.ceil(total / limit),
+        };
+    }
+};
+exports.AuditLogService = AuditLogService;
+exports.AuditLogService = AuditLogService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, typeorm_1.InjectRepository)(audit_log_entity_1.AuditLog)),
+    __param(1, (0, common_1.Inject)(constants_1.AUDIT_LOG_OPTIONS)),
+    __metadata("design:paramtypes", [Function, Object])
+], AuditLogService);
+//# sourceMappingURL=audit-log.service.js.map

package/dist/audit-log.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-log.service.js","sourceRoot":"","sources":["../src/audit-log.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAoD;AACpD,6CAAmD;AAEnD,mDAAkD;AAClD,yDAA8C;AAE9C,2CAAgD;AAEhD,uCAA6C;AAC7C,uCAA4E;AAE5E;;;;;;;;;;;;;;;GAeG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IAC1B,YAEmB,IAA0B,EAE1B,OAA8B;QAF9B,SAAI,GAAJ,IAAI,CAAsB;QAE1B,YAAO,GAAP,OAAO,CAAuB;IAC9C,CAAC;IAEJ;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,MAAiB;;QACzB,MAAM,OAAO,GAAG,IAAA,+BAAe,GAAE,CAAC;QAElC,0CAA0C;QAC1C,MAAM,WAAW,GAAG,MAAA,MAAA,MAAM,CAAC,MAAM,0CAAE,WAAW,mCAAI,IAAI,CAAC;QAEvD,kDAAkD;QAClD,MAAM,aAAa,GAAG,IAAA,2BAAoB,EAAC,WAAW,EAAE,MAAA,IAAI,CAAC,OAAO,CAAC,aAAa,mCAAI,EAAE,CAAC,CAAC;QAE1F,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAA,oBAAa,EAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAE3E,yCAAyC;QACzC,MAAM,SAAS,GAAG,IAAA,6BAAsB,EAAC,MAAM,CAAC,SAAS,EAAE,WAAW,EAAE,MAAA,IAAI,CAAC,OAAO,CAAC,aAAa,mCAAI,EAAE,CAAC,CAAC;QAC1G,MAAM,SAAS,GAAG,IAAA,6BAAsB,EAAC,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,MAAA,IAAI,CAAC,OAAO,CAAC,aAAa,mCAAI,EAAE,CAAC,CAAC;QAEvG,yBAAyB;QACzB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YAC7B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,MAAM,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,IAAI;YAC/B,QAAQ,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,IAAI;YACnC,SAAS;YACT,SAAS;YACT,IAAI;YACJ,EAAE,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,mCAAI,IAAI;YACvB,SAAS,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,mCAAI,IAAI;YACrC,QAAQ,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,IAAI;SACpC,CAAC,CAAC;QAEH,qBAAqB;QACrB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACvB,iCAAiC;YACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpC,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,KAAK,CAAC,CAAC;YACtE,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,QAAgB,EAAE,OAA6B;QACpF,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI;aACpB,kBAAkB,CAAC,OAAO,CAAC;aAC3B,KAAK,CAAC,gCAAgC,EAAE,EAAE,UAAU,EAAE,CAAC;aACvD,QAAQ,CAAC,4BAA4B,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAExD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE,CAAC;YACnB,KAAK,CAAC,QAAQ,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE,CAAC;YACnB,KAAK,CAAC,QAAQ,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE,CAAC;YACpB,KAAK,CAAC,QAAQ,CAAC,wBAAwB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;QAEzC,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE,CAAC;YACnB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,OAA2B;QAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,wBAAwB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAEhG,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE,CAAC;YACnB,KAAK,CAAC,QAAQ,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE,CAAC;YACnB,KAAK,CAAC,QAAQ,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE,CAAC;YACxB,KAAK,CAAC,QAAQ,CAAC,gCAAgC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE,CAAC;YACpB,KAAK,CAAC,QAAQ,CAAC,wBAAwB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;QAEzC,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE,CAAC;YACnB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,OAAwB;;QACpC,MAAM,IAAI,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,mCAAI,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;QAEhC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAEpD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE,CAAC;YACnB,KAAK,CAAC,QAAQ,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE,CAAC;YACnB,KAAK,CAAC,QAAQ,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE,CAAC;YACxB,KAAK,CAAC,QAAQ,CAAC,gCAAgC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE,CAAC;YACtB,KAAK,CAAC,QAAQ,CAAC,4BAA4B,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/E,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE,CAAC;YACpB,KAAK,CAAC,QAAQ,CAAC,wBAAwB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE,CAAC;YACpB,KAAK,CAAC,QAAQ,CAAC,wBAAwB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;QAEzC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,CAAC;QAE5E,OAAO;YACL,KAAK;YACL,KAAK;YACL,IAAI;YACJ,KAAK;YACL,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;SACrC,CAAC;IACJ,CAAC;CACF,CAAA;AAlKY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,mBAAU,GAAE;IAGR,WAAA,IAAA,0BAAgB,EAAC,2BAAQ,CAAC,CAAA;IAE1B,WAAA,IAAA,eAAM,EAAC,6BAAiB,CAAC,CAAA;;GAJjB,eAAe,CAkK3B"}

package/dist/audit-log.subscriber.d.ts

@@ -0,0 +1,66 @@
+import type { DataSource, EntitySubscriberInterface, InsertEvent, RemoveEvent, UpdateEvent } from 'typeorm';
+import { type LogParams } from './types';
+/**
+ * Interface for the audit log service that the subscriber depends on.
+ * Allows for loose coupling and easier testing.
+ */
+export interface IAuditLogService {
+    log(params: LogParams): Promise<void>;
+}
+/**
+ * TypeORM event subscriber that captures entity changes and logs them.
+ * Automatically detects entities decorated with @Auditable() and creates
+ * audit log entries for INSERT, UPDATE, and DELETE operations.
+ *
+ * This subscriber is designed to be instantiated by NestJS DI and then
+ * registered with the TypeORM DataSource.
+ *
+ * @example
+ * ```typescript
+ * // In your module
+ * @Module({
+ *   providers: [
+ *     {
+ *       provide: AuditLogSubscriber,
+ *       useFactory: (dataSource: DataSource, auditLogService: AuditLogService) => {
+ *         const subscriber = new AuditLogSubscriber(auditLogService);
+ *         dataSource.subscribers.push(subscriber);
+ *         return subscriber;
+ *       },
+ *       inject: [DataSource, AuditLogService],
+ *     },
+ *   ],
+ * })
+ * ```
+ */
+export declare class AuditLogSubscriber implements EntitySubscriberInterface {
+    private auditLogService;
+    /**
+     * Set the audit log service. Called during module initialization.
+     */
+    setAuditLogService(service: IAuditLogService): void;
+    /**
+     * Register this subscriber with a TypeORM DataSource.
+     */
+    registerWithDataSource(dataSource: DataSource): void;
+    /**
+     * Handle entity insertion events.
+     */
+    afterInsert(event: InsertEvent<unknown>): void;
+    /**
+     * Handle entity update events.
+     */
+    afterUpdate(event: UpdateEvent<unknown>): void;
+    /**
+     * Handle entity removal events.
+     */
+    afterRemove(event: RemoveEvent<unknown>): void;
+    /**
+     * Common handler for all entity events.
+     */
+    private handleEvent;
+    /**
+     * Extract the entity ID from the event or entity.
+     */
+    private getEntityId;
+}