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

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

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type {
   AddDatabaseForm,
   ColumnInformationSchema,
@@ -10,123 +12,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?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 创建数据库数据源
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 创建数据库数据源
+   */
   postAddDatabase(
     data: AddDatabaseForm,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // api数据打平
-  postApiDataFlatten(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IObject[]>>;
-  // 查询表字段信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * api数据打平
+   */
+  postApiDataFlatten(config?: Partial<AxiosRequestConfig>): Promise<IObject[]>;
+  /**
+   * 查询表字段信息
+   */
   getColumnInformation(
     query: getColumnInformationQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ColumnInformationSchema[]>>;
-  // 查询数据库列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ColumnInformationSchema[]>;
+  /**
+   * 查询数据库列表
+   */
   getDbInformation(
     query: getDbInformationQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<DataBaseInformationSchema[]>>;
-  // 分页获取数据库数据源
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<DataBaseInformationSchema[]>;
+  /**
+   * 分页获取数据库数据源
+   */
   postGetDatabaseByPage(
     data: 数据库数据源查询参数,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 数据源详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 数据源详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<AddDatabaseForm>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<AddDatabaseForm>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<AddDatabaseForm[]>>;
-  // 删除数据库数据源
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<AddDatabaseForm[]>;
+  /**
+   * 删除数据库数据源
+   */
   deleteRemoveDatabase(
     query: deleteRemoveDatabaseQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 运行SQL语句
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 运行SQL语句
+   */
   postRunSql(
     data: RunSqlForm,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 分页列表
+   */
   getTableDataPageList(
     query: getTableDataPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IObject>>;
-  // 查询数据库表信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IObject>;
+  /**
+   * 查询数据库表信息
+   */
   getTableInformation(
     query: getTableInformationQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<TableInformationSchema[]>>;
-  // 测试api数据源
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<TableInformationSchema[]>;
+  /**
+   * 测试api数据源
+   */
   postTestApi(
     data: AddDatabaseForm,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<JSONObject>>;
-  // 测试数据库连接
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<JSONObject>;
+  /**
+   * 测试数据库连接
+   */
   postTestDatabaseConn(
     data: TestDatabaseConnForm,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改数据库数据源
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改数据库数据源
+   */
   putUpdateDatabase(
     data: AddDatabaseForm,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询数据库视图信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 查询数据库视图信息
+   */
   getViewInformation(
     query: getViewInformationQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<TableInformationSchema[]>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<TableInformationSchema[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: AddDatabaseForm,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

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

@@ -1,51 +1,79 @@
+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?: 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<PnDatasetLogResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PnDatasetLogResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PnDatasetLogResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PnDatasetLogResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<PnDatasetLogResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<PnDatasetLogResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PnDatasetLogRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }