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

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/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,36 @@ 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;
+  }
 }

package/lib/apaas/service/api-config.cjs

@@ -590,13 +590,15 @@ const apiConfig = exports.apiConfig = [{
     method: "postModelKeyBsKey",
     path: "{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "put",
     method: "putModelKeyBsKey",
     path: "{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "delete",
     method: "deleteModelKeyBsKey",
@@ -990,13 +992,15 @@ const apiConfig = exports.apiConfig = [{
     method: "postBizServiceModelKeyBsKey",
     path: "biz-service/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "put",
     method: "putBizServiceModelKeyBsKey",
     path: "biz-service/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "delete",
     method: "deleteBizServiceModelKeyBsKey",
@@ -2344,6 +2348,24 @@ const apiConfig = exports.apiConfig = [{
     hasPathParams: true,
     hasData: true
   }]
+}, {
+  name: "importReport",
+  entityName: "import-report",
+  apis: [{
+    mode: "get",
+    method: "getInfo",
+    path: "info",
+    hasQuery: true
+  }, {
+    mode: "get",
+    method: "getList",
+    path: "list"
+  }, {
+    mode: "get",
+    method: "getPageList",
+    path: "page/list",
+    hasQuery: true
+  }]
 }, {
   name: "instanceRelation",
   entityName: "instance-relation",
@@ -2952,7 +2974,8 @@ const apiConfig = exports.apiConfig = [{
     method: "postBizServiceGeneralModelCategoryModelKeyBsKey",
     path: "biz-service/general/{modelCategory}/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "get",
     method: "getBizServiceModelCategoryModelKeyBsKey",
@@ -2964,19 +2987,22 @@ const apiConfig = exports.apiConfig = [{
     method: "postBizServiceModelCategoryModelKeyBsKey",
     path: "biz-service/{modelCategory}/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "put",
     method: "putBizServiceModelCategoryModelKeyBsKey",
     path: "biz-service/{modelCategory}/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "delete",
     method: "deleteBizServiceModelCategoryModelKeyBsKey",
     path: "biz-service/{modelCategory}/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "get",
     method: "getEnumInfoModelCategory",
@@ -2988,7 +3014,8 @@ const apiConfig = exports.apiConfig = [{
     method: "postExportModelCategoryModelKeyTmplKey",
     path: "export/{modelCategory}/{modelKey}/{tmplKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "get",
     method: "getFieldListModelCategory",
@@ -5652,7 +5679,8 @@ const apiConfig = exports.apiConfig = [{
     method: "postBizServiceModelKeyBsKey",
     path: "biz-service/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }]
 }, {
   name: "ss",
@@ -6064,13 +6092,15 @@ const apiConfig = exports.apiConfig = [{
     method: "postBizServiceModelKeyBsKey",
     path: "biz-service/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "put",
     method: "putBizServiceModelKeyBsKey",
     path: "biz-service/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "delete",
     method: "deleteBizServiceModelKeyBsKey",
@@ -6405,7 +6435,8 @@ const apiConfig = exports.apiConfig = [{
     method: "postModelComprehensiveBizServiceGeneralBsModelCategoryModelKeyBsKey",
     path: "model-comprehensive/biz-service/generalBs/{modelCategory}/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "post",
     method: "postModelComprehensiveBizServiceModelCategoryModelKeyUpload",
@@ -6423,19 +6454,22 @@ const apiConfig = exports.apiConfig = [{
     method: "postModelComprehensiveBizServiceModelCategoryModelKeyBsKey",
     path: "model-comprehensive/biz-service/{modelCategory}/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "put",
     method: "putModelComprehensiveBizServiceModelCategoryModelKeyBsKey",
     path: "model-comprehensive/biz-service/{modelCategory}/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "delete",
     method: "deleteModelComprehensiveBizServiceModelCategoryModelKeyBsKey",
     path: "model-comprehensive/biz-service/{modelCategory}/{modelKey}/{bsKey}",
     hasPathParams: true,
-    hasQuery: true
+    hasQuery: true,
+    hasData: true
   }, {
     mode: "get",
     method: "getProcessListAll",