ms-vite-plugin 1.1.2 → 1.1.4

package/docs/api/appleocr.md

@@ -0,0 +1,229 @@
+# AppleOCR 模块
+
+AppleOCR 模块基于 Apple Vision 框架，提供原生的光学字符识别（OCR）功能。该模块利用 iOS 系统内置的机器学习能力，无需额外模型文件，具有高效、准确的特点。
+
+<span style="color: red;">此模块仅支持 iOS 系统。</span>
+
+## 核心特性
+
+### 🚀 性能优势
+
+- **原生支持**: 基于 Apple Vision 框架，无需额外模型文件
+- **高性能**: 利用 iOS 系统优化，识别速度快
+- **低资源占用**: 无需加载大型模型文件
+
+### 🌍 多语言支持
+
+- **默认语言**: 中文和英文（["zh-Hans", "en-US"]）
+- **支持语言**: ["en-US", "fr-FR", "it-IT", "de-DE", "es-ES", "pt-BR", "zh-Hans", "zh-Hant"]
+
+### 📱 多种输入源
+
+- **屏幕截图**: 直接识别当前屏幕内容
+- **图片文件**: 支持本地图片文件路径
+- **图片 ID**: 通过 image 模块获取的图片 ID
+- **区域识别**: 支持指定区域的精确文字识别
+
+## 数据类型
+
+### OCRResult
+
+识别结果对象，包含以下属性：
+
+```typescript
+interface OCRResult {
+  text: string; // 识别的文本内容
+  confidence: number; // 识别置信度 (0-1)
+  x: number; // 文本区域左上角 x 坐标
+  y: number; // 文本区域左上角 y 坐标
+  width: number; // 文本区域宽度
+  height: number; // 文本区域高度
+  ex: number; // 文本区域右下角 x 坐标
+  ey: number; // 文本区域右下角 y 坐标
+  centerX: number; // 文本区域中心点 x 坐标
+  centerY: number; // 文本区域中心点 y 坐标
+}
+```
+
+**字段说明：**
+| 参数名 | 类型 | 描述 |
+| ------------- | ----------- | ---------------------- |
+| `text` | string | 识别的文本内容 |
+| `confidence` | number | 识别置信度 (0-1)，值越高表示识别越准确 |
+| `x`, `y` | number | 文本区域左上角坐标 |
+| `width`, `height` | number | 文本区域宽度和高度 |
+| `ex`, `ey` | number | 文本区域右下角坐标 |
+| `centerX`, `centerY` | number | 文本区域中心点坐标 |
+
+## API 参考
+
+### 文字识别
+
+#### recognize
+
+执行通用 OCR 文字识别，支持多种输入源和指定识别区域。
+
+```typescript
+function recognize(
+  input: string,
+  x?: number,
+  y?: number,
+  ex?: number,
+  ey?: number,
+  languages?: string[],
+): OCRResult[];
+```
+
+**参数:**
+
+| 参数名      | 类型     | 是否必填 | 默认值               | 描述                                                                                                                                     |
+| ----------- | -------- | -------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| `input`     | string   | 是       | -                    | 输入源，支持以下类型：<br>- `"screen"` - 当前屏幕截图<br>- `string` - 图片文件路径或 URL<br>- `imageId` - 图片 ID（通过 image 模块获取） |
+| `x`         | number   | 否       | -                    | 识别区域左上角 x 坐标                                                                                                                    |
+| `y`         | number   | 否       | -                    | 识别区域左上角 y 坐标                                                                                                                    |
+| `ex`        | number   | 否       | -                    | 识别区域右下角 x 坐标                                                                                                                    |
+| `ey`        | number   | 否       | -                    | 识别区域右下角 y 坐标                                                                                                                    |
+| `languages` | string[] | 否       | ["zh-Hans", "en-US"] | 可选，指定识别语言列表，如 ["zh-Hans", "en-US"]                                                                                          |
+
+**返回值:**
+
+| 类型        | 描述                   |
+| ----------- | ---------------------- |
+| OCRResult[] | 匹配的文本识别结果数组 |
+
+**使用示例:**
+
+```javascript
+// 识别整个屏幕
+const fullScreenResults = appleOcr.recognize("screen", 0, 0, 0, 0);
+logi(`识别到 ${fullScreenResults.length} 个文本区域`);
+fullScreenResults.forEach((result, index) => {
+  logi(`文本 ${index + 1}: ${result.text} (置信度: ${result.confidence})`);
+  logi(`位置: (${result.x}, ${result.y}) - (${result.ex}, ${result.ey})`);
+  logi(`中心点: (${result.centerX}, ${result.centerY})`);
+});
+
+// 识别屏幕指定区域
+const regionResults = appleOcr.recognize("screen", 100, 100, 500, 300);
+logi(`指定区域识别结果: ${JSON.stringify(regionResults)}`);
+
+// 识别图片文件
+const imageResults = appleOcr.recognize("/path/to/image.png", 0, 0, 800, 600);
+if (imageResults.length > 0) {
+  logi("图片文字识别成功");
+  imageResults.forEach((result) => {
+    logi(`识别文字: ${result.text}`);
+    logi(`区域: ${result.width}x${result.height}`);
+  });
+} else {
+  logi("图片中未识别到文字");
+}
+
+// 指定识别语言
+const chineseResults = appleOcr.recognize("screen", 0, 0, 1920, 1080, [
+  "zh-Hans",
+  "en-US",
+]);
+logi(`中英文识别结果: ${JSON.stringify(chineseResults)}`);
+
+// 识别当前屏幕
+const screenResults = appleOcr.recognize("screen", 0, 0, 1920, 1080);
+logi(`屏幕识别结果: ${JSON.stringify(screenResults)}`);
+```
+
+### 数字识别
+
+#### recognizeNumbers
+
+执行专门的数字 OCR 识别，针对数字识别进行了优化，提高数字识别的准确性。
+
+**支持字符**: 0-9 数字、逗号(,)、小数点(.)、加号(+)、减号(-)
+
+```typescript
+function recognizeNumbers(
+  input: string,
+  x?: number,
+  y?: number,
+  ex?: number,
+  ey?: number,
+): OCRResult[];
+```
+
+**参数:**
+
+| 参数名  | 类型   | 是否必填 | 默认值 | 描述                                                                                                                                 |
+| ------- | ------ | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `input` | string | 是       | -      | 输入源，支持以下类型： <br>-`"screen"` 当前屏幕截图 <br>- `string` 图片文件路径或 URL <br>- `imageId` 图片 ID（通过 image 模块获取） |
+| `x`     | number | 否       | -      | 识别区域左上角 x 坐标                                                                                                                |
+| `y`     | number | 否       | -      | 识别区域左上角 y 坐标                                                                                                                |
+| `ex`    | number | 否       | -      | 识别区域右下角 x 坐标                                                                                                                |
+| `ey`    | number | 否       | -      | 识别区域右下角 y 坐标                                                                                                                |
+
+**返回值:**
+
+| 类型          | 描述                   |
+| ------------- | ---------------------- |
+| `OCRResult[]` | 匹配的数字识别结果数组 |
+
+**使用示例:**
+
+```javascript
+// 识别屏幕中的数字
+const numberResults = appleOcr.recognizeNumbers("screen", 100, 100, 500, 300);
+logi(`识别到 ${numberResults.length} 个数字区域`);
+
+numberResults.forEach((result, index) => {
+  logi(`数字 ${index + 1}: ${result.text}`);
+  logi(`置信度: ${result.confidence}`);
+  logi(`位置: (${result.centerX}, ${result.centerY})`);
+});
+```
+
+### 文本查找
+
+#### findText
+
+执行指定文本查找，在识别结果中查找特定的文本内容。使用全字匹配模式，确保精确匹配目标文本。
+
+```typescript
+function findText(
+  input: string,
+  texts: string[],
+  x?: number,
+  y?: number,
+  ex?: number,
+  ey?: number,
+  languages?: string[],
+): OCRResult[];
+```
+
+**参数:**
+
+| 参数名      | 类型     | 是否必填 | 默认值               | 描述                                                                                                                                 |
+| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `input`     | string   | 是       | -                    | 输入源，支持以下类型： <br>-`"screen"` 当前屏幕截图 <br>- `string` 图片文件路径或 URL <br>- `imageId` 图片 ID（通过 image 模块获取） |
+| `texts`     | string[] | 是       | -                    | 要查找的文本数组                                                                                                                     |
+| `x`         | number   | 否       | -                    | 识别区域左上角 x 坐标                                                                                                                |
+| `y`         | number   | 否       | -                    | 识别区域左上角 y 坐标                                                                                                                |
+| `ex`        | number   | 否       | -                    | 识别区域右下角 x 坐标                                                                                                                |
+| `ey`        | number   | 否       | -                    | 识别区域右下角 y 坐标                                                                                                                |
+| `languages` | string[] | 否       | ["zh-Hans", "en-US"] | 可选，指定识别语言列表，如 ["zh-Hans", "en-US"]                                                                                      |
+
+**返回值:**
+
+| 类型          | 描述                   |
+| ------------- | ---------------------- |
+| `OCRResult[]` | 匹配的文本识别结果数组 |
+
+**使用示例:**
+
+```javascript
+// 识别屏幕中的文本
+const textResults = appleOcr.findText("screen", ["123", "456"], 0, 0, 100, 100);
+logi(`识别到 ${textResults.length} 个文本区域`);
+textResults.forEach((result, index) => {
+  logi(`文本 ${index + 1}: ${result.text} (置信度: ${result.confidence})`);
+  logi(`位置: (${result.x}, ${result.y}) - (${result.ex}, ${result.ey})`);
+  logi(`中心点: (${result.centerX}, ${result.centerY})`);
+});
+```

package/docs/api/config.md

@@ -0,0 +1,122 @@
+# 配置模块 (Config)
+
+配置模块提供了读取、更新和删除应用配置的功能。
+
+网页的 ms.setConfig 对应 config.set
+
+网页的 ms.getConfig 对应 config.get
+
+网页的 ms.getAllConfig 对应 config.all
+
+网页的 ms.removeConfig 对应 config.remove
+
+## API 参考
+
+### 配置读取
+
+#### get - 读取配置项的值。
+
+```typescript
+function get(key: string): any | null;
+```
+
+**参数:**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 描述     |
+| ------ | ------ | -------- | ------ | -------- |
+| `key`  | string | 是       | -      | 配置键名 |
+
+**返回值:**
+
+| 类型          | 描述   |
+| ------------- | ------ |
+| `any \| null` | 配置值 |
+
+**示例:**
+
+```javascript
+const maxRetries = config.get("maxRetries");
+if (maxRetries !== null) {
+  logi(`最大重试次数: ${maxRetries}`);
+}
+```
+
+### 配置管理
+
+#### all - 获取所有配置的 JSON 格式数据。
+
+```typescript
+function all(): Record<string, any>;
+```
+
+**返回值:**
+
+| 类型                  | 描述               |
+| --------------------- | ------------------ |
+| `Record<string, any>` | 包含所有配置的对象 |
+
+**示例:**
+
+```javascript
+const allConfigs = config.all();
+logi(`所有配置: ${JSON.stringify(allConfigs, null, 2)}`);
+```
+
+#### set - 更新或设置配置项的值。
+
+```typescript
+function set(key: string, value: any): boolean;
+```
+
+**参数:**
+
+| 参数名  | 类型   | 是否必填 | 默认值 | 描述       |
+| ------- | ------ | -------- | ------ | ---------- |
+| `key`   | string | 是       | -      | 配置键名   |
+| `value` | any    | 是       | -      | 新的配置值 |
+
+**返回值:**
+
+| 类型      | 描述         |
+| --------- | ------------ |
+| `boolean` | 更新是否成功 |
+
+**示例:**
+
+```javascript
+// 更新不同类型的配置
+const success1 = config.set("maxRetries", 5);
+const success2 = config.set("apiBaseUrl", "https://api.example.com");
+const success3 = config.set("debugEnabled", true);
+
+if (success1 && success2 && success3) {
+  logi("配置更新成功");
+}
+```
+
+#### remove - 删除指定的配置项。
+
+```typescript
+function remove(key: string): boolean;
+```
+
+**参数:**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 描述             |
+| ------ | ------ | -------- | ------ | ---------------- |
+| `key`  | string | 是       | -      | 要删除的配置键名 |
+
+**返回值:**
+
+| 类型      | 描述         |
+| --------- | ------------ |
+| `boolean` | 删除是否成功 |
+
+**示例:**
+
+```javascript
+const deleted = config.remove("temporaryConfig");
+if (deleted) {
+  logi("临时配置已删除");
+}
+```

package/docs/api/cryptoUtils.md

@@ -0,0 +1,232 @@
+# 加密模块 (CryptoUtils)
+
+加密模块提供了常用的加密和解密功能，支持 AES、RSA 以及 MD5、SHA1、SHA256 等哈希算法。
+
+## 功能概览
+
+- **AES 加解密**: 支持 AES-ECB 模式的加密与解密
+- **RSA 加解密**: 支持 RSA 公钥加密与私钥解密
+- **哈希算法**: 支持 MD5, SHA1, SHA256 消息摘要计算
+
+## API 参考
+
+### AES 加解密
+
+#### encryptWithAES_ECB - 使用 AES ECB 模式加密数据
+
+默认使用 PKCS7 填充。
+
+```typescript
+function encryptWithAES_ECB(
+  data: string,
+  aesKey: string,
+  noPadding?: boolean
+): string;
+```
+
+**参数:**
+
+| 参数名      | 类型    | 是否必填 | 默认值 | 描述                                                                   |
+| ----------- | ------- | -------- | ------ | ---------------------------------------------------------------------- |
+| `data`      | string  | 是       |        | 要加密的数据                                                           |
+| `aesKey`    | string  | 是       |        | AES 密钥，支持 16 位、24 位、32 位字符串                               |
+| `noPadding` | boolean | 否       | false  | 是否禁用填充。`false`: 使用 PKCS7 填充; `true`: 不使用填充 (NoPadding) |
+
+**返回值:**
+
+| 类型     | 描述                             |
+| -------- | -------------------------------- |
+| `string` | 加密后的数据 (Base64 编码字符串) |
+
+**示例:**
+
+```javascript
+const data = "Hello World";
+const key = "1234567890123456"; // 16位密钥
+const encrypted = cryptoUtils.encryptWithAES_ECB(data, key);
+logi(`AES Encrypted: ${encrypted}`);
+```
+
+#### decryptWithAES_ECB - 使用 AES ECB 模式解密数据
+
+默认使用 PKCS7 填充。
+
+```typescript
+function decryptWithAES_ECB(
+  data: string,
+  aesKey: string,
+  noPadding?: boolean
+): string;
+```
+
+**参数:**
+
+| 参数名      | 类型    | 是否必填 | 默认值 | 描述                                                                   |
+| ----------- | ------- | -------- | ------ | ---------------------------------------------------------------------- |
+| `data`      | string  | 是       |        | 要解密的数据 (Base64 编码字符串)                                       |
+| `aesKey`    | string  | 是       |        | AES 密钥，支持 16 位、24 位、32 位字符串                               |
+| `noPadding` | boolean | 否       | false  | 是否禁用填充。`false`: 使用 PKCS7 填充; `true`: 不使用填充 (NoPadding) |
+
+**返回值:**
+
+| 类型     | 描述             |
+| -------- | ---------------- |
+| `string` | 解密后的原始数据 |
+
+**示例:**
+
+```javascript
+const encryptedData = "Base64EncodedString...";
+const key = "1234567890123456";
+const decrypted = cryptoUtils.decryptWithAES_ECB(encryptedData, key);
+logi(`AES Decrypted: ${decrypted}`);
+```
+
+### RSA 加解密
+
+#### encryptWithRSA - 使用 RSA 公钥加密数据
+
+使用 PKCS1 填充。
+
+```typescript
+function encryptWithRSA(data: string, rsaPublicKey: string): string;
+```
+
+**参数:**
+
+| 参数名         | 类型   | 是否必填 | 默认值 | 描述         |
+| -------------- | ------ | -------- | ------ | ------------ |
+| `data`         | string | 是       |        | 要加密的数据 |
+| `rsaPublicKey` | string | 是       |        | RSA 公钥     |
+
+**返回值:**
+
+| 类型     | 描述                             |
+| -------- | -------------------------------- |
+| `string` | 加密后的数据 (Base64 编码字符串) |
+
+**示例:**
+
+```javascript
+const data = "123456";
+const publicKey = `-----BEGIN PUBLIC KEY-----
+公钥内容
+-----END PUBLIC KEY-----
+`;
+const encrypted = cryptoUtils.encryptWithRSA(data, publicKey);
+logi(`RSA Encrypted: ${encrypted}`);
+```
+
+#### decryptWithRSA - 使用 RSA 私钥解密数据
+
+使用 PKCS1 填充。
+
+```typescript
+function decryptWithRSA(data: string, rsaPrivateKey: string): string;
+```
+
+**参数:**
+
+| 参数名          | 类型   | 是否必填 | 默认值 | 描述                             |
+| --------------- | ------ | -------- | ------ | -------------------------------- |
+| `data`          | string | 是       |        | 要解密的数据 (Base64 编码字符串) |
+| `rsaPrivateKey` | string | 是       |        | RSA 私钥                         |
+
+**返回值:**
+
+| 类型     | 描述             |
+| -------- | ---------------- |
+| `string` | 解密后的原始数据 |
+
+**示例:**
+
+```javascript
+const encryptedData = "加密后字符串";
+const privateKey = `-----BEGIN PRIVATE KEY-----
+私钥内容
+-----END PRIVATE KEY-----`;
+const decrypted = cryptoUtils.decryptWithRSA(encryptedData, privateKey);
+logi(`RSA Decrypted: ${decrypted}`);
+```
+
+### 哈希算法
+
+#### md5 - 计算 MD5 值
+
+```typescript
+function md5(data: string): string;
+```
+
+**参数:**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 描述              |
+| ------ | ------ | -------- | ------ | ----------------- |
+| `data` | string | 是       |        | 要计算 MD5 的数据 |
+
+**返回值:**
+
+| 类型     | 描述                            |
+| -------- | ------------------------------- |
+| `string` | MD5 哈希值 (小写 16 进制字符串) |
+
+**示例:**
+
+```javascript
+const data = "123456";
+const hash = cryptoUtils.md5(data);
+logi(`MD5: ${hash}`); // e10adc3949ba59abbe56e057f20f883e
+```
+
+#### sha1 - 计算 SHA1 值
+
+```typescript
+function sha1(data: string, key?: string): string;
+```
+
+**参数:**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 描述                       |
+| ------ | ------ | -------- | ------ | -------------------------- |
+| `data` | string | 是       |        | 要计算 SHA1 的数据         |
+| `key`  | string | 否       |        | 可选的密钥，用于 HMAC-SHA1 |
+
+**返回值:**
+
+| 类型     | 描述                             |
+| -------- | -------------------------------- |
+| `string` | SHA1 哈希值 (小写 16 进制字符串) |
+
+**示例:**
+
+```javascript
+const data = "123456";
+const hash = cryptoUtils.sha1(data);
+logi(`SHA1: ${hash}`);
+```
+
+#### sha256 - 计算 SHA256 值
+
+```typescript
+function sha256(data: string, key?: string): string;
+```
+
+**参数:**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 描述                         |
+| ------ | ------ | -------- | ------ | ---------------------------- |
+| `data` | string | 是       |        | 要计算 SHA256 的数据         |
+| `key`  | string | 否       |        | 可选的密钥，用于 HMAC-SHA256 |
+
+**返回值:**
+
+| 类型     | 描述                               |
+| -------- | ---------------------------------- |
+| `string` | SHA256 哈希值 (小写 16 进制字符串) |
+
+**示例:**
+
+```javascript
+const data = "123456";
+const hash = cryptoUtils.sha256(data);
+logi(`SHA256: ${hash}`);
+```