@hlw-uni-mp/request 1.0.0

package/README.md

@@ -0,0 +1,101 @@
+# @hlw-uni-mp/request
+
+基于 uni-app 的极简轻量级 HTTP 请求与文件直传客户端，内置 RSA-2048 非对称加密与请求防篡改验签能力。
+
+## 特性
+
+- **轻量易用**：类似 Axios 的 API 设计，开箱即用，支持 Promise
+- **防篡改与安全**：内置 RSA 公钥加密与 SHA-256 数据签名机制，无缝对接后端接口验签规范
+- **全平台设备采集**：自动采集平台、系统、版本与网络状态并注入请求头
+- **拦截器支持**：支持请求前拦截与响应后处理，方便统一注入 Token 或错误兜底
+- **文件直传支持**：内置本地直传、阿里云 OSS 与七牛云直传能力
+- **强类型约束**：全 TypeScript 编写，完备的类型推导与接口响应声明
+
+---
+
+## 安装
+
+```bash
+# pnpm
+pnpm add @hlw-uni-mp/request
+
+# npm
+npm install @hlw-uni-mp/request
+```
+
+---
+
+## 快速上手
+
+### 1. 初始化网络配置
+
+```ts
+import { setupHttp } from "@hlw-uni-mp/request";
+
+setupHttp({
+    baseURL: "https://api.example.com",
+    timeout: 15000,
+    publicKey: "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...", // RSA 公钥
+    secret: "your-sign-secret",                                    // 验签密钥
+    getToken: () => uni.getStorageSync("token") || "",
+    onUnauthorized: (msg) => {
+        // 登录失效处理
+    },
+});
+```
+
+---
+
+### 2. 接口请求调用
+
+#### 快捷方式（get / post / put / del）
+
+```ts
+import { get, post, request } from "@hlw-uni-mp/request";
+
+// GET 请求
+export function fetchUserInfo() {
+    return get("/api/v1.user/info");
+}
+
+// POST 请求
+export function submitOrder(data: { goodsId: number; num: number }) {
+    return post("/api/v1.order/create", data);
+}
+
+// 通用 request
+export function customRequest() {
+    return request({
+        url: "/api/v1.data/list",
+        method: "POST",
+        data: { page: 1 },
+    });
+}
+```
+
+#### 客户端实例方式（http / client）
+
+```ts
+import { http } from "@hlw-uni-mp/request";
+
+const response = await http.get("/api/v1.config");
+```
+
+---
+
+### 3. 文件上传
+
+```ts
+import { uploadFile } from "@hlw-uni-mp/request";
+
+const fileUrl = await uploadFile({
+    biz: "avatar",
+    filePath: tempFilePath,
+});
+```
+
+---
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,375 @@
+/**
+ * 设备信息定义
+ */
+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
+}
+
+/**
+ * SHA-256 哈希计算 (基于 crypto-js)
+ */
+declare function sha256(rawInput: string): string;
+/**
+ * 递归规范化参数排序串（与后端 1:1 对齐）
+ */
+declare function sortString(data: any): string;
+interface SignOptions {
+    timestamp: string | number;
+    nonce: string;
+    context: string;
+    secret?: string;
+    data?: any;
+}
+/**
+ * 计算请求防篡改签名
+ */
+declare function calculateSign(options: SignOptions): string;
+
+/**
+ * 请求配置项
+ */
+interface RequestConfig {
+	url: string
+	method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | string
+	data?: unknown
+	params?: unknown
+	baseURL?: string
+	headers?: Record<string, string>
+	timeout?: number
+}
+
+/**
+ * 响应数据包
+ */
+interface AxiosResponse<T = any> {
+	data: T
+	status: number
+	statusText: string
+	headers: Record<string, string>
+	config: RequestConfig
+}
+
+/**
+ * 拦截处理器
+ */
+interface InterceptorHandler<T> {
+	fulfilled?: (value: T) => T | Promise<T>
+	rejected?: (error: any) => any
+}
+
+/**
+ * 模态弹窗配置
+ */
+interface ModalOptions {
+	title?: string
+	content?: string
+	confirmText?: string
+	cancelText?: string
+	showCancel?: boolean
+	[key: string]: unknown
+}
+
+/**
+ * 接口业务数据扩展标记（供各业务项目通过声明合并自由扩展）
+ */
+interface ApiResData {
+	/**
+	 * 模态弹窗配置
+	 */
+	modal?: ModalOptions
+}
+
+/**
+ * 接口响应表
+ */
+interface ApiRes<T = any> {
+	/**
+	 * 状态码数值 (1 为成功)
+	 */
+	code: number
+	/**
+	 * 提示文本串
+	 */
+	msg: string
+	/**
+	 * 数据业务体
+	 */
+	data: T & ApiResData
+	/**
+	 * 是否弹窗提示
+	 */
+	modal?: boolean
+	/**
+	 * 模态弹窗配置
+	 */
+	modalOptions?: ModalOptions
+}
+
+/**
+ * 请求配置项
+ */
+interface HttpOptions {
+	/**
+	 * 基础接口路由
+	 */
+	baseURL?: string
+	/**
+	 * 超时时间数值 (ms)
+	 */
+	timeout?: number
+	/**
+	 * 获取凭证函数
+	 */
+	getToken?: () => string
+	/**
+	 * 获取设备函数
+	 */
+	getDevice?: () => DeviceInfo | Record<string, any>
+	/**
+	 * 鉴权失败回调
+	 */
+	onUnauthorized?: (message: string) => void
+	/**
+	 * RSA 公钥（用于非对称加密 X-Client-Context）
+	 */
+	publicKey?: string
+	/**
+	 * 签名密钥（用于计算 X-Client-Sign）
+	 */
+	secret?: string
+}
+
+/**
+ * 基础上传凭据
+ */
+interface UploadSignBase {
+	type: 'local' | 'alioss' | 'qiniu'
+	key: string
+	url: string
+	server: string
+}
+
+/**
+ * 本地上传凭据
+ */
+interface LocalUploadSign extends UploadSignBase {
+	type: 'local'
+}
+
+/**
+ * 阿里存储凭据
+ */
+interface AliossUploadSign extends UploadSignBase {
+	type: 'alioss'
+	OSSAccessKeyId: string
+	policy: string
+	Signature: string
+	success_action_status: string
+	oSSAccessKeyId?: string
+	signature?: string
+	successActionStatus?: string
+}
+
+/**
+ * 七牛存储凭据
+ */
+interface QiniuUploadSign extends UploadSignBase {
+	type: 'qiniu'
+	token: string
+}
+
+/**
+ * 联合存储凭据
+ */
+type UploadSign = LocalUploadSign | AliossUploadSign | QiniuUploadSign
+
+/**
+ * 文件上传参数
+ */
+interface UploadFileParams {
+	/** 业务场景标识 */
+	biz: string
+	/** 本地文件路径 */
+	filePath: string
+	/** 文件格式后缀 */
+	ext?: string
+	/** 文件字节大小 */
+	size?: number
+	/** 签名接口路径 */
+	signUrl?: string
+	/** 自定义请求头 */
+	header?: Record<string, string>
+}
+
+/**
+ * 阿里配置项
+ */
+interface OssConfig {
+	/** 对象存储键 */
+	key?: string
+	/** 上传策略串 */
+	policy?: string
+	/** 身份标识符 */
+	OSSAccessKeyId?: string
+	/** 签名密文字 */
+	signature?: string
+	/** 主机服务址 */
+	host?: string
+	/** 文件访问址 */
+	url?: string
+	/** 目标文件名 */
+	filename?: string
+	[key: string]: unknown
+}
+
+/**
+ * 采集设备信息
+ * @returns 设备参数集
+ */
+declare function getDevice(): DeviceInfo;
+
+/**
+ * 纯 TypeScript 实现的 RSA-2048 公钥分段加密（PKCS#1 v1.5 填充）
+ * 零第三方外部依赖，原生兼容小程序、浏览器与 Node 环境
+ */
+/**
+ * RSA-2048 公钥分段加密
+ * @param plaintext 明文字符串（支持 UTF-8 多字节）
+ * @param publicKey PEM 格式或纯 Base64 公钥
+ * @returns 密文 Base64 编码
+ */
+declare function encryptRsa(plaintext: string, publicKey: string): string;
+
+/**
+ * 直传阿里云 OSS
+ * @param oss 阿里配置项
+ * @param source 源文件路径或文件对象
+ * @returns 资源访问地址
+ */
+declare function uploadOss(oss: OssConfig, source: string | any): Promise<string>;
+
+/**
+ * 请求上传凭证
+ * @param data 签名请求参数
+ * @param signUrl 签名接口地址
+ * @returns 上传签名凭据
+ */
+declare function postUploadSign(data: {
+    biz: string;
+    ext: string;
+    size?: number;
+}, signUrl?: string): Promise<ApiRes<UploadSign>>;
+/**
+ * 执行文件直传
+ * @param cred 上传签名凭据
+ * @param filePath 本地文件路径
+ * @param customHeader 额外请求头
+ * @returns 直传异步项
+ */
+declare function doUpload(cred: UploadSign, filePath: string, customHeader?: Record<string, string>): Promise<void>;
+/**
+ * 统一直传文件
+ * @param params 文件上传参数
+ * @returns 文件网络地址
+ */
+declare function uploadFile(params: UploadFileParams): Promise<string>;
+
+/**
+ * 拦截管理器
+ */
+declare class InterceptorManager<T> {
+    private handlers;
+    use(fulfilled?: (value: T) => T | Promise<T>, rejected?: (error: any) => any): 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<any>>;
+    };
+    constructor(options?: {
+        baseURL?: string;
+        timeout?: number;
+        headers?: Record<string, string>;
+    });
+    request<T = any>(config: RequestConfig): Promise<AxiosResponse<T>>;
+    get<T = any>(url: string, config?: Partial<RequestConfig>): Promise<AxiosResponse<T>>;
+    post<T = any>(url: string, data?: unknown, config?: Partial<RequestConfig>): Promise<AxiosResponse<T>>;
+    put<T = any>(url: string, data?: unknown, config?: Partial<RequestConfig>): Promise<AxiosResponse<T>>;
+    delete<T = any>(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 = any>(config: RequestConfig): Promise<ApiRes<T>>;
+/**
+ * 发送 GET 读取请求
+ */
+declare function get<T = any>(url: string, params?: unknown): Promise<ApiRes<T>>;
+/**
+ * 发送 POST 提交请求
+ */
+declare function post<T = any>(url: string, data?: unknown): Promise<ApiRes<T>>;
+/**
+ * 发送 PUT 修改请求
+ */
+declare function put<T = any>(url: string, data?: unknown): Promise<ApiRes<T>>;
+/**
+ * 发送 DELETE 删除请求
+ */
+declare function del<T = any>(url: string, params?: unknown): Promise<ApiRes<T>>;
+/**
+ * 获取全局网络配置
+ */
+declare function getHttpOptions(): HttpOptions;
+declare const client: UniHttpClient;
+declare const http: UniHttpClient;
+
+export { type AliossUploadSign, type ApiRes, type ApiResData, type AxiosResponse, type DeviceInfo, type HttpOptions, type InterceptorHandler, InterceptorManager, type LocalUploadSign, type ModalOptions, 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 };