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

package/es/apaas/service/apis/field-meta.service.d.ts

@@ -8,37 +8,82 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
 }
 export interface putDecimalDigitsAllDigitsPathParams {
   digits: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  includeBuiltin?: boolean; // 是否包含内置字段
-  includeProcess?: boolean; // 是否包含流程字段字段
-  keyword?: string; // 搜索关键字
-  modelKey: string; // 模型key
-  sys?: boolean; // 是否包含系统字段
+  /**
+   * 是否包含内置字段
+   */
+  includeBuiltin?: boolean;
+  /**
+   * 是否包含流程字段字段
+   */
+  includeProcess?: boolean;
+  /**
+   * 搜索关键字
+   */
+  keyword?: string;
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 是否包含系统字段
+   */
+  sys?: boolean;
 }
 export interface getListConditionFieldQuery {
-  includeProcess?: boolean; // 是否包含流程字段字段
-  modelKey: string; // 模型key
+  /**
+   * 是否包含流程字段字段
+   */
+  includeProcess?: boolean;
+  /**
+   * 模型key
+   */
+  modelKey: string;
 }
 export interface getPageGetRecycledListQuery {
-  modelKey?: string; // modelKey
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * modelKey
+   */
+  modelKey?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface putPageRecycledRestoreFieldIdPathParams {
   fieldId: string;
 }
 export interface getRemoveDocumentQuery {
-  appId?: string; // appId
-  branchId?: string; // branchId
-  env?: string; // env
+  /**
+   * appId
+   */
+  appId?: string;
+  /**
+   * branchId
+   */
+  branchId?: string;
+  /**
+   * env
+   */
+  env?: string;
 }
 export interface putUniqueConstraintAddModelKeyFieldKeyTypePathParams {
   modelKey: string;
@@ -49,76 +94,106 @@ export interface putIdPathParams {
   id: string;
 }
 export interface FieldMetaService {
-  // 删除字段
+  /**
+   * 删除字段
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 补充 data_version_ 字段（后门接口，谨慎使用！）
+  /**
+   * 补充 data_version_ 字段（后门接口，谨慎使用！）
+   */
   postCompleteDataVersion(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 更新所有精度小数字段的小数位数（后门接口，谨慎使用！）
+  /**
+   * 更新所有精度小数字段的小数位数（后门接口，谨慎使用！）
+   */
   putDecimalDigitsAllDigits(
     path: putDecimalDigitsAllDigitsPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 公式字段校验
+  /**
+   * 公式字段校验
+   */
   postFuncCheck(
     data: FieldMeta4Check,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<object>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<FieldMetaDTO>;
-  // 实体模型数据字段列表
+  /**
+   * 实体模型数据字段列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<FieldMetaDTO[]>;
-  // 获取条件字段
+  /**
+   * 获取条件字段
+   */
   getListConditionField(
     query: getListConditionFieldQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<FieldMetaDTO[]>;
-  // 字段移动位置
+  /**
+   * 字段移动位置
+   */
   postMove(
     data: FieldSortRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 回收站模型字段分页列表
+  /**
+   * 回收站模型字段分页列表
+   */
   getPageGetRecycledList(
     query: getPageGetRecycledListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<FieldMetaDTO>>;
-  // 从回收站恢复模型
+  /**
+   * 从回收站恢复模型
+   */
   putPageRecycledRestoreFieldId(
     path: putPageRecycledRestoreFieldIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 序列号预览
+  /**
+   * 序列号预览
+   */
   postPreview(
     data: SequencePreviewRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string[]>;
-  // 移除单据模板字段元数据
+  /**
+   * 移除单据模板字段元数据
+   */
   getRemoveDocument(
     query: getRemoveDocumentQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 字段保存
+  /**
+   * 字段保存
+   */
   postSave(
     data: FieldMetaVO,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 添加唯一约束（后门接口，谨慎使用！）
+  /**
+   * 添加唯一约束（后门接口，谨慎使用！）
+   */
   putUniqueConstraintAddModelKeyFieldKeyType(
     path: putUniqueConstraintAddModelKeyFieldKeyTypePathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 字段编辑
+  /**
+   * 字段编辑
+   */
   putId(
     path: putIdPathParams,
     data: FieldMetaVO,

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

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

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

@@ -6,21 +6,33 @@ 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?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 批量查询文件信息
+  /**
+   * 批量查询文件信息
+   */
   postList(
     data: FileResource4Req,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<FileResourceResponse[]>;
-  // 文件上传minio
+  /**
+   * 文件上传minio
+   */
   postUpload(
     query: postUploadQuery,
     config?: Partial<AxiosRequestConfig>,

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

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

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

@@ -2,26 +2,41 @@ 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?: Partial<AxiosRequestConfig>,
   ): Promise<string[]>;
-  // PDF文件转图片返回BASE64编码
+  /**
+   * PDF文件转图片返回BASE64编码
+   */
   postPdfPage(
     query: postPdfPageQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<number>;
-  // 文件上传minio
+  /**
+   * 文件上传minio
+   */
   postUploadImage(
     query: postUploadImageQuery,
     config?: Partial<AxiosRequestConfig>,

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

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

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

@@ -10,115 +10,232 @@ 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?: Partial<AxiosRequestConfig>,
   ): Promise<CategoryCompleteVO[]>;
-  // 新增
+  /**
+   * 新增
+   */
   postCategory(
     data: CategoryRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 分类删除
+  /**
+   * 分类删除
+   */
   deleteCategory(
     query: deleteCategoryQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<number>;
-  // 拖拽
+  /**
+   * 拖拽
+   */
   putCategoryDrag(
     data: CategoryDragDTO,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ResponseEntity>;
-  // 修改
+  /**
+   * 修改
+   */
   putCategoryId(
     path: putCategoryIdPathParams,
     data: CategoryRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 分类删除
+  /**
+   * 分类删除
+   */
   deleteDeleteCategory(
     query: deleteDeleteCategoryQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<void>;
-  // 在线表单/eDHR 模板详情
+  /**
+   * 在线表单/eDHR 模板详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<FormRelateDTO>;
-  // 在线表单/eDHR 所有分类
+  /**
+   * 在线表单/eDHR 所有分类
+   */
   getListAllCategory(
     query: getListAllCategoryQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<CategoryCompleteResponse[]>;
-  // 在线表单/eDHR 所有版本
+  /**
+   * 在线表单/eDHR 所有版本
+   */
   getListAllVersion(
     query: getListAllVersionQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<FormRelateDTO[]>;
-  // 在线表单获取模型接口
+  /**
+   * 在线表单获取模型接口
+   */
   getPageListAllModelKey(
     query: getPageListAllModelKeyQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<OnlineFormModelMeta>>;
-  // 在线表单/eDHR 分页列表含版本
+  /**
+   * 在线表单/eDHR 分页列表含版本
+   */
   getPageListFormAppendChild(
     query: getPageListFormAppendChildQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<FormRelateDTO>>;
-  // 在线表单/eDHR 分页列表不含版本
+  /**
+   * 在线表单/eDHR 分页列表不含版本
+   */
   getPageListFormNoChild(
     query: getPageListFormNoChildQuery,
     config?: Partial<AxiosRequestConfig>,