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

package/es/service/http.util.mjs

@@ -1,7 +1,7 @@
 import axios from "axios";
-import qs from "qs";
 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 {
   /**
@@ -19,13 +19,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 请求方法
@@ -33,13 +34,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 请求方法
@@ -47,13 +49,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 请求方法
@@ -61,13 +64,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 请求方法
@@ -75,13 +82,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 请求方法
@@ -89,13 +100,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 请求方法
@@ -103,13 +115,32 @@ 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" });
+  }
+  /**
+   * 转换 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;
   }
   /**
    * 通用请求方法
@@ -117,26 +148,17 @@ 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 = {}) {
-    if (query) {
-      const queryStr = qs.stringify(query, { arrayFormat: "brackets" });
-      if (queryStr) {
-        if (url.includes("?")) {
-          url += `&${queryStr}`;
-        } else {
-          url += `?${queryStr}`;
-        }
-      }
-    }
+  static async request(url, path, data, query, config = {}) {
     const res = await instance.request(
       deepMerge(
         {
-          url,
+          url: this.transformUrl(url, path || {}),
           data: JSON.stringify(data ? data : {}),
           params: query,
           timeout: 2 * 60 * 1e3,
@@ -148,7 +170,11 @@ export class HttpUtil {
       )
     );
     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";