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

package/lib/platform/service/apis/knowledge-base-chunk.service.d.ts

@@ -1,50 +1,75 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   KnowledgeBaseChunkRequest,
   KnowledgeBaseChunkResponse,
 } 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 KnowledgeBaseChunkService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: KnowledgeBaseChunkRequest,
-    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<KnowledgeBaseChunkResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<KnowledgeBaseChunkResponse>;
+  /**
+   * 列表
+   */
   getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<KnowledgeBaseChunkResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<KnowledgeBaseChunkResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<KnowledgeBaseChunkResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<KnowledgeBaseChunkResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: KnowledgeBaseChunkRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/platform/service/apis/knowledge-base-doc.service.d.ts

@@ -1,50 +1,75 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   KnowledgeBaseDocRequest,
   KnowledgeBaseDocResponse,
 } 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 KnowledgeBaseDocService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: KnowledgeBaseDocRequest,
-    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<KnowledgeBaseDocResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<KnowledgeBaseDocResponse>;
+  /**
+   * 列表
+   */
   getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<KnowledgeBaseDocResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<KnowledgeBaseDocResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<KnowledgeBaseDocResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<KnowledgeBaseDocResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: KnowledgeBaseDocRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/platform/service/apis/knowledge-base.service.d.ts

@@ -1,47 +1,72 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { KnowledgeBaseRequest, KnowledgeBaseResponse } 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 KnowledgeBaseService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: KnowledgeBaseRequest,
-    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<KnowledgeBaseResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<KnowledgeBaseResponse>;
+  /**
+   * 列表
+   */
   getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<KnowledgeBaseResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<KnowledgeBaseResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<KnowledgeBaseResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<KnowledgeBaseResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: KnowledgeBaseRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

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

@@ -1,6 +1,7 @@
+import type { AxiosRequestConfig } from 'axios';
 export interface LdapService {
-  // 文件上传minio
-  postUploadCertificate(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+  /**
+   * 文件上传minio
+   */
+  postUploadCertificate(config?: Partial<AxiosRequestConfig>): Promise<string>;
 }

package/lib/platform/service/apis/license-unbind-log.service.d.ts

@@ -1,9 +1,12 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { LicenseUnbindLogRequest } from '../entities';
 
 export interface LicenseUnbindLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: LicenseUnbindLogRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

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

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   ClientsDto,
   AuthBasicInfo,
@@ -7,126 +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?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 平台和应用激活
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 平台和应用激活
+   */
   postActivates(
     query: postActivatesQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 平台和应用激活
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 平台和应用激活
+   */
   postActivatesOffline(
     query: postActivatesOfflineQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 证书校验，用于平台登录前判断是否在有效期
-  getCheckLicense(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 获取在线客户端
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 证书校验，用于平台登录前判断是否在有效期
+   */
+  getCheckLicense(config?: Partial<AxiosRequestConfig>): Promise<boolean>;
+  /**
+   * 获取在线客户端
+   */
   getClients(
     query: getClientsQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ClientsDto[]>>;
-  // 离线授权获取二维码信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ClientsDto[]>;
+  /**
+   * 离线授权获取二维码信息
+   */
   getGetAppBasicInfo(
     query: getGetAppBasicInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<AuthBasicInfo>>;
-  // 获取过期提醒
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<AuthBasicInfo>;
+  /**
+   * 获取过期提醒
+   */
   getGetExpireMsg(
     query: getGetExpireMsgQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<LicenseExpireMsg[]>>;
-  // 判断是否满足用户数授权条件
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<LicenseExpireMsg[]>;
+  /**
+   * 判断是否满足用户数授权条件
+   */
   getGetUsers(
     query: getGetUsersQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 平台应用，授权详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 平台应用，授权详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<LicenseLimitResponse[]>>;
-  // 判断对应模块是否已进行授权
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<LicenseLimitResponse[]>;
+  /**
+   * 判断对应模块是否已进行授权
+   */
   getModuleAuth(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 平台/应用，授权列表
+    query: getModuleAuthQuery,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 平台/应用，授权列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<AcLicenseResponse>>>;
-  // 判断是否为被共享应用
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<AcLicenseResponse>>;
+  /**
+   * 判断是否为被共享应用
+   */
   getShareTag(
     query: getShareTagQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 判断是否为共享应用
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 判断是否为共享应用
+   */
   getSourceTag(
     query: getSourceTagQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 授权解绑
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 授权解绑
+   */
   getUnbind(
     query: getUnbindQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 执行shell脚本并清空授权
-  getUninstall(config?: Record<string, string>): Promise<IHttpResponse<string>>;
-  // 环境校验
-  getVerify(config?: Record<string, string>): Promise<IHttpResponse<boolean>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 执行shell脚本并清空授权
+   */
+  getUninstall(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 环境校验
+   */
+  getVerify(config?: Partial<AxiosRequestConfig>): Promise<boolean>;
 }