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

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

@@ -6,83 +6,130 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface deleteDeleteDatasetCategoryQuery {
-  appId?: string; // 应用Id
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 应用Id
+   */
+  appId?: string;
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  assetsModule: string; // assetsModule
+  /**
+   * assetsModule
+   */
+  assetsModule: string;
 }
 export interface getListDatasetCategoryQuery {
-  appId: string; // appId
-  assetsModule: string; // assetsModule
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * assetsModule
+   */
+  assetsModule: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface CategoryService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: CategoryRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 添加默认分类
-  postAddDefaultCusComp(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除数据集分类
+  ): Promise<string>;
+  /**
+   * 添加默认分类
+   */
+  postAddDefaultCusComp(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 删除数据集分类
+   */
   deleteDeleteDatasetCategory(
     query: deleteDeleteDatasetCategoryQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 拖拽
+  ): Promise<string>;
+  /**
+   * 拖拽
+   */
   postDrag(
     data: CategoryDragRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryResponse>>;
-  // 列表
+  ): Promise<CategoryResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryResponse[]>>;
-  // 数据集分类列表
+  ): Promise<CategoryResponse[]>;
+  /**
+   * 数据集分类列表
+   */
   getListDatasetCategory(
     query: getListDatasetCategoryQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryResponse[]>>;
-  // 分页列表
+  ): Promise<CategoryResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<CategoryResponse>>>;
-  // 保存数据集分类
+  ): Promise<IPage<CategoryResponse>>;
+  /**
+   * 保存数据集分类
+   */
   postSaveDatasetCategory(
     data: CategoryRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: CategoryRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -1,5 +1,7 @@
 import type { AxiosRequestConfig } from 'axios';
 export interface ClearLogLoginService {
-  // 清除登录日志
-  post(config?: Partial<AxiosRequestConfig>): Promise<IHttpResponse<unknown>>;
+  /**
+   * 清除登录日志
+   */
+  post(config?: Partial<AxiosRequestConfig>): Promise<unknown>;
 }

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

@@ -1,5 +1,7 @@
 import type { AxiosRequestConfig } from 'axios';
 export interface ClearLogOperateService {
-  // 清空操作日志表
-  post(config?: Partial<AxiosRequestConfig>): Promise<IHttpResponse<unknown>>;
+  /**
+   * 清空操作日志表
+   */
+  post(config?: Partial<AxiosRequestConfig>): Promise<unknown>;
 }

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

@@ -1,5 +1,7 @@
 import type { AxiosRequestConfig } from 'axios';
 export interface ClearTempDirService {
-  // 清空临时文件目录
-  post(config?: Partial<AxiosRequestConfig>): Promise<IHttpResponse<unknown>>;
+  /**
+   * 清空临时文件目录
+   */
+  post(config?: Partial<AxiosRequestConfig>): Promise<unknown>;
 }

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

@@ -2,9 +2,11 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 结果集过滤器表实体类 } from '../entities';
 
 export interface CopyFilterService {
-  // 复制过滤器
+  /**
+   * 复制过滤器
+   */
   post(
     data: 结果集过滤器表实体类,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
+  ): Promise<unknown>;
 }

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

@@ -6,56 +6,89 @@ 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 putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface DashboardService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: DashboardRequest,
     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<DashboardResponse>>;
-  // 列表
+  ): Promise<DashboardResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DashboardResponse[]>>;
-  // 移动位置
+  ): Promise<DashboardResponse[]>;
+  /**
+   * 移动位置
+   */
   postMove(
     data: DashboardSortRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 分页列表
+  ): Promise<string>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DashboardResponse>>>;
-  // 修改
+  ): Promise<IPage<DashboardResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: DashboardRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -10,80 +10,135 @@ 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<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   put(
     data: DataSourceMainRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 启用和禁用
+  ): Promise<string>;
+  /**
+   * 启用和禁用
+   */
   putEnabled(
     data: DataSourceIsEnableRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 支持DML、DDL
+  ): Promise<string>;
+  /**
+   * 支持DML、DDL
+   */
   postExecuteUpdate(
     data: DataSourceUpdateRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<number>>;
-  // 查询数据源详情
+  ): Promise<number>;
+  /**
+   * 查询数据源详情
+   */
   getFindById(
     query: getFindByIdQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DataSourceMainResponse>>;
-  // 列表
+  ): Promise<DataSourceMainResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DataSourceMainResponse[]>>;
-  // 分页列表
+  ): Promise<DataSourceMainResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DataSourceMainResponse>>>;
-  // 查询数据
+  ): Promise<IPage<DataSourceMainResponse>>;
+  /**
+   * 查询数据
+   */
   postQueryData(
     query: postQueryDataQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IObject[]>>;
-  // 查询SQL视图表字段信息
+  ): Promise<IObject[]>;
+  /**
+   * 查询SQL视图表字段信息
+   */
   postSqlColumnInformation(
     data: TableColumnDTO,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ColumnInformationSchema[]>>;
-  // 连接测试
+  ): Promise<ColumnInformationSchema[]>;
+  /**
+   * 连接测试
+   */
   postTestConnect(
     data: DataSource,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
+  ): Promise<boolean>;
 }

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

@@ -6,52 +6,70 @@ import type {
 } 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 DataTraceService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: DataTraceRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 导出
+  ): Promise<string>;
+  /**
+   * 导出
+   */
   postExport(
     data: DataTraceRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DataTraceResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<DataTraceResponse[]>>;
-  // 操作人
-  getOperators(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<UserInfo[]>>;
-  // 分页列表
+  ): Promise<DataTraceResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<DataTraceResponse[]>;
+  /**
+   * 操作人
+   */
+  getOperators(config?: Partial<AxiosRequestConfig>): Promise<UserInfo[]>;
+  /**
+   * 分页列表
+   */
   postPageList(
     data: DataTraceRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<DataTraceResponse>>>;
-  // 修改
+  ): Promise<IPage<DataTraceResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: DataTraceRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }