ms-vite-plugin 1.1.2 → 1.1.3

package/docs/apipython/hotUpdate.md

@@ -0,0 +1,154 @@
+# 热更新模块 (HotUpdate)
+
+热更新模块提供完整的应用热更新功能，支持检查更新、下载更新包、MD5 校验、对话框展示等核心功能。
+
+## 自动检查更新
+
+脚本启动时会自动检查是否有更新；有更新则下载更新包并安装后重启应用。
+
+## 类型定义
+
+### HotUpdateResponse
+
+服务器响应数据结构。
+
+```python
+from typing import TypedDict, Optional
+
+class HotUpdateResponse(TypedDict):
+    download_url: str      # 新包的下载地址
+    version: int           # 新包的版本号
+    download_timeout: int  # 下载超时时间（秒）
+    dialog: bool           # 是否用对话框展示
+    msg: str               # 对话框消息
+    force: bool            # 是否强制更新
+    md5: Optional[str]     # 更新包 MD5 值（可选）
+```
+
+### HotUpdateResult
+
+热更新检查结果。
+
+```python
+from typing import TypedDict, Optional
+
+class HotUpdateResult(TypedDict):
+    needUpdate: bool                   # 是否需要更新
+    error: Optional[str]               # 错误信息（当检查失败时）
+    data: Optional[HotUpdateResponse]  # 服务器返回的更新数据（当 needUpdate 为 True 时）
+```
+
+### InstallResult
+
+安装结果。
+
+```python
+from typing import TypedDict, Optional
+
+class InstallResult(TypedDict):
+    updated: bool         # 是否安装成功
+    error: Optional[str]  # 安装失败时的错误信息
+```
+
+## API 参考
+
+- 只有你需要代码检查更新，才需要调用 `checkUpdate` 方法
+
+### 更新管理
+
+#### checkUpdate - 检查更新
+
+```python
+def checkUpdate() -> HotUpdateResult
+```
+
+**返回值:**
+
+| 类型            | 描述         |
+| --------------- | ------------ |
+| HotUpdateResult | 检查结果对象 |
+
+**示例:**
+
+```python
+from kuaijs import hotupdate
+
+# 传入字典即可
+r = hotupdate.checkUpdate()
+
+if r.needUpdate:
+    print("发现新版本")
+    # 注意：downloadAndInstall 会根据 checkUpdate 的结果自动处理
+    install_result = hotupdate.downloadAndInstall()
+    if install_result.updated:
+        print("更新安装成功")
+    else:
+        print(f"更新失败: {install_result.error}")
+elif r.error:
+    print(f"检查更新失败: {r.error}")
+else:
+    print("已是最新版本")
+```
+
+#### downloadAndInstall - 下载并安装更新
+
+下载并安装更新，安装完成后自动重启脚本。
+
+```python
+def downloadAndInstall() -> InstallResult
+```
+
+**参数:**
+
+- 无需参数，自动使用上次 `checkUpdate` 的结果
+
+**返回值:**
+
+| 字段      | 类型 | 描述                 |
+| --------- | ---- | -------------------- |
+| `updated` | bool | 是否安装成功         |
+| `error`   | str  | 安装失败时的错误信息 |
+
+**示例:**
+
+```python
+from kuaijs import hotupdate
+
+r = hotupdate.checkUpdate()
+if r.needUpdate:
+    install_result = hotupdate.downloadAndInstall()
+    if install_result.updated:
+        print("更新安装成功")
+    else:
+        print(f"更新失败: {install_result.error}")
+else:
+    print("已是最新版本")
+```
+
+### 版本信息
+
+#### getCurrentVersion - 获取当前版本号
+
+```python
+def getCurrentVersion() -> int
+```
+
+**返回值:**
+
+| 字段      | 类型 | 描述                               |
+| --------- | ---- | ---------------------------------- |
+| `version` | int  | 当前应用版本号（仅支持整数版本号） |
+
+版本获取逻辑：
+
+- 从 `package.json` 文件读取 `appVersion` 字段
+- 支持数字类型的 `appVersion`
+- 如果获取不到则返回 0
+
+**示例:**
+
+```python
+from kuaijs import hotupdate
+version = hotupdate.getCurrentVersion()
+print("当前版本:", version)
+```