@gct-paas/api 0.1.0-word.2 → 0.1.0

package/lib/apaas/service/apis/designer-common.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   EnumModelFieldResponse,
   GetAppResponse,
@@ -8,167 +9,438 @@ import type {
 } from '../entities';
 
 export interface getEnumModelFieldListQuery {
-  endTime?: string; // 结束时间
-  enumModelId?: string; // 枚举模型id
-  enumModelKey?: string; // 枚举模型Key
-  id?: string; // 枚举字段id
-  pageNo?: number; // 页码
-  pageSize?: number; // 一页条数，覆盖父类默认值
-  searchKey?: string; // 枚举文本/枚举值
-  sortField?: string; // 排序字段
-  sortNum?: number; // 排序
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  text?: string; // 枚举文本
-  value?: string; // 枚举值
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 枚举模型id
+   */
+  enumModelId?: string;
+  /**
+   * 枚举模型Key
+   */
+  enumModelKey?: string;
+  /**
+   * 枚举字段id
+   */
+  id?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 一页条数，覆盖父类默认值
+   */
+  pageSize?: number;
+  /**
+   * 枚举文本/枚举值
+   */
+  searchKey?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序
+   */
+  sortNum?: number;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 枚举文本
+   */
+  text?: string;
+  /**
+   * 枚举值
+   */
+  value?: string;
 }
 export interface getGetCanBeUsedOrgUserQuery {
-  allUserOption?: number; // 是否显示主部门与下级部门所有人员
-  appUserGranted?: number; // 应用用户是否授权
-  fieldKey?: string; // 字段 key，不涉及字段的情况下不用传
-  ignoreCase?: number; // 是否忽略大小写
-  ignoreEnabled?: number; // 是否忽略用户状态
-  keyword?: string; // 关键字
-  keywordFields?: string; // 关键字筛选字段
-  modelKey?: string; // 模型 key，不涉及字段的情况下不用传
-  orgId?: string; // 部门id
-  orgIds?: string; // 部门id，多个的情况
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  userGroupIds?: string; // 用户组id
-  userName?: string; // 查询的用户姓名或账号
+  /**
+   * 是否显示主部门与下级部门所有人员
+   */
+  allUserOption?: number;
+  /**
+   * 应用用户是否授权
+   */
+  appUserGranted?: number;
+  /**
+   * 字段 key，不涉及字段的情况下不用传
+   */
+  fieldKey?: string;
+  /**
+   * 是否忽略大小写
+   */
+  ignoreCase?: number;
+  /**
+   * 是否忽略用户状态
+   */
+  ignoreEnabled?: number;
+  /**
+   * 关键字
+   */
+  keyword?: string;
+  /**
+   * 关键字筛选字段
+   */
+  keywordFields?: string[];
+  /**
+   * 模型 key，不涉及字段的情况下不用传
+   */
+  modelKey?: string;
+  /**
+   * 部门id
+   */
+  orgId?: string;
+  /**
+   * 部门id，多个的情况
+   */
+  orgIds?: string[];
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 用户组id
+   */
+  userGroupIds?: string[];
+  /**
+   * 查询的用户姓名或账号
+   */
+  userName?: string;
 }
 export interface getGetUserGroupUserQuery {
-  allUserOption?: number; // 是否显示主部门与下级部门所有人员
-  appUserGranted?: number; // 应用用户是否授权
-  fieldKey?: string; // 字段 key，不涉及字段的情况下不用传
-  ignoreCase?: number; // 是否忽略大小写
-  ignoreEnabled?: number; // 是否忽略用户状态
-  keyword?: string; // 关键字
-  keywordFields?: string; // 关键字筛选字段
-  modelKey?: string; // 模型 key，不涉及字段的情况下不用传
-  orgId?: string; // 部门id
-  orgIds?: string; // 部门id，多个的情况
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  userGroupIds?: string; // 用户组id
-  userName?: string; // 查询的用户姓名或账号
+  /**
+   * 是否显示主部门与下级部门所有人员
+   */
+  allUserOption?: number;
+  /**
+   * 应用用户是否授权
+   */
+  appUserGranted?: number;
+  /**
+   * 字段 key，不涉及字段的情况下不用传
+   */
+  fieldKey?: string;
+  /**
+   * 是否忽略大小写
+   */
+  ignoreCase?: number;
+  /**
+   * 是否忽略用户状态
+   */
+  ignoreEnabled?: number;
+  /**
+   * 关键字
+   */
+  keyword?: string;
+  /**
+   * 关键字筛选字段
+   */
+  keywordFields?: string[];
+  /**
+   * 模型 key，不涉及字段的情况下不用传
+   */
+  modelKey?: string;
+  /**
+   * 部门id
+   */
+  orgId?: string;
+  /**
+   * 部门id，多个的情况
+   */
+  orgIds?: string[];
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 用户组id
+   */
+  userGroupIds?: string[];
+  /**
+   * 查询的用户姓名或账号
+   */
+  userName?: string;
 }
 export interface getGetVisibleOrgUserQuery {
-  allUserOption?: number; // 是否显示主部门与下级部门所有人员
-  appUserGranted?: number; // 应用用户是否授权
-  fieldKey?: string; // 字段 key，不涉及字段的情况下不用传
-  ignoreCase?: number; // 是否忽略大小写
-  ignoreEnabled?: number; // 是否忽略用户状态
-  keyword?: string; // 关键字
-  keywordFields?: string; // 关键字筛选字段
-  modelKey?: string; // 模型 key，不涉及字段的情况下不用传
-  orgId?: string; // 部门id
-  orgIds?: string; // 部门id，多个的情况
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  userGroupIds?: string; // 用户组id
-  userName?: string; // 查询的用户姓名或账号
+  /**
+   * 是否显示主部门与下级部门所有人员
+   */
+  allUserOption?: number;
+  /**
+   * 应用用户是否授权
+   */
+  appUserGranted?: number;
+  /**
+   * 字段 key，不涉及字段的情况下不用传
+   */
+  fieldKey?: string;
+  /**
+   * 是否忽略大小写
+   */
+  ignoreCase?: number;
+  /**
+   * 是否忽略用户状态
+   */
+  ignoreEnabled?: number;
+  /**
+   * 关键字
+   */
+  keyword?: string;
+  /**
+   * 关键字筛选字段
+   */
+  keywordFields?: string[];
+  /**
+   * 模型 key，不涉及字段的情况下不用传
+   */
+  modelKey?: string;
+  /**
+   * 部门id
+   */
+  orgId?: string;
+  /**
+   * 部门id，多个的情况
+   */
+  orgIds?: string[];
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 用户组id
+   */
+  userGroupIds?: string[];
+  /**
+   * 查询的用户姓名或账号
+   */
+  userName?: string;
 }
 export interface getGetVisibleUserAndVisibleOrgUserQuery {
-  allUserOption?: number; // 是否显示主部门与下级部门所有人员
-  appUserGranted?: number; // 应用用户是否授权
-  fieldKey?: string; // 字段 key，不涉及字段的情况下不用传
-  ignoreCase?: number; // 是否忽略大小写
-  ignoreEnabled?: number; // 是否忽略用户状态
-  keyword?: string; // 关键字
-  keywordFields?: string; // 关键字筛选字段
-  modelKey?: string; // 模型 key，不涉及字段的情况下不用传
-  orgId?: string; // 部门id
-  orgIds?: string; // 部门id，多个的情况
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  userGroupIds?: string; // 用户组id
-  userName?: string; // 查询的用户姓名或账号
+  /**
+   * 是否显示主部门与下级部门所有人员
+   */
+  allUserOption?: number;
+  /**
+   * 应用用户是否授权
+   */
+  appUserGranted?: number;
+  /**
+   * 字段 key，不涉及字段的情况下不用传
+   */
+  fieldKey?: string;
+  /**
+   * 是否忽略大小写
+   */
+  ignoreCase?: number;
+  /**
+   * 是否忽略用户状态
+   */
+  ignoreEnabled?: number;
+  /**
+   * 关键字
+   */
+  keyword?: string;
+  /**
+   * 关键字筛选字段
+   */
+  keywordFields?: string[];
+  /**
+   * 模型 key，不涉及字段的情况下不用传
+   */
+  modelKey?: string;
+  /**
+   * 部门id
+   */
+  orgId?: string;
+  /**
+   * 部门id，多个的情况
+   */
+  orgIds?: string[];
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 用户组id
+   */
+  userGroupIds?: string[];
+  /**
+   * 查询的用户姓名或账号
+   */
+  userName?: string;
 }
 export interface getListUserByIdsQuery {
-  fieldKey?: string; // 字段 key
-  ids?: string; // ids
-  modelKey?: string; // 模型 key
+  /**
+   * 字段 key
+   */
+  fieldKey?: string;
+  /**
+   * ids
+   */
+  ids?: string[];
+  /**
+   * 模型 key
+   */
+  modelKey?: string;
 }
 export interface getTableEntityModelListQuery {
-  subModel?: number; // 模型是否为子模型 不传查询全部(1 子模型, 0 非子模型)
-  type?: string; // 模型标志:(NDO/RDO) 多个类型逗号分隔
+  /**
+   * 模型是否为子模型 不传查询全部(1 子模型, 0 非子模型)
+   */
+  subModel?: number;
+  /**
+   * 模型标志:(NDO/RDO) 多个类型逗号分隔
+   */
+  type?: string;
 }
 export interface postUploadFileQuery {
-  type?: string; // type
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface DesignerCommonService {
-  // 设计态查询枚举字段
+  /**
+   * 设计态查询枚举字段
+   */
   getEnumModelFieldList(
     query: getEnumModelFieldListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<EnumModelFieldResponse>>>;
-  // 获取应用信息
-  getGetApp(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<GetAppResponse>>;
-  // 获取应用可使用组织
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<EnumModelFieldResponse>>;
+  /**
+   * 获取应用信息
+   */
+  getGetApp(config?: Partial<AxiosRequestConfig>): Promise<GetAppResponse>;
+  /**
+   * 获取应用可使用组织
+   */
   getGetCanBeUsedOrg(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PickerOrgDTO[]>>;
-  // 获取应用可使用组织下的人员
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PickerOrgDTO[]>;
+  /**
+   * 获取应用可使用组织下的人员
+   */
   getGetCanBeUsedOrgUser(
     query: getGetCanBeUsedOrgUserQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<PickerUserDTO>>>;
-  // 获取用户组下的人员
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<PickerUserDTO>>;
+  /**
+   * 获取用户组下的人员
+   */
   getGetUserGroupUser(
     query: getGetUserGroupUserQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PickerUserDTO[]>>;
-  // 获取应用可见组织
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PickerUserDTO[]>;
+  /**
+   * 获取应用可见组织
+   */
   getGetVisibleOrg(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PickerOrgDTO[]>>;
-  // 获取应用可见组织下的人员
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PickerOrgDTO[]>;
+  /**
+   * 获取应用可见组织下的人员
+   */
   getGetVisibleOrgUser(
     query: getGetVisibleOrgUserQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<PickerUserDTO>>>;
-  // 获取应用可见用户
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<PickerUserDTO>>;
+  /**
+   * 获取应用可见用户
+   */
   getGetVisibleUser(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PickerUserDTO[]>>;
-  // 获取应用可见用户与可见组织下的用户
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PickerUserDTO[]>;
+  /**
+   * 获取应用可见用户与可见组织下的用户
+   */
   getGetVisibleUserAndVisibleOrgUser(
     query: getGetVisibleUserAndVisibleOrgUserQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PickerUserDTO[]>>;
-  // 获取指定组织人员
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PickerUserDTO[]>;
+  /**
+   * 获取指定组织人员
+   */
   getListUserByIds(
     query: getListUserByIdsQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PickerUserDTO[]>>;
-  // 模型列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PickerUserDTO[]>;
+  /**
+   * 模型列表
+   */
   getTableEntityModelList(
     query: getTableEntityModelListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelBriefInfo[]>>;
-  // 应用文件上传
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelBriefInfo[]>;
+  /**
+   * 应用文件上传
+   */
   postUploadFile(
     query: postUploadFileQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 上传标签图片
-  postUploadLabelImage(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取用户角色权限组
-  getUserInfo(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<UserOfAppDTO>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 上传标签图片
+   */
+  postUploadLabelImage(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 获取用户角色权限组
+   */
+  getUserInfo(config?: Partial<AxiosRequestConfig>): Promise<UserOfAppDTO>;
 }

package/lib/apaas/service/apis/designer-lock.service.d.ts

@@ -1,33 +1,50 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { PageLockRequest, PageOccupyResponse } from '../entities';
 
 export interface getGetPageOccupyMsgQuery {
-  id: string; // id
-  type?: string; // type
+  /**
+   * id
+   */
+  id: string;
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface DesignerLockService {
-  // 取消page页面占用
+  /**
+   * 取消page页面占用
+   */
   postCancelOccupyPage(
     data: PageLockRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取page页面占用信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 获取page页面占用信息
+   */
   getGetPageOccupyMsg(
     query: getGetPageOccupyMsgQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PageOccupyResponse>>;
-  // 锁定page页面
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PageOccupyResponse>;
+  /**
+   * 锁定page页面
+   */
   postLockPage(
     data: PageLockRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 占用page页面进行编辑
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 占用page页面进行编辑
+   */
   postOccupyPage(
     data: PageLockRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 解除锁定page页面
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 解除锁定page页面
+   */
   postUnLockPage(
     data: PageLockRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }