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

package/es/service/http.util.mjs

@@ -1,6 +1,6 @@
 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 {
   /**
@@ -18,13 +18,14 @@ export class HttpUtil {
    * @static
    * @template T
    * @param {string} url 请求地址
+   * @param {IObject} [path={}] 路径参数
    * @param {IObject} [data={}] 请求数据
    * @param {IParams} [query={}] 查询参数
    * @param {AxiosRequestConfig} [config={}] 请求配置
-   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  static get(url, data = {}, query = {}, config = {}) {
-    return this.request(url, data, query, { ...config, method: "GET" });
+  static get(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, { ...config, method: "GET" });
   }
   /**
    * POST 请求方法
@@ -32,13 +33,14 @@ export class HttpUtil {
    * @static
    * @template T
    * @param {string} url 请求地址
+   * @param {IObject} [path={}] 路径参数
    * @param {IObject} [data={}] 请求数据
    * @param {IParams} [query={}] 查询参数
    * @param {AxiosRequestConfig} [config={}] 请求配置
-   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  static post(url, data = {}, query = {}, config = {}) {
-    return this.request(url, data, query, { ...config, method: "POST" });
+  static post(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, { ...config, method: "POST" });
   }
   /**
    * PUT 请求方法
@@ -46,13 +48,14 @@ export class HttpUtil {
    * @static
    * @template T
    * @param {string} url 请求地址
+   * @param {IObject} [path={}] 路径参数
    * @param {IObject} [data={}] 请求数据
    * @param {IParams} [query={}] 查询参数
    * @param {AxiosRequestConfig} [config={}] 请求配置
-   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  static put(url, data = {}, query = {}, config = {}) {
-    return this.request(url, data, query, { ...config, method: "PUT" });
+  static put(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, { ...config, method: "PUT" });
   }
   /**
    * DELETE 请求方法
@@ -60,13 +63,17 @@ export class HttpUtil {
    * @static
    * @template T
    * @param {string} url 请求地址
+   * @param {IObject} [path={}] 路径参数
    * @param {IObject} [data={}] 请求数据
    * @param {IParams} [query={}] 查询参数
    * @param {AxiosRequestConfig} [config={}] 请求配置
-   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  static delete(url, data = {}, query = {}, config = {}) {
-    return this.request(url, data, query, { ...config, method: "DELETE" });
+  static delete(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, {
+      ...config,
+      method: "DELETE"
+    });
   }
   /**
    * OPTIONS 请求方法
@@ -74,13 +81,17 @@ export class HttpUtil {
    * @static
    * @template T
    * @param {string} url 请求地址
+   * @param {IObject} [path={}] 路径参数
    * @param {IObject} [data={}] 请求数据
    * @param {IParams} [query={}] 查询参数
    * @param {AxiosRequestConfig} [config={}] 请求配置
-   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  static options(url, data = {}, query = {}, config = {}) {
-    return this.request(url, data, query, { ...config, method: "OPTIONS" });
+  static options(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, {
+      ...config,
+      method: "OPTIONS"
+    });
   }
   /**
    * PATCH 请求方法
@@ -88,13 +99,14 @@ export class HttpUtil {
    * @static
    * @template T
    * @param {string} url 请求地址
+   * @param {IObject} [path={}] 路径参数
    * @param {IObject} [data={}] 请求数据
    * @param {IParams} [query={}] 查询参数
    * @param {AxiosRequestConfig} [config={}] 请求配置
-   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  static patch(url, data = {}, query = {}, config = {}) {
-    return this.request(url, data, query, { ...config, method: "PATCH" });
+  static patch(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, { ...config, method: "PATCH" });
   }
   /**
    * HEAD 请求方法
@@ -102,13 +114,76 @@ export class HttpUtil {
    * @static
    * @template T
    * @param {string} url 请求地址
+   * @param {IObject} [path={}] 路径参数
    * @param {IObject} [data={}] 请求数据
    * @param {IParams} [query={}] 查询参数
    * @param {AxiosRequestConfig} [config={}] 请求配置
-   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  static head(url, data = {}, query = {}, config = {}) {
-    return this.request(url, data, query, { ...config, method: "HEAD" });
+  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 中的路径参数
+   *
+   * @protected
+   * @param {string} url
+   * @param {IObject} path
+   * @return {*}  {string}
+   */
+  static transformUrl(url, path) {
+    let transformedUrl = url;
+    for (const [key, value] of Object.entries(path)) {
+      transformedUrl = transformedUrl.replace(
+        `{${key}}`,
+        encodeURIComponent(String(value))
+      );
+    }
+    return transformedUrl;
   }
   /**
    * 通用请求方法
@@ -116,28 +191,30 @@ export class HttpUtil {
    * @static
    * @template T
    * @param {string} url 请求地址
+   * @param {(IObject | null)} path 路径参数
    * @param {(IObject | null)} data 请求数据
    * @param {(IParams | null)} query 查询参数
    * @param {AxiosRequestConfig} [config={}] 请求配置
-   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  static async request(url, data, query, config = {}) {
-    const res = await instance.request(
-      deepMerge(
-        {
-          url,
-          data: JSON.stringify(data ? data : {}),
-          params: query,
-          timeout: 2 * 60 * 1e3,
-          headers: {
-            "Content-Type": ContentTypeEnum.JSON
-          }
-        },
-        config
-      )
-    );
+  static async request(url, path, data, query, 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) {
-      return res.data;
+      const data2 = res.data;
+      if (data2.ok === true) {
+        return data2.data;
+      }
+      throw new BackendError(data2);
     }
     throw res;
   }

package/es/service/index.d.ts

@@ -4,5 +4,6 @@ import type { ApiMap } from './api-service.interface';
  */
 export declare const api: ApiMap;
 export { ResultEnum, RequestEnum, ContentTypeEnum, BizServiceEnum, } from './http.enum';
+export { BackendError } from './http.error';
 export type { IHttpResponse, ApiConfigItem, ApiItem, ApiMap, } from './api-service.interface';
 export { HttpUtil } from './http.util';

package/es/service/index.mjs

@@ -11,4 +11,5 @@ export {
   ContentTypeEnum,
   BizServiceEnum
 } from "./http.enum.mjs";
+export { BackendError } from "./http.error.mjs";
 export { HttpUtil } from "./http.util.mjs";

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;
+  }
 }