feat: 新增api接口文件

apps/web-ele/src/api/bpm/category/index.ts

@@ -0,0 +1,60 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+export namespace BpmCategoryApi {
+  /** 流程分类 */
+  export interface Category {
+    id: number;
+    name: string;
+    code: string;
+    status: number;
+    description?: string;
+    sort: number; // 分类排序
+  }
+}
+
+/** 查询流程分类分页 */
+export async function getCategoryPage(params: PageParam) {
+  return requestClient.get<PageResult<BpmCategoryApi.Category>>(
+    '/bpm/category/page',
+    { params },
+  );
+}
+
+/** 查询流程分类详情 */
+export async function getCategory(id: number) {
+  return requestClient.get<BpmCategoryApi.Category>(
+    `/bpm/category/get?id=${id}`,
+  );
+}
+
+/** 新增流程分类 */
+export async function createCategory(data: BpmCategoryApi.Category) {
+  return requestClient.post<number>('/bpm/category/create', data);
+}
+
+/** 修改流程分类 */
+export async function updateCategory(data: BpmCategoryApi.Category) {
+  return requestClient.put<boolean>('/bpm/category/update', data);
+}
+
+/** 删除流程分类 */
+export async function deleteCategory(id: number) {
+  return requestClient.delete<boolean>(`/bpm/category/delete?id=${id}`);
+}
+
+/** 查询流程分类列表 */
+export async function getCategorySimpleList() {
+  return requestClient.get<BpmCategoryApi.Category[]>(
+    `/bpm/category/simple-list`,
+  );
+}
+
+/** 批量修改流程分类的排序 */
+export async function updateCategorySortBatch(ids: number[]) {
+  const params = ids.join(',');
+  return requestClient.put<boolean>(
+    `/bpm/category/update-sort-batch?ids=${params}`,
+  );
+}

apps/web-ele/src/api/bpm/definition/index.ts

@@ -0,0 +1,53 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+export namespace BpmProcessDefinitionApi {
+  /** 流程定义 */
+  export interface ProcessDefinition {
+    id: string;
+    version: number;
+    deploymentTime: number;
+    suspensionState: number;
+    modelType: number;
+    modelId: string;
+    formType?: number;
+    bpmnXml?: string;
+    simpleModel?: string;
+    formFields?: string[];
+  }
+}
+
+/** 查询流程定义 */
+export async function getProcessDefinition(id?: string, key?: string) {
+  return requestClient.get<BpmProcessDefinitionApi.ProcessDefinition>(
+    '/bpm/process-definition/get',
+    {
+      params: { id, key },
+    },
+  );
+}
+
+/** 分页查询流程定义 */
+export async function getProcessDefinitionPage(params: PageParam) {
+  return requestClient.get<
+    PageResult<BpmProcessDefinitionApi.ProcessDefinition>
+  >('/bpm/process-definition/page', { params });
+}
+
+/** 查询流程定义列表 */
+export async function getProcessDefinitionList(params: any) {
+  return requestClient.get<BpmProcessDefinitionApi.ProcessDefinition[]>(
+    '/bpm/process-definition/list',
+    {
+      params,
+    },
+  );
+}
+
+/** 查询流程定义列表（简单列表） */
+export async function getSimpleProcessDefinitionList() {
+  return requestClient.get<
+    PageResult<BpmProcessDefinitionApi.ProcessDefinition>
+  >('/bpm/process-definition/simple-list');
+}

apps/web-ele/src/api/bpm/form/index.ts

@@ -0,0 +1,48 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+export namespace BpmFormApi {
+  /** 流程表单 */
+  export interface Form {
+    id?: number | undefined;
+    name: string;
+    conf: string;
+    fields: string[];
+    status: number;
+    remark: string;
+    createTime: number;
+  }
+}
+
+/** 获取表单分页列表 */
+export async function getFormPage(params: PageParam) {
+  return requestClient.get<PageResult<BpmFormApi.Form>>('/bpm/form/page', {
+    params,
+  });
+}
+
+/** 获取表单详情 */
+export async function getFormDetail(id: number) {
+  return requestClient.get<BpmFormApi.Form>(`/bpm/form/get?id=${id}`);
+}
+
+/** 创建表单 */
+export async function createForm(data: BpmFormApi.Form) {
+  return requestClient.post('/bpm/form/create', data);
+}
+
+/** 更新表单 */
+export async function updateForm(data: BpmFormApi.Form) {
+  return requestClient.put('/bpm/form/update', data);
+}
+
+/** 删除表单 */
+export async function deleteForm(id: number) {
+  return requestClient.delete(`/bpm/form/delete?id=${id}`);
+}
+
+/** 获取表单简单列表 */
+export async function getFormSimpleList() {
+  return requestClient.get<BpmFormApi.Form[]>('/bpm/form/simple-list');
+}

apps/web-ele/src/api/bpm/model/index.ts

@@ -0,0 +1,111 @@
+import { requestClient } from '#/api/request';
+
+export namespace BpmModelApi {
+  /** 用户信息 TODO 这个是不是可以抽取出来定义在公共模块 */
+  // TODO @芋艿：一起看看。
+  export interface UserInfo {
+    id: number;
+    nickname: string;
+    avatar?: string;
+    deptId?: number;
+    deptName?: string;
+  }
+
+  /** 流程定义 */
+  export interface ProcessDefinition {
+    id: string;
+    key?: string;
+    version: number;
+    deploymentTime: number;
+    suspensionState: number;
+    formType?: number;
+    formCustomViewPath?: string;
+  }
+
+  /** 流程模型 */
+  export interface Model {
+    id: number;
+    key: string;
+    name: string;
+    icon?: string;
+    description: string;
+    category: string;
+    formName: string;
+    formType: number;
+    formId: number;
+    formCustomCreatePath: string;
+    formCustomViewPath: string;
+    processDefinition: ProcessDefinition;
+    status: number;
+    remark: string;
+    createTime: string;
+    bpmnXml: string;
+    startUsers?: UserInfo[];
+  }
+}
+
+/** 模型分类信息 */
+export interface ModelCategoryInfo {
+  id: number;
+  name: string;
+  modelList: BpmModelApi.Model[];
+}
+
+/** 获取流程模型列表 */
+export async function getModelList(name: string | undefined) {
+  return requestClient.get<BpmModelApi.Model[]>('/bpm/model/list', {
+    params: { name },
+  });
+}
+
+/** 获取流程模型详情 */
+export async function getModel(id: string) {
+  return requestClient.get<BpmModelApi.Model>(`/bpm/model/get?id=${id}`);
+}
+
+/** 更新流程模型 */
+export async function updateModel(data: BpmModelApi.Model) {
+  return requestClient.put('/bpm/model/update', data);
+}
+
+/** 批量修改流程模型排序 */
+export async function updateModelSortBatch(ids: number[]) {
+  const params = ids.join(',');
+  return requestClient.put<boolean>(
+    `/bpm/model/update-sort-batch?ids=${params}`,
+  );
+}
+
+/** 更新流程模型的 BPMN XML */
+export async function updateModelBpmn(data: BpmModelApi.Model) {
+  return requestClient.put('/bpm/model/update-bpmn', data);
+}
+
+/** 更新流程模型状态 */
+export async function updateModelState(id: number, state: number) {
+  const data = {
+    id,
+    state,
+  };
+  return requestClient.put('/bpm/model/update-state', data);
+}
+
+/** 创建流程模型 */
+export async function createModel(data: BpmModelApi.Model) {
+  return requestClient.post('/bpm/model/create', data);
+}
+
+/** 删除流程模型 */
+export async function deleteModel(id: number) {
+  return requestClient.delete(`/bpm/model/delete?id=${id}`);
+}
+
+/** 部署流程模型 */
+export async function deployModel(id: number) {
+  return requestClient.post(`/bpm/model/deploy?id=${id}`);
+}
+
+/** 清理流程模型 */
+export async function cleanModel(id: number) {
+  return requestClient.delete(`/bpm/model/clean?id=${id}`);
+}

apps/web-ele/src/api/bpm/oa/leave/index.ts

@@ -0,0 +1,40 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+export namespace BpmOALeaveApi {
+  export interface Leave {
+    id: number;
+    status: number;
+    type: number;
+    reason: string;
+    processInstanceId: string;
+    startTime: number;
+    endTime: number;
+    createTime: Date;
+    startUserSelectAssignees?: Record<string, string[]>;
+  }
+}
+
+/** 创建请假申请 */
+export async function createLeave(data: BpmOALeaveApi.Leave) {
+  return requestClient.post('/bpm/oa/leave/create', data);
+}
+
+/** 更新请假申请 */
+export async function updateLeave(data: BpmOALeaveApi.Leave) {
+  return requestClient.post('/bpm/oa/leave/update', data);
+}
+
+/** 获得请假申请 */
+export async function getLeave(id: number) {
+  return requestClient.get<BpmOALeaveApi.Leave>(`/bpm/oa/leave/get?id=${id}`);
+}
+
+/** 获得请假申请分页 */
+export async function getLeavePage(params: PageParam) {
+  return requestClient.get<PageResult<BpmOALeaveApi.Leave>>(
+    '/bpm/oa/leave/page',
+    { params },
+  );
+}

apps/web-ele/src/api/bpm/processExpression/index.ts

@@ -0,0 +1,53 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+export namespace BpmProcessExpressionApi {
+  /** 流程表达式 */
+  export interface ProcessExpression {
+    id: number; // 编号
+    name: string; // 表达式名字
+    status: number; // 表达式状态
+    expression: string; // 表达式
+  }
+}
+
+/** 查询流程表达式分页 */
+export async function getProcessExpressionPage(params: PageParam) {
+  return requestClient.get<
+    PageResult<BpmProcessExpressionApi.ProcessExpression>
+  >('/bpm/process-expression/page', { params });
+}
+
+/** 查询流程表达式详情 */
+export async function getProcessExpression(id: number) {
+  return requestClient.get<BpmProcessExpressionApi.ProcessExpression>(
+    `/bpm/process-expression/get?id=${id}`,
+  );
+}
+
+/** 新增流程表达式 */
+export async function createProcessExpression(
+  data: BpmProcessExpressionApi.ProcessExpression,
+) {
+  return requestClient.post<number>('/bpm/process-expression/create', data);
+}
+
+/** 修改流程表达式 */
+export async function updateProcessExpression(
+  data: BpmProcessExpressionApi.ProcessExpression,
+) {
+  return requestClient.put<boolean>('/bpm/process-expression/update', data);
+}
+
+/** 删除流程表达式 */
+export async function deleteProcessExpression(id: number) {
+  return requestClient.delete<boolean>(
+    `/bpm/process-expression/delete?id=${id}`,
+  );
+}
+
+/** 导出流程表达式 */
+export async function exportProcessExpression(params: any) {
+  return requestClient.download('/bpm/process-expression/export-excel', params);
+}

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

@@ -0,0 +1,197 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import type { BpmTaskApi } from '../task';
+
+import type { BpmModelApi } from '#/api/bpm/model';
+import type { BpmCandidateStrategyEnum, BpmNodeTypeEnum } from '#/utils';
+
+import { requestClient } from '#/api/request';
+
+export namespace BpmProcessInstanceApi {
+  // TODO @芋艿：一些注释缺少或者不对；
+  export interface Task {
+    id: number;
+    name: string;
+  }
+
+  export interface User {
+    avatar: 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: number;
+    name: string;
+    nodeType: BpmNodeTypeEnum;
+    startTime?: Date;
+    status: number;
+    tasks: ApprovalTaskInfo[];
+  }
+
+  /** 流程实例 */
+  export interface ProcessInstance {
+    businessKey: string;
+    category: string;
+    createTime: string;
+    endTime: string;
+    fields: string[];
+    formVariables: Record<string, any>;
+    id: number;
+    name: string;
+    processDefinition?: BpmModelApi.ProcessDefinition;
+    processDefinitionId: string;
+    remark: string;
+    result: number;
+    startTime?: Date;
+    startUser?: User;
+    status: number;
+    tasks?: BpmProcessInstanceApi.Task[];
+  }
+
+  // 审批详情
+  export interface ApprovalDetail {
+    activityNodes: BpmProcessInstanceApi.ApprovalNodeInfo[];
+    formFieldsPermission: any;
+    processDefinition: BpmModelApi.ProcessDefinition;
+    processInstance: BpmProcessInstanceApi.ProcessInstance;
+    status: number;
+    todoTask: BpmTaskApi.Task;
+  }
+
+  // 抄送流程实例
+  export interface Copy {
+    activityId: string;
+    activityName: string;
+    createTime: number;
+    createUser: User;
+    id: number;
+    processInstanceId: string;
+    processInstanceName: string;
+    processInstanceStartTime: number;
+    reason: string;
+    startUser: User;
+    summary: {
+      key: string;
+      value: string;
+    }[];
+    taskId: string;
+  }
+}
+
+/** 查询我的流程实例分页 */
+export async function getProcessInstanceMyPage(params: PageParam) {
+  return requestClient.get<PageResult<BpmProcessInstanceApi.ProcessInstance>>(
+    '/bpm/process-instance/my-page',
+    { params },
+  );
+}
+
+/** 查询管理员流程实例分页 */
+export async function getProcessInstanceManagerPage(params: PageParam) {
+  return requestClient.get<PageResult<BpmProcessInstanceApi.ProcessInstance>>(
+    '/bpm/process-instance/manager-page',
+    { params },
+  );
+}
+
+/** 新增流程实例 */
+export async function createProcessInstance(data: any) {
+  return requestClient.post<BpmProcessInstanceApi.ProcessInstance>(
+    '/bpm/process-instance/create',
+    data,
+  );
+}
+
+/** 申请人主动取消流程实例 */
+export async function cancelProcessInstanceByStartUser(
+  id: number,
+  reason: string,
+) {
+  return requestClient.delete<boolean>(
+    '/bpm/process-instance/cancel-by-start-user',
+    {
+      data: { id, reason },
+    },
+  );
+}
+
+/** 管理员取消流程实例 */
+export async function cancelProcessInstanceByAdmin(id: number, reason: string) {
+  return requestClient.delete<boolean>(
+    '/bpm/process-instance/cancel-by-admin',
+    {
+      data: { id, reason },
+    },
+  );
+}
+
+/** 查询流程实例详情 */
+export async function getProcessInstance(id: number) {
+  return requestClient.get<BpmProcessInstanceApi.ProcessInstance>(
+    `/bpm/process-instance/get?id=${id}`,
+  );
+}
+
+/** 查询复制流程实例分页 */
+export async function getProcessInstanceCopyPage(params: PageParam) {
+  return requestClient.get<PageResult<BpmProcessInstanceApi.ProcessInstance>>(
+    '/bpm/process-instance/copy/page',
+    { params },
+  );
+}
+
+/** 更新流程实例 */
+export async function updateProcessInstance(
+  data: BpmProcessInstanceApi.ProcessInstance,
+) {
+  return requestClient.put<BpmProcessInstanceApi.ProcessInstance>(
+    '/bpm/process-instance/update',
+    data,
+  );
+}
+
+/** 获取审批详情 */
+export async function getApprovalDetail(params: any) {
+  return requestClient.get<BpmProcessInstanceApi.ApprovalDetail>(
+    `/bpm/process-instance/get-approval-detail`,
+    { params },
+  );
+}
+
+/** 获取下一个执行的流程节点 */
+export async function getNextApprovalNodes(params: any) {
+  return requestClient.get<BpmProcessInstanceApi.ApprovalNodeInfo[]>(
+    `/bpm/process-instance/get-next-approval-nodes`,
+    { params },
+  );
+}
+
+/** 获取表单字段权限 */
+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>(
+    `/bpm/process-instance/get-bpmn-model-view?id=${id}`,
+  );
+}

apps/web-ele/src/api/bpm/processListener/index.ts

@@ -0,0 +1,50 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+export namespace BpmProcessListenerApi {
+  /** BPM 流程监听器 */
+  export interface ProcessListener {
+    id: number; // 编号
+    name: string; // 监听器名字
+    type: string; // 监听器类型
+    status: number; // 监听器状态
+    event: string; // 监听事件
+    valueType: string; // 监听器值类型
+    value: string; // 监听器值
+  }
+}
+
+/** 查询流程监听器分页 */
+export async function getProcessListenerPage(params: PageParam) {
+  return requestClient.get<PageResult<BpmProcessListenerApi.ProcessListener>>(
+    '/bpm/process-listener/page',
+    { params },
+  );
+}
+
+/** 查询流程监听器详情 */
+export async function getProcessListener(id: number) {
+  return requestClient.get<BpmProcessListenerApi.ProcessListener>(
+    `/bpm/process-listener/get?id=${id}`,
+  );
+}
+
+/** 新增流程监听器 */
+export async function createProcessListener(
+  data: BpmProcessListenerApi.ProcessListener,
+) {
+  return requestClient.post<number>('/bpm/process-listener/create', data);
+}
+
+/** 修改流程监听器 */
+export async function updateProcessListener(
+  data: BpmProcessListenerApi.ProcessListener,
+) {
+  return requestClient.put<boolean>('/bpm/process-listener/update', data);
+}
+
+/** 删除流程监听器 */
+export async function deleteProcessListener(id: number) {
+  return requestClient.delete<boolean>(`/bpm/process-listener/delete?id=${id}`);
+}

apps/web-ele/src/api/bpm/task/index.ts

@@ -0,0 +1,132 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import type { BpmProcessInstanceApi } from '../processInstance';
+
+import { requestClient } from '#/api/request';
+
+export namespace BpmTaskApi {
+  /** BPM 流程监听器 */
+  export interface Task {
+    id: number; // 编号
+    name: string; // 监听器名字
+    type: string; // 监听器类型
+    status: number; // 监听器状态
+    event: string; // 监听事件
+    valueType: string; // 监听器值类型
+  }
+
+  // 流程任务
+  export interface TaskManager {
+    id: string; // 编号
+    name: string; // 任务名称
+    createTime: number; // 创建时间
+    endTime: number; // 结束时间
+    durationInMillis: number; // 持续时间
+    status: number; // 状态
+    reason: string; // 原因
+    ownerUser: any; // 负责人
+    assigneeUser: any; // 处理人
+    taskDefinitionKey: string; // 任务定义key
+    processInstanceId: string; // 流程实例id
+    processInstance: BpmProcessInstanceApi.ProcessInstance; // 流程实例
+    parentTaskId: any; // 父任务id
+    children: any; // 子任务
+    formId: any; // 表单id
+    formName: any; // 表单名称
+    formConf: any; // 表单配置
+    formFields: any; // 表单字段
+    formVariables: any; // 表单变量
+    buttonsSetting: any; // 按钮设置
+    signEnable: any; // 签名设置
+    reasonRequire: any; // 原因设置
+    nodeType: any; // 节点类型
+  }
+}
+
+/** 查询待办任务分页 */
+export async function getTaskTodoPage(params: PageParam) {
+  return requestClient.get<PageResult<BpmTaskApi.Task>>('/bpm/task/todo-page', {
+    params,
+  });
+}
+
+/** 查询已办任务分页 */
+export async function getTaskDonePage(params: PageParam) {
+  return requestClient.get<PageResult<BpmTaskApi.Task>>('/bpm/task/done-page', {
+    params,
+  });
+}
+
+/** 查询任务管理分页 */
+export async function getTaskManagerPage(params: PageParam) {
+  return requestClient.get<PageResult<BpmTaskApi.Task>>(
+    '/bpm/task/manager-page',
+    { params },
+  );
+}
+
+/** 审批任务 */
+export const approveTask = async (data: any) => {
+  return await requestClient.put('/bpm/task/approve', data);
+};
+
+/** 驳回任务 */
+export const rejectTask = async (data: any) => {
+  return await requestClient.put('/bpm/task/reject', data);
+};
+
+/** 根据流程实例 ID 查询任务列表 */
+export const getTaskListByProcessInstanceId = async (id: string) => {
+  return await requestClient.get(
+    `/bpm/task/list-by-process-instance-id?processInstanceId=${id}`,
+  );
+};
+
+/** 获取所有可退回的节点 */
+export const getTaskListByReturn = async (id: string) => {
+  return await requestClient.get(`/bpm/task/list-by-return?id=${id}`);
+};
+
+/** 退回 */
+export const returnTask = async (data: any) => {
+  return await requestClient.put('/bpm/task/return', data);
+};
+
+// 委派
+export const delegateTask = async (data: any) => {
+  return await requestClient.put('/bpm/task/delegate', data);
+};
+
+// 转派
+export const transferTask = async (data: any) => {
+  return await requestClient.put('/bpm/task/transfer', data);
+};
+
+// 加签
+export const signCreateTask = async (data: any) => {
+  return await requestClient.put('/bpm/task/create-sign', data);
+};
+
+// 减签
+export const signDeleteTask = async (data: any) => {
+  return await requestClient.delete('/bpm/task/delete-sign', data);
+};
+
+// 抄送
+export const copyTask = async (data: any) => {
+  return await requestClient.put('/bpm/task/copy', data);
+};
+
+// 获取我的待办任务
+export const myTodoTask = async (processInstanceId: string) => {
+  return await requestClient.get(
+    `/bpm/task/my-todo?processInstanceId=${processInstanceId}`,
+  );
+};
+
+// 获取加签任务列表
+export const getChildrenTaskList = async (id: string) => {
+  return await requestClient.get(
+    `/bpm/task/list-by-parent-task-id?parentTaskId=${id}`,
+  );
+};

apps/web-ele/src/api/bpm/userGroup/index.ts

@@ -0,0 +1,53 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+export namespace BpmUserGroupApi {
+  /** BPM 用户组 */
+  export interface UserGroup {
+    id: number;
+    name: string;
+    description: string;
+    userIds: number[];
+    status: number;
+    remark: string;
+    createTime: string;
+  }
+}
+
+/** 查询用户组分页 */
+export async function getUserGroupPage(params: PageParam) {
+  return requestClient.get<PageResult<BpmUserGroupApi.UserGroup>>(
+    '/bpm/user-group/page',
+    { params },
+  );
+}
+
+/** 查询用户组详情 */
+export async function getUserGroup(id: number) {
+  return requestClient.get<BpmUserGroupApi.UserGroup>(
+    `/bpm/user-group/get?id=${id}`,
+  );
+}
+
+/** 新增用户组 */
+export async function createUserGroup(data: BpmUserGroupApi.UserGroup) {
+  return requestClient.post<number>('/bpm/user-group/create', data);
+}
+
+/** 修改用户组 */
+export async function updateUserGroup(data: BpmUserGroupApi.UserGroup) {
+  return requestClient.put<boolean>('/bpm/user-group/update', data);
+}
+
+/** 删除用户组 */
+export async function deleteUserGroup(id: number) {
+  return requestClient.delete<boolean>(`/bpm/user-group/delete?id=${id}`);
+}
+
+/** 查询用户组列表 */
+export async function getUserGroupSimpleList() {
+  return requestClient.get<BpmUserGroupApi.UserGroup[]>(
+    `/bpm/user-group/simple-list`,
+  );
+}