From 9f6bee86f0ad014d58f188b66a4a0f67d36603ea Mon Sep 17 00:00:00 2001 From: dap <15891557205@163.com> Date: Fri, 10 Jan 2025 14:02:21 +0800 Subject: [PATCH] =?UTF-8?q?refactor:=20type/=E6=B3=A8=E9=87=8A=E4=BC=98?= =?UTF-8?q?=E5=8C=96=20=E5=8E=BB=E9=99=A4=E5=A4=A7=E9=87=8Fany?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- apps/web-antd/src/adapter/component/index.ts | 12 ++- apps/web-antd/src/adapter/vxe-table.ts | 9 +- apps/web-antd/src/api/common.d.ts | 1 + apps/web-antd/src/api/core/menu.ts | 2 +- apps/web-antd/src/api/monitor/online/index.ts | 5 ++ .../web-antd/src/api/monitor/operlog/index.ts | 18 +++- apps/web-antd/src/api/system/client/index.ts | 38 ++++++++- apps/web-antd/src/api/system/config/index.ts | 33 +++++-- .../web-antd/src/api/system/config/model.d.ts | 2 +- apps/web-antd/src/api/system/dept/index.ts | 23 ++++- .../web-antd/src/api/system/dict/dict-data.ts | 6 +- .../web-antd/src/api/system/dict/dict-type.ts | 7 +- apps/web-antd/src/api/system/menu/index.ts | 32 +++++-- apps/web-antd/src/api/system/menu/model.d.ts | 9 ++ apps/web-antd/src/api/system/notice/index.ts | 24 +++++- .../src/api/system/oss-config/index.ts | 4 +- apps/web-antd/src/api/system/oss/index.ts | 23 ++++- apps/web-antd/src/api/system/post/index.ts | 36 +++++++- apps/web-antd/src/api/system/role/index.ts | 85 ++++++++++++++----- apps/web-antd/src/api/system/social/index.ts | 7 +- .../src/api/system/tenant-package/index.ts | 52 ++++++++++-- apps/web-antd/src/api/system/tenant/index.ts | 47 +++++++--- .../web-antd/src/api/system/tenant/model.d.ts | 2 +- apps/web-antd/src/api/system/user/index.ts | 8 +- apps/web-antd/src/api/tool/gen/index.ts | 7 +- apps/web-antd/src/api/workflow/task/index.ts | 1 - .../cache/components/command-chart.vue | 13 ++- .../monitor/cache/components/memory-chart.vue | 16 ++-- .../cache/components/redis-description.vue | 11 ++- .../src/views/monitor/cache/index.vue | 10 ++- .../src/views/monitor/logininfor/data.tsx | 10 ++- .../src/views/monitor/logininfor/index.vue | 26 +++--- .../web-antd/src/views/monitor/online/data.ts | 6 +- .../src/views/monitor/online/index.vue | 11 ++- .../src/views/monitor/operlog/data.tsx | 2 +- .../src/views/monitor/operlog/index.vue | 13 +-- .../operlog/operation-preview-drawer.vue | 4 +- .../src/views/system/client/index.vue | 12 +-- apps/web-antd/src/views/system/config/data.ts | 2 +- .../src/views/system/config/index.vue | 21 +++-- apps/web-antd/src/views/system/dept/data.ts | 3 +- .../src/views/system/dept/dept-drawer.vue | 4 +- apps/web-antd/src/views/system/dept/index.vue | 19 +++-- .../src/views/system/dict/data/data.ts | 5 +- .../src/views/system/dict/data/index.vue | 24 +++--- .../system/dict/data/tag-style-picker.vue | 13 ++- .../src/views/system/dict/type/data.ts | 3 +- .../src/views/system/dict/type/index.vue | 23 +++-- apps/web-antd/src/views/system/menu/data.tsx | 3 +- apps/web-antd/src/views/system/menu/index.vue | 22 ++--- apps/web-antd/src/views/system/notice/data.ts | 2 +- .../src/views/system/notice/index.vue | 21 +++-- .../src/views/system/oss-config/data.tsx | 3 +- .../src/views/system/oss-config/index.vue | 21 +++-- apps/web-antd/src/views/system/oss/data.tsx | 3 +- apps/web-antd/src/views/system/oss/index.vue | 19 +++-- apps/web-antd/src/views/system/post/data.ts | 2 +- apps/web-antd/src/views/system/post/index.vue | 21 +++-- .../src/views/system/role-assign/data.tsx | 3 +- .../src/views/system/role-assign/index.vue | 17 ++-- .../system/role-assign/role-assign-drawer.vue | 8 +- apps/web-antd/src/views/system/role/index.vue | 14 +-- .../src/views/system/role/role-auth-modal.vue | 4 +- .../web-antd/src/views/system/tenant/data.tsx | 3 +- .../src/views/system/tenant/index.vue | 24 +++--- .../src/views/system/tenantPackage/data.ts | 3 +- .../src/views/system/tenantPackage/index.vue | 22 +++-- .../views/system/tenantPackage/tree-item.tsx | 4 +- apps/web-antd/src/views/system/user/data.tsx | 3 +- .../src/views/system/user/dept-tree.vue | 4 +- apps/web-antd/src/views/system/user/index.vue | 27 +++--- .../src/views/system/user/user-drawer.vue | 13 +-- .../src/views/system/user/user-info-modal.vue | 10 ++- .../system/user/user-reset-pwd-modal.vue | 6 +- .../src/views/tool/gen/code-preview-modal.vue | 14 +-- apps/web-antd/src/views/tool/gen/data.tsx | 3 +- .../tool/gen/edit-steps/basic-setting.vue | 4 +- .../src/views/tool/gen/edit-steps/basic.tsx | 4 +- .../views/tool/gen/edit-steps/gen-config.vue | 7 +- apps/web-antd/src/views/tool/gen/index.vue | 11 ++- .../src/views/tool/gen/table-import-modal.vue | 8 +- 81 files changed, 710 insertions(+), 367 deletions(-) diff --git a/apps/web-antd/src/adapter/component/index.ts b/apps/web-antd/src/adapter/component/index.ts index 750c7936..95472d96 100644 --- a/apps/web-antd/src/adapter/component/index.ts +++ b/apps/web-antd/src/adapter/component/index.ts @@ -3,13 +3,15 @@ * 可用于 vben-form、vben-modal、vben-drawer 等组件使用, */ -import type { BaseFormComponentType } from '@vben/common-ui'; import type { Component, SetupContext } from 'vue'; -import { Tinymce as RichTextarea } from '#/components/tinymce'; -import { FileUpload, ImageUpload } from '#/components/upload'; +import type { BaseFormComponentType } from '@vben/common-ui'; + +import { h } from 'vue'; + import { ApiComponent, globalShareState, IconPicker } from '@vben/common-ui'; import { $t } from '@vben/locales'; + import { AutoComplete, Button, @@ -34,7 +36,9 @@ import { TreeSelect, Upload, } from 'ant-design-vue'; -import { h } from 'vue'; + +import { Tinymce as RichTextarea } from '#/components/tinymce'; +import { FileUpload, ImageUpload } from '#/components/upload'; const withDefaultPlaceholder = ( component: T, diff --git a/apps/web-antd/src/adapter/vxe-table.ts b/apps/web-antd/src/adapter/vxe-table.ts index 9b3236d6..c0ff5cb6 100644 --- a/apps/web-antd/src/adapter/vxe-table.ts +++ b/apps/web-antd/src/adapter/vxe-table.ts @@ -1,10 +1,13 @@ -import type { VxeGridDefines, VxeGridPropTypes } from '@vben/plugins/vxe-table'; import type { Ref } from 'vue'; -import { setupVbenVxeTable, useVbenVxeGrid } from '@vben/plugins/vxe-table'; -import { Button, Image } from 'ant-design-vue'; +import type { VxeGridDefines, VxeGridPropTypes } from '@vben/plugins/vxe-table'; + import { h } from 'vue'; +import { setupVbenVxeTable, useVbenVxeGrid } from '@vben/plugins/vxe-table'; + +import { Button, Image } from 'ant-design-vue'; + import { useVbenForm } from './form'; setupVbenVxeTable({ diff --git a/apps/web-antd/src/api/common.d.ts b/apps/web-antd/src/api/common.d.ts index 233f2aa6..a6ed2aea 100644 --- a/apps/web-antd/src/api/common.d.ts +++ b/apps/web-antd/src/api/common.d.ts @@ -38,4 +38,5 @@ export interface PageQuery { orderByColumn?: string; pageNum?: number; pageSize?: number; + [key: string]: any; } diff --git a/apps/web-antd/src/api/core/menu.ts b/apps/web-antd/src/api/core/menu.ts index e4bef601..e04c2baf 100644 --- a/apps/web-antd/src/api/core/menu.ts +++ b/apps/web-antd/src/api/core/menu.ts @@ -19,7 +19,7 @@ export interface MenuMeta { * @param name 菜单名 * @param path 菜单路径 * @param hidden 是否隐藏 - * @param component 组件名称 Laout + * @param component 组件名称 Layout * @param alwaysShow 总是显示 * @param query 路由参数(json形式) * @param meta 路由信息 diff --git a/apps/web-antd/src/api/monitor/online/index.ts b/apps/web-antd/src/api/monitor/online/index.ts index 19ef27ed..8b4d938c 100644 --- a/apps/web-antd/src/api/monitor/online/index.ts +++ b/apps/web-antd/src/api/monitor/online/index.ts @@ -17,6 +17,11 @@ export function onlineDeviceList() { return requestClient.get>(Api.root); } +/** + * 这里的分页参数无效 返回的是全部的分页 + * @param params 请求参数 + * @returns 结果 + */ export function onlineList(params?: PageQuery) { return requestClient.get>(Api.onlineList, { params }); } diff --git a/apps/web-antd/src/api/monitor/operlog/index.ts b/apps/web-antd/src/api/monitor/operlog/index.ts index c061b447..44946f10 100644 --- a/apps/web-antd/src/api/monitor/operlog/index.ts +++ b/apps/web-antd/src/api/monitor/operlog/index.ts @@ -12,20 +12,36 @@ enum Api { root = '/monitor/operlog', } +/** + * 操作日志分页 + * @param params 查询参数 + * @returns 分页结果 + */ export function operLogList(params?: PageQuery) { return requestClient.get>(Api.operLogList, { params, }); } +/** + * 删除操作日志 + * @param operIds id/ids + */ export function operLogDelete(operIds: IDS) { return requestClient.deleteWithMsg(`${Api.root}/${operIds}`); } +/** + * 清空全部分页日志 + */ export function operLogClean() { return requestClient.deleteWithMsg(Api.operLogClean); } -export function operLogExport(data: any) { +/** + * 导出操作日志 + * @param data 查询参数 + */ +export function operLogExport(data: Partial) { return commonExport(Api.operLogExport, data); } diff --git a/apps/web-antd/src/api/system/client/index.ts b/apps/web-antd/src/api/system/client/index.ts index b440c4fe..bb8c4b99 100644 --- a/apps/web-antd/src/api/system/client/index.ts +++ b/apps/web-antd/src/api/system/client/index.ts @@ -12,30 +12,60 @@ enum Api { root = '/system/client', } +/** + * 查询客户端分页列表 + * @param params 请求参数 + * @returns 列表 + */ export function clientList(params?: PageQuery) { return requestClient.get>(Api.clientList, { params }); } -export function clientExport(data: any) { +/** + * 导出客户端excel + * @param data 请求参数 + */ +export function clientExport(data: Partial) { return commonExport(Api.clientExport, data); } +/** + * 客户端详情 + * @param id id + * @returns 详情 + */ export function clientInfo(id: ID) { return requestClient.get(`${Api.root}/${id}`); } -export function clientAdd(data: any) { +/** + * 客户端新增 + * @param data 参数 + */ +export function clientAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } -export function clientUpdate(data: any) { +/** + * 客户端修改 + * @param data 参数 + */ +export function clientUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } +/** + * 客户端状态修改 + * @param data 状态 + */ export function clientChangeStatus(data: any) { return requestClient.putWithMsg(Api.clientChangeStatus, data); } +/** + * 客户端删除 + * @param ids id集合 + */ export function clientRemove(ids: IDS) { - return requestClient.deleteWithMsg(`${Api.root}/${ids}`); + return requestClient.deleteWithMsg(`${Api.root}/${ids}`); } diff --git a/apps/web-antd/src/api/system/config/index.ts b/apps/web-antd/src/api/system/config/index.ts index 588bb2b1..546c95b1 100644 --- a/apps/web-antd/src/api/system/config/index.ts +++ b/apps/web-antd/src/api/system/config/index.ts @@ -1,4 +1,4 @@ -import type { Config } from './model'; +import type { SysConfig } from './model'; import type { ID, IDS, PageQuery, PageResult } from '#/api/common'; @@ -13,15 +13,24 @@ enum Api { root = '/system/config', } +/** + * 系统参数分页列表 + * @param params 请求参数 + * @returns 列表 + */ export function configList(params?: PageQuery) { - return requestClient.get>(Api.configList, { params }); + return requestClient.get>(Api.configList, { params }); } export function configInfo(configId: ID) { - return requestClient.get(`${Api.root}/${configId}`); + return requestClient.get(`${Api.root}/${configId}`); } -export function configExport(data: any) { +/** + * 导出 + * @param data 参数 + */ +export function configExport(data: Partial) { return commonExport(Api.configExport, data); } @@ -33,14 +42,26 @@ export function configRefreshCache() { return requestClient.deleteWithMsg(Api.configRefreshCache); } -export function configUpdate(data: any) { +/** + * 更新系统配置 + * @param data 参数 + */ +export function configUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } -export function configAdd(data: any) { +/** + * 新增系统配置 + * @param data 参数 + */ +export function configAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } +/** + * 删除配置 + * @param configIds ids + */ export function configRemove(configIds: IDS) { return requestClient.deleteWithMsg(`${Api.root}/${configIds}`); } diff --git a/apps/web-antd/src/api/system/config/model.d.ts b/apps/web-antd/src/api/system/config/model.d.ts index 85afc559..ee13acf4 100644 --- a/apps/web-antd/src/api/system/config/model.d.ts +++ b/apps/web-antd/src/api/system/config/model.d.ts @@ -1,4 +1,4 @@ -export interface Config { +export interface SysConfig { configId: number; configName: string; configKey: string; diff --git a/apps/web-antd/src/api/system/dept/index.ts b/apps/web-antd/src/api/system/dept/index.ts index 7557537d..bf7b721c 100644 --- a/apps/web-antd/src/api/system/dept/index.ts +++ b/apps/web-antd/src/api/system/dept/index.ts @@ -10,7 +10,11 @@ enum Api { root = '/system/dept', } -export function deptList(params?: any) { +/** + * 部门列表 + * @returns list + */ +export function deptList(params?: { deptName?: string; status?: string }) { return requestClient.get(Api.deptList, { params }); } @@ -23,15 +27,28 @@ export function deptNodeList(deptId: ID) { return requestClient.get(`${Api.deptNodeInfo}/${deptId}`); } +/** + * 部门详情 + * @param deptId 部门id + * @returns 部门信息 + */ export function deptInfo(deptId: ID) { return requestClient.get(`${Api.root}/${deptId}`); } -export function deptAdd(data: any) { +/** + * 部门新增 + * @param data 参数 + */ +export function deptAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } -export function deptUpdate(data: any) { +/** + * 部门更新 + * @param data 参数 + */ +export function deptUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } diff --git a/apps/web-antd/src/api/system/dict/dict-data.ts b/apps/web-antd/src/api/system/dict/dict-data.ts index a39ec396..61c7db9f 100644 --- a/apps/web-antd/src/api/system/dict/dict-data.ts +++ b/apps/web-antd/src/api/system/dict/dict-data.ts @@ -34,7 +34,7 @@ export function dictDataList(params?: PageQuery) { * @param data 表单参数 * @returns blob */ -export function dictDataExport(data: any) { +export function dictDataExport(data: Partial) { return commonExport(Api.dictDataExport, data); } @@ -52,7 +52,7 @@ export function dictDataRemove(dictIds: IDS) { * @param data 表单参数 * @returns void */ -export function dictDataAdd(data: any) { +export function dictDataAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } @@ -61,7 +61,7 @@ export function dictDataAdd(data: any) { * @param data 表单参数 * @returns void */ -export function dictDataUpdate(data: any) { +export function dictDataUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } diff --git a/apps/web-antd/src/api/system/dict/dict-type.ts b/apps/web-antd/src/api/system/dict/dict-type.ts index e3d4b291..96341606 100644 --- a/apps/web-antd/src/api/system/dict/dict-type.ts +++ b/apps/web-antd/src/api/system/dict/dict-type.ts @@ -27,7 +27,7 @@ export function dictTypeList(params?: PageQuery) { * @param data 表单参数 * @returns blob */ -export function dictTypeExport(data: any) { +export function dictTypeExport(data: Partial) { return commonExport(Api.dictTypeExport, data); } @@ -53,7 +53,7 @@ export function refreshDictTypeCache() { * @param data 表单参数 * @returns void */ -export function dictTypeAdd(data: any) { +export function dictTypeAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } @@ -62,7 +62,7 @@ export function dictTypeAdd(data: any) { * @param data 表单参数 * @returns void */ -export function dictTypeUpdate(data: any) { +export function dictTypeUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } @@ -76,6 +76,7 @@ export function dictTypeInfo(dictId: ID) { } /** + * 这个在ele用到 v5用不上 * 下拉框 返回值和list一样 * @returns options */ diff --git a/apps/web-antd/src/api/system/menu/index.ts b/apps/web-antd/src/api/system/menu/index.ts index e4f14c17..0381449d 100644 --- a/apps/web-antd/src/api/system/menu/index.ts +++ b/apps/web-antd/src/api/system/menu/index.ts @@ -1,6 +1,6 @@ -import type { ID, IDS } from '#/api/common'; +import type { Menu, MenuOption, MenuQuery, MenuResp } from './model'; -import type { Menu, MenuOption, MenuResp } from './model'; +import type { ID, IDS } from '#/api/common'; import { requestClient } from '#/api/request'; @@ -12,22 +12,44 @@ enum Api { tenantPackageMenuTreeselect = '/system/menu/tenantPackageMenuTreeselect', } -export function menuList(params?: any) { +/** + * 菜单列表 + * @param params 参数 + * @returns 列表 + */ +export function menuList(params?: MenuQuery) { return requestClient.get(Api.menuList, { params }); } +/** + * 菜单详情 + * @param menuId 菜单id + * @returns 菜单详情 + */ export function menuInfo(menuId: ID) { return requestClient.get(`${Api.root}/${menuId}`); } -export function menuAdd(data: any) { +/** + * 菜单新增 + * @param data 参数 + */ +export function menuAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } -export function menuUpdate(data: any) { +/** + * 菜单更新 + * @param data 参数 + */ +export function menuUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } +/** + * 菜单删除 + * @param menuIds ids + */ export function menuRemove(menuIds: IDS) { return requestClient.deleteWithMsg(`${Api.root}/${menuIds}`); } diff --git a/apps/web-antd/src/api/system/menu/model.d.ts b/apps/web-antd/src/api/system/menu/model.d.ts index 0a988bc2..5854f5c7 100644 --- a/apps/web-antd/src/api/system/menu/model.d.ts +++ b/apps/web-antd/src/api/system/menu/model.d.ts @@ -46,3 +46,12 @@ export interface MenuResp { checkedKeys: number[]; menus: MenuOption[]; } + +/** + * 菜单表单查询 + */ +export interface MenuQuery { + menuName?: string; + visible?: string; + status?: string; +} diff --git a/apps/web-antd/src/api/system/notice/index.ts b/apps/web-antd/src/api/system/notice/index.ts index 82877943..8588930f 100644 --- a/apps/web-antd/src/api/system/notice/index.ts +++ b/apps/web-antd/src/api/system/notice/index.ts @@ -9,22 +9,44 @@ enum Api { root = '/system/notice', } +/** + * 通知公告分页 + * @param params 分页参数 + * @returns 分页结果 + */ export function noticeList(params?: PageQuery) { return requestClient.get(Api.noticeList, { params }); } +/** + * 通知公告详情 + * @param noticeId id + * @returns 详情 + */ export function noticeInfo(noticeId: ID) { return requestClient.get(`${Api.root}/${noticeId}`); } -export function noticeAdd(data: any) { +/** + * 通知公告新增 + * @param data 参数 + */ +export function noticeAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } +/** + * 通知公告更新 + * @param data 参数 + */ export function noticeUpdate(data: any) { return requestClient.putWithMsg(Api.root, data); } +/** + * 通知公告删除 + * @param noticeIds ids + */ export function noticeRemove(noticeIds: IDS) { return requestClient.deleteWithMsg(`${Api.root}/${noticeIds}`); } diff --git a/apps/web-antd/src/api/system/oss-config/index.ts b/apps/web-antd/src/api/system/oss-config/index.ts index 3774e8af..ee01800a 100644 --- a/apps/web-antd/src/api/system/oss-config/index.ts +++ b/apps/web-antd/src/api/system/oss-config/index.ts @@ -21,12 +21,12 @@ export function ossConfigInfo(ossConfigId: ID) { } // 添加新的OSS配置 -export function ossConfigAdd(data: any) { +export function ossConfigAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } // 更新现有的OSS配置 -export function ossConfigUpdate(data: any) { +export function ossConfigUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } diff --git a/apps/web-antd/src/api/system/oss/index.ts b/apps/web-antd/src/api/system/oss/index.ts index ded2b422..04fc58a5 100644 --- a/apps/web-antd/src/api/system/oss/index.ts +++ b/apps/web-antd/src/api/system/oss/index.ts @@ -1,7 +1,7 @@ -import type { ID, IDS, PageQuery, PageResult } from '#/api/common'; - import type { OssFile } from './model'; +import type { ID, IDS, PageQuery, PageResult } from '#/api/common'; + import { ContentTypeEnum } from '#/api/helper'; import { requestClient } from '#/api/request'; @@ -13,20 +13,30 @@ enum Api { root = '/resource/oss', } +/** + * 文件list + * @param params 参数 + * @returns 分页 + */ export function ossList(params?: PageQuery) { return requestClient.get>(Api.ossList, { params }); } +/** + * 查询文件信息 返回为数组 + * @param ossIds id数组 + * @returns 信息数组 + */ export function ossInfo(ossIds: IDS) { return requestClient.get(`${Api.ossInfo}/${ossIds}`); } /** - * @deprecated + * @deprecated 使用apps/web-antd/src/api/core/upload.ts uploadApi方法 * @param file 文件 * @returns void */ -export function ossUpload(file: any) { +export function ossUpload(file: Blob | File) { const formData = new FormData(); formData.append('file', file); return requestClient.postWithMsg(Api.ossUpload, formData, { @@ -48,6 +58,11 @@ export function ossDownload(ossId: ID) { }); } +/** + * 删除文件 + * @param ossIds id数组 + * @returns void + */ export function ossRemove(ossIds: IDS) { return requestClient.deleteWithMsg(`${Api.root}/${ossIds}`); } diff --git a/apps/web-antd/src/api/system/post/index.ts b/apps/web-antd/src/api/system/post/index.ts index 61c5c3eb..3e1ef2e2 100644 --- a/apps/web-antd/src/api/system/post/index.ts +++ b/apps/web-antd/src/api/system/post/index.ts @@ -21,26 +21,56 @@ export function postList(params?: PageQuery) { return requestClient.get(Api.postList, { params }); } -export function postExport(data: any) { +/** + * 导出岗位信息 + * @param data 请求参数 + * @returns blob + */ +export function postExport(data: Partial) { return commonExport(Api.postExport, data); } +/** + * 查询岗位信息 + * @param postId id + * @returns 岗位信息 + */ export function postInfo(postId: ID) { return requestClient.get(`${Api.root}/${postId}`); } -export function postAdd(data: any) { +/** + * 岗位新增 + * @param data 参数 + * @returns void + */ +export function postAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } -export function postUpdate(data: any) { +/** + * 岗位更新 + * @param data 参数 + * @returns void + */ +export function postUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } +/** + * 岗位删除 + * @param postIds ids + * @returns void + */ export function postRemove(postIds: IDS) { return requestClient.deleteWithMsg(`${Api.root}/${postIds}`); } +/** + * 根据部门id获取岗位下拉列表 + * @param deptId 部门id + * @returns 岗位 + */ export function postOptionSelect(deptId: ID) { return requestClient.get(Api.postSelect, { params: { deptId } }); } diff --git a/apps/web-antd/src/api/system/role/index.ts b/apps/web-antd/src/api/system/role/index.ts index 6382fa03..e9e32891 100644 --- a/apps/web-antd/src/api/system/role/index.ts +++ b/apps/web-antd/src/api/system/role/index.ts @@ -1,3 +1,4 @@ +import type { User } from '../user/model'; import type { DeptResp, Role } from './model'; import type { ID, IDS, PageQuery, PageResult } from '#/api/common'; @@ -20,30 +21,65 @@ enum Api { root = '/system/role', } +/** + * 查询角色分页列表 + * @param params 搜索条件 + * @returns 分页列表 + */ export function roleList(params?: PageQuery) { return requestClient.get>(Api.roleList, { params }); } -export function roleExport(data: any) { +/** + * 导出角色信息 + * @param data 查询参数 + * @returns blob + */ +export function roleExport(data: Partial) { return commonExport(Api.roleExport, data); } +/** + * 查询角色信息 + * @param roleId 角色id + * @returns 角色信息 + */ export function roleInfo(roleId: ID) { return requestClient.get(`${Api.root}/${roleId}`); } -export function roleAdd(data: any) { +/** + * 角色新增 + * @param data 参数 + * @returns void + */ +export function roleAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } -export function roleUpdate(data: any) { +/** + * 角色更新 + * @param data 参数 + * @returns void + */ +export function roleUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } -export function roleChangeStatus(data: any) { +/** + * 修改角色状态 + * @param data 参数 + * @returns void + */ +export function roleChangeStatus(data: Partial) { return requestClient.putWithMsg(Api.roleChangeStatus, data); } +/** + * 角色删除 + * @param roleIds ids + * @returns void + */ export function roleRemove(roleIds: IDS) { return requestClient.deleteWithMsg(`${Api.root}/${roleIds}`); } @@ -57,12 +93,20 @@ export function roleDataScope(data: any) { return requestClient.putWithMsg(Api.roleDataScope, data); } +/** + * @deprecated 全局并没有用到这个方法 + */ export function roleOptionSelect(params?: any) { return requestClient.get(Api.roleOptionSelect, { params }); } -export function roleAllocatedList(params: any) { - return requestClient.get(Api.roleAllocatedList, { params }); +/** + * 已分配角色的用户分页 + * @param params 请求参数 + * @returns 分页 + */ +export function roleAllocatedList(params?: PageQuery) { + return requestClient.get>(Api.roleAllocatedList, { params }); } /** @@ -71,28 +115,26 @@ export function roleAllocatedList(params: any) { * @returns void */ export function roleUnallocatedList(params: any) { - return requestClient.get(Api.roleUnallocatedList, { params }); + return requestClient.get>(Api.roleUnallocatedList, { + params, + }); } /** - * 取消授权 - * @param data {userId: 2, roleId: "2"} + * 取消用户角色授权 * @returns void */ -export function roleAuthCancel(data: any) { +export function roleAuthCancel(data: { roleId: ID; userId: ID }) { return requestClient.putWithMsg(Api.roleAuthCancel, data); } /** * 批量取消授权 - * @param roleId - * @param userIds + * @param roleId 角色ID + * @param userIds 用户ID集合 * @returns void */ -export function roleAuthCancelAll( - roleId: number | string, - userIds: number[] | string[], -) { +export function roleAuthCancelAll(roleId: ID, userIds: IDS) { return requestClient.putWithMsg( `${Api.roleAuthCancelAll}?roleId=${roleId}&userIds=${userIds.join(',')}`, ); @@ -100,21 +142,18 @@ export function roleAuthCancelAll( /** * 批量授权用户 - * @param roleId - * @param userIds + * @param roleId 角色ID + * @param userIds 用户ID集合 * @returns void */ -export function roleSelectAll( - roleId: number | string, - userIds: number[] | string[], -) { +export function roleSelectAll(roleId: ID, userIds: IDS) { return requestClient.putWithMsg( `${Api.roleAuthSelectAll}?roleId=${roleId}&userIds=${userIds.join(',')}`, ); } /** - * 部门树 + * 根据角色id获取部门树 * @param roleId 角色id * @returns DeptResp */ diff --git a/apps/web-antd/src/api/system/social/index.ts b/apps/web-antd/src/api/system/social/index.ts index 7c50ed3a..91aef896 100644 --- a/apps/web-antd/src/api/system/social/index.ts +++ b/apps/web-antd/src/api/system/social/index.ts @@ -1,5 +1,7 @@ import type { SocialInfo } from './model'; +import type { ID } from '#/api/common'; + import { requestClient } from '#/api/request'; enum Api { @@ -15,6 +17,9 @@ export function socialList() { return requestClient.get(Api.socialList); } -export function socialInfo(id: number | string) { +/** + * @deprecated 并没有用到这个方法 + */ +export function socialInfo(id: ID) { return requestClient.get(`${Api.root}/${id}`); } diff --git a/apps/web-antd/src/api/system/tenant-package/index.ts b/apps/web-antd/src/api/system/tenant-package/index.ts index 1851a7bc..3cb83a2b 100644 --- a/apps/web-antd/src/api/system/tenant-package/index.ts +++ b/apps/web-antd/src/api/system/tenant-package/index.ts @@ -13,37 +13,75 @@ enum Api { root = '/system/tenant/package', } +/** + * 租户套餐分页列表 + * @param params 请求参数 + * @returns 分页列表 + */ export function packageList(params?: PageQuery) { return requestClient.get>(Api.packageList, { params, }); } -// 下拉框 +/** + * 租户套餐下拉框 + * @returns 下拉框 + */ export function packageSelectList() { return requestClient.get(Api.packageSelectList); } -export function packageExport(data: any) { +/** + * 租户套餐导出 + * @param data 参数 + * @returns blob + */ +export function packageExport(data: Partial) { return commonExport(Api.packageExport, data); } +/** + * 租户套餐信息 + * @param id id + * @returns 信息 + */ export function packageInfo(id: ID) { return requestClient.get(`${Api.root}/${id}`); } -export function packageAdd(data: any) { +/** + * 租户套餐新增 + * @param data data + * @returns void + */ +export function packageAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } -export function packageUpdate(data: any) { +/** + * 租户套餐更新 + * @param data data + * @returns void + */ +export function packageUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } -export function packageChangeStatus(data: any) { - return requestClient.putWithMsg(Api.packageChangeStatus, data); +/** + * 租户套餐状态变更 + * @param data data + * @returns void + */ +export function packageChangeStatus(data: Partial) { + return requestClient.putWithMsg(Api.packageChangeStatus, data); } +/** + * 租户套餐移除 + * @param ids ids + * @returns void + */ export function packageRemove(ids: IDS) { - return requestClient.deleteWithMsg(`${Api.root}/${ids}`); + return requestClient.deleteWithMsg(`${Api.root}/${ids}`); } diff --git a/apps/web-antd/src/api/system/tenant/index.ts b/apps/web-antd/src/api/system/tenant/index.ts index f5c6505e..e0269b23 100644 --- a/apps/web-antd/src/api/system/tenant/index.ts +++ b/apps/web-antd/src/api/system/tenant/index.ts @@ -16,14 +16,29 @@ enum Api { tenantSyncPackage = '/system/tenant/syncTenantPackage', } +/** + * 查询租户分页列表 + * @param params 参数 + * @returns 分页 + */ export function tenantList(params?: PageQuery) { return requestClient.get(Api.tenantList, { params }); } -export function tenantExport(data: any) { +/** + * 租户导出 + * @param data data + * @returns void + */ +export function tenantExport(data: Partial) { return commonExport(Api.tenantExport, data); } +/** + * 查询租户信息 + * @param id id + * @returns 租户信息 + */ export function tenantInfo(id: ID) { return requestClient.get(`${Api.root}/${id}`); } @@ -33,18 +48,33 @@ export function tenantInfo(id: ID) { * @param data data * @returns void */ -export function tenantAdd(data: any) { +export function tenantAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data, { encrypt: true }); } -export function tenantUpdate(data: any) { +/** + * 租户更新 + * @param data data + * @returns void + */ +export function tenantUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } -export function tenantStatusChange(data: any) { +/** + * 租户状态更新 + * @param data data + * @returns void + */ +export function tenantStatusChange(data: Partial) { return requestClient.putWithMsg(Api.tenantStatus, data); } +/** + * 租户删除 + * @param ids ids + * @returns void + */ export function tenantRemove(ids: IDS) { return requestClient.deleteWithMsg(`${Api.root}/${ids}`); } @@ -70,17 +100,12 @@ export function tenantDynamicClear() { * 租户套餐同步 * @param tenantId 租户id * @param packageId 套餐id - * @param showMsg 是否显示成功信息 * @returns void */ -export function tenantSyncPackage( - tenantId: string, - packageId: string, - showMsg = true, -) { +export function tenantSyncPackage(tenantId: string, packageId: string) { return requestClient.get(Api.tenantSyncPackage, { params: { packageId, tenantId }, - successMessageMode: showMsg ? 'message' : 'none', + successMessageMode: 'message', }); } diff --git a/apps/web-antd/src/api/system/tenant/model.d.ts b/apps/web-antd/src/api/system/tenant/model.d.ts index 309ad587..db6121c3 100644 --- a/apps/web-antd/src/api/system/tenant/model.d.ts +++ b/apps/web-antd/src/api/system/tenant/model.d.ts @@ -9,7 +9,7 @@ export interface Tenant { id: number; intro: string; licenseNumber?: any; - packageId?: string; + packageId: string; remark?: string; status: string; tenantId: string; diff --git a/apps/web-antd/src/api/system/user/index.ts b/apps/web-antd/src/api/system/user/index.ts index ff2a3d52..ed1b20c4 100644 --- a/apps/web-antd/src/api/system/user/index.ts +++ b/apps/web-antd/src/api/system/user/index.ts @@ -38,7 +38,7 @@ export function userList(params?: PageQuery) { * @param data data * @returns blob */ -export function userExport(data: any) { +export function userExport(data: Partial) { return commonExport(Api.userExport, data); } @@ -91,7 +91,7 @@ export function findUserInfo(userId?: ID) { * @param data data * @returns void */ -export function userAdd(data: any) { +export function userAdd(data: Partial) { return requestClient.postWithMsg(Api.root, data); } @@ -100,7 +100,7 @@ export function userAdd(data: any) { * @param data data * @returns void */ -export function userUpdate(data: any) { +export function userUpdate(data: Partial) { return requestClient.putWithMsg(Api.root, data); } @@ -109,7 +109,7 @@ export function userUpdate(data: any) { * @param data data * @returns void */ -export function userStatusChange(data: any) { +export function userStatusChange(data: Partial) { return requestClient.putWithMsg(Api.userStatusChange, data); } diff --git a/apps/web-antd/src/api/tool/gen/index.ts b/apps/web-antd/src/api/tool/gen/index.ts index 0514d3e0..127b962c 100644 --- a/apps/web-antd/src/api/tool/gen/index.ts +++ b/apps/web-antd/src/api/tool/gen/index.ts @@ -1,6 +1,6 @@ import type { GenInfo } from './model'; -import type { ID, IDS } from '#/api/common'; +import type { ID, IDS, PageQuery } from '#/api/common'; import { ContentTypeEnum } from '#/api/helper'; import { requestClient } from '#/api/request'; @@ -19,7 +19,7 @@ enum Api { syncDb = '/tool/gen/synchDb', } // 查询代码生成列表 -export function generatedList(params: any) { +export function generatedList(params?: PageQuery) { return requestClient.get(Api.generatedList, { params }); } @@ -29,7 +29,7 @@ export function genInfo(tableId: ID) { } // 查询数据库列表 -export function readyToGenList(params: any) { +export function readyToGenList(params?: PageQuery) { return requestClient.get(Api.readyToGenList, { params }); } @@ -63,6 +63,7 @@ export function editSave(data: any) { export function genRemove(tableIds: IDS) { return requestClient.deleteWithMsg(`${Api.root}/${tableIds}`); } + // 预览代码 export function previewCode(tableId: ID) { return requestClient.get<{ [key: string]: string }>( diff --git a/apps/web-antd/src/api/workflow/task/index.ts b/apps/web-antd/src/api/workflow/task/index.ts index 134a54c7..ae4cc407 100644 --- a/apps/web-antd/src/api/workflow/task/index.ts +++ b/apps/web-antd/src/api/workflow/task/index.ts @@ -95,7 +95,6 @@ export function getTaskByTaskId(taskId: string) { /** * 终止任务 - * @param data */ export function terminationTask(data: { comment?: string; taskId: string }) { return requestClient.postWithMsg( diff --git a/apps/web-antd/src/views/monitor/cache/components/command-chart.vue b/apps/web-antd/src/views/monitor/cache/components/command-chart.vue index 06ccf984..df17a1c3 100644 --- a/apps/web-antd/src/views/monitor/cache/components/command-chart.vue +++ b/apps/web-antd/src/views/monitor/cache/components/command-chart.vue @@ -1,20 +1,18 @@ diff --git a/apps/web-antd/src/views/system/client/index.vue b/apps/web-antd/src/views/system/client/index.vue index 4ddba4ea..a3eaf9be 100644 --- a/apps/web-antd/src/views/system/client/index.vue +++ b/apps/web-antd/src/views/system/client/index.vue @@ -1,8 +1,8 @@ diff --git a/apps/web-antd/src/views/system/role/role-auth-modal.vue b/apps/web-antd/src/views/system/role/role-auth-modal.vue index c3e7a601..6ee5c2b9 100644 --- a/apps/web-antd/src/views/system/role/role-auth-modal.vue +++ b/apps/web-antd/src/views/system/role/role-auth-modal.vue @@ -1,4 +1,6 @@