@nest-omni/core 4.1.3-1 → 4.1.3-11

package/audit/services/entity-audit.service.js

@@ -32,10 +32,14 @@ const audit_context_service_1 = require("./audit-context.service");
 const audit_strategy_service_1 = require("./audit-strategy.service");
 const multi_database_service_1 = require("./multi-database.service");
 const dto_1 = require("../../common/dto");
+/**
+ * 实体审计服务
+ */
 let EntityAuditService = class EntityAuditService {
-    constructor(auditLogRepository, transactionRepository, entityManager, contextService, multiDbService, auditStrategy = new audit_strategy_service_1.DefaultAuditStrategy(), config, auditConnectionName) {
+    constructor(auditLogRepository, transactionRepository, manualOperationRepository, entityManager, contextService, multiDbService, auditStrategy = new audit_strategy_service_1.DefaultAuditStrategy(), config, auditConnectionName) {
         this.auditLogRepository = auditLogRepository;
         this.transactionRepository = transactionRepository;
+        this.manualOperationRepository = manualOperationRepository;
         this.entityManager = entityManager;
         this.contextService = contextService;
         this.multiDbService = multiDbService;
@@ -43,22 +47,32 @@ let EntityAuditService = class EntityAuditService {
         this.config = config;
         this.auditConnectionName = auditConnectionName || 'default';
     }
+    /**
+     * 记录实体变更
+     */
     logEntityChange(entityType_1, entityId_1, operation_1, oldValue_1, newValue_1) {
         return __awaiter(this, arguments, void 0, function* (entityType, entityId, operation, oldValue, newValue, metadata = {}) {
             var _a, _b;
+            // 检查是否应该记录
             if (!this.auditStrategy.shouldRecord(entityType, operation)) {
                 return null;
             }
+            // 获取记录策略
             const recordStrategy = this.auditStrategy.getRecordStrategy(entityType, operation);
             if (recordStrategy === enums_1.RecordStrategy.DISABLED) {
                 return null;
             }
+            // 获取字段过滤器
             const fieldFilter = this.auditStrategy.getFieldFilter(entityType);
+            // 过滤和脱敏字段
             const filteredOldValue = this.filterAndMaskFields(oldValue, fieldFilter);
             const filteredNewValue = this.filterAndMaskFields(newValue, fieldFilter);
+            // 计算变更字段
             const changedFields = this.calculateChangedFields(filteredOldValue, filteredNewValue);
             const changedFieldPaths = this.calculateChangedFieldPaths(filteredOldValue, filteredNewValue);
+            // 获取上下文信息
             const context = yield this.contextService.getCurrentContext();
+            // 创建审计日志
             const auditLog = this.auditLogRepository.create({
                 entityType,
                 entityId,
@@ -77,17 +91,23 @@ let EntityAuditService = class EntityAuditService {
                     ? yield this.generateHashChain(entityType, entityId, filteredNewValue)
                     : undefined,
             });
+            // 保存变更日志
             const savedLog = yield this.auditLogRepository.save(auditLog);
             return savedLog;
         });
     }
+    /**
+     * 查询审计日志
+     */
     getAuditLogs(query) {
         return __awaiter(this, void 0, void 0, function* () {
+            // 应用默认值
             const page = query.page || 1;
             const limit = query.limit || 20;
             const sortBy = query.sortBy || 'createdAt';
             const sortOrder = query.sortOrder || 'DESC';
             const queryBuilder = this.auditLogRepository.createQueryBuilder('log');
+            // 应用过滤条件
             if (query.entityType) {
                 queryBuilder.andWhere('log.entityType = :entityType', { entityType: query.entityType });
             }
@@ -111,7 +131,9 @@ let EntityAuditService = class EntityAuditService {
                     search: `%${query.search}%`,
                 });
             }
+            // 应用排序
             queryBuilder.orderBy(`log.${sortBy}`, sortOrder);
+            // 应用分页
             const skip = (page - 1) * limit;
             queryBuilder.skip(skip).take(limit);
             const [data, total] = yield queryBuilder.getManyAndCount();
@@ -124,6 +146,9 @@ let EntityAuditService = class EntityAuditService {
             return new dto_1.PageDto(data, pageMetaDto);
         });
     }
+    /**
+     * 比较实体差异
+     */
     compareEntities(entityType, entityId, fromLogId, toLogId) {
         return __awaiter(this, void 0, void 0, function* () {
             let fromData = {};
@@ -137,6 +162,7 @@ let EntityAuditService = class EntityAuditService {
                 toData = (toLog === null || toLog === void 0 ? void 0 : toLog.newValue) || {};
             }
             else {
+                // 获取最新的日志
                 const latestLog = yield this.auditLogRepository.findOne({
                     where: { entityType, entityId },
                     order: { createdAt: 'DESC' },
@@ -146,6 +172,9 @@ let EntityAuditService = class EntityAuditService {
             return this.compareSnapshotData(fromData, toData);
         });
     }
+    /**
+     * 预检查恢复操作
+     */
     preCheckRestore(entityType, entityId, auditLogId) {
         return __awaiter(this, void 0, void 0, function* () {
             const auditLog = yield this.auditLogRepository.findOne({ where: { id: auditLogId } });
@@ -163,6 +192,7 @@ let EntityAuditService = class EntityAuditService {
                     warnings: [],
                 };
             }
+            // 获取当前实体状态
             const repository = this.entityManager.getRepository(entityType);
             const currentEntity = yield repository.findOne({ where: { id: entityId } });
             if (!currentEntity) {
@@ -179,6 +209,7 @@ let EntityAuditService = class EntityAuditService {
                     warnings: [],
                 };
             }
+            // 检查冲突
             const conflicts = this.detectConflicts(currentEntity, auditLog.oldValue);
             return {
                 canRestore: conflicts.length === 0,
@@ -187,6 +218,9 @@ let EntityAuditService = class EntityAuditService {
             };
         });
     }
+    /**
+     * 恢复实体
+     */
     restoreEntity(entityType_1, entityId_1, auditLogId_1) {
         return __awaiter(this, arguments, void 0, function* (entityType, entityId, auditLogId, options = {}) {
             const auditLog = yield this.auditLogRepository.findOne({ where: { id: auditLogId } });
@@ -196,6 +230,7 @@ let EntityAuditService = class EntityAuditService {
                     message: '审计日志不存在',
                 };
             }
+            // 预检查
             const preCheckResult = yield this.preCheckRestore(entityType, entityId, auditLogId);
             if (!preCheckResult.canRestore && !options.force) {
                 return {
@@ -205,10 +240,13 @@ let EntityAuditService = class EntityAuditService {
                 };
             }
             try {
+                // 获取指定的数据库连接
                 const connectionName = options.connectionName || 'default';
                 const dataSource = yield this.multiDbService.getDataSource(connectionName);
                 const repository = dataSource.getRepository(entityType);
+                // 恢复实体
                 const restoreData = Object.assign({}, auditLog.oldValue);
+                // 应用字段过滤
                 if (options.includeFields && options.includeFields.length > 0) {
                     Object.keys(restoreData).forEach((key) => {
                         if (!options.includeFields.includes(key)) {
@@ -221,8 +259,10 @@ let EntityAuditService = class EntityAuditService {
                         delete restoreData[field];
                     });
                 }
+                // 执行恢复
                 if (!options.dryRun) {
                     yield repository.update({ id: entityId }, restoreData);
+                    // 记录恢复操作
                     yield this.logEntityChange(entityType, entityId, enums_1.AuditOperation.RESTORE, auditLog.newValue, restoreData);
                 }
                 return {
@@ -239,9 +279,14 @@ let EntityAuditService = class EntityAuditService {
             }
         });
     }
+    /**
+     * 计算变更字段
+     */
     calculateChangedFields(oldValue, newValue) {
         const changedFields = [];
+        // 获取所有字段
         const allFields = new Set([...Object.keys(oldValue || {}), ...Object.keys(newValue || {})]);
+        // 比较每个字段
         for (const field of allFields) {
             const oldVal = oldValue === null || oldValue === void 0 ? void 0 : oldValue[field];
             const newVal = newValue === null || newValue === void 0 ? void 0 : newValue[field];
@@ -251,14 +296,22 @@ let EntityAuditService = class EntityAuditService {
         }
         return changedFields;
     }
+    /**
+     * 计算变更字段路径
+     */
     calculateChangedFieldPaths(oldValue, newValue) {
         const changedPaths = [];
+        // 使用深度比较获取变更路径
         const diff = this.deepDiff(oldValue, newValue);
+        // 提取路径
         for (const change of diff) {
             changedPaths.push(change.path.join('.'));
         }
         return changedPaths;
     }
+    /**
+     * 深度比较对象
+     */
     deepEqual(a, b) {
         if (a === b)
             return true;
@@ -282,13 +335,18 @@ let EntityAuditService = class EntityAuditService {
         }
         return true;
     }
+    /**
+     * 深度差异比较
+     */
     deepDiff(oldObj, newObj, path = []) {
         var _a;
         const changes = [];
         const maxDepth = ((_a = this.config) === null || _a === void 0 ? void 0 : _a.maxDiffDepth) || 5;
+        // 防止过深
         if (path.length > maxDepth) {
             return changes;
         }
+        // 处理基本类型
         if (typeof oldObj !== 'object' || oldObj === null) {
             if (oldObj !== newObj) {
                 changes.push({
@@ -300,6 +358,7 @@ let EntityAuditService = class EntityAuditService {
             }
             return changes;
         }
+        // 处理数组
         if (Array.isArray(oldObj)) {
             if (!Array.isArray(newObj)) {
                 changes.push({
@@ -324,6 +383,7 @@ let EntityAuditService = class EntityAuditService {
             }
             return changes;
         }
+        // 处理对象
         const allKeys = new Set([...Object.keys(oldObj), ...Object.keys(newObj)]);
         for (const key of allKeys) {
             const oldVal = oldObj[key];
@@ -350,6 +410,9 @@ let EntityAuditService = class EntityAuditService {
         }
         return changes;
     }
+    /**
+     * 比较快照数据
+     */
     compareSnapshotData(fromData, toData) {
         const changes = this.deepDiff(fromData, toData);
         return {
@@ -361,6 +424,9 @@ let EntityAuditService = class EntityAuditService {
             },
         };
     }
+    /**
+     * 过滤和脱敏字段
+     */
     filterAndMaskFields(data, fieldFilter, path = []) {
         if (typeof data !== 'object' || data === null) {
             return data;
@@ -368,14 +434,17 @@ let EntityAuditService = class EntityAuditService {
         const result = {};
         for (const [key, value] of Object.entries(data)) {
             const currentPath = [...path, key];
+            // 检查是否应该包含此字段
             if (!fieldFilter.shouldIncludeField(key, currentPath)) {
                 continue;
             }
+            // 检查是否应该脱敏此字段
             if (fieldFilter.shouldMaskField(key, currentPath)) {
                 const maskingStrategy = fieldFilter.getMaskingStrategy(key, currentPath);
                 result[key] = this.applyMasking(value, maskingStrategy);
             }
             else if (typeof value === 'object' && value !== null) {
+                // 递归处理嵌套对象
                 result[key] = this.filterAndMaskFields(value, fieldFilter, currentPath);
             }
             else {
@@ -384,6 +453,9 @@ let EntityAuditService = class EntityAuditService {
         }
         return result;
     }
+    /**
+     * 应用脱敏策略
+     */
     applyMasking(value, strategy) {
         if (value == null)
             return value;
@@ -400,14 +472,23 @@ let EntityAuditService = class EntityAuditService {
                 return '***MASKED***';
         }
     }
+    /**
+     * 哈希值
+     */
     hashValue(value) {
         const strValue = String(value);
         return (0, crypto_1.createHash)('sha256').update(strValue).digest('hex');
     }
+    /**
+     * 掩码值
+     */
     maskValue(value) {
         const strValue = String(value);
         return '*'.repeat(strValue.length);
     }
+    /**
+     * 部分掩码值
+     */
     partialMaskValue(value) {
         const strValue = String(value);
         if (strValue.length <= 4) {
@@ -417,14 +498,19 @@ let EntityAuditService = class EntityAuditService {
             '*'.repeat(strValue.length - 4) +
             strValue.substring(strValue.length - 2));
     }
+    /**
+     * 生成哈希链
+     */
     generateHashChain(entityType, entityId, data) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
+            // 获取上一个审计记录的哈希
             const lastLog = yield this.auditLogRepository.findOne({
                 where: { entityType, entityId },
                 order: { createdAt: 'DESC' },
             });
             const previousHash = ((_a = lastLog === null || lastLog === void 0 ? void 0 : lastLog.hashChain) === null || _a === void 0 ? void 0 : _a.currentHash) || '';
+            // 计算当前数据的哈希
             const currentData = JSON.stringify(data);
             const hashAlgorithm = ((_c = (_b = this.config) === null || _b === void 0 ? void 0 : _b.security) === null || _c === void 0 ? void 0 : _c.hashAlgorithm) || 'sha256';
             const currentHash = (0, crypto_1.createHash)(hashAlgorithm).update(currentData + previousHash).digest('hex');
@@ -435,6 +521,9 @@ let EntityAuditService = class EntityAuditService {
             };
         });
     }
+    /**
+     * 生成描述
+     */
     generateDescription(operation, entityType, entityId, changedFields) {
         const operationText = {
             [enums_1.AuditOperation.CREATE]: '创建',
@@ -448,6 +537,9 @@ let EntityAuditService = class EntityAuditService {
         }
         return `${text} ${entityType}(${entityId})`;
     }
+    /**
+     * 检测冲突
+     */
     detectConflicts(currentEntity, targetValue) {
         const conflicts = [];
         for (const [key, targetVal] of Object.entries(targetValue)) {
@@ -463,20 +555,223 @@ let EntityAuditService = class EntityAuditService {
         }
         return conflicts;
     }
+    // ========== 新增方法：支持模板和手动操作 ==========
+    /**
+     * 增强的记录实体变更（支持模板和结构化变更详情）
+     * @param data 审计数据
+     * @returns 审计日志实体
+     */
+    logEntityChangeWithTemplate(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g;
+            // 检查是否应该记录
+            if (!this.auditStrategy.shouldRecord(data.entityType, data.operation)) {
+                return null;
+            }
+            // 获取记录策略
+            const recordStrategy = this.auditStrategy.getRecordStrategy(data.entityType, data.operation);
+            if (recordStrategy === enums_1.RecordStrategy.DISABLED) {
+                return null;
+            }
+            // 获取字段过滤器
+            const fieldFilter = this.auditStrategy.getFieldFilter(data.entityType);
+            // 过滤和脱敏字段
+            const filteredOldValue = this.filterAndMaskFields(data.oldValue || {}, fieldFilter);
+            const filteredNewValue = this.filterAndMaskFields(data.newValue || {}, fieldFilter);
+            // 计算变更字段
+            const changedFields = data.changedFields || this.calculateChangedFields(filteredOldValue, filteredNewValue);
+            const changedFieldPaths = this.calculateChangedFieldPaths(filteredOldValue, filteredNewValue);
+            // 获取上下文信息
+            const context = yield this.contextService.getCurrentContext();
+            // 如果没有提供操作模板键，使用默认模板
+            const operationTemplateKey = data.operationTemplateKey || `${data.entityType}.${data.operation}`;
+            // 如果没有提供描述参数，使用实体数据
+            const descriptionParams = data.descriptionParams || Object.assign(Object.assign(Object.assign({}, filteredOldValue), filteredNewValue), { changedFields, changedFieldsCount: changedFields.length });
+            // 创建审计日志
+            const auditLog = this.auditLogRepository.create({
+                entityType: data.entityType,
+                entityId: data.entityId,
+                operation: data.operation,
+                oldValue: filteredOldValue,
+                newValue: filteredNewValue,
+                changedFields,
+                changedFieldPaths: changedFieldPaths.join(','),
+                userId: context.userId || ((_a = data.metadata) === null || _a === void 0 ? void 0 : _a.userId),
+                username: context.username || ((_b = data.metadata) === null || _b === void 0 ? void 0 : _b.username),
+                requestId: context.requestId || ((_c = data.metadata) === null || _c === void 0 ? void 0 : _c.requestId),
+                requestIp: context.requestIp || ((_d = data.metadata) === null || _d === void 0 ? void 0 : _d.requestIp),
+                userAgent: context.userAgent || ((_e = data.metadata) === null || _e === void 0 ? void 0 : _e.userAgent),
+                description: this.generateDescription(data.operation, data.entityType, data.entityId, changedFields),
+                hashChain: ((_g = (_f = this.config) === null || _f === void 0 ? void 0 : _f.security) === null || _g === void 0 ? void 0 : _g.hashChainEnabled)
+                    ? yield this.generateHashChain(data.entityType, data.entityId, filteredNewValue)
+                    : undefined,
+                // 新增字段
+                operationTemplateKey,
+                descriptionParams,
+                changeDetails: data.changeDetails,
+                rollbackActions: data.rollbackActions,
+            });
+            // 保存变更日志
+            const savedLog = yield this.auditLogRepository.save(auditLog);
+            return savedLog;
+        });
+    }
+    /**
+     * 记录手动操作
+     * @param data 手动操作数据
+     * @returns 手动操作日志实体
+     */
+    logManualOperation(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 获取上下文信息
+            const context = yield this.contextService.getCurrentContext();
+            const manualLog = this.manualOperationRepository.create({
+                transactionId: data.transactionId,
+                operationTemplateKey: data.operationTemplateKey,
+                descriptionParams: data.descriptionParams,
+                userId: data.userId || context.userId,
+                username: data.username || context.username,
+                requestIp: data.requestIp || context.requestIp,
+                rollbackActions: data.rollbackActions || [],
+            });
+            return yield this.manualOperationRepository.save(manualLog);
+        });
+    }
+    /**
+     * 在事务中执行操作
+     * @param fn 执行函数
+     * @param options 事务选项
+     * @returns 执���结果
+     */
+    withTransaction(fn, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            // 获取上下文信息
+            const context = yield this.contextService.getCurrentContext();
+            // 创建事务
+            const transaction = this.transactionRepository.create({
+                description: ((_a = options === null || options === void 0 ? void 0 : options.descriptionParams) === null || _a === void 0 ? void 0 : _a.description) || 'Transaction',
+                status: 'PENDING',
+                entities: [],
+                userId: (options === null || options === void 0 ? void 0 : options.userId) || context.userId,
+                username: (options === null || options === void 0 ? void 0 : options.username) || context.username,
+                requestIp: (options === null || options === void 0 ? void 0 : options.requestIp) || context.requestIp,
+                operationTemplateKey: options === null || options === void 0 ? void 0 : options.operationTemplateKey,
+                descriptionParams: options === null || options === void 0 ? void 0 : options.descriptionParams,
+                metadata: options === null || options === void 0 ? void 0 : options.metadata,
+            });
+            const savedTransaction = yield this.transactionRepository.save(transaction);
+            const transactionId = savedTransaction.id;
+            try {
+                // 设置事务ID到上下文
+                yield this.contextService.setContext(Object.assign(Object.assign({}, context), { transactionId }));
+                // 执行操作
+                const result = yield fn(transactionId);
+                // 提交事务
+                yield this.transactionRepository.update(transactionId, {
+                    status: 'COMMITTED',
+                    completedAt: new Date(),
+                });
+                return result;
+            }
+            catch (error) {
+                // 回滚事务
+                yield this.transactionRepository.update(transactionId, {
+                    status: 'ROLLED_BACK',
+                    completedAt: new Date(),
+                });
+                throw error;
+            }
+        });
+    }
+    /**
+     * 获取当前事务ID
+     * @returns 当前事务ID或null
+     */
+    getCurrentTransactionId() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const context = yield this.contextService.getCurrentContext();
+            return context.transactionId || null;
+        });
+    }
+    /**
+     * 设置当前事务ID
+     * @param transactionId 事务ID
+     */
+    setCurrentTransactionId(transactionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const context = yield this.contextService.getCurrentContext();
+            yield this.contextService.setContext(Object.assign(Object.assign({}, context), { transactionId }));
+        });
+    }
+    /**
+     * 开始事务
+     * @param userId 用户ID
+     * @param userName 用户名
+     * @param ip IP地址
+     * @param operationTemplateKey 操作模板键
+     * @param descriptionParams 描述参数
+     * @returns 事务ID
+     */
+    beginTransaction(userId, userName, ip, operationTemplateKey, descriptionParams) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 获取上下文信息
+            const context = yield this.contextService.getCurrentContext();
+            // 创建事务
+            const transaction = this.transactionRepository.create({
+                description: (descriptionParams === null || descriptionParams === void 0 ? void 0 : descriptionParams.description) || 'Transaction',
+                status: 'pending',
+                entities: [],
+                userId: userId || context.userId,
+                username: userName || context.username,
+                requestIp: ip || context.requestIp,
+                operationTemplateKey,
+                descriptionParams,
+            });
+            const savedTransaction = yield this.transactionRepository.save(transaction);
+            return savedTransaction.id;
+        });
+    }
+    /**
+     * 提交事务
+     * @param transactionId 事务ID
+     */
+    commitTransaction(transactionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.transactionRepository.update(transactionId, {
+                status: 'committed',
+                completedAt: new Date(),
+            });
+        });
+    }
+    /**
+     * 回滚事务
+     * @param transactionId 事务ID
+     */
+    rollbackTransaction(transactionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.transactionRepository.update(transactionId, {
+                status: 'rolled_back',
+                completedAt: new Date(),
+            });
+        });
+    }
 };
 exports.EntityAuditService = EntityAuditService;
 exports.EntityAuditService = EntityAuditService = __decorate([
     (0, common_1.Injectable)(),
     __param(0, (0, typeorm_1.InjectRepository)(entities_1.EntityAuditLogEntity)),
     __param(1, (0, typeorm_1.InjectRepository)(entities_1.EntityTransactionEntity)),
-    __param(2, (0, common_1.Inject)('AUDIT_ENTITY_MANAGER')),
-    __param(5, (0, common_1.Optional)()),
-    __param(5, (0, common_1.Inject)('AUDIT_STRATEGY')),
+    __param(2, (0, typeorm_1.InjectRepository)(entities_1.ManualOperationLogEntity)),
+    __param(3, (0, common_1.Inject)('AUDIT_ENTITY_MANAGER')),
     __param(6, (0, common_1.Optional)()),
-    __param(6, (0, common_1.Inject)('AUDIT_CONFIG')),
+    __param(6, (0, common_1.Inject)('AUDIT_STRATEGY')),
     __param(7, (0, common_1.Optional)()),
-    __param(7, (0, common_1.Inject)('AUDIT_CONNECTION_NAME')),
+    __param(7, (0, common_1.Inject)('AUDIT_CONFIG')),
+    __param(8, (0, common_1.Optional)()),
+    __param(8, (0, common_1.Inject)('AUDIT_CONNECTION_NAME')),
     __metadata("design:paramtypes", [typeorm_2.Repository,
+        typeorm_2.Repository,
         typeorm_2.Repository,
         typeorm_2.EntityManager,
         audit_context_service_1.AuditContextService,

package/audit/services/index.d.ts

@@ -3,3 +3,5 @@ export * from './audit-strategy.service';
 export * from './entity-audit.service';
 export * from './transaction-audit.service';
 export * from './multi-database.service';
+export * from './operation-description.service';
+export * from './manual-audit-log.service';

package/audit/services/index.js

@@ -19,3 +19,5 @@ __exportStar(require("./audit-strategy.service"), exports);
 __exportStar(require("./entity-audit.service"), exports);
 __exportStar(require("./transaction-audit.service"), exports);
 __exportStar(require("./multi-database.service"), exports);
+__exportStar(require("./operation-description.service"), exports);
+__exportStar(require("./manual-audit-log.service"), exports);