ms-vite-plugin 1.1.2 → 1.1.3

package/docs/apicn/appleocr.md

@@ -0,0 +1,233 @@
+# AppleOCR 模块($苹果 OCR)
+
+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
+- **区域识别**: 支持指定区域的精确文字识别
+
+## 数据类型
+
+### OCR 识别结果
+
+识别结果对象，包含以下属性：
+
+```typescript
+interface OCR识别结果 {
+  text: 字符串; // 识别的文本内容
+  confidence: 数字; // 识别置信度 (0-1)
+  x: 数字; // 文本区域左上角 x 坐标
+  y: 数字; // 文本区域左上角 y 坐标
+  width: 数字; // 文本区域宽度
+  height: 数字; // 文本区域高度
+  ex: 数字; // 文本区域右下角 x 坐标
+  ey: 数字; // 文本区域右下角 y 坐标
+  centerX: 数字; // 文本区域中心点 x 坐标
+  centerY: 数字; // 文本区域中心点 y 坐标
+}
+```
+
+**字段说明：**
+| 参数名 | 类型 | 描述 |
+| ------------- | ----------- | ---------------------- |
+| `text` | 字符串 | 识别的文本内容 |
+| `confidence` | 数字 | 识别置信度 (0-1)，值越高表示识别越准确 |
+| `x`, `y` | 数字 | 文本区域左上角坐标 |
+| `width`, `height` | 数字 | 文本区域宽度和高度 |
+| `ex`, `ey` | 数字 | 文本区域右下角坐标 |
+| `centerX`, `centerY` | 数字 | 文本区域中心点坐标 |
+
+## API 参考
+
+### 文字识别
+
+#### 识别
+
+执行通用 OCR 文字识别，支持多种输入源和指定识别区域。
+
+```typescript
+function 识别(
+  输入源: 字符串,
+  图片边界框左上角x坐标?: 数字,
+  图片边界框左上角y坐标?: 数字,
+  图片边界框右下角x坐标?: 数字,
+  图片边界框右下角y坐标?: 数字,
+  识别语言数组?: Array<字符串>,
+): 数组<OCR识别结果>;
+```
+
+**参数:**
+
+| 参数名                  | 类型     | 是否必填 | 默认值               | 描述                                                                                                                                     |
+| ----------------------- | -------- | -------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| `输入源`                | string   | 是       | -                    | 输入源，支持以下类型：<br>- `"screen"` - 当前屏幕截图<br>- `string` - 图片文件路径或 URL<br>- `imageId` - 图片 ID（通过 image 模块获取） |
+| `图片边界框左上角x坐标` | number   | 否       | -                    | 识别区域左上角 x 坐标                                                                                                                    |
+| `图片边界框左上角y坐标` | number   | 否       | -                    | 识别区域左上角 y 坐标                                                                                                                    |
+| `图片边界框右下角x坐标` | number   | 否       | -                    | 识别区域右下角 x 坐标                                                                                                                    |
+| `图片边界框右下角y坐标` | number   | 否       | -                    | 识别区域右下角 y 坐标                                                                                                                    |
+| `识别语言数组`          | string[] | 否       | ["zh-Hans", "en-US"] | 可选，指定识别语言列表，如 ["zh-Hans", "en-US"]                                                                                          |
+
+**返回值:**
+
+| 类型               | 描述                   |
+| ------------------ | ---------------------- |
+| 数组<OCR 识别结果> | 匹配的文本识别结果数组 |
+
+**使用示例:**
+
+```javascript
+// 识别整个屏幕
+const 全屏识别结果 = $苹果OCR.识别("screen", 0, 0, 0, 0);
+logi(`识别到 ${全屏识别结果.length} 个文本区域`);
+全屏识别结果.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 区域识别结果 = $苹果OCR.识别("screen", 100, 100, 500, 300);
+logi(`指定区域识别结果: ${JSON.stringify(区域识别结果)}`);
+
+// 识别图片文件
+const 图片识别结果 = $苹果OCR.识别("/path/to/image.png", 0, 0, 800, 600);
+if (图片识别结果.length > 0) {
+  logi("图片文字识别成功");
+  图片识别结果.forEach((result) => {
+    logi(`识别文字: ${result.text}`);
+    logi(`区域: ${result.width}x${result.height}`);
+  });
+} else {
+  logi("图片中未识别到文字");
+}
+
+// 指定识别语言
+const 中英文识别结果 = $苹果OCR.识别("screen", 0, 0, 1920, 1080, [
+  "zh-Hans",
+  "en-US",
+]);
+logi(`中英文识别结果: ${JSON.stringify(中英文识别结果)}`);
+
+// 识别当前屏幕
+const 屏幕识别结果 = $苹果OCR.识别("screen", 0, 0, 1920, 1080);
+logi(`屏幕识别结果: ${JSON.stringify(屏幕识别结果)}`);
+```
+
+### 数字识别
+
+#### 识别数字
+
+执行专门的数字 OCR 识别，针对数字识别进行了优化，提高数字识别的准确性。
+
+**支持字符**: 0-9 数字、逗号(,)、小数点(.)、加号(+)、减号(-)
+
+```typescript
+function 识别数字(
+  输入源: 字符串,
+  图片边界框左上角x坐标?: 数字,
+  图片边界框左上角y坐标?: 数字,
+  图片边界框右下角x坐标?: 数字,
+  图片边界框右下角y坐标?: 数字,
+): 数组<OCR识别结果>;
+```
+
+**参数:**
+
+| 参数名                  | 类型   | 是否必填 | 默认值 | 描述                                                                                                                                 |
+| ----------------------- | ------ | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `输入源`                | string | 是       | -      | 输入源，支持以下类型： <br>-`"screen"` 当前屏幕截图 <br>- `string` 图片文件路径或 URL <br>- `imageId` 图片 ID（通过 image 模块获取） |
+| `图片边界框左上角x坐标` | number | 否       | -      | 识别区域左上角 x 坐标                                                                                                                |
+| `图片边界框左上角y坐标` | number | 否       | -      | 识别区域左上角 y 坐标                                                                                                                |
+| `图片边界框右下角x坐标` | number | 否       | -      | 识别区域右下角 x 坐标                                                                                                                |
+| `图片边界框右下角y坐标` | number | 否       | -      | 识别区域右下角 y 坐标                                                                                                                |
+
+**返回值:**
+
+| 类型                | 描述                   |
+| ------------------- | ---------------------- |
+| `数组<OCR识别结果>` | 匹配的数字识别结果数组 |
+
+**使用示例:**
+
+```javascript
+// 识别屏幕中的数字
+const 数字识别结果 = 识别数字("screen", 100, 100, 500, 300);
+$打印信息日志(`识别到 ${数字识别结果.length} 个数字区域`);
+
+数字识别结果.forEach((result, index) => {
+  $打印信息日志(`数字 ${index + 1}: ${result.text}`);
+  $打印信息日志(`置信度: ${result.confidence}`);
+  $打印信息日志(`位置: (${result.centerX}, ${result.centerY})`);
+});
+```
+
+### 文本查找
+
+#### 查找文本
+
+执行指定文本查找，在识别结果中查找特定的文本内容。使用全字匹配模式，确保精确匹配目标文本。
+
+```typescript
+function 查找文本(
+  输入源: 字符串,
+  要查找的文本数组: 数组<字符串>,
+  图片边界框左上角x坐标?: 数字,
+  图片边界框左上角y坐标?: 数字,
+  图片边界框右下角x坐标?: 数字,
+  图片边界框右下角y坐标?: 数字,
+  识别语言数组?: 数组<字符串>,
+): 数组<OCR识别结果>;
+```
+
+**参数:**
+
+| 参数名                  | 类型         | 是否必填 | 默认值               | 描述                                                                                                                                 |
+| ----------------------- | ------------ | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `输入源`                | string       | 是       | -                    | 输入源，支持以下类型： <br>-`"screen"` 当前屏幕截图 <br>- `string` 图片文件路径或 URL <br>- `imageId` 图片 ID（通过 image 模块获取） |
+| `要查找的文本数组`      | 数组<字符串> | 是       | -                    | 要查找的文本数组                                                                                                                     |
+| `图片边界框左上角x坐标` | number       | 否       | -                    | 识别区域左上角 x 坐标                                                                                                                |
+| `图片边界框左上角y坐标` | number       | 否       | -                    | 识别区域左上角 y 坐标                                                                                                                |
+| `图片边界框右下角x坐标` | number       | 否       | -                    | 识别区域右下角 x 坐标                                                                                                                |
+| `图片边界框右下角y坐标` | number       | 否       | -                    | 识别区域右下角 y 坐标                                                                                                                |
+| `识别语言数组`          | 数组<字符串> | 否       | ["zh-Hans", "en-US"] | 可选，指定识别语言列表，如 ["zh-Hans", "en-US"]                                                                                      |
+
+**返回值:**
+
+| 类型                | 描述                   |
+| ------------------- | ---------------------- |
+| `数组<OCR识别结果>` | 匹配的文本识别结果数组 |
+
+**使用示例:**
+
+```javascript
+// 识别屏幕中的文本
+const 文本识别结果 = 查找文本("screen", ["123", "456"], 0, 0, 100, 100);
+$打印信息日志(`识别到 ${文本识别结果.length} 个文本区域`);
+文本识别结果.forEach((result, index) => {
+  $打印信息日志(
+    `文本 ${index + 1}: ${result.text} (置信度: ${result.confidence})`,
+  );
+  $打印信息日志(
+    `位置: (${result.x}, ${result.y}) - (${result.ex}, ${result.ey})`,
+  );
+  $打印信息日志(`中心点: (${result.centerX}, ${result.centerY})`);
+});
+```

package/docs/apicn/config.md

@@ -0,0 +1,120 @@
+# 配置模块 ($配置)
+
+配置模块提供了读取、更新和删除应用配置的功能。
+
+网页的 ms.setConfig 对应 $配置.设置
+
+网页的 ms.getConfig 对应 $配置.获取
+
+网页的 ms.getAllConfig 对应 $配置.所有配置
+
+网页的 ms.removeConfig 对应 $配置.删除
+
+## API 参考
+
+### 配置读取
+
+#### 获取
+
+```typescript
+function 获取(配置键: 字符串): 任意类型 | null;
+```
+
+**参数:**
+
+| 参数名   | 类型   | 是否必填 | 默认值 | 描述     |
+| -------- | ------ | -------- | ------ | -------- |
+| `配置键` | 字符串 | 是       | -      | 配置键名 |
+
+**返回值:**
+
+| 类型               | 描述   |
+| ------------------ | ------ |
+| `任意类型 \| null` | 配置值 |
+
+**示例:**
+
+```javascript
+const maxRetries = $配置.获取("maxRetries");
+$打印信息日志(`最大重试次数: ${maxRetries}`);
+```
+
+### 配置管理
+
+#### 所有配置
+
+```typescript
+function 所有配置(): 字典<任意类型>;
+```
+
+**返回值:**
+
+| 类型             | 描述               |
+| ---------------- | ------------------ |
+| `字典<任意类型>` | 包含所有配置的对象 |
+
+**示例:**
+
+```javascript
+const allConfigs = $配置.所有配置();
+$打印信息日志(`所有配置: ${JSON.stringify(allConfigs, null, 2)}`);
+```
+
+#### 设置
+
+```typescript
+function 设置(配置键: 字符串, 配置值: 任意类型): 布尔值;
+```
+
+**参数:**
+
+| 参数名   | 类型     | 是否必填 | 默认值 | 描述       |
+| -------- | -------- | -------- | ------ | ---------- |
+| `配置键` | 字符串   | 是       | -      | 配置键名   |
+| `配置值` | 任意类型 | 是       | -      | 新的配置值 |
+
+**返回值:**
+
+| 类型      | 描述         |
+| --------- | ------------ |
+| `boolean` | 更新是否成功 |
+
+**示例:**
+
+```javascript
+// 更新不同类型的配置
+const 是否更新成功1 = $配置.设置("maxRetries", 5);
+const 是否更新成功2 = $配置.设置("apiBaseUrl", "https://api.example.com");
+const 是否更新成功3 = $配置.设置("debugEnabled", true);
+
+if (是否更新成功1 && 是否更新成功2 && 是否更新成功3) {
+  $打印信息日志("配置更新成功");
+}
+```
+
+#### 删除
+
+```typescript
+function 删除(配置键: 字符串): 布尔值;
+```
+
+**参数:**
+
+| 参数名   | 类型   | 是否必填 | 默认值 | 描述             |
+| -------- | ------ | -------- | ------ | ---------------- |
+| `配置键` | 字符串 | 是       | -      | 要删除的配置键名 |
+
+**返回值:**
+
+| 类型     | 描述         |
+| -------- | ------------ |
+| `布尔值` | 删除是否成功 |
+
+**示例:**
+
+```javascript
+const 是否删除成功 = $配置.删除("temporaryConfig");
+if (是否删除成功) {
+  $打印信息日志("临时配置已删除");
+}
+```