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

package/es/apaas/service/apis/report-data-set.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   ReportDataSetRequest,
   ExprDTO,
@@ -8,79 +9,119 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface postGenColumnQuery {
-  fileUpload?: boolean; // 数据集是否是本地上传
+  /**
+   * 数据集是否是本地上传
+   */
+  fileUpload?: boolean;
 }
 export interface getGenSqlQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getInfoQuery {
-  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 ReportDataSetService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: ReportDataSetRequest,
-    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>;
+  /**
+   * 函数生成新字段
+   */
   postGenColumn(
     query: postGenColumnQuery,
     data: ExprDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 生成sql
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 生成sql
+   */
   getGenSql(
     query: getGenSqlQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ReportDataSetResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ReportDataSetResponse>;
+  /**
+   * 列表
+   */
   getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ReportDataSetResponse[]>>;
-  // 数据集分页查询
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ReportDataSetResponse[]>;
+  /**
+   * 数据集分页查询
+   */
   postListByPage4DataSet(
     data: ReportConditionDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelPageableRow>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelPageableRow>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<ReportDataSetResponse>>>;
-  // 预览
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ReportDataSetResponse>>;
+  /**
+   * 预览
+   */
   postPreview(
     data: ReportDataSetConditionDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelPageableRow>>;
-  // 名称修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelPageableRow>;
+  /**
+   * 名称修改
+   */
   postUpdateName(
     data: ReportDataSetRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ReportDataSetRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/apaas/service/apis/report-data.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   ReportConditionDTO,
   ModelPageableRow,
@@ -5,19 +6,25 @@ import type {
 } from '../entities';
 
 export interface ReportDataService {
-  // 列表
+  /**
+   * 列表
+   */
   postListByPage(
     data: ReportConditionDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelPageableRow>>;
-  // 交叉表分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelPageableRow>;
+  /**
+   * 交叉表分页列表
+   */
   postListByPage4Cross(
     data: CrossReportConditionDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 统计行
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 统计行
+   */
   postListStatistic(
     data: ReportConditionDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
 }

package/es/apaas/service/apis/report.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   ReportRequest,
   ReportResponse,
@@ -7,98 +8,157 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getInfosQuery {
-  appId?: string; // app id
-  env?: string; // 环境
-  type?: boolean; // true:按分类，false:按数据源
+  /**
+   * app id
+   */
+  appId?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * true:按分类，false:按数据源
+   */
+  type?: boolean;
 }
 export interface getListModelReportQuery {
-  modelKey?: string; // modelKey
+  /**
+   * modelKey
+   */
+  modelKey?: string;
 }
 export interface getListSystemModelFieldsQuery {
-  modelKey: string; // modelKey
+  /**
+   * modelKey
+   */
+  modelKey: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putUndeployIdPathParams {
+  id: string;
+}
+export interface getUserPermissionIdPathParams {
+  id: string;
+}
+export interface putIdPathParams {
+  id: string;
 }
 export interface ReportService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: ReportRequest,
-    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>;
+  /**
+   * 发布
+   */
   postDeploy(
     data: ReportRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ReportResponse>>;
-  // 报表列表获取(按类型)
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ReportResponse>;
+  /**
+   * 报表列表获取(按类型)
+   */
   getInfos(
     query: getInfosQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IObject>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ReportResponse[]>>;
-  // 报表列表获取(按类型)
-  getListType(config?: Record<string, string>): Promise<IHttpResponse<IObject>>;
-  // 获取模型对应报表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IObject>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<ReportResponse[]>;
+  /**
+   * 报表列表获取(按类型)
+   */
+  getListType(config?: Partial<AxiosRequestConfig>): Promise<IObject>;
+  /**
+   * 获取模型对应报表
+   */
   getListModelReport(
     query: getListModelReportQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelReport[]>>;
-  // 获取系统模型对应字段
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelReport[]>;
+  /**
+   * 获取系统模型对应字段
+   */
   getListSystemModelFields(
     query: getListSystemModelFieldsQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FieldMeta[]>>;
-  // 获取系统模型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FieldMeta[]>;
+  /**
+   * 获取系统模型
+   */
   getListSystemModels(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<SystemModelMeta[]>>;
-  // 移动
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<SystemModelMeta[]>;
+  /**
+   * 移动
+   */
   putMove(
     data: ReportRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 分页列表
+   */
   postPageList(
     data: ReportRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<ReportResponse>>>;
-  // 取消发布
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ReportResponse>>;
+  /**
+   * 取消发布
+   */
   putUndeployId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 判断用户是否有报表权限
+    path: putUndeployIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 判断用户是否有报表权限
+   */
   getUserPermissionId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 看板分页列表
+    path: getUserPermissionIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 看板分页列表
+   */
   postViewPageList(
     data: ReportRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<ReportResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ReportResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ReportRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/apaas/service/apis/role-permission.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   RolePermissionRequest,
   RolePermissionListDTO,
@@ -5,28 +6,42 @@ import type {
 } from '../entities';
 
 export interface getMenuListQuery {
-  roleId: string; // 角色id
-  type: string; // 权限分类 (WEB/MOBILE)
+  /**
+   * 角色id
+   */
+  roleId: string;
+  /**
+   * 权限分类 (WEB/MOBILE)
+   */
+  type: string;
 }
 export interface RolePermissionService {
-  // 角色权限保存
+  /**
+   * 角色权限保存
+   */
   post(
     data: RolePermissionRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 角色权限批量保存
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 角色权限批量保存
+   */
   postBulk(
     data: RolePermissionListDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 权限配置权限列表查询
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 权限配置权限列表查询
+   */
   getMenuList(
     query: getMenuListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<MenuPermissionDTO>>;
-  // 角色权限删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<MenuPermissionDTO>;
+  /**
+   * 角色权限删除
+   */
   postRemove(
     data: RolePermissionRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/apaas/service/apis/role.service.d.ts

@@ -1,47 +1,91 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { RoleRequest, RoleResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  enabled?: number; // 状态(1:启用 ,0: 禁用 空查询全部)
-  roleName?: string; // 角色名称
+  /**
+   * 状态(1:启用 ,0: 禁用 空查询全部)
+   */
+  enabled?: number;
+  /**
+   * 角色名称
+   */
+  roleName?: string;
 }
 export interface getPageListQuery {
-  enabled?: number; // 状态(1:启用 ,0: 禁用 空查询全部)
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  roleName?: string; // 角色名称
+  /**
+   * 状态(1:启用 ,0: 禁用 空查询全部)
+   */
+  enabled?: number;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 角色名称
+   */
+  roleName?: string;
+}
+export interface putIdEnabledPathParams {
+  id: string;
+  enabled: string;
 }
 export interface RoleService {
-  // 新增编辑 角色
+  /**
+   * 新增编辑 角色
+   */
   post(
     data: RoleRequest,
-    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<RoleResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<RoleResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<RoleResponse[]>>;
-  // 角色条件查询分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<RoleResponse[]>;
+  /**
+   * 角色条件查询分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<RoleResponse>>>;
-  // 角色 启用禁用
-  putIdEnabled(config?: Record<string, string>): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<RoleResponse>>;
+  /**
+   * 角色 启用禁用
+   */
+  putIdEnabled(
+    path: putIdEnabledPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }