ms-vite-plugin 1.1.2 → 1.1.4

package/docs/apipython/appleocr.md

@@ -0,0 +1,226 @@
+# 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"]`
+
+### 📱 多种输入源
+
+- **屏幕截图**: 直接识别当前屏幕内容 (`"screen"`)
+- **图片文件**: 支持本地图片文件路径
+- **图片 ID**: 通过 image 模块获取的图片 ID
+- **区域识别**: 支持指定区域的精确文字识别
+
+## 数据类型
+
+### OCRResult
+
+识别结果字典，包含以下键：
+
+```python
+from typing import TypedDict
+
+class OCRResult(TypedDict):
+    text: str       # 识别的文本内容
+    confidence: float # 识别置信度 (0-1)
+    x: int          # 文本区域左上角 x 坐标
+    y: int          # 文本区域左上角 y 坐标
+    width: int      # 文本区域宽度
+    height: int     # 文本区域高度
+    ex: int         # 文本区域右下角 x 坐标
+    ey: int         # 文本区域右下角 y 坐标
+    centerX: int    # 文本区域中心点 x 坐标
+    centerY: int    # 文本区域中心点 y 坐标
+```
+
+**字段说明：**
+
+| 参数名               | 类型  | 描述                                   |
+| -------------------- | ----- | -------------------------------------- |
+| `text`               | str   | 识别的文本内容                         |
+| `confidence`         | float | 识别置信度 (0-1)，值越高表示识别越准确 |
+| `x`, `y`             | int   | 文本区域左上角坐标                     |
+| `width`, `height`    | int   | 文本区域宽度和高度                     |
+| `ex`, `ey`           | int   | 文本区域右下角坐标                     |
+| `centerX`, `centerY` | int   | 文本区域中心点坐标                     |
+
+## API 参考
+
+### 文字识别
+
+#### recognize
+
+执行通用 OCR 文字识别，支持多种输入源和指定识别区域。
+
+```python
+def recognize(
+    input: str,
+    x: int = 0,
+    y: int = 0,
+    ex: int = 0,
+    ey: int = 0,
+    languages: Optional[List[str]] = ["zh-Hans", "en-US"]
+) -> List[OCRResult]
+```
+
+**参数:**
+
+| 参数名      | 类型      | 是否必填 | 默认值               | 描述                                                                                                                                  |
+| ----------- | --------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| `input`     | str       | 是       | -                    | 输入源，支持以下类型：<br>- `"screen"` - 当前屏幕截图<br>- `str` - 图片文件路径或 URL<br>- `imageId` - 图片 ID（通过 image 模块获取） |
+| `x`         | int       | 否       | 0                    | 识别区域左上角 x 坐标                                                                                                                 |
+| `y`         | int       | 否       | 0                    | 识别区域左上角 y 坐标                                                                                                                 |
+| `ex`        | int       | 否       | 0                    | 识别区域右下角 x 坐标                                                                                                                 |
+| `ey`        | int       | 否       | 0                    | 识别区域右下角 y 坐标                                                                                                                 |
+| `languages` | List[str] | 否       | ["zh-Hans", "en-US"] | 可选，指定识别语言列表，如 `["zh-Hans", "en-US"]`                                                                                     |
+
+**返回值:**
+
+| 类型              | 描述                   |
+| ----------------- | ---------------------- |
+| `List[OCRResult]` | 匹配的文本识别结果数组 |
+
+**使用示例:**
+
+```python
+from kuaijs import appleocr
+
+# 识别整个屏幕
+full_screen_results = appleocr.recognize("screen", 0, 0, 0, 0)
+print(f"识别到 {len(full_screen_results)} 个文本区域")
+for i, result in enumerate(full_screen_results):
+    print(f"文本 {i + 1}: {result.text} (置信度: {result.confidence})")
+    print(f"位置: ({result.x}, {result.y}) - ({result.ex}, {result.ey})")
+    print(f"中心点: ({result.centerX}, {result.centerY})")
+
+# 识别屏幕指定区域
+region_results = appleocr.recognize("screen", 100, 100, 500, 300)
+print(f"指定区域识别结果: {region_results}")
+
+# 识别图片文件
+image_results = appleocr.recognize("/path/to/image.png", 0, 0, 800, 600)
+if image_results:
+    print("图片文字识别成功")
+    for result in image_results:
+        print(f"识别文字: {result.text}")
+        print(f"区域: {result.width}x{result.height}")
+else:
+    print("图片中未识别到文字")
+
+# 指定识别语言
+chinese_results = appleocr.recognize("screen", 0, 0, 1920, 1080, ["zh-Hans", "en-US"])
+print(f"中英文识别结果: {chinese_results}")
+```
+
+### 数字识别
+
+#### recognizeNumbers
+
+执行专门的数字 OCR 识别，针对数字识别进行了优化，提高数字识别的准确性。
+
+**支持字符**: 0-9 数字、逗号(,)、小数点(.)、加号(+)、减号(-)
+
+```python
+def recognizeNumbers(
+    input: str,
+    x: int = 0,
+    y: int = 0,
+    ex: int = 0,
+    ey: int = 0
+) -> List[OCRResult]
+```
+
+**参数:**
+
+| 参数名  | 类型 | 是否必填 | 默认值 | 描述                                                                                                                              |
+| ------- | ---- | -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------- |
+| `input` | str  | 是       | -      | 输入源，支持以下类型： <br>-`"screen"` 当前屏幕截图 <br>- `str` 图片文件路径或 URL <br>- `imageId` 图片 ID（通过 image 模块获取） |
+| `x`     | int  | 否       | 0      | 识别区域左上角 x 坐标                                                                                                             |
+| `y`     | int  | 否       | 0      | 识别区域左上角 y 坐标                                                                                                             |
+| `ex`    | int  | 否       | 0      | 识别区域右下角 x 坐标                                                                                                             |
+| `ey`    | int  | 否       | 0      | 识别区域右下角 y 坐标                                                                                                             |
+
+**返回值:**
+
+| 类型              | 描述                   |
+| ----------------- | ---------------------- |
+| `List[OCRResult]` | 匹配的数字识别结果数组 |
+
+**使用示例:**
+
+```python
+from kuaijs import appleocr
+
+# 识别屏幕中的数字
+number_results = appleocr.recognizeNumbers("screen", 100, 100, 500, 300)
+print(f"识别到 {len(number_results)} 个数字区域")
+
+for i, result in enumerate(number_results):
+    print(f"数字 {i + 1}: {result.text}")
+    print(f"置信度: {result.confidence}")
+    print(f"位置: ({result.centerX}, {result.centerY})")
+```
+
+### 文本查找
+
+#### findText
+
+执行指定文本查找，在识别结果中查找特定的文本内容。使用全字匹配模式，确保精确匹配目标文本。
+
+```python
+def findText(
+    input: str,
+    texts: List[str],
+    x: int = 0,
+    y: int = 0,
+    ex: int = 0,
+    ey: int = 0,
+    languages: Optional[List[str]] = ["zh-Hans", "en-US"]
+) -> List[OCRResult]
+```
+
+**参数:**
+
+| 参数名      | 类型      | 是否必填 | 默认值               | 描述                                                                                                                              |
+| ----------- | --------- | -------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `input`     | str       | 是       | -                    | 输入源，支持以下类型： <br>-`"screen"` 当前屏幕截图 <br>- `str` 图片文件路径或 URL <br>- `imageId` 图片 ID（通过 image 模块获取） |
+| `texts`     | List[str] | 是       | -                    | 要查找的文本数组                                                                                                                  |
+| `x`         | int       | 否       | 0                    | 识别区域左上角 x 坐标                                                                                                             |
+| `y`         | int       | 否       | 0                    | 识别区域左上角 y 坐标                                                                                                             |
+| `ex`        | int       | 否       | 0                    | 识别区域右下角 x 坐标                                                                                                             |
+| `ey`        | int       | 否       | 0                    | 识别区域右下角 y 坐标                                                                                                             |
+| `languages` | List[str] | 否       | ["zh-Hans", "en-US"] | 可选，指定识别语言列表，如 `["zh-Hans", "en-US"]`                                                                                 |
+
+**返回值:**
+
+| 类型              | 描述                   |
+| ----------------- | ---------------------- |
+| `List[OCRResult]` | 匹配的文本识别结果数组 |
+
+**使用示例:**
+
+```python
+from kuaijs import appleocr
+
+# 识别屏幕中的文本
+text_results = appleocr.findText("screen", ["123", "456"], 0, 0, 100, 100)
+print(f"识别到 {len(text_results)} 个文本区域")
+
+for i, result in enumerate(text_results):
+    print(f"文本 {i + 1}: {result.text} (置信度: {result.confidence})")
+    print(f"位置: ({result.x}, {result.y}) - ({result.ex}, {result.ey})")
+    print(f"中心点: ({result.centerX}, {result.centerY})")
+```

package/docs/apipython/config.md

@@ -0,0 +1,126 @@
+# 配置模块 (Config)
+
+配置模块提供了读取、更新和删除应用配置的功能。
+
+网页的 ms.setConfig 对应 config.set
+
+网页的 ms.getConfig 对应 config.get
+
+网页的 ms.getAllConfig 对应 config.all
+
+网页的 ms.removeConfig 对应 config.remove
+
+## API 参考
+
+### 配置读取
+
+#### get - 读取配置项的值。
+
+```python
+from typing import Any, Optional, Dict
+
+def get(key: str) -> Any | None:
+```
+
+**参数:**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 描述     |
+| ------ | ------ | -------- | ------ | -------- |
+| `key`  | string | 是       | -      | 配置键名 |
+
+**返回值:**
+
+| 类型          | 描述   |
+| ------------- | ------ |
+| `Any \| None` | 配置值 |
+
+**示例:**
+
+```python
+from kuaijs import config
+maxRetries = config.get("maxRetries")
+if maxRetries:
+  print(f"最大重试次数: {maxRetries}")
+```
+
+### 配置管理
+
+#### all - 获取所有配置的 JSON 格式数据。
+
+```python
+def all() -> Dict[str, Any]:
+```
+
+**返回值:**
+
+| 类型             | 描述               |
+| ---------------- | ------------------ |
+| `Dict[str, Any]` | 包含所有配置的对象 |
+
+**示例:**
+
+```python
+from kuaijs import config
+import json
+allConfigs = config.all()
+print(f"所有配置: {json.dumps(allConfigs, indent=2)}")
+```
+
+#### set - 更新或设置配置项的值。
+
+```python
+def set(key: str, value: Any) -> bool:
+```
+
+**参数:**
+
+| 参数名  | 类型   | 是否必填 | 默认值 | 描述       |
+| ------- | ------ | -------- | ------ | ---------- |
+| `key`   | string | 是       | -      | 配置键名   |
+| `value` | Any    | 是       | -      | 新的配置值 |
+
+**返回值:**
+
+| 类型   | 描述         |
+| ------ | ------------ |
+| `bool` | 更新是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import config
+# 更新不同类型的配置
+success1 = config.set("maxRetries", 5)
+success2 = config.set("apiBaseUrl", "https://api.example.com")
+success3 = config.set("debugEnabled", True)
+
+if success1 and success2 and success3:
+  print("配置更新成功")
+```
+
+#### remove - 删除指定的配置项。
+
+```python
+def remove(key: str) -> bool:
+```
+
+**参数:**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 描述             |
+| ------ | ------ | -------- | ------ | ---------------- |
+| `key`  | string | 是       | -      | 要删除的配置键名 |
+
+**返回值:**
+
+| 类型   | 描述         |
+| ------ | ------------ |
+| `bool` | 删除是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import config
+deleted = config.remove("temporaryConfig")
+if deleted:
+  print("临时配置已删除")
+```

package/docs/apipython/cryptoUtils.md

@@ -0,0 +1,246 @@
+# 加密模块 (CryptoUtils)
+
+加密模块提供了常用的加密和解密功能，支持 AES、RSA 以及 MD5、SHA1、SHA256 等哈希算法。
+
+## 功能概览
+
+- **AES 加解密**: 支持 AES-ECB 模式的加密与解密
+- **RSA 加解密**: 支持 RSA 公钥加密与私钥解密
+- **哈希算法**: 支持 MD5, SHA1, SHA256 消息摘要计算
+
+## API 参考
+
+### AES 加解密
+
+#### encryptWithAES_ECB - 使用 AES ECB 模式加密数据
+
+默认使用 PKCS7 填充。
+
+```python
+def encryptWithAES_ECB(data: str, aesKey: str, noPadding: bool) -> str
+```
+
+**参数:**
+
+| 参数名      | 类型 | 是否必填 | 默认值 | 描述                                                                   |
+| ----------- | ---- | -------- | ------ | ---------------------------------------------------------------------- |
+| `data`      | str  | 是       |        | 要加密的数据                                                           |
+| `aesKey`    | str  | 是       |        | AES 密钥，支持 16 位、24 位、32 位字符串                               |
+| `noPadding` | bool | 否       | False  | 是否禁用填充。`False`: 使用 PKCS7 填充; `True`: 不使用填充 (NoPadding) |
+
+**返回值:**
+
+| 类型  | 描述                             |
+| ----- | -------------------------------- |
+| `str` | 加密后的数据 (Base64 编码字符串) |
+
+**示例:**
+
+```python
+from kuaijs import cryptoUtils, logger
+
+data = "Hello World"
+key = "1234567890123456" # 16位密钥
+encrypted = cryptoUtils.encryptWithAES_ECB(data, key, False)
+logger.info(f"AES Encrypted: {encrypted}")
+```
+
+#### decryptWithAES_ECB - 使用 AES ECB 模式解密数据
+
+默认使用 PKCS7 填充。
+
+```python
+def decryptWithAES_ECB(data: str, aesKey: str, noPadding: bool) -> str
+```
+
+**参数:**
+
+| 参数名      | 类型 | 是否必填 | 默认值 | 描述                                                                   |
+| ----------- | ---- | -------- | ------ | ---------------------------------------------------------------------- |
+| `data`      | str  | 是       |        | 要解密的数据 (Base64 编码字符串)                                       |
+| `aesKey`    | str  | 是       |        | AES 密钥，支持 16 位、24 位、32 位字符串                               |
+| `noPadding` | bool | 否       | False  | 是否禁用填充。`False`: 使用 PKCS7 填充; `True`: 不使用填充 (NoPadding) |
+
+**返回值:**
+
+| 类型  | 描述             |
+| ----- | ---------------- |
+| `str` | 解密后的原始数据 |
+
+**示例:**
+
+```python
+from kuaijs import cryptoUtils, logger
+
+encrypted_data = "Base64EncodedString..."
+key = "1234567890123456"
+decrypted = cryptoUtils.decryptWithAES_ECB(encrypted_data, key, False)
+logger.info(f"AES Decrypted: {decrypted}")
+```
+
+### RSA 加解密
+
+#### encryptWithRSA - 使用 RSA 公钥加密数据
+
+使用 PKCS1 填充。
+
+```python
+def encryptWithRSA(data: str, publicKeyBase64: str) -> str
+```
+
+**参数:**
+
+| 参数名            | 类型 | 是否必填 | 默认值 | 描述                         |
+| ----------------- | ---- | -------- | ------ | ---------------------------- |
+| `data`            | str  | 是       |        | 要加密的数据                 |
+| `publicKeyBase64` | str  | 是       |        | RSA 公钥 (Base64 编码字符串) |
+
+**返回值:**
+
+| 类型  | 描述                             |
+| ----- | -------------------------------- |
+| `str` | 加密后的数据 (Base64 编码字符串) |
+
+**示例:**
+
+```python
+from kuaijs import cryptoUtils, logger
+
+data = "123456"
+public_key = """-----BEGIN PUBLIC KEY-----
+公钥内容
+-----END PUBLIC KEY-----
+"""
+encrypted = cryptoUtils.encryptWithRSA(data, public_key)
+logger.info(f"RSA Encrypted: {encrypted}")
+```
+
+#### decryptWithRSA - 使用 RSA 私钥解密数据
+
+使用 PKCS1 填充。
+
+```python
+def decryptWithRSA(encryptedData: str, privateKeyBase64: str) -> str
+```
+
+**参数:**
+
+| 参数名             | 类型 | 是否必填 | 默认值 | 描述                             |
+| ------------------ | ---- | -------- | ------ | -------------------------------- |
+| `encryptedData`    | str  | 是       |        | 要解密的数据 (Base64 编码字符串) |
+| `privateKeyBase64` | str  | 是       |        | RSA 私钥 (Base64 编码字符串)     |
+
+**返回值:**
+
+| 类型  | 描述             |
+| ----- | ---------------- |
+| `str` | 解密后的原始数据 |
+
+**示例:**
+
+```python
+from kuaijs import cryptoUtils, logger
+
+encrypted_data = "加密后字符串"
+private_key = """-----BEGIN PRIVATE KEY-----
+私钥内容
+-----END PRIVATE KEY-----"""
+decrypted = cryptoUtils.decryptWithRSA(encrypted_data, private_key)
+logger.info(f"RSA Decrypted: {decrypted}")
+```
+
+### 哈希算法
+
+#### md5 - 计算 MD5 值
+
+```python
+def md5(source: str) -> str
+```
+
+**参数:**
+
+| 参数名   | 类型 | 是否必填 | 默认值 | 描述              |
+| -------- | ---- | -------- | ------ | ----------------- |
+| `source` | str  | 是       |        | 要计算 MD5 的数据 |
+
+**返回值:**
+
+| 类型  | 描述                            |
+| ----- | ------------------------------- |
+| `str` | MD5 哈希值 (小写 16 进制字符串) |
+
+**示例:**
+
+```python
+from kuaijs import cryptoUtils, logger
+
+data = "123456"
+hash_val = cryptoUtils.md5(data)
+logger.info(f"MD5: {hash_val}") # e10adc3949ba59abbe56e057f20f883e
+```
+
+#### sha1 - 计算 SHA1 值
+
+```python
+def sha1(source: str, key: str = None) -> str
+```
+
+**参数:**
+
+| 参数名   | 类型 | 是否必填 | 默认值 | 描述               |
+| -------- | ---- | -------- | ------ | ------------------ |
+| `source` | str  | 是       |        | 要计算 SHA1 的数据 |
+| `key`    | str  | 否       | None   | 可选的 HMAC 密钥   |
+
+**返回值:**
+
+| 类型  | 描述                             |
+| ----- | -------------------------------- |
+| `str` | SHA1 哈希值 (小写 16 进制字符串) |
+
+**示例:**
+
+```python
+from kuaijs import cryptoUtils, logger
+
+data = "123456"
+hash_val = cryptoUtils.sha1(data)
+logger.info(f"SHA1: {hash_val}")
+
+# HMAC-SHA1
+# hmac_val = cryptoUtils.sha1(data, "secret_key")
+# logger.info(f"HMAC-SHA1: {hmac_val}")
+```
+
+#### sha256 - 计算 SHA256 值
+
+```python
+def sha256(source: str, key: str = None) -> str
+```
+
+**参数:**
+
+| 参数名   | 类型 | 是否必填 | 默认值 | 描述                 |
+| -------- | ---- | -------- | ------ | -------------------- |
+| `source` | str  | 是       |        | 要计算 SHA256 的数据 |
+| `key`    | str  | 否       | None   | 可选的 HMAC 密钥     |
+
+**返回值:**
+
+| 类型  | 描述                               |
+| ----- | ---------------------------------- |
+| `str` | SHA256 哈希值 (小写 16 进制字符串) |
+
+**示例:**
+
+```python
+from kuaijs import cryptoUtils, logger
+
+data = "123456"
+hash_val = cryptoUtils.sha256(data)
+logger.info(f"SHA256: {hash_val}")
+
+# HMAC-SHA256
+# hmac_val = cryptoUtils.sha256(data, "secret_key")
+# logger.info(f"HMAC-SHA256: {hmac_val}")
+```