feat: 添加客户管理模块

apps/web-antd/src/api/license/customer/index.ts

@@ -0,0 +1,54 @@
+import type { PageParam, PageResult } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+export namespace CustomerApi {
+  /** 客户信息 */
+  export interface Customer {
+    id: number; // 主键
+    name?: string; // 客户名称
+    code?: string; // 客户编号
+    type?: number; // 客户类型
+    areaId?: number; // 地区
+    contacts?: string; // 联系人
+    role: string; // 角色
+    phone: string; // 联系电话
+    email: string; // 邮箱
+    remark: string; // 备注
+  }
+}
+
+/** 查询客户分页 */
+export function getCustomerPage(params: PageParam) {
+  return requestClient.get<PageResult<CustomerApi.Customer>>(
+    '/license/customer/page',
+    { params },
+  );
+}
+
+/** 查询客户详情 */
+export function getCustomer(id: number) {
+  return requestClient.get<CustomerApi.Customer>(
+    `/license/customer/get?id=${id}`,
+  );
+}
+
+/** 新增客户 */
+export function createCustomer(data: CustomerApi.Customer) {
+  return requestClient.post('/license/customer/create', data);
+}
+
+/** 修改客户 */
+export function updateCustomer(data: CustomerApi.Customer) {
+  return requestClient.put('/license/customer/update', data);
+}
+
+/** 删除客户 */
+export function deleteCustomer(id: number) {
+  return requestClient.delete(`/license/customer/delete?id=${id}`);
+}
+
+/** 导出客户 */
+export function exportCustomer(params: any) {
+  return requestClient.download('/license/customer/export-excel', params);
+}

apps/web-antd/src/locales/langs/en-US/menu.json

@@ -81,5 +81,6 @@
       "java": "Java Monitoring",
       "track": "Link Tracking"
     }
-  }
+  },
+  "customer": "Customer Management"
 }

apps/web-antd/src/locales/langs/zh-CN/menu.json

@@ -81,5 +81,6 @@
       "java": "Java 监控",
       "track": "链路追踪"
     }
-  }
+  },
+  "customer": "客户管理"
 }

apps/web-antd/src/utils/dict.ts

@@ -219,6 +219,8 @@ enum DICT_TYPE {
   IOT_RW_TYPE = 'iot_rw_type', // IOT 读写类型
   IOT_UNIT_TYPE = 'iot_unit_type', // IOT 单位类型
   IOT_VALIDATE_TYPE = 'iot_validate_type', // IOT 数据校验级别
+  // ========== LICENSE 模块 ==========
+  LIC_CUSTOMER_TYPE = 'lic_customer_type', // 客户类型
   MEMBER_EXPERIENCE_BIZ_TYPE = 'member_experience_biz_type', // 会员经验业务类型
   // ========== Member 会员模块 ==========
   MEMBER_POINT_BIZ_TYPE = 'member_point_biz_type', // 积分的业务类型

apps/web-antd/src/views/license/customer/data.ts

@@ -0,0 +1,252 @@
+import type { VbenFormSchema } from '#/adapter/form';
+import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
+import type { CustomerApi } from '#/api/license/customer';
+
+import { useAccess } from '@vben/access';
+
+import { DICT_TYPE, getDictOptions, getRangePickerDefaultProps } from '#/utils';
+
+const { hasAccessByCodes } = useAccess();
+
+/** 新增/修改的表单 */
+export function useFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'id',
+      component: 'Input',
+      dependencies: {
+        triggerFields: [''],
+        show: () => false,
+      },
+    },
+    {
+      fieldName: 'name',
+      label: '客户名称',
+      rules: 'required',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入客户名称',
+      },
+    },
+    {
+      fieldName: 'code',
+      label: '客户编号',
+      rules: 'required',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入客户编号',
+      },
+    },
+    {
+      fieldName: 'type',
+      label: '客户类型',
+      rules: 'required',
+      component: 'Select',
+      componentProps: {
+        options: getDictOptions(DICT_TYPE.LIC_CUSTOMER_TYPE, 'number'),
+        placeholder: '请选择客户类型',
+      },
+    },
+    {
+      fieldName: 'areaId',
+      label: '地区',
+      rules: 'required',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入地区',
+      },
+    },
+    {
+      fieldName: 'contacts',
+      label: '联系人',
+      rules: 'required',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入联系人',
+      },
+    },
+    {
+      fieldName: 'role',
+      label: '角色',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入角色',
+      },
+    },
+    {
+      fieldName: 'phone',
+      label: '联系电话',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入联系电话',
+      },
+    },
+    {
+      fieldName: 'email',
+      label: '邮箱',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入邮箱',
+      },
+    },
+    {
+      fieldName: 'remark',
+      label: '备注',
+      component: 'Textarea',
+      componentProps: {
+        placeholder: '请输入备注',
+      },
+    },
+  ];
+}
+
+/** 列表的搜索表单 */
+export function useGridFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'name',
+      label: '客户名称',
+      component: 'Input',
+      componentProps: {
+        allowClear: true,
+        placeholder: '请输入客户名称',
+      },
+    },
+    {
+      fieldName: 'code',
+      label: '客户编号',
+      component: 'Input',
+      componentProps: {
+        allowClear: true,
+        placeholder: '请输入客户编号',
+      },
+    },
+    {
+      fieldName: 'type',
+      label: '客户类型',
+      component: 'Select',
+      componentProps: {
+        allowClear: true,
+        options: getDictOptions(DICT_TYPE.LIC_CUSTOMER_TYPE, 'number'),
+        placeholder: '请选择客户类型',
+      },
+    },
+    {
+      fieldName: 'areaId',
+      label: '地区',
+      component: 'Input',
+      componentProps: {
+        allowClear: true,
+        placeholder: '请输入地区',
+      },
+    },
+    {
+      fieldName: 'contacts',
+      label: '联系人',
+      component: 'Input',
+      componentProps: {
+        allowClear: true,
+        placeholder: '请输入联系人',
+      },
+    },
+    {
+      fieldName: 'createTime',
+      label: '创建时间',
+      component: 'RangePicker',
+      componentProps: {
+        ...getRangePickerDefaultProps(),
+        allowClear: true,
+      },
+    },
+  ];
+}
+
+/** 列表的字段 */
+export function useGridColumns(
+  onActionClick?: OnActionClickFn<CustomerApi.Customer>,
+): VxeTableGridOptions<CustomerApi.Customer>['columns'] {
+  return [
+    {
+      field: 'name',
+      title: '客户名称',
+      minWidth: 120,
+    },
+    {
+      field: 'code',
+      title: '客户编号',
+      minWidth: 120,
+    },
+    {
+      field: 'type',
+      title: '客户类型',
+      minWidth: 120,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.LIC_CUSTOMER_TYPE },
+      },
+    },
+    {
+      field: 'areaId',
+      title: '地区',
+      minWidth: 120,
+    },
+    {
+      field: 'contacts',
+      title: '联系人',
+      minWidth: 120,
+    },
+    {
+      field: 'role',
+      title: '角色',
+      minWidth: 120,
+    },
+    {
+      field: 'phone',
+      title: '联系电话',
+      minWidth: 120,
+    },
+    {
+      field: 'email',
+      title: '邮箱',
+      minWidth: 120,
+    },
+    {
+      field: 'remark',
+      title: '备注',
+      minWidth: 120,
+    },
+    {
+      field: 'createTime',
+      title: '创建时间',
+      minWidth: 120,
+      formatter: 'formatDateTime',
+    },
+    {
+      field: 'operation',
+      title: '操作',
+      minWidth: 200,
+      align: 'center',
+      fixed: 'right',
+      headerAlign: 'center',
+      showOverflow: false,
+      cellRender: {
+        attrs: {
+          nameField: 'id',
+          nameTitle: '客户',
+          onClick: onActionClick,
+        },
+        name: 'CellOperation',
+        options: [
+          {
+            code: 'edit',
+            show: hasAccessByCodes(['license:customer:update']),
+          },
+          {
+            code: 'delete',
+            show: hasAccessByCodes(['license:customer:delete']),
+          },
+        ],
+      },
+    },
+  ];
+}

apps/web-antd/src/views/license/customer/index.vue

@@ -0,0 +1,145 @@
+<script lang="ts" setup>
+import type {
+  OnActionClickParams,
+  VxeTableGridOptions,
+} from '#/adapter/vxe-table';
+import type { CustomerApi } from '#/api/license/customer';
+
+import { h } from 'vue';
+
+import { Page, useVbenModal } from '@vben/common-ui';
+import { Download, Plus } from '@vben/icons';
+import { downloadFileFromBlobPart } from '@vben/utils';
+
+import { Button, message } from 'ant-design-vue';
+
+import { useVbenVxeGrid } from '#/adapter/vxe-table';
+import {
+  deleteCustomer,
+  exportCustomer,
+  getCustomerPage,
+} from '#/api/license/customer';
+import { $t } from '#/locales';
+
+import { useGridColumns, useGridFormSchema } from './data';
+import Form from './modules/form.vue';
+
+const [FormModal, formModalApi] = useVbenModal({
+  connectedComponent: Form,
+  destroyOnClose: true,
+});
+
+/** 刷新表格 */
+function onRefresh() {
+  gridApi.query();
+}
+
+/** 创建客户 */
+function onCreate() {
+  formModalApi.setData({}).open();
+}
+
+/** 编辑客户 */
+function onEdit(row: CustomerApi.Customer) {
+  formModalApi.setData(row).open();
+}
+
+/** 删除客户 */
+async function onDelete(row: CustomerApi.Customer) {
+  const hideLoading = message.loading({
+    content: $t('ui.actionMessage.deleting', [row.id]),
+    duration: 0,
+    key: 'action_process_msg',
+  });
+  try {
+    await deleteCustomer(row.id as number);
+    message.success($t('ui.actionMessage.deleteSuccess', [row.id]));
+    onRefresh();
+  } catch {
+    hideLoading();
+  }
+}
+
+/** 导出表格 */
+async function onExport() {
+  const data = await exportCustomer(await gridApi.formApi.getValues());
+  downloadFileFromBlobPart({ fileName: '客户.xls', source: data });
+}
+
+/** 表格操作按钮的回调函数 */
+function onActionClick({
+  code,
+  row,
+}: OnActionClickParams<CustomerApi.Customer>) {
+  switch (code) {
+    case 'delete': {
+      onDelete(row);
+      break;
+    }
+    case 'edit': {
+      onEdit(row);
+      break;
+    }
+  }
+}
+
+const [Grid, gridApi] = useVbenVxeGrid({
+  formOptions: {
+    schema: useGridFormSchema(),
+  },
+  gridOptions: {
+    columns: useGridColumns(onActionClick),
+    height: 'auto',
+    pagerConfig: {
+      enabled: true,
+    },
+    proxyConfig: {
+      ajax: {
+        query: async ({ page }, formValues) => {
+          return await getCustomerPage({
+            pageNo: page.currentPage,
+            pageSize: page.pageSize,
+            ...formValues,
+          });
+        },
+      },
+    },
+    rowConfig: {
+      keyField: 'id',
+      isHover: true,
+    },
+    toolbarConfig: {
+      refresh: { code: 'query' },
+      search: true,
+    },
+  } as VxeTableGridOptions<CustomerApi.Customer>,
+});
+</script>
+
+<template>
+  <Page auto-content-height>
+    <FormModal @success="onRefresh" />
+
+    <Grid table-title="客户列表">
+      <template #toolbar-tools>
+        <Button
+          :icon="h(Plus)"
+          type="primary"
+          @click="onCreate"
+          v-access:code="['license:customer:create']"
+        >
+          {{ $t('ui.actionTitle.create', ['客户']) }}
+        </Button>
+        <Button
+          :icon="h(Download)"
+          type="primary"
+          class="ml-2"
+          @click="onExport"
+          v-access:code="['license:customer:export']"
+        >
+          {{ $t('ui.actionTitle.export') }}
+        </Button>
+      </template>
+    </Grid>
+  </Page>
+</template>

apps/web-antd/src/views/license/customer/modules/form.vue

@@ -0,0 +1,89 @@
+<script lang="ts" setup>
+import type { CustomerApi } from '#/api/license/customer';
+
+import { computed, ref } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+
+import { message } from 'ant-design-vue';
+
+import { useVbenForm } from '#/adapter/form';
+import {
+  createCustomer,
+  getCustomer,
+  updateCustomer,
+} from '#/api/license/customer';
+import { $t } from '#/locales';
+
+import { useFormSchema } from '../data';
+
+const emit = defineEmits(['success']);
+const formData = ref<CustomerApi.Customer>();
+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: 80,
+  },
+  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 CustomerApi.Customer;
+    try {
+      await (formData.value?.id ? updateCustomer(data) : createCustomer(data));
+      // 关闭并提示
+      await modalApi.close();
+      emit('success');
+      message.success($t('ui.actionMessage.operationSuccess'));
+    } finally {
+      modalApi.unlock();
+    }
+  },
+  async onOpenChange(isOpen: boolean) {
+    if (!isOpen) {
+      formData.value = undefined;
+      return;
+    }
+    // 加载数据
+    let data = modalApi.getData<CustomerApi.Customer>();
+    if (!data) {
+      return;
+    }
+    if (data.id) {
+      modalApi.lock();
+      try {
+        data = await getCustomer(data.id);
+      } finally {
+        modalApi.unlock();
+      }
+    }
+    // 设置到 values
+    formData.value = data;
+    await formApi.setValues(formData.value);
+  },
+});
+</script>
+
+<template>
+  <Modal :title="getTitle">
+    <Form class="mx-4" />
+  </Modal>
+</template>