feat：【antd】【mp】优化 api 的注释

apps/web-antd/src/api/bpm/processInstance/index.ts

@@ -11,44 +11,6 @@ import type { BpmModelApi } from '#/api/bpm/model';
 import { requestClient } from '#/api/request';
 
 export namespace BpmProcessInstanceApi {
-  // TODO @芋艿：一些注释缺少或者不对；
-  export interface Task {
-    id: number;
-    name: string;
-    assigneeUser?: User;
-  }
-
-  export interface User {
-    avatar: string;
-    deptName?: string;
-    id: number;
-    nickname: string;
-  }
-
-  // 审批任务信息
-  export interface ApprovalTaskInfo {
-    assigneeUser: User;
-    id: number;
-    ownerUser: User;
-    reason: string;
-    signPicUrl: string;
-    status: number;
-  }
-
-  // 审批节点信息
-  export interface ApprovalNodeInfo {
-    candidateStrategy?: BpmCandidateStrategyEnum;
-    candidateUsers?: User[];
-    endTime?: Date;
-    id: string;
-    name: string;
-    nodeType: BpmNodeTypeEnum;
-    startTime?: Date;
-    status: number;
-    processInstanceId?: string;
-    tasks: ApprovalTaskInfo[];
-  }
-
   /** 流程实例 */
   export interface ProcessInstance {
     businessKey: string;
@@ -74,8 +36,23 @@ export namespace BpmProcessInstanceApi {
     tasks?: BpmProcessInstanceApi.Task[];
   }
 
-  // 审批详情
-  export interface ApprovalDetail {
+  /** 流程实例的任务 */
+  export interface Task {
+    id: number;
+    name: string;
+    assigneeUser?: User;
+  }
+
+  /** 流程实例的用户信息 */
+  export interface User {
+    id: number;
+    nickname: string;
+    avatar: string;
+    deptName?: string;
+  }
+
+  /** 审批详情 */
+  export interface ApprovalDetailRespVO {
     activityNodes: BpmProcessInstanceApi.ApprovalNodeInfo[];
     formFieldsPermission: any;
     processDefinition: BpmModelApi.ProcessDefinition;
@@ -84,8 +61,32 @@ export namespace BpmProcessInstanceApi {
     todoTask: BpmTaskApi.Task;
   }
 
-  // 抄送流程实例
-  export interface Copy {
+  /** 审批详情的节点信息 */
+  export interface ApprovalNodeInfo {
+    candidateStrategy?: BpmCandidateStrategyEnum;
+    candidateUsers?: User[];
+    endTime?: Date;
+    id: string;
+    name: string;
+    nodeType: BpmNodeTypeEnum;
+    startTime?: Date;
+    status: number;
+    processInstanceId?: string;
+    tasks: ApprovalTaskInfo[];
+  }
+
+  /** 审批详情的节点的任务 */
+  export interface ApprovalTaskInfo {
+    id: number;
+    assigneeUser: User;
+    ownerUser: User;
+    reason: string;
+    signPicUrl: string;
+    status: number;
+  }
+
+  /** 抄送流程实例 */
+  export interface ProcessInstanceCopyRespVO {
     activityId: string;
     activityName: string;
     createTime: number;
@@ -103,20 +104,17 @@ export namespace BpmProcessInstanceApi {
     taskId: string;
   }
 
-  /** 打印数据任务信息 */
-  export interface PrintTask {
-    description: string;
-    id: number;
-    name: string;
-    signPicUrl?: string;
-  }
-
-  /** 打印数据 */
-  export interface PrintData {
+  /** 流程实例的打印数据响应 */
+  export interface ProcessPrintDataRespVO {
     printTemplateEnable: boolean;
     printTemplateHtml?: string;
     processInstance: ProcessInstance;
-    tasks: PrintTask[];
+    tasks: {
+      description: string;
+      id: number;
+      name: string;
+      signPicUrl?: string;
+    }[];
   }
 }
 
@@ -194,7 +192,7 @@ export async function updateProcessInstance(
 
 /** 获取审批详情 */
 export async function getApprovalDetail(params: any) {
-  return requestClient.get<BpmProcessInstanceApi.ApprovalDetail>(
+  return requestClient.get<BpmProcessInstanceApi.ApprovalDetailRespVO>(
     `/bpm/process-instance/get-approval-detail`,
     { params },
   );
@@ -208,14 +206,6 @@ export async function getNextApprovalNodes(params: any) {
   );
 }
 
-/** 获取表单字段权限 */
-export async function getFormFieldsPermission(params: any) {
-  return requestClient.get<BpmProcessInstanceApi.ProcessInstance>(
-    `/bpm/process-instance/get-form-fields-permission`,
-    { params },
-  );
-}
-
 /** 获取流程实例 BPMN 模型视图 */
 export async function getProcessInstanceBpmnModelView(id: string) {
   return requestClient.get<BpmProcessInstanceApi.ProcessInstance>(
@@ -225,7 +215,7 @@ export async function getProcessInstanceBpmnModelView(id: string) {
 
 /** 获取流程实例打印数据 */
 export async function getProcessInstancePrintData(id: string) {
-  return requestClient.get<BpmProcessInstanceApi.PrintData>(
+  return requestClient.get<BpmProcessInstanceApi.ProcessPrintDataRespVO>(
     `/bpm/process-instance/get-print-data?processInstanceId=${id}`,
   );
 }