refactor: type/注释优化 去除大量any

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<PageResult<Role>>(Api.roleList, { params });
 }
 
-export function roleExport(data: any) {
+/**
+ * 导出角色信息
+ * @param data 查询参数
+ * @returns blob
+ */
+export function roleExport(data: Partial<Role>) {
   return commonExport(Api.roleExport, data);
 }
 
+/**
+ * 查询角色信息
+ * @param roleId 角色id
+ * @returns 角色信息
+ */
 export function roleInfo(roleId: ID) {
   return requestClient.get<Role>(`${Api.root}/${roleId}`);
 }
 
-export function roleAdd(data: any) {
+/**
+ * 角色新增
+ * @param data 参数
+ * @returns void
+ */
+export function roleAdd(data: Partial<Role>) {
   return requestClient.postWithMsg<void>(Api.root, data);
 }
 
-export function roleUpdate(data: any) {
+/**
+ * 角色更新
+ * @param data 参数
+ * @returns void
+ */
+export function roleUpdate(data: Partial<Role>) {
   return requestClient.putWithMsg<void>(Api.root, data);
 }
 
-export function roleChangeStatus(data: any) {
+/**
+ * 修改角色状态
+ * @param data 参数
+ * @returns void
+ */
+export function roleChangeStatus(data: Partial<Role>) {
   return requestClient.putWithMsg<void>(Api.roleChangeStatus, data);
 }
 
+/**
+ * 角色删除
+ * @param roleIds ids
+ * @returns void
+ */
 export function roleRemove(roleIds: IDS) {
   return requestClient.deleteWithMsg<void>(`${Api.root}/${roleIds}`);
 }
@@ -57,12 +93,20 @@ export function roleDataScope(data: any) {
   return requestClient.putWithMsg<void>(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<PageResult<User>>(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<PageResult<User>>(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<void>(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<void>(
     `${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<void>(
     `${Api.roleAuthSelectAll}?roleId=${roleId}&userIds=${userIds.join(',')}`,
   );
 }
 
 /**
- * 部门树
+ * 根据角色id获取部门树
  * @param roleId 角色id
  * @returns DeptResp
  */