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

package/lib/service/api-service.cjs

@@ -24,21 +24,37 @@ class ApiService {
           const cfg = config.apis.find(item => item.method === property);
           if (cfg) {
             const modeFn = `_${cfg.mode}`;
-            if (cfg.hasData && cfg.hasQuery) {
-              api[property] = (data, query, config2) => {
-                return api[modeFn](cfg.path, query, data, config2);
+            if (cfg.hasPathParams && cfg.hasData && cfg.hasQuery) {
+              api[property] = (path2, query, data, config2) => {
+                return api[modeFn](cfg.path, path2, query, data, config2);
+              };
+            } else if (cfg.hasPathParams && cfg.hasData) {
+              api[property] = function (path2, data, config2) {
+                return api[modeFn](cfg.path, path2, void 0, data, config2);
+              };
+            } else if (cfg.hasPathParams && cfg.hasQuery) {
+              api[property] = function (path2, query, config2) {
+                return api[modeFn](cfg.path, path2, query, void 0, config2);
+              };
+            } else if (cfg.hasPathParams) {
+              api[property] = function (path2, config2) {
+                return api[modeFn](cfg.path, path2, void 0, void 0, config2);
+              };
+            } else if (cfg.hasData && cfg.hasQuery) {
+              api[property] = function (query, data, config2) {
+                return api[modeFn](cfg.path, void 0, query, data, config2);
               };
             } else if (cfg.hasData) {
               api[property] = function (data, config2) {
-                return api[modeFn](cfg.path, data, void 0, config2);
+                return api[modeFn](cfg.path, void 0, void 0, data, config2);
               };
             } else if (cfg.hasQuery) {
               api[property] = function (query, config2) {
-                return api[modeFn](cfg.path, void 0, query, config2);
+                return api[modeFn](cfg.path, void 0, query, void 0, config2);
               };
             } else {
               api[property] = function (config2) {
-                return api[modeFn](cfg.path, void 0, void 0, config2);
+                return api[modeFn](cfg.path, void 0, void 0, void 0, config2);
               };
             }
           }
@@ -52,91 +68,98 @@ class ApiService {
    *
    * @protected
    * @param {string} method 请求方法路径
-   * @param {(IObject | null)} data 请求数据
-   * @param {(IParams | null)} query 查询参数
+   * @param {(IParams)} pathParams 路径参数
+   * @param {(IObject)} data 请求数据
+   * @param {(IParams)} query 查询参数
    * @param {Partial<AxiosRequestConfig>} [config] 请求配置
-   * @returns {Promise<IHttpResponse>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  _put(method, data, query, config) {
-    return _http.HttpUtil.put(query?.id ? _pathBrowserify.default.join(this.url, method, query.id) : _pathBrowserify.default.join(this.url, method), data || {}, query || {}, config);
+  _put(method, pathParams, query, data, config) {
+    return _http.HttpUtil.put(_pathBrowserify.default.join(this.url, method), pathParams, data, query, config);
   }
   /**
    * GET 请求方法
    *
    * @protected
    * @param {string} method 请求方法路径
-   * @param {(IObject | null)} data 请求数据
-   * @param {(IParams | null)} query 查询参数
+   * @param {(IParams)} pathParams 路径参数
+   * @param {(IObject)} data 请求数据
+   * @param {(IParams)} query 查询参数
    * @param {Partial<AxiosRequestConfig>} [config] 请求配置
-   * @returns {Promise<IHttpResponse>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  _get(method, data, query, config) {
-    return _http.HttpUtil.get(_pathBrowserify.default.join(this.url, method), data || {}, query || {}, config);
+  _get(method, pathParams, query, data, config) {
+    return _http.HttpUtil.get(_pathBrowserify.default.join(this.url, method), pathParams, data, query, config);
   }
   /**
    * DELETE 请求方法
    *
    * @protected
    * @param {string} method 请求方法路径
-   * @param {(IObject | null)} data 请求数据
-   * @param {(IParams | null)} query 查询参数
+   * @param {(IParams)} pathParams 路径参数
+   * @param {(IObject)} data 请求数据
+   * @param {(IParams)} query 查询参数
    * @param {Partial<AxiosRequestConfig>} [config] 请求配置
-   * @returns {Promise<IHttpResponse>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  _delete(method, data, query, config) {
-    return _http.HttpUtil.delete(_pathBrowserify.default.join(this.url, method), data || {}, query || {}, config);
+  _delete(method, pathParams, query, data, config) {
+    return _http.HttpUtil.delete(_pathBrowserify.default.join(this.url, method), pathParams, data, query, config);
   }
   /**
    * POST 请求方法
    *
    * @protected
    * @param {string} method 请求方法路径
-   * @param {(IObject | null)} data 请求数据
-   * @param {(IParams | null)} query 查询参数
+   * @param {(IParams)} pathParams 路径参数
+   * @param {(IObject)} data 请求数据
+   * @param {(IParams)} query 查询参数
    * @param {Partial<AxiosRequestConfig>} [config] 请求配置
-   * @returns {Promise<IHttpResponse>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  _post(method, data, query, config) {
-    return _http.HttpUtil.post(_pathBrowserify.default.join(this.url, method), data || {}, query || {}, config);
+  _post(method, pathParams, query, data, config) {
+    return _http.HttpUtil.post(_pathBrowserify.default.join(this.url, method), pathParams, data, query, config);
   }
   /**
    * OPTIONS 请求方法
    *
    * @protected
    * @param {string} method 请求方法路径
-   * @param {(IObject | null)} data 请求数据
-   * @param {(IParams | null)} query 查询参数
+   * @param {(IParams)} pathParams 路径参数
+   * @param {(IObject)} data 请求数据
+   * @param {(IParams)} query 查询参数
    * @param {Partial<AxiosRequestConfig>} [config] 请求配置
-   * @returns {Promise<IHttpResponse>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  _options(method, data, query, config) {
-    return _http.HttpUtil.options(_pathBrowserify.default.join(this.url, method), data || {}, query || {}, config);
+  _options(method, pathParams, query, data, config) {
+    return _http.HttpUtil.options(_pathBrowserify.default.join(this.url, method), pathParams, data, query, config);
   }
   /**
    * PATCH 请求方法
    *
    * @protected
    * @param {string} method 请求方法路径
-   * @param {(IObject | null)} data 请求数据
-   * @param {(IParams | null)} query 查询参数
+   * @param {(IParams)} pathParams 路径参数
+   * @param {(IObject)} data 请求数据
+   * @param {(IParams)} query 查询参数
    * @param {Partial<AxiosRequestConfig>} [config] 请求配置
-   * @returns {Promise<IHttpResponse>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  _patch(method, data, query, config) {
-    return _http.HttpUtil.patch(_pathBrowserify.default.join(this.url, method), data || {}, query || {}, config);
+  _patch(method, pathParams, query, data, config) {
+    return _http.HttpUtil.patch(_pathBrowserify.default.join(this.url, method), pathParams, data, query, config);
   }
   /**
    * HEAD 请求方法
    *
    * @protected
    * @param {string} method 请求方法路径
-   * @param {(IObject | null)} data 请求数据
-   * @param {(IParams | null)} query 查询参数
+   * @param {(IParams)} pathParams 路径参数
+   * @param {(IObject)} data 请求数据
+   * @param {(IParams)} query 查询参数
    * @param {Partial<AxiosRequestConfig>} [config] 请求配置
-   * @returns {Promise<IHttpResponse>} 请求结果
+   * @returns {Promise<T>} 请求结果
    */
-  _head(method, data, query, config) {
-    return _http.HttpUtil.head(_pathBrowserify.default.join(this.url, method), data || {}, query || {}, config);
+  _head(method, pathParams, query, data, config) {
+    return _http.HttpUtil.head(_pathBrowserify.default.join(this.url, method), pathParams, data, query, config);
   }
 }
 exports.ApiService = ApiService;

package/lib/service/http.error.cjs

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BackendError = void 0;
+class BackendError extends Error {
+  /**
+   * 错误代码
+   *
+   * @type {number}
+   */
+  code;
+  /**
+   * 响应数据
+   *
+   * @type {T}
+   */
+  data;
+  /**
+   * 子状态码
+   *
+   * @type {number}
+   */
+  subCode;
+  /**
+   * 子状态消息
+   *
+   * @type {string}
+   */
+  subMessage;
+  /**
+   * 创建 BackendError 实例
+   *
+   * @param {IHttpResponse<T>} response HTTP 响应对象
+   */
+  constructor(response) {
+    super(response.message);
+    this.name = "BackendError";
+    this.code = response.code;
+    this.data = response.data;
+    this.subCode = response.subCode;
+    this.subMessage = response.subMessage;
+  }
+}
+exports.BackendError = BackendError;

package/lib/service/http.util.cjs

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.HttpUtil = void 0;
 var _axios = _interopRequireDefault(require("axios"));
 var _http = require("./http.enum.cjs");
-var _utils = require("../utils/index.cjs");
+var _http2 = require("./http.error.cjs");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const instance = _axios.default.create();
 class HttpUtil {
@@ -25,13 +25,14 @@ 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, {
+  static get(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, {
       ...config,
       method: "GET"
     });
@@ -42,13 +43,14 @@ 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, {
+  static post(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, {
       ...config,
       method: "POST"
     });
@@ -59,13 +61,14 @@ 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, {
+  static put(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, {
       ...config,
       method: "PUT"
     });
@@ -76,13 +79,14 @@ 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, {
+  static delete(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, {
       ...config,
       method: "DELETE"
     });
@@ -93,13 +97,14 @@ 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, {
+  static options(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, {
       ...config,
       method: "OPTIONS"
     });
@@ -110,13 +115,14 @@ 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, {
+  static patch(url, path = {}, data = {}, query = {}, config = {}) {
+    return this.request(url, path, data, query, {
       ...config,
       method: "PATCH"
     });
@@ -127,40 +133,111 @@ 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, {
+  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": _http.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;
+  }
   /**
    * 通用请求方法
    *
    * @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((0, _utils.deepMerge)({
-      url,
-      data: JSON.stringify(data ? data : {}),
+  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": _http.ContentTypeEnum.JSON
-      }
-    }, config));
+        "Content-Type": _http.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 _http2.BackendError(data2);
     }
     throw res;
   }

package/lib/service/index.cjs

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "BackendError", {
+  enumerable: true,
+  get: function () {
+    return _http2.BackendError;
+  }
+});
 Object.defineProperty(exports, "BizServiceEnum", {
   enumerable: true,
   get: function () {
@@ -18,7 +24,7 @@ Object.defineProperty(exports, "ContentTypeEnum", {
 Object.defineProperty(exports, "HttpUtil", {
   enumerable: true,
   get: function () {
-    return _http2.HttpUtil;
+    return _http3.HttpUtil;
   }
 });
 Object.defineProperty(exports, "RequestEnum", {
@@ -38,7 +44,8 @@ var _apaas = require("../apaas/index.cjs");
 var _platform = require("../platform/index.cjs");
 var _apiManage = require("./api-manage.cjs");
 var _http = require("./http.enum.cjs");
-var _http2 = require("./http.util.cjs");
+var _http2 = require("./http.error.cjs");
+var _http3 = require("./http.util.cjs");
 const api = exports.api = {
   apaas: new _apiManage.ApiManage("/gct-apaas/api", _apaas.apiConfig),
   platform: new _apiManage.ApiManage("/gct-platform/api", _platform.apiConfig)

package/lib/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gct-paas/api",
-  "version": "0.1.0-dev.5",
+  "version": "0.1.0-dev.7",
   "description": "paas 平台底包",
   "type": "module",
   "keywords": [
@@ -24,8 +24,7 @@
     ".": {
       "types": "./es/index.d.ts",
       "import": "./es/index.mjs",
-      "require": "./lib/index.cjs",
-      "system": "./dist/gct-api.system.min.js"
+      "require": "./lib/index.cjs"
     },
     "./apaas": {
       "types": "./es/apaas/index.d.ts"
@@ -35,6 +34,9 @@
     },
     "./platform": {
       "types": "./es/platform/index.d.ts"
+    },
+    "./global-type": {
+      "types": "./es/types/index.d.ts"
     }
   },
   "files": [
@@ -45,6 +47,8 @@
   "scripts": {
     "build": "rollup -c rollup.config.js && unbuild",
     "lint": "eslint './src' --fix",
+    "test": "vitest",
+    "test:run": "vitest run",
     "prettier": "prettier './src' --write",
     "prepare": "husky",
     "prepublish": "npm run build",
@@ -67,8 +71,8 @@
   "devDependencies": {
     "@babel/preset-env": "^7.28.6",
     "@commitlint/cli": "^20.3.1",
-    "@gct-paas/build": "0.1.5-dev.2",
-    "@gct-paas/cli": "^0.1.5-dev.2",
+    "@gct-paas/build": "^0.1.5-dev.6",
+    "@gct-paas/cli": "^0.1.5-dev.7",
     "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",