@base-web-kits/base-tools-web 1.0.2-alpha.2 → 1.0.2-alpha.4

package/dist/network/request.d.ts

@@ -6,6 +6,23 @@ export * from './request.d';
  * @param config 请求配置
  * @returns Promise<T> & { task?: RequestTask }
  * @example
+ * // 在入口文件完成配置 (确保请求失败有toast提示,登录过期能够触发重新登录,log有日志输出)
+ * setBaseToolsConfig({
+ * toast: ({ msg, status }) => (status === 'fail' ? message.error(msg) : message.success(msg)),
+ * showLoading: () => message.loading('加载中...'),
+ * hideLoading: () => message.destroy(),
+ * toLogin: () => reLogin(),
+ * log(level, data) {
+ *   if (data.name === 'request') {
+ *     sendLog('request', data); // 请求日志
+ *   } else if (level === 'error') {
+ *     sendLog('error', data); // 错误日志
+ *   } else {
+ *     sendLog('action', data); // 操作日志
+ *   }
+ * },
+ * });
+ *
  * // 封装项目的基础请求
  * export function requestApi<T>(config: RequestConfig) {
  *    return request<T>({

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

@@ -1 +1 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/web/network/request.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAiB,iBAAiB,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE9F,cAAc,aAAa,CAAC;AAK5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;WAkL9D,WAAW;EAMxC"}
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/web/network/request.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAEV,iBAAiB,EACjB,WAAW,EACX,WAAW,EAEZ,MAAM,aAAa,CAAC;AAErB,cAAc,aAAa,CAAC;AAK5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;WAmL9D,WAAW;EAMxC"}

package/package.json

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

package/src/web/config/index.ts

@@ -1,6 +1,6 @@
 export type AppConfig = {
   /** 全局 Toast 提示 */
-  toast?: (msg: string) => void;
+  toast?: (option: { msg: string; status: 'success' | 'fail' }) => void;
   /** 显示全局 Loading */
   showLoading?: () => void;
   /** 隐藏全局 Loading */
@@ -45,6 +45,22 @@ export function getAppConfig() {
 
 /**
  * 初始化应用配置 (在入口文件设置)
+ * @example
+ * setBaseToolsConfig({
+ * toast: ({ msg, status }) => (status === 'fail' ? message.error(msg) : message.success(msg)),
+ * showLoading: () => message.loading('加载中...'),
+ * hideLoading: () => message.destroy(),
+ * toLogin: () => reLogin(),
+ * log(level, data) {
+ *   if (data.name === 'request') {
+ *     sendLog('request', data); // 请求日志
+ *   } else if (level === 'error') {
+ *     sendLog('error', data); // 错误日志
+ *   } else {
+ *     sendLog('action', data); // 操作日志
+ *   }
+ * },
+ * });
  */
 export function setBaseToolsConfig(newConfig: AppConfig) {
   Object.assign(appConfig, newConfig);

package/src/web/network/request.d.ts

@@ -26,6 +26,11 @@ export type RequestData =
   | unknown[]
   | null;
 
+/**
+ * 响应数据类型
+ */
+export type ResponseData = string | ArrayBuffer | Blob | Record<string, unknown> | unknown[] | null;
+
 /**
  * 发起请求的配置 (对外,参数可选)
  */
@@ -86,7 +91,7 @@ export type RequestConfigBase<D extends RequestData = RequestData> = {
   responseType?: 'text' | 'arraybuffer' | 'json';
 
   /** 响应拦截 */
-  responseInterceptor?: (data: unknown) => unknown;
+  responseInterceptor?: (data: ResponseData) => ResponseData;
 };
 
 /**

package/src/web/network/request.ts

@@ -8,7 +8,13 @@ import {
 } from '../../ts';
 import { getAppConfig } from '../config';
 import type { AppLogInfo } from '../config';
-import type { ChunkCallback, RequestConfigBase, RequestData, RequestTask } from './request.d';
+import type {
+  ChunkCallback,
+  RequestConfigBase,
+  RequestData,
+  RequestTask,
+  ResponseData,
+} from './request.d';
 
 export * from './request.d';
 
@@ -21,6 +27,23 @@ const requestCache = new Map<string, { res: unknown; expire: number }>();
  * @param config 请求配置
  * @returns Promise<T> & { task?: RequestTask }
  * @example
+ * // 在入口文件完成配置 (确保请求失败有toast提示,登录过期能够触发重新登录,log有日志输出)
+ * setBaseToolsConfig({
+ * toast: ({ msg, status }) => (status === 'fail' ? message.error(msg) : message.success(msg)),
+ * showLoading: () => message.loading('加载中...'),
+ * hideLoading: () => message.destroy(),
+ * toLogin: () => reLogin(),
+ * log(level, data) {
+ *   if (data.name === 'request') {
+ *     sendLog('request', data); // 请求日志
+ *   } else if (level === 'error') {
+ *     sendLog('error', data); // 错误日志
+ *   } else {
+ *     sendLog('action', data); // 操作日志
+ *   }
+ * },
+ * });
+ *
  * // 封装项目的基础请求
  * export function requestApi<T>(config: RequestConfig) {
  *    return request<T>({
@@ -225,22 +248,23 @@ export function request<T, D extends RequestData = RequestData>(config: RequestC
           appConfig.toLogin?.(); // 放在后面,确保reject执行后再跳转登录
         } else {
           // 业务错误
-          if (toastError && msg) appConfig.toast?.(msg);
+          if (toastError && msg) appConfig.toast?.({ status: 'fail', msg });
           reject(res);
         }
       } catch (e) {
+        const status = 'fail';
         const isAbortError = e instanceof DOMException && e.name === 'AbortError'; // 取消请求不视为错误
 
         if (isAbortError && isTimeout) {
-          if (toastError) appConfig.toast?.('请求超时');
+          if (toastError) appConfig.toast?.({ status, msg: '请求超时' });
           const timeoutError = new Error('Request Timeout');
-          logRequestInfo({ status: 'fail', config: logConfig, startTime, e: timeoutError });
+          logRequestInfo({ status, config: logConfig, startTime, e: timeoutError });
           reject(timeoutError);
           return;
         }
 
-        if (!isAbortError && toastError) appConfig.toast?.('网络请求失败');
-        logRequestInfo({ status: 'fail', config: logConfig, startTime, e });
+        if (!isAbortError && toastError) appConfig.toast?.({ status, msg: '网络请求失败' });
+        logRequestInfo({ status, config: logConfig, startTime, e });
         reject(e);
       } finally {
         if (timeoutId) clearTimeout(timeoutId);
@@ -344,7 +368,7 @@ async function handleStreamResponse(response: Response, chunkCallback: ChunkCall
  * 解析响应数据
  */
 async function parseResponse(response: Response, responseType: string) {
-  let resData: unknown;
+  let resData: ResponseData;
   if (responseType === 'arraybuffer') {
     resData = await response.arrayBuffer();
   } else if (responseType === 'text') {