@nest-omni/core 4.1.3-2 → 4.1.3-20

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

@@ -0,0 +1,244 @@
+"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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditActionService = void 0;
+const common_1 = require("@nestjs/common");
+const audit_context_service_1 = require("./audit-context.service");
+const entity_audit_service_1 = require("./entity-audit.service");
+const enums_1 = require("../enums");
+/**
+ * 审计动作服务
+ * 提供声明式的审计动作管理，自动关联同一业务操作的所有实体变化
+ */
+let AuditActionService = class AuditActionService {
+    constructor(contextService, auditService) {
+        this.contextService = contextService;
+        this.auditService = auditService;
+    }
+    /**
+     * 在审计动作上下文中执行操作
+     * 自动关联该动作内的所有实体变化
+     *
+     * @example
+     * ```typescript
+     * const result = await auditActionService.executeAction(
+     *   {
+     *     actionName: 'createOrder',
+     *     operationTemplateKey: 'order.create',
+     *     descriptionParams: {
+     *       productCount: orderItems.length,
+     *       receiver: order.receiverName,
+     *       totalAmount: order.totalAmount,
+     *       address: order.shippingAddress,
+     *     },
+     *   },
+     *   async () => {
+     *     // 1. 创建订单
+     *     const order = await this.orderRepository.save(newOrder);
+     *
+     *     // 2. 创建订单项
+     *     await this.orderItemRepository.save(orderItems);
+     *
+     *     // 3. 扣减库存
+     *     await this.inventoryService.deduct(orderItems);
+     *
+     *     // 4. 创建物流信息
+     *     await this.shippingService.create(order.id);
+     *
+     *     return order;
+     *   }
+     * );
+     *
+     * // 结果中包含所有实体变化：
+     * // result.entityChanges = [
+     * //   { entityType: 'Order', entityId: '1', operation: 'CREATE', sequence: 1 },
+     * //   { entityType: 'OrderItem', entityId: '1', operation: 'CREATE', sequence: 2 },
+     * //   { entityType: 'OrderItem', entityId: '2', operation: 'CREATE', sequence: 3 },
+     * //   { entityType: 'Inventory', entityId: '1', operation: 'UPDATE', sequence: 4 },
+     * //   { entityType: 'Shipping', entityId: '1', operation: 'CREATE', sequence: 5 },
+     * // ]
+     * ```
+     */
+    executeAction(options, operation) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const actionId = this.contextService.generateActionId();
+            const startTime = new Date();
+            // 创建审计动作上下文
+            const actionContext = {
+                actionId,
+                actionName: options.actionName,
+                operationTemplateKey: options.operationTemplateKey,
+                descriptionParams: options.descriptionParams,
+                startTime,
+                entityChanges: [],
+                detailedChanges: [],
+            };
+            // 设置到 CLS
+            this.contextService.setActionContext(actionContext);
+            let success = false;
+            let error;
+            let result;
+            try {
+                // 执行业务操作
+                result = yield operation();
+                success = true;
+                // 记录审计动作汇总日志（可选）
+                yield this.recordActionSummary(actionContext, options);
+                return {
+                    actionId,
+                    actionName: options.actionName,
+                    entityChanges: actionContext.entityChanges,
+                    duration: Date.now() - startTime.getTime(),
+                    success: true,
+                };
+            }
+            catch (err) {
+                error = err;
+                success = false;
+                // 记录失败的审计动作
+                yield this.recordActionSummary(actionContext, options, error);
+                throw err;
+            }
+            finally {
+                // 清除审计动作上下文
+                this.contextService.clearActionContext();
+            }
+        });
+    }
+    /**
+     * 记录审计动作汇总日志
+     */
+    recordActionSummary(actionContext, options, error) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const context = yield this.contextService.getCurrentContext();
+                // 使用 logEntityChangeWithTemplate 记录汇总信息
+                yield this.auditService.logEntityChangeWithTemplate({
+                    entityType: 'AuditAction',
+                    entityId: actionContext.actionId,
+                    operation: error ? enums_1.AuditOperation.DELETE : enums_1.AuditOperation.CREATE, // 失败用 DELETE 表示回滚
+                    oldValue: {},
+                    newValue: {
+                        actionName: actionContext.actionName,
+                        entityChangesCount: actionContext.entityChanges.length,
+                        duration: Date.now() - actionContext.startTime.getTime(),
+                        success: !error,
+                        error: error === null || error === void 0 ? void 0 : error.message,
+                    },
+                    operationTemplateKey: options.operationTemplateKey,
+                    descriptionParams: options.descriptionParams,
+                    metadata: Object.assign(Object.assign({}, options.metadata), { auditActionId: actionContext.actionId, entityChanges: actionContext.entityChanges }),
+                });
+            }
+            catch (err) {
+                console.error('Failed to record audit action summary:', err);
+            }
+        });
+    }
+    /**
+     * 获取审计动作的所有实体变化
+     */
+    getActionAuditLogs(actionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const logs = yield this.auditService['auditLogRepository'].find({
+                where: { auditActionId: actionId },
+                order: { sequenceInAction: 'ASC', createdAt: 'ASC' },
+            });
+            return {
+                actionId,
+                logs,
+                summary: {
+                    totalChanges: logs.length,
+                    operations: this.groupByOperation(logs),
+                    entities: this.groupByEntity(logs),
+                },
+            };
+        });
+    }
+    /**
+     * 获取请求内的所有审计动作
+     */
+    getRequestActions(requestId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const logs = yield this.auditService['auditLogRepository'].find({
+                where: { requestId },
+                order: { createdAt: 'ASC' },
+            });
+            // 按 auditActionId 分组
+            const actionMap = new Map();
+            const noActionLogs = [];
+            logs.forEach(log => {
+                if (log.auditActionId) {
+                    if (!actionMap.has(log.auditActionId)) {
+                        actionMap.set(log.auditActionId, []);
+                    }
+                    actionMap.get(log.auditActionId).push(log);
+                }
+                else {
+                    noActionLogs.push(log);
+                }
+            });
+            const actions = Array.from(actionMap.entries()).map(([actionId, logs]) => {
+                var _a;
+                return ({
+                    actionId,
+                    actionName: ((_a = logs[0]) === null || _a === void 0 ? void 0 : _a.auditActionName) || 'Unknown',
+                    entityChanges: logs.map(log => ({
+                        entityType: log.entityType,
+                        entityId: log.entityId,
+                        operation: log.operation,
+                        sequence: log.sequenceInAction,
+                        timestamp: log.createdAt,
+                    })),
+                    logs,
+                });
+            });
+            return {
+                requestId,
+                actions,
+                noActionLogs, // 未关联到任何动作的日志
+                summary: {
+                    totalActions: actions.length,
+                    totalChanges: logs.length,
+                },
+            };
+        });
+    }
+    groupByOperation(logs) {
+        const result = new Map();
+        logs.forEach(log => {
+            result.set(log.operation, (result.get(log.operation) || 0) + 1);
+        });
+        return Object.fromEntries(result);
+    }
+    groupByEntity(logs) {
+        const result = new Map();
+        logs.forEach(log => {
+            result.set(log.entityType, (result.get(log.entityType) || 0) + 1);
+        });
+        return Object.fromEntries(result);
+    }
+};
+exports.AuditActionService = AuditActionService;
+exports.AuditActionService = AuditActionService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [audit_context_service_1.AuditContextService,
+        entity_audit_service_1.EntityAuditService])
+], AuditActionService);

package/audit/services/audit-context.service.d.ts

@@ -1,10 +1,107 @@
 import { ClsService } from 'nestjs-cls';
 import { AuditContext } from '../interfaces';
+import { AuditOperation } from '../enums';
+/**
+ * 实体变更详情
+ */
+export interface EntityChangeDetail {
+    entityType: string;
+    entityId: string;
+    operation: AuditOperation;
+    oldValue: Record<string, any>;
+    newValue: Record<string, any>;
+    changedFields: string[];
+    sequence: number;
+    metadata?: Record<string, any>;
+}
+/**
+ * 审计参数上下文
+ */
+export interface AuditParamsContext {
+    req: any;
+    result?: any;
+    error?: Error;
+    entityChanges: EntityChangeDetail[];
+    findEntity(entityType: string, operation?: AuditOperation): EntityChangeDetail | null;
+    findEntities(entityType: string, operation?: AuditOperation): EntityChangeDetail[];
+    countEntities(entityType: string, operation?: AuditOperation): number;
+    extractParams(mapping: Record<string, any>): Record<string, any>;
+    extractByPath(path: string): any;
+    extractByConfig(config: any): any;
+}
+/**
+ * 审计动作上下文
+ */
+export interface AuditActionContext {
+    actionId: string;
+    actionName: string;
+    operationTemplateKey?: string;
+    descriptionParams?: Record<string, any>;
+    paramsBuilder?: (context: AuditParamsContext) => Record<string, any>;
+    startTime: Date;
+    entityChanges: Array<{
+        entityType: string;
+        entityId: string;
+        operation: string;
+        sequence: number;
+    }>;
+    detailedChanges: EntityChangeDetail[];
+    req?: any;
+    result?: any;
+    error?: Error;
+}
+/**
+ * 审计上下文服务
+ */
 export declare class AuditContextService {
     private readonly cls;
     constructor(cls: ClsService);
+    /**
+     * 获取当前上下文
+     */
     getCurrentContext(): Promise<AuditContext>;
+    /**
+     * 设置上下文
+     */
     setContext(context: Partial<AuditContext>): void;
+    /**
+     * 清除上下文
+     */
     clearContext(): void;
+    /**
+     * 获取默认上下文
+     */
     private getDefaultContext;
+    /**
+     * 获取当前审计动作上下文
+     */
+    getCurrentActionContext(): AuditActionContext | null;
+    /**
+     * 设置审计动作上下文
+     */
+    setActionContext(context: AuditActionContext): void;
+    /**
+     * 清除审计动作上下文
+     */
+    clearActionContext(): void;
+    /**
+     * 记录实体变化到当前动作（简单版本）
+     */
+    recordEntityChangeInAction(entityType: string, entityId: string, operation: string): void;
+    /**
+     * 记录详细的实体变化
+     */
+    recordDetailedEntityChange(entityType: string, entityId: string, operation: AuditOperation, oldValue: Record<string, any>, newValue: Record<string, any>, changedFields: string[], metadata?: Record<string, any>): void;
+    /**
+     * 获取当前动作内的序号
+     */
+    getSequenceInAction(): number;
+    /**
+     * 生成审计动作ID
+     */
+    generateActionId(): string;
+    /**
+     * 构建审计参数上下文
+     */
+    buildParamsContext(): AuditParamsContext | null;
 }

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

@@ -21,22 +21,38 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuditContextService = void 0;
 const common_1 = require("@nestjs/common");
 const nestjs_cls_1 = require("nestjs-cls");
+const crypto_1 = require("crypto");
+/**
+ * 审计上下文服务
+ */
 let AuditContextService = class AuditContextService {
     constructor(cls) {
         this.cls = cls;
     }
+    /**
+     * 获取当前上下文
+     */
     getCurrentContext() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.cls.get('auditContext') || this.getDefaultContext();
         });
     }
+    /**
+     * 设置上下文
+     */
     setContext(context) {
         const currentContext = this.cls.get('auditContext') || this.getDefaultContext();
         this.cls.set('auditContext', Object.assign(Object.assign({}, currentContext), context));
     }
+    /**
+     * 清除上下文
+     */
     clearContext() {
         this.cls.set('auditContext', undefined);
     }
+    /**
+     * 获取默认上下文
+     */
     getDefaultContext() {
         return {
             userId: 'system',
@@ -47,6 +63,175 @@ let AuditContextService = class AuditContextService {
             timestamp: new Date(),
         };
     }
+    // ========== 审计动作上下文管理 ==========
+    /**
+     * 获取当前审计动作上下文
+     */
+    getCurrentActionContext() {
+        return this.cls.get('auditActionContext') || null;
+    }
+    /**
+     * 设置审计动作上下文
+     */
+    setActionContext(context) {
+        this.cls.set('auditActionContext', context);
+    }
+    /**
+     * 清除审计动作上下文
+     */
+    clearActionContext() {
+        this.cls.set('auditActionContext', null);
+    }
+    /**
+     * 记录实体变化到当前动作（简单版本）
+     */
+    recordEntityChangeInAction(entityType, entityId, operation) {
+        const actionContext = this.getCurrentActionContext();
+        if (actionContext) {
+            actionContext.entityChanges.push({
+                entityType,
+                entityId,
+                operation,
+                sequence: actionContext.entityChanges.length + 1,
+            });
+        }
+    }
+    /**
+     * 记录详细的实体变化
+     */
+    recordDetailedEntityChange(entityType, entityId, operation, oldValue, newValue, changedFields, metadata) {
+        const actionContext = this.getCurrentActionContext();
+        if (actionContext) {
+            const detail = {
+                entityType,
+                entityId,
+                operation,
+                oldValue,
+                newValue,
+                changedFields,
+                sequence: actionContext.detailedChanges.length + 1,
+                metadata,
+            };
+            actionContext.detailedChanges.push(detail);
+        }
+    }
+    /**
+     * 获取当前动作内的序号
+     */
+    getSequenceInAction() {
+        const actionContext = this.getCurrentActionContext();
+        return actionContext ? actionContext.entityChanges.length + 1 : 0;
+    }
+    /**
+     * 生成审计动作ID
+     */
+    generateActionId() {
+        return (0, crypto_1.randomBytes)(16).toString('hex');
+    }
+    /**
+     * 构建审计参数上下文
+     */
+    buildParamsContext() {
+        const actionContext = this.getCurrentActionContext();
+        if (!actionContext) {
+            return null;
+        }
+        const context = {
+            req: actionContext.req,
+            result: actionContext.result,
+            error: actionContext.error,
+            entityChanges: actionContext.detailedChanges,
+            // 查找单个实体
+            findEntity(entityType, operation) {
+                return context.entityChanges.find((change) => change.entityType === entityType &&
+                    (operation === undefined || change.operation === operation)) || null;
+            },
+            // 查找多个实体
+            findEntities(entityType, operation) {
+                return context.entityChanges.filter((change) => change.entityType === entityType &&
+                    (operation === undefined || change.operation === operation));
+            },
+            // 统计实体数量
+            countEntities(entityType, operation) {
+                return context.findEntities(entityType, operation).length;
+            },
+            // 路径提取
+            extractParams(mapping) {
+                const result = {};
+                for (const [key, value] of Object.entries(mapping)) {
+                    if (typeof value === 'string') {
+                        // 简单路径: 'Order.CREATE.orderSn'
+                        result[key] = this.extractByPath(value);
+                    }
+                    else if (typeof value === 'object' && value.type) {
+                        // 复杂提取: { type: 'join', path: 'OrderItem.CREATE', field: 'name' }
+                        result[key] = this.extractByConfig(value);
+                    }
+                }
+                return result;
+            },
+            extractByPath(path) {
+                const parts = path.split('.');
+                if (parts.length < 2)
+                    return undefined;
+                const [entityType, operationStr, ...fieldParts] = parts;
+                const operation = operationStr;
+                const entity = context.findEntity(entityType, operation);
+                if (!entity)
+                    return undefined;
+                // 支持嵌套字段访问
+                let value = entity.newValue;
+                for (const field of fieldParts) {
+                    if (value && typeof value === 'object') {
+                        value = value[field];
+                    }
+                    else {
+                        return undefined;
+                    }
+                }
+                return value;
+            },
+            extractByConfig(config) {
+                const { type, path, field, separator = ', ' } = config;
+                const parts = path.split('.');
+                const [entityType, operationStr] = parts;
+                const operation = operationStr;
+                const entities = context.findEntities(entityType, operation);
+                switch (type) {
+                    case 'count':
+                        return entities.length;
+                    case 'join': {
+                        const values = entities.map((e) => {
+                            const fieldParts = field.split('.');
+                            let value = e.newValue;
+                            for (const part of fieldParts) {
+                                if (part === 'metadata') {
+                                    value = e.metadata;
+                                }
+                                else if (value && typeof value === 'object') {
+                                    value = value[part];
+                                }
+                                else {
+                                    return undefined;
+                                }
+                            }
+                            return value;
+                        }).filter(Boolean);
+                        return values.join(separator);
+                    }
+                    case 'sum': {
+                        return entities.reduce((sum, e) => {
+                            const value = e.newValue[field];
+                            return sum + (typeof value === 'number' ? value : 0);
+                        }, 0);
+                    }
+                    default:
+                        return undefined;
+                }
+            },
+        };
+        return context;
+    }
 };
 exports.AuditContextService = AuditContextService;
 exports.AuditContextService = AuditContextService = __decorate([

package/audit/services/audit-strategy.service.d.ts

@@ -1,5 +1,8 @@
 import { IAuditStrategy, IFieldFilter, AuditConfig } from '../interfaces';
 import { AuditOperation, RecordStrategy, MaskingStrategy } from '../enums';
+/**
+ * 默认字段过滤器
+ */
 export declare class DefaultFieldFilter implements IFieldFilter {
     private readonly includeFields?;
     private readonly excludeFields?;
@@ -10,6 +13,9 @@ export declare class DefaultFieldFilter implements IFieldFilter {
     getMaskingStrategy(fieldName: string, path: string[]): MaskingStrategy;
     private matchPattern;
 }
+/**
+ * 默认审计策略
+ */
 export declare class DefaultAuditStrategy implements IAuditStrategy {
     private readonly config?;
     constructor(config?: AuditConfig);

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

@@ -15,6 +15,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultAuditStrategy = exports.DefaultFieldFilter = void 0;
 const common_1 = require("@nestjs/common");
 const enums_1 = require("../enums");
+/**
+ * 默认字段过滤器
+ */
 class DefaultFieldFilter {
     constructor(includeFields, excludeFields, maskFields) {
         this.includeFields = includeFields;
@@ -23,9 +26,11 @@ class DefaultFieldFilter {
     }
     shouldIncludeField(fieldName, path) {
         const fullPath = [...path, fieldName].join('.');
+        // 如果指定了包含字段，则只记录这些字段
         if (this.includeFields && this.includeFields.length > 0) {
             return this.includeFields.some((pattern) => this.matchPattern(fullPath, pattern));
         }
+        // 如果指定了排除字段，则排除这些字段
         if (this.excludeFields && this.excludeFields.length > 0) {
             return !this.excludeFields.some((pattern) => this.matchPattern(fullPath, pattern));
         }
@@ -40,6 +45,7 @@ class DefaultFieldFilter {
         return enums_1.MaskingStrategy.MASK;
     }
     matchPattern(path, pattern) {
+        // 支持通配符匹配，如 user.address.*
         if (pattern.endsWith('*')) {
             return path.startsWith(pattern.slice(0, -1));
         }
@@ -47,18 +53,24 @@ class DefaultFieldFilter {
     }
 }
 exports.DefaultFieldFilter = DefaultFieldFilter;
+/**
+ * 默认审计策略
+ */
 let DefaultAuditStrategy = class DefaultAuditStrategy {
     constructor(config) {
         this.config = config;
     }
     shouldRecord(entityType, operation) {
         var _a, _b, _c, _d, _e;
+        // 检查全局配置
         const globalEnabled = ((_a = this.config) === null || _a === void 0 ? void 0 : _a.enabled) !== false;
         if (!globalEnabled)
             return false;
+        // 检查实体级别配置
         const entityConfig = (_c = (_b = this.config) === null || _b === void 0 ? void 0 : _b.entities) === null || _c === void 0 ? void 0 : _c[entityType];
         if (entityConfig && entityConfig.enabled === false)
             return false;
+        // 检查操作级别配置
         const operationConfig = (_e = (_d = this.config) === null || _d === void 0 ? void 0 : _d.operations) === null || _e === void 0 ? void 0 : _e[operation];
         if (operationConfig && operationConfig.enabled === false)
             return false;
@@ -66,6 +78,7 @@ let DefaultAuditStrategy = class DefaultAuditStrategy {
     }
     getRecordStrategy(entityType, operation) {
         var _a, _b, _c, _d, _e, _f, _g;
+        // 优先级: 实体级别 > 操作级别 > 全局默认
         const entityStrategy = (_c = (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.entities) === null || _b === void 0 ? void 0 : _b[entityType]) === null || _c === void 0 ? void 0 : _c.strategy;
         if (entityStrategy)
             return entityStrategy;