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

package/dist/network/{load.d.ts → download.d.ts}

@@ -74,4 +74,4 @@ export declare function hasCss(href: string): boolean;
  * await preloadImage('/a.png');
  */
 export declare function preloadImage(src: string): Promise<HTMLImageElement>;
-//# sourceMappingURL=load.d.ts.map
+//# sourceMappingURL=download.d.ts.map

package/dist/network/download.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/web/network/download.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C;;;;;;;;GAQG;AACH,wBAAsB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,SAAK,iBAyC/D;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAAC,GAAG,EAAE,aAAa,CAAC,IAAI,CAAC;;;GAc5D;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,CAAC,EAAE,MAAM,UAkB1D;AAED;;;;;;;GAOG;AACH,wBAAsB,MAAM,CAC1B,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,OAAO,GAAG,aAAa,CAAC,iBAuBnE;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,WAOhC;AAED;;;;;;;GAOG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,aAAa,GAAG,OAAO,CAAC,iBAuBvD;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,WAOlC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,6BAOvC"}

package/dist/network/index.d.ts

@@ -1,3 +1,4 @@
-export * from './load';
+export * from './download';
 export * from './request';
+export * from './uploadFile';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/web/network/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/web/network/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC"}

package/dist/network/request.d.ts

@@ -39,8 +39,8 @@ export type RequestConfigBase<D extends RequestData = RequestData> = {
     successCode: (number | string)[];
     /** 登录过期状态码 */
     reloginCode: (number | string)[];
-    /** 是否显示进度条 (默认true) */
-    showLoading?: boolean;
+    /** 是否显示进度条: 支持字符串,自定义文本 (默认true) */
+    showLoading?: boolean | string;
     /** 是否提示接口异常 (默认true) */
     toastError?: boolean;
     /** 是否输出日志 (默认true) */
@@ -82,7 +82,7 @@ export type ChunkCallback = (response: {
  * // 在入口文件完成配置 (确保请求失败有toast提示,登录过期能够触发重新登录,log有日志输出)
  * setBaseToolsConfig({
  * toast: ({ msg, status }) => (status === 'fail' ? message.error(msg) : message.success(msg)),
- * showLoading: () => message.loading('加载中...'),
+ * showLoading: ({ title }) => message.loading(title || '加载中...'),
  * hideLoading: () => message.destroy(),
  * toLogin: () => reLogin(),
  * log(level, data) {
@@ -148,4 +148,12 @@ export type ChunkCallback = (response: {
 export declare function request<T, D extends RequestData = RequestData>(config: RequestConfigBase<D>): Promise<T> & {
     task?: RequestTask;
 };
+/**
+ * 参数过滤undefined, 避免接口处理异常 (不可过滤 null 、 "" 、 false 、 0 这些有效值)
+ */
+export declare function filterRequestData(data: Record<string, any>): Record<string, any>;
+/**
+ * 请求头过滤空值 (undefined, null, ""), 不过滤0和false
+ */
+export declare function filterRequestHeader(header: RequestConfigBase['header']): Record<string, string>;
 //# sourceMappingURL=request.d.ts.map

package/dist/network/request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/web/network/request.ts"],"names":[],"mappings":"AAWA,aAAa;AACb,MAAM,MAAM,aAAa,GACrB,KAAK,GACL,MAAM,GACN,KAAK,GACL,QAAQ,GACR,SAAS,GACT,MAAM,GACN,SAAS,GACT,OAAO,GACP,OAAO,CAAC;AAEZ;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,WAAW,GACX,eAAe,GACf,IAAI,GACJ,QAAQ,GACR,eAAe,GACf,cAAc,CAAC,UAAU,CAAC,GAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,OAAO,EAAE,GACT,IAAI,CAAC;AAET;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,WAAW,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC;AAEpG;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;IACnE,WAAW;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW;IACX,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IACtE,WAAW;IACX,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,0BAA0B;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,uDAAuD;IACvD,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IAEf,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC;IAEhB,kDAAkD;IAClD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,YAAY;IACZ,WAAW,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAEjC,cAAc;IACd,WAAW,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAEjC,uBAAuB;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,wBAAwB;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,sBAAsB;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,uBAAuB;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC;IAE/C,WAAW;IACX,mBAAmB,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,YAAY,CAAC;CAC5D,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW;IACX,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,kBAAkB;IAClB,eAAe,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,IAAI,CAAC;IAEnD,oBAAoB;IACpB,gBAAgB,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,KAAK,IAAI,CAAC;AAKtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;WAuM9D,WAAW;EAMxC"}
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/web/network/request.ts"],"names":[],"mappings":"AAUA,aAAa;AACb,MAAM,MAAM,aAAa,GACrB,KAAK,GACL,MAAM,GACN,KAAK,GACL,QAAQ,GACR,SAAS,GACT,MAAM,GACN,SAAS,GACT,OAAO,GACP,OAAO,CAAC;AAEZ;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,WAAW,GACX,eAAe,GACf,IAAI,GACJ,QAAQ,GACR,eAAe,GACf,cAAc,CAAC,UAAU,CAAC,GAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,OAAO,EAAE,GACT,IAAI,CAAC;AAET;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,WAAW,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC;AAEpG;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;IACnE,WAAW;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW;IACX,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IACtE,WAAW;IACX,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,0BAA0B;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,uDAAuD;IACvD,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IAEf,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC;IAEhB,kDAAkD;IAClD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,YAAY;IACZ,WAAW,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAEjC,cAAc;IACd,WAAW,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAEjC,oCAAoC;IACpC,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B,wBAAwB;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,sBAAsB;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,uBAAuB;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC;IAE/C,WAAW;IACX,mBAAmB,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,YAAY,CAAC;CAC5D,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW;IACX,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,kBAAkB;IAClB,eAAe,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,IAAI,CAAC;IAEnD,oBAAoB;IACpB,gBAAgB,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,KAAK,IAAI,CAAC;AAKtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;WAqM9D,WAAW;EAMxC;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,uBAM1D;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,CAAC,QAAQ,CAAC,0BAQtE"}

package/dist/network/uploadFile.d.ts

@@ -0,0 +1,57 @@
+import type { WebApiConfig } from '../async';
+/**
+ * 上传文件的选项
+ */
+export type UploadFileOption = {
+    /** 上传接口地址 */
+    url: string;
+    /** 要上传的文件对象 */
+    file: File;
+    /** 文件对应的 key, 默认'file' (服务端通过这个 key 获取文件的二进制内容) */
+    name?: string;
+    /** 请求头 */
+    header?: Record<string, string | number>;
+    /** 额外的formData参数 */
+    formData?: Record<string, string | number>;
+    /** 超时时间，单位 ms，默认 0（不超时） */
+    timeout?: number;
+};
+export type OnUploadProgressUpdate = (res: UploadProgressEvent) => void;
+export type UploadProgressEvent = {
+    /** 上传进度百分比: 0-100 */
+    progress: number;
+    /** 已上传字节数 */
+    loaded: number;
+    /** 总字节数 */
+    total: number;
+};
+export type UploadTask = {
+    /** 上传进度 */
+    onProgressUpdate: (callback: OnUploadProgressUpdate) => void;
+    /** 取消上传 */
+    abort: () => void;
+};
+export type UploadConfig = {
+    /** 获取task对象 */
+    onTaskReady?: (task: UploadTask) => void;
+};
+export type UploadFail = {
+    message: string;
+    status: number;
+};
+/**
+ * 上传文件
+ * @param option 上传文件的选项
+ * @param config 配置项
+ * @example
+ * // 上传
+ * await uploadFile({ url: 'https://xx', file: file});
+ *
+ * // 监听上传进度
+ * await uploadFile({ url: 'https://xx', file: file}, {
+ *   onTaskReady: (task) =>
+ *     task.onProgressUpdate((res) => console.log('上传进度:', res.progress)),
+ * });
+ */
+export declare function uploadFile<T = any>(option: UploadFileOption, config?: UploadConfig & WebApiConfig<T, UploadFail>): Promise<T>;
+//# sourceMappingURL=uploadFile.d.ts.map

package/dist/network/uploadFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploadFile.d.ts","sourceRoot":"","sources":["../../src/web/network/uploadFile.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa;IACb,GAAG,EAAE,MAAM,CAAC;IAEZ,eAAe;IACf,IAAI,EAAE,IAAI,CAAC;IAEX,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU;IACV,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAEzC,oBAAoB;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAE3C,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,GAAG,EAAE,mBAAmB,KAAK,IAAI,CAAC;AAExE,MAAM,MAAM,mBAAmB,GAAG;IAChC,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW;IACX,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW;IACX,gBAAgB,EAAE,CAAC,QAAQ,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAC7D,WAAW;IACX,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,eAAe;IACf,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AA6EF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,CAAC,GAAG,GAAG,EAChC,MAAM,EAAE,gBAAgB,EACxB,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC,CAAC,EAAE,UAAU,CAAC,cAMpD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base-web-kits/base-tools-web",
-  "version": "1.1.11",
+  "version": "1.1.18-alpha.0",
   "sideEffects": false,
   "description": "Independent Web utilities package built from src/web.",
   "keywords": [
@@ -25,7 +25,7 @@
     "src"
   ],
   "dependencies": {
-    "@base-web-kits/base-tools-ts": "^1.1.10"
+    "@base-web-kits/base-tools-ts": "^1.1.11"
   },
   "peerDependencies": {
     "axios": ">=0.18.0"

package/src/web/async/index.ts

@@ -0,0 +1,82 @@
+import { getBaseToolsConfig } from '../index';
+
+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 function promisifyWebApi<Option, Res, Err, Config = unknown>(
+  webApi: WebApi<Option, Res, Config>,
+  apiName?: string,
+) {
+  return (option: Option, config?: WebApiConfig<Res, Err> & Config) => {
+    const finalConfig = config || ({} as WebApiConfig<Res, Err> & Config);
+    const {
+      showLoading = false,
+      toastSuccess = false,
+      toastError = true,
+      showLog = true,
+    } = finalConfig;
+    const {
+      log,
+      toast,
+      showLoading: showLoadingFn,
+      hideLoading: hideLoadingFn,
+    } = getBaseToolsConfig();
+    const fname = apiName || 'promisifyWebApi'; // webApi.name经过打包后取不到原函数名，不如默认'promisifyWebApi'
+
+    if (showLoading) {
+      const title = typeof showLoading === 'string' ? showLoading : '';
+      showLoadingFn?.({ title });
+    }
+
+    return new Promise<Res>((resolve, reject) => {
+      webApi(option, finalConfig)
+        .then((res) => {
+          if (showLoading) hideLoadingFn?.();
+          if (showLog) log?.('info', { name: fname, status: 'success', option, res });
+          resolve(res);
+
+          const msg = typeof toastSuccess === 'function' ? toastSuccess(res) : toastSuccess;
+          if (msg) toast?.({ msg, status: 'success' });
+        })
+        .catch((e) => {
+          if (showLoading) hideLoadingFn?.();
+          if (showLog) log?.('error', { name: fname, status: 'fail', option, e });
+
+          const msg = typeof toastError === 'function' ? toastError(e) : toastError;
+          if (msg) {
+            toast?.({
+              msg: typeof msg === 'string' ? msg : `${fname} fail: ${JSON.stringify(e)}`,
+              status: 'fail',
+            });
+          }
+
+          reject(e);
+        });
+    });
+  };
+}

package/src/web/config/index.ts

@@ -2,7 +2,7 @@ export type AppConfig = {
   /** 全局 Toast 提示 */
   toast?: (option: { msg: string; status: 'success' | 'fail' }) => void;
   /** 显示全局 Loading */
-  showLoading?: () => void;
+  showLoading?: (option?: { title?: string }) => void;
   /** 隐藏全局 Loading */
   hideLoading?: () => void;
   /** 跳转登录页的方法 */

package/src/web/network/index.ts

@@ -1,2 +1,3 @@
-export * from './load';
+export * from './download';
 export * from './request';
+export * from './uploadFile';

package/src/web/network/request.ts

@@ -3,7 +3,6 @@ import {
   cloneDeep,
   getObjectValue,
   isPlainObject,
-  pickBy,
   toDayjs,
 } from '@base-web-kits/base-tools-ts';
 import { getBaseToolsConfig } from '../config';
@@ -80,8 +79,8 @@ export type RequestConfigBase<D extends RequestData = RequestData> = {
   /** 登录过期状态码 */
   reloginCode: (number | string)[];
 
-  /** 是否显示进度条 (默认true) */
-  showLoading?: boolean;
+  /** 是否显示进度条: 支持字符串,自定义文本 (默认true) */
+  showLoading?: boolean | string;
 
   /** 是否提示接口异常 (默认true) */
   toastError?: boolean;
@@ -136,7 +135,7 @@ const requestCache = new Map<string, { res: unknown; expire: number }>();
  * // 在入口文件完成配置 (确保请求失败有toast提示,登录过期能够触发重新登录,log有日志输出)
  * setBaseToolsConfig({
  * toast: ({ msg, status }) => (status === 'fail' ? message.error(msg) : message.success(msg)),
- * showLoading: () => message.loading('加载中...'),
+ * showLoading: ({ title }) => message.loading(title || '加载中...'),
  * hideLoading: () => message.destroy(),
  * toLogin: () => reLogin(),
  * log(level, data) {
@@ -244,14 +243,11 @@ export function request<T, D extends RequestData = RequestData>(config: RequestC
       const isArrayData = !isObjectData && Array.isArray(data);
 
       // 2.1 参数处理
-      // 参数: 过滤undefined, 避免接口处理异常 (不可过滤 null 、 "" 、 false 、 0 这些有效值)
-      const fillData = isObjectData ? pickBy(data, (val) => val !== undefined) : data;
+      // 参数过滤 undefined
+      const fillData = isObjectData ? filterRequestData(data) : data;
 
-      // 请求头: 过滤空值 (undefined, null, ""), 不过滤0和false
-      const emptyValue: unknown[] = [undefined, null, ''];
-      const fillHeader = (
-        header ? pickBy(header, (val) => !emptyValue.includes(val)) : {}
-      ) as Record<string, string>;
+      // 请求头过滤空值 (undefined, null, "")
+      const fillHeader = filterRequestHeader(header);
 
       // 获取 Content-Type (忽略大小写)
       const contentTypeKey = Object.keys(fillHeader).find(
@@ -310,7 +306,8 @@ export function request<T, D extends RequestData = RequestData>(config: RequestC
 
       // 2.5 UI 反馈
       const appConfig = getBaseToolsConfig();
-      if (showLoading) appConfig.showLoading?.();
+      if (showLoading)
+        appConfig.showLoading?.(typeof showLoading === 'string' ? { title: showLoading } : {});
 
       // 2.6 设置超时
       let isTimeout = false;
@@ -406,6 +403,30 @@ export function request<T, D extends RequestData = RequestData>(config: RequestC
   return promise;
 }
 
+/**
+ * 参数过滤undefined, 避免接口处理异常 (不可过滤 null 、 "" 、 false 、 0 这些有效值)
+ */
+export function filterRequestData(data: Record<string, any>) {
+  const res: Record<string, any> = {};
+  Object.entries(data).forEach(([k, v]) => {
+    if (v !== undefined) res[k] = v;
+  });
+  return res;
+}
+
+/**
+ * 请求头过滤空值 (undefined, null, ""), 不过滤0和false
+ */
+export function filterRequestHeader(header: RequestConfigBase['header']) {
+  const newHeader: Record<string, string> = {};
+  if (header) {
+    Object.entries(header).forEach(([k, v]) => {
+      if (v !== undefined && v !== null && v !== '') newHeader[k] = String(v);
+    });
+  }
+  return newHeader;
+}
+
 /**
  * 日志输出
  */

package/src/web/network/uploadFile.ts

@@ -0,0 +1,152 @@
+import { promisifyWebApi } from '../async';
+import type { WebApiConfig } from '../async';
+
+/**
+ * 上传文件的选项
+ */
+export type UploadFileOption = {
+  /** 上传接口地址 */
+  url: string;
+
+  /** 要上传的文件对象 */
+  file: File;
+
+  /** 文件对应的 key, 默认'file' (服务端通过这个 key 获取文件的二进制内容) */
+  name?: string;
+
+  /** 请求头 */
+  header?: Record<string, string | number>;
+
+  /** 额外的formData参数 */
+  formData?: Record<string, string | number>;
+
+  /** 超时时间，单位 ms，默认 0（不超时） */
+  timeout?: number;
+};
+
+export type OnUploadProgressUpdate = (res: UploadProgressEvent) => void;
+
+export type UploadProgressEvent = {
+  /** 上传进度百分比: 0-100 */
+  progress: number;
+  /** 已上传字节数 */
+  loaded: number;
+  /** 总字节数 */
+  total: number;
+};
+
+export type UploadTask = {
+  /** 上传进度 */
+  onProgressUpdate: (callback: OnUploadProgressUpdate) => void;
+  /** 取消上传 */
+  abort: () => void;
+};
+
+export type UploadConfig = {
+  /** 获取task对象 */
+  onTaskReady?: (task: UploadTask) => void;
+};
+
+export type UploadFail = {
+  message: string;
+  status: number;
+};
+
+function upload<T>(option: UploadFileOption, config?: UploadConfig) {
+  return new Promise<T>((resolve, reject) => {
+    const xhr = new XMLHttpRequest();
+    const { url, file, name = 'file', header, formData, timeout = 0 } = option;
+
+    const fail = (error: UploadFail) => reject(error);
+
+    const success = (responseText: string) => {
+      try {
+        resolve(JSON.parse(responseText) as T);
+      } catch (e) {
+        resolve(responseText as T);
+      }
+    };
+
+    // 构造任务对象
+    let onProgressUpdate: OnUploadProgressUpdate;
+    const task: UploadTask = {
+      onProgressUpdate: (callback) => {
+        onProgressUpdate = callback;
+      },
+      abort: () => xhr.abort(),
+    };
+    config?.onTaskReady?.(task);
+
+    // 监听进度
+    xhr.upload.onprogress = (e) => {
+      if (!e.lengthComputable) return;
+      const ev: UploadProgressEvent = {
+        progress: Math.round((e.loaded / e.total) * 100),
+        loaded: e.loaded,
+        total: e.total,
+      };
+      onProgressUpdate?.(ev);
+    };
+
+    // 监听事件
+    xhr.onload = () => {
+      if (xhr.status >= 200 && xhr.status < 300) {
+        success(xhr.responseText);
+      } else {
+        fail({ message: `上传失败`, status: xhr.status });
+      }
+    };
+    xhr.onerror = () => fail({ message: '网络错误', status: 0 });
+    xhr.ontimeout = () => fail({ message: '上传超时', status: -1 });
+    xhr.onabort = () => fail({ message: '用户取消', status: -2 });
+
+    // 设置请求方法和 URL
+    xhr.open('POST', url);
+
+    // 设置请求头
+    if (header) {
+      Object.entries(header).forEach(([k, v]) => {
+        if (v !== undefined && v !== null && v !== '') xhr.setRequestHeader(k, String(v));
+      });
+    }
+
+    // 设置超时时间
+    xhr.timeout = timeout;
+
+    // 组装 FormData
+    const data = new FormData();
+    data.append(name, file);
+    if (formData) {
+      Object.entries(formData).forEach(([k, v]) => {
+        if (v !== undefined) data.append(k, String(v));
+      });
+    }
+
+    // 发送请求
+    xhr.send(data);
+  });
+}
+
+/**
+ * 上传文件
+ * @param option 上传文件的选项
+ * @param config 配置项
+ * @example
+ * // 上传
+ * await uploadFile({ url: 'https://xx', file: file});
+ *
+ * // 监听上传进度
+ * await uploadFile({ url: 'https://xx', file: file}, {
+ *   onTaskReady: (task) =>
+ *     task.onProgressUpdate((res) => console.log('上传进度:', res.progress)),
+ * });
+ */
+export function uploadFile<T = any>(
+  option: UploadFileOption,
+  config?: UploadConfig & WebApiConfig<T, UploadFail>,
+) {
+  return promisifyWebApi<UploadFileOption, T, UploadFail, UploadConfig>(upload, 'uploadFile')(
+    option,
+    config,
+  );
+}

package/dist/network/load.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../src/web/network/load.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C;;;;;;;;GAQG;AACH,wBAAsB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,SAAK,iBAyC/D;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAAC,GAAG,EAAE,aAAa,CAAC,IAAI,CAAC;;;GAc5D;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,CAAC,EAAE,MAAM,UAkB1D;AAED;;;;;;;GAOG;AACH,wBAAsB,MAAM,CAC1B,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,OAAO,GAAG,aAAa,CAAC,iBAuBnE;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,WAOhC;AAED;;;;;;;GAOG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,aAAa,GAAG,OAAO,CAAC,iBAuBvD;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,WAOlC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,6BAOvC"}