!90 feat: 完善用户分组管理功能

Merge pull request !90 from 子夜/feature/bpm

apps/web-antd/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 用户组 VO */
+  export interface UserGroupVO {
+    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.UserGroupVO>>(
+    '/bpm/user-group/page',
+    { params },
+  );
+}
+
+/** 查询用户组详情 */
+export async function getUserGroup(id: number) {
+  return requestClient.get<BpmUserGroupApi.UserGroupVO>(
+    `/bpm/user-group/get?id=${id}`,
+  );
+}
+
+/** 新增用户组 */
+export async function createUserGroup(data: BpmUserGroupApi.UserGroupVO) {
+  return requestClient.post<number>('/bpm/user-group/create', data);
+}
+
+/** 修改用户组 */
+export async function updateUserGroup(data: BpmUserGroupApi.UserGroupVO) {
+  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.UserGroupVO[]>(
+    `/bpm/user-group/simple-list`,
+  );
+}

apps/web-antd/src/views/bpm/group/data.ts

@@ -0,0 +1,171 @@
+import type { VbenFormSchema } from '#/adapter/form';
+import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
+import type { BpmCategoryApi } from '#/api/bpm/category';
+
+import { useAccess } from '@vben/access';
+
+import { z } from '#/adapter/form';
+import { getSimpleUserList } from '#/api/system/user';
+import { CommonStatusEnum } from '#/utils/constants';
+import { DICT_TYPE, getDictOptions } from '#/utils/dict';
+
+const { hasAccessByCodes } = useAccess();
+/** 新增/修改的表单 */
+export function useFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'id',
+      component: 'Input',
+      dependencies: {
+        triggerFields: [''],
+        show: () => false,
+      },
+    },
+    {
+      fieldName: 'name',
+      label: '组名',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入组名',
+      },
+      rules: 'required',
+    },
+    {
+      fieldName: 'description',
+      label: '描述',
+      component: 'Textarea',
+      componentProps: {
+        placeholder: '请输入描述',
+      },
+    },
+    {
+      fieldName: 'userIds',
+      label: '成员',
+      component: 'ApiSelect',
+      componentProps: {
+        placeholder: '请选择成员',
+        api: getSimpleUserList,
+        labelField: 'nickname',
+        valueField: 'id',
+        mode: 'tags',
+      },
+      rules: z.array(z.number()).min(1, '请选择成员').default([]),
+    },
+    {
+      fieldName: 'status',
+      label: '状态',
+      component: 'RadioGroup',
+      componentProps: {
+        options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
+        buttonStyle: 'solid',
+        optionType: 'button',
+      },
+      rules: z.number().default(CommonStatusEnum.ENABLE),
+    },
+  ];
+}
+
+/** 列表的搜索表单 */
+export function useGridFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'name',
+      label: '组名',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入组名',
+        allowClear: true,
+      },
+    },
+    {
+      fieldName: 'status',
+      label: '状态',
+      component: 'Select',
+      componentProps: {
+        placeholder: '请选择状态',
+        options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
+        allowClear: true,
+      },
+    },
+    {
+      fieldName: 'createTime',
+      label: '创建时间',
+      component: 'RangePicker',
+      componentProps: {
+        placeholder: ['开始时间', '结束时间'],
+        allowClear: true,
+      },
+    },
+  ];
+}
+
+/** 列表的字段 */
+export function useGridColumns<T = BpmCategoryApi.CategoryVO>(
+  onActionClick: OnActionClickFn<T>,
+): VxeTableGridOptions['columns'] {
+  return [
+    {
+      field: 'id',
+      title: '编号',
+      minWidth: 100,
+    },
+    {
+      field: 'name',
+      title: '组名',
+      minWidth: 200,
+    },
+    {
+      field: 'description',
+      title: '描述',
+      minWidth: 200,
+    },
+    {
+      field: 'userIds',
+      title: '成员',
+      minWidth: 200,
+      slots: {
+        default: 'userIds-cell',
+      },
+    },
+    {
+      field: 'status',
+      title: '状态',
+      minWidth: 100,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.COMMON_STATUS },
+      },
+    },
+    {
+      field: 'createTime',
+      title: '创建时间',
+      minWidth: 180,
+      formatter: 'formatDateTime',
+    },
+    {
+      field: 'operation',
+      title: '操作',
+      minWidth: 180,
+      align: 'center',
+      fixed: 'right',
+      cellRender: {
+        attrs: {
+          nameField: 'name',
+          nameTitle: '用户分组',
+          onClick: onActionClick,
+        },
+        name: 'CellOperation',
+        options: [
+          {
+            code: 'edit',
+            show: hasAccessByCodes(['bpm:user-group:update']),
+          },
+          {
+            code: 'delete',
+            show: hasAccessByCodes(['bpm:user-group:delete']),
+          },
+        ],
+      },
+    },
+  ];
+}

apps/web-antd/src/views/bpm/group/index.vue

@@ -1,31 +1,144 @@
 <script lang="ts" setup>
-import { Page } from '@vben/common-ui';
+import type {
+  OnActionClickParams,
+  VxeTableGridOptions,
+} from '#/adapter/vxe-table';
+import type { BpmUserGroupApi } from '#/api/bpm/userGroup';
+import type { SystemUserApi } from '#/api/system/user';
 
-import { Button } from 'ant-design-vue';
+import { onMounted, ref } from 'vue';
 
-import { DocAlert } from '#/components/doc-alert';
+import { Page, useVbenModal } from '@vben/common-ui';
+import { Plus } from '@vben/icons';
+
+import { Button, message } from 'ant-design-vue';
+
+import { useVbenVxeGrid } from '#/adapter/vxe-table';
+import { deleteUserGroup, getUserGroupPage } from '#/api/bpm/userGroup';
+import { getSimpleUserList } from '#/api/system/user';
+import { $t } from '#/locales';
+
+import { useGridColumns, useGridFormSchema } from './data';
+import Form from './modules/form.vue';
+
+const [FormModal, formModalApi] = useVbenModal({
+  connectedComponent: Form,
+  destroyOnClose: true,
+});
+const [Grid, gridApi] = useVbenVxeGrid({
+  formOptions: {
+    schema: useGridFormSchema(),
+  },
+  gridOptions: {
+    columns: useGridColumns(onActionClick),
+    height: 'auto',
+    keepSource: true,
+    proxyConfig: {
+      ajax: {
+        query: async ({ page }, formValues) => {
+          return await getUserGroupPage({
+            pageNo: page.currentPage,
+            pageSize: page.pageSize,
+            ...formValues,
+          });
+        },
+      },
+    },
+    rowConfig: {
+      keyField: 'id',
+    },
+    toolbarConfig: {
+      refresh: { code: 'query' },
+      search: true,
+    },
+  } as VxeTableGridOptions<BpmUserGroupApi.UserGroupVO>,
+});
+
+/** 表格操作按钮的回调函数 */
+function onActionClick({
+  code,
+  row,
+}: OnActionClickParams<BpmUserGroupApi.UserGroupVO>) {
+  switch (code) {
+    case 'delete': {
+      onDelete(row);
+      break;
+    }
+    case 'edit': {
+      onEdit(row);
+      break;
+    }
+  }
+}
+
+/** 刷新表格 */
+function onRefresh() {
+  gridApi.query();
+}
+
+/** 创建用户分组 */
+function onCreate() {
+  formModalApi.setData(null).open();
+}
+
+/** 编辑用户分组 */
+function onEdit(row: BpmUserGroupApi.UserGroupVO) {
+  formModalApi.setData(row).open();
+}
+
+/** 删除用户分组 */
+async function onDelete(row: BpmUserGroupApi.UserGroupVO) {
+  const hideLoading = message.loading({
+    content: $t('ui.actionMessage.deleting', [row.name]),
+    duration: 0,
+    key: 'action_process_msg',
+  });
+  try {
+    await deleteUserGroup(row.id as number);
+    message.success({
+      content: $t('ui.actionMessage.deleteSuccess', [row.name]),
+      key: 'action_process_msg',
+    });
+    onRefresh();
+  } catch {
+    hideLoading();
+  }
+}
+
+//
+const userList = ref<SystemUserApi.User[]>([]);
+/** 初始化 */
+onMounted(async () => {
+  // 加载用户列表
+  userList.value = await getSimpleUserList();
+});
 </script>
 
 <template>
-  <Page>
-    <DocAlert title="工作流手册" url="https://doc.iocoder.cn/bpm/" />
-    <Button
-      danger
-      type="link"
-      target="_blank"
-      href="https://github.com/yudaocode/yudao-ui-admin-vue3"
-    >
-      该功能支持 Vue3 + element-plus 版本！
-    </Button>
-    <br />
-    <Button
-      type="link"
-      target="_blank"
-      href="https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/src/views/bpm/group/index"
-    >
-      可参考
-      https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/src/views/bpm/group/index
-      代码，pull request 贡献给我们！
-    </Button>
+  <Page auto-content-height>
+    <FormModal @success="onRefresh" />
+    <Grid table-title="用户分组">
+      <template #toolbar-tools>
+        <Button
+          type="primary"
+          @click="onCreate"
+          v-access:code="['bpm:category:create']"
+        >
+          <Plus class="size-5" />
+          {{ $t('ui.actionTitle.create', ['用户分组']) }}
+        </Button>
+      </template>
+
+      <template #userIds-cell="{ row }">
+        <span
+          v-for="(userId, index) in row.userIds"
+          :key="userId"
+          class="pr-5px"
+        >
+          {{ userList.find((user) => user.id === userId)?.nickname }}
+          <span v-if="index < row.userIds.length - 1">、</span>
+        </span>
+      </template>
+    </Grid>
   </Page>
 </template>

apps/web-antd/src/views/bpm/group/modules/form.vue

@@ -0,0 +1,91 @@
+<script lang="ts" setup>
+import type { BpmUserGroupApi } from '#/api/bpm/userGroup';
+
+import { computed, ref } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+
+import { message } from 'ant-design-vue';
+
+import { useVbenForm } from '#/adapter/form';
+import {
+  createUserGroup,
+  getUserGroup,
+  updateUserGroup,
+} from '#/api/bpm/userGroup';
+import { $t } from '#/locales';
+
+import { useFormSchema } from '../data';
+
+const emit = defineEmits(['success']);
+const formData = ref<BpmUserGroupApi.UserGroupVO>();
+const getTitle = computed(() => {
+  return formData.value?.id
+    ? $t('ui.actionTitle.edit', ['用户分组'])
+    : $t('ui.actionTitle.create', ['用户分组']);
+});
+
+const [Form, formApi] = useVbenForm({
+  commonConfig: {
+    componentProps: {
+      class: 'w-full',
+    },
+    formItemClass: 'col-span-2',
+    labelWidth: 100,
+  },
+  layout: 'horizontal',
+  schema: useFormSchema(),
+  showDefaultActions: false,
+});
+
+const [Modal, modalApi] = useVbenModal({
+  async onConfirm() {
+    const { valid } = await formApi.validate();
+    if (!valid) {
+      return;
+    }
+    modalApi.lock();
+    // 提交表单
+    const data = (await formApi.getValues()) as BpmUserGroupApi.UserGroupVO;
+    try {
+      await (formData.value?.id
+        ? updateUserGroup(data)
+        : createUserGroup(data));
+      // 关闭并提示
+      await modalApi.close();
+      emit('success');
+      message.success({
+        content: $t('ui.actionMessage.operationSuccess'),
+        key: 'action_process_msg',
+      });
+    } finally {
+      modalApi.unlock();
+    }
+  },
+  async onOpenChange(isOpen: boolean) {
+    if (!isOpen) {
+      formData.value = undefined;
+      return;
+    }
+    // 加载数据
+    const data = modalApi.getData<BpmUserGroupApi.UserGroupVO>();
+    if (!data || !data.id) {
+      return;
+    }
+    modalApi.lock();
+    try {
+      formData.value = await getUserGroup(data.id as number);
+      // 设置到 values
+      await formApi.setValues(formData.value);
+    } finally {
+      modalApi.unlock();
+    }
+  },
+});
+</script>
+
+<template>
+  <Modal :title="getTitle">
+    <Form class="mx-4" />
+  </Modal>
+</template>