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

package/lib/platform/service/apis/database.service.d.ts

@@ -11,123 +11,200 @@ import type {
 } from '../entities';
 
 export interface getColumnInformationQuery {
-  id: string; // 数据源id
-  tbName: string; // 表名
+  /**
+   * 数据源id
+   */
+  id: string;
+  /**
+   * 表名
+   */
+  tbName: string;
 }
 export interface getDbInformationQuery {
-  dbType: string; // dbType
-  poolName: string; // pool_name
+  /**
+   * dbType
+   */
+  dbType: string;
+  /**
+   * pool_name
+   */
+  poolName: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  aliasName?: string; // 名称
-  appId: string; // 应用id
+  /**
+   * 名称
+   */
+  aliasName?: string;
+  /**
+   * 应用id
+   */
+  appId: string;
 }
 export interface deleteRemoveDatabaseQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getTableDataPageListQuery {
-  deleteTag?: boolean; // 是否去除逻辑（delete_=1）删除数据
-  id: string; // 数据源id
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  tableName?: string; // 表名
+  /**
+   * 是否去除逻辑（delete_=1）删除数据
+   */
+  deleteTag?: boolean;
+  /**
+   * 数据源id
+   */
+  id: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 表名
+   */
+  tableName?: string;
 }
 export interface getTableInformationQuery {
-  id: string; // 数据源id
+  /**
+   * 数据源id
+   */
+  id: string;
 }
 export interface getViewInformationQuery {
-  id: string; // 数据源id
+  /**
+   * 数据源id
+   */
+  id: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface DatabaseService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: AddDatabaseForm,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 创建数据库数据源
+  ): Promise<string>;
+  /**
+   * 创建数据库数据源
+   */
   postAddDatabase(
     data: AddDatabaseForm,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // api数据打平
-  postApiDataFlatten(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IObject[]>>;
-  // 查询表字段信息
+  ): Promise<string>;
+  /**
+   * api数据打平
+   */
+  postApiDataFlatten(config?: Partial<AxiosRequestConfig>): Promise<IObject[]>;
+  /**
+   * 查询表字段信息
+   */
   getColumnInformation(
     query: getColumnInformationQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ColumnInformationSchema[]>>;
-  // 查询数据库列表
+  ): Promise<ColumnInformationSchema[]>;
+  /**
+   * 查询数据库列表
+   */
   getDbInformation(
     query: getDbInformationQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DataBaseInformationSchema[]>>;
-  // 分页获取数据库数据源
+  ): Promise<DataBaseInformationSchema[]>;
+  /**
+   * 分页获取数据库数据源
+   */
   postGetDatabaseByPage(
     data: 数据库数据源查询参数,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 数据源详情
+  ): Promise<unknown>;
+  /**
+   * 数据源详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AddDatabaseForm>>;
-  // 列表
+  ): Promise<AddDatabaseForm>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AddDatabaseForm[]>>;
-  // 删除数据库数据源
+  ): Promise<AddDatabaseForm[]>;
+  /**
+   * 删除数据库数据源
+   */
   deleteRemoveDatabase(
     query: deleteRemoveDatabaseQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 运行SQL语句
+  ): Promise<string>;
+  /**
+   * 运行SQL语句
+   */
   postRunSql(
     data: RunSqlForm,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 分页列表
+  ): Promise<unknown>;
+  /**
+   * 分页列表
+   */
   getTableDataPageList(
     query: getTableDataPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IObject>>;
-  // 查询数据库表信息
+  ): Promise<IObject>;
+  /**
+   * 查询数据库表信息
+   */
   getTableInformation(
     query: getTableInformationQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TableInformationSchema[]>>;
-  // 测试api数据源
+  ): Promise<TableInformationSchema[]>;
+  /**
+   * 测试api数据源
+   */
   postTestApi(
     data: AddDatabaseForm,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<JSONObject>>;
-  // 测试数据库连接
+  ): Promise<JSONObject>;
+  /**
+   * 测试数据库连接
+   */
   postTestDatabaseConn(
     data: TestDatabaseConnForm,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改数据库数据源
+  ): Promise<string>;
+  /**
+   * 修改数据库数据源
+   */
   putUpdateDatabase(
     data: AddDatabaseForm,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询数据库视图信息
+  ): Promise<string>;
+  /**
+   * 查询数据库视图信息
+   */
   getViewInformation(
     query: getViewInformationQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<TableInformationSchema[]>>;
-  // 修改
+  ): Promise<TableInformationSchema[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: AddDatabaseForm,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/dataset-log.service.d.ts

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

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

@@ -9,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?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 更换数据集分类
+  ): Promise<string>;
+  /**
+   * 更换数据集分类
+   */
   getChangeCategory(
     query: getChangeCategoryQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 列所有值，去重
+  ): Promise<string>;
+  /**
+   * 列所有值，去重
+   */
   getColumnValue(
     query: getColumnValueQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<SqlResult>>;
-  // 新建数据集时手动调用api
+  ): Promise<SqlResult>;
+  /**
+   * 新建数据集时手动调用api
+   */
   postCreateRequest(
     query: postCreateRequestQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IObject[]>>;
-  // 编辑/浏览数据集时调用api
+  ): Promise<IObject[]>;
+  /**
+   * 编辑/浏览数据集时调用api
+   */
   postEditRequest(
     query: postEditRequestQuery,
     data: APIDatasetConfigDTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 历史数据encode
+  ): Promise<string>;
+  /**
+   * 历史数据encode
+   */
   putEncode(
     query: putEncodeQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 函数生成新字段
+  ): Promise<string>;
+  /**
+   * 函数生成新字段
+   */
   postGenColumn(
     query: postGenColumnQuery,
     data: ExprDTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnDatasetResponse>>;
-  // 详情
+  ): Promise<PnDatasetResponse>;
+  /**
+   * 详情
+   */
   getInfoNoHeader(
     query: getInfoNoHeaderQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnDatasetResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnDatasetResponse[]>>;
-  // 目录和数据集列表
+  ): Promise<PnDatasetResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PnDatasetResponse[]>;
+  /**
+   * 目录和数据集列表
+   */
   getListCategoryDataset(
     query: getListCategoryDatasetQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // 列表(根据id)
+  ): Promise<object>;
+  /**
+   * 列表(根据id)
+   */
   getListIds(
     query: getListIdsQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnDatasetResponse[]>>;
-  // 列表(根据key)
+  ): Promise<PnDatasetResponse[]>;
+  /**
+   * 列表(根据key)
+   */
   getListKeys(
     query: getListKeysQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnDatasetResponse[]>>;
-  // 分页列表
+  ): Promise<PnDatasetResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PnDatasetResponse>>>;
-  // 运行sql
+  ): Promise<IPage<PnDatasetResponse>>;
+  /**
+   * 运行sql
+   */
   postRunScript(
     data: PnDataset,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<SqlResult>>;
-  // 运行sql(裸奔接口)
+  ): Promise<SqlResult>;
+  /**
+   * 运行sql(裸奔接口)
+   */
   postRunScriptNoHeader(
     data: PnDataset,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<SqlResult>>;
-  // 修改
+  ): Promise<SqlResult>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PnDatasetRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }