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

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

@@ -8,122 +8,241 @@ import type {
 } from '../entities';
 
 export interface getActivateQuery {
-  appId?: string; // 应用id
-  authorizationCode: string; // 激活码
-  increment?: boolean; // 增量激活
-  suiteKey?: string; // 应用Key
-  version?: string; // 平台版本
+  /**
+   * 应用id
+   */
+  appId?: string;
+  /**
+   * 激活码
+   */
+  authorizationCode: string;
+  /**
+   * 增量激活
+   */
+  increment?: boolean;
+  /**
+   * 应用Key
+   */
+  suiteKey?: string;
+  /**
+   * 平台版本
+   */
+  version?: string;
 }
 export interface postActivatesQuery {
-  increment?: boolean; // 增量激活
+  /**
+   * 增量激活
+   */
+  increment?: boolean;
 }
 export interface postActivatesOfflineQuery {
-  appId?: string; // 应用id
-  productType: string; // 应用Key
+  /**
+   * 应用id
+   */
+  appId?: string;
+  /**
+   * 应用Key
+   */
+  productType: string;
 }
 export interface getClientsQuery {
-  appId: string; // appId
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface getGetAppBasicInfoQuery {
-  appId?: string; // 应用id
+  /**
+   * 应用id
+   */
+  appId?: string;
 }
 export interface getGetExpireMsgQuery {
-  appId?: string; // 应用id
-  env?: string; // 授权环境
+  /**
+   * 应用id
+   */
+  appId?: string;
+  /**
+   * 授权环境
+   */
+  env?: string;
 }
 export interface getGetUsersQuery {
-  appId?: string; // 应用id
-  clientId: string; // 客户端id
-  env?: string; // 环境
+  /**
+   * 应用id
+   */
+  appId?: string;
+  /**
+   * 客户端id
+   */
+  clientId: string;
+  /**
+   * 环境
+   */
+  env?: string;
 }
 export interface getInfoQuery {
-  licenseId: string; // licenseId授权信息id
+  /**
+   * licenseId授权信息id
+   */
+  licenseId: string;
+}
+export interface getModuleAuthQuery {
+  /**
+   * 授权模块
+   */
+  module?: string;
 }
 export interface getPageListQuery {
-  appId?: string; // 应用id
-  env?: string; // 授权环境
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  productType?: string; // 产品类型
+  /**
+   * 应用id
+   */
+  appId?: string;
+  /**
+   * 授权环境
+   */
+  env?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 产品类型
+   */
+  productType?: string;
 }
 export interface getShareTagQuery {
-  appId?: string; // 应用id
+  /**
+   * 应用id
+   */
+  appId?: string;
 }
 export interface getSourceTagQuery {
-  appId?: string; // 应用id
+  /**
+   * 应用id
+   */
+  appId?: string;
 }
 export interface getUnbindQuery {
-  appId?: string; // appId
-  env?: string; // 授权环境
-  licenseId: string; // licenseId授权信息id
+  /**
+   * appId
+   */
+  appId?: string;
+  /**
+   * 授权环境
+   */
+  env?: string;
+  /**
+   * licenseId授权信息id
+   */
+  licenseId: string;
 }
 export interface LicenseService {
-  // 平台和应用激活
+  /**
+   * 平台和应用激活
+   */
   getActivate(
     query: getActivateQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 平台和应用激活
+  /**
+   * 平台和应用激活
+   */
   postActivates(
     query: postActivatesQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 平台和应用激活
+  /**
+   * 平台和应用激活
+   */
   postActivatesOffline(
     query: postActivatesOfflineQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 证书校验，用于平台登录前判断是否在有效期
+  /**
+   * 证书校验，用于平台登录前判断是否在有效期
+   */
   getCheckLicense(config?: Partial<AxiosRequestConfig>): Promise<boolean>;
-  // 获取在线客户端
+  /**
+   * 获取在线客户端
+   */
   getClients(
     query: getClientsQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<ClientsDto[]>;
-  // 离线授权获取二维码信息
+  /**
+   * 离线授权获取二维码信息
+   */
   getGetAppBasicInfo(
     query: getGetAppBasicInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<AuthBasicInfo>;
-  // 获取过期提醒
+  /**
+   * 获取过期提醒
+   */
   getGetExpireMsg(
     query: getGetExpireMsgQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<LicenseExpireMsg[]>;
-  // 判断是否满足用户数授权条件
+  /**
+   * 判断是否满足用户数授权条件
+   */
   getGetUsers(
     query: getGetUsersQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 平台应用，授权详情
+  /**
+   * 平台应用，授权详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<LicenseLimitResponse[]>;
-  // 判断对应模块是否已进行授权
-  getModuleAuth(config?: Partial<AxiosRequestConfig>): Promise<boolean>;
-  // 平台/应用，授权列表
+  /**
+   * 判断对应模块是否已进行授权
+   */
+  getModuleAuth(
+    query: getModuleAuthQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 平台/应用，授权列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<AcLicenseResponse>>;
-  // 判断是否为被共享应用
+  /**
+   * 判断是否为被共享应用
+   */
   getShareTag(
     query: getShareTagQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 判断是否为共享应用
+  /**
+   * 判断是否为共享应用
+   */
   getSourceTag(
     query: getSourceTagQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 授权解绑
+  /**
+   * 授权解绑
+   */
   getUnbind(
     query: getUnbindQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 执行shell脚本并清空授权
+  /**
+   * 执行shell脚本并清空授权
+   */
   getUninstall(config?: Partial<AxiosRequestConfig>): Promise<string>;
-  // 环境校验
+  /**
+   * 环境校验
+   */
   getVerify(config?: Partial<AxiosRequestConfig>): Promise<boolean>;
 }

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

@@ -2,15 +2,35 @@ import type { AxiosRequestConfig } from 'axios';
 import type { LoginLogResponse } from '../entities';
 
 export interface getPageListQuery {
-  endTime?: string; // 截止时间
-  ip?: string; // IP地址
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  sourceEnum?: string; // 客户端
-  startTime?: string; // 开始时间
+  /**
+   * 截止时间
+   */
+  endTime?: string;
+  /**
+   * IP地址
+   */
+  ip?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 客户端
+   */
+  sourceEnum?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface LoginLogService {
-  // 登录足迹分页列表
+  /**
+   * 登录足迹分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,

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

@@ -7,37 +7,65 @@ import type {
 } from '../entities';
 
 export interface getSignOutQuery {
-  appId?: string; // 应用id
-  clientId?: string; // 应用id
-  env?: string; // 应用环境
-  platform?: string; // 页面SystemTypeEnum
+  /**
+   * 应用id
+   */
+  appId?: string;
+  /**
+   * 应用id
+   */
+  clientId?: string;
+  /**
+   * 应用环境
+   */
+  env?: string;
+  /**
+   * 页面SystemTypeEnum
+   */
+  platform?: string;
 }
 export interface getUserAppAuthQuery {
-  appId: string; // 应用id
-  clientId: string; // 客户端id
+  /**
+   * 应用id
+   */
+  appId: string;
+  /**
+   * 客户端id
+   */
+  clientId: string;
 }
 export interface LoginService {
-  // 验证第三方平台是否注册正常
+  /**
+   * 验证第三方平台是否注册正常
+   */
   postCheckApp(
     data: ThirdAppConfigReq,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 短信登录发送短信
+  /**
+   * 短信登录发送短信
+   */
   postSendMsg(
     data: SmsDto,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 登录api
+  /**
+   * 登录api
+   */
   postSign(
     data: UserBaseReq,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<UserLoginResp>;
-  // 退出登录
+  /**
+   * 退出登录
+   */
   getSignOut(
     query: getSignOutQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 当前人员登录app时是否有权限
+  /**
+   * 当前人员登录app时是否有权限
+   */
   getUserAppAuth(
     query: getUserAppAuthQuery,
     config?: Partial<AxiosRequestConfig>,

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

@@ -2,20 +2,36 @@ import type { AxiosRequestConfig } from 'axios';
 import type { ManagerBean } from '../entities';
 
 export interface getPlatPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface getTenantPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface ManagerService {
-  // (平台管理)管理员分页列表
+  /**
+   * (平台管理)管理员分页列表
+   */
   getPlatPageList(
     query: getPlatPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<ManagerBean>>;
-  // (租户管理后台)管理员分页列表
+  /**
+   * (租户管理后台)管理员分页列表
+   */
   getTenantPageList(
     query: getTenantPageListQuery,
     config?: Partial<AxiosRequestConfig>,

package/lib/platform/service/apis/message-setting.service.d.ts

@@ -8,76 +8,138 @@ 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 {
-  type?: string; // type
+  /**
+   * type
+   */
+  type?: string;
 }
 export interface getPageListQuery {
-  endTime?: string; // 结束时间
-  key?: string; // key
-  name?: string; // 名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  remark?: string; // 备注
-  serviceType?: string; // 服务类型
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  type?: string; // 消息分类
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * key
+   */
+  key?: string;
+  /**
+   * 名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 备注
+   */
+  remark?: string;
+  /**
+   * 服务类型
+   */
+  serviceType?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 消息分类
+   */
+  type?: string;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface MessageSettingService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: MessageSettingRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 获取各个类型的数据条数
+  /**
+   * 获取各个类型的数据条数
+   */
   getGetTypeCount(
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MessageSettingCountResponse>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MessageSettingResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<MessageSettingResponse[]>;
-  // 调试用api测试发送MQTT消息
+  /**
+   * 调试用api测试发送MQTT消息
+   */
   postMqttSend(
     data: SendMessageRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<MessageSettingResponse>>;
-  // 测试发送邮箱消息
+  /**
+   * 测试发送邮箱消息
+   */
   postSendEmailMessage(
     data: SendEmailMessageRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 测试发送企业微信、钉钉、飞书消息
+  /**
+   * 测试发送企业微信、钉钉、飞书消息
+   */
   postSendMessage(
     data: SendMessageRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<boolean>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: MessageSettingRequest,

package/lib/platform/service/apis/minio-file.service.d.ts

@@ -1,18 +1,26 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import type { AxiosRequestConfig } from 'axios';
 import type { Base64UploadPlatFormRequest } from '../entities';
 
 export interface getDownloadQuery {
-  fileUrl: string; // fileUrl
+  /**
+   * fileUrl
+   */
+  fileUrl: string;
 }
 export interface MinioFileService {
-  // base64文件上传minio
+  /**
+   * base64文件上传minio
+   */
   postBase64Upload(
     data: Base64UploadPlatFormRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // minIO获取文件公用接口
+  /**
+   * minIO获取文件公用接口
+   */
   getDownload(
     query: getDownloadQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<unknown>;
+  ): Promise<any>;
 }