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

package/es/platform/service/apis/workbench-component.service.d.ts

@@ -5,49 +5,79 @@ 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 {
-  terminalType?: string; //
-  type?: string; //
+  /**
+   *
+   */
+  terminalType?: string;
+  /**
+   *
+   */
+  type?: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface putIdPathParams {
   id: string;
 }
 export interface WorkbenchComponentService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: WorkbenchComponentRequest,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 删除
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<string>;
-  // 详情
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<WorkbenchComponentResponse>;
-  // 列表
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<WorkbenchComponentResponse[]>;
-  // 分页列表
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
   ): Promise<IPage<WorkbenchComponentResponse>>;
-  // 修改
+  /**
+   * 修改
+   */
   putId(
     path: putIdPathParams,
     data: WorkbenchComponentRequest,

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

@@ -1276,9 +1276,9 @@ export interface AppMemberDto {
   /**
    *
    *
-   * @type unknown
+   * @type AppPO
    */
-  appData?: unknown;
+  appData?: AppPO;
   /**
    *
    *
@@ -2092,9 +2092,9 @@ export interface AppResponse {
   /**
    * 应用维护者信息
    *
-   * @type unknown
+   * @type AppMember
    */
-  appMember?: unknown;
+  appMember?: AppMember;
   /**
    * 自建应用版本
    *
@@ -2822,9 +2822,9 @@ export interface BIChartConditionDTO {
   /**
    *
    *
-   * @type unknown
+   * @type WhereRelation
    */
-  condition?: unknown;
+  condition?: WhereRelation;
   /**
    * 数据集key
    *
@@ -2846,9 +2846,9 @@ export interface BIChartConditionDTO {
   /**
    * 自定义排序
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  orderValues?: Record<string, unknown>;
+  orderValues?: IObject;
   /**
    *
    *
@@ -2896,9 +2896,9 @@ export interface BIChartExportDTO {
   /**
    *
    *
-   * @type unknown
+   * @type WhereRelation
    */
-  condition?: unknown;
+  condition?: WhereRelation;
   /**
    * 数据集key
    *
@@ -2920,9 +2920,9 @@ export interface BIChartExportDTO {
   /**
    * 自定义排序
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  orderValues?: Record<string, unknown>;
+  orderValues?: IObject;
   /**
    *
    *
@@ -2982,9 +2982,9 @@ export interface BICrossReportDTO {
   /**
    *
    *
-   * @type unknown
+   * @type WhereRelation
    */
-  condition?: unknown;
+  condition?: WhereRelation;
   /**
    * 数据集key
    *
@@ -3006,9 +3006,9 @@ export interface BICrossReportDTO {
   /**
    * 自定义排序
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  orderValues?: Record<string, unknown>;
+  orderValues?: IObject;
   /**
    *
    *
@@ -3082,15 +3082,15 @@ export interface BiDataSetPreviewRequest {
   /**
    * 字段配置json
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  fieldConfig?: Record<string, unknown>;
+  fieldConfig?: IObject;
   /**
    * 过滤条件配置json
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  filterConfig?: Record<string, unknown>;
+  filterConfig?: IObject;
   /**
    * fullSql
    *
@@ -3100,9 +3100,9 @@ export interface BiDataSetPreviewRequest {
   /**
    * 连接配置json
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  joinConfig?: Record<string, unknown>;
+  joinConfig?: IObject;
   /**
    * 数据集Key
    *
@@ -3136,9 +3136,9 @@ export interface BiDataSetPreviewRequest {
   /**
    * 数据集信息组装
    *
-   * @type unknown
+   * @type PnDataset
    */
-  pnDataset?: unknown;
+  pnDataset?: PnDataset;
 }
 export interface BiDataSetPreviewResult {
   /**
@@ -3150,9 +3150,9 @@ export interface BiDataSetPreviewResult {
   /**
    * 数据
    *
-   * @type unknown
+   * @type SqlResult
    */
-  sqlResult?: unknown;
+  sqlResult?: SqlResult;
   /**
    * 总数
    *
@@ -3170,21 +3170,21 @@ export interface BiDataSetRequest {
   /**
    * 字段配置json
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  fieldConfig?: Record<string, unknown>;
+  fieldConfig?: IObject;
   /**
    * 过滤条件配置json
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  filterConfig?: Record<string, unknown>;
+  filterConfig?: IObject;
   /**
    * 连接配置json
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  joinConfig?: Record<string, unknown>;
+  joinConfig?: IObject;
   /**
    * 数据集Key
    *
@@ -4088,27 +4088,27 @@ export interface CrossReport {
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  columnData?: Record<string, unknown>;
+  columnData?: IObject;
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  columnSubTotalData?: Record<string, unknown>;
+  columnSubTotalData?: IObject;
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  rowData?: Record<string, unknown>;
+  rowData?: IObject;
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  rowSubTotalData?: Record<string, unknown>;
+  rowSubTotalData?: IObject;
 }
 export interface DashboardRequest {
   /**
@@ -6300,9 +6300,9 @@ export interface ExprDTO {
   /**
    * 值，当 type=CONST/COLUMN 时才有
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  value?: Record<string, unknown>;
+  value?: IObject;
 }
 export interface ExtFieldConfig {
   /**
@@ -6780,9 +6780,9 @@ export interface FilePreviewDTO {
   /**
    *
    *
-   * @type unknown
+   * @type WhereRelation
    */
-  condition?: unknown;
+  condition?: WhereRelation;
   /**
    * 数据集key
    *
@@ -6810,9 +6810,9 @@ export interface FilePreviewDTO {
   /**
    * 自定义排序
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  orderValues?: Record<string, unknown>;
+  orderValues?: IObject;
   /**
    *
    *
@@ -6940,9 +6940,9 @@ export interface FileTaskInfo {
   /**
    *
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  params?: Record<string, unknown>;
+  params?: IObject;
   /**
    *
    *
@@ -12428,9 +12428,9 @@ export interface PluginTenant {
   /**
    *
    *
-   * @type unknown
+   * @type Category
    */
-  category?: unknown;
+  category?: Category;
   /**
    *
    *
@@ -13810,9 +13810,9 @@ export interface PnDataset {
   /**
    * 自定义排序
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  orderValues?: Record<string, unknown>;
+  orderValues?: IObject;
   /**
    *
    *
@@ -15772,9 +15772,9 @@ export interface PublishedAppDtoResponse {
   /**
    *
    *
-   * @type unknown
+   * @type App
    */
-  app?: unknown;
+  app?: App;
   /**
    *
    *
@@ -16204,9 +16204,9 @@ export interface ResponseEntity {
   /**
    * 返回正确结果时携带的数据
    *
-   * @type Record<string, unknown>
+   * @type IObject
    */
-  data?: Record<string, unknown>;
+  data?: IObject;
   /**
    * 执行结果信息
    *
@@ -20450,9 +20450,9 @@ export interface UserLoginResp {
   /**
    * mqtt配置
    *
-   * @type unknown
+   * @type MqttPropertiesDTO
    */
-  mqttProperties?: unknown;
+  mqttProperties?: MqttPropertiesDTO;
   /**
    * 用户所属组织id集合
    *

package/es/service/http.util.d.ts

@@ -104,6 +104,19 @@ export declare class HttpUtil {
      * @returns {Promise<T>} 请求结果
      */
     static head<T = unknown>(url: string, path?: IObject, data?: IObject, query?: IParams, config?: AxiosRequestConfig): Promise<T>;
+    /**
+     * 文件上传方法
+     *
+     * @static
+     * @template T
+     * @param {string} url 请求地址
+     * @param {IObject} [path={}] 路径参数
+     * @param {UploadFileData} [data={}] 额外的请求数据
+     * @param {IParams} [query={}] 查询参数
+     * @param {AxiosRequestConfig} [config={}] 请求配置
+     * @returns {Promise<T>} 请求结果
+     */
+    static upload<T = unknown>(url: string, path?: IObject, data?: Partial<UploadFileData>, query?: IParams, config?: AxiosRequestConfig): Promise<T>;
     /**
      * 转换 URL 中的路径参数
      *

package/es/service/http.util.mjs

@@ -1,6 +1,5 @@
 import axios from "axios";
 import { ContentTypeEnum } from "./http.enum.mjs";
-import { deepMerge } from "../utils/index.mjs";
 import { BackendError } from "./http.error.mjs";
 const instance = axios.create();
 export class HttpUtil {
@@ -124,6 +123,50 @@ export class HttpUtil {
   static head(url, path = {}, data = {}, query = {}, config = {}) {
     return this.request(url, path, data, query, { ...config, method: "HEAD" });
   }
+  /**
+   * 文件上传方法
+   *
+   * @static
+   * @template T
+   * @param {string} url 请求地址
+   * @param {IObject} [path={}] 路径参数
+   * @param {UploadFileData} [data={}] 额外的请求数据
+   * @param {IParams} [query={}] 查询参数
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {Promise<T>} 请求结果
+   */
+  static upload(url, path = {}, data = {}, query = {}, config = {}) {
+    const formData = new FormData();
+    const { name, filename, file } = data;
+    const fileArray = Array.isArray(file) ? file : [file];
+    fileArray.forEach((file2) => {
+      if (filename) {
+        formData.append(name || "file", file2, filename);
+      } else {
+        formData.append(name || "file", file2);
+      }
+    });
+    if (data.data) {
+      for (const [key, value] of Object.entries(data.data)) {
+        if (value !== null && value !== void 0) {
+          if (Array.isArray(value)) {
+            value.forEach((item) => {
+              formData.append(`${key}[]`, item);
+            });
+          }
+          formData.append(key, value);
+        }
+      }
+    }
+    return this.request(url, path, formData, query, {
+      ...config,
+      method: "POST",
+      headers: {
+        "Content-Type": ContentTypeEnum.FORM_DATA,
+        ...config.headers
+      }
+    });
+  }
   /**
    * 转换 URL 中的路径参数
    *
@@ -155,20 +198,17 @@ export class HttpUtil {
    * @returns {Promise<T>} 请求结果
    */
   static async request(url, path, data, query, config = {}) {
-    const res = await instance.request(
-      deepMerge(
-        {
-          url: this.transformUrl(url, path || {}),
-          data: JSON.stringify(data ? data : {}),
-          params: query,
-          timeout: 2 * 60 * 1e3,
-          headers: {
-            "Content-Type": ContentTypeEnum.JSON
-          }
-        },
-        config
-      )
-    );
+    const res = await instance.request({
+      url: this.transformUrl(url, path || {}),
+      data: data instanceof FormData ? data : JSON.stringify(data ? data : {}),
+      params: query,
+      timeout: 2 * 60 * 1e3,
+      headers: {
+        "Content-Type": ContentTypeEnum.JSON,
+        ...config.headers
+      },
+      ...config
+    });
     if (res.status >= 200 && res.status < 300) {
       const data2 = res.data;
       if (data2.ok === true) {

package/es/types/index.d.ts

@@ -120,4 +120,52 @@ declare global {
      */
     subMessage?: string;
   }
+
+  /**
+   * 上传文件 Body 参数结构
+   *
+   * @interface UploadFileData
+   */
+  interface UploadFileData {
+    /**
+     * 附加数据
+     *
+     * @type {IObject}
+     */
+    data?: IObject;
+    /**
+     * 文件字段名
+     *
+     * @type {string}
+     */
+    name?: string;
+    /**
+     * 文件对象
+     *
+     * @type {(File | Blob | File[] | Blob[])}
+     */
+    file: File | Blob | File[] | Blob[];
+    /**
+     * 文件名称
+     *
+     * @type {string}
+     */
+    filename?: string;
+  }
+
+  // 扩展的对象类型
+  interface ITripleObject<T = any, U = any, V = any> {
+    left?: T;
+    center?: U;
+    right?: V;
+  }
+
+  interface LocalDateTime {
+    code: number;
+    data?: string;
+    message: string;
+    ok?: boolean;
+    subCode?: string;
+    subMessage?: string;
+  }
 }