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

package/dist/index.d.cts

@@ -362,6 +362,15 @@ type RequestData = string | ArrayBuffer | ArrayBufferView | Blob | FormData | UR
  * 响应数据类型
  */
 type ResponseData = string | ArrayBuffer | Blob | Record<string, unknown> | unknown[] | null;
+/** 请求前转换上下文 */
+type TransformRequestContext<D extends RequestData = RequestData> = {
+    url: string;
+    method: RequestMethod;
+    header: Record<string, string>;
+    data?: D;
+};
+/** 请求前转换结果 */
+type TransformRequestResult<D extends RequestData = RequestData> = Partial<Pick<TransformRequestContext<D>, 'url' | 'header' | 'data'>>;
 /**
  * 发起请求的配置 (对外,参数可选)
  */
@@ -406,8 +415,10 @@ 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;
     /**
@@ -453,7 +464,8 @@ 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',
@@ -532,8 +544,8 @@ type WebApiConfig<Res = any, Err = any> = {
     toastError?: ((e: Err) => boolean | string) | boolean | string;
     /** 是否显示日志, 默认 true */
     showLog?: boolean;
-    /** 响应数据的转换, 如解密操作 (返回值在成功日志中输出'resMap'字段) */
-    resMap?: (res: any) => Res;
+    /** 响应数据的转换, 如解密操作 (返回值在成功日志中输出'transformResponse'字段) */
+    transformResponse?: (res: any) => Res;
     /** 成功和失败时,额外输出的日志数据 (可覆盖内部log参数,如'name') */
     logExtra?: Record<string, unknown>;
 };
@@ -670,4 +682,4 @@ declare function getUrlNumber(key: string, url?: string): number | null;
  */
 declare function getUrlParams(url?: string): Record<string, string>;
 
-export { type AppConfig, type AppLogInfo, type OnUploadProgressUpdate, type RequestConfig, type RequestConfigBase, type RequestData, type RequestMethod, type RequestTask, type ResponseData, type UploadConfig, type UploadFail, type UploadFileOption, type UploadProgressEvent, type UploadTask, copyBlob, copyHtml, copyImage, copyNode, copyRtf, copyTable, copyText, copyUrl, download, filterRequestData, filterRequestHeader, getBaseToolsConfig, getBrowserName, getBrowserVersion, getCookie, getDevicePixelRatio, getDispositionFileName, getLocalStorage, getOS, getUA, getUrlNumber, getUrlParam, getUrlParams, getWindowHeight, getWindowScrollLeft, getWindowScrollTop, getWindowWidth, hasCss, hasJs, isAndroid, isChrome, isIOS, isInViewport, isMobile, isPC, isTablet, isTouchSupported, isWeChat, loadCss, loadJs, lockBodyScroll, preloadImage, removeCookie, removeLocalStorage, request, setBaseToolsConfig, setCookie, setLocalStorage, unlockBodyScroll, uploadFile, windowScrollTo };
+export { type AppConfig, type AppLogInfo, type OnUploadProgressUpdate, type RequestConfig, type RequestConfigBase, type RequestData, type RequestMethod, type RequestTask, type ResponseData, type TransformRequestContext, type TransformRequestResult, type UploadConfig, type UploadFail, type UploadFileOption, type UploadProgressEvent, type UploadTask, copyBlob, copyHtml, copyImage, copyNode, copyRtf, copyTable, copyText, copyUrl, download, filterRequestData, filterRequestHeader, getBaseToolsConfig, getBrowserName, getBrowserVersion, getCookie, getDevicePixelRatio, getDispositionFileName, getLocalStorage, getOS, getUA, getUrlNumber, getUrlParam, getUrlParams, getWindowHeight, getWindowScrollLeft, getWindowScrollTop, getWindowWidth, hasCss, hasJs, isAndroid, isChrome, isIOS, isInViewport, isMobile, isPC, isTablet, isTouchSupported, isWeChat, loadCss, loadJs, lockBodyScroll, preloadImage, removeCookie, removeLocalStorage, request, setBaseToolsConfig, setCookie, setLocalStorage, unlockBodyScroll, uploadFile, windowScrollTo };

package/dist/index.mjs

@@ -1983,7 +1983,8 @@ function request(config) {
     toastError = true,
     enableChunked = false,
     cacheTime,
-    resMap,
+    transformRequest,
+    transformResponse,
     responseType = "json",
     timeout = 6e4,
     onTaskReady,
@@ -2003,18 +2004,34 @@ function request(config) {
     const execute = () => __async(null, null, function* () {
       var _a, _b, _c, _d, _e, _f, _g, _h, _i;
       const isGet = method === "GET";
-      const isObjectData = isPlainObject(data);
-      const isArrayData = !isObjectData && Array.isArray(data);
-      const fillData = isObjectData ? filterRequestData(data) : data;
-      const fillHeader = filterRequestHeader(header);
+      let fillData = isPlainObject(data) ? filterRequestData(data) : data;
+      let fillHeader = filterRequestHeader(header);
+      let fillUrl = url;
+      const requestTransformer = transformRequest;
+      if (requestTransformer) {
+        const transformed = (yield requestTransformer({
+          url: fillUrl,
+          method,
+          header: __spreadValues({}, fillHeader),
+          data: fillData
+        })) || {};
+        if (transformed.url !== void 0) fillUrl = transformed.url;
+        if (transformed.header !== void 0) fillHeader = filterRequestHeader(transformed.header);
+        if (transformed.data !== void 0) {
+          const transformedData = transformed.data;
+          fillData = isPlainObject(transformedData) ? filterRequestData(transformedData) : transformedData;
+        }
+      }
       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";
       }
-      const fillUrl = isGet && isObjectData ? appendUrlParam(url, fillData) : url;
+      fillUrl = isGet && isPlainObject(fillData) ? appendUrlParam(fillUrl, fillData) : fillUrl;
       let fillBody;
       if (!isGet && fillData) {
         if (isObjectData && contentType.includes("application/x-www-form-urlencoded")) {
@@ -2085,7 +2102,7 @@ function request(config) {
         }
         const resData = yield parseResponse(response, responseType);
         if (showLoading) (_d = appConfig2.hideLoading) == null ? void 0 : _d.call(appConfig2);
-        const res = resMap ? resMap(resData) : resData;
+        const res = transformResponse ? transformResponse(resData) : resData;
         const code = getObjectValue(res, codeKey);
         const scode = successKey ? getObjectValue(res, successKey) : code;
         const msg = getObjectValue(res, msgKey);
@@ -2273,7 +2290,7 @@ function enhanceWebApi(webApi, apiName) {
       toastSuccess = false,
       toastError = true,
       showLog = true,
-      resMap,
+      transformResponse,
       logExtra
     } = finalConfig;
     const {
@@ -2290,12 +2307,12 @@ function enhanceWebApi(webApi, apiName) {
     return new Promise((resolve, reject) => {
       webApi(option, finalConfig).then((res) => {
         if (showLoading) hideLoadingFn == null ? void 0 : hideLoadingFn();
-        const finalRes = resMap ? resMap(res) : res;
+        const finalRes = transformResponse ? transformResponse(res) : res;
         if (showLog) {
           const logData = __spreadValues({ 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);
           }