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

package/es/platform/service/apis/dataset.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   PnDatasetRequest,
   SqlResult,
@@ -8,145 +9,239 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getChangeCategoryQuery {
-  datasetId?: string; // 数据集Id
-  destId?: string; // 目的地category id
+  /**
+   * 数据集Id
+   */
+  datasetId?: string;
+  /**
+   * 目的地category id
+   */
+  destId?: string;
 }
 export interface getColumnValueQuery {
-  column: string; // column
-  datasetId: string; // datasetId
+  /**
+   * column
+   */
+  column: string;
+  /**
+   * datasetId
+   */
+  datasetId: string;
 }
 export interface postCreateRequestQuery {
-  datasourceId: string; // 数据源id
+  /**
+   * 数据源id
+   */
+  datasourceId: string;
 }
 export interface postEditRequestQuery {
-  datasetId: string; // 数据集id
+  /**
+   * 数据集id
+   */
+  datasetId: string;
 }
 export interface putEncodeQuery {
-  sql: string; // encode的id，多个按','分割
+  /**
+   * encode的id，多个按','分割
+   */
+  sql: string;
 }
 export interface postGenColumnQuery {
-  dbType: string; // 数据集对应的数据库类型（postgres/sqlserver/mysql/oracle），本地上传填postgres
-  fileUpload?: boolean; // 数据集是否是本地上传
+  /**
+   * 数据集对应的数据库类型（postgres/sqlserver/mysql/oracle），本地上传填postgres
+   */
+  dbType: string;
+  /**
+   * 数据集是否是本地上传
+   */
+  fileUpload?: boolean;
 }
 export interface getInfoQuery {
-  id?: string; // id
-  key?: string; // key
+  /**
+   * id
+   */
+  id?: string;
+  /**
+   * key
+   */
+  key?: string;
 }
 export interface getInfoNoHeaderQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListCategoryDatasetQuery {
-  appId?: string; // 应用id
+  /**
+   * 应用id
+   */
+  appId?: string;
 }
 export interface getListIdsQuery {
-  ids: string; // 多个id，多个按','分割
+  /**
+   * 多个id，多个按','分割
+   */
+  ids: string;
 }
 export interface getListKeysQuery {
-  keys: string; // 多个key，多个按','分割
+  /**
+   * 多个key，多个按','分割
+   */
+  keys: string;
 }
 export interface getPageListQuery {
-  categoryId?: string; // categoryId
-  name?: string; // name
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * categoryId
+   */
+  categoryId?: string;
+  /**
+   * name
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface DatasetService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PnDatasetRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 更换数据集分类
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 更换数据集分类
+   */
   getChangeCategory(
     query: getChangeCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 列所有值，去重
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 列所有值，去重
+   */
   getColumnValue(
     query: getColumnValueQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<SqlResult>>;
-  // 新建数据集时手动调用api
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<SqlResult>;
+  /**
+   * 新建数据集时手动调用api
+   */
   postCreateRequest(
     query: postCreateRequestQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IObject[]>>;
-  // 编辑/浏览数据集时调用api
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IObject[]>;
+  /**
+   * 编辑/浏览数据集时调用api
+   */
   postEditRequest(
     query: postEditRequestQuery,
     data: APIDatasetConfigDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 历史数据encode
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 历史数据encode
+   */
   putEncode(
     query: putEncodeQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 函数生成新字段
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 函数生成新字段
+   */
   postGenColumn(
     query: postGenColumnQuery,
     data: ExprDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PnDatasetResponse>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PnDatasetResponse>;
+  /**
+   * 详情
+   */
   getInfoNoHeader(
     query: getInfoNoHeaderQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PnDatasetResponse>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PnDatasetResponse[]>>;
-  // 目录和数据集列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PnDatasetResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PnDatasetResponse[]>;
+  /**
+   * 目录和数据集列表
+   */
   getListCategoryDataset(
     query: getListCategoryDatasetQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 列表(根据id)
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 列表(根据id)
+   */
   getListIds(
     query: getListIdsQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PnDatasetResponse[]>>;
-  // 列表(根据key)
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PnDatasetResponse[]>;
+  /**
+   * 列表(根据key)
+   */
   getListKeys(
     query: getListKeysQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PnDatasetResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PnDatasetResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<PnDatasetResponse>>>;
-  // 运行sql
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<PnDatasetResponse>>;
+  /**
+   * 运行sql
+   */
   postRunScript(
     data: PnDataset,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<SqlResult>>;
-  // 运行sql(裸奔接口)
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<SqlResult>;
+  /**
+   * 运行sql(裸奔接口)
+   */
   postRunScriptNoHeader(
     data: PnDataset,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<SqlResult>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<SqlResult>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PnDatasetRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/platform/service/apis/datasource-devops.service.d.ts

@@ -1,47 +1,66 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   DatasourceDevopsRequest,
   DatasourceDevopsResponse,
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface DatasourceDevopsService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: DatasourceDevopsRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<DatasourceDevopsResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<DatasourceDevopsResponse>;
+  /**
+   * 列表
+   */
   postList(
     data: DatasourceDevopsRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<DatasourceDevopsResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<DatasourceDevopsResponse[]>;
+  /**
+   * 分页列表
+   */
   postPageList(
     data: DatasourceDevopsRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<DatasourceDevopsResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<DatasourceDevopsResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: DatasourceDevopsRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/platform/service/apis/datasource-move-data.service.d.ts

@@ -1,55 +1,86 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   DatasourceMoveDataRequest,
   DatasourceMoveDataResponse,
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  id: string; // 迁移任务detail的Id
+  /**
+   * 迁移任务detail的Id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  id: string; // 迁移任务detail的Id
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 迁移任务detail的Id
+   */
+  id: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface DatasourceMoveDataService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: DatasourceMoveDataRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<DatasourceMoveDataResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<DatasourceMoveDataResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<DatasourceMoveDataResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<DatasourceMoveDataResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<DatasourceMoveDataResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<DatasourceMoveDataResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: DatasourceMoveDataRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/platform/service/apis/datasource-move-detail.service.d.ts

@@ -1,54 +1,82 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   DatasourceMoveDetailRequest,
   DatasourceMoveDetailResponse,
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  id: string; // 迁移任务Id
+  /**
+   * 迁移任务Id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface DatasourceMoveDetailService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: DatasourceMoveDetailRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<DatasourceMoveDetailResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<DatasourceMoveDetailResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<DatasourceMoveDetailResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<DatasourceMoveDetailResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<DatasourceMoveDetailResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<DatasourceMoveDetailResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: DatasourceMoveDetailRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }