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

package/lib/apaas/service/apis/excel-tmpl.service.d.ts

@@ -7,102 +7,184 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getDetailQuery {
-  key: string; // 模板key
-  modelKey: string; // 模型key
+  /**
+   * 模板key
+   */
+  key: string;
+  /**
+   * 模型key
+   */
+  modelKey: string;
+}
+export interface getDownloadPlatIdPathParams {
+  id: string;
+}
+export interface getDownloadIdPathParams {
+  id: string;
 }
 export interface getInfoQuery {
-  id?: string; // id
-  key?: string; // key
-  modelType?: string; // modelType
+  /**
+   * id
+   */
+  id?: string;
+  /**
+   * key
+   */
+  key?: string;
+  /**
+   * modelType
+   */
+  modelType?: string;
 }
 export interface getInitTmplQuery {
-  id?: string; // 模板id
-  key?: string; // 模板id
-  modelKey?: string; // 模板id
+  /**
+   * 模板id
+   */
+  id?: string;
+  /**
+   * 模板id
+   */
+  key?: string;
+  /**
+   * 模板id
+   */
+  modelKey?: string;
 }
 export interface postInitTmplQuery {
-  all?: boolean; // 更新全部
+  /**
+   * 更新全部
+   */
+  all?: boolean;
 }
 export interface getListQuery {
-  modelKey: string; // 模型key
-  type?: string; // 类型：IMPORT-导入;EXPORT-导出
-  排序list?: string; // 排序list
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 类型：IMPORT-导入;EXPORT-导出
+   */
+  type?: string;
+  /**
+   * 排序list
+   */
+  排序list?: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  排序list?: string; // 排序list
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 排序list
+   */
+  排序list?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface ExcelTmplService {
-  // 模板保存
+  /**
+   * 模板保存
+   */
   post(
     data: ExcelTmplRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 模板配置信息保存
+  ): Promise<string>;
+  /**
+   * 模板配置信息保存
+   */
   postConfig(
     data: ExcelTemplateConfigReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 根据模板信息查询
+  ): Promise<string>;
+  /**
+   * 根据模板信息查询
+   */
   getDetail(
     query: getDetailQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ExcelTmplResponse>>;
-  // 平台下载模板
+  ): Promise<ExcelTmplResponse>;
+  /**
+   * 平台下载模板
+   */
   getDownloadPlatId(
+    path: getDownloadPlatIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 下载模板
+  ): Promise<unknown>;
+  /**
+   * 下载模板
+   */
   getDownloadId(
+    path: getDownloadIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 详情
+  ): Promise<unknown>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ExcelTmplResponse>>;
-  // 批量生成模型模板
+  ): Promise<ExcelTmplResponse>;
+  /**
+   * 批量生成模型模板
+   */
   getInitTmpl(
     query: getInitTmplQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 批量生成模型模板
+  ): Promise<string>;
+  /**
+   * 批量生成模型模板
+   */
   postInitTmpl(
     query: postInitTmplQuery,
     data: ExcelTemplateConfigReq,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 列表
+  ): Promise<string>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ExcelTmplResponse[]>>;
-  // 分页列表
+  ): Promise<ExcelTmplResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<ExcelTmplResponse>>>;
-  // 新模板配置信息保存
+  ): Promise<IPage<ExcelTmplResponse>>;
+  /**
+   * 新模板配置信息保存
+   */
   postV1Config(
     data: ExcelTemplateConfigV1Req,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 模板修改
+  ): Promise<string>;
+  /**
+   * 模板修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ExcelTmplRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -1,68 +1,147 @@
 import type { AxiosRequestConfig } from 'axios';
-import type { ImportModelData, ExcelValidateResponse } from '../entities';
+import type {
+  ImportModelData,
+  ResponseEntity,
+  ExcelValidateResponse,
+} from '../entities';
 
 export interface getDataDoImportQuery {
-  duplicateKeyUpdate: number; // 数据重复时的导入策略 1 新增及更新/0 忽略重复数据/2仅更新数据
-  fileId: string; // 文件id
-  importInvalidate?: number; // 数据校验不通过时是否导入 1：导入；0：不导入; 2 错误即停止
-  refFieldKey?: string; // 引用主模型数据的字段KEY(仅子表导入需要传)
-  refMasterId?: string; // 引用主模型数据的id_(仅子表导入需要传)
-  updateStrategy?: boolean; // 空值是否更新
+  /**
+   * 数据重复时的导入策略 1 新增及更新/0 忽略重复数据/2仅更新数据
+   */
+  duplicateKeyUpdate: number;
+  /**
+   * 文件id
+   */
+  fileId: string;
+  /**
+   * 数据校验不通过时是否导入 1：导入；0：不导入; 2 错误即停止
+   */
+  importInvalidate?: number;
+  /**
+   * 引用主模型数据的字段KEY(仅子表导入需要传)
+   */
+  refFieldKey?: string;
+  /**
+   * 引用主模型数据的id_(仅子表导入需要传)
+   */
+  refMasterId?: string;
+  /**
+   * 空值是否更新
+   */
+  updateStrategy?: boolean;
 }
 export interface getDataExportQuery {
-  modelKey: string; // 模型key
-  tmplKey: string; // 模板key
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 模板key
+   */
+  tmplKey: string;
 }
 export interface postDataImportQuery {
-  duplicateKeyUpdate?: number; // 数据重复时的导入策略 1 新增及更新/0 忽略重复数据
-  headerRowNo?: number; // 标题行号
-  importInvalidate?: number; // 数据校验不通过时是否导入
-  modelKey: string; // 模型key
-  startRowNo?: number; // 数据起始行号
-  tmplKey: string; // 模板key
+  /**
+   * 数据重复时的导入策略 1 新增及更新/0 忽略重复数据
+   */
+  duplicateKeyUpdate?: number;
+  /**
+   * 标题行号
+   */
+  headerRowNo?: number;
+  /**
+   * 数据校验不通过时是否导入
+   */
+  importInvalidate?: number;
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 数据起始行号
+   */
+  startRowNo?: number;
+  /**
+   * 模板key
+   */
+  tmplKey: string;
 }
 export interface getDataPreviewQuery {
-  fileId: string; // 文件id
+  /**
+   * 文件id
+   */
+  fileId: string;
 }
 export interface getDataReportQuery {
-  fileId: string; // 文件id
+  /**
+   * 文件id
+   */
+  fileId: string;
 }
 export interface postDataValidateQuery {
-  headerRowNo?: number; // 标题行号
-  importType?: number; // 导入类型 1：普通导入，2：主子同时导
-  modelKey: string; // 模型key
-  startRowNo?: number; // 数据起始行号
-  tmplKey: string; // 模板key
+  /**
+   * 标题行号
+   */
+  headerRowNo?: number;
+  /**
+   * 导入类型 1：普通导入，2：主子同时导
+   */
+  importType?: number;
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 数据起始行号
+   */
+  startRowNo?: number;
+  /**
+   * 模板key
+   */
+  tmplKey: string;
 }
 export interface ExcelService {
-  // 导入数据
+  /**
+   * 导入数据
+   */
   getDataDoImport(
     query: getDataDoImportQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // excel数据导出
+  ): Promise<object>;
+  /**
+   * excel数据导出
+   */
   getDataExport(
     query: getDataExportQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // excel数据导入
+  ): Promise<unknown>;
+  /**
+   * excel数据导入
+   */
   postDataImport(
     query: postDataImportQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // excel数据导入数据预览
+  ): Promise<object>;
+  /**
+   * excel数据导入数据预览
+   */
   getDataPreview(
     query: getDataPreviewQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ImportModelData>>;
-  // 下载错误报告
+  ): Promise<ImportModelData>;
+  /**
+   * 下载错误报告
+   */
   getDataReport(
     query: getDataReportQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // excel数据导入数据校验
+  ): Promise<ResponseEntity>;
+  /**
+   * excel数据导入数据校验
+   */
   postDataValidate(
     query: postDataValidateQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ExcelValidateResponse>>;
+  ): Promise<ExcelValidateResponse>;
 }

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

@@ -8,106 +8,195 @@ 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;
+  fieldKey: string;
+  type: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface FieldMetaService {
-  // 删除字段
+  /**
+   * 删除字段
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 补充 data_version_ 字段（后门接口，谨慎使用！）
+  ): Promise<string>;
+  /**
+   * 补充 data_version_ 字段（后门接口，谨慎使用！）
+   */
   postCompleteDataVersion(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 更新所有精度小数字段的小数位数（后门接口，谨慎使用！）
+  ): Promise<string>;
+  /**
+   * 更新所有精度小数字段的小数位数（后门接口，谨慎使用！）
+   */
   putDecimalDigitsAllDigits(
+    path: putDecimalDigitsAllDigitsPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 公式字段校验
+  ): Promise<string>;
+  /**
+   * 公式字段校验
+   */
   postFuncCheck(
     data: FieldMeta4Check,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // 详情
+  ): Promise<object>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<FieldMetaDTO>>;
-  // 实体模型数据字段列表
+  ): Promise<FieldMetaDTO>;
+  /**
+   * 实体模型数据字段列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<FieldMetaDTO[]>>;
-  // 获取条件字段
+  ): Promise<FieldMetaDTO[]>;
+  /**
+   * 获取条件字段
+   */
   getListConditionField(
     query: getListConditionFieldQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<FieldMetaDTO[]>>;
-  // 字段移动位置
+  ): Promise<FieldMetaDTO[]>;
+  /**
+   * 字段移动位置
+   */
   postMove(
     data: FieldSortRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 回收站模型字段分页列表
+  ): Promise<string>;
+  /**
+   * 回收站模型字段分页列表
+   */
   getPageGetRecycledList(
     query: getPageGetRecycledListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<FieldMetaDTO>>>;
-  // 从回收站恢复模型
+  ): Promise<IPage<FieldMetaDTO>>;
+  /**
+   * 从回收站恢复模型
+   */
   putPageRecycledRestoreFieldId(
+    path: putPageRecycledRestoreFieldIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 序列号预览
+  ): Promise<string>;
+  /**
+   * 序列号预览
+   */
   postPreview(
     data: SequencePreviewRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string[]>>;
-  // 移除单据模板字段元数据
+  ): Promise<string[]>;
+  /**
+   * 移除单据模板字段元数据
+   */
   getRemoveDocument(
     query: getRemoveDocumentQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 字段保存
+  ): Promise<string>;
+  /**
+   * 字段保存
+   */
   postSave(
     data: FieldMetaVO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 添加唯一约束（后门接口，谨慎使用！）
+  ): Promise<string>;
+  /**
+   * 添加唯一约束（后门接口，谨慎使用！）
+   */
   putUniqueConstraintAddModelKeyFieldKeyType(
+    path: putUniqueConstraintAddModelKeyFieldKeyTypePathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 字段编辑
+  ): Promise<string>;
+  /**
+   * 字段编辑
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: FieldMetaVO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

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