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

package/es/ipaas/service/apis/flow-ext.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   FlowExtRequest,
   FlowExtResponse,
@@ -5,63 +6,95 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getFindByFuuidQuery {
-  fuuid: string; // fuuid
+  /**
+   * fuuid
+   */
+  fuuid: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface getValidCronQuery {
-  cron: string; // cron
+  /**
+   * cron
+   */
+  cron: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface FlowExtService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: FlowExtRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 根据fuuid查询上线的版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 根据fuuid查询上线的版本
+   */
   getFindByFuuid(
     query: getFindByFuuidQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FlowExtResponse>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FlowExtResponse>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FlowExtResponse>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FlowExtResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FlowExtResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<FlowExtResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<FlowExtResponse>>>;
-  // 校验cron表达式
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<FlowExtResponse>>;
+  /**
+   * 校验cron表达式
+   */
   getValidCron(
     query: getValidCronQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ValidCronResponse>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ValidCronResponse>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: FlowExtRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/ipaas/service/apis/flow.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   ResponseEntity,
   FlowCategoryTree,
@@ -6,55 +7,101 @@ import type {
 } from '../entities';
 
 export interface postImportQuery {
-  categoryId: string; // 分类id
+  /**
+   * 分类id
+   */
+  categoryId: string;
 }
 export interface getListCategoryOnlineQuery {
-  categoryId: string; // 分类id
-  keyword?: string; // 根据名称,KEY 搜索
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 分类id
+   */
+  categoryId: string;
+  /**
+   * 根据名称,KEY 搜索
+   */
+  keyword?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface getListOnlineQuery {
-  name?: string; // name
+  /**
+   * name
+   */
+  name?: string;
 }
 export interface getPageListQuery {
-  categoryId: string; // 分类id
-  keyword?: string; // 根据名称,KEY 搜索
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 分类id
+   */
+  categoryId: string;
+  /**
+   * 根据名称,KEY 搜索
+   */
+  keyword?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+}
+export interface putFuuidPathParams {
+  fuuid: string;
 }
 export interface FlowService {
-  // 导出
-  postExport(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ResponseEntity>>;
-  // 流程和分类关联树
+  /**
+   * 导出
+   */
+  postExport(config?: Partial<AxiosRequestConfig>): Promise<ResponseEntity>;
+  /**
+   * 流程和分类关联树
+   */
   getFlowCategoryTree(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FlowCategoryTree[]>>;
-  // 导入
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FlowCategoryTree[]>;
+  /**
+   * 导入
+   */
   postImport(
     query: postImportQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 分类下的已上线的连接流 - 只返回触发类型为webhook的
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 分类下的已上线的连接流 - 只返回触发类型为webhook的
+   */
   getListCategoryOnline(
     query: getListCategoryOnlineQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<FlowMainResp>>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<FlowMainResp>>;
+  /**
+   * 列表
+   */
   getListOnline(
     query: getListOnlineQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FlowMainResp[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FlowMainResp[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<FlowMainResp>>>;
-  // 更新连接流信息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<FlowMainResp>>;
+  /**
+   * 更新连接流信息
+   */
   putFuuid(
+    path: putFuuidPathParams,
     data: FlowUpdateReq,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/ipaas/service/apis/runtime.service.d.ts

@@ -1,21 +1,29 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { ResponseEntity, DebugDTO } from '../entities';
 
 export interface getDestroyContextQuery {
-  clientId: string; // clientId
+  /**
+   * clientId
+   */
+  clientId: string;
 }
 export interface RuntimeService {
-  // 销毁上下文
+  /**
+   * 销毁上下文
+   */
   getDestroyContext(
     query: getDestroyContextQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 获取随机id
-  getRandomId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ResponseEntity>>;
-  // 运行到指定节点
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 获取随机id
+   */
+  getRandomId(config?: Partial<AxiosRequestConfig>): Promise<ResponseEntity>;
+  /**
+   * 运行到指定节点
+   */
   postValidWebSocketAndRunToSpecNode(
     data: DebugDTO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ResponseEntity>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ResponseEntity>;
 }

package/es/ipaas/service/entities.d.ts

@@ -682,15 +682,15 @@ export interface ConnectorLogResponse {
   /**
    * 请求报文信息
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  requestMessage?: Record<string, unknown>;
+  requestMessage?: IObject;
   /**
    * 接口响应信息
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  responseMessage?: Record<string, unknown>;
+  responseMessage?: IObject;
   /**
    * 请求时间
    *
@@ -1174,15 +1174,15 @@ export interface FlowDebugNodeLog {
   /**
    *
    *
-   * @type unknown
+   * @type LogResponse
    */
-  request?: unknown;
+  request?: LogResponse;
   /**
    *
    *
-   * @type unknown
+   * @type LogResponse
    */
-  response?: unknown;
+  response?: LogResponse;
   /**
    *
    *
@@ -1454,33 +1454,33 @@ export interface LogResponse {
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  body?: Record<string, unknown>;
+  body?: IObject;
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  headers?: Record<string, unknown>;
+  headers?: IObject;
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  method?: Record<string, unknown>;
+  method?: IObject;
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  path?: Record<string, unknown>;
+  path?: IObject;
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  query?: Record<string, unknown>;
+  query?: IObject;
   /**
    *
    *
@@ -1712,9 +1712,9 @@ export interface ResponseEntity {
   /**
    * 返回正确结果时携带的数据
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  data?: Record<string, unknown>;
+  data?: IObject;
   /**
    * 执行结果信息
    *
@@ -1744,21 +1744,21 @@ export interface SchemaObject {
   /**
    *
    *
-   * @type unknown
+   * @type SchemaObject
    */
-  items?: unknown;
+  items?: SchemaObject;
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  not?: Record<string, unknown>;
+  not?: IObject;
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  properties?: Record<string, unknown>;
+  properties?: IObject;
   /**
    *
    *