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

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

@@ -20,7 +20,10 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface putAppCleanUpIdPathParams {
   id: string;
@@ -42,16 +45,40 @@ export interface putEnableIdPathParams {
   id: string;
 }
 export interface getFieldMetaListQuery {
-  appId: string; // appId
-  env: string; // env
-  includeBuiltin?: boolean; // includeBuiltin
-  includeProcess?: boolean; // includeProcess
-  keyword?: string; // keyword
-  modelKey: string; // modelKey
-  sys?: boolean; // sys
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * env
+   */
+  env: string;
+  /**
+   * includeBuiltin
+   */
+  includeBuiltin?: boolean;
+  /**
+   * includeProcess
+   */
+  includeProcess?: boolean;
+  /**
+   * keyword
+   */
+  keyword?: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
+  /**
+   * sys
+   */
+  sys?: boolean;
 }
 export interface getGetAppCountTenantIdQuery {
-  type?: string; // type
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface getGetAppCountTenantIdPathParams {
   tenantId: string;
@@ -60,7 +87,10 @@ export interface getGetCurrentBranchAppIdPathParams {
   appId: string;
 }
 export interface getGetLatestCommitAppIdQuery {
-  branchId: string; // branchId
+  /**
+   * branchId
+   */
+  branchId: string;
 }
 export interface getGetLatestCommitAppIdPathParams {
   appId: string;
@@ -72,7 +102,10 @@ export interface postImportVersionAppIdPathParams {
   appId: string;
 }
 export interface getImportVersionPreviewAppIdQuery {
-  appPkgUrl: string; // appPkgUrl
+  /**
+   * appPkgUrl
+   */
+  appPkgUrl: string;
 }
 export interface getImportVersionPreviewAppIdPathParams {
   appId: string;
@@ -84,15 +117,27 @@ export interface getListBranchAppIdPathParams {
   appId: string;
 }
 export interface getMergeInfoAppIdQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getMergeInfoAppIdPathParams {
   appId: string;
 }
 export interface getMergePageListAppIdQuery {
-  keyword?: string; // keyword
-  pageNo?: number; // pageNo
-  pageSize?: number; // pageSize
+  /**
+   * keyword
+   */
+  keyword?: string;
+  /**
+   * pageNo
+   */
+  pageNo?: number;
+  /**
+   * pageSize
+   */
+  pageSize?: number;
 }
 export interface getMergePageListAppIdPathParams {
   appId: string;
@@ -101,83 +146,255 @@ export interface postMergeAppIdPathParams {
   appId: string;
 }
 export interface getMergePreviewAppIdQuery {
-  sourceBranchId: string; // sourceBranchId
-  targetBranchId: string; // targetBranchId
+  /**
+   * sourceBranchId
+   */
+  sourceBranchId: string;
+  /**
+   * targetBranchId
+   */
+  targetBranchId: string;
 }
 export interface getMergePreviewAppIdPathParams {
   appId: string;
 }
 export interface getModelMetaListQuery {
-  appId?: string; //
-  createTime?: string; //
-  createUserId?: string; //
-  createUserName?: string; //
-  deleted?: number; //
-  env?: string; //
-  fullPath?: string; //
-  id?: string; //
-  modifyTime?: string; //
-  modifyUserId?: string; //
-  modifyUserName?: string; //
-  name?: string; //
-  pageId?: string; // 关联的页面id, 当pageId 不为空时 追加pageId 相关数据
-  parentId?: string; // 父节点id , 有则传
-  relationId?: string; //
-  sortNum?: number; //
-  sysBuiltin?: number; //
+  /**
+   *
+   */
+  appId?: string;
+  /**
+   *
+   */
+  createTime?: string;
+  /**
+   *
+   */
+  createUserId?: string;
+  /**
+   *
+   */
+  createUserName?: string;
+  /**
+   *
+   */
+  deleted?: number;
+  /**
+   *
+   */
+  env?: string;
+  /**
+   *
+   */
+  fullPath?: string;
+  /**
+   *
+   */
+  id?: string;
+  /**
+   *
+   */
+  modifyTime?: string;
+  /**
+   *
+   */
+  modifyUserId?: string;
+  /**
+   *
+   */
+  modifyUserName?: string;
+  /**
+   * 所属模块(实体、枚举、web页面 、view_model_module/视图模型模块 、data_model/数据模型模块、document_module/单据)
+   */
+  module?: string;
+  /**
+   *
+   */
+  name?: string;
+  /**
+   * 关联的页面id, 当pageId 不为空时 追加pageId 相关数据
+   */
+  pageId?: string;
+  /**
+   * 父节点id , 有则传
+   */
+  parentId?: string;
+  /**
+   *
+   */
+  relationId?: string;
+  /**
+   *
+   */
+  sortNum?: number;
+  /**
+   *
+   */
+  sysBuiltin?: number;
 }
 export interface getPageListQuery {
-  deleted?: number; // 回收状态（0 正常应用 1 回收站应用）
-  description?: string; // 应用描述
-  endTime?: string; // 结束时间
-  id?: string; // 应用标识主键id
-  initFailReason?: string; // 错误原因
-  name?: string; // 应用名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  searchKey?: string; // 应用名称或者Id
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  tenantId?: string; // 所属租户id
-  type?: string; // 类型
+  /**
+   * 回收状态（0 正常应用 1 回收站应用）
+   */
+  deleted?: number;
+  /**
+   * 应用描述
+   */
+  description?: string;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 应用标识主键id
+   */
+  id?: string;
+  /**
+   * 错误原因
+   */
+  initFailReason?: string;
+  /**
+   * 应用名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 应用名称或者Id
+   */
+  searchKey?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 所属租户id
+   */
+  tenantId?: string;
+  /**
+   * 类型
+   */
+  type?: string;
 }
 export interface getPageListReleasedAppQuery {
-  deleted?: number; // 回收状态（0 正常应用 1 回收站应用）
-  description?: string; // 应用描述
-  endTime?: string; // 结束时间
-  id?: string; // 应用标识主键id
-  initFailReason?: string; // 错误原因
-  name?: string; // 应用名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  searchKey?: string; // 应用名称或者Id
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  tenantId?: string; // 所属租户id
-  type?: string; // 类型
+  /**
+   * 回收状态（0 正常应用 1 回收站应用）
+   */
+  deleted?: number;
+  /**
+   * 应用描述
+   */
+  description?: string;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 应用标识主键id
+   */
+  id?: string;
+  /**
+   * 错误原因
+   */
+  initFailReason?: string;
+  /**
+   * 应用名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 应用名称或者Id
+   */
+  searchKey?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 所属租户id
+   */
+  tenantId?: string;
+  /**
+   * 类型
+   */
+  type?: string;
 }
 export interface getPublishLogInfoAppIdQuery {
-  branchId: string; // branchId
-  publishId: string; // publishId
+  /**
+   * branchId
+   */
+  branchId: string;
+  /**
+   * publishId
+   */
+  publishId: string;
 }
 export interface getPublishLogInfoAppIdPathParams {
   appId: string;
 }
 export interface getPublishLogPageListAppIdQuery {
-  appEnv?: string; // 环境 test/prod
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  state?: string; // 状态
+  /**
+   * 环境 test/prod
+   */
+  appEnv?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 状态
+   */
+  state?: string;
 }
 export interface getPublishLogPageListAppIdPathParams {
   appId: string;
 }
 export interface getReportInfosQuery {
-  appId?: string; // app id
-  env?: string; // 环境
-  type?: boolean; // true:按分类，false:按数据集
+  /**
+   * app id
+   */
+  appId?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * true:按分类，false:按数据集
+   */
+  type?: boolean;
 }
 export interface postRevertAppIdPathParams {
   appId: string;
@@ -186,24 +403,57 @@ export interface postSwitchBranchAppIdPathParams {
   appId: string;
 }
 export interface getTenantAppsQuery {
-  deleted: number; // deleted
-  pageNo: number; // pageNo
-  pageSize: number; // pageSize
-  searchKey?: string; // searchKey
-  type?: string; // type
+  /**
+   * deleted
+   */
+  deleted: number;
+  /**
+   * pageNo
+   */
+  pageNo: number;
+  /**
+   * pageSize
+   */
+  pageSize: number;
+  /**
+   * searchKey
+   */
+  searchKey?: string;
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface getTenantRoleRolesAppsQuery {
-  pageNo: number; // pageNo
-  pageSize: number; // pageSize
-  searchKey?: string; // searchKey
-  type?: string; // type
+  /**
+   * pageNo
+   */
+  pageNo: number;
+  /**
+   * pageSize
+   */
+  pageSize: number;
+  /**
+   * searchKey
+   */
+  searchKey?: string;
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface getTenantRoleRolesAppsPathParams {
   roles: string;
 }
 export interface getTenantRoleRolesAppsCountQuery {
-  searchKey?: string; // searchKey
-  type?: string; // type
+  /**
+   * searchKey
+   */
+  searchKey?: string;
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface getTenantRoleRolesAppsCountPathParams {
   roles: string;
@@ -212,189 +462,263 @@ export interface putIdPathParams {
   id: string;
 }
 export interface AppService {
-  // 保存
+  /**
+   * 保存
+   */
   post(data: AppRequest, config?: Partial<AxiosRequestConfig>): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 回收站清除应用
+  /**
+   * 回收站清除应用
+   */
   putAppCleanUpId(
     path: putAppCleanUpIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 回收站还原应用
+  /**
+   * 回收站还原应用
+   */
   putAppRestoreIdUserId(
     path: putAppRestoreIdUserIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 校验应用的维护者是否还在该租户的开发人员列表中
+  /**
+   * 校验应用的维护者是否还在该租户的开发人员列表中
+   */
   getCheckAppMaintainerInTenantAppId(
     path: getCheckAppMaintainerInTenantAppIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 创建版本/分支
+  /**
+   * 创建版本/分支
+   */
   postCreateBranchAppId(
     path: postCreateBranchAppIdPathParams,
     data: CreateBranchRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 数据迁移的应用
+  /**
+   * 数据迁移的应用
+   */
   getDatamoveApps(config?: Partial<AxiosRequestConfig>): Promise<AppResponse[]>;
-  // 锁定应用
+  /**
+   * 锁定应用
+   */
   putDisableId(
     path: putDisableIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 解锁应用
+  /**
+   * 解锁应用
+   */
   putEnableId(
     path: putEnableIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 根据appid获取应用模型下的字段
+  /**
+   * 根据appid获取应用模型下的字段
+   */
   getFieldMetaList(
     query: getFieldMetaListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<FieldMetaResponse[]>;
-  // 租户应用数量查询
+  /**
+   * 租户应用数量查询
+   */
   getGetAppCountTenantId(
     path: getGetAppCountTenantIdPathParams,
     query: getGetAppCountTenantIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AppCountDto>;
-  // 获取当前版本/分支
+  /**
+   * 获取当前版本/分支
+   */
   getGetCurrentBranchAppId(
     path: getGetCurrentBranchAppIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AppBranchResponse>;
-  // 获取最新提交
+  /**
+   * 获取最新提交
+   */
   getGetLatestCommitAppId(
     path: getGetLatestCommitAppIdPathParams,
     query: getGetLatestCommitAppIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<CommitLogResponse>;
-  // 获取移动端sqlite文件路径
+  /**
+   * 获取移动端sqlite文件路径
+   */
   getGetMobileDbFileUrlAppId(
     path: getGetMobileDbFileUrlAppIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 导入版本
+  /**
+   * 导入版本
+   */
   postImportVersionAppId(
     path: postImportVersionAppIdPathParams,
     data: ImportVersionRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<CreateImportAppResponse>;
-  // 导入版本预览
+  /**
+   * 导入版本预览
+   */
   getImportVersionPreviewAppId(
     path: getImportVersionPreviewAppIdPathParams,
     query: getImportVersionPreviewAppIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MergePreviewResponse>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfoId(
     path: getInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AppResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(config?: Partial<AxiosRequestConfig>): Promise<AppResponse[]>;
-  // 查询版本/分支列表
+  /**
+   * 查询版本/分支列表
+   */
   getListBranchAppId(
     path: getListBranchAppIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AppBranchResponse[]>;
-  // 合并详情
+  /**
+   * 合并详情
+   */
   getMergeInfoAppId(
     path: getMergeInfoAppIdPathParams,
     query: getMergeInfoAppIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MergeLogResponse>;
-  // 合并记录分页列表
+  /**
+   * 合并记录分页列表
+   */
   getMergePageListAppId(
     path: getMergePageListAppIdPathParams,
     query: getMergePageListAppIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<MergeLogResponse>>;
-  // 合并
+  /**
+   * 合并
+   */
   postMergeAppId(
     path: postMergeAppIdPathParams,
     data: MergeRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 合并预览
+  /**
+   * 合并预览
+   */
   getMergePreviewAppId(
     path: getMergePreviewAppIdPathParams,
     query: getMergePreviewAppIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MergePreviewResponse>;
-  // 根据appid获取应用所有模型
+  /**
+   * 根据appid获取应用所有模型
+   */
   getModelMetaList(
     query: getModelMetaListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ModelCompleteResponse[]>;
-  // 查询租户下所有已发布应用(我的应用)
+  /**
+   * 查询租户下所有已发布应用(我的应用)
+   */
   getPageGetListReleasedApp(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AppResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<AppResponse>>;
-  // 查询租户下所有已发布应用 分页列表
+  /**
+   * 查询租户下所有已发布应用 分页列表
+   */
   getPageListReleasedApp(
     query: getPageListReleasedAppQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<AppResponse>>;
-  // 查询发布日志详情
+  /**
+   * 查询发布日志详情
+   */
   getPublishLogInfoAppId(
     path: getPublishLogInfoAppIdPathParams,
     query: getPublishLogInfoAppIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PublishLogResponse>;
-  // 分页查询发布日志
+  /**
+   * 分页查询发布日志
+   */
   getPublishLogPageListAppId(
     path: getPublishLogPageListAppIdPathParams,
     query: getPublishLogPageListAppIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<AppPublishLogResponse>>;
-  // 报表列表获取(按类型)
+  /**
+   * 报表列表获取(按类型)
+   */
   getReportInfos(
     query: getReportInfosQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IObject>;
-  // 回退上一版
+  /**
+   * 回退上一版
+   */
   postRevertAppId(
     path: postRevertAppIdPathParams,
     data: RevertRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PublishLogResponse>;
-  // 切换版本/分支
+  /**
+   * 切换版本/分支
+   */
   postSwitchBranchAppId(
     path: postSwitchBranchAppIdPathParams,
     data: SwitchBranchRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<void>;
-  // 租户下的应用
+  /**
+   * 租户下的应用
+   */
   getTenantApps(
     query: getTenantAppsQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<AppResponse>>;
-  // 租户下的我的角色应用
+  /**
+   * 租户下的我的角色应用
+   */
   getTenantRoleRolesApps(
     path: getTenantRoleRolesAppsPathParams,
     query: getTenantRoleRolesAppsQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<AppResponse>>;
-  // 租户下的我的角色应用数量
+  /**
+   * 租户下的我的角色应用数量
+   */
   getTenantRoleRolesAppsCount(
     path: getTenantRoleRolesAppsCountPathParams,
     query: getTenantRoleRolesAppsCountQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<number>;
-  // 文件上传minio
+  /**
+   * 文件上传minio
+   */
   postUploadAppPkg(config?: Partial<AxiosRequestConfig>): Promise<string>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: AppRequest,