@nest-omni/core 4.1.3-3 → 4.1.3-31

package/audit/audit.module.d.ts

@@ -4,6 +4,7 @@ import { AuditConfig } from './interfaces';
  * 审计模块
  */
 export declare class AuditModule {
+    private static readonly logger;
     /**
      * 注册审计模块
      * @param config 审计配置

package/audit/audit.module.js

@@ -37,6 +37,10 @@ let AuditModule = AuditModule_1 = class AuditModule {
         var _a, _b;
         const auditConnectionName = ((_a = config === null || config === void 0 ? void 0 : config.connections) === null || _a === void 0 ? void 0 : _a.audit) || 'default';
         const monitoredConnections = ((_b = config === null || config === void 0 ? void 0 : config.connections) === null || _b === void 0 ? void 0 : _b.monitored) || ['default'];
+        if (process.env.NODE_ENV !== 'prod') {
+            this.logger.log(`Initializing AuditModule with connection: ${auditConnectionName}`);
+            this.logger.log(`Monitoring connections: ${monitoredConnections.join(', ')}`);
+        }
         // 创建多个订阅者提供者，每个监听的数据库连接一个
         const subscriberProviders = monitoredConnections.map((connectionName) => ({
             provide: `AUDIT_SUBSCRIBER_${connectionName}`,
@@ -67,6 +71,27 @@ let AuditModule = AuditModule_1 = class AuditModule {
                 },
                 inject: [(0, typeorm_1.getDataSourceToken)(auditConnectionName)],
             },
+            {
+                provide: (0, typeorm_1.getRepositoryToken)(entities_1.OperationTemplateEntity),
+                useFactory: (dataSource) => {
+                    return dataSource.getRepository(entities_1.OperationTemplateEntity);
+                },
+                inject: [(0, typeorm_1.getDataSourceToken)(auditConnectionName)],
+            },
+            {
+                provide: (0, typeorm_1.getRepositoryToken)(entities_1.ManualOperationLogEntity),
+                useFactory: (dataSource) => {
+                    return dataSource.getRepository(entities_1.ManualOperationLogEntity);
+                },
+                inject: [(0, typeorm_1.getDataSourceToken)(auditConnectionName)],
+            },
+            {
+                provide: (0, typeorm_1.getRepositoryToken)(entities_1.AuditActionSummaryEntity),
+                useFactory: (dataSource) => {
+                    return dataSource.getRepository(entities_1.AuditActionSummaryEntity);
+                },
+                inject: [(0, typeorm_1.getDataSourceToken)(auditConnectionName)],
+            },
             {
                 provide: 'AUDIT_ENTITY_MANAGER',
                 useFactory: (dataSource) => {
@@ -78,8 +103,14 @@ let AuditModule = AuditModule_1 = class AuditModule {
         return {
             module: AuditModule_1,
             imports: [
-                // 审计日志存储到指定的数据库连接
-                typeorm_1.TypeOrmModule.forFeature([entities_1.EntityAuditLogEntity, entities_1.EntityTransactionEntity], auditConnectionName),
+                // ��计日志存储到指定的数据库连接
+                typeorm_1.TypeOrmModule.forFeature([
+                    entities_1.EntityAuditLogEntity,
+                    entities_1.EntityTransactionEntity,
+                    entities_1.OperationTemplateEntity,
+                    entities_1.ManualOperationLogEntity,
+                    entities_1.AuditActionSummaryEntity,
+                ], auditConnectionName),
                 nestjs_cls_1.ClsModule.forRoot({
                     global: true,
                     middleware: { mount: true },
@@ -105,7 +136,11 @@ let AuditModule = AuditModule_1 = class AuditModule {
                 ...repositoryProviders,
                 services_1.EntityAuditService,
                 services_1.TransactionAuditService,
+                services_1.OperationDescriptionService,
+                services_1.AuditActionService,
+                services_1.ManualAuditLogService,
                 interceptors_1.AuditInterceptor,
+                interceptors_1.AuditActionInterceptor,
                 ...subscriberProviders,
             ],
             exports: [
@@ -114,7 +149,12 @@ let AuditModule = AuditModule_1 = class AuditModule {
                 services_1.MultiDatabaseService,
                 services_1.EntityAuditService,
                 services_1.TransactionAuditService,
+                services_1.OperationDescriptionService,
+                services_1.AuditActionService,
+                services_1.ManualAuditLogService,
                 interceptors_1.AuditInterceptor,
+                interceptors_1.AuditActionInterceptor,
+                (0, typeorm_1.getRepositoryToken)(entities_1.AuditActionSummaryEntity),
             ],
         };
     }
@@ -226,7 +266,11 @@ let AuditModule = AuditModule_1 = class AuditModule {
                 ...repositoryProviders,
                 services_1.EntityAuditService,
                 services_1.TransactionAuditService,
+                services_1.OperationDescriptionService,
+                services_1.AuditActionService,
+                services_1.ManualAuditLogService,
                 interceptors_1.AuditInterceptor,
+                interceptors_1.AuditActionInterceptor,
             ],
             exports: [
                 services_1.AuditContextService,
@@ -234,12 +278,17 @@ let AuditModule = AuditModule_1 = class AuditModule {
                 services_1.MultiDatabaseService,
                 services_1.EntityAuditService,
                 services_1.TransactionAuditService,
+                services_1.OperationDescriptionService,
+                services_1.AuditActionService,
+                services_1.ManualAuditLogService,
                 interceptors_1.AuditInterceptor,
+                interceptors_1.AuditActionInterceptor,
             ],
         };
     }
 };
 exports.AuditModule = AuditModule;
+AuditModule.logger = new common_1.Logger(AuditModule_1.name);
 exports.AuditModule = AuditModule = AuditModule_1 = __decorate([
     (0, common_1.Global)(),
     (0, common_1.Module)({})

package/audit/controllers/audit.controller.d.ts

@@ -1,6 +1,6 @@
 import { EntityAuditService } from '../services/entity-audit.service';
 import { TransactionAuditService } from '../services/transaction-audit.service';
-import { AuditLogQueryDto, CompareEntitiesDto, RestoreEntityDto, PreCheckRestoreDto, BeginTransactionDto } from '../dto';
+import { AuditLogQueryDto, AuditActionQueryDto, CompareEntitiesDto, RestoreEntityDto, PreCheckRestoreDto, BeginTransactionDto } from '../dto';
 import { EntityAuditLogEntity } from '../entities';
 import { EntityDifference, PreCheckResult, RestoreResult } from '../interfaces';
 import { PageDto } from '../../common/dto';
@@ -41,4 +41,60 @@ export declare class AuditController {
      * 回滚审计事务
      */
     rollbackTransaction(transactionId: string): Promise<void>;
+    /**
+     * 查询审计动作汇总记录
+     */
+    getAuditActions(query: AuditActionQueryDto): Promise<PageDto<import("../entities").AuditActionSummaryEntity>>;
+    /**
+     * 查询单个审计动作的详细信息
+     */
+    getAuditActionDetail(actionId: string): Promise<{
+        summary: {
+            id: string;
+            actionName: string;
+            operationTemplateKey: string;
+            description: string;
+            descriptionParams: Record<string, any>;
+            success: boolean;
+            errorMessage: string;
+            duration: number;
+            userId: string;
+            username: string;
+            requestId: string;
+            requestIp: string;
+            userAgent: string;
+            entityChangesCount: number;
+            entityTypes: string[];
+            operationStats: Record<string, number>;
+            createdAt: Date;
+            metadata: Record<string, any>;
+        };
+        entityChanges: EntityAuditLogEntity[];
+        detailedChanges: {
+            id: string;
+            entityType: string;
+            entityId: string;
+            operation: import("..").AuditOperation;
+            operationLabel: string;
+            description: string;
+            sequenceInAction: number;
+            createdAt: Date;
+            oldValue: Record<string, any>;
+            newValue: Record<string, any>;
+            changeDetails: import("../interfaces").ChangeDetail[];
+            changedFieldsCount: number;
+            changedFields: string[];
+        }[];
+        statistics: {
+            totalChanges: number;
+            totalFieldChanges: number;
+            byEntityType: Record<string, number>;
+            byOperation: Record<string, number>;
+            operationSequence: {
+                sequence: number;
+                entityType: string;
+                operation: import("..").AuditOperation;
+            }[];
+        };
+    }>;
 }

package/audit/controllers/audit.controller.js

@@ -93,6 +93,31 @@ let AuditController = class AuditController {
             return this.transactionAuditService.rollbackTransaction(transactionId);
         });
     }
+    /**
+     * 查询审计动作汇总记录
+     */
+    getAuditActions(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.entityAuditService.getAuditActions({
+                userId: query.userId,
+                username: query.username,
+                actionName: query.actionName,
+                success: query.success,
+                startTime: query.startTime ? new Date(query.startTime) : undefined,
+                endTime: query.endTime ? new Date(query.endTime) : undefined,
+                page: query.page,
+                limit: query.limit,
+            });
+        });
+    }
+    /**
+     * 查询单个审计动作的详细信息
+     */
+    getAuditActionDetail(actionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.entityAuditService.getAuditActionDetail(actionId);
+        });
+    }
 };
 exports.AuditController = AuditController;
 __decorate([
@@ -158,6 +183,24 @@ __decorate([
     __metadata("design:paramtypes", [String]),
     __metadata("design:returntype", Promise)
 ], AuditController.prototype, "rollbackTransaction", null);
+__decorate([
+    (0, common_1.Get)('actions'),
+    (0, swagger_1.ApiOperation)({ summary: '查询审计动作汇总记录' }),
+    (0, swagger_1.ApiResponse)({ status: 200, description: '返回审计动作汇总列表' }),
+    __param(0, (0, common_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [dto_1.AuditActionQueryDto]),
+    __metadata("design:returntype", Promise)
+], AuditController.prototype, "getAuditActions", null);
+__decorate([
+    (0, common_1.Get)('actions/:actionId'),
+    (0, swagger_1.ApiOperation)({ summary: '查询审计动作详细信息' }),
+    (0, swagger_1.ApiResponse)({ status: 200, description: '返回审计动作详细信息' }),
+    __param(0, (0, common_1.Param)('actionId')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], AuditController.prototype, "getAuditActionDetail", null);
 exports.AuditController = AuditController = __decorate([
     (0, common_1.Controller)('audit'),
     (0, swagger_1.ApiTags)('audit'),

package/audit/decorators/audit-action.decorator.d.ts

@@ -0,0 +1,74 @@
+import { AuditParamsContext } from '../services/audit-context.service';
+export declare const AUDIT_ACTION_METADATA = "AUDIT_ACTION_METADATA";
+/**
+ * 审计动作选项
+ */
+export interface AuditActionOptions {
+    /**
+     * 操作模板键（可选）
+     * @example 'order.create'
+     */
+    templateKey?: string;
+    /**
+     * 参数构建器，用于从请求和实体变更中提取描述参数
+     * @param context - 包含 req, result, error, entityChanges 的上下文
+     * @returns 描述参数对象
+     *
+     * @example
+     * paramsBuilder: (context) => {
+     *   const order = context.findEntity('Order', 'CREATE');
+     *   const items = context.findEntities('OrderItem', 'CREATE');
+     *   return {
+     *     'order.sn': order?.newValue.orderSn,
+     *     'product.count': items.length,
+     *     'receiver': order?.newValue.receiverName,
+     *   };
+     * }
+     */
+    paramsBuilder?: (context: AuditParamsContext) => Record<string, any>;
+    /**
+     * 是否启用审计（默认 true）
+     */
+    enabled?: boolean;
+    /**
+     * 扩展元数据
+     */
+    metadata?: Record<string, any>;
+}
+/**
+ * 审计动作装饰器元数据
+ */
+export interface AuditActionMetadata {
+    actionName: string;
+    options: AuditActionOptions;
+}
+/**
+ * 审计动作装饰器
+ * 用于在控制器方法上标记审计动作，自动收集该请求中的所有实体变更
+ *
+ * @param actionName - 操作名称，如 'createOrder', 'cancelOrder'
+ * @param options - 审计动作选项
+ *
+ * @example
+ * ```typescript
+ * @Post()
+ * @AuditAction('createOrder', {
+ *   templateKey: 'order.create',
+ *   paramsBuilder: (context) => {
+ *     const order = context.findEntity('Order', 'CREATE');
+ *     const items = context.findEntities('OrderItem', 'CREATE');
+ *     return {
+ *       'order.sn': order?.newValue.orderSn,
+ *       'product.count': items.length,
+ *       'product.names': items.map(i => i.metadata?.productName).join('、'),
+ *       'receiver': order?.newValue.receiverName,
+ *       'totalAmount': order?.newValue.totalAmount,
+ *     };
+ *   }
+ * })
+ * async createOrder(@Body() dto: CreateOrderDto) {
+ *   return await this.orderService.create(dto);
+ * }
+ * ```
+ */
+export declare function AuditAction(actionName: string, options?: AuditActionOptions): MethodDecorator;

package/audit/decorators/audit-action.decorator.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AUDIT_ACTION_METADATA = void 0;
+exports.AuditAction = AuditAction;
+const common_1 = require("@nestjs/common");
+exports.AUDIT_ACTION_METADATA = 'AUDIT_ACTION_METADATA';
+/**
+ * 审计动作装饰器
+ * 用于在控制器方法上标记审计动作，自动收集该请求中的所有实体变更
+ *
+ * @param actionName - 操作名称，如 'createOrder', 'cancelOrder'
+ * @param options - 审计动作选项
+ *
+ * @example
+ * ```typescript
+ * @Post()
+ * @AuditAction('createOrder', {
+ *   templateKey: 'order.create',
+ *   paramsBuilder: (context) => {
+ *     const order = context.findEntity('Order', 'CREATE');
+ *     const items = context.findEntities('OrderItem', 'CREATE');
+ *     return {
+ *       'order.sn': order?.newValue.orderSn,
+ *       'product.count': items.length,
+ *       'product.names': items.map(i => i.metadata?.productName).join('、'),
+ *       'receiver': order?.newValue.receiverName,
+ *       'totalAmount': order?.newValue.totalAmount,
+ *     };
+ *   }
+ * })
+ * async createOrder(@Body() dto: CreateOrderDto) {
+ *   return await this.orderService.create(dto);
+ * }
+ * ```
+ */
+function AuditAction(actionName, options = {}) {
+    const metadata = {
+        actionName,
+        options: Object.assign({ enabled: true }, options),
+    };
+    return (0, common_1.SetMetadata)(exports.AUDIT_ACTION_METADATA, metadata);
+}

package/audit/decorators/audit-controller.decorator.d.ts

@@ -5,7 +5,7 @@ export declare const METHOD_AUDIT_OPTIONS: unique symbol;
  * 控制器审计装饰器
  * @param options 控制器审计选项
  */
-export declare function EntityAuditController(options?: ControllerAuditOptions): ClassDecorator;
+export declare function AuditController(options?: ControllerAuditOptions): ClassDecorator;
 /**
  * 方法审计装饰器
  * @param options 方法审计选项

package/audit/decorators/audit-controller.decorator.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.METHOD_AUDIT_OPTIONS = exports.CONTROLLER_AUDIT_OPTIONS = void 0;
-exports.EntityAuditController = EntityAuditController;
+exports.AuditController = AuditController;
 exports.AuditMethod = AuditMethod;
 // 元数据键
 exports.CONTROLLER_AUDIT_OPTIONS = Symbol('CONTROLLER_AUDIT_OPTIONS');
@@ -10,7 +10,7 @@ exports.METHOD_AUDIT_OPTIONS = Symbol('METHOD_AUDIT_OPTIONS');
  * 控制器审计装饰器
  * @param options 控制器审计选项
  */
-function EntityAuditController(options) {
+function AuditController(options) {
     return (target) => {
         Reflect.defineMetadata(exports.CONTROLLER_AUDIT_OPTIONS, options || {}, target);
     };

package/audit/decorators/audit-operation.decorator.d.ts

@@ -7,7 +7,6 @@ export declare const AUDIT_OPERATION_OPTIONS: unique symbol;
  * 用于手动记录业务操作的审计日志，支持：
  * - 自定义操作模板
  * - 动态描述参数
- * - 回滚操作定义
  * - 自动事务管理
  *
  * @param options 审计操作选项
@@ -20,12 +19,6 @@ export declare const AUDIT_OPERATION_OPTIONS: unique symbol;
  *     username: args[0].username,
  *     approver: result.approver
  *   }),
- *   rollbackActions: (args, result) => [{
- *     type: RollbackActionType.UPDATE,
- *     action: 'reject',
- *     params: { userId: args[0].id },
- *     order: 1
- *   }],
  *   autoTransaction: true
  * })
  * async approveUser(user: User): Promise<ApprovalResult> {

package/audit/decorators/audit-operation.decorator.js

@@ -13,7 +13,6 @@ exports.AUDIT_OPERATION_OPTIONS = Symbol('AUDIT_OPERATION_OPTIONS');
  * 用于手动记录业务操作的审计日志，支持：
  * - 自定义操作模板
  * - 动态描述参数
- * - 回滚操作定义
  * - 自动事务管理
  *
  * @param options 审计操作选项
@@ -26,12 +25,6 @@ exports.AUDIT_OPERATION_OPTIONS = Symbol('AUDIT_OPERATION_OPTIONS');
  *     username: args[0].username,
  *     approver: result.approver
  *   }),
- *   rollbackActions: (args, result) => [{
- *     type: RollbackActionType.UPDATE,
- *     action: 'reject',
- *     params: { userId: args[0].id },
- *     order: 1
- *   }],
  *   autoTransaction: true
  * })
  * async approveUser(user: User): Promise<ApprovalResult> {

package/audit/decorators/entity-audit.decorator.d.ts

@@ -3,11 +3,87 @@ export declare const ENTITY_AUDIT_OPTIONS: unique symbol;
 export declare const FIELD_AUDIT_OPTIONS: unique symbol;
 /**
  * 实体审计装饰器
+ *
+ * @description
+ * 支持基础审计配置和多语言标签。
+ * 字段标签和值标签请使用 @AuditField({ label: { zh: '姓名', en: 'Name' } })
+ *
  * @param options 审计配置选项
+ *
+ * @example
+ * // 基础用法
+ * @AuditEntity({
+ *   enabled: true,
+ *   label: { zh: '订单', en: 'Order' },
+ *   excludeFields: ['password'],
+ *   maskFields: ['email']
+ * })
+ *
+ * @example
+ * // 指定模板键
+ * @AuditEntity({
+ *   enabled: true,
+ *   label: { zh: '用户', en: 'User' },
+ *   templateKey: 'user',
+ * })
  */
-export declare function EntityAudit(options?: EntityAuditConfig): ClassDecorator;
+export declare function AuditEntity(options?: EntityAuditConfig): ClassDecorator;
 /**
  * 字段审计装饰器
- * @param options 字段显示选项
+ * @param options 字段显示选项（支持多语言 label 和 valueLabels）
+ *
+ * @example
+ * // 单语言
+ * @AuditField({ label: '姓名' })
+ *
+ * @example
+ * // 多语言
+ * @AuditField({ label: { zh: '姓名', en: 'Name' } })
+ *
+ * @example
+ * // 带值标签映射
+ * @AuditField({
+ *   label: { zh: '状态', en: 'Status' },
+ *   valueLabels: {
+ *     active: { zh: '激活', en: 'Active' },
+ *     inactive: { zh: '未激活', en: 'Inactive' }
+ *   }
+ * })
  */
 export declare function AuditField(options?: FieldDisplayOptions): PropertyDecorator;
+/**
+ * 获取实体审计配置
+ * @param target 目标类
+ * @returns 审计配置
+ */
+export declare function getEntityAuditConfig(target: any): EntityAuditConfig;
+/**
+ * 获取字段审计配置
+ * @param target 目标类
+ * @returns 字段配置映射
+ */
+export declare function getFieldAuditConfig(target: any): Record<string, FieldDisplayOptions>;
+/**
+ * 获取字段的标签（支持多语言）
+ * @param target 目标类
+ * @param fieldName 字段名
+ * @param language 语言代码（默认：zh）
+ * @returns 字段标签
+ */
+export declare function getFieldLabel(target: any, fieldName: string, language?: string): string;
+/**
+ * 获取字段值的标签（支持多语言）
+ * @param target 目标类
+ * @param fieldName 字段名
+ * @param value 值
+ * @param language 语言代码（默认：zh）
+ * @returns 值的标签
+ */
+export declare function getFieldValueLabel(target: any, fieldName: string, value: any, language?: string): string;
+/**
+ * 获取实体的标签（支持多语言）
+ * @param target 目标类
+ * @param language 语言代码（默认：zh）
+ * @returns 实体标签
+ */
+export declare function getEntityLabel(target: any, language?: string): string;