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

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

@@ -13,6 +13,9 @@ exports.EntityAuditLogEntity = void 0;
 const typeorm_1 = require("typeorm");
 const abstract_entity_1 = require("../../common/abstract.entity");
 const enums_1 = require("../enums");
+/**
+ * 实体审计日志
+ */
 let EntityAuditLogEntity = class EntityAuditLogEntity extends abstract_entity_1.AbstractUuidPrimaryEntity {
 };
 exports.EntityAuditLogEntity = EntityAuditLogEntity;
@@ -37,13 +40,9 @@ __decorate([
     __metadata("design:type", Object)
 ], EntityAuditLogEntity.prototype, "newValue", void 0);
 __decorate([
-    (0, typeorm_1.Column)({ type: 'json', nullable: true, comment: '变更的字段' }),
+    (0, typeorm_1.Column)({ type: 'json', nullable: true, comment: '变更的字段列表' }),
     __metadata("design:type", Array)
 ], EntityAuditLogEntity.prototype, "changedFields", void 0);
-__decorate([
-    (0, typeorm_1.Column)({ type: 'text', nullable: true, comment: '变更字段路径' }),
-    __metadata("design:type", String)
-], EntityAuditLogEntity.prototype, "changedFieldPaths", void 0);
 __decorate([
     (0, typeorm_1.Column)({ nullable: true, comment: '操作用户ID' }),
     __metadata("design:type", String)
@@ -69,13 +68,53 @@ __decorate([
     __metadata("design:type", String)
 ], EntityAuditLogEntity.prototype, "description", void 0);
 __decorate([
-    (0, typeorm_1.Column)({ type: 'json', nullable: true, comment: '哈希链' }),
+    (0, typeorm_1.Column)({ nullable: true, comment: '审计动作ID，用于关联同一业务操作的多个实体变化' }),
+    __metadata("design:type", String)
+], EntityAuditLogEntity.prototype, "auditActionId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, comment: '审计动作名称，如 createOrder、updateUser' }),
+    __metadata("design:type", String)
+], EntityAuditLogEntity.prototype, "auditActionName", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'int', default: 0, comment: '在审计动作内的序号' }),
+    __metadata("design:type", Number)
+], EntityAuditLogEntity.prototype, "sequenceInAction", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, comment: '操作模板键，用于动态生成描述' }),
+    __metadata("design:type", String)
+], EntityAuditLogEntity.prototype, "operationTemplateKey", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'json',
+        nullable: true,
+        comment: '描述参数，用于填充模板占位符',
+    }),
     __metadata("design:type", Object)
-], EntityAuditLogEntity.prototype, "hashChain", void 0);
+], EntityAuditLogEntity.prototype, "descriptionParams", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'json',
+        nullable: true,
+        comment: '结构化变更详情列表（包含多语言支持）',
+    }),
+    __metadata("design:type", Array)
+], EntityAuditLogEntity.prototype, "changeDetails", void 0);
 exports.EntityAuditLogEntity = EntityAuditLogEntity = __decorate([
-    (0, typeorm_1.Entity)('entity_audit_log'),
+    (0, typeorm_1.Entity)('entity_audit_log')
+    // 单字段索引
+    ,
     (0, typeorm_1.Index)('idx_entity_relation', ['entityType', 'entityId']),
     (0, typeorm_1.Index)('idx_operation', ['operation']),
     (0, typeorm_1.Index)('idx_user', ['userId']),
-    (0, typeorm_1.Index)('idx_created_at', ['createdAt'])
+    (0, typeorm_1.Index)('idx_created_at', ['createdAt']),
+    (0, typeorm_1.Index)('idx_template_key', ['operationTemplateKey']),
+    (0, typeorm_1.Index)('idx_request_id', ['requestId']),
+    (0, typeorm_1.Index)('idx_audit_action', ['auditActionId'])
+    // 复合索引 - 优化常见查询
+    ,
+    (0, typeorm_1.Index)('idx_entity_operation', ['entityType', 'entityId', 'operation']),
+    (0, typeorm_1.Index)('idx_entity_time', ['entityType', 'entityId', 'createdAt']),
+    (0, typeorm_1.Index)('idx_user_time', ['userId', 'createdAt']),
+    (0, typeorm_1.Index)('idx_request_time', ['requestId', 'createdAt']),
+    (0, typeorm_1.Index)('idx_action_sequence', ['auditActionId', 'sequenceInAction'])
 ], EntityAuditLogEntity);

package/audit/entities/entity-transaction.entity.d.ts

@@ -1,8 +1,11 @@
 import { AbstractUuidPrimaryEntity } from '../../common/abstract.entity';
-import { AuditOperation, TransactionStatus } from '../enums';
+import { AuditOperation, AuditTransactionStatus } from '../enums';
+/**
+ * 实体事务
+ */
 export declare class EntityTransactionEntity extends AbstractUuidPrimaryEntity {
     description: string;
-    status: TransactionStatus;
+    status: AuditTransactionStatus;
     entities: Array<{
         entityType: string;
         entityId: string;
@@ -11,4 +14,10 @@ export declare class EntityTransactionEntity extends AbstractUuidPrimaryEntity {
     userId: string;
     username: string;
     dependencyGraph: Record<string, any>;
+    operationTemplateKey: string;
+    descriptionParams: Record<string, any>;
+    requestIp: string;
+    metadata: Record<string, any>;
+    completedAt: Date;
+    manualOperations: any[];
 }

package/audit/entities/entity-transaction.entity.js

@@ -13,6 +13,9 @@ exports.EntityTransactionEntity = void 0;
 const typeorm_1 = require("typeorm");
 const abstract_entity_1 = require("../../common/abstract.entity");
 const enums_1 = require("../enums");
+/**
+ * 实体事务
+ */
 let EntityTransactionEntity = class EntityTransactionEntity extends abstract_entity_1.AbstractUuidPrimaryEntity {
 };
 exports.EntityTransactionEntity = EntityTransactionEntity;
@@ -21,7 +24,7 @@ __decorate([
     __metadata("design:type", String)
 ], EntityTransactionEntity.prototype, "description", void 0);
 __decorate([
-    (0, typeorm_1.Column)({ type: 'enum', enum: enums_1.TransactionStatus, comment: '事务状态' }),
+    (0, typeorm_1.Column)({ type: 'enum', enum: enums_1.AuditTransactionStatus, comment: '事务状态' }),
     __metadata("design:type", String)
 ], EntityTransactionEntity.prototype, "status", void 0);
 __decorate([
@@ -43,9 +46,45 @@ __decorate([
     (0, typeorm_1.Column)({ type: 'json', nullable: true, comment: '依赖图' }),
     __metadata("design:type", Object)
 ], EntityTransactionEntity.prototype, "dependencyGraph", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, comment: '操作模板键（事务级别）' }),
+    __metadata("design:type", String)
+], EntityTransactionEntity.prototype, "operationTemplateKey", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'json',
+        nullable: true,
+        comment: '描述参数，用于填充事务级别的模板占位符',
+    }),
+    __metadata("design:type", Object)
+], EntityTransactionEntity.prototype, "descriptionParams", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, comment: '请求IP' }),
+    __metadata("design:type", String)
+], EntityTransactionEntity.prototype, "requestIp", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'json', nullable: true, comment: '事务元数据' }),
+    __metadata("design:type", Object)
+], EntityTransactionEntity.prototype, "metadata", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'timestamp', nullable: true, comment: '完成时间' }),
+    __metadata("design:type", Date)
+], EntityTransactionEntity.prototype, "completedAt", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)('ManualOperationLogEntity', 'transaction'),
+    __metadata("design:type", Array)
+], EntityTransactionEntity.prototype, "manualOperations", void 0);
 exports.EntityTransactionEntity = EntityTransactionEntity = __decorate([
-    (0, typeorm_1.Entity)('entity_transaction'),
+    (0, typeorm_1.Entity)('entity_transaction')
+    // 单字段索引
+    ,
     (0, typeorm_1.Index)('idx_status', ['status']),
     (0, typeorm_1.Index)('idx_user', ['userId']),
-    (0, typeorm_1.Index)('idx_created_at', ['createdAt'])
+    (0, typeorm_1.Index)('idx_created_at', ['createdAt']),
+    (0, typeorm_1.Index)('idx_template_key', ['operationTemplateKey'])
+    // 复合索引 - 优化常见查询
+    ,
+    (0, typeorm_1.Index)('idx_user_status', ['userId', 'status']),
+    (0, typeorm_1.Index)('idx_user_time', ['userId', 'createdAt']),
+    (0, typeorm_1.Index)('idx_status_time', ['status', 'createdAt'])
 ], EntityTransactionEntity);

package/audit/entities/index.d.ts

@@ -1,2 +1,5 @@
 export * from './entity-audit-log.entity';
 export * from './entity-transaction.entity';
+export * from './operation-template.entity';
+export * from './manual-operation-log.entity';
+export * from './audit-action-summary.entity';

package/audit/entities/index.js

@@ -16,3 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./entity-audit-log.entity"), exports);
 __exportStar(require("./entity-transaction.entity"), exports);
+__exportStar(require("./operation-template.entity"), exports);
+__exportStar(require("./manual-operation-log.entity"), exports);
+__exportStar(require("./audit-action-summary.entity"), exports);

package/audit/entities/manual-operation-log.entity.d.ts

@@ -1,6 +1,9 @@
 import { AbstractUuidPrimaryEntity } from '../../common/abstract.entity';
 import { EntityTransactionEntity } from './entity-transaction.entity';
-import { RollbackAction } from '../interfaces';
+/**
+ * 手动操作记录表
+ * 用于记录跨实体的复杂业务操作
+ */
 export declare class ManualOperationLogEntity extends AbstractUuidPrimaryEntity {
     transactionId: string;
     operationTemplateKey: string;
@@ -10,6 +13,5 @@ export declare class ManualOperationLogEntity extends AbstractUuidPrimaryEntity
     userId: string;
     username: string;
     requestIp: string;
-    rollbackActions: RollbackAction[];
     transaction: EntityTransactionEntity;
 }

package/audit/entities/manual-operation-log.entity.js

@@ -13,6 +13,10 @@ exports.ManualOperationLogEntity = void 0;
 const typeorm_1 = require("typeorm");
 const abstract_entity_1 = require("../../common/abstract.entity");
 const entity_transaction_entity_1 = require("./entity-transaction.entity");
+/**
+ * 手动操作记录表
+ * 用于记录跨实体的复杂业务操作
+ */
 let ManualOperationLogEntity = class ManualOperationLogEntity extends abstract_entity_1.AbstractUuidPrimaryEntity {
 };
 exports.ManualOperationLogEntity = ManualOperationLogEntity;
@@ -60,23 +64,22 @@ __decorate([
     (0, typeorm_1.Column)({ nullable: true, comment: '操作IP' }),
     __metadata("design:type", String)
 ], ManualOperationLogEntity.prototype, "requestIp", void 0);
-__decorate([
-    (0, typeorm_1.Column)({
-        type: 'json',
-        nullable: true,
-        comment: '回滚操作列表',
-    }),
-    __metadata("design:type", Array)
-], ManualOperationLogEntity.prototype, "rollbackActions", void 0);
 __decorate([
     (0, typeorm_1.ManyToOne)('EntityTransactionEntity', { onDelete: 'CASCADE' }),
     (0, typeorm_1.JoinColumn)({ name: 'transactionId' }),
     __metadata("design:type", entity_transaction_entity_1.EntityTransactionEntity)
 ], ManualOperationLogEntity.prototype, "transaction", void 0);
 exports.ManualOperationLogEntity = ManualOperationLogEntity = __decorate([
-    (0, typeorm_1.Entity)('manual_operation_log'),
+    (0, typeorm_1.Entity)('manual_operation_log')
+    // 单字段索引
+    ,
     (0, typeorm_1.Index)('idx_transaction', ['transactionId']),
     (0, typeorm_1.Index)('idx_template_key', ['operationTemplateKey']),
     (0, typeorm_1.Index)('idx_user', ['userId']),
     (0, typeorm_1.Index)('idx_created_at', ['createdAt'])
+    // 复合索引 - 优化常见查询
+    ,
+    (0, typeorm_1.Index)('idx_transaction_time', ['transactionId', 'createdAt']),
+    (0, typeorm_1.Index)('idx_user_time', ['userId', 'createdAt']),
+    (0, typeorm_1.Index)('idx_template_user', ['operationTemplateKey', 'userId'])
 ], ManualOperationLogEntity);

package/audit/entities/operation-template.entity.d.ts

@@ -1,5 +1,9 @@
 import { AbstractUuidPrimaryEntity } from '../../common/abstract.entity';
 import { AuditOperation } from '../enums';
+/**
+ * 操作模板配置表
+ * 用于存储多语言操作描述模板
+ */
 export declare class OperationTemplateEntity extends AbstractUuidPrimaryEntity {
     key: string;
     entityName: string;

package/audit/entities/operation-template.entity.js

@@ -13,6 +13,10 @@ exports.OperationTemplateEntity = void 0;
 const typeorm_1 = require("typeorm");
 const abstract_entity_1 = require("../../common/abstract.entity");
 const enums_1 = require("../enums");
+/**
+ * 操作模板配置表
+ * 用于存储多语言操作描述模板
+ */
 let OperationTemplateEntity = class OperationTemplateEntity extends abstract_entity_1.AbstractUuidPrimaryEntity {
 };
 exports.OperationTemplateEntity = OperationTemplateEntity;

package/audit/enums/audit.enums.d.ts

@@ -1,27 +1,50 @@
+/**
+ * 审计操作类型（兼容性别名，映射到 OperationType）
+ */
 export declare enum AuditOperation {
     CREATE = "CREATE",
     UPDATE = "UPDATE",
     DELETE = "DELETE",
     RESTORE = "RESTORE"
 }
-export declare enum TransactionStatus {
-    PENDING = "PENDING",
-    COMMITTED = "COMMITTED",
-    ROLLED_BACK = "ROLLED_BACK"
+/**
+ * 事务状态（设计文档标准命名）
+ */
+export declare enum AuditTransactionStatus {
+    PENDING = "pending",
+    COMMITTED = "committed",
+    ROLLED_BACK = "rolled_back"
 }
+/**
+ * 恢复策略
+ */
 export declare enum RecoveryStrategy {
     ENTITY_ONLY = "ENTITY_ONLY",
     TRANSACTION_RESTORE = "TRANSACTION_RESTORE",
     DEPENDENCY_GRAPH = "DEPENDENCY_GRAPH"
 }
+/**
+ * 记录策略
+ */
 export declare enum RecordStrategy {
-    FULL = "FULL",
-    DIFF_ONLY = "DIFF_ONLY",
+    FULL = "FULL",// 记录完整变更
+    DIFF_ONLY = "DIFF_ONLY",// 仅记录差异
     DISABLED = "DISABLED"
 }
+/**
+ * 脱敏策略
+ */
 export declare enum MaskingStrategy {
     NONE = "NONE",
     HASH = "HASH",
     MASK = "MASK",
     PARTIAL = "PARTIAL"
 }
+/**
+ * 变更类型（设计文档标准命名）
+ */
+export declare enum ChangeType {
+    ADDED = "added",// 新增字段
+    REMOVED = "removed",// 删除字段
+    MODIFIED = "modified"
+}

package/audit/enums/audit.enums.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MaskingStrategy = exports.RecordStrategy = exports.RecoveryStrategy = exports.TransactionStatus = exports.AuditOperation = void 0;
+exports.ChangeType = exports.MaskingStrategy = exports.RecordStrategy = exports.RecoveryStrategy = exports.AuditTransactionStatus = exports.AuditOperation = void 0;
+/**
+ * 审计操作类型（兼容性别名，映射到 OperationType）
+ */
 var AuditOperation;
 (function (AuditOperation) {
     AuditOperation["CREATE"] = "CREATE";
@@ -8,24 +11,36 @@ var AuditOperation;
     AuditOperation["DELETE"] = "DELETE";
     AuditOperation["RESTORE"] = "RESTORE";
 })(AuditOperation || (exports.AuditOperation = AuditOperation = {}));
-var TransactionStatus;
-(function (TransactionStatus) {
-    TransactionStatus["PENDING"] = "PENDING";
-    TransactionStatus["COMMITTED"] = "COMMITTED";
-    TransactionStatus["ROLLED_BACK"] = "ROLLED_BACK";
-})(TransactionStatus || (exports.TransactionStatus = TransactionStatus = {}));
+/**
+ * 事务状态（设计文档标准命名）
+ */
+var AuditTransactionStatus;
+(function (AuditTransactionStatus) {
+    AuditTransactionStatus["PENDING"] = "pending";
+    AuditTransactionStatus["COMMITTED"] = "committed";
+    AuditTransactionStatus["ROLLED_BACK"] = "rolled_back";
+})(AuditTransactionStatus || (exports.AuditTransactionStatus = AuditTransactionStatus = {}));
+/**
+ * 恢复策略
+ */
 var RecoveryStrategy;
 (function (RecoveryStrategy) {
     RecoveryStrategy["ENTITY_ONLY"] = "ENTITY_ONLY";
     RecoveryStrategy["TRANSACTION_RESTORE"] = "TRANSACTION_RESTORE";
     RecoveryStrategy["DEPENDENCY_GRAPH"] = "DEPENDENCY_GRAPH";
 })(RecoveryStrategy || (exports.RecoveryStrategy = RecoveryStrategy = {}));
+/**
+ * 记录策略
+ */
 var RecordStrategy;
 (function (RecordStrategy) {
     RecordStrategy["FULL"] = "FULL";
     RecordStrategy["DIFF_ONLY"] = "DIFF_ONLY";
     RecordStrategy["DISABLED"] = "DISABLED";
 })(RecordStrategy || (exports.RecordStrategy = RecordStrategy = {}));
+/**
+ * 脱敏策略
+ */
 var MaskingStrategy;
 (function (MaskingStrategy) {
     MaskingStrategy["NONE"] = "NONE";
@@ -33,3 +48,12 @@ var MaskingStrategy;
     MaskingStrategy["MASK"] = "MASK";
     MaskingStrategy["PARTIAL"] = "PARTIAL";
 })(MaskingStrategy || (exports.MaskingStrategy = MaskingStrategy = {}));
+/**
+ * 变更类型（设计文档标准命名）
+ */
+var ChangeType;
+(function (ChangeType) {
+    ChangeType["ADDED"] = "added";
+    ChangeType["REMOVED"] = "removed";
+    ChangeType["MODIFIED"] = "modified";
+})(ChangeType || (exports.ChangeType = ChangeType = {}));

package/audit/examples/decorator-value-mapping.example.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 装饰器值映射完整示例
+ *
+ * 本示例演示如何使用 @AuditField 装饰器的 valueLabels 功能
+ * 实现字段值的多语言显示和映射
+ */
+export declare class ProductEntity {
+    id: string;
+    name: string;
+    price: number;
+    costPrice: number;
+    stock: number;
+    status: string;
+    isFeatured: boolean;
+    productType: string;
+    internalNotes: string;
+    supplierCode: string;
+}
+export declare class OrderEntity {
+    orderSn: string;
+    totalAmount: number;
+    orderStatus: string;
+    paymentStatus: string;
+    shippingMethod: string;
+    customerPhone: string;
+    customerEmail: string;
+}
+export declare class UserEntity {
+    username: string;
+    email: string;
+    phone: string;
+    status: string;
+    role: string;
+    emailNotificationEnabled: boolean;
+    smsNotificationEnabled: boolean;
+    gender: string;
+    password: string;
+}
+export declare class InventoryEntity {
+    productCode: string;
+    availableStock: number;
+    lockedStock: number;
+    totalStock: number;
+    stockStatus: string;
+}
+/**
+ * 当产品状态从 'active' 变为 'out_of_stock' 时，
+ * 审计日志的 changeDetails 会显示：
+ *
+ * 中文 (language=zh):
+ * {
+ *   "fieldName": "状态",
+ *   "changeType": "modified",
+ *   "displayOldValue": "在售",
+ *   "displayNewValue": "缺货",
+ *   "oldValue": "active",
+ *   "newValue": "out_of_stock"
+ * }
+ *
+ * 英文 (language=en):
+ * {
+ *   "fieldName": "Status",
+ *   "changeType": "modified",
+ *   "displayOldValue": "Active",
+ *   "displayNewValue": "Out of Stock",
+ *   "oldValue": "active",
+ *   "newValue": "out_of_stock"
+ * }
+ */
+export {};