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

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

@@ -1,10 +1,14 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 export interface getQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface GetPageTemplateLayoutService {
-  // 获取页面模板保存的布局数据
-  get(
-    query: getQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
+  /**
+   * 获取页面模板保存的布局数据
+   */
+  get(query: getQuery, config?: Partial<AxiosRequestConfig>): Promise<any>;
 }

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

@@ -1,10 +1,14 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 export interface getQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface GetPageTemplateThemeJsonService {
-  // 获取页面模板保存的主题数据
-  get(
-    query: getQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
+  /**
+   * 获取页面模板保存的主题数据
+   */
+  get(query: getQuery, config?: Partial<AxiosRequestConfig>): Promise<any>;
 }

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

@@ -1,4 +1,8 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 export interface GetPageTotalCountService {
-  // 获取页面总数
-  get(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
+  /**
+   * 获取页面总数
+   */
+  get(config?: Partial<AxiosRequestConfig>): Promise<any>;
 }

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

@@ -1,9 +1,13 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type { 操作日志查询参数 } from '../entities';
 
 export interface GetPnLogOperateByPageService {
-  // 分页获取操作日志数据
+  /**
+   * 分页获取操作日志数据
+   */
   post(
     data: 操作日志查询参数,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
 }

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

@@ -1,10 +1,14 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 export interface getQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface GetPnResourceGroupByIdService {
-  // 根据ID获取资源分组
-  get(
-    query: getQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
+  /**
+   * 根据ID获取资源分组
+   */
+  get(query: getQuery, config?: Partial<AxiosRequestConfig>): Promise<any>;
 }

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

@@ -1,4 +1,8 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 export interface GetProjectTotalCountService {
-  // 获取项目总数
-  get(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
+  /**
+   * 获取项目总数
+   */
+  get(config?: Partial<AxiosRequestConfig>): Promise<any>;
 }

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

@@ -1,10 +1,14 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 export interface getQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface GetShareCustomCompByIdService {
-  // 根据ID获取共享自定义组件
-  get(
-    query: getQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
+  /**
+   * 根据ID获取共享自定义组件
+   */
+  get(query: getQuery, config?: Partial<AxiosRequestConfig>): Promise<any>;
 }

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

@@ -1,9 +1,13 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type { 共享自定义组件查询参数 } from '../entities';
 
 export interface GetShareCustomCompByPageService {
-  // 分页获取共享自定义组件数据
+  /**
+   * 分页获取共享自定义组件数据
+   */
   post(
     data: 共享自定义组件查询参数,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
 }

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

@@ -1,4 +1,8 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 export interface GetSysEchartThemesService {
-  // 获取系统主题列表
-  get(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
+  /**
+   * 获取系统主题列表
+   */
+  get(config?: Partial<AxiosRequestConfig>): Promise<any>;
 }

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

@@ -1,9 +1,10 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type { HttpQueryForm } from '../entities';
 
 export interface HttpQueryService {
-  // 代理请求
-  post(
-    data: HttpQueryForm,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
+  /**
+   * 代理请求
+   */
+  post(data: HttpQueryForm, config?: Partial<AxiosRequestConfig>): Promise<any>;
 }

package/es/platform/service/apis/i18n-config.service.d.ts

@@ -1,21 +1,29 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { I18nConfigResponse, I18nConfigRequest } from '../entities';
 
 export interface getListQuery {
-  keyword?: string; // 搜索关键字
+  /**
+   * 搜索关键字
+   */
+  keyword?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface I18NConfigService {
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<I18nConfigResponse[]>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<I18nConfigResponse[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: I18nConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/platform/service/apis/i18n-info.service.d.ts

@@ -1,65 +1,115 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type { I18nInfoResponse, I18nInfoRequest } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getLangDownloadQuery {
-  exportData?: boolean; // 是否导出数据 false 不导出,true 导出数据
+  /**
+   * 是否导出数据 false 不导出,true 导出数据
+   */
+  exportData?: boolean;
 }
 export interface postLangJsonQuery {
-  all?: boolean; // 是否全量更新/增量更新 默认否
-  tag?: string; // 多语言分类 前端/后端(frontend/backend)
+  /**
+   * 是否全量更新/增量更新 默认否
+   */
+  all?: boolean;
+  /**
+   * 多语言分类 前端/后端(frontend/backend)
+   */
+  tag?: string;
 }
 export interface postLangTransQuery {
-  all?: boolean; // 是否全量更新/增量更新 默认否
-  tag?: string; // 多语言分类 前端/后端(frontend/backend)
+  /**
+   * 是否全量更新/增量更新 默认否
+   */
+  all?: boolean;
+  /**
+   * 多语言分类 前端/后端(frontend/backend)
+   */
+  tag?: string;
 }
 export interface postLangUploadQuery {
-  skipValid?: boolean; // skipValid
+  /**
+   * skipValid
+   */
+  skipValid?: boolean;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  searchKey?: string; // searchKey
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * searchKey
+   */
+  searchKey?: string;
+}
+export interface putKeyPathParams {
+  key: string;
 }
 export interface I18NInfoService {
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 同步多语言
-  postExternalLangSync(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 导出多语言/或导出模板
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 同步多语言
+   */
+  postExternalLangSync(config?: Partial<AxiosRequestConfig>): Promise<object>;
+  /**
+   * 导出多语言/或导出模板
+   */
   getLangDownload(
     query: getLangDownloadQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 前端多语言翻译api(前端调用 录入i18n信息 开发阶段使用)
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 前端多语言翻译api(前端调用 录入i18n信息 开发阶段使用)
+   */
   postLangJson(
     query: postLangJsonQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 多语言翻译
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 多语言翻译
+   */
   postLangTrans(
     query: postLangTransQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 多语言导入
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 多语言导入
+   */
   postLangUpload(
     query: postLangUploadQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<I18nInfoResponse>>>;
-  // 保存或修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<I18nInfoResponse>>;
+  /**
+   * 保存或修改
+   */
   putKey(
+    path: putKeyPathParams,
     data: I18nInfoRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

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

@@ -1,9 +1,13 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type { 导入组件JSON数据表单数据 } from '../entities';
 
 export interface ImportCompInfoJsonService {
-  // 导入组件信息JSON数据
+  /**
+   * 导入组件信息JSON数据
+   */
   post(
     data: 导入组件JSON数据表单数据,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
 }

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

@@ -1,16 +1,32 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 export interface ImportTemplateService {
-  // 导入模板
-  get(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
-  // 导入模板
-  head(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
-  // 导入模板
-  post(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
-  // 导入模板
-  put(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
-  // 导入模板
-  delete(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
-  // 导入模板
-  options(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
-  // 导入模板
-  patch(config?: Record<string, string>): Promise<IHttpResponse<unknown>>;
+  /**
+   * 导入模板
+   */
+  get(config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 导入模板
+   */
+  head(config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 导入模板
+   */
+  post(config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 导入模板
+   */
+  put(config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 导入模板
+   */
+  delete(config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 导入模板
+   */
+  options(config?: Partial<AxiosRequestConfig>): Promise<any>;
+  /**
+   * 导入模板
+   */
+  patch(config?: Partial<AxiosRequestConfig>): Promise<any>;
 }

package/es/platform/service/apis/internal-message.service.d.ts

@@ -1,50 +1,96 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   InternalMessageRequest,
   InternalMessageResponse,
 } from '../entities';
 
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  endTime?: string; // 截止时间
-  startTime?: string; // 开始时间
-  status?: string; // 消息状态 未读 UNREAD/全部 ALL
+  /**
+   * 截止时间
+   */
+  endTime?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 消息状态 未读 UNREAD/全部 ALL
+   */
+  status?: string;
 }
 export interface getPageListQuery {
-  endTime?: string; // 截止时间
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  startTime?: string; // 开始时间
-  status?: string; // 消息状态 未读 UNREAD/全部 ALL
+  /**
+   * 截止时间
+   */
+  endTime?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 消息状态 未读 UNREAD/全部 ALL
+   */
+  status?: string;
+}
+export interface putReadIdPathParams {
+  id: string;
 }
 export interface InternalMessageService {
-  // 保存消息记录
+  /**
+   * 保存消息记录
+   */
   post(
     data: InternalMessageRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<InternalMessageResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<InternalMessageResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<InternalMessageResponse[]>>;
-  // 系统消息分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<InternalMessageResponse[]>;
+  /**
+   * 系统消息分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<InternalMessageResponse>>>;
-  // 全部标记已读
-  putReadAll(config?: Record<string, string>): Promise<IHttpResponse<string>>;
-  // 单条消息标记已读
-  putReadId(config?: Record<string, string>): Promise<IHttpResponse<string>>;
-  // 未读消息数量
-  getUnreadCount(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<InternalMessageResponse>>;
+  /**
+   * 全部标记已读
+   */
+  putReadAll(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 单条消息标记已读
+   */
+  putReadId(
+    path: putReadIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 未读消息数量
+   */
+  getUnreadCount(config?: Partial<AxiosRequestConfig>): Promise<string>;
 }

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

@@ -1,35 +1,73 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type { ThirdPartyInvokeLogResponse } from '../entities';
 
 export interface getExportQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  beginTime?: string; // 调用时间起
-  endTime?: string; // 调用时间止
-  env?: string; // 环境
-  key?: string; // 接口标识
-  name?: string; // 接口名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  result?: number; // 调用结果
+  /**
+   * 调用时间起
+   */
+  beginTime?: string;
+  /**
+   * 调用时间止
+   */
+  endTime?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * 接口标识
+   */
+  key?: string;
+  /**
+   * 接口名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 调用结果
+   */
+  result?: number;
 }
 export interface InvokeLogService {
-  // 导出日志
+  /**
+   * 导出日志
+   */
   getExport(
     query: getExportQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ThirdPartyInvokeLogResponse>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ThirdPartyInvokeLogResponse>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<ThirdPartyInvokeLogResponse>>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ThirdPartyInvokeLogResponse>>;
 }