@base-web-kits/base-tools-web 1.3.18 → 1.4.0

package/dist/network/request.d.ts

@@ -10,6 +10,15 @@ export type RequestData = string | ArrayBuffer | ArrayBufferView | Blob | FormDa
  * 响应数据类型
  */
 export type ResponseData = string | ArrayBuffer | Blob | Record<string, unknown> | unknown[] | null;
+/** 请求前转换上下文 */
+export type TransformRequestContext<D extends RequestData = RequestData> = {
+    url: string;
+    method: RequestMethod;
+    header: Record<string, string>;
+    data?: D;
+};
+/** 请求前转换结果 */
+export type TransformRequestResult<D extends RequestData = RequestData> = Partial<Pick<TransformRequestContext<D>, 'url' | 'header' | 'data'>>;
 /**
  * 发起请求的配置 (对外,参数可选)
  */
@@ -54,8 +63,10 @@ export type RequestConfigBase<D extends RequestData = RequestData> = {
     showLog?: boolean;
     /** 成功和失败时,额外输出的日志数据 (可覆盖内部log参数,如'name') */
     logExtra?: Record<string, unknown>;
+    /** 请求前的数据转换, 可用于加密 header、data 或重写 url */
+    transformRequest?: (ctx: TransformRequestContext<D>) => TransformRequestResult<D> | Promise<TransformRequestResult<D>>;
     /** 响应数据的转换 */
-    resMap?: (data: ResponseData) => ResponseData;
+    transformResponse?: (data: ResponseData) => ResponseData;
     /** 获取请求对象, 用于取消请求 */
     onTaskReady?: (task: RequestTask) => void;
     /**
@@ -101,7 +112,8 @@ export type RequestTask = {
  * export function requestApi<T>(config: RequestConfig) {
  *    return request<T>({
  *      header: { token: 'xx', version: 'xx', tid: 'xx' }, // 会自动过滤空值
- *      // resMap: (res) => res, // 响应数据的转换, 如解密操作 (可选)
+ *      // transformRequest: ({ header, data }) => ({ header, data }), // 请求前转换, 如加密请求头和请求参数 (可选)
+ *      // transformResponse: (res) => res, // 响应数据的转换, 如解密操作 (可选)
  *      resKey: 'data',
  *      msgKey: 'message',
  *      codeKey: 'status',

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

@@ -1 +1 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/web/network/request.ts"],"names":[],"mappings":"AAKA,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAG5E,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;IAEZ,WAAW;IACX,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IAEtE,WAAW;IACX,IAAI,CAAC,EAAE,CAAC,CAAC;IAET,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,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC;IAE/C,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,wBAAwB;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,oCAAoC;IACpC,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B,sBAAsB;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,cAAc;IACd,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,YAAY,CAAC;IAE9C,qBAAqB;IACrB,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;IAE1C;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF,sBAAsB;AACtB,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW;IACX,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC;AAYF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkFG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,cA6N3F;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"}
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/web/network/request.ts"],"names":[],"mappings":"AAKA,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAG5E,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,eAAe;AACf,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;IACzE,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,IAAI,CAAC,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,cAAc;AACd,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,OAAO,CAC/E,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC,CAC5D,CAAC;AAEF;;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;IAEZ,WAAW;IACX,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IAEtE,WAAW;IACX,IAAI,CAAC,EAAE,CAAC,CAAC;IAET,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,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC;IAE/C,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,wBAAwB;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,oCAAoC;IACpC,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B,sBAAsB;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,0CAA0C;IAC1C,gBAAgB,CAAC,EAAE,CACjB,GAAG,EAAE,uBAAuB,CAAC,CAAC,CAAC,KAC5B,sBAAsB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpE,cAAc;IACd,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,YAAY,CAAC;IAEzD,qBAAqB;IACrB,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;IAE1C;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF,sBAAsB;AACtB,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW;IACX,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC;AAuBF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,cAsP3F;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/package.json

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

package/src/web/async/index.ts

@@ -23,8 +23,8 @@ export type WebApiConfig<Res = any, Err = any> = {
   /** 是否显示日志, 默认 true */
   showLog?: boolean;
 
-  /** 响应数据的转换, 如解密操作 (返回值在成功日志中输出'resMap'字段) */
-  resMap?: (res: any) => Res;
+  /** 响应数据的转换, 如解密操作 (返回值在成功日志中输出'transformResponse'字段) */
+  transformResponse?: (res: any) => Res;
 
   /** 成功和失败时,额外输出的日志数据 (可覆盖内部log参数,如'name') */
   logExtra?: Record<string, unknown>;
@@ -50,7 +50,7 @@ export function enhanceWebApi<Option = any, Res = any, Err = any, Config = any>(
       toastSuccess = false,
       toastError = true,
       showLog = true,
-      resMap,
+      transformResponse,
       logExtra,
     } = finalConfig;
 
@@ -72,14 +72,14 @@ export function enhanceWebApi<Option = any, Res = any, Err = any, Config = any>(
         .then((res) => {
           if (showLoading) hideLoadingFn?.();
 
-          const finalRes = resMap ? resMap(res) : res;
+          const finalRes = transformResponse ? transformResponse(res) : res;
 
           if (showLog) {
             const logData: AppLogInfo = { name: fname, status: 'success', option, ...logExtra };
 
-            if (resMap) {
+            if (transformResponse) {
               logData.res = res; // 输出原始数据
-              logData.resMap = cloneDeep(finalRes); // 深拷贝处理后数据,避免外部修改对象,造成输出不一致
+              logData.transformResponse = cloneDeep(finalRes); // 深拷贝处理后数据,避免外部修改对象,造成输出不一致
             } else {
               logData.res = cloneDeep(res); // 深拷贝原始数据,避免外部修改对象,造成输出不一致
             }

package/src/web/network/request.ts

@@ -39,6 +39,19 @@ export type RequestData =
  */
 export type ResponseData = string | ArrayBuffer | Blob | Record<string, unknown> | unknown[] | null;
 
+/** 请求前转换上下文 */
+export type TransformRequestContext<D extends RequestData = RequestData> = {
+  url: string;
+  method: RequestMethod;
+  header: Record<string, string>;
+  data?: D;
+};
+
+/** 请求前转换结果 */
+export type TransformRequestResult<D extends RequestData = RequestData> = Partial<
+  Pick<TransformRequestContext<D>, 'url' | 'header' | 'data'>
+>;
+
 /**
  * 发起请求的配置 (对外,参数可选)
  */
@@ -102,8 +115,13 @@ export type RequestConfigBase<D extends RequestData = RequestData> = {
   /** 成功和失败时,额外输出的日志数据 (可覆盖内部log参数,如'name') */
   logExtra?: Record<string, unknown>;
 
+  /** 请求前的数据转换, 可用于加密 header、data 或重写 url */
+  transformRequest?: (
+    ctx: TransformRequestContext<D>,
+  ) => TransformRequestResult<D> | Promise<TransformRequestResult<D>>;
+
   /** 响应数据的转换 */
-  resMap?: (data: ResponseData) => ResponseData;
+  transformResponse?: (data: ResponseData) => ResponseData;
 
   /** 获取请求对象, 用于取消请求 */
   onTaskReady?: (task: RequestTask) => void;
@@ -134,6 +152,17 @@ export type RequestTask = {
  */
 type SseTask = { parser: SSEParser | undefined | null };
 
+/** 日志请求 */
+type RequestLogConfig = {
+  url?: string;
+  data?: unknown;
+  header?: unknown;
+  method?: RequestMethod;
+  logExtra?: Record<string, unknown>;
+  showLog?: boolean;
+  resKey?: RequestConfigBase['resKey'];
+};
+
 /** 请求缓存 */
 const requestCache = new Map<string, { res: unknown; expire: number }>();
 
@@ -163,7 +192,8 @@ const requestCache = new Map<string, { res: unknown; expire: number }>();
  * export function requestApi<T>(config: RequestConfig) {
  *    return request<T>({
  *      header: { token: 'xx', version: 'xx', tid: 'xx' }, // 会自动过滤空值
- *      // resMap: (res) => res, // 响应数据的转换, 如解密操作 (可选)
+ *      // transformRequest: ({ header, data }) => ({ header, data }), // 请求前转换, 如加密请求头和请求参数 (可选)
+ *      // transformResponse: (res) => res, // 响应数据的转换, 如解密操作 (可选)
  *      resKey: 'data',
  *      msgKey: 'message',
  *      codeKey: 'status',
@@ -236,7 +266,8 @@ export function request<T, D extends RequestData = RequestData>(config: RequestC
     toastError = true,
     enableChunked = false,
     cacheTime,
-    resMap,
+    transformRequest,
+    transformResponse,
     responseType = 'json',
     timeout = 60000,
     onTaskReady,
@@ -265,29 +296,53 @@ export function request<T, D extends RequestData = RequestData>(config: RequestC
   return new Promise<T>((resolve, reject) => {
     const execute = async () => {
       const isGet = method === 'GET';
-      const isObjectData = isPlainObject(data);
-      const isArrayData = !isObjectData && Array.isArray(data);
 
       // 2.1 参数处理
       // 参数过滤 undefined
-      const fillData = isObjectData ? filterRequestData(data) : data;
+      let fillData = isPlainObject(data) ? filterRequestData(data) : data;
 
       // 请求头过滤空值 (undefined, null, "")
-      const fillHeader = filterRequestHeader(header);
+      let fillHeader = filterRequestHeader(header);
+
+      // 请求前转换
+      let fillUrl = url;
+      const requestTransformer = transformRequest;
+      if (requestTransformer) {
+        const transformed =
+          (await requestTransformer({
+            url: fillUrl,
+            method,
+            header: { ...fillHeader },
+            data: fillData as D,
+          })) || {};
+
+        if (transformed.url !== undefined) fillUrl = transformed.url;
+        if (transformed.header !== undefined) fillHeader = filterRequestHeader(transformed.header);
+        if (transformed.data !== undefined) {
+          const transformedData = transformed.data;
+          fillData = isPlainObject(transformedData)
+            ? filterRequestData(transformedData as Record<string, any>)
+            : transformedData;
+        }
+      }
 
       // 获取 Content-Type (忽略大小写)
       const contentTypeKey = Object.keys(fillHeader).find(
         (k) => k.toLowerCase() === 'content-type',
       );
       const contentType = contentTypeKey ? String(fillHeader[contentTypeKey]).toLowerCase() : '';
+      const isObjectData = isPlainObject(fillData);
+      const isArrayData = !isObjectData && Array.isArray(fillData);
 
       if (!isGet && fillData && (isObjectData || isArrayData) && !contentType) {
         fillHeader['Content-Type'] = 'application/json';
       }
 
       // 2.2 处理 URL 和 Body
-      const fillUrl =
-        isGet && isObjectData ? appendUrlParam(url, fillData as Record<string, unknown>) : url;
+      fillUrl =
+        isGet && isPlainObject(fillData)
+          ? appendUrlParam(fillUrl, fillData as Record<string, unknown>)
+          : fillUrl;
 
       let fillBody: BodyInit | null | undefined;
 
@@ -390,8 +445,8 @@ export function request<T, D extends RequestData = RequestData>(config: RequestC
         // 隐藏 Loading
         if (showLoading) appConfig.hideLoading?.();
 
-        // 响应拦截
-        const res = resMap ? resMap(resData) : resData;
+        // 响应数据转换
+        const res = transformResponse ? transformResponse(resData) : resData;
 
         // 2.10 业务状态码解析
         const code = getObjectValue(res, codeKey);
@@ -431,7 +486,7 @@ export function request<T, D extends RequestData = RequestData>(config: RequestC
         }
 
         if (!isAbortError && toastError)
-          appConfig.toast?.({ status, msg: `请求失败,${String(e)}` });
+          appConfig.toast?.({ status, msg: `请求失败,${JSON.stringify(e)}` });
         logRequestInfo({ status, config: logConfig, startTime, e });
         reject(e);
       } finally {
@@ -471,7 +526,7 @@ export function filterRequestHeader(header: RequestConfigBase['header']) {
  * 日志输出
  */
 function logRequestInfo(options: {
-  config: RequestConfigBase<RequestData> & { url?: string };
+  config: RequestLogConfig;
   fromCache?: boolean;
   startTime: number;
   status: 'success' | 'fail';
@@ -506,7 +561,7 @@ function logRequestInfo(options: {
     info.res = cloneDeep(res); // 深拷贝,避免外部修改对象,造成输出不一致
     log('info', info);
   } else {
-    info.e = e instanceof Error ? { name: e.name, message: e.message, stack: e.stack } : String(e); // Error需转为普通对象,否则发送网络日志会序列化成空对象
+    info.e = e instanceof Error ? { name: e.name, message: e.message, stack: e.stack } : e; // Error需转为普通对象,否则发送网络日志会序列化成空对象
     log('error', info);
   }
 }