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

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

@@ -6,53 +6,86 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  name?: string; // 名称
+  /**
+   * 名称
+   */
+  name?: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 仪表盘来源
+   */
+  source?: number;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface DashboardService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: DashboardRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<DashboardResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<DashboardResponse[]>;
-  // 移动位置
+  /**
+   * 移动位置
+   */
   postMove(
     data: DashboardSortRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<DashboardResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: DashboardRequest,

package/lib/platform/service/apis/data-source.service.d.ts

@@ -10,78 +10,133 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  keys: string; // 删除的key，多个按','分割
+  /**
+   * 删除的key，多个按','分割
+   */
+  keys: string;
 }
 export interface getFindByIdQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  name?: string; // 数据源名称
-  type?: string; // 数据库类型
+  /**
+   * 数据源名称
+   */
+  name?: string;
+  /**
+   * 数据库类型
+   */
+  type?: string;
 }
 export interface getPageListQuery {
-  name?: string; // 数据源名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  type?: string; // 数据库类型
+  /**
+   * 数据源名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 数据库类型
+   */
+  type?: string;
 }
 export interface postQueryDataQuery {
-  env: string; // env
-  key: string; // key
-  sql: string; // sql
+  /**
+   * env
+   */
+  env: string;
+  /**
+   * key
+   */
+  key: string;
+  /**
+   * sql
+   */
+  sql: string;
 }
 export interface DataSourceService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: DataSourceMainRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 修改
+  /**
+   * 修改
+   */
   put(
     data: DataSourceMainRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 启用和禁用
+  /**
+   * 启用和禁用
+   */
   putEnabled(
     data: DataSourceIsEnableRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 支持DML、DDL
+  /**
+   * 支持DML、DDL
+   */
   postExecuteUpdate(
     data: DataSourceUpdateRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<number>;
-  // 查询数据源详情
+  /**
+   * 查询数据源详情
+   */
   getFindById(
     query: getFindByIdQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<DataSourceMainResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<DataSourceMainResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<DataSourceMainResponse>>;
-  // 查询数据
+  /**
+   * 查询数据
+   */
   postQueryData(
     query: postQueryDataQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IObject[]>;
-  // 查询SQL视图表字段信息
+  /**
+   * 查询SQL视图表字段信息
+   */
   postSqlColumnInformation(
     data: TableColumnDTO,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ColumnInformationSchema[]>;
-  // 连接测试
+  /**
+   * 连接测试
+   */
   postTestConnect(
     data: DataSource,
     config?: Partial<AxiosRequestConfig>,

package/lib/platform/service/apis/data-trace.service.d.ts

@@ -6,45 +6,67 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface DataTraceService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: DataTraceRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 导出
+  /**
+   * 导出
+   */
   postExport(
     data: DataTraceRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<DataTraceResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(config?: Partial<AxiosRequestConfig>): Promise<DataTraceResponse[]>;
-  // 操作人
+  /**
+   * 操作人
+   */
   getOperators(config?: Partial<AxiosRequestConfig>): Promise<UserInfo[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   postPageList(
     data: DataTraceRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<DataTraceResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: DataTraceRequest,

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

@@ -11,118 +11,197 @@ 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 putIdPathParams {
   id: string;
 }
 export interface DatabaseService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: AddDatabaseForm,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 创建数据库数据源
+  /**
+   * 创建数据库数据源
+   */
   postAddDatabase(
     data: AddDatabaseForm,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // api数据打平
+  /**
+   * api数据打平
+   */
   postApiDataFlatten(config?: Partial<AxiosRequestConfig>): Promise<IObject[]>;
-  // 查询表字段信息
+  /**
+   * 查询表字段信息
+   */
   getColumnInformation(
     query: getColumnInformationQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ColumnInformationSchema[]>;
-  // 查询数据库列表
+  /**
+   * 查询数据库列表
+   */
   getDbInformation(
     query: getDbInformationQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<DataBaseInformationSchema[]>;
-  // 分页获取数据库数据源
+  /**
+   * 分页获取数据库数据源
+   */
   postGetDatabaseByPage(
     data: 数据库数据源查询参数,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<unknown>;
-  // 数据源详情
+  /**
+   * 数据源详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AddDatabaseForm>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AddDatabaseForm[]>;
-  // 删除数据库数据源
+  /**
+   * 删除数据库数据源
+   */
   deleteRemoveDatabase(
     query: deleteRemoveDatabaseQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 运行SQL语句
+  /**
+   * 运行SQL语句
+   */
   postRunSql(
     data: RunSqlForm,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<unknown>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getTableDataPageList(
     query: getTableDataPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IObject>;
-  // 查询数据库表信息
+  /**
+   * 查询数据库表信息
+   */
   getTableInformation(
     query: getTableInformationQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<TableInformationSchema[]>;
-  // 测试api数据源
+  /**
+   * 测试api数据源
+   */
   postTestApi(
     data: AddDatabaseForm,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<JSONObject>;
-  // 测试数据库连接
+  /**
+   * 测试数据库连接
+   */
   postTestDatabaseConn(
     data: TestDatabaseConnForm,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 修改数据库数据源
+  /**
+   * 修改数据库数据源
+   */
   putUpdateDatabase(
     data: AddDatabaseForm,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 查询数据库视图信息
+  /**
+   * 查询数据库视图信息
+   */
   getViewInformation(
     query: getViewInformationQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<TableInformationSchema[]>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: AddDatabaseForm,

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

@@ -2,48 +2,75 @@ 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 putIdPathParams {
   id: string;
 }
 export interface DatasetLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PnDatasetLogRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PnDatasetLogResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<PnDatasetLogResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<PnDatasetLogResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: PnDatasetLogRequest,