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

package/dist/async/index.d.ts

@@ -1,8 +1,8 @@
-type WebApi<Option, Res, Config = unknown> = (option: Option, config?: Config) => Promise<Res>;
+type WebApi<Option = any, Res = any, Config = any> = (option: Option, config?: Config) => Promise<Res>;
 /**
  * web api 的调用配置
  */
-export type WebApiConfig<Res, Err> = {
+export type WebApiConfig<Res = any, Err = any> = {
     /** 是否显示加载提示, 默认 false. (支持字符串,自定义文本) */
     showLoading?: boolean | string;
     /** 操作成功的toast提示, 默认不显示 */
@@ -11,16 +11,20 @@ export type WebApiConfig<Res, Err> = {
     toastError?: ((e: Err) => boolean | string) | boolean | string;
     /** 是否显示日志, 默认 true */
     showLog?: boolean;
+    /** 处理成功res, 如解密操作 (返回值在成功日志中输出'resFilter'字段) */
+    resFilter?: (res: Res) => Res;
+    /** 成功和失败时,额外输出的日志数据 (可覆盖内部log参数,如'name') */
+    logExtra?: Record<string, unknown>;
 };
 /**
- * 拓展 web api, 使其支持loading,toast,log,任务对象等能力
+ * 拓展 web api, 使其支持loading,toast,log能力
  * @param webApi web api
- * @param apiName web api 名称 (可选, 用于日志输出, 默认'promisifyWebApi')
+ * @param apiName web api 名称 (可选, 用于日志输出, 默认'enhanceWebApi')
  * @return 注入拓展能力的promise (默认提示异常和输出日志,不显示进度条和操作成功)
  * @example
- * const promise = promisifyWebApi(downloadFile, 'downloadFile');
+ * const promise = enhanceWebApi(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 declare function enhanceWebApi<Option = any, Res = any, Err = any, Config = any>(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

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/web/async/index.ts"],"names":[],"mappings":"AAIA,KAAK,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,CACnD,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,KACZ,OAAO,CAAC,GAAG,CAAC,CAAC;AAElB;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,GAAG,GAAG,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI;IAC/C,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;IAElB,gDAAgD;IAChD,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC;IAE9B,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,MAAM,GAAG,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,EAC5E,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,kBAiEjE"}

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

@@ -1953,7 +1953,7 @@ var baseToolsWeb = (() => {
     const { isLog = true } = options.config;
     if (!log || !isLog) return;
     const { config, res, fromCache = false, startTime, status, e } = options;
-    const { url, data, header, method, extraLog } = config;
+    const { url, data, header, method, logExtra } = config;
     const endTime = Date.now();
     const fmt = "YYYY-MM-DD HH:mm:ss.SSS";
     const info = __spreadValues({
@@ -1967,7 +1967,7 @@ var baseToolsWeb = (() => {
       startTime: toDayjs(startTime).format(fmt),
       endTime: toDayjs(endTime).format(fmt),
       duration: endTime - startTime
-    }, extraLog);
+    }, logExtra);
     if (status === "success") {
       info.res = cloneDeep(res);
       log("info", info);
@@ -2057,14 +2057,16 @@ var baseToolsWeb = (() => {
   }
 
   // src/web/async/index.ts
-  function promisifyWebApi(webApi, apiName) {
+  function enhanceWebApi(webApi, apiName) {
     return (option, config) => {
       const finalConfig = config || {};
       const {
         showLoading = false,
         toastSuccess = false,
         toastError = true,
-        showLog = true
+        showLog = true,
+        resFilter,
+        logExtra
       } = finalConfig;
       const {
         log,
@@ -2072,7 +2074,7 @@ var baseToolsWeb = (() => {
         showLoading: showLoadingFn,
         hideLoading: hideLoadingFn
       } = getBaseToolsConfig();
-      const fname = apiName || "promisifyWebApi";
+      const fname = apiName || "enhanceWebApi";
       if (showLoading) {
         const title = typeof showLoading === "string" ? showLoading : "";
         showLoadingFn == null ? void 0 : showLoadingFn({ title });
@@ -2080,13 +2082,23 @@ var baseToolsWeb = (() => {
       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;
+          const finalRes = resFilter ? resFilter(res) : res;
+          if (showLog) {
+            const logData = __spreadValues({ name: fname, status: "success", option }, logExtra);
+            if (resFilter) {
+              logData.res = res;
+              logData.resFilter = cloneDeep(finalRes);
+            } else {
+              logData.res = cloneDeep(res);
+            }
+            log == null ? void 0 : log("info", logData);
+          }
+          resolve(finalRes);
+          const msg = typeof toastSuccess === "function" ? toastSuccess(finalRes) : 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 });
+          if (showLog) log == null ? void 0 : log("error", __spreadValues({ name: fname, status: "fail", option, e }, logExtra));
           const msg = typeof toastError === "function" ? toastError(e) : toastError;
           if (msg) {
             toast == null ? void 0 : toast({
@@ -2152,17 +2164,14 @@ var baseToolsWeb = (() => {
       data.append(name, file);
       if (formData) {
         Object.entries(formData).forEach(([k, v]) => {
-          if (v !== void 0) data.append(k, String(v));
+          if (v !== void 0 && v !== null) data.append(k, String(v));
         });
       }
       xhr.send(data);
     });
   }
   function uploadFile(option, config) {
-    return promisifyWebApi(upload, "uploadFile")(
-      option,
-      config
-    );
+    return enhanceWebApi(upload, "uploadFile")(option, config);
   }
 
   // src/web/storage/index.ts