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

package/lib/apaas/service/apis/field.service.d.ts

@@ -1,10 +1,16 @@
+import type { AxiosRequestConfig } from 'axios';
 export interface deleteRemoveQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface FieldService {
-  // 删除模型字段,支持多个
+  /**
+   * 删除模型字段,支持多个
+   */
   deleteRemove(
     query: deleteRemoveQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/file-resource.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   Base64UploadRequest,
   FileResource4Req,
@@ -5,23 +6,35 @@ import type {
 } from '../entities';
 
 export interface postUploadQuery {
-  modelKey?: string; // 模型key
-  type?: string; // 资源分类枚举 LABEL_IMAGE:标签图片/MODEL_EXCEL:模型导入模板
+  /**
+   * 模型key
+   */
+  modelKey?: string;
+  /**
+   * 资源分类枚举 LABEL_IMAGE:标签图片/MODEL_EXCEL:模型导入模板
+   */
+  type?: string;
 }
 export interface FileResourceService {
-  // base64文件上传minio
+  /**
+   * base64文件上传minio
+   */
   postBase64Upload(
     data: Base64UploadRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 批量查询文件信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 批量查询文件信息
+   */
   postList(
     data: FileResource4Req,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FileResourceResponse[]>>;
-  // 文件上传minio
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FileResourceResponse[]>;
+  /**
+   * 文件上传minio
+   */
   postUpload(
     query: postUploadQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/file-task.service.d.ts

@@ -1,16 +1,23 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { FileTaskStatus, FileTaskDTO } from '../entities';
 
 export interface FileTaskService {
-  // 立即开启文件转换任务
-  getStart(config?: Record<string, string>): Promise<IHttpResponse<string>>;
-  // 更新文件转换状态
+  /**
+   * 立即开启文件转换任务
+   */
+  getStart(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 更新文件转换状态
+   */
   postStatus(
     data: FileTaskStatus,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 新增生成PDF任务
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 新增生成PDF任务
+   */
   postSubmit(
     data: FileTaskDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/file.service.d.ts

@@ -1,28 +1,44 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {} from '../entities';
 
 export interface postPdfEncodeQuery {
-  url: string; // pdf相对地址
+  /**
+   * pdf相对地址
+   */
+  url: string;
 }
 export interface postPdfPageQuery {
-  url: string; // pdf相对地址
+  /**
+   * pdf相对地址
+   */
+  url: string;
 }
 export interface postUploadImageQuery {
-  bucket: string; // 桶枚举值,(IMAGE 图片桶,ICON 图标桶)
+  /**
+   * 桶枚举值,(IMAGE 图片桶,ICON 图标桶)
+   */
+  bucket: string;
 }
 export interface FileService {
-  // PDF文件转图片返回BASE64编码
+  /**
+   * PDF文件转图片返回BASE64编码
+   */
   postPdfEncode(
     query: postPdfEncodeQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string[]>>;
-  // PDF文件转图片返回BASE64编码
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string[]>;
+  /**
+   * PDF文件转图片返回BASE64编码
+   */
   postPdfPage(
     query: postPdfPageQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<number>>;
-  // 文件上传minio
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<number>;
+  /**
+   * 文件上传minio
+   */
   postUploadImage(
     query: postUploadImageQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/form.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   DhrProcessApproveRequest,
   DhrProcessReassign4InterfereRequest,
@@ -8,34 +9,46 @@ import type {
 } from '../entities';
 
 export interface FormService {
-  // 审核
+  /**
+   * 审核
+   */
   postChangeProcessApprove(
     data: DhrProcessApproveRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 流程干预转办
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 流程干预转办
+   */
   postChangeProcessInterfereReassign(
     data: DhrProcessReassign4InterfereRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 流程干预退回
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 流程干预退回
+   */
   postChangeProcessInterfereReturn(
     data: DhrProcessReturn4InterfereRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 根据按钮key跳转流程节点
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 根据按钮key跳转流程节点
+   */
   postChangeProcessJump(
     data: DhrProcessJumpRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 转办
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 转办
+   */
   postChangeProcessReassign(
     data: DhrProcessReassignRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 退回
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 退回
+   */
   postChangeProcessReturn(
     data: DhrProcessReturnRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/formRelate.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   CategoryCompleteVO,
   CategoryRequest,
@@ -9,113 +10,234 @@ import type {
 } from '../entities';
 
 export interface getCategoryQuery {
-  moduleType: string; // moduleType
+  /**
+   * moduleType
+   */
+  moduleType: string;
 }
 export interface deleteCategoryQuery {
-  id: string; // 删除的分类id
-  moduleType: string; // 模块类型
+  /**
+   * 删除的分类id
+   */
+  id: string;
+  /**
+   * 模块类型
+   */
+  moduleType: string;
+}
+export interface putCategoryIdPathParams {
+  id: string;
 }
 export interface deleteDeleteCategoryQuery {
-  id: string; // 删除的分类id
-  moduleType: string; // 模块类型
+  /**
+   * 删除的分类id
+   */
+  id: string;
+  /**
+   * 模块类型
+   */
+  moduleType: string;
 }
 export interface getInfoQuery {
-  id: string; // id
-  moduleType: string; // moduleType
+  /**
+   * id
+   */
+  id: string;
+  /**
+   * moduleType
+   */
+  moduleType: string;
 }
 export interface getListAllCategoryQuery {
-  moduleType: string; // moduleType
-  name?: string; // name
+  /**
+   * moduleType
+   */
+  moduleType: string;
+  /**
+   * name
+   */
+  name?: string;
 }
 export interface getListAllVersionQuery {
-  baseId: string; // baseId
-  moduleType: string; // moduleType
-  name?: string; // name
+  /**
+   * baseId
+   */
+  baseId: string;
+  /**
+   * moduleType
+   */
+  moduleType: string;
+  /**
+   * name
+   */
+  name?: string;
 }
 export interface getPageListAllModelKeyQuery {
-  name?: string; // name
-  pageNo: number; // pageNo
-  pageSize: number; // pageSize
+  /**
+   * name
+   */
+  name?: string;
+  /**
+   * pageNo
+   */
+  pageNo: number;
+  /**
+   * pageSize
+   */
+  pageSize: number;
 }
 export interface getPageListFormAppendChildQuery {
-  categoryId?: string; // categoryId
-  code?: string; // 表单编码
-  configured?: boolean; // 是否返回配置过流程属性
-  controlStatus?: string; // 受控状态(UNCONTROLLED:期初,RUNNING:受控中,CONTROLLED:已受控)
-  formType?: string; // 表单类型：BASE 基础表单、PROCESS 流程表单、VIEW视图表单、TEXT文本表单
-  moduleType: string; // moduleType
-  name?: string; // name
-  pageNo: number; // pageNo
-  pageSize: number; // pageSize
+  /**
+   * categoryId
+   */
+  categoryId?: string;
+  /**
+   * 表单编码
+   */
+  code?: string;
+  /**
+   * 是否返回配置过流程属性
+   */
+  configured?: boolean;
+  /**
+   * 受控状态(UNCONTROLLED:期初,RUNNING:受控中,CONTROLLED:已受控)
+   */
+  controlStatus?: string;
+  /**
+   * 表单类型：BASE 基础表单、PROCESS 流程表单、VIEW视图表单、TEXT文本表单
+   */
+  formType?: string;
+  /**
+   * moduleType
+   */
+  moduleType: string;
+  /**
+   * name
+   */
+  name?: string;
+  /**
+   * pageNo
+   */
+  pageNo: number;
+  /**
+   * pageSize
+   */
+  pageSize: number;
 }
 export interface getPageListFormNoChildQuery {
-  categoryId?: string; // categoryId
-  code?: string; // 表单编码
-  formType?: string; // 表单类型：BASE 基础表单、PROCESS 流程表单、VIEW视图表单、TEXT文本表单
-  moduleType: string; // moduleType
-  name?: string; // name
-  pageNo: number; // pageNo
-  pageSize: number; // pageSize
+  /**
+   * categoryId
+   */
+  categoryId?: string;
+  /**
+   * 表单编码
+   */
+  code?: string;
+  /**
+   * 表单类型：BASE 基础表单、PROCESS 流程表单、VIEW视图表单、TEXT文本表单
+   */
+  formType?: string;
+  /**
+   * moduleType
+   */
+  moduleType: string;
+  /**
+   * name
+   */
+  name?: string;
+  /**
+   * pageNo
+   */
+  pageNo: number;
+  /**
+   * pageSize
+   */
+  pageSize: number;
 }
 export interface FormRelateService {
-  // 在线表单/eDHR 所有分类树
+  /**
+   * 在线表单/eDHR 所有分类树
+   */
   getCategory(
     query: getCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CategoryCompleteVO[]>>;
-  // 新增
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CategoryCompleteVO[]>;
+  /**
+   * 新增
+   */
   postCategory(
     data: CategoryRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 分类删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 分类删除
+   */
   deleteCategory(
     query: deleteCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<number>>;
-  // 拖拽
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<number>;
+  /**
+   * 拖拽
+   */
   putCategoryDrag(
     data: CategoryDragDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ResponseEntity>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ResponseEntity>;
+  /**
+   * 修改
+   */
   putCategoryId(
+    path: putCategoryIdPathParams,
     data: CategoryRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 分类删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 分类删除
+   */
   deleteDeleteCategory(
     query: deleteDeleteCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<void>>;
-  // 在线表单/eDHR 模板详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<void>;
+  /**
+   * 在线表单/eDHR 模板详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FormRelateDTO>>;
-  // 在线表单/eDHR 所有分类
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FormRelateDTO>;
+  /**
+   * 在线表单/eDHR 所有分类
+   */
   getListAllCategory(
     query: getListAllCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CategoryCompleteResponse[]>>;
-  // 在线表单/eDHR 所有版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CategoryCompleteResponse[]>;
+  /**
+   * 在线表单/eDHR 所有版本
+   */
   getListAllVersion(
     query: getListAllVersionQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FormRelateDTO[]>>;
-  // 在线表单获取模型接口
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FormRelateDTO[]>;
+  /**
+   * 在线表单获取模型接口
+   */
   getPageListAllModelKey(
     query: getPageListAllModelKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<OnlineFormModelMeta>>>;
-  // 在线表单/eDHR 分页列表含版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<OnlineFormModelMeta>>;
+  /**
+   * 在线表单/eDHR 分页列表含版本
+   */
   getPageListFormAppendChild(
     query: getPageListFormAppendChildQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<FormRelateDTO>>>;
-  // 在线表单/eDHR 分页列表不含版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<FormRelateDTO>>;
+  /**
+   * 在线表单/eDHR 分页列表不含版本
+   */
   getPageListFormNoChild(
     query: getPageListFormNoChildQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<FormRelateDTO>>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<FormRelateDTO>>;
 }

package/lib/apaas/service/apis/front-operate-log.service.d.ts

@@ -1,19 +1,46 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { FrontOperateLogResponse } from '../entities';
 
 export interface getPageListQuery {
-  bizModel?: string; // 模块(BIZ_SERVICE:业务模块 )
-  endTime?: string; // 截止时间
-  keyword?: string; // 内容
-  operateType?: string; // 操作类型
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  startTime?: string; // 开始时间
-  username?: string; // 操作人
+  /**
+   * 模块(BIZ_SERVICE:业务模块 )
+   */
+  bizModel?: string;
+  /**
+   * 截止时间
+   */
+  endTime?: string;
+  /**
+   * 内容
+   */
+  keyword?: string;
+  /**
+   * 操作类型
+   */
+  operateType?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 操作人
+   */
+  username?: string;
 }
 export interface FrontOperateLogService {
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<FrontOperateLogResponse>>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<FrontOperateLogResponse>>;
 }