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

package/es/apaas/service/apis/permission.service.d.ts

@@ -2,51 +2,78 @@ import type { AxiosRequestConfig } from 'axios';
 import type { PermissionRequest, PermissionResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  relationId?: string; //
+  /**
+   *
+   */
+  relationId?: 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>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PermissionResponse>>;
-  // 列表
+  ): Promise<PermissionResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PermissionResponse[]>>;
-  // 分页列表
+  ): 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/es/apaas/service/apis/plat.service.d.ts

@@ -8,28 +8,38 @@ import type {
 } from '../entities';
 
 export interface PlatService {
-  // 应用全局配置设置 保存/更新
+  /**
+   * 应用全局配置设置 保存/更新
+   */
   postAppGlobal(
     data: SysConfigRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 应用全局配置设置 查询
+  ): Promise<string>;
+  /**
+   * 应用全局配置设置 查询
+   */
   getAppGlobalInfo(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<SysConfigResponse>>;
-  // 基础设置 保存/更新
+  ): Promise<SysConfigResponse>;
+  /**
+   * 基础设置 保存/更新
+   */
   postBase(
     data: PlatformBaseConfig,
     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>>;
+  ): Promise<string>;
 }

package/es/apaas/service/apis/pm-process-definition-version.service.d.ts

@@ -7,60 +7,91 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
+}
+export interface postCopyIdPathParams {
+  id: string;
 }
 export interface postDeployQuery {
-  procVerId?: string; // procVerId
+  /**
+   * procVerId
+   */
+  procVerId?: string;
 }
 export interface getListQuery {
-  procDefId: string; // 流程定义id(表单版本id)
+  /**
+   * 流程定义id(表单版本id)
+   */
+  procDefId: string;
 }
-export interface getIdQuery {
-  id: string; // 数据主键
+export interface getIdPathParams {
+  id: string;
 }
 export interface PmProcessDefinitionVersionService {
-  // 新建版本
+  /**
+   * 新建版本
+   */
   post(
     data: PmProcessDefinitionVersionRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 复制
+  ): Promise<boolean>;
+  /**
+   * 复制
+   */
   postCopyId(
+    path: postCopyIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 发布
+  ): Promise<string>;
+  /**
+   * 发布
+   */
   postDeploy(
     query: postDeployQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 列表
+  ): Promise<string>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ProcessDefinitionVerListResponse[]>>;
-  // 保存
+  ): Promise<ProcessDefinitionVerListResponse[]>;
+  /**
+   * 保存
+   */
   postSave(
     data: PmProcessDefinitionVersionRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 保存并发布
+  ): Promise<string>;
+  /**
+   * 保存并发布
+   */
   postSaveAndDeploy(
     data: PmProcessDefinitionVersionRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 保存审批人和消息接收人
+  ): Promise<string>;
+  /**
+   * 保存审批人和消息接收人
+   */
   postUpdateProcessUser(
     data: ProcessUserRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getId(
-    query: getIdQuery,
+    path: getIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ProcessDefinitionVersionResponse>>;
+  ): Promise<ProcessDefinitionVersionResponse>;
 }

package/es/apaas/service/apis/pm-process-definition.service.d.ts

@@ -7,65 +7,115 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListAllProcHasPublishedVersionQuery {
-  moduleType?: string; // moduleType
+  /**
+   * moduleType
+   */
+  moduleType?: string;
 }
 export interface getPageListQuery {
-  categoryId: string; // categoryId
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  query?: string; // query
+  /**
+   * categoryId
+   */
+  categoryId: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * query
+   */
+  query?: string;
 }
 export interface getPageListByPageQuery {
-  categoryId: string; // categoryId
-  modelKey?: string; // modelKey
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  query?: string; // query
+  /**
+   * categoryId
+   */
+  categoryId: string;
+  /**
+   * modelKey
+   */
+  modelKey?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * query
+   */
+  query?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface PmProcessDefinitionService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PmProcessDefinition,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PmProcessVersion>>;
-  // 删除
+  ): Promise<PmProcessVersion>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PmProcessDefinition>>;
-  // 获取所有流程且含有激活版本
+  ): Promise<PmProcessDefinition>;
+  /**
+   * 获取所有流程且含有激活版本
+   */
   getListAllProcHasPublishedVersion(
     query: getListAllProcHasPublishedVersionQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryCompleteResponse[]>>;
-  // 分页列表(需含激活版本)
+  ): Promise<CategoryCompleteResponse[]>;
+  /**
+   * 分页列表(需含激活版本)
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PmProcessActiveVersion>>>;
-  // 分页列表
+  ): Promise<IPage<PmProcessActiveVersion>>;
+  /**
+   * 分页列表
+   */
   getPageListByPage(
     query: getPageListByPageQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PmProcessActiveVersion>>>;
-  // 修改
+  ): Promise<IPage<PmProcessActiveVersion>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PmProcessDefinition,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/es/apaas/service/apis/pm-process-engine.service.d.ts

@@ -12,115 +12,197 @@ import type {
 } from '../entities';
 
 export interface getHiTaskExtensionQuery {
-  taskId: string; // taskId
+  /**
+   * taskId
+   */
+  taskId: string;
 }
 export interface getInitialTaskExtensionQuery {
-  processInstanceId: string; // processInstanceId
+  /**
+   * processInstanceId
+   */
+  processInstanceId: string;
 }
 export interface getModelQuery {
-  processInstanceId: string; // processInstanceId
+  /**
+   * processInstanceId
+   */
+  processInstanceId: string;
 }
 export interface getPageListQuery {
-  assignees?: string; // 当前审批人
-  combinedStatus?: string; // 流程状态
-  initiator?: string; // 发起人
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  processDefName?: string; // 流程名称
-  processInstanceId?: string; // 流程实例id
-  taskNames?: string; // 当前环节
-  title?: string; // 流程标题
+  /**
+   * 当前审批人
+   */
+  assignees?: string;
+  /**
+   * 流程状态
+   */
+  combinedStatus?: string;
+  /**
+   * 发起人
+   */
+  initiator?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 流程名称
+   */
+  processDefName?: string;
+  /**
+   * 流程实例id
+   */
+  processInstanceId?: string;
+  /**
+   * 当前环节
+   */
+  taskNames?: string;
+  /**
+   * 流程标题
+   */
+  title?: string;
 }
 export interface getProcInstExtensionQuery {
-  dataId?: string; // dataId
-  modelKey?: string; // modelKey
-  procInstId?: string; // procInstId
+  /**
+   * dataId
+   */
+  dataId?: string;
+  /**
+   * modelKey
+   */
+  modelKey?: string;
+  /**
+   * procInstId
+   */
+  procInstId?: string;
 }
 export interface getTaskExtensionQuery {
-  taskId: string; // taskId
+  /**
+   * taskId
+   */
+  taskId: string;
 }
 export interface PmProcessEngineService {
-  // 通过/同意
+  /**
+   * 通过/同意
+   */
   postApprove(
     data: ProcessOperateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取已办任务节点拓展信息
+  ): Promise<string>;
+  /**
+   * 获取已办任务节点拓展信息
+   */
   getHiTaskExtension(
     query: getHiTaskExtensionQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TaskNodeOp>>;
-  // 获取流程开始节点拓展信息
+  ): Promise<TaskNodeOp>;
+  /**
+   * 获取流程开始节点拓展信息
+   */
   getInitialTaskExtension(
     query: getInitialTaskExtensionQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<StarterNodeOp>>;
-  // 获取所有审批人
+  ): Promise<StarterNodeOp>;
+  /**
+   * 获取所有审批人
+   */
   getListAllAssignees(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserBase[]>>;
-  // 获取所有发起人
+  ): Promise<UserBase[]>;
+  /**
+   * 获取所有发起人
+   */
   getListAllInitiators(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserBase[]>>;
-  // 获取模型数据
+  ): Promise<UserBase[]>;
+  /**
+   * 获取模型数据
+   */
   getModel(
     query: getModelQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ProcModelDataInfo>>;
-  // 分页列表
+  ): Promise<ProcModelDataInfo>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<ProcessInstanceResponse>>>;
-  // 流程按钮操作
+  ): Promise<IPage<ProcessInstanceResponse>>;
+  /**
+   * 流程按钮操作
+   */
   postProcExecute(
     data: ProcessOperateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取流程拓展信息
+  ): Promise<string>;
+  /**
+   * 获取流程拓展信息
+   */
   getProcInstExtension(
     query: getProcInstExtensionQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ProcessExtension>>;
-  // 转交
+  ): Promise<ProcessExtension>;
+  /**
+   * 转交
+   */
   postReassign(
     data: ProcessOperateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 拒绝/不同意
+  ): Promise<string>;
+  /**
+   * 拒绝/不同意
+   */
   postRefuse(
     data: ProcessOperateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 驳回
+  ): Promise<string>;
+  /**
+   * 驳回
+   */
   postReject(
     data: ProcessOperateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 重新提交
+  ): Promise<string>;
+  /**
+   * 重新提交
+   */
   postResubmit(
     data: ProcessOperateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 流程发起
+  ): Promise<string>;
+  /**
+   * 流程发起
+   */
   postStartProcInst(
     data: ProcStartInstRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ProcessInstance>>;
-  // 获取待办任务节点拓展信息
+  ): Promise<ProcessInstance>;
+  /**
+   * 获取待办任务节点拓展信息
+   */
   getTaskExtension(
     query: getTaskExtensionQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TaskNodeOp>>;
-  // 终止
+  ): Promise<TaskNodeOp>;
+  /**
+   * 终止
+   */
   postTerminate(
     data: ProcessOperateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 撤回
+  ): Promise<string>;
+  /**
+   * 撤回
+   */
   postWithdraw(
     data: ProcessOperateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }