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

package/lib/platform/service/apis/openapi-group.service.d.ts

@@ -7,90 +7,176 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id唯一标识
+  /**
+   * id唯一标识
+   */
+  id: string;
 }
 export interface getInfoAssociationModelQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
-  name?: string; // 关联模型名称
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * 关联模型名称
+   */
+  name?: string;
 }
 export interface getInfoOpenapiInfoQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
-  id?: string; // 接口id
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * 接口id
+   */
+  id?: string;
 }
 export interface getInfoPageListQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
-  key?: string; // 接口标识
-  modelKey?: string; // 关联模型
-  name?: string; // 接口名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * 接口标识
+   */
+  key?: string;
+  /**
+   * 关联模型
+   */
+  modelKey?: string;
+  /**
+   * 接口名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface getListDownloadQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
 }
 export interface getPageListQuery {
-  appId?: string; // 应用标识
-  env?: string; // 环境
-  name?: string; // 应用名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 应用标识
+   */
+  appId?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * 应用名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface OpenapiGroupService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: OpenapiGroupRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 分组详情-基础信息
+  /**
+   * 分组详情-基础信息
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OpenapiGroupResponse>;
-  // 分组详情-关联模型列表
+  /**
+   * 分组详情-关联模型列表
+   */
   getInfoAssociationModel(
     query: getInfoAssociationModelQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IObject>;
-  // 分组详情-api管理列表-单个接口详情
+  /**
+   * 分组详情-api管理列表-单个接口详情
+   */
   getInfoOpenapiInfo(
     query: getInfoOpenapiInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ApiInfo>;
-  // 分组详情-api管理列表
+  /**
+   * 分组详情-api管理列表
+   */
   getInfoPageList(
     query: getInfoPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<OpenapiResponse>>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OpenapiGroupResponse[]>;
-  // 分组PDF导出
+  /**
+   * 分组PDF导出
+   */
   getListDownload(
     query: getListDownloadQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<unknown>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<OpenapiGroupResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: OpenapiGroupRequest,

package/lib/platform/service/apis/openapi-key-grant.service.d.ts

@@ -7,54 +7,88 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getOpenapiListQuery {
-  appTag?: string; // 应用标识
-  env?: string; // 环境
+  /**
+   * 应用标识
+   */
+  appTag?: string;
+  /**
+   * 环境
+   */
+  env?: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface OpenapiKeyGrantService {
-  // 新建保存
+  /**
+   * 新建保存
+   */
   post(config?: Partial<AxiosRequestConfig>): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 授权信息详情
+  /**
+   * 授权信息详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OpenapiKeyGrantResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OpenapiKeyGrantResponse[]>;
-  // 已开放api列表
+  /**
+   * 已开放api列表
+   */
   getOpenapiList(
     query: getOpenapiListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OpenapiAggregateByModelTreeResponse[]>;
-  // 已开放租户api列表
+  /**
+   * 已开放租户api列表
+   */
   getOpenapiTenantList(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OpenapiAggregateResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<OpenapiKeyGrantResponse>>;
-  // 授权接口修改
+  /**
+   * 授权接口修改
+   */
   putId(
     path: putIdPathParams,
     data: OpenapiAuthorizationSetRequest,

package/lib/platform/service/apis/org-user-picker.service.d.ts

@@ -2,35 +2,67 @@ import type { AxiosRequestConfig } from 'axios';
 import type { PickerUserDTO, PickerOrgDTO } from '../entities';
 
 export interface getManagementUserListByIdsQuery {
-  ids?: string; // ids
+  /**
+   * ids
+   */
+  ids?: string;
 }
 export interface getTenantManagementOrgUserPageListQuery {
-  keyword?: string; // 关键字
-  orgId?: string; // 部门id
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
+  /**
+   * 关键字
+   */
+  keyword?: string;
+  /**
+   * 部门id
+   */
+  orgId?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
 }
 export interface getTenantManagementUserListByIdsQuery {
-  ids?: string; // ids
+  /**
+   * ids
+   */
+  ids?: string;
 }
 export interface OrgUserPickerService {
-  // 后台查询指定id的用户
+  /**
+   * 后台查询指定id的用户
+   */
   getManagementUserListByIds(
     query: getManagementUserListByIdsQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PickerUserDTO[]>;
-  // 租户后台查询所有组织
+  /**
+   * 租户后台查询所有组织
+   */
   getTenantManagementOrgList(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PickerOrgDTO[]>;
-  // 租户后台分页查询指定部门下的用户
+  /**
+   * 租户后台分页查询指定部门下的用户
+   */
   getTenantManagementOrgUserPageList(
     query: getTenantManagementOrgUserPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<PickerUserDTO>>;
-  // 租户后台查询指定id的用户
+  /**
+   * 租户后台查询指定id的用户
+   */
   getTenantManagementUserListByIds(
     query: getTenantManagementUserListByIdsQuery,
     config?: Partial<AxiosRequestConfig>,

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

@@ -12,113 +12,201 @@ 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 putIdPathParams {
   id: string;
 }
 export interface OrgService {
-  // 组织保存
+  /**
+   * 组织保存
+   */
   post(data: OrgRequest, config?: Partial<AxiosRequestConfig>): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 拖拽
+  /**
+   * 拖拽
+   */
   postDrag(
     data: OrgDragRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfoId(
     path: getInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OrgResponse>;
-  // 名称、编号输入校验
+  /**
+   * 名称、编号输入校验
+   */
   postInputCheck(
     data: OrgRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(config?: Partial<AxiosRequestConfig>): Promise<OrgResponse[]>;
-  // 组织删除校验
+  /**
+   * 组织删除校验
+   */
   postOrgHavePersonCheck(
     data: OrgRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 转移并删除
+  /**
+   * 转移并删除
+   */
   postTransferAndDelete(
     data: OrgTransferAndDeleteRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 组织成员添加用户
+  /**
+   * 组织成员添加用户
+   */
   postUserAdd(
     data: OrgAddOrUpdateUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 创建并添加用户
+  /**
+   * 创建并添加用户
+   */
   postUserCreateAndAdd(
     data: OrgCreateAndAddUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 查询用户详情
+  /**
+   * 查询用户详情
+   */
   getUserInfo(
     query: getUserInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OrgUserResponse>;
-  // 查询当前租户下的用户
+  /**
+   * 查询当前租户下的用户
+   */
   getUserListCurrentTenantUser(
     query: getUserListCurrentTenantUserQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<OrgUserResponse[]>;
-  // 组织成员移动用户
+  /**
+   * 组织成员移动用户
+   */
   postUserMove(
     data: OrgMoveUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 组织用户分页查询
+  /**
+   * 组织用户分页查询
+   */
   getUserPageList(
     query: getUserPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<OrgUserResponse>>;
-  // 移除用户
+  /**
+   * 移除用户
+   */
   postUserRemove(
     data: OrgRemoveUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 组织成员编辑用户
+  /**
+   * 组织成员编辑用户
+   */
   postUserUpdate(
     data: OrgAddOrUpdateUserRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 组织成员修改
+  /**
+   * 组织成员修改
+   */
   putId(
     path: putIdPathParams,
     data: OrgRequest,

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

@@ -1,9 +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返回
+  /**
+   * 解析CSV或Excel文件，将内容构建成List返回
+   */
   get(query: getQuery, config?: Partial<AxiosRequestConfig>): Promise<unknown>;
 }