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

package/lib/apaas/service/apis/js-engine.service.d.ts

@@ -1,25 +1,37 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type { ScriptExecuteRequest } from '../entities';
 
-export interface getExecKeyQuery {
-  requestParam?: Record<string, unknown>; // requestParam
+export type getExecKeyQuery = Record<any, any>;
+export interface getExecKeyPathParams {
+  key: string;
 }
-export interface postExecKeyQuery {
-  requestParam?: Record<string, unknown>; // requestParam
+export type postExecKeyQuery = Record<any, any>;
+export interface postExecKeyPathParams {
+  key: string;
 }
 export interface JsEngineService {
-  // 执行脚本服务
+  /**
+   * 执行脚本服务
+   */
   getExecKey(
+    path: getExecKeyPathParams,
     query: getExecKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // POST执行脚本服务
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * POST执行脚本服务
+   */
   postExecKey(
+    path: postExecKeyPathParams,
     query: postExecKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 脚本调试或直接执行
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 脚本调试或直接执行
+   */
   postExecute(
     data: ScriptExecuteRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
 }

package/lib/apaas/service/apis/label-log.service.d.ts

@@ -1,52 +1,90 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { LabelLogRequest, LabelLogResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  endTime?: string; // 结束时间
-  labelKey?: string; // 标签key
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 标签key
+   */
+  labelKey?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface LabelLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: LabelLogRequest,
-    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<LabelLogResponse>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<LabelLogResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<LabelLogResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<LabelLogResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<LabelLogResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<LabelLogResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: LabelLogRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/label.service.d.ts

@@ -1,202 +1,359 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type {
   LabelRequest,
   LabelResponse,
-  LabelDesigner,
+  LabelBtwDesigner,
   CategoryRdoRelationResponse,
   LabelNameCheckRequest,
   FontConfig,
+  LabelDesigner,
   XmlSetting,
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getBtwPageListQuery {
-  modelKey?: string; // 模型key
-  name?: string; // 标签名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
+  /**
+   * 模型key
+   */
+  modelKey?: string;
+  /**
+   * 标签名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
 }
 export interface deleteBtwRemoveVersionByIdQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
+}
+export interface postCopyVersionIdPathParams {
+  id: string;
 }
 export interface getEntityInfoQuery {
-  tableNamePattern?: string; // tableNamePattern
+  /**
+   * tableNamePattern
+   */
+  tableNamePattern?: string;
 }
 export interface getExportQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getGetVersionByIdQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getLabelCategoryTreeQuery {
-  moduleVal: string; // 分类模板
+  /**
+   * 分类模板
+   */
+  moduleVal: string;
 }
 export interface getListQuery {
-  key?: string; // 标签key
-  modelKey?: string; // 模型key
+  /**
+   * 标签key
+   */
+  key?: string;
+  /**
+   * 模型key
+   */
+  modelKey?: string;
 }
 export interface getListVersionByIdQuery {
-  baseId: string; // baseId
-  name?: string; // 根据名称搜索
+  /**
+   * baseId
+   */
+  baseId: string;
+  /**
+   * 根据名称搜索
+   */
+  name?: string;
 }
 export interface getPageListQuery {
-  description?: string; // 页面描述
-  endTime?: string; // 结束时间
-  id?: string; // 主键id
-  key?: string; // 标签key
-  modelKey?: string; // 模型key
-  name?: string; // 标签名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
+  /**
+   * 页面描述
+   */
+  description?: string;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 主键id
+   */
+  id?: string;
+  /**
+   * 标签key
+   */
+  key?: string;
+  /**
+   * 模型key
+   */
+  modelKey?: string;
+  /**
+   * 标签名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface deleteRemoveVersionByIdQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
 }
 export interface getTestQuery {
-  exp?: string; // exp
+  /**
+   * exp
+   */
+  exp?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putUpdateVersionByIdIdPathParams {
+  id: string;
+}
+export interface putIdPathParams {
+  id: string;
 }
 export interface LabelService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: LabelRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除父
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除父
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // btw保存
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * btw保存
+   */
   postBtw(
     data: LabelRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // btw模板分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * btw复制
+   */
+  postBtwCopy(
+    data: LabelRequest,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * btw模板分页列表
+   */
   getBtwPageList(
     query: getBtwPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<LabelResponse>>>;
-  // 删除版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<LabelResponse>>;
+  /**
+   * 删除版本
+   */
   deleteBtwRemoveVersionById(
     query: deleteBtwRemoveVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // btw标签修改
-  putBtwUpdateDesigner(
-    data: LabelDesigner,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 复制
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * btw标签修改
+   */
+  putBtwUpdate(
+    data: LabelBtwDesigner,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 复制
+   */
   postCopy(
     data: LabelRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 复制版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 复制版本
+   */
   postCopyVersionId(
+    path: postCopyVersionIdPathParams,
     data: LabelRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 下载实体列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 下载实体列表
+   */
   getEntityInfo(
     query: getEntityInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 下载实体列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 下载实体列表
+   */
   getEntityUpdateDatetimeSql(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 列表
-  getExecute(config?: Record<string, string>): Promise<IHttpResponse<string>>;
-  // 导出
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 列表
+   */
+  getExecute(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 导出
+   */
   getExport(
     query: getExportQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 根据id查子
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 根据id查子
+   */
   getGetVersionById(
     query: getGetVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<LabelResponse>>;
-  // 导入
-  postImport(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<LabelResponse>>;
-  // 标签和分类树
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<LabelResponse>;
+  /**
+   * 导入
+   */
+  postImport(config?: Partial<AxiosRequestConfig>): Promise<LabelResponse>;
+  /**
+   * 标签和分类树
+   */
   getLabelCategoryTree(
     query: getLabelCategoryTreeQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CategoryRdoRelationResponse[]>>;
-  // 名称重复校验
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CategoryRdoRelationResponse[]>;
+  /**
+   * 名称重复校验
+   */
   postLabelDuplicateNameCheck(
     data: LabelNameCheckRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 父节点数据清洗
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 父节点数据清洗
+   */
   getLabelParentDataClean(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<LabelResponse[]>>;
-  // 自定义字体查询
-  getListFont(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FontConfig[]>>;
-  // 根据父baseId 查所有版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<LabelResponse[]>;
+  /**
+   * 自定义字体查询
+   */
+  getListFont(config?: Partial<AxiosRequestConfig>): Promise<FontConfig[]>;
+  /**
+   * 根据父baseId 查所有版本
+   */
   getListVersionById(
     query: getListVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<LabelResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<LabelResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<LabelResponse>>>;
-  // 删除版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<LabelResponse>>;
+  /**
+   * 删除版本
+   */
   deleteRemoveVersionById(
     query: deleteRemoveVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 保存版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 保存版本
+   */
   postSaveVersion(
     data: LabelRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 测试公式
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 测试公式
+   */
   getTest(
     query: getTestQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 修改设计Json
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 修改设计Json
+   */
   putUpdateDesigner(
     data: LabelDesigner,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改版本
+   */
   putUpdateVersionByIdId(
+    path: putUpdateVersionByIdIdPathParams,
     data: LabelRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // xml生成
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * xml生成
+   */
   postXmlSetting(
     data: XmlSetting,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: LabelRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

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

@@ -1,9 +1,12 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { UserLoginLogPageRequest, UserLoginLogDTO } from '../entities';
 
 export interface LoginLogService {
-  // 用户登录日志分页查询
+  /**
+   * 用户登录日志分页查询
+   */
   postUserLoginLogPage(
     data: UserLoginLogPageRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<UserLoginLogDTO>>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<UserLoginLogDTO>>;
 }