@gct-paas/api 0.1.0-dev.5 → 0.1.0-dev.7

package/lib/platform/service/apis/org.service.d.ts

@@ -12,117 +12,204 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
+}
+export interface getInfoIdPathParams {
+  id: string;
 }
 export interface getUserInfoQuery {
-  orgId: string; // 组织id
-  userId: string; // 用户id
+  /**
+   * 组织id
+   */
+  orgId: string;
+  /**
+   * 用户id
+   */
+  userId: string;
 }
 export interface getUserListCurrentTenantUserQuery {
-  keyword?: string; // 关键字
-  orgId: string; // 部门id
+  /**
+   * 关键字
+   */
+  keyword?: string;
+  /**
+   * 部门id
+   */
+  orgId: string;
 }
 export interface getUserPageListQuery {
-  allUserOption?: number; // 是否显示下级
-  enabled?: number; // 是否启用
-  endTime?: string; // 创建结束时间
-  fullname?: string; // 姓名
-  mobile?: string; // 手机号码
-  orgId: string; // 部门id
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  source?: number; // 参数来源，0企业后台管理、1租户后台管理
-  startTime?: string; // 创建开始时间
-  username?: string; // 账号
+  /**
+   * 是否显示下级
+   */
+  allUserOption?: number;
+  /**
+   * 是否启用
+   */
+  enabled?: number;
+  /**
+   * 创建结束时间
+   */
+  endTime?: string;
+  /**
+   * 姓名
+   */
+  fullname?: string;
+  /**
+   * 手机号码
+   */
+  mobile?: string;
+  /**
+   * 部门id
+   */
+  orgId: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 参数来源，0企业后台管理、1租户后台管理
+   */
+  source?: number;
+  /**
+   * 创建开始时间
+   */
+  startTime?: string;
+  /**
+   * 账号
+   */
+  username?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface OrgService {
-  // 组织保存
-  post(
-    data: OrgRequest,
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  /**
+   * 组织保存
+   */
+  post(data: OrgRequest, config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 拖拽
+  ): Promise<string>;
+  /**
+   * 拖拽
+   */
   postDrag(
     data: OrgDragRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfoId(
+    path: getInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OrgResponse>>;
-  // 名称、编号输入校验
+  ): Promise<OrgResponse>;
+  /**
+   * 名称、编号输入校验
+   */
   postInputCheck(
     data: OrgRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OrgResponse[]>>;
-  // 组织删除校验
+  ): Promise<string>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<OrgResponse[]>;
+  /**
+   * 组织删除校验
+   */
   postOrgHavePersonCheck(
     data: OrgRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 转移并删除
+  ): Promise<boolean>;
+  /**
+   * 转移并删除
+   */
   postTransferAndDelete(
     data: OrgTransferAndDeleteRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 组织成员添加用户
+  ): Promise<string>;
+  /**
+   * 组织成员添加用户
+   */
   postUserAdd(
     data: OrgAddOrUpdateUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 创建并添加用户
+  ): Promise<string>;
+  /**
+   * 创建并添加用户
+   */
   postUserCreateAndAdd(
     data: OrgCreateAndAddUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询用户详情
+  ): Promise<string>;
+  /**
+   * 查询用户详情
+   */
   getUserInfo(
     query: getUserInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OrgUserResponse>>;
-  // 查询当前租户下的用户
+  ): Promise<OrgUserResponse>;
+  /**
+   * 查询当前租户下的用户
+   */
   getUserListCurrentTenantUser(
     query: getUserListCurrentTenantUserQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<OrgUserResponse[]>>;
-  // 组织成员移动用户
+  ): Promise<OrgUserResponse[]>;
+  /**
+   * 组织成员移动用户
+   */
   postUserMove(
     data: OrgMoveUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 组织用户分页查询
+  ): Promise<string>;
+  /**
+   * 组织用户分页查询
+   */
   getUserPageList(
     query: getUserPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<OrgUserResponse>>>;
-  // 移除用户
+  ): Promise<IPage<OrgUserResponse>>;
+  /**
+   * 移除用户
+   */
   postUserRemove(
     data: OrgRemoveUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 组织成员编辑用户
+  ): Promise<string>;
+  /**
+   * 组织成员编辑用户
+   */
   postUserUpdate(
     data: OrgAddOrUpdateUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 组织成员修改
+  ): Promise<string>;
+  /**
+   * 组织成员修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: OrgRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/parseCsvOrExcel.service.d.ts

@@ -1,12 +1,17 @@
 import type { AxiosRequestConfig } from 'axios';
 export interface getQuery {
-  fileName: string; // fileName
-  folderName: string; // folderName
+  /**
+   * fileName
+   */
+  fileName: string;
+  /**
+   * folderName
+   */
+  folderName: string;
 }
 export interface ParseCsvOrExcelService {
-  // 解析CSV或Excel文件，将内容构建成List返回
-  get(
-    query: getQuery,
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
+  /**
+   * 解析CSV或Excel文件，将内容构建成List返回
+   */
+  get(query: getQuery, config?: Partial<AxiosRequestConfig>): Promise<unknown>;
 }

package/lib/platform/service/apis/permission.service.d.ts

@@ -2,39 +2,56 @@ import type { AxiosRequestConfig } from 'axios';
 import type { PermissionRequest, PermissionResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface PermissionService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PermissionRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PermissionResponse[]>>;
-  // 分页列表
+  ): Promise<string>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PermissionResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PermissionResponse>>>;
-  // 修改
+  ): Promise<IPage<PermissionResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PermissionRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/plat.service.d.ts

@@ -16,122 +16,175 @@ import type {
   WXWorkConfig,
 } from '../entities';
 
+export interface getAppGlobalInfoAppIdPathParams {
+  appId: string;
+}
+export interface postAppGlobalAppIdPathParams {
+  appId: string;
+}
 export interface getInfoQuery {
-  configEnum: string; // 配置枚举(BASE_CFG/基础设置,THEME_CFG/主题设置,LOGIN_CFG/登录设置,MARK_CFG/水印设置,SECURITY_CFG/安全设置,ORG_CFG/组织设置)
+  /**
+   * 配置枚举(BASE_CFG/基础设置,THEME_CFG/主题设置,LOGIN_CFG/登录设置,MARK_CFG/水印设置,SECURITY_CFG/安全设置,ORG_CFG/组织设置)
+   */
+  configEnum: string;
 }
 export interface getTenantDisabledDevelopQuery {
-  tenantId: string; // 租户ID
+  /**
+   * 租户ID
+   */
+  tenantId: string;
 }
 export interface deleteUserRoleQuery {
-  userId: string; // 删除的userId
+  /**
+   * 删除的userId
+   */
+  userId: string;
 }
 export interface PlatService {
-  // 应用全局配置设置 查询
+  /**
+   * 应用全局配置设置 查询
+   */
   getAppGlobalInfoAppId(
+    path: getAppGlobalInfoAppIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<SysConfigResponse>>;
-  // 应用全局配置设置 保存/更新
+  ): Promise<SysConfigResponse>;
+  /**
+   * 应用全局配置设置 保存/更新
+   */
   postAppGlobalAppId(
+    path: postAppGlobalAppIdPathParams,
     data: SysConfigRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 基础设置 保存/更新
+  ): Promise<string>;
+  /**
+   * 基础设置 保存/更新
+   */
   postBase(
     data: PlatformBaseConfig,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 钉钉设置 保存/更新
+  ): Promise<string>;
+  /**
+   * 钉钉设置 保存/更新
+   */
   postDingtalk(
     data: DingTalkConfig,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 邮件 保存/更新
+  ): Promise<string>;
+  /**
+   * 邮件 保存/更新
+   */
   postEmail(
     data: MailConfig,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 飞书设置 保存/更新
+  ): Promise<string>;
+  /**
+   * 飞书设置 保存/更新
+   */
   postFeishu(
     data: FeiShuConfig,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 全局禁用设计器
+  ): Promise<string>;
+  /**
+   * 全局禁用设计器
+   */
   getGlobalDisabledDevelop(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<SysConfigResponse>>;
-  // 配置列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<SysConfigResponse[]>>;
-  // 登录设置 保存/更新
+  ): Promise<SysConfigResponse>;
+  /**
+   * 配置列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<SysConfigResponse[]>;
+  /**
+   * 登录设置 保存/更新
+   */
   postLogin(
     data: AuthConfig,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 组织设置 保存/更新
+  ): Promise<string>;
+  /**
+   * 组织设置 保存/更新
+   */
   postOrg(
     data: OrgConfig,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 安全设置 保存/更新
+  ): Promise<string>;
+  /**
+   * 安全设置 保存/更新
+   */
   postSecurity(
     data: SecurityConfig,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询租户配置
-  getTenantCfg(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TenantConfig>>;
-  // 禁用设计器
+  ): Promise<string>;
+  /**
+   * 查询租户配置
+   */
+  getTenantCfg(config?: Partial<AxiosRequestConfig>): Promise<TenantConfig>;
+  /**
+   * 禁用设计器
+   */
   getTenantDisabledDevelop(
     query: getTenantDisabledDevelopQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 主题设置 保存/更新
+  ): Promise<string>;
+  /**
+   * 主题设置 保存/更新
+   */
   postTheme(
     data: SysConfigRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 企微证书文件上传
-  postUploadCertFile(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (平台管理)添加管理员 保存
+  ): Promise<string>;
+  /**
+   * 企微证书文件上传
+   */
+  postUploadCertFile(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * (平台管理)添加管理员 保存
+   */
   postUserRole(
     data: UserRoleRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (平台管理)管理员角色删除
+  ): Promise<string>;
+  /**
+   * (平台管理)管理员角色删除
+   */
   deleteUserRole(
     query: deleteUserRoleQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (平台管理)管理员角色编辑
+  ): Promise<string>;
+  /**
+   * (平台管理)管理员角色编辑
+   */
   postUserRoleReset(
     data: UserRoles4Update,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 人员类型导入重复数据 辅助唯一值字段
-  getUserField(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserFieldMeta[]>>;
-  // 查询平台版本
-  getVersion(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 水印设置 保存/更新
+  ): Promise<string>;
+  /**
+   * 人员类型导入重复数据 辅助唯一值字段
+   */
+  getUserField(config?: Partial<AxiosRequestConfig>): Promise<UserFieldMeta[]>;
+  /**
+   * 查询平台版本
+   */
+  getVersion(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 水印设置 保存/更新
+   */
   postWatermark(
     data: SysConfigRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 企业微信设置 保存/更新
+  ): Promise<string>;
+  /**
+   * 企业微信设置 保存/更新
+   */
   postWxwork(
     data: WXWorkConfig,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }