midway-fatcms 0.0.3 → 0.0.4

package/dist/middleware/tx.middleware.js

@@ -1,83 +1,83 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startTransaction = void 0;
-/**
- * 事务中间件 - 数据库事务自动管理
- *
- * 核心职责：
- * 1. 自动开启事务：请求开始时自动调用 beginTx() 开启数据库事务
- * 2. 自动提交事务：请求成功完成后自动调用 commitTx() 提交所有变更
- * 3. 自动回滚事务：请求异常时自动调用 rollbackTx() 回滚所有变更
- * 4. 自动释放连接：无论成功或失败都调用 releaseTx() 释放数据库连接
- *
- * 应用场景：
- * 1. 订单处理：创建订单 + 扣减库存 + 生成物流单，任一步骤失败全部回滚
- * 2. 资金转账：扣款账户减少 + 收款账户增加，保证两步同时成功或同时失败
- * 3. 批量操作：导入100条数据，要么全部成功，要么全部不导入（避免脏数据）
- * 4. 状态关联更新：更新订单状态 + 更新用户积分 + 更新商品销量，保证数据一致性
- * 5. 工作流审批：审批通过 + 更新流程状态 + 发送通知，确保流程完整性
- *
- * 使用方式：
- * 在 Controller 方法的 middleware 配置中使用：
- *
- * @example
- * ```typescript
- * import { Controller, Post, Inject } from '@midwayjs/core';
- * import { startTransaction } from '../middleware/tx.middleware';
- *
- * @Controller('/api/order')
- * export class OrderController {
- *   @Inject()
- *   orderService: OrderService;
- *
- *   @Post('/create', { middleware: [startTransaction()] })  // 在路由配置中使用
- *   async createOrder(@Body() dto: CreateOrderDto) {
- *     // 1. 创建订单记录
- *     const order = await this.orderService.create(dto);
- *
- *     // 2. 扣减商品库存
- *     await this.productService.decreaseStock(dto.productId, dto.quantity);
- *
- *     // 3. 生成支付单
- *     await this.paymentService.createPayment(order.id, dto.amount);
- *
- *     // 如果任何一步失败，以上所有操作都会自动回滚
- *     return order;
- *   }
- * }
- * ```
- *
- * 注意事项：
- * - 事务中的所有数据库操作必须使用同一个 ctx.transaction 实例
- * - 避免在事务中执行长时间操作（如HTTP请求、文件IO），会长时间占用数据库连接
- * - 事务嵌套需要特别注意，确保内层事务与外层事务共享同一连接
- * - 异常会被捕获、记录日志并重新抛出，由全局中间件统一处理
- */
-function startTransaction() {
-    return async (ctx, next) => {
-        // 获取上下文中的事务对象（由 global.middleware.ts 初始化）
-        const transaction = ctx.transaction;
-        try {
-            // 开启数据库事务
-            await transaction.beginTx();
-            // 执行业务逻辑（Controller 方法）
-            const res = await next();
-            // 业务逻辑执行成功，提交事务
-            await transaction.commitTx();
-            return res;
-        }
-        catch (e) {
-            // 记录异常日志
-            ctx.contextLogger.error('TxMiddleware', e);
-            // 业务逻辑执行失败，回滚事务
-            await transaction.rollbackTx();
-            // 重新抛出异常，让上层错误处理机制捕获
-            throw e;
-        }
-        finally {
-            // 无论成功还是失败，都释放数据库连接
-            await transaction.releaseTx();
-        }
-    };
-}
-exports.startTransaction = startTransaction;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startTransaction = void 0;
+/**
+ * 事务中间件 - 数据库事务自动管理
+ *
+ * 核心职责：
+ * 1. 自动开启事务：请求开始时自动调用 beginTx() 开启数据库事务
+ * 2. 自动提交事务：请求成功完成后自动调用 commitTx() 提交所有变更
+ * 3. 自动回滚事务：请求异常时自动调用 rollbackTx() 回滚所有变更
+ * 4. 自动释放连接：无论成功或失败都调用 releaseTx() 释放数据库连接
+ *
+ * 应用场景：
+ * 1. 订单处理：创建订单 + 扣减库存 + 生成物流单，任一步骤失败全部回滚
+ * 2. 资金转账：扣款账户减少 + 收款账户增加，保证两步同时成功或同时失败
+ * 3. 批量操作：导入100条数据，要么全部成功，要么全部不导入（避免脏数据）
+ * 4. 状态关联更新：更新订单状态 + 更新用户积分 + 更新商品销量，保证数据一致性
+ * 5. 工作流审批：审批通过 + 更新流程状态 + 发送通知，确保流程完整性
+ *
+ * 使用方式：
+ * 在 Controller 方法的 middleware 配置中使用：
+ *
+ * @example
+ * ```typescript
+ * import { Controller, Post, Inject } from '@midwayjs/core';
+ * import { startTransaction } from '../middleware/tx.middleware';
+ *
+ * @Controller('/api/order')
+ * export class OrderController {
+ *   @Inject()
+ *   orderService: OrderService;
+ *
+ *   @Post('/create', { middleware: [startTransaction()] })  // 在路由配置中使用
+ *   async createOrder(@Body() dto: CreateOrderDto) {
+ *     // 1. 创建订单记录
+ *     const order = await this.orderService.create(dto);
+ *
+ *     // 2. 扣减商品库存
+ *     await this.productService.decreaseStock(dto.productId, dto.quantity);
+ *
+ *     // 3. 生成支付单
+ *     await this.paymentService.createPayment(order.id, dto.amount);
+ *
+ *     // 如果任何一步失败，以上所有操作都会自动回滚
+ *     return order;
+ *   }
+ * }
+ * ```
+ *
+ * 注意事项：
+ * - 事务中的所有数据库操作必须使用同一个 ctx.transaction 实例
+ * - 避免在事务中执行长时间操作（如HTTP请求、文件IO），会长时间占用数据库连接
+ * - 事务嵌套需要特别注意，确保内层事务与外层事务共享同一连接
+ * - 异常会被捕获、记录日志并重新抛出，由全局中间件统一处理
+ */
+function startTransaction() {
+    return async (ctx, next) => {
+        // 获取上下文中的事务对象（由 global.middleware.ts 初始化）
+        const transaction = ctx.transaction;
+        try {
+            // 开启数据库事务
+            await transaction.beginTx();
+            // 执行业务逻辑（Controller 方法）
+            const res = await next();
+            // 业务逻辑执行成功，提交事务
+            await transaction.commitTx();
+            return res;
+        }
+        catch (e) {
+            // 记录异常日志
+            ctx.contextLogger.error('TxMiddleware', e);
+            // 业务逻辑执行失败，回滚事务
+            await transaction.rollbackTx();
+            // 重新抛出异常，让上层错误处理机制捕获
+            throw e;
+        }
+        finally {
+            // 无论成功还是失败，都释放数据库连接
+            await transaction.releaseTx();
+        }
+    };
+}
+exports.startTransaction = startTransaction;

package/dist/models/AsyncTaskModel.d.ts

@@ -1,74 +1,74 @@
-export interface SysAsyncTaskEntity {
-    id: number;
-    task_uuid: string;
-    task_name: string;
-    task_description: string | null;
-    task_type: string;
-    task_status: SysAsyncTaskStatus;
-    input_params: any;
-    output_result: any | null;
-    input_file_path: string | null;
-    input_file_format: SysAsyncFileFormat | null;
-    input_file_size: number | null;
-    output_file_path: string | null;
-    output_file_format: SysAsyncFileFormat | null;
-    output_file_size: number | null;
-    input_total_records: number | null;
-    output_total_records: number | null;
-    processed_records: number;
-    progress: number;
-    error_message: string | null;
-    error_records: any | null;
-    created_by: string | null;
-    priority: number;
-    retry_count: number;
-    max_retries: number;
-    parent_task_id: number | null;
-    created_at: Date | string | null;
-    started_at: Date | string | null;
-    updated_at: Date | string | null;
-    expired_at: Date | string | null;
-    completed_at: Date | string | null;
-    created_user_session: string;
-}
-export declare type SysAsyncTaskPartial = Partial<SysAsyncTaskEntity>;
-export declare enum SysAsyncTaskStatus {
-    PENDING = "PENDING",
-    RUNNING = "RUNNING",
-    SUCCEEDED = "SUCCEEDED",
-    PART_SUCCEEDED = "PART_SUCCEEDED",
-    FAILED = "FAILED",
-    CANCELLED = "CANCELLED",
-    PAUSED = "PAUSED"
-}
-/**
- * 导出的文件名后缀
- */
-export declare enum SysAsyncFileFormat {
-    XLSX = "xlsx",
-    CSV = "csv",
-    JSON = "json",
-    PDF = "pdf",
-    TXT = "txt",
-    XML = "xml",
-    ZIP = "zip",
-    HTML = "html",
-    PNG = "png",
-    JPG = "jpg"
-}
-export interface ISysAsyncTaskHandler {
-    execute(asyncTaskContext: SysAsyncTaskContext): Promise<void>;
-}
-export interface SysAsyncTaskContext {
-    task: SysAsyncTaskEntity;
-    updateTaskStatus: (sysAsyncTaskPartial: SysAsyncTaskPartial) => any;
-}
-export interface SysAsyncTaskHandlerConfig {
-    taskType: string;
-    handler: ISysAsyncTaskHandler;
-    maxRetries?: number;
-    priority?: number;
-    expireSeconds?: number;
-}
-export declare const HEADER_KEY_RUN_BY_ASYNC_TASK_ID = "run-by-async-task-id";
-export declare const HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = "run-by-async-task-workbenchcode";
+export interface SysAsyncTaskEntity {
+    id: number;
+    task_uuid: string;
+    task_name: string;
+    task_description: string | null;
+    task_type: string;
+    task_status: SysAsyncTaskStatus;
+    input_params: any;
+    output_result: any | null;
+    input_file_path: string | null;
+    input_file_format: SysAsyncFileFormat | null;
+    input_file_size: number | null;
+    output_file_path: string | null;
+    output_file_format: SysAsyncFileFormat | null;
+    output_file_size: number | null;
+    input_total_records: number | null;
+    output_total_records: number | null;
+    processed_records: number;
+    progress: number;
+    error_message: string | null;
+    error_records: any | null;
+    created_by: string | null;
+    priority: number;
+    retry_count: number;
+    max_retries: number;
+    parent_task_id: number | null;
+    created_at: Date | string | null;
+    started_at: Date | string | null;
+    updated_at: Date | string | null;
+    expired_at: Date | string | null;
+    completed_at: Date | string | null;
+    created_user_session: string;
+}
+export declare type SysAsyncTaskPartial = Partial<SysAsyncTaskEntity>;
+export declare enum SysAsyncTaskStatus {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    SUCCEEDED = "SUCCEEDED",
+    PART_SUCCEEDED = "PART_SUCCEEDED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED",
+    PAUSED = "PAUSED"
+}
+/**
+ * 导出的文件名后缀
+ */
+export declare enum SysAsyncFileFormat {
+    XLSX = "xlsx",
+    CSV = "csv",
+    JSON = "json",
+    PDF = "pdf",
+    TXT = "txt",
+    XML = "xml",
+    ZIP = "zip",
+    HTML = "html",
+    PNG = "png",
+    JPG = "jpg"
+}
+export interface ISysAsyncTaskHandler {
+    execute(asyncTaskContext: SysAsyncTaskContext): Promise<void>;
+}
+export interface SysAsyncTaskContext {
+    task: SysAsyncTaskEntity;
+    updateTaskStatus: (sysAsyncTaskPartial: SysAsyncTaskPartial) => any;
+}
+export interface SysAsyncTaskHandlerConfig {
+    taskType: string;
+    handler: ISysAsyncTaskHandler;
+    maxRetries?: number;
+    priority?: number;
+    expireSeconds?: number;
+}
+export declare const HEADER_KEY_RUN_BY_ASYNC_TASK_ID = "run-by-async-task-id";
+export declare const HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = "run-by-async-task-workbenchcode";

package/dist/models/AsyncTaskModel.js

@@ -1,31 +1,31 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = exports.HEADER_KEY_RUN_BY_ASYNC_TASK_ID = exports.SysAsyncFileFormat = exports.SysAsyncTaskStatus = void 0;
-var SysAsyncTaskStatus;
-(function (SysAsyncTaskStatus) {
-    SysAsyncTaskStatus["PENDING"] = "PENDING";
-    SysAsyncTaskStatus["RUNNING"] = "RUNNING";
-    SysAsyncTaskStatus["SUCCEEDED"] = "SUCCEEDED";
-    SysAsyncTaskStatus["PART_SUCCEEDED"] = "PART_SUCCEEDED";
-    SysAsyncTaskStatus["FAILED"] = "FAILED";
-    SysAsyncTaskStatus["CANCELLED"] = "CANCELLED";
-    SysAsyncTaskStatus["PAUSED"] = "PAUSED";
-})(SysAsyncTaskStatus = exports.SysAsyncTaskStatus || (exports.SysAsyncTaskStatus = {}));
-/**
- * 导出的文件名后缀
- */
-var SysAsyncFileFormat;
-(function (SysAsyncFileFormat) {
-    SysAsyncFileFormat["XLSX"] = "xlsx";
-    SysAsyncFileFormat["CSV"] = "csv";
-    SysAsyncFileFormat["JSON"] = "json";
-    SysAsyncFileFormat["PDF"] = "pdf";
-    SysAsyncFileFormat["TXT"] = "txt";
-    SysAsyncFileFormat["XML"] = "xml";
-    SysAsyncFileFormat["ZIP"] = "zip";
-    SysAsyncFileFormat["HTML"] = "html";
-    SysAsyncFileFormat["PNG"] = "png";
-    SysAsyncFileFormat["JPG"] = "jpg";
-})(SysAsyncFileFormat = exports.SysAsyncFileFormat || (exports.SysAsyncFileFormat = {}));
-exports.HEADER_KEY_RUN_BY_ASYNC_TASK_ID = 'run-by-async-task-id';
-exports.HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = 'run-by-async-task-workbenchcode';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = exports.HEADER_KEY_RUN_BY_ASYNC_TASK_ID = exports.SysAsyncFileFormat = exports.SysAsyncTaskStatus = void 0;
+var SysAsyncTaskStatus;
+(function (SysAsyncTaskStatus) {
+    SysAsyncTaskStatus["PENDING"] = "PENDING";
+    SysAsyncTaskStatus["RUNNING"] = "RUNNING";
+    SysAsyncTaskStatus["SUCCEEDED"] = "SUCCEEDED";
+    SysAsyncTaskStatus["PART_SUCCEEDED"] = "PART_SUCCEEDED";
+    SysAsyncTaskStatus["FAILED"] = "FAILED";
+    SysAsyncTaskStatus["CANCELLED"] = "CANCELLED";
+    SysAsyncTaskStatus["PAUSED"] = "PAUSED";
+})(SysAsyncTaskStatus = exports.SysAsyncTaskStatus || (exports.SysAsyncTaskStatus = {}));
+/**
+ * 导出的文件名后缀
+ */
+var SysAsyncFileFormat;
+(function (SysAsyncFileFormat) {
+    SysAsyncFileFormat["XLSX"] = "xlsx";
+    SysAsyncFileFormat["CSV"] = "csv";
+    SysAsyncFileFormat["JSON"] = "json";
+    SysAsyncFileFormat["PDF"] = "pdf";
+    SysAsyncFileFormat["TXT"] = "txt";
+    SysAsyncFileFormat["XML"] = "xml";
+    SysAsyncFileFormat["ZIP"] = "zip";
+    SysAsyncFileFormat["HTML"] = "html";
+    SysAsyncFileFormat["PNG"] = "png";
+    SysAsyncFileFormat["JPG"] = "jpg";
+})(SysAsyncFileFormat = exports.SysAsyncFileFormat || (exports.SysAsyncFileFormat = {}));
+exports.HEADER_KEY_RUN_BY_ASYNC_TASK_ID = 'run-by-async-task-id';
+exports.HEADER_KEY_RUN_BY_ASYNC_TASK_WORKBENCH_CODE = 'run-by-async-task-workbenchcode';