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

package/lib/apaas/service/apis/enum-model.service.d.ts

@@ -7,22 +7,55 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoIdPathParams {
   id: string;
 }
 export interface getPageListQuery {
-  code?: string; // 编码
-  description?: string; // 枚举模型描述
-  endTime?: string; // 结束时间
-  key?: string; // 枚举模型key
-  name?: string; // 枚举模型名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
+  /**
+   * 编码
+   */
+  code?: string;
+  /**
+   * 枚举模型描述
+   */
+  description?: string;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 枚举模型key
+   */
+  key?: string;
+  /**
+   * 枚举模型名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface putUpdateIconStateIdPathParams {
   id: string;
@@ -34,46 +67,64 @@ export interface putIdPathParams {
   id: string;
 }
 export interface EnumModelService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: EnumModelRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfoId(
     path: getInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<EnumModelResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(config?: Partial<AxiosRequestConfig>): Promise<EnumModelResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<EnumModelResponse>>;
-  // 带字段整体提交（不带id：新增；带id：更新）,前台字典功能使用
+  /**
+   * 带字段整体提交（不带id：新增；带id：更新）,前台字典功能使用
+   */
   postSubmitWithFields(
     data: EnumModelSubmitRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 修改枚举图标启用禁用状态
+  /**
+   * 修改枚举图标启用禁用状态
+   */
   putUpdateIconStateId(
     path: putUpdateIconStateIdPathParams,
     data: EnumModelState,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 修改枚举字段颜色启用禁用状态
+  /**
+   * 修改枚举字段颜色启用禁用状态
+   */
   putUpdateTextStateId(
     path: putUpdateTextStateIdPathParams,
     data: EnumModelState,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: EnumModelRequest,

package/lib/apaas/service/apis/event-log.service.d.ts

@@ -2,29 +2,49 @@ import type { AxiosRequestConfig } from 'axios';
 import type { EventLogResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface EventLogService {
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<EventLogResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(config?: Partial<AxiosRequestConfig>): Promise<EventLogResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,

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

@@ -2,49 +2,79 @@ import type { AxiosRequestConfig } from 'axios';
 import type { EventRequest, EventResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  type?: string; // type
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  searchKey?: string; // searchKey
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * searchKey
+   */
+  searchKey?: string;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface EventService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: EventRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<EventResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<EventResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<EventResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: EventRequest,

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

@@ -7,11 +7,20 @@ 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;
@@ -20,94 +29,159 @@ 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 putIdPathParams {
   id: string;
 }
 export interface ExcelTmplService {
-  // 模板保存
+  /**
+   * 模板保存
+   */
   post(
     data: ExcelTmplRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 模板配置信息保存
+  /**
+   * 模板配置信息保存
+   */
   postConfig(
     data: ExcelTemplateConfigReq,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 根据模板信息查询
+  /**
+   * 根据模板信息查询
+   */
   getDetail(
     query: getDetailQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ExcelTmplResponse>;
-  // 平台下载模板
+  /**
+   * 平台下载模板
+   */
   getDownloadPlatId(
     path: getDownloadPlatIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<unknown>;
-  // 下载模板
+  /**
+   * 下载模板
+   */
   getDownloadId(
     path: getDownloadIdPathParams,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<unknown>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ExcelTmplResponse>;
-  // 批量生成模型模板
+  /**
+   * 批量生成模型模板
+   */
   getInitTmpl(
     query: getInitTmplQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 批量生成模型模板
+  /**
+   * 批量生成模型模板
+   */
   postInitTmpl(
     query: postInitTmplQuery,
     data: ExcelTemplateConfigReq,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ExcelTmplResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<ExcelTmplResponse>>;
-  // 新模板配置信息保存
+  /**
+   * 新模板配置信息保存
+   */
   postV1Config(
     data: ExcelTemplateConfigV1Req,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 模板修改
+  /**
+   * 模板修改
+   */
   putId(
     path: putIdPathParams,
     data: ExcelTmplRequest,

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

@@ -1,66 +1,145 @@
 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<object>;
-  // excel数据导出
+  /**
+   * excel数据导出
+   */
   getDataExport(
     query: getDataExportQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<unknown>;
-  // excel数据导入
+  /**
+   * excel数据导入
+   */
   postDataImport(
     query: postDataImportQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<object>;
-  // excel数据导入数据预览
+  /**
+   * excel数据导入数据预览
+   */
   getDataPreview(
     query: getDataPreviewQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ImportModelData>;
-  // 下载错误报告
+  /**
+   * 下载错误报告
+   */
   getDataReport(
     query: getDataReportQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<unknown>;
-  // excel数据导入数据校验
+  ): Promise<ResponseEntity>;
+  /**
+   * excel数据导入数据校验
+   */
   postDataValidate(
     query: postDataValidateQuery,
     config?: Partial<AxiosRequestConfig>,