@base-web-kits/base-tools-web 1.4.2 → 1.4.3

package/dist/network/uploadFile.d.ts

@@ -34,10 +34,13 @@ export type UploadTask = {
 export type UploadConfig = {
     /** 获取task对象 */
     onTaskReady?: (task: UploadTask) => void;
+    /** 响应类型, 默认'text' */
+    responseType?: 'text' | 'json';
 };
 export type UploadFail = {
     message: string;
     status: number;
+    data?: unknown;
 };
 /**
  * 上传文件
@@ -53,8 +56,12 @@ export type UploadFail = {
  *     task.onProgressUpdate((res) => console.log('上传进度:', res.progress)),
  * });
  *
+ * // 直接返回json对象
+ * const json = await uploadFile({ url: 'https://xx', file: file}, { responseType: 'json' });
+ *
  * // 解析上传结果
  * console.log('uploadFile ok', JSON.parse(res));
  */
-export declare function uploadFile(option: UploadFileOption, config?: UploadConfig & WebApiConfig): Promise<string>;
+export declare function uploadFile(option: UploadFileOption, config?: UploadConfig & WebApiConfig<string, UploadFail>): Promise<string>;
+export declare function uploadFile<T = unknown>(option: UploadFileOption, config?: UploadConfig & WebApiConfig<T, UploadFail>): Promise<T>;
 //# sourceMappingURL=uploadFile.d.ts.map

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

@@ -1 +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,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAEvC,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;AA2EF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY,mBAExF"}
+{"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,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAEvC,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;IAEzC,qBAAqB;IACrB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAwHF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,gBAAgB,EACxB,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,GACvD,OAAO,CAAC,MAAM,CAAC,CAAC;AAEnB,wBAAgB,UAAU,CAAC,CAAC,GAAG,OAAO,EACpC,MAAM,EAAE,gBAAgB,EACxB,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC,CAAC,EAAE,UAAU,CAAC,GAClD,OAAO,CAAC,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base-web-kits/base-tools-web",
-  "version": "1.4.2",
+  "version": "1.4.3",
   "sideEffects": false,
   "description": "Independent Web utilities package built from src/web.",
   "keywords": [

package/src/web/network/uploadFile.ts

@@ -42,26 +42,70 @@ export type UploadTask = {
   abort: () => void;
 };
 
-export type UploadConfig = {
-  /** 获取task对象 */
-  onTaskReady?: (task: UploadTask) => void;
-};
-
-export type UploadFail = {
-  message: string;
-  status: number;
-};
-
-function upload(option: UploadFileOption, config?: UploadConfig) {
-  return new Promise<string>((resolve, reject) => {
-    const xhr = new XMLHttpRequest();
-    const { url, file, name = 'file', header, data, timeout = 0 } = option;
-
-    const fail = (error: UploadFail) => reject(error);
-
-    const success = (responseText: string) => {
-      resolve(responseText);
-    };
+export type UploadConfig = {
+  /** 获取task对象 */
+  onTaskReady?: (task: UploadTask) => void;
+
+  /** 响应类型, 默认'text' */
+  responseType?: 'text' | 'json';
+};
+
+export type UploadFail = {
+  message: string;
+  status: number;
+  data?: unknown;
+};
+
+function parseJsonSafe(text: string) {
+  try {
+    return JSON.parse(text);
+  } catch {
+    return null;
+  }
+}
+
+function getErrorMessage(responseText: string, fallback: string) {
+  const parsed = parseJsonSafe(responseText);
+  if (parsed && typeof parsed === 'object' && 'message' in parsed) {
+    const message = (parsed as { message?: unknown }).message;
+    if (typeof message === 'string' && message.trim()) {
+      return message;
+    }
+  }
+  return fallback;
+}
+
+function upload(
+  option: UploadFileOption,
+  config?: UploadConfig & { responseType?: 'text' },
+): Promise<string>;
+
+function upload<T = unknown>(
+  option: UploadFileOption,
+  config?: UploadConfig & { responseType: 'json' },
+): Promise<T>;
+
+function upload<T = unknown>(option: UploadFileOption, config?: UploadConfig) {
+  return new Promise<string | T>((resolve, reject) => {
+    const xhr = new XMLHttpRequest();
+    const { url, file, name = 'file', header, data, timeout = 0 } = option;
+    const responseType = config?.responseType ?? 'text';
+
+    const fail = (error: UploadFail) => reject(error);
+
+    const success = (responseText: string) => {
+      if (responseType === 'json') {
+        const parsed = parseJsonSafe(responseText);
+        if (parsed === null) {
+          fail({ message: '响应不是合法 JSON', status: xhr.status });
+          return;
+        }
+        resolve(parsed as T);
+        return;
+      }
+
+      resolve(responseText);
+    };
 
     // 构造任务对象
     let onProgressUpdate: OnUploadProgressUpdate;
@@ -84,15 +128,20 @@ function upload(option: UploadFileOption, config?: UploadConfig) {
       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.onload = () => {
+      const responseText = xhr.responseText || '';
+      if (xhr.status >= 200 && xhr.status < 300) {
+        success(responseText);
+      } else {
+        fail({
+          message: getErrorMessage(responseText, '上传失败'),
+          status: xhr.status,
+          data: parseJsonSafe(responseText),
+        });
+      }
+    };
+    xhr.onerror = () => fail({ message: '网络错误', status: 0 });
     xhr.ontimeout = () => fail({ message: '上传超时', status: -1 });
     xhr.onabort = () => fail({ message: '用户取消', status: -2 });
 
@@ -133,15 +182,37 @@ function upload(option: UploadFileOption, config?: UploadConfig) {
  * // 上传
  * const res = await uploadFile({ url: 'https://xx', file: file});
  *
- * // 监听上传进度
- * const res = await uploadFile({ url: 'https://xx', file: file}, {
- *   onTaskReady: (task) =>
- *     task.onProgressUpdate((res) => console.log('上传进度:', res.progress)),
- * });
- *
- * // 解析上传结果
- * console.log('uploadFile ok', JSON.parse(res));
- */
-export function uploadFile(option: UploadFileOption, config?: UploadConfig & WebApiConfig) {
-  return enhanceWebApi(upload, 'uploadFile')(option, config);
-}
+ * // 监听上传进度
+ * const res = await uploadFile({ url: 'https://xx', file: file}, {
+ *   onTaskReady: (task) =>
+ *     task.onProgressUpdate((res) => console.log('上传进度:', res.progress)),
+ * });
+ *
+ * // 直接返回json对象
+ * const json = await uploadFile({ url: 'https://xx', file: file}, { responseType: 'json' });
+ *
+ * // 解析上传结果
+ * console.log('uploadFile ok', JSON.parse(res));
+ */
+export function uploadFile(
+  option: UploadFileOption,
+  config?: UploadConfig & WebApiConfig<string, UploadFail>,
+): Promise<string>;
+
+export function uploadFile<T = unknown>(
+  option: UploadFileOption,
+  config?: UploadConfig & WebApiConfig<T, UploadFail>,
+): Promise<T>;
+
+export function uploadFile<T = string>(
+  option: UploadFileOption,
+  config?: UploadConfig & WebApiConfig<T, UploadFail>,
+): Promise<T> {
+  return enhanceWebApi(
+    upload as (
+      option: UploadFileOption,
+      config?: UploadConfig,
+    ) => Promise<T>,
+    'uploadFile',
+  )(option, config);
+}