ms-vite-plugin 1.5.8 → 1.5.10

package/docs/apicn/ui.md

@@ -107,6 +107,47 @@ $视图.调用函数("loadData", {
 });
 ```
 
+### 调用悬浮窗函数 - 调用越狱悬浮窗网页中的 JavaScript 函数
+
+```typescript
+function 调用悬浮窗函数(函数名: 字符串, 数据: 字典<任意类型>): 无返回值;
+```
+
+调用悬浮窗网页里 `registerUIFunc` 注册的函数。主界面 WebView 不受影响。没有悬浮窗网页时无效果。
+
+**参数：**
+
+| 参数名   | 类型           | 是否必填 | 默认值 | 描述                         |
+| -------- | -------------- | -------- | ------ | ---------------------------- |
+| `函数名` | 字符串         | 是       |        | 悬浮窗页面 JavaScript 方法名 |
+| `数据`   | 字典<任意类型> | 是       |        | 传递给方法的参数             |
+
+**示例：**
+
+```typescript
+$视图.调用悬浮窗函数("updateStatus", { status: "running", progress: 50 });
+```
+
+### 执行悬浮窗JS代码 - 在越狱悬浮窗网页中执行 JavaScript
+
+```typescript
+function 执行悬浮窗JS代码(代码: 字符串): 无返回值;
+```
+
+在悬浮窗网页中执行 JavaScript。主界面 WebView 不受影响。没有悬浮窗网页时无效果。
+
+**参数：**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 描述                 |
+| ------ | ------ | -------- | ------ | -------------------- |
+| `代码` | 字符串 | 是       |        | JavaScript 代码字符串 |
+
+**示例：**
+
+```typescript
+$视图.执行悬浮窗JS代码("console.log('float')");
+```
+
 ### 显示 Toast 提示 - 显示 Toast 提示消息
 
 ```typescript
@@ -643,6 +684,30 @@ ms.getDeviceID()
   });
 ```
 
+#### getOrientation() - 获取屏幕方向
+
+```typescript
+declare function getOrientation(): Promise<"PORTRAIT" | "LANDSCAPE">;
+```
+
+**返回值：**
+
+| 类型                                        | 描述                                                         |
+| ------------------------------------------- | ------------------------------------------------------------ |
+| `Promise<"PORTRAIT" \| "LANDSCAPE">` | `"PORTRAIT"` 竖屏，`"LANDSCAPE"` 横屏 |
+
+**说明：**
+
+获取当前屏幕方向。
+
+**网页端示例：**
+
+```javascript
+ms.getOrientation().then((orientation) => {
+  console.log(orientation);
+});
+```
+
 #### getAuthCardNo() - 获取缓存的授权卡密
 
 ```typescript
@@ -707,6 +772,55 @@ ms.openURL("https://www.baidu.com")
   });
 ```
 
+#### setWebWindowSize() - 设置网页窗口宽高
+
+```typescript
+declare function setWebWindowSize(size: {
+  portraitWidth: number;
+  portraitHeight: number;
+  landscapeWidth: number;
+  landscapeHeight: number;
+}): Promise<boolean>;
+```
+
+**参数：**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 描述                     |
+| ------ | ------ | -------- | ------ | ------------------------ |
+| `size` | object | 是       |        | 横竖屏网页窗口像素尺寸   |
+
+**`size` 字段：**
+
+| 字段名            | 类型   | 是否必填 | 默认值 | 描述                   |
+| ----------------- | ------ | -------- | ------ | ---------------------- |
+| `portraitWidth`   | number | 是       |        | 竖屏窗口宽度（像素）   |
+| `portraitHeight`  | number | 是       |        | 竖屏窗口高度（像素）   |
+| `landscapeWidth`  | number | 是       |        | 横屏窗口宽度（像素）   |
+| `landscapeHeight` | number | 是       |        | 横屏窗口高度（像素）   |
+
+**返回值：**
+
+| 类型               | 描述                                  |
+| ------------------ | ------------------------------------- |
+| `Promise<boolean>` | 如果设置成功返回 true，否则返回 false |
+
+**说明：**
+
+仅越狱包可用。一次同时设置竖屏和横屏的网页窗口像素尺寸。未调用过时，横竖屏都默认使用对应朝向屏幕宽高的 60%。免越狱包调用返回 `false`。
+
+**网页端示例：**
+
+```javascript
+ms.setWebWindowSize({
+  portraitWidth: 700,
+  portraitHeight: 1200,
+  landscapeWidth: 1200,
+  landscapeHeight: 700,
+}).then((ok) => {
+  console.log(ok);
+});
+```
+
 ### 完整示例
 
 **完整的控制面板示例：**

package/docs/apilua/device.md

@@ -56,12 +56,9 @@ print("剩余存储: " .. tostring(storage.free) .. tostring(storage.unit))
 
 ## 设备标识信息
 
-### getDeviceID - 获取设备的唯一标识符（ID）。
+### getDeviceID - 获取设备 ID。
 
-**注意事项：**
-
-- 这个 ID 卸载重装 APP 后会改变。
-- 更新 APP 后，不会改变。
+越狱包返回芯片生成的固定 ID，卸载重装不变；免越狱包返回 IDFV，卸载重装会改变。
 
 ```lua
 ---@return string
@@ -70,14 +67,13 @@ function getDeviceID() end
 
 **返回值：**
 
-| 类型   | 描述             |
-| ------ | ---------------- |
-| string | 设备的唯一标识符 |
+| 类型   | 描述    |
+| ------ | ------- |
+| string | 设备 ID |
 
 **示例：**
 
 ```lua
--- 获取设备ID
 local uuid = device.getDeviceID()
 print("设备ID = " .. tostring(uuid))
 ```

package/docs/apilua/global.md

@@ -56,10 +56,10 @@ print("调试模式: " .. tostring(IsDebug))
 
 #### **Platform**
 
-平台信息，标识当前应用运行的平台，例如 `"ios"`、`"android"`。
+免越狱包为 `"ios"`，越狱包为 `"ios_jb"`。
 
 ```lua
----@type string
+---@type "ios"|"ios_jb"
 Platform = nil
 ```
 

package/docs/apilua/jbclear.md

@@ -0,0 +1,313 @@
+# 清理模块 (JBClear)
+
+模块表是内置全局 `jbclear`，直接调用即可。不要 `require` 宿主模块。
+
+仅越狱包可用。免越狱包没有 `jbclear`。
+
+## API 参考
+
+### keychain - 按关联名清理钥匙串。
+
+空串返回 `false`。
+
+```lua
+---@param identifier string
+---@return boolean
+function keychain(identifier) end
+```
+
+**参数:**
+
+| 参数名       | 类型   | 是否必填 | 默认值 | 描述                                   |
+| ------------ | ------ | -------- | ------ | -------------------------------------- |
+| `identifier` | string | 是       | -      | 钥匙串关联名，例如 `"demo.sample.app"` |
+
+**返回值:**
+
+| 类型      | 描述          |
+| --------- | ------------- |
+| `boolean` | 成功为 `true` |
+
+**示例:**
+
+```lua
+jbclear.keychain("demo.sample.app")
+```
+
+### allKeychain - 清理第三方应用钥匙串。
+
+不清理本 App。
+
+```lua
+---@return boolean
+function allKeychain() end
+```
+
+**返回值:**
+
+| 类型      | 描述          |
+| --------- | ------------- |
+| `boolean` | 成功为 `true` |
+
+**示例:**
+
+```lua
+jbclear.allKeychain()
+```
+
+### cookies - 清理 Safari Cookies。
+
+```lua
+---@return boolean
+function cookies() end
+```
+
+**返回值:**
+
+| 类型      | 描述          |
+| --------- | ------------- |
+| `boolean` | 成功为 `true` |
+
+**示例:**
+
+```lua
+jbclear.cookies()
+```
+
+### caches - 清理系统缓存。
+
+必须传表。默认会重建图标缓存。传 `{ noUicache = true }` 跳过。
+
+```lua
+---@param options table
+---@return boolean
+function caches(options) end
+```
+
+**参数:**
+
+| 参数名    | 类型  | 是否必填 | 默认值 | 描述                                      |
+| --------- | ----- | -------- | ------ | ----------------------------------------- |
+| `options` | table | 是       | `{}`   | `{ noUicache = true }` 时跳过重建图标缓存 |
+
+**返回值:**
+
+| 类型      | 描述          |
+| --------- | ------------- |
+| `boolean` | 成功为 `true` |
+
+**示例:**
+
+```lua
+jbclear.caches({})
+jbclear.caches { noUicache = true }
+```
+
+### photos - 删除本机相册里的本地照片。
+
+不影响 iCloud 照片。
+
+```lua
+---@return boolean
+function photos() end
+```
+
+**返回值:**
+
+| 类型      | 描述          |
+| --------- | ------------- |
+| `boolean` | 成功为 `true` |
+
+**示例:**
+
+```lua
+jbclear.photos()
+```
+
+### appData - 清理指定应用的本地数据，不卸载应用。
+
+先结束该应用进程，再清数据容器、App Group、扩展数据容器，以及该应用钥匙串。不卸载。空包名或本 App 及其扩展返回 `false`。
+
+```lua
+---@param bundleId string
+---@return boolean
+function appData(bundleId) end
+```
+
+**参数:**
+
+| 参数名     | 类型   | 是否必填 | 默认值 | 描述                                   |
+| ---------- | ------ | -------- | ------ | -------------------------------------- |
+| `bundleId` | string | 是       | -      | 应用包标识符，例如 `"demo.sample.app"` |
+
+**返回值:**
+
+| 类型      | 描述          |
+| --------- | ------------- |
+| `boolean` | 成功为 `true` |
+
+**示例:**
+
+```lua
+jbclear.appData("demo.sample.app")
+```
+
+### getIdfa - 读取整机广告标识（IDFA）。
+
+```lua
+---@return string|nil
+function getIdfa() end
+```
+
+**返回值:**
+
+| 类型            | 描述                          |
+| --------------- | ----------------------------- |
+| `string \| nil` | UUID 字符串；读不到返回 `nil` |
+
+**示例:**
+
+```lua
+local idfa = jbclear.getIdfa()
+```
+
+### resetIdfa - 重置整机广告标识（IDFA）。
+
+之后所有 App 读到的 IDFA 都会变。
+
+```lua
+---@return string|nil
+function resetIdfa() end
+```
+
+**返回值:**
+
+| 类型            | 描述                          |
+| --------------- | ----------------------------- |
+| `string \| nil` | 重置前的 UUID；失败返回 `nil` |
+
+**示例:**
+
+```lua
+local old = jbclear.resetIdfa()
+if old then
+  file.writeFile("idfa.txt", old)
+end
+```
+
+### setIdfa - 写入整机广告标识（IDFA）。
+
+```lua
+---@param value string
+---@return string|nil
+function setIdfa(value) end
+```
+
+**参数:**
+
+| 参数名  | 类型   | 是否必填 | 默认值 | 描述                                |
+| ------- | ------ | -------- | ------ | ----------------------------------- |
+| `value` | string | 是       | -      | `getIdfa` / `resetIdfa` 返回的 UUID |
+
+**返回值:**
+
+| 类型            | 描述                          |
+| --------------- | ----------------------------- |
+| `string \| nil` | 写入前的 UUID；失败返回 `nil` |
+
+**示例:**
+
+```lua
+local old = file.readFile("idfa.txt")
+if old then
+  jbclear.setIdfa(old)
+end
+```
+
+### getIdfv - 读取指定应用所属开发商的 IDFV。
+
+```lua
+---@param bundleId string
+---@return string|nil
+function getIdfv(bundleId) end
+```
+
+**参数:**
+
+| 参数名     | 类型   | 是否必填 | 默认值 | 描述                                   |
+| ---------- | ------ | -------- | ------ | -------------------------------------- |
+| `bundleId` | string | 是       | -      | 应用包标识符，例如 `"demo.sample.app"` |
+
+**返回值:**
+
+| 类型            | 描述                          |
+| --------------- | ----------------------------- |
+| `string \| nil` | UUID 字符串；读不到返回 `nil` |
+
+**示例:**
+
+```lua
+local idfv = jbclear.getIdfv("demo.sample.app")
+```
+
+### resetIdfv - 重置指定应用所属开发商的 IDFV。
+
+同一开发商的 App 会一起变。
+
+```lua
+---@param bundleId string
+---@return string|nil
+function resetIdfv(bundleId) end
+```
+
+**参数:**
+
+| 参数名     | 类型   | 是否必填 | 默认值 | 描述                                   |
+| ---------- | ------ | -------- | ------ | -------------------------------------- |
+| `bundleId` | string | 是       | -      | 应用包标识符，例如 `"demo.sample.app"` |
+
+**返回值:**
+
+| 类型            | 描述                          |
+| --------------- | ----------------------------- |
+| `string \| nil` | 重置前的 UUID；失败返回 `nil` |
+
+**示例:**
+
+```lua
+local old = jbclear.resetIdfv("demo.sample.app")
+if old then
+  file.writeFile("idfv.txt", old)
+end
+```
+
+### setIdfv - 写入指定应用所属开发商的 IDFV。
+
+```lua
+---@param bundleId string
+---@param value string
+---@return string|nil
+function setIdfv(bundleId, value) end
+```
+
+**参数:**
+
+| 参数名     | 类型   | 是否必填 | 默认值 | 描述                                   |
+| ---------- | ------ | -------- | ------ | -------------------------------------- |
+| `bundleId` | string | 是       | -      | 应用包标识符，例如 `"demo.sample.app"` |
+| `value`    | string | 是       | -      | `getIdfv` / `resetIdfv` 返回的 UUID    |
+
+**返回值:**
+
+| 类型            | 描述                          |
+| --------------- | ----------------------------- |
+| `string \| nil` | 写入前的 UUID；失败返回 `nil` |
+
+**示例:**
+
+```lua
+local old = file.readFile("idfv.txt")
+if old then
+  jbclear.setIdfv("demo.sample.app", old)
+end
+```