feat(vben5): add notification group manage

1 year ago · 942d3bedb3
12 changed files with 544 additions and 2 deletions
--- a/apps/vben5/apps/app-antd/src/locales/langs/en-US/abp.json
+++ b/apps/vben5/apps/app-antd/src/locales/langs/en-US/abp.json
@ -42,7 +42,8 @@
    },
    "notifications": {
      "title": "Notifications",
-      "myNotifilers": "My Notifilers"
+      "myNotifilers": "My Notifilers",
+      "groups": "Groups"
    }
  },
  "openiddict": {
--- a/apps/vben5/apps/app-antd/src/locales/langs/zh-CN/abp.json
+++ b/apps/vben5/apps/app-antd/src/locales/langs/zh-CN/abp.json
@ -42,7 +42,8 @@
    },
    "notifications": {
      "title": "通知管理",
-      "myNotifilers": "我的通知"
+      "myNotifilers": "我的通知",
+      "groups": "通知分组"
    }
  },
  "openiddict": {
--- a/apps/vben5/apps/app-antd/src/router/routes/modules/abp.ts
+++ b/apps/vben5/apps/app-antd/src/router/routes/modules/abp.ts
@ -202,6 +202,16 @@ const routes: RouteRecordRaw[] = [
                component: () =>
                  import('#/views/notifications/my-notifilers/index.vue'),
              },
+              {
+                meta: {
+                  title: $t('abp.manage.notifications.groups'),
+                  icon: 'lucide:group',
+                },
+                name: 'NotificationGroupDefinitions',
+                path: '/manage/notifications/groups',
+                component: () =>
+                  import('#/views/notifications/groups/index.vue'),
+              },
            ],
          },
        ],
--- a/apps/vben5/apps/app-antd/src/views/notifications/groups/index.vue
+++ b/apps/vben5/apps/app-antd/src/views/notifications/groups/index.vue
@ -0,0 +1,15 @@
+<script lang="ts" setup>
+import { Page } from '@vben/common-ui';
+
+import { NotificationGroupDefinitionTable } from '@abp/notifications';
+
+defineOptions({
+  name: 'NotificationGroupDefinitions',
+});
+</script>
+
+<template>
+  <Page>
+    <NotificationGroupDefinitionTable />
+  </Page>
+</template>
--- a/apps/vben5/packages/@abp/notifications/src/api/index.ts
+++ b/apps/vben5/packages/@abp/notifications/src/api/index.ts
@ -1,3 +1,4 @@
 export { useMyNotifilersApi } from './useMyNotifilersApi';
 export { useMySubscribesApi } from './useMySubscribesApi';
+export { useNotificationGroupDefinitionsApi } from './useNotificationGroupDefinitionsApi';
 export { useNotificationsApi } from './useNotificationsApi';
--- a/apps/vben5/packages/@abp/notifications/src/api/useNotificationGroupDefinitionsApi.ts
+++ b/apps/vben5/packages/@abp/notifications/src/api/useNotificationGroupDefinitionsApi.ts
@ -0,0 +1,100 @@
+import type { ListResultDto } from '@abp/core';
+
+import type {
+  NotificationGroupDefinitionCreateDto,
+  NotificationGroupDefinitionDto,
+  NotificationGroupDefinitionGetListInput,
+  NotificationGroupDefinitionUpdateDto,
+} from '../types';
+
+import { useRequest } from '@abp/request';
+
+export function useNotificationGroupDefinitionsApi() {
+  const { cancel, request } = useRequest();
+
+  /**
+   * 删除通知分组定义
+   * @param name 通知分组名称
+   */
+  function deleteApi(name: string): Promise<void> {
+    return request(`/api/notifications/definitions/groups/${name}`, {
+      method: 'DELETE',
+    });
+  }
+
+  /**
+   * 查询通知分组定义
+   * @param name 通知分组名称
+   * @returns 通知分组定义数据传输对象
+   */
+  function getApi(name: string): Promise<NotificationGroupDefinitionDto> {
+    return request<NotificationGroupDefinitionDto>(
+      `/api/notifications/definitions/groups/${name}`,
+      {
+        method: 'GET',
+      },
+    );
+  }
+
+  /**
+   * 查询通知分组定义列表
+   * @param input 通知分组过滤条件
+   * @returns 通知分组定义数据传输对象列表
+   */
+  function getListApi(
+    input?: NotificationGroupDefinitionGetListInput,
+  ): Promise<ListResultDto<NotificationGroupDefinitionDto>> {
+    return request<ListResultDto<NotificationGroupDefinitionDto>>(
+      `/api/notifications/definitions/groups`,
+      {
+        method: 'GET',
+        params: input,
+      },
+    );
+  }
+
+  /**
+   * 创建通知分组定义
+   * @param input 通知分组定义参数
+   * @returns 通知分组定义数据传输对象
+   */
+  function createApi(
+    input: NotificationGroupDefinitionCreateDto,
+  ): Promise<NotificationGroupDefinitionDto> {
+    return request<NotificationGroupDefinitionDto>(
+      '/api/notifications/definitions/groups',
+      {
+        data: input,
+        method: 'POST',
+      },
+    );
+  }
+
+  /**
+   * 更新通知分组定义
+   * @param name 通知分组名称
+   * @param input 通知分组定义参数
+   * @returns 通知分组定义数据传输对象
+   */
+  function updateApi(
+    name: string,
+    input: NotificationGroupDefinitionUpdateDto,
+  ): Promise<NotificationGroupDefinitionDto> {
+    return request<NotificationGroupDefinitionDto>(
+      `/api/notifications/definitions/groups/${name}`,
+      {
+        data: input,
+        method: 'PUT',
+      },
+    );
+  }
+
+  return {
+    cancel,
+    createApi,
+    deleteApi,
+    getApi,
+    getListApi,
+    updateApi,
+  };
+}
--- a/apps/vben5/packages/@abp/notifications/src/components/definitions/groups/NotificationGroupDefinitionModal.vue
+++ b/apps/vben5/packages/@abp/notifications/src/components/definitions/groups/NotificationGroupDefinitionModal.vue
@ -0,0 +1,150 @@
+<script setup lang="ts">
+import type { PropertyInfo } from '@abp/ui';
+import type { FormInstance } from 'ant-design-vue';
+
+import type { NotificationGroupDefinitionDto } from '../../../types/groups';
+
+import { defineEmits, defineOptions, ref, toValue, useTemplateRef } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+import { $t } from '@vben/locales';
+
+import { LocalizableInput, PropertyTable } from '@abp/ui';
+import { Form, Input, message, Tabs } from 'ant-design-vue';
+
+import { useNotificationGroupDefinitionsApi } from '../../../api/useNotificationGroupDefinitionsApi';
+
+defineOptions({
+  name: 'NotificationGroupDefinitionModal',
+});
+const emits = defineEmits<{
+  (event: 'change', data: NotificationGroupDefinitionDto): void;
+}>();
+
+const FormItem = Form.Item;
+const TabPane = Tabs.TabPane;
+
+type TabKeys = 'basic' | 'props';
+
+const defaultModel = {} as NotificationGroupDefinitionDto;
+
+const isEditModel = ref(false);
+const activeTab = ref<TabKeys>('basic');
+const form = useTemplateRef<FormInstance>('form');
+const formModel = ref<NotificationGroupDefinitionDto>({ ...defaultModel });
+
+const { cancel, createApi, getApi, updateApi } =
+  useNotificationGroupDefinitionsApi();
+const [Modal, modalApi] = useVbenModal({
+  class: 'w-1/2',
+  draggable: true,
+  fullscreenButton: false,
+  onCancel() {
+    modalApi.close();
+  },
+  onClosed() {
+    cancel('NotificationGroupDefinitionModal has closed!');
+  },
+  onConfirm: async () => {
+    await form.value?.validate();
+    const api = isEditModel.value
+      ? updateApi(formModel.value.name, toValue(formModel))
+      : createApi(toValue(formModel));
+    modalApi.setState({ confirmLoading: true, loading: true });
+    api
+      .then((res) => {
+        message.success($t('AbpUi.SavedSuccessfully'));
+        emits('change', res);
+        modalApi.close();
+      })
+      .finally(() => {
+        modalApi.setState({ confirmLoading: false, loading: false });
+      });
+  },
+  onOpenChange: async (isOpen: boolean) => {
+    if (isOpen) {
+      isEditModel.value = false;
+      activeTab.value = 'basic';
+      formModel.value = { ...defaultModel };
+      modalApi.setState({
+        showConfirmButton: true,
+        title: $t('Notifications.GroupDefinitions:AddNew'),
+      });
+      try {
+        modalApi.setState({ loading: true });
+        const { name } = modalApi.getData<NotificationGroupDefinitionDto>();
+        name && (await onGet(name));
+      } finally {
+        modalApi.setState({ loading: false });
+      }
+    }
+  },
+  title: $t('Notifications.GroupDefinitions:AddNew'),
+});
+async function onGet(name: string) {
+  isEditModel.value = true;
+  const dto = await getApi(name);
+  formModel.value = dto;
+  modalApi.setState({
+    showConfirmButton: !dto.isStatic,
+    title: `${$t('Notifications.GroupDefinitions')} - ${dto.name}`,
+  });
+}
+function onPropChange(prop: PropertyInfo) {
+  formModel.value.extraProperties ??= {};
+  formModel.value.extraProperties[prop.key] = prop.value;
+}
+function onPropDelete(prop: PropertyInfo) {
+  formModel.value.extraProperties ??= {};
+  delete formModel.value.extraProperties[prop.key];
+}
+</script>
+
+<template>
+  <Modal>
+    <Form
+      ref="form"
+      :label-col="{ span: 6 }"
+      :model="formModel"
+      :wrapper-col="{ span: 18 }"
+    >
+      <Tabs v-model:active-key="activeTab">
+        <!-- 基本信息 -->
+        <TabPane key="basic" :tab="$t('Notifications.BasicInfo')">
+          <FormItem
+            :label="$t('Notifications.DisplayName:Name')"
+            name="name"
+            required
+          >
+            <Input
+              v-model:value="formModel.name"
+              :disabled="formModel.isStatic"
+              autocomplete="off"
+            />
+          </FormItem>
+          <FormItem
+            :label="$t('Notifications.DisplayName:DisplayName')"
+            name="displayName"
+            required
+          >
+            <LocalizableInput
+              v-model:value="formModel.displayName"
+              :disabled="formModel.isStatic"
+            />
+          </FormItem>
+        </TabPane>
+        <!-- 属性 -->
+        <TabPane key="props" :tab="$t('Notifications.Properties')">
+          <PropertyTable
+            :data="formModel.extraProperties"
+            :disabled="formModel.isStatic"
+            @change="onPropChange"
+            @delete="onPropDelete"
+          />
+        </TabPane>
+      </Tabs>
+    </Form>
+  </Modal>
+</template>
+
+<style scoped></style>
--- a/apps/vben5/packages/@abp/notifications/src/components/definitions/groups/NotificationGroupDefinitionTable.vue
+++ b/apps/vben5/packages/@abp/notifications/src/components/definitions/groups/NotificationGroupDefinitionTable.vue
@ -0,0 +1,217 @@
+<script setup lang="ts">
+import type { VbenFormProps, VxeGridListeners, VxeGridProps } from '@abp/ui';
+
+import type { NotificationGroupDefinitionDto } from '../../../types/groups';
+
+import { defineAsyncComponent, h, onMounted, reactive, ref } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+import { $t } from '@vben/locales';
+
+import { useLocalization, useLocalizationSerializer } from '@abp/core';
+import { useVbenVxeGrid } from '@abp/ui';
+import {
+  DeleteOutlined,
+  EditOutlined,
+  PlusOutlined,
+} from '@ant-design/icons-vue';
+import { Button, message, Modal } from 'ant-design-vue';
+
+import { useNotificationGroupDefinitionsApi } from '../../../api/useNotificationGroupDefinitionsApi';
+import { GroupDefinitionsPermissions } from '../../../constants/permissions';
+
+defineOptions({
+  name: 'NotificationGroupDefinitionTable',
+});
+
+const permissionGroups = ref<NotificationGroupDefinitionDto[]>([]);
+const pageState = reactive({
+  current: 1,
+  size: 10,
+  total: 0,
+});
+
+const { Lr } = useLocalization();
+const { deserialize } = useLocalizationSerializer();
+const { deleteApi, getListApi } = useNotificationGroupDefinitionsApi();
+
+const formOptions: VbenFormProps = {
+  // 默认展开
+  collapsed: false,
+  handleReset: onReset,
+  async handleSubmit(params) {
+    pageState.current = 1;
+    await onGet(params);
+  },
+  schema: [
+    {
+      component: 'Input',
+      fieldName: 'filter',
+      formItemClass: 'col-span-2 items-baseline',
+      label: $t('AbpUi.Search'),
+    },
+  ],
+  // 控制表单是否显示折叠按钮
+  showCollapseButton: true,
+  // 按下回车时是否提交表单
+  submitOnEnter: true,
+};
+
+const gridOptions: VxeGridProps<NotificationGroupDefinitionDto> = {
+  columns: [
+    {
+      align: 'left',
+      field: 'name',
+      minWidth: 150,
+      title: $t('Notifications.DisplayName:Name'),
+    },
+    {
+      align: 'left',
+      field: 'displayName',
+      minWidth: 150,
+      title: $t('Notifications.DisplayName:DisplayName'),
+    },
+    {
+      field: 'action',
+      fixed: 'right',
+      slots: { default: 'action' },
+      title: $t('AbpUi.Actions'),
+      width: 220,
+    },
+  ],
+  exportConfig: {},
+  keepSource: true,
+  toolbarConfig: {
+    custom: true,
+    export: true,
+    refresh: false,
+    zoom: true,
+  },
+};
+
+const gridEvents: VxeGridListeners<NotificationGroupDefinitionDto> = {
+  pageChange(params) {
+    pageState.current = params.currentPage;
+    pageState.size = params.pageSize;
+    onPageChange();
+  },
+};
+
+const [Grid, gridApi] = useVbenVxeGrid({
+  formOptions,
+  gridEvents,
+  gridOptions,
+});
+
+const [NotificationGroupDefinitionModal, groupModalApi] = useVbenModal({
+  connectedComponent: defineAsyncComponent(
+    () => import('./NotificationGroupDefinitionModal.vue'),
+  ),
+});
+
+async function onGet(input?: Record<string, string>) {
+  try {
+    gridApi.setLoading(true);
+    const { items } = await getListApi(input);
+    pageState.total = items.length;
+    permissionGroups.value = items.map((item) => {
+      const localizableString = deserialize(item.displayName);
+      return {
+        ...item,
+        displayName: Lr(localizableString.resourceName, localizableString.name),
+      };
+    });
+    onPageChange();
+  } finally {
+    gridApi.setLoading(false);
+  }
+}
+
+async function onReset() {
+  await gridApi.formApi.resetForm();
+  const input = await gridApi.formApi.getValues();
+  await onGet(input);
+}
+
+function onPageChange() {
+  const items = permissionGroups.value.slice(
+    (pageState.current - 1) * pageState.size,
+    pageState.current * pageState.size,
+  );
+  gridApi.setGridOptions({
+    data: items,
+    pagerConfig: {
+      currentPage: pageState.current,
+      pageSize: pageState.size,
+      total: pageState.total,
+    },
+  });
+}
+
+function onCreate() {
+  groupModalApi.setData({});
+  groupModalApi.open();
+}
+
+function onUpdate(row: NotificationGroupDefinitionDto) {
+  groupModalApi.setData(row);
+  groupModalApi.open();
+}
+
+function onDelete(row: NotificationGroupDefinitionDto) {
+  Modal.confirm({
+    centered: true,
+    content: `${$t('AbpUi.ItemWillBeDeletedMessageWithFormat', [row.name])}`,
+    onOk: async () => {
+      await deleteApi(row.name);
+      message.success($t('AbpUi.SuccessfullyDeleted'));
+      onGet();
+    },
+    title: $t('AbpUi.AreYouSure'),
+  });
+}
+
+onMounted(onGet);
+</script>
+
+<template>
+  <Grid :table-title="$t('Notifications.GroupDefinitions')">
+    <template #toolbar-tools>
+      <Button
+        :icon="h(PlusOutlined)"
+        type="primary"
+        v-access:code="[GroupDefinitionsPermissions.Create]"
+        @click="onCreate"
+      >
+        {{ $t('Notifications.GroupDefinitions:AddNew') }}
+      </Button>
+    </template>
+    <template #action="{ row }">
+      <div class="flex flex-row">
+        <Button
+          :icon="h(EditOutlined)"
+          block
+          type="link"
+          v-access:code="[GroupDefinitionsPermissions.Update]"
+          @click="onUpdate(row)"
+        >
+          {{ $t('AbpUi.Edit') }}
+        </Button>
+        <Button
+          v-if="!row.isStatic"
+          :icon="h(DeleteOutlined)"
+          block
+          danger
+          type="link"
+          v-access:code="[GroupDefinitionsPermissions.Delete]"
+          @click="onDelete(row)"
+        >
+          {{ $t('AbpUi.Delete') }}
+        </Button>
+      </div>
+    </template>
+  </Grid>
+  <NotificationGroupDefinitionModal @change="() => onGet()" />
+</template>
+
+<style scoped></style>
--- a/apps/vben5/packages/@abp/notifications/src/components/index.ts
+++ b/apps/vben5/packages/@abp/notifications/src/components/index.ts
@ -1 +1,2 @@
+export { default as NotificationGroupDefinitionTable } from './definitions/groups/NotificationGroupDefinitionTable.vue';
 export { default as MyNotificationTable } from './my-notifilers/MyNotificationTable.vue';
--- a/apps/vben5/packages/@abp/notifications/src/constants/permissions.ts
+++ b/apps/vben5/packages/@abp/notifications/src/constants/permissions.ts
@ -0,0 +1,10 @@
+/** 分组权限 */
+export const GroupDefinitionsPermissions = {
+  /** 新增 */
+  Create: 'Notifications.GroupDefinitions.Create',
+  Default: 'Notifications.GroupDefinitions',
+  /** 删除 */
+  Delete: 'Notifications.GroupDefinitions.Delete',
+  /** 更新 */
+  Update: 'Notifications.GroupDefinitions.Update',
+};
--- a/apps/vben5/packages/@abp/notifications/src/types/groups.ts
+++ b/apps/vben5/packages/@abp/notifications/src/types/groups.ts
@ -0,0 +1,35 @@
+import type { ExtensibleObject, IHasExtraProperties } from '@abp/core';
+
+interface NotificationGroupDefinitionDto extends ExtensibleObject {
+  allowSubscriptionToClients: boolean;
+  description?: string;
+  displayName: string;
+  isStatic: boolean;
+  name: string;
+}
+
+interface NotificationGroupDefinitionGetListInput {
+  filter?: string;
+}
+
+interface NotificationGroupDefinitionCreateOrUpdateDto
+  extends IHasExtraProperties {
+  allowSubscriptionToClients: boolean;
+  description?: string;
+  displayName: string;
+}
+
+interface NotificationGroupDefinitionCreateDto
+  extends NotificationGroupDefinitionCreateOrUpdateDto {
+  name: string;
+}
+
+type NotificationGroupDefinitionUpdateDto =
+  NotificationGroupDefinitionCreateOrUpdateDto;
+
+export type {
+  NotificationGroupDefinitionCreateDto,
+  NotificationGroupDefinitionDto,
+  NotificationGroupDefinitionGetListInput,
+  NotificationGroupDefinitionUpdateDto,
+};
--- a/apps/vben5/packages/@abp/notifications/src/types/index.ts
+++ b/apps/vben5/packages/@abp/notifications/src/types/index.ts
@ -1,4 +1,5 @@
 export * from './definitions';
+export * from './groups';
 export * from './my-notifilers';
 export * from './notifications';
 export * from './subscribes';