@base-web-kits/base-tools-web 1.1.11 → 1.1.18-alpha.0

package/dist/async/index.d.ts

@@ -0,0 +1,26 @@
+type WebApi<Option, Res, Config = unknown> = (option: Option, config?: Config) => Promise<Res>;
+/**
+ * web api 的调用配置
+ */
+export type WebApiConfig<Res, Err> = {
+    /** 是否显示加载提示, 默认 false. (支持字符串,自定义文本) */
+    showLoading?: boolean | string;
+    /** 操作成功的toast提示, 默认不显示 */
+    toastSuccess?: ((res: Res) => false | string) | false | string;
+    /** 是否显示操作失败的详细错误信息, 默认 true. (支持字符串,自定义文本; 支持根据errMsg判断是否显示, 例如: (e) => !e.errMsg.includes('cancel') */
+    toastError?: ((e: Err) => boolean | string) | boolean | string;
+    /** 是否显示日志, 默认 true */
+    showLog?: boolean;
+};
+/**
+ * 拓展 web api, 使其支持loading,toast,log,任务对象等能力
+ * @param webApi web api
+ * @param apiName web api 名称 (可选, 用于日志输出, 默认'promisifyWebApi')
+ * @return 注入拓展能力的promise (默认提示异常和输出日志,不显示进度条和操作成功)
+ * @example
+ * const promise = promisifyWebApi(downloadFile, 'downloadFile');
+ * await promise({ url: 'xx' }, {showLoading: '下载中', toastSuccess: '下载成功'});
+ */
+export declare function promisifyWebApi<Option, Res, Err, Config = unknown>(webApi: WebApi<Option, Res, Config>, apiName?: string): (option: Option, config?: WebApiConfig<Res, Err> & Config) => Promise<Res>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/async/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/web/async/index.ts"],"names":[],"mappings":"AAEA,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,GAAG,EAAE,GAAG,IAAI;IACnC,wCAAwC;IACxC,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B,0BAA0B;IAC1B,YAAY,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,KAAK,GAAG,MAAM,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC;IAE/D,wGAAwG;IACxG,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,GAAG,MAAM,CAAC,GAAG,OAAO,GAAG,MAAM,CAAC;IAE/D,sBAAsB;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,EAChE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,EACnC,OAAO,CAAC,EAAE,MAAM,IAER,QAAQ,MAAM,EAAE,SAAS,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,MAAM,kBA+CjE"}

package/dist/base-tools-web.umd.global.js

@@ -755,6 +755,8 @@ var baseToolsWeb = (() => {
     copyText: () => copyText,
     copyUrl: () => copyUrl,
     download: () => download,
+    filterRequestData: () => filterRequestData,
+    filterRequestHeader: () => filterRequestHeader,
     getBaseToolsConfig: () => getBaseToolsConfig,
     getBrowserName: () => getBrowserName,
     getBrowserVersion: () => getBrowserVersion,
@@ -794,6 +796,7 @@ var baseToolsWeb = (() => {
     setCookie: () => setCookie,
     setLocalStorage: () => setLocalStorage,
     unlockBodyScroll: () => unlockBodyScroll,
+    uploadFile: () => uploadFile,
     windowScrollTo: () => windowScrollTo
   });
 
@@ -1181,7 +1184,7 @@ var baseToolsWeb = (() => {
     window.scrollTo(0, y);
   }
 
-  // src/web/network/load.ts
+  // src/web/network/download.ts
   function download(url, fileName = "") {
     return __async(this, null, function* () {
       if (!url) return;
@@ -1578,20 +1581,6 @@ var baseToolsWeb = (() => {
     return key === "__proto__";
   }
 
-  // node_modules/.pnpm/es-toolkit@1.42.0/node_modules/es-toolkit/dist/object/pickBy.mjs
-  function pickBy(obj, shouldPick) {
-    const result = {};
-    const keys = Object.keys(obj);
-    for (let i = 0; i < keys.length; i++) {
-      const key = keys[i];
-      const value = obj[key];
-      if (shouldPick(value, key)) {
-        result[key] = value;
-      }
-    }
-    return result;
-  }
-
   // node_modules/.pnpm/es-toolkit@1.42.0/node_modules/es-toolkit/dist/compat/_internal/isDeepKey.mjs
   function isDeepKey(key) {
     switch (typeof key) {
@@ -1835,9 +1824,8 @@ var baseToolsWeb = (() => {
         const isGet = method === "GET";
         const isObjectData = isPlainObject(data);
         const isArrayData = !isObjectData && Array.isArray(data);
-        const fillData = isObjectData ? pickBy(data, (val) => val !== void 0) : data;
-        const emptyValue = [void 0, null, ""];
-        const fillHeader = header ? pickBy(header, (val) => !emptyValue.includes(val)) : {};
+        const fillData = isObjectData ? filterRequestData(data) : data;
+        const fillHeader = filterRequestHeader(header);
         const contentTypeKey = Object.keys(fillHeader).find(
           (k) => k.toLowerCase() === "content-type"
         );
@@ -1878,7 +1866,8 @@ var baseToolsWeb = (() => {
           }
         }
         const appConfig2 = getBaseToolsConfig();
-        if (showLoading) (_a = appConfig2.showLoading) == null ? void 0 : _a.call(appConfig2);
+        if (showLoading)
+          (_a = appConfig2.showLoading) == null ? void 0 : _a.call(appConfig2, typeof showLoading === "string" ? { title: showLoading } : {});
         let isTimeout = false;
         const timeoutId = setTimeout(() => {
           isTimeout = true;
@@ -1943,6 +1932,22 @@ var baseToolsWeb = (() => {
     promise.task = task;
     return promise;
   }
+  function filterRequestData(data) {
+    const res = {};
+    Object.entries(data).forEach(([k, v]) => {
+      if (v !== void 0) res[k] = v;
+    });
+    return res;
+  }
+  function filterRequestHeader(header) {
+    const newHeader = {};
+    if (header) {
+      Object.entries(header).forEach(([k, v]) => {
+        if (v !== void 0 && v !== null && v !== "") newHeader[k] = String(v);
+      });
+    }
+    return newHeader;
+  }
   function logRequestInfo(options) {
     const { log } = getBaseToolsConfig();
     const { isLog = true } = options.config;
@@ -2051,6 +2056,115 @@ var baseToolsWeb = (() => {
     return formData;
   }
 
+  // src/web/async/index.ts
+  function promisifyWebApi(webApi, apiName) {
+    return (option, config) => {
+      const finalConfig = config || {};
+      const {
+        showLoading = false,
+        toastSuccess = false,
+        toastError = true,
+        showLog = true
+      } = finalConfig;
+      const {
+        log,
+        toast,
+        showLoading: showLoadingFn,
+        hideLoading: hideLoadingFn
+      } = getBaseToolsConfig();
+      const fname = apiName || "promisifyWebApi";
+      if (showLoading) {
+        const title = typeof showLoading === "string" ? showLoading : "";
+        showLoadingFn == null ? void 0 : showLoadingFn({ title });
+      }
+      return new Promise((resolve, reject) => {
+        webApi(option, finalConfig).then((res) => {
+          if (showLoading) hideLoadingFn == null ? void 0 : hideLoadingFn();
+          if (showLog) log == null ? void 0 : log("info", { name: fname, status: "success", option, res });
+          resolve(res);
+          const msg = typeof toastSuccess === "function" ? toastSuccess(res) : toastSuccess;
+          if (msg) toast == null ? void 0 : toast({ msg, status: "success" });
+        }).catch((e) => {
+          if (showLoading) hideLoadingFn == null ? void 0 : hideLoadingFn();
+          if (showLog) log == null ? void 0 : log("error", { name: fname, status: "fail", option, e });
+          const msg = typeof toastError === "function" ? toastError(e) : toastError;
+          if (msg) {
+            toast == null ? void 0 : toast({
+              msg: typeof msg === "string" ? msg : `${fname} fail: ${JSON.stringify(e)}`,
+              status: "fail"
+            });
+          }
+          reject(e);
+        });
+      });
+    };
+  }
+
+  // src/web/network/uploadFile.ts
+  function upload(option, config) {
+    return new Promise((resolve, reject) => {
+      var _a;
+      const xhr = new XMLHttpRequest();
+      const { url, file, name = "file", header, formData, timeout = 0 } = option;
+      const fail = (error) => reject(error);
+      const success = (responseText) => {
+        try {
+          resolve(JSON.parse(responseText));
+        } catch (e) {
+          resolve(responseText);
+        }
+      };
+      let onProgressUpdate;
+      const task = {
+        onProgressUpdate: (callback) => {
+          onProgressUpdate = callback;
+        },
+        abort: () => xhr.abort()
+      };
+      (_a = config == null ? void 0 : config.onTaskReady) == null ? void 0 : _a.call(config, task);
+      xhr.upload.onprogress = (e) => {
+        if (!e.lengthComputable) return;
+        const ev = {
+          progress: Math.round(e.loaded / e.total * 100),
+          loaded: e.loaded,
+          total: e.total
+        };
+        onProgressUpdate == null ? void 0 : onProgressUpdate(ev);
+      };
+      xhr.onload = () => {
+        if (xhr.status >= 200 && xhr.status < 300) {
+          success(xhr.responseText);
+        } else {
+          fail({ message: `\u4E0A\u4F20\u5931\u8D25`, status: xhr.status });
+        }
+      };
+      xhr.onerror = () => fail({ message: "\u7F51\u7EDC\u9519\u8BEF", status: 0 });
+      xhr.ontimeout = () => fail({ message: "\u4E0A\u4F20\u8D85\u65F6", status: -1 });
+      xhr.onabort = () => fail({ message: "\u7528\u6237\u53D6\u6D88", status: -2 });
+      xhr.open("POST", url);
+      if (header) {
+        Object.entries(header).forEach(([k, v]) => {
+          if (v !== void 0 && v !== null && v !== "") xhr.setRequestHeader(k, String(v));
+        });
+      }
+      xhr.timeout = timeout;
+      const data = new FormData();
+      data.append(name, file);
+      if (formData) {
+        Object.entries(formData).forEach(([k, v]) => {
+          if (v !== void 0) data.append(k, String(v));
+        });
+      }
+      xhr.send(data);
+    });
+  }
+  function uploadFile(option, config) {
+    return promisifyWebApi(upload, "uploadFile")(
+      option,
+      config
+    );
+  }
+
   // src/web/storage/index.ts
   var WK = {
     val: "__l_val",