utils-uniapp 1.1.20 → 1.1.21

package/lib/http/index.d.ts

@@ -44,8 +44,13 @@ type RequestFailPayload = {
   res: UniApp.GeneralCallbackResult;
 };
 
-/** 请求配置 */
-type RequestConfig = Partial<UniApp.RequestOptions | UniApp.UploadFileOption | UniApp.DownloadFileOption>;
+/** 标准化后的请求配置 */
+type NormalizeReqConfig = Partial<UniApp.RequestOptions | UniApp.UploadFileOption | UniApp.DownloadFileOption> & {
+  /** 库自定义：请求基础地址，非uni.request原生参数 */
+  baseURL: string;
+  /** 用于取消请求的token */
+  cancelToken: string
+};
 
 /**
  * 缓存适配器抽象接口，对接外部缓存实现
@@ -96,7 +101,7 @@ export interface CacheConfigInput {
    */
   adapter?: CacheAdapter | null | ((ctx: {
     url: string;
-    config: RequestConfig;
+    config: NormalizeReqConfig;
     options: RequestOptions;
     cacheConfig: CacheConfig;
   }) => CacheAdapter | null);
@@ -122,9 +127,9 @@ interface CacheConfig {
  * @returns 处理后的请求参数
  */
 type ReqInterceptor = (
-  invokeArgs: RequestConfig,
+  invokeArgs: NormalizeReqConfig,
   options: RequestOptions
-) => Promise<RequestConfig> | RequestConfig;
+) => Promise<NormalizeReqConfig> | NormalizeReqConfig;
 
 /**
  * 响应拦截器【标准化后】
@@ -138,7 +143,7 @@ type ReqInterceptor = (
 type ResInterceptor = (
   res: unknown,
   payload: {
-    config: RequestConfig;
+    config: NormalizeReqConfig;
     options: RequestOptions;
     reloadFn: (() => Promise<unknown>) | null;
   }
@@ -156,7 +161,7 @@ type ResInterceptor = (
 type ErrInterceptor = (
   err: RequestFailPayload | Error,
   payload: {
-    config: RequestConfig;
+    config: NormalizeReqConfig;
     options: RequestOptions;
     reloadFn: (() => Promise<unknown>) | null;
   }
@@ -255,6 +260,16 @@ export interface UserRequestOpts {
   [key: string]: any;
 }
 
+/**
+ * 运行时 headers 上下文对象
+ * 用于 headers 工厂函数回调，提供请求运行时信息，支持业务自定义扩展字段
+ * @template T - 业务原始配置泛型，会合并到上下文对象
+ * @property {string} url - 请求地址
+ */
+export type RuntimeHeadersCtx<T = {}> = {
+  url: string;
+} & T
+
 /**
  * 请求config：uni.request配置，排除内部强制覆盖字段，允许业务扩展
  * @note baseURL 为库自定义字段，非uni原生API字段
@@ -263,7 +278,7 @@ export type HttpRequestConfig = Partial<Omit<UniApp.RequestOptions, 'url' | 'hea
   /** 库自定义：请求基础地址，非uni.request原生参数 */
   baseURL?: string;
   /** 库自定义：headers支持对象或者返回对象的工厂函数 */
-  headers?: Record<string, string> | ((ctx: RequestConfig & { headers?: Record<string, string> }) => Record<string, string>);
+  headers?: Record<string, string> | ((ctx: RuntimeHeadersCtx<HttpRequestConfig>) => Record<string, string>);
   [key: string]: any;
 };
 
@@ -275,7 +290,7 @@ export type UploadConfig = Partial<Omit<UniApp.UploadFileOption, 'url' | 'header
   /** 库自定义：请求基础地址 */
   baseURL?: string;
   /** 库自定义：headers支持对象或者返回对象的工厂函数 */
-  headers?: Record<string, string> | ((ctx: RequestConfig & { headers?: Record<string, string> }) => Record<string, string>);
+  headers?: Record<string, string> | ((ctx: RuntimeHeadersCtx<UploadConfig>) => Record<string, string>);
   [key: string]: any;
 };
 
@@ -287,7 +302,7 @@ export type DownloadConfig = Partial<Omit<UniApp.DownloadFileOption, 'url' | 'he
   /** 库自定义：请求基础地址 */
   baseURL?: string;
   /** 库自定义：headers支持对象或者返回对象的工厂函数 */
-  headers?: Record<string, string> | ((ctx: RequestConfig & { headers?: Record<string, string> }) => Record<string, string>);
+  headers?: Record<string, string> | ((ctx: RuntimeHeadersCtx<DownloadConfig>) => Record<string, string>);
   [key: string]: any;
 };
 
@@ -337,7 +352,7 @@ export declare const CancelToken: {
  */
 export declare function promisifyRequest(
   type: 'request' | 'uploadFile' | 'downloadFile',
-  opts: RequestConfig
+  opts: NormalizeReqConfig
 ): Promise<UniAnyResult>;
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "utils-uniapp",
-  "version": "1.1.20",
+  "version": "1.1.21",
   "description": "aubyn's utils for uniapp",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",