ms-vite-plugin 1.5.9 → 1.5.11

package/docs/api/device.md

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

package/docs/api/global.md

@@ -66,10 +66,10 @@ logi(`运行状态: ${__isRunning__}`);
 
 #### **platform**
 
-平台信息，标识当前应用运行的平台，例如 "ios"、"android" 等。
+免越狱包为 `"ios"`，越狱包为 `"ios_jb"`。
 
 ```typescript
-declare const __platform__: "ios" | "android";
+declare const __platform__: "ios" | "ios_jb";
 ```
 
 **示例:**

package/docs/api/jbclear.md

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