qsh-webview-sdk 2.0.3 → 2.0.5

package/README.md

@@ -1,6 +1,6 @@
-# UniApp WebView SDK
+# QSH WebView SDK
 
-一个重构后的 UniApp WebView SDK，支持微信小程序和 APP 端的 WebView 与原生端通信。
+一个重构后的 QSH WebView SDK，支持微信小程序和 APP 端的 WebView 与原生端通信。
 
 ## 特性
 
@@ -22,7 +22,7 @@ npm install qsh-webview-sdk
 ### CDN 引入
 
 ```html
-<script src="path/to/uni-webview.umd.js"></script>
+<script src="path/to/qsh-webview-sdk.umd.js"></script>
 ```
 
 ## 使用方法
@@ -37,10 +37,15 @@ npm install qsh-webview-sdk
   }
 </script>
 
-<!-- 引入 UniApp WebView SDK -->
-<script type="text/javascript" src="path/to/uni-webview.umd.js"></script>
+<!-- 引入 QSH WebView SDK -->
+<script type="text/javascript" src="path/to/qsh-webview-sdk.umd.js"></script>
 ```
 
+### 初始化
+
+- SDK 会在 DOM 就绪后自动初始化，并触发 `UniAppJSBridgeReady` 事件。
+- 可使用 `qsh.ready()` 等待准备完成；如需控制时机，可手动调用 `qsh.init()`。
+
 ### 基础使用
 
 ```javascript
@@ -115,6 +120,45 @@ console.log('是否微信小程序:', env.isWeixinMiniProgram);
 console.log('是否 APP:', env.isAppPlus);
 ```
 
+### 加密能力（SM2/SM3/SM4）
+
+- 已内置并通过 `qsh.crypto` 暴露以下能力：`sm2`（密钥对/加解密/签名验签）、`sm3`（杂凑/HMAC）、`sm4`（对称加解密）。
+- 参考实现来源：[miniprogram-sm-crypto（GitHub）](https://github.com/wechat-miniprogram/sm-crypto)。
+
+#### ESM 使用
+
+```javascript
+import qsh from 'qsh-webview-sdk';
+
+// SM3 杂凑
+const hash = qsh.crypto.sm3Hash('abc');
+
+// SM2：生成密钥对 + 签名 + 验签（示例使用 DER 编码）
+const { publicKey, privateKey } = qsh.crypto.sm2GenerateKeyPair();
+const sig = qsh.crypto.sm2Sign('hello sm2', privateKey, { der: true });
+const ok = qsh.crypto.sm2Verify('hello sm2', sig, publicKey, { der: true });
+
+// SM4：默认 ECB + pkcs#7 填充
+const key = '0123456789abcdeffedcba9876543210';
+const cipher = qsh.crypto.sm4Encrypt('hello', key);
+const plain = qsh.crypto.sm4Decrypt(cipher, key);
+```
+
+#### UMD 使用
+
+```html
+<script src="path/to/qsh-webview-sdk.umd.js"></script>
+<script>
+  // 直接通过全局 qsh 访问
+  const hash = window.qsh.crypto.sm3Hash('abc');
+</script>
+```
+
+提示：
+- SM2 默认使用 C1C3C2（cipherMode=1）。与其他工具互通时请确保模式一致。
+- SM4 支持 ECB/CBC 等模式；CBC 需提供 `iv`。
+- 如需数组输入/输出，可通过 `options.output = 'array'` 控制（与上游库一致）。
+
 ## API 文档
 
 ### 导航 API
@@ -134,6 +178,10 @@ console.log('是否 APP:', env.isAppPlus);
 | `postMessage` | 向原生端发送消息 | `{ data?: any }` |
 | `getEnv` | 获取当前环境信息 | `callback: Function` |
 
+### 加密 API
+
+- 通过 `qsh.crypto` 使用加密能力，详情与示例参见上文“加密能力（SM2/SM3/SM4）”。
+
 ### 环境属性
 
 | 属性 | 类型 | 说明 |
@@ -169,8 +217,10 @@ npm run build
 
 项目包含以下示例文件：
 
+- `example/index.html` - 入口示例
 - `example/test.html` - 完整的测试页面，包含所有功能演示
 - `example/simple.html` - 简单示例，展示基础用法
+- `example/npm-usage.html` - 以 ESModule 方式演示，包括加密能力示例
 - `test.html` - 快速测试页面
 
 ## 项目结构
@@ -186,7 +236,8 @@ src/
 │   └── app.js          # APP 端
 ├── api/                # API 接口
 │   ├── navigation.js   # 导航 API
-│   └── message.js      # 消息 API
+│   ├── message.js      # 消息 API
+│   └── crypto.js       # 加密 API（SM2/SM3/SM4）
 ├── index.js            # 主入口
 └── index.d.ts          # 类型定义
 ```

package/dist/index.d.ts

@@ -90,6 +90,26 @@ declare namespace UniWebView {
     ready(): Promise<void>;
     /** WebView 对象（兼容旧版本） */
     webView: WebView | null;
+    /** 加密 API（SM2/SM3/SM4） */
+    crypto: {
+      // SM2
+      sm2GenerateKeyPair(random?: any): { publicKey: string; privateKey: string };
+      sm2Encrypt(message: string | number[], publicKey: string, cipherMode?: 0 | 1, options?: Record<string, any>): string | number[];
+      sm2Decrypt(cipherText: string | number[], privateKey: string, cipherMode?: 0 | 1, options?: { output?: 'array' | 'string' }): string | number[];
+      sm2Sign(message: string | number[], privateKey: string, options?: Record<string, any>): string;
+      sm2Verify(message: string | number[], signatureHex: string, publicKey: string, options?: Record<string, any>): boolean;
+      sm2GetPublicKey(privateKey: string): string;
+      sm2GetPoint(): any;
+      sm2CompressPublicKey(publicKey: string): string;
+      sm2ComparePublicKey(a: string, b: string): boolean;
+      sm2VerifyPublicKey(publicKey: string): boolean;
+      // SM3
+      sm3Hash(message: string | number[], options?: { key?: string | number[] }): string;
+      // SM4
+      sm4Encrypt(message: string | number[], key: string | number[], options?: { padding?: 'pkcs#7' | 'pkcs#5' | 'none'; output?: 'array' | 'string'; mode?: 'ecb' | 'cbc'; iv?: string | number[] }): string | number[];
+      sm4Decrypt(cipherText: string | number[], key: string | number[], options?: { padding?: 'pkcs#7' | 'pkcs#5' | 'none'; output?: 'array' | 'string'; mode?: 'ecb' | 'cbc'; iv?: string | number[] }): string | number[];
+      __raw__: any;
+    };
   }
 }