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

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

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   SysConfigResponse,
   SysConfigRequest,
@@ -15,120 +16,175 @@ import type {
   WXWorkConfig,
 } from '../entities';
 
+export interface getAppGlobalInfoAppIdPathParams {
+  appId: string;
+}
+export interface postAppGlobalAppIdPathParams {
+  appId: string;
+}
 export interface getInfoQuery {
-  configEnum: string; // 配置枚举(BASE_CFG/基础设置,THEME_CFG/主题设置,LOGIN_CFG/登录设置,MARK_CFG/水印设置,SECURITY_CFG/安全设置,ORG_CFG/组织设置)
+  /**
+   * 配置枚举(BASE_CFG/基础设置,THEME_CFG/主题设置,LOGIN_CFG/登录设置,MARK_CFG/水印设置,SECURITY_CFG/安全设置,ORG_CFG/组织设置)
+   */
+  configEnum: string;
 }
 export interface getTenantDisabledDevelopQuery {
-  tenantId: string; // 租户ID
+  /**
+   * 租户ID
+   */
+  tenantId: string;
 }
 export interface deleteUserRoleQuery {
-  userId: string; // 删除的userId
+  /**
+   * 删除的userId
+   */
+  userId: string;
 }
 export interface PlatService {
-  // 应用全局配置设置 查询
+  /**
+   * 应用全局配置设置 查询
+   */
   getAppGlobalInfoAppId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<SysConfigResponse>>;
-  // 应用全局配置设置 保存/更新
+    path: getAppGlobalInfoAppIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<SysConfigResponse>;
+  /**
+   * 应用全局配置设置 保存/更新
+   */
   postAppGlobalAppId(
+    path: postAppGlobalAppIdPathParams,
     data: SysConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 基础设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 基础设置 保存/更新
+   */
   postBase(
     data: PlatformBaseConfig,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 钉钉设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 钉钉设置 保存/更新
+   */
   postDingtalk(
     data: DingTalkConfig,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 邮件 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 邮件 保存/更新
+   */
   postEmail(
     data: MailConfig,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 飞书设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 飞书设置 保存/更新
+   */
   postFeishu(
     data: FeiShuConfig,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 全局禁用设计器
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 全局禁用设计器
+   */
   getGlobalDisabledDevelop(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<SysConfigResponse>>;
-  // 配置列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<SysConfigResponse[]>>;
-  // 登录设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<SysConfigResponse>;
+  /**
+   * 配置列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<SysConfigResponse[]>;
+  /**
+   * 登录设置 保存/更新
+   */
   postLogin(
     data: AuthConfig,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 组织设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 组织设置 保存/更新
+   */
   postOrg(
     data: OrgConfig,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 安全设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 安全设置 保存/更新
+   */
   postSecurity(
     data: SecurityConfig,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询租户配置
-  getTenantCfg(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<TenantConfig>>;
-  // 禁用设计器
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 查询租户配置
+   */
+  getTenantCfg(config?: Partial<AxiosRequestConfig>): Promise<TenantConfig>;
+  /**
+   * 禁用设计器
+   */
   getTenantDisabledDevelop(
     query: getTenantDisabledDevelopQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 主题设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 主题设置 保存/更新
+   */
   postTheme(
     data: SysConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 企微证书文件上传
-  postUploadCertFile(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // (平台管理)添加管理员 保存
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 企微证书文件上传
+   */
+  postUploadCertFile(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * (平台管理)添加管理员 保存
+   */
   postUserRole(
     data: UserRoleRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // (平台管理)管理员角色删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * (平台管理)管理员角色删除
+   */
   deleteUserRole(
     query: deleteUserRoleQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // (平台管理)管理员角色编辑
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * (平台管理)管理员角色编辑
+   */
   postUserRoleReset(
     data: UserRoles4Update,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 人员类型导入重复数据 辅助唯一值字段
-  getUserField(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<UserFieldMeta[]>>;
-  // 查询平台版本
-  getVersion(config?: Record<string, string>): Promise<IHttpResponse<string>>;
-  // 水印设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 人员类型导入重复数据 辅助唯一值字段
+   */
+  getUserField(config?: Partial<AxiosRequestConfig>): Promise<UserFieldMeta[]>;
+  /**
+   * 查询平台版本
+   */
+  getVersion(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 水印设置 保存/更新
+   */
   postWatermark(
     data: SysConfigRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 企业微信设置 保存/更新
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 企业微信设置 保存/更新
+   */
   postWxwork(
     data: WXWorkConfig,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/platform/service/apis/plugin-version.service.d.ts

@@ -1,48 +1,73 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { PluginVersionRequest, PluginVersionResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: 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 PluginVersionService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PluginVersionRequest,
-    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<PluginVersionResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PluginVersionResponse>;
+  /**
+   * 列表
+   */
   postList(
     data: PluginVersionRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PluginVersionResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PluginVersionResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<PluginVersionResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<PluginVersionResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PluginVersionRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

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

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type {
   PluginRequest,
   PackageJson,
@@ -6,92 +8,178 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getGetImagesQuery {
-  imageUrl: string; // imageUrl
+  /**
+   * imageUrl
+   */
+  imageUrl: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface postUploadZipQuery {
-  categoryId?: string; // 分类Id
-  client?: string; // 支持客户端
-  description?: string; // 版本说明
-  icon?: string; // 组件图标
-  id?: string; // id
-  ids?: string; // ids
-  key?: string; // 组件key
-  keyWord?: string; //
-  name?: string; // 最新名称
-  pageNo?: number; //
-  pageSize?: number; //
-  readMe?: string; //
-  screenShot?: string; // 组件截图
-  tag?: string; // 标识
-  tenantId?: string; // 租户ID
-  tmpPath?: string; //
-  url?: string; // 最新文件地址
-  version?: string; // 最新版本号
-  zipUrl?: string; // zip文件地址
+  /**
+   * 分类Id
+   */
+  categoryId?: string;
+  /**
+   * 支持客户端
+   */
+  client?: string;
+  /**
+   * 版本说明
+   */
+  description?: string;
+  /**
+   * 组件图标
+   */
+  icon?: string;
+  /**
+   * id
+   */
+  id?: string;
+  /**
+   * ids
+   */
+  ids?: string;
+  /**
+   * 组件key
+   */
+  key?: string;
+  /**
+   *
+   */
+  keyWord?: string;
+  /**
+   * 最新名称
+   */
+  name?: string;
+  /**
+   *
+   */
+  pageNo?: number;
+  /**
+   *
+   */
+  pageSize?: number;
+  /**
+   *
+   */
+  readMe?: string;
+  /**
+   * 组件截图
+   */
+  screenShot?: string;
+  /**
+   * 标识
+   */
+  tag?: string;
+  /**
+   * 租户ID
+   */
+  tenantId?: string;
+  /**
+   *
+   */
+  tmpPath?: string;
+  /**
+   * 最新文件地址
+   */
+  url?: string;
+  /**
+   * 最新版本号
+   */
+  version?: string;
+  /**
+   * zip文件地址
+   */
+  zipUrl?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface PluginService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PluginRequest,
-    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>;
+  /**
+   * 取消上传文件
+   */
   postCancelUpload(
     data: PackageJson,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 删除分类
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 删除分类
+   */
   putDeleteCategory(
     data: PluginRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取服务器存储的图片
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 获取服务器存储的图片
+   */
   getGetImages(
     query: getGetImagesQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 获取租户下的所有组件信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 获取租户下的所有组件信息
+   */
   postGetTenantCompList(
     data: PluginRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PluginTenant[]>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PluginTenant[]>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PluginResponse>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PluginResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PluginResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PluginResponse[]>;
+  /**
+   * 分页列表
+   */
   postPageList(
     data: PluginRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<PluginResponse>>>;
-  // 上传压缩文件
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<PluginResponse>>;
+  /**
+   * 上传压缩文件
+   */
   postUploadZip(
     query: postUploadZipQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PackageJson>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PackageJson>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PluginRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }