@hlw-uni-mp/request 1.0.5 → 1.0.8

package/dist/index.d.mts

@@ -2,52 +2,56 @@
  * 设备信息定义
  */
 interface DeviceInfo {
-	appid: string
-	appName: string
-	version: string
-	versionCode: string
-	channel: string
-	deviceId: string
-	deviceType: string
-	deviceOrientation: 'portrait' | 'landscape'
-	brand: string
-	model: string
-	system: string
-	os: string
-	pixelRatio: number
-	screenWidth: number
-	screenHeight: number
-	windowWidth: number
-	windowHeight: number
-	statusBarHeight: number
-	sdkVersion: string
-	hostName: string
-	hostVersion: string
-	hostLanguage: string
-	hostTheme: string
-	platform: string
-	language: string
-	networkType: string
-	benchmarkLevel: number
-	theme: string
-	fontSizeSetting: number
+    appid: string;
+    appName: string;
+    version: string;
+    versionCode: string;
+    channel: string;
+    deviceId: string;
+    deviceType: string;
+    deviceOrientation: 'portrait' | 'landscape';
+    brand: string;
+    model: string;
+    system: string;
+    os: string;
+    pixelRatio: number;
+    screenWidth: number;
+    screenHeight: number;
+    windowWidth: number;
+    windowHeight: number;
+    statusBarHeight: number;
+    sdkVersion: string;
+    hostName: string;
+    hostVersion: string;
+    hostLanguage: string;
+    hostTheme: string;
+    platform: string;
+    language: string;
+    networkType: string;
+    benchmarkLevel: number;
+    theme: string;
+    fontSizeSetting: number;
 }
-
 declare global {
-	namespace UniNamespace {
-		interface GetDeviceInfoResult {
-			benchmarkLevel?: number
-		}
-		interface GetAppBaseInfoResult {
-			appChannel?: string
-			appLanguage?: string
-			fontSizeSetting?: number
-		}
-		interface GetWindowInfoResult {
-			deviceOrientation?: 'portrait' | 'landscape'
-		}
-	}
+    namespace UniNamespace {
+        interface GetDeviceInfoResult {
+            benchmarkLevel?: number;
+        }
+        interface GetAppBaseInfoResult {
+            appChannel?: string;
+            appLanguage?: string;
+            fontSizeSetting?: number;
+        }
+        interface GetWindowInfoResult {
+            deviceOrientation?: 'portrait' | 'landscape';
+        }
+    }
 }
+/**
+ * 采集设备信息
+ * @returns 设备参数集
+ */
+declare function getDevice(): DeviceInfo;
 
 /**
  * SHA-256 哈希计算 (基于 crypto-js)
@@ -75,31 +79,49 @@ declare function calculateSign(options: SignOptions): string;
 type HttpMethod = 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'CONNECT'
 
 /**
- * 请求配置项
+ * 请求配置选项
  */
 interface RequestConfig {
+	/** 请求相对路径或完整 URL */
 	url: string
+	/** 请求方法，默认 GET */
 	method?: HttpMethod | string
+	/** 请求体数据 (POST/PUT) */
 	data?: unknown
+	/** URL 查询参数 (GET/DELETE) */
 	params?: unknown
+	/** 基础接口地址 */
 	baseURL?: string
+	/** 自定义请求头 */
 	headers?: Record<string, string>
+	/** 超时时间 (毫秒)，默认 15000 */
 	timeout?: number
 }
 
+/** 兼容别名 */
+type HttpConfig = RequestConfig
+
 /**
- * 响应数据包
+ * HTTP 原始响应包
  */
-interface AxiosResponse<T = unknown> {
+interface HttpResponse<T = unknown> {
+	/** 响应数据主体 */
 	data: T
+	/** HTTP 状态码 */
 	status: number
+	/** 状态文本 */
 	statusText: string
+	/** 响应头字典 */
 	headers: Record<string, string>
+	/** 请求配置项 */
 	config: RequestConfig
 }
 
+/** 兼容别名 */
+type AxiosResponse<T = unknown> = HttpResponse<T>
+
 /**
- * 拦截处理器
+ * 拦截器处理器
  */
 interface InterceptorHandler<T> {
 	fulfilled?: (value: T) => T | Promise<T>
@@ -110,69 +132,43 @@ interface InterceptorHandler<T> {
  * 接口业务数据扩展标记（供各业务项目通过声明合并自由扩展）
  */
 interface ApiResData {
-	/**
-	 * 模态弹窗配置
-	 */
+	/** 模态弹窗配置 */
 	modal?: UniApp.ShowModalOptions
 }
 
 /**
- * 接口响应表
+ * 统一接口返回数据结构
  */
 interface ApiRes<T = unknown> {
-	/**
-	 * 状态码数值 (1 为成功)
-	 */
+	/** 业务状态码 (1 为成功) */
 	code: number
-	/**
-	 * 提示文本串
-	 */
+	/** 提示消息文本 */
 	msg: string
-	/**
-	 * 数据业务体
-	 */
+	/** 核心业务数据体 */
 	data: T & ApiResData
-	/**
-	 * 是否弹窗提示
-	 */
+	/** 是否弹窗提示 */
 	modal?: boolean
-	/**
-	 * 模态弹窗配置
-	 */
+	/** 模态弹窗配置项 */
 	modalOptions?: UniApp.ShowModalOptions
 }
 
 /**
- * 请求配置项
+ * 全局网络请求配置选项
  */
 interface HttpOptions {
-	/**
-	 * 基础接口路由
-	 */
+	/** 接口基础 URL 地址 */
 	baseURL?: string
-	/**
-	 * 超时时间数值 (ms)
-	 */
+	/** 请求超时时间 (毫秒)，默认 15000 */
 	timeout?: number
-	/**
-	 * 获取凭证函数
-	 */
+	/** 动态获取当前用户登录凭证 (Token) */
 	getToken?: () => string
-	/**
-	 * 获取设备函数
-	 */
+	/** 动态获取设备指纹上下文信息 */
 	getDevice?: () => DeviceInfo | Record<string, unknown>
-	/**
-	 * 鉴权失败回调
-	 */
+	/** 登录失效 (401/403) 统一回调处理 */
 	onUnauthorized?: (message: string) => void
-	/**
-	 * RSA 公钥（用于非对称加密 X-Client-Context）
-	 */
+	/** RSA 加密公钥（用于加密 X-Client-Context） */
 	publicKey?: string
-	/**
-	 * 签名密钥（用于计算 X-Client-Sign）
-	 */
+	/** 请求签名密钥（用于计算 X-Client-Sign） */
 	secret?: string
 }
 
@@ -187,14 +183,14 @@ interface UploadSignBase {
 }
 
 /**
- * 本地上传凭据
+ * 本地存储上传凭据
  */
 interface LocalUploadSign extends UploadSignBase {
 	type: 'local'
 }
 
 /**
- * 阿里存储凭据（严格遵循阿里云 PostObject 规范单一属性名）
+ * 阿里云 OSS 上传凭据
  */
 interface AliossUploadSign extends UploadSignBase {
 	type: 'alioss'
@@ -205,7 +201,7 @@ interface AliossUploadSign extends UploadSignBase {
 }
 
 /**
- * 七牛存储凭据
+ * 七牛云上传凭据
  */
 interface QiniuUploadSign extends UploadSignBase {
 	type: 'qiniu'
@@ -213,57 +209,28 @@ interface QiniuUploadSign extends UploadSignBase {
 }
 
 /**
- * 联合存储凭据
+ * 统一上传签名凭据联合类型
  */
 type UploadSign = LocalUploadSign | AliossUploadSign | QiniuUploadSign
 
 /**
- * 文件上传参数
+ * 文件直传参数配置
  */
 interface UploadFileParams {
-	/** 业务场景标识 */
+	/** 业务场景标识 (如 avatar, poster 等) */
 	biz: string
 	/** 本地文件路径 */
 	filePath: string
-	/** 文件格式后缀 */
+	/** 文件扩展名 (如 png, jpg) */
 	ext?: string
-	/** 文件字节大小 */
+	/** 文件大小 (字节) */
 	size?: number
-	/** 签名接口路径 */
+	/** 获取上传签名的接口地址，默认 /api/v1.upload/sign */
 	signUrl?: string
 	/** 自定义请求头 */
 	header?: Record<string, string>
 }
 
-/**
- * 阿里配置项
- */
-interface OssConfig {
-	/** 对象存储键 */
-	key?: string
-	/** 上传策略串 */
-	policy?: string
-	/** 身份标识符 */
-	OSSAccessKeyId?: string
-	/** 签名密文字 */
-	signature?: string
-	/** 主机服务址 */
-	host?: string
-	/** 文件访问址 */
-	url?: string
-	/** 目标文件名 */
-	filename?: string
-	/** 成功响应状态码 */
-	successActionStatus?: string
-	[key: string]: unknown
-}
-
-/**
- * 采集设备信息
- * @returns 设备参数集
- */
-declare function getDevice(): DeviceInfo;
-
 /**
  * 纯 TypeScript 实现的 RSA-2048 公钥分段加密（PKCS#1 v1.5 填充）
  * 零第三方外部依赖，原生兼容小程序、浏览器与 Node 环境
@@ -276,17 +243,6 @@ declare function getDevice(): DeviceInfo;
  */
 declare function encryptRsa(plaintext: string, publicKey: string): string;
 
-/**
- * 直传阿里云 OSS
- * @param oss 阿里配置项
- * @param source 源文件路径或文件对象
- * @returns 资源访问地址
- */
-declare function uploadOss(oss: OssConfig, source: string | {
-    path?: string;
-    tempFilePath?: string;
-}): Promise<string>;
-
 /**
  * 请求上传凭证
  * @param data 签名请求参数
@@ -317,83 +273,69 @@ declare function uploadFile(params: UploadFileParams): Promise<string>;
  * 统一网络请求异常类
  */
 declare class HttpError<T = unknown> extends Error {
-    response?: AxiosResponse<T>;
+    response?: HttpResponse<T>;
     status?: number;
     config?: RequestConfig;
     constructor(message: string, options?: {
-        response?: AxiosResponse<T>;
+        response?: HttpResponse<T>;
         status?: number;
         config?: RequestConfig;
     });
 }
-/**
- * 拦截管理器
- */
-declare class InterceptorManager<T> {
-    private handlers;
-    use(fulfilled?: (value: T) => T | Promise<T>, rejected?: (error: unknown) => unknown): number;
-    eject(id: number): void;
-    forEach(fn: (handler: InterceptorHandler<T>) => void): void;
-}
-/**
- * 原生请求客户端
- */
-declare class UniHttpClient {
-    defaults: {
-        baseURL: string;
-        timeout: number;
-        headers: Record<string, string>;
-    };
-    interceptors: {
-        request: InterceptorManager<RequestConfig>;
-        response: InterceptorManager<AxiosResponse<unknown>>;
-    };
-    constructor(options?: {
-        baseURL?: string;
-        timeout?: number;
-        headers?: Record<string, string>;
-    });
-    request<T = unknown>(config: RequestConfig): Promise<AxiosResponse<T>>;
-    get<T = unknown>(url: string, config?: Partial<RequestConfig>): Promise<AxiosResponse<T>>;
-    post<T = unknown>(url: string, data?: unknown, config?: Partial<RequestConfig>): Promise<AxiosResponse<T>>;
-    put<T = unknown>(url: string, data?: unknown, config?: Partial<RequestConfig>): Promise<AxiosResponse<T>>;
-    delete<T = unknown>(url: string, config?: Partial<RequestConfig>): Promise<AxiosResponse<T>>;
-    private resolveUrl;
-    private send;
-}
-/**
- * 获取请求实例
- */
-declare function getClient(): UniHttpClient;
-/**
- * 初始化配置网络请求
- */
-declare function setupHttp(options?: Partial<HttpOptions>): UniHttpClient;
 /**
  * 发送通用请求
  */
 declare function request<T = unknown>(config: RequestConfig): Promise<ApiRes<T>>;
 /**
- * 发送 GET 读取请求
+ * 发送 GET 请求
  */
-declare function get<T = unknown>(url: string, params?: unknown): Promise<ApiRes<T>>;
+declare function get<T = unknown>(url: string, params?: unknown, config?: Partial<RequestConfig>): Promise<ApiRes<T>>;
 /**
  * 发送 POST 提交请求
  */
-declare function post<T = unknown>(url: string, data?: unknown): Promise<ApiRes<T>>;
+declare function post<T = unknown>(url: string, data?: unknown, config?: Partial<RequestConfig>): Promise<ApiRes<T>>;
 /**
  * 发送 PUT 修改请求
  */
-declare function put<T = unknown>(url: string, data?: unknown): Promise<ApiRes<T>>;
+declare function put<T = unknown>(url: string, data?: unknown, config?: Partial<RequestConfig>): Promise<ApiRes<T>>;
 /**
  * 发送 DELETE 删除请求
  */
-declare function del<T = unknown>(url: string, params?: unknown): Promise<ApiRes<T>>;
+declare function del<T = unknown>(url: string, params?: unknown, config?: Partial<RequestConfig>): Promise<ApiRes<T>>;
+/**
+ * 统一 HTTP 请求客户端门面
+ */
+declare const http: {
+    request: typeof request;
+    get: typeof get;
+    post: typeof post;
+    put: typeof put;
+    delete: typeof del;
+    del: typeof del;
+    setup: typeof setupHttp;
+    getOptions: typeof getHttpOptions;
+};
+declare const client: {
+    request: typeof request;
+    get: typeof get;
+    post: typeof post;
+    put: typeof put;
+    delete: typeof del;
+    del: typeof del;
+    setup: typeof setupHttp;
+    getOptions: typeof getHttpOptions;
+};
+/**
+ * 获取请求客户端
+ */
+declare function getClient(): typeof http;
+/**
+ * 初始化配置网络请求
+ */
+declare function setupHttp(options?: Partial<HttpOptions>): typeof http;
 /**
  * 获取全局网络配置
  */
 declare function getHttpOptions(): HttpOptions;
-declare const client: UniHttpClient;
-declare const http: UniHttpClient;
 
-export { type AliossUploadSign, type ApiRes, type ApiResData, type AxiosResponse, type DeviceInfo, HttpError, type HttpMethod, type HttpOptions, type InterceptorHandler, InterceptorManager, type LocalUploadSign, type OssConfig, type QiniuUploadSign, type RequestConfig, type SignOptions, UniHttpClient, type UploadFileParams, type UploadSign, type UploadSignBase, calculateSign, client, request as default, del, doUpload, encryptRsa, get, getClient, getDevice, getHttpOptions, http, post, postUploadSign, put, request, setupHttp, sha256, sortString, uploadFile, uploadOss };
+export { type AliossUploadSign, type ApiRes, type ApiResData, type AxiosResponse, type DeviceInfo, type HttpConfig, HttpError, type HttpMethod, type HttpOptions, type HttpResponse, type InterceptorHandler, type LocalUploadSign, type QiniuUploadSign, type RequestConfig, type SignOptions, type UploadFileParams, type UploadSign, type UploadSignBase, calculateSign, client, request as default, del, doUpload, encryptRsa, get, getClient, getDevice, getHttpOptions, http, post, postUploadSign, put, request, setupHttp, sha256, sortString, uploadFile };