@studiosonrai/nestjs-audit-log 1.0.0

package/dist/src/audit.subscriber.js

@@ -0,0 +1,100 @@
+"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); }
+};
+var AuditSubscriber_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditSubscriber = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("@nestjs/typeorm");
+const typeorm_2 = require("typeorm");
+const nestjs_cls_1 = require("nestjs-cls");
+const audit_log_entity_1 = require("./entities/audit-log.entity");
+const audit_helper_1 = require("./audit.helper");
+const audit_builder_1 = require("./audit.builder");
+const auditable_decorator_1 = require("./decorators/auditable.decorator");
+const audit_constants_1 = require("./audit.constants");
+let AuditSubscriber = AuditSubscriber_1 = class AuditSubscriber {
+    cls;
+    logger = new common_1.Logger(AuditSubscriber_1.name);
+    constructor(dataSource, cls) {
+        this.cls = cls;
+        dataSource.subscribers.push(this);
+    }
+    currentUserId() {
+        return this.cls?.get(audit_constants_1.AUDIT_CLS_USER_ID);
+    }
+    async afterInsert(event) {
+        const entity = event.entity;
+        if (!entity || entity instanceof audit_log_entity_1.AuditLog) {
+            return;
+        }
+        const auditable = (0, auditable_decorator_1.getAuditableOptions)(entity);
+        if (!auditable) {
+            return;
+        }
+        const record = entity;
+        await this.persist(event.manager.getRepository(audit_log_entity_1.AuditLog), {
+            entityType: auditable.entityType,
+            entityId: record.id,
+            entityName: auditable.nameField
+                ? record[auditable.nameField]
+                : undefined,
+            action: audit_log_entity_1.AuditActionType.CREATE,
+            changes: (0, audit_helper_1.extractAuditableFields)(entity, auditable.exclude),
+        });
+    }
+    async afterUpdate(event) {
+        const entity = event.entity;
+        if (!entity || entity instanceof audit_log_entity_1.AuditLog) {
+            return;
+        }
+        const auditable = (0, auditable_decorator_1.getAuditableOptions)(entity);
+        if (!auditable) {
+            return;
+        }
+        const newData = (0, audit_helper_1.extractAuditableFields)(entity, auditable.exclude);
+        const oldData = event.databaseEntity
+            ? (0, audit_helper_1.extractAuditableFields)(event.databaseEntity, auditable.exclude)
+            : undefined;
+        const changes = (0, audit_helper_1.calculateChanges)(oldData, newData);
+        if (Object.keys(changes).length === 0) {
+            return;
+        }
+        const record = entity;
+        await this.persist(event.manager.getRepository(audit_log_entity_1.AuditLog), {
+            entityType: auditable.entityType,
+            entityId: record.id,
+            entityName: auditable.nameField
+                ? record[auditable.nameField]
+                : undefined,
+            action: audit_log_entity_1.AuditActionType.UPDATE,
+            changes,
+        });
+    }
+    async persist(repository, input) {
+        try {
+            await repository.save((0, audit_builder_1.toAuditLog)({ ...input, changedBy: this.currentUserId() }));
+        }
+        catch (error) {
+            this.logger.error(`Failed to record ${input.action} audit for ${input.entityType} ${input.entityId}`, String(error));
+        }
+    }
+};
+exports.AuditSubscriber = AuditSubscriber;
+exports.AuditSubscriber = AuditSubscriber = AuditSubscriber_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, typeorm_1.InjectDataSource)()),
+    __metadata("design:paramtypes", [typeorm_2.DataSource,
+        nestjs_cls_1.ClsService])
+], AuditSubscriber);
+//# sourceMappingURL=audit.subscriber.js.map

package/dist/src/audit.subscriber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit.subscriber.js","sourceRoot":"","sources":["../../src/audit.subscriber.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAoD;AACpD,6CAAmD;AACnD,qCAMiB;AACjB,2CAAwC;AACxC,kEAAwE;AACxE,iDAA0E;AAC1E,mDAA6C;AAC7C,0EAAuE;AACvE,uDAAsD;AAa/C,IAAM,eAAe,uBAArB,MAAM,eAAe;IAKP;IAJF,MAAM,GAAG,IAAI,eAAM,CAAC,iBAAe,CAAC,IAAI,CAAC,CAAC;IAE3D,YACsB,UAAsB,EACzB,GAAe;QAAf,QAAG,GAAH,GAAG,CAAY;QAEhC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAEO,aAAa;QACnB,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,CAAqB,mCAAiB,CAAC,CAAC;IAC9D,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAA0B;QAC1C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,MAAM,IAAI,MAAM,YAAY,2BAAQ,EAAE,CAAC;YAC1C,OAAO;QACT,CAAC;QACD,MAAM,SAAS,GAAG,IAAA,yCAAmB,EAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,MAAiC,CAAC;QACjD,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,2BAAQ,CAAC,EAAE;YACxD,UAAU,EAAE,SAAS,CAAC,UAAoB;YAC1C,QAAQ,EAAE,MAAM,CAAC,EAAY;YAC7B,UAAU,EAAE,SAAS,CAAC,SAAS;gBAC7B,CAAC,CAAE,MAAM,CAAC,SAAS,CAAC,SAAS,CAAwB;gBACrD,CAAC,CAAC,SAAS;YACb,MAAM,EAAE,kCAAe,CAAC,MAAM;YAC9B,OAAO,EAAE,IAAA,qCAAsB,EAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC;SAC3D,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAA0B;QAC1C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,MAAM,IAAI,MAAM,YAAY,2BAAQ,EAAE,CAAC;YAC1C,OAAO;QACT,CAAC;QACD,MAAM,SAAS,GAAG,IAAA,yCAAmB,EAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,IAAA,qCAAsB,EAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,OAAO,GAAG,KAAK,CAAC,cAAc;YAClC,CAAC,CAAC,IAAA,qCAAsB,EAAC,KAAK,CAAC,cAAc,EAAE,SAAS,CAAC,OAAO,CAAC;YACjE,CAAC,CAAC,SAAS,CAAC;QACd,MAAM,OAAO,GAAG,IAAA,+BAAgB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACnD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,MAAiC,CAAC;QACjD,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,2BAAQ,CAAC,EAAE;YACxD,UAAU,EAAE,SAAS,CAAC,UAAoB;YAC1C,QAAQ,EAAE,MAAM,CAAC,EAAY;YAC7B,UAAU,EAAE,SAAS,CAAC,SAAS;gBAC7B,CAAC,CAAE,MAAM,CAAC,SAAS,CAAC,SAAS,CAAwB;gBACrD,CAAC,CAAC,SAAS;YACb,MAAM,EAAE,kCAAe,CAAC,MAAM;YAC9B,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,OAAO,CACnB,UAAgC,EAChC,KAMC;QAED,IAAI,CAAC;YACH,MAAM,UAAU,CAAC,IAAI,CACnB,IAAA,0BAAU,EAAC,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAC1D,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,oBAAoB,KAAK,CAAC,MAAM,cAAc,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,QAAQ,EAAE,EAClF,MAAM,CAAC,KAAK,CAAC,CACd,CAAC;QACJ,CAAC;IACH,CAAC;CACF,CAAA;AAxFY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,mBAAU,GAAE;IAKR,WAAA,IAAA,0BAAgB,GAAE,CAAA;qCAAa,oBAAU;QACpB,uBAAU;GALvB,eAAe,CAwF3B"}

package/dist/src/decorators/auditable.decorator.d.ts

@@ -0,0 +1,3 @@
+import { AuditableOptions } from '../interfaces/audit.interfaces';
+export declare function Auditable(options?: AuditableOptions): ClassDecorator;
+export declare function getAuditableOptions(entity: object): AuditableOptions | null;

package/dist/src/decorators/auditable.decorator.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auditable = Auditable;
+exports.getAuditableOptions = getAuditableOptions;
+const audit_constants_1 = require("../audit.constants");
+function Auditable(options = {}) {
+    return (target) => {
+        Reflect.defineMetadata(audit_constants_1.AUDITABLE_METADATA, options, target);
+    };
+}
+function getAuditableOptions(entity) {
+    const ctor = entity.constructor;
+    if (typeof ctor !== 'function') {
+        return null;
+    }
+    const options = Reflect.getMetadata(audit_constants_1.AUDITABLE_METADATA, ctor);
+    if (!options) {
+        return null;
+    }
+    return { entityType: ctor.name, ...options };
+}
+//# sourceMappingURL=auditable.decorator.js.map

package/dist/src/decorators/auditable.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auditable.decorator.js","sourceRoot":"","sources":["../../../src/decorators/auditable.decorator.ts"],"names":[],"mappings":";;AAQA,8BAIC;AAGD,kDAYC;AA3BD,wDAAwD;AAQxD,SAAgB,SAAS,CAAC,UAA4B,EAAE;IACtD,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,OAAO,CAAC,cAAc,CAAC,oCAAkB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC,CAAC;AACJ,CAAC;AAGD,SAAgB,mBAAmB,CAAC,MAAc;IAChD,MAAM,IAAI,GAAI,MAAoC,CAAC,WAAW,CAAC;IAC/D,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,oCAAkB,EAAE,IAAI,CAE/C,CAAC;IACd,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC;AAC/C,CAAC"}

package/dist/src/dto/audit-filter.dto.d.ts

@@ -0,0 +1,10 @@
+import { AuditActionType } from '../entities/audit-log.entity';
+export declare class AuditFilterDto {
+    page?: number;
+    limit?: number;
+    entityType?: string;
+    entityId?: number;
+    changedBy?: number;
+    action?: AuditActionType;
+    search?: string;
+}

package/dist/src/dto/audit-filter.dto.js

@@ -0,0 +1,101 @@
+"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.AuditFilterDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const audit_log_entity_1 = require("../entities/audit-log.entity");
+class AuditFilterDto {
+    page = 0;
+    limit = 10;
+    entityType;
+    entityId;
+    changedBy;
+    action;
+    search;
+}
+exports.AuditFilterDto = AuditFilterDto;
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Page number (0-indexed)',
+        example: 0,
+        default: 0,
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(0),
+    __metadata("design:type", Number)
+], AuditFilterDto.prototype, "page", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Number of items per page',
+        example: 10,
+        default: 10,
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(1),
+    __metadata("design:type", Number)
+], AuditFilterDto.prototype, "limit", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Entity type to filter by',
+        example: 'Contact',
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], AuditFilterDto.prototype, "entityType", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Entity ID to filter by',
+        example: 1,
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(1),
+    __metadata("design:type", Number)
+], AuditFilterDto.prototype, "entityId", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'User ID who made the change',
+        example: 1,
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(1),
+    __metadata("design:type", Number)
+], AuditFilterDto.prototype, "changedBy", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Action type to filter by',
+        example: 'CREATE',
+        enum: audit_log_entity_1.AuditActionType,
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(audit_log_entity_1.AuditActionType),
+    __metadata("design:type", String)
+], AuditFilterDto.prototype, "action", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Search query - searches entity name and entity type',
+        example: 'contact',
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], AuditFilterDto.prototype, "search", void 0);
+//# sourceMappingURL=audit-filter.dto.js.map

package/dist/src/dto/audit-filter.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-filter.dto.js","sourceRoot":"","sources":["../../../src/dto/audit-filter.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAsD;AACtD,yDAAyC;AACzC,qDAA2E;AAC3E,mEAA+D;AAE/D,MAAa,cAAc;IAUzB,IAAI,GAAY,CAAC,CAAC;IAWlB,KAAK,GAAY,EAAE,CAAC;IAQpB,UAAU,CAAU;IAUpB,QAAQ,CAAU;IAUlB,SAAS,CAAU;IASnB,MAAM,CAAmB;IAQzB,MAAM,CAAU;CACjB;AAnED,wCAmEC;AAzDC;IATC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,yBAAyB;QACtC,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;KACX,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAClB,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;;4CACW;AAWlB;IATC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;KACZ,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAClB,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;;6CACa;AAQpB;IANC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,SAAS;KACnB,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;kDACS;AAUpB;IARC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,wBAAwB;QACrC,OAAO,EAAE,CAAC;KACX,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAClB,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;;gDACW;AAUlB;IARC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE,CAAC;KACX,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IAClB,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;;iDACY;AASnB;IAPC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,QAAQ;QACjB,IAAI,EAAE,kCAAe;KACtB,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,wBAAM,EAAC,kCAAe,CAAC;;8CACC;AAQzB;IANC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,qDAAqD;QAClE,OAAO,EAAE,SAAS;KACnB,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;;8CACK"}

package/dist/src/dto/audit-log-response.dto.d.ts

@@ -0,0 +1,13 @@
+import { AuditActionType } from '../entities/audit-log.entity';
+export declare class AuditLogResponseDto {
+    id: number;
+    entityType: string;
+    entityId: number;
+    entityName?: string;
+    action: AuditActionType;
+    changes?: string;
+    changedBy?: number;
+    changedByName?: string;
+    changedByEmail?: string;
+    changedAt: Date;
+}

package/dist/src/dto/audit-log-response.dto.js

@@ -0,0 +1,91 @@
+"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.AuditLogResponseDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const audit_log_entity_1 = require("../entities/audit-log.entity");
+class AuditLogResponseDto {
+    id;
+    entityType;
+    entityId;
+    entityName;
+    action;
+    changes;
+    changedBy;
+    changedByName;
+    changedByEmail;
+    changedAt;
+}
+exports.AuditLogResponseDto = AuditLogResponseDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Audit log ID', example: 1 }),
+    __metadata("design:type", Number)
+], AuditLogResponseDto.prototype, "id", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Entity type', example: 'Contact' }),
+    __metadata("design:type", String)
+], AuditLogResponseDto.prototype, "entityType", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Entity ID', example: 42 }),
+    __metadata("design:type", Number)
+], AuditLogResponseDto.prototype, "entityId", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'Entity name (human readable)',
+        example: 'John Doe',
+    }),
+    __metadata("design:type", String)
+], AuditLogResponseDto.prototype, "entityName", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Action performed',
+        example: 'CREATE',
+        enum: audit_log_entity_1.AuditActionType,
+    }),
+    __metadata("design:type", String)
+], AuditLogResponseDto.prototype, "action", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Changes made (JSON)',
+        example: '{"name":"John","email":"john@example.com"}',
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], AuditLogResponseDto.prototype, "changes", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'User ID who made the change',
+        example: 1,
+    }),
+    __metadata("design:type", Number)
+], AuditLogResponseDto.prototype, "changedBy", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'User name who made the change',
+        example: 'John Admin',
+    }),
+    __metadata("design:type", String)
+], AuditLogResponseDto.prototype, "changedByName", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'User email who made the change',
+        example: 'john.admin@example.com',
+    }),
+    __metadata("design:type", String)
+], AuditLogResponseDto.prototype, "changedByEmail", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Timestamp of the change',
+        example: '2024-01-01T00:00:00Z',
+    }),
+    __metadata("design:type", Date)
+], AuditLogResponseDto.prototype, "changedAt", void 0);
+//# sourceMappingURL=audit-log-response.dto.js.map

package/dist/src/dto/audit-log-response.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-log-response.dto.js","sourceRoot":"","sources":["../../../src/dto/audit-log-response.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAAmE;AACnE,mEAA+D;AAE/D,MAAa,mBAAmB;IAE9B,EAAE,CAAS;IAGX,UAAU,CAAS;IAGnB,QAAQ,CAAS;IAMjB,UAAU,CAAU;IAOpB,MAAM,CAAkB;IAOxB,OAAO,CAAU;IAMjB,SAAS,CAAU;IAMnB,aAAa,CAAU;IAMvB,cAAc,CAAU;IAMxB,SAAS,CAAO;CACjB;AArDD,kDAqDC;AAnDC;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;+CAC9C;AAGX;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;;uDAC7C;AAGnB;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;;qDACtC;AAMjB;IAJC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,8BAA8B;QAC3C,OAAO,EAAE,UAAU;KACpB,CAAC;;uDACkB;AAOpB;IALC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,kBAAkB;QAC/B,OAAO,EAAE,QAAQ;QACjB,IAAI,EAAE,kCAAe;KACtB,CAAC;;mDACsB;AAOxB;IALC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,qBAAqB;QAClC,OAAO,EAAE,4CAA4C;QACrD,QAAQ,EAAE,IAAI;KACf,CAAC;;oDACe;AAMjB;IAJC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE,CAAC;KACX,CAAC;;sDACiB;AAMnB;IAJC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,+BAA+B;QAC5C,OAAO,EAAE,YAAY;KACtB,CAAC;;0DACqB;AAMvB;IAJC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,gCAAgC;QAC7C,OAAO,EAAE,wBAAwB;KAClC,CAAC;;2DACsB;AAMxB;IAJC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,yBAAyB;QACtC,OAAO,EAAE,sBAAsB;KAChC,CAAC;8BACS,IAAI;sDAAC"}

package/dist/src/dto/paginated-result.dto.d.ts

@@ -0,0 +1,9 @@
+export declare class PaginatedResultDto<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+}

package/dist/src/dto/paginated-result.dto.js

@@ -0,0 +1,52 @@
+"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.PaginatedResultDto = void 0;
+const swagger_1 = require("@nestjs/swagger");
+class PaginatedResultDto {
+    data;
+    total;
+    page;
+    limit;
+    totalPages;
+    hasNextPage;
+    hasPreviousPage;
+}
+exports.PaginatedResultDto = PaginatedResultDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Array of items' }),
+    __metadata("design:type", Array)
+], PaginatedResultDto.prototype, "data", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Total number of items', example: 100 }),
+    __metadata("design:type", Number)
+], PaginatedResultDto.prototype, "total", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Current page (0-indexed)', example: 0 }),
+    __metadata("design:type", Number)
+], PaginatedResultDto.prototype, "page", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Number of items per page', example: 10 }),
+    __metadata("design:type", Number)
+], PaginatedResultDto.prototype, "limit", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Total number of pages', example: 10 }),
+    __metadata("design:type", Number)
+], PaginatedResultDto.prototype, "totalPages", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Whether there is a next page', example: true }),
+    __metadata("design:type", Boolean)
+], PaginatedResultDto.prototype, "hasNextPage", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Whether there is a previous page', example: false }),
+    __metadata("design:type", Boolean)
+], PaginatedResultDto.prototype, "hasPreviousPage", void 0);
+//# sourceMappingURL=paginated-result.dto.js.map

package/dist/src/dto/paginated-result.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginated-result.dto.js","sourceRoot":"","sources":["../../../src/dto/paginated-result.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAA8C;AAE9C,MAAa,kBAAkB;IAE7B,IAAI,CAAM;IAGV,KAAK,CAAS;IAGd,IAAI,CAAS;IAGb,KAAK,CAAS;IAGd,UAAU,CAAS;IAGnB,WAAW,CAAU;IAGrB,eAAe,CAAU;CAC1B;AArBD,gDAqBC;AAnBC;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;;gDACrC;AAGV;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,uBAAuB,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;;iDACtD;AAGd;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,0BAA0B,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;gDACxD;AAGb;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,0BAA0B,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;;iDACxD;AAGd;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,uBAAuB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;;sDAChD;AAGnB;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,8BAA8B,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;uDACvD;AAGrB;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,kCAAkC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;;2DACxD"}

package/dist/src/entities/audit-log.entity.d.ts

@@ -0,0 +1,15 @@
+export declare enum AuditActionType {
+    CREATE = "CREATE",
+    UPDATE = "UPDATE",
+    DELETE = "DELETE"
+}
+export declare class AuditLog {
+    id: number;
+    entityType: string;
+    entityId: number;
+    action: AuditActionType;
+    changes?: string;
+    entityName?: string;
+    changedBy?: number;
+    changedAt: Date;
+}

package/dist/src/entities/audit-log.entity.js

@@ -0,0 +1,101 @@
+"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 = exports.AuditActionType = void 0;
+const typeorm_1 = require("typeorm");
+const swagger_1 = require("@nestjs/swagger");
+var AuditActionType;
+(function (AuditActionType) {
+    AuditActionType["CREATE"] = "CREATE";
+    AuditActionType["UPDATE"] = "UPDATE";
+    AuditActionType["DELETE"] = "DELETE";
+})(AuditActionType || (exports.AuditActionType = AuditActionType = {}));
+let AuditLog = class AuditLog {
+    id;
+    entityType;
+    entityId;
+    action;
+    changes;
+    entityName;
+    changedBy;
+    changedAt;
+};
+exports.AuditLog = AuditLog;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Audit log ID', example: 1 }),
+    (0, typeorm_1.PrimaryGeneratedColumn)(),
+    __metadata("design:type", Number)
+], AuditLog.prototype, "id", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Entity type being audited', example: 'Contact' }),
+    (0, typeorm_1.Column)({ type: 'nvarchar', length: 255 }),
+    __metadata("design:type", String)
+], AuditLog.prototype, "entityType", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'ID of the entity being audited',
+        example: 42,
+    }),
+    (0, typeorm_1.Column)({ type: 'int' }),
+    __metadata("design:type", Number)
+], AuditLog.prototype, "entityId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Type of action performed',
+        example: 'CREATE',
+        enum: AuditActionType,
+    }),
+    (0, typeorm_1.Column)({
+        type: 'nvarchar',
+        length: 50,
+        default: AuditActionType.CREATE,
+    }),
+    __metadata("design:type", String)
+], AuditLog.prototype, "action", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Changes made to the entity (JSON)',
+        example: '{"name":"John","email":"john@example.com"}',
+        nullable: true,
+    }),
+    (0, typeorm_1.Column)({ type: 'nvarchar', length: 'MAX', nullable: true }),
+    __metadata("design:type", String)
+], AuditLog.prototype, "changes", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Human-readable name of the entity (e.g. contact full name, organisation name)',
+        example: 'John Doe',
+        nullable: true,
+    }),
+    (0, typeorm_1.Column)({ type: 'nvarchar', length: 500, nullable: true }),
+    __metadata("design:type", String)
+], AuditLog.prototype, "entityName", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'User ID who made the change',
+        example: 1,
+        nullable: true,
+    }),
+    (0, typeorm_1.Column)({ type: 'int', nullable: true }),
+    __metadata("design:type", Number)
+], AuditLog.prototype, "changedBy", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Timestamp of the change',
+        example: '2024-01-01T00:00:00Z',
+    }),
+    (0, typeorm_1.Column)({ type: 'datetime2', default: () => 'GETDATE()' }),
+    __metadata("design:type", Date)
+], AuditLog.prototype, "changedAt", void 0);
+exports.AuditLog = AuditLog = __decorate([
+    (0, typeorm_1.Entity)('auditLog')
+], AuditLog);
+//# sourceMappingURL=audit-log.entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"audit-log.entity.js","sourceRoot":"","sources":["../../../src/entities/audit-log.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAiE;AACjE,6CAA8C;AAE9C,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;AACnB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAGM,IAAM,QAAQ,GAAd,MAAM,QAAQ;IAGnB,EAAE,CAAS;IAIX,UAAU,CAAS;IAOnB,QAAQ,CAAS;IAYjB,MAAM,CAAkB;IAQxB,OAAO,CAAU;IASjB,UAAU,CAAU;IAQpB,SAAS,CAAU;IAOnB,SAAS,CAAO;CACjB,CAAA;AA3DY,4BAAQ;AAGnB;IAFC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACxD,IAAA,gCAAsB,GAAE;;oCACd;AAIX;IAFC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,2BAA2B,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IAC7E,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;4CACvB;AAOnB;IALC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,gCAAgC;QAC7C,OAAO,EAAE,EAAE;KACZ,CAAC;IACD,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;;0CACP;AAYjB;IAVC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,QAAQ;QACjB,IAAI,EAAE,eAAe;KACtB,CAAC;IACD,IAAA,gBAAM,EAAC;QACN,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,eAAe,CAAC,MAAM;KAChC,CAAC;;wCACsB;AAQxB;IANC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE,4CAA4C;QACrD,QAAQ,EAAE,IAAI;KACf,CAAC;IACD,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yCAC3C;AASjB;IAPC,IAAA,qBAAW,EAAC;QACX,WAAW,EACT,+EAA+E;QACjF,OAAO,EAAE,UAAU;QACnB,QAAQ,EAAE,IAAI;KACf,CAAC;IACD,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACtC;AAQpB;IANC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE,CAAC;QACV,QAAQ,EAAE,IAAI;KACf,CAAC;IACD,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACrB;AAOnB;IALC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,yBAAyB;QACtC,OAAO,EAAE,sBAAsB;KAChC,CAAC;IACD,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;8BAC/C,IAAI;2CAAC;mBA1DL,QAAQ;IADpB,IAAA,gBAAM,EAAC,UAAU,CAAC;GACN,QAAQ,CA2DpB"}

package/dist/src/index.d.ts

@@ -0,0 +1,13 @@
+export * from './audit.module';
+export * from './audit.service';
+export * from './audit.subscriber';
+export * from './audit-context.interceptor';
+export * from './audit.constants';
+export * from './decorators/auditable.decorator';
+export * from './audit.helper';
+export * from './audit.builder';
+export * from './entities/audit-log.entity';
+export * from './dto/audit-filter.dto';
+export * from './dto/audit-log-response.dto';
+export * from './dto/paginated-result.dto';
+export * from './interfaces/audit.interfaces';

package/dist/src/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./audit.module"), exports);
+__exportStar(require("./audit.service"), exports);
+__exportStar(require("./audit.subscriber"), exports);
+__exportStar(require("./audit-context.interceptor"), exports);
+__exportStar(require("./audit.constants"), exports);
+__exportStar(require("./decorators/auditable.decorator"), exports);
+__exportStar(require("./audit.helper"), exports);
+__exportStar(require("./audit.builder"), exports);
+__exportStar(require("./entities/audit-log.entity"), exports);
+__exportStar(require("./dto/audit-filter.dto"), exports);
+__exportStar(require("./dto/audit-log-response.dto"), exports);
+__exportStar(require("./dto/paginated-result.dto"), exports);
+__exportStar(require("./interfaces/audit.interfaces"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,iDAA+B;AAC/B,kDAAgC;AAChC,qDAAmC;AACnC,8DAA4C;AAC5C,oDAAkC;AAGlC,mEAAiD;AAGjD,iDAA+B;AAC/B,kDAAgC;AAGhC,8DAA4C;AAG5C,yDAAuC;AACvC,+DAA6C;AAC7C,6DAA2C;AAG3C,gEAA8C"}

package/dist/src/interfaces/audit.interfaces.d.ts

@@ -0,0 +1,34 @@
+import { InjectionToken, ModuleMetadata, Type } from '@nestjs/common';
+import { AuditActionType } from '../entities/audit-log.entity';
+export interface AuditUser {
+    name?: string;
+    email?: string;
+}
+export type UserResolver = (userId: number) => Promise<AuditUser | null> | AuditUser | null;
+export type UserIdExtractor = (request: unknown) => number | undefined;
+export interface AuditLogInput {
+    entityType: string;
+    entityId: number;
+    entityName?: string;
+    action: AuditActionType;
+    changes?: Record<string, unknown>;
+    changedBy?: number;
+}
+export interface AuditableOptions {
+    entityType?: string;
+    nameField?: string;
+    exclude?: string[];
+}
+export interface AuditModuleOptions {
+    resolveUser?: UserResolver;
+    getUserId?: UserIdExtractor;
+}
+export interface AuditModuleOptionsFactory {
+    createAuditOptions(): Promise<AuditModuleOptions> | AuditModuleOptions;
+}
+export interface AuditModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    useExisting?: Type<AuditModuleOptionsFactory>;
+    useClass?: Type<AuditModuleOptionsFactory>;
+    useFactory?: (...args: never[]) => Promise<AuditModuleOptions> | AuditModuleOptions;
+    inject?: InjectionToken[];
+}

package/dist/src/interfaces/audit.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=audit.interfaces.js.map

package/dist/src/interfaces/audit.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit.interfaces.js","sourceRoot":"","sources":["../../../src/interfaces/audit.interfaces.ts"],"names":[],"mappings":""}