ms-vite-plugin 1.4.35 → 1.4.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -305,8 +305,8 @@ function setScreenBrightness(brightness: number): boolean;
305
305
 
306
306
  **返回值:**
307
307
 
308
- | 类型 | 描述 |
309
- | --------- | ------------------------ |
308
+ | 类型 | 描述 |
309
+ | --------- | ------------ |
310
310
  | `boolean` | 是否设置成功 |
311
311
 
312
312
  **示例:**
package/docs/api/pip.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## 功能特性
6
6
 
7
- - **显示模式**:支持日志、保活和自定义三种显示模式
7
+ - **显示模式**:支持日志、保活和自定义三种显示模式;首次安装默认保活
8
8
  - **关闭控制**:支持主动关闭悬浮窗
9
9
  - **状态查询**:判断悬浮窗是否正在显示
10
10
  - **尺寸设置**:日志模式和自定义模式支持设置内容宽高,并按模式分别持久化
@@ -13,6 +13,12 @@
13
13
  - **CPU 管理**: 获取 CPU 使用率
14
14
  - **Agent 服务**: 启动 快点 Agent 服务
15
15
 
16
+ ## 常见问题
17
+
18
+ 1、获取剪切板每次都会弹窗
19
+
20
+ 从设置找到快点JS点进去->把从其他 App 粘贴设置为允许
21
+
16
22
  ## API 参考
17
23
 
18
24
  ### 应用管理
@@ -206,8 +212,8 @@ function recent(): boolean;
206
212
 
207
213
  **返回值:**
208
214
 
209
- | 类型 | 描述 |
210
- | --------- | ---------------------- |
215
+ | 类型 | 描述 |
216
+ | --------- | ----------------------- |
211
217
  | `boolean` | 是否成功打开 App 切换器 |
212
218
 
213
219
  **示例:**
@@ -435,13 +441,13 @@ function getMemoryInfo(): {
435
441
 
436
442
  **返回值:**
437
443
 
438
- | 类型 | 描述 |
439
- | ----------------- | ---------------------------- |
440
- | `used` | 当前应用占用(单位:MB) |
441
- | `available` | 系统可用内存(单位:MB) |
442
- | `total` | 系统总内存(单位:MB) |
443
- | `systemUsed` | 系统已用内存(单位:MB) |
444
- | `usagePercentage` | 系统内存占用率(百分比) |
444
+ | 类型 | 描述 |
445
+ | ----------------- | ------------------------ |
446
+ | `used` | 当前应用占用(单位:MB) |
447
+ | `available` | 系统可用内存(单位:MB) |
448
+ | `total` | 系统总内存(单位:MB) |
449
+ | `systemUsed` | 系统已用内存(单位:MB) |
450
+ | `usagePercentage` | 系统内存占用率(百分比) |
445
451
 
446
452
  **说明:**
447
453
 
@@ -559,8 +565,8 @@ function getSystemUsedMemory(): number;
559
565
 
560
566
  **返回值:**
561
567
 
562
- | 类型 | 描述 |
563
- | -------- | -------------------------- |
568
+ | 类型 | 描述 |
569
+ | -------- | ---------------------------- |
564
570
  | `number` | 系统已用内存大小(单位:MB) |
565
571
 
566
572
  **说明:**
@@ -589,8 +595,8 @@ function getCpuUsage(): number;
589
595
 
590
596
  **返回值:**
591
597
 
592
- | 类型 | 描述 |
593
- | -------- | ---------------------------- |
598
+ | 类型 | 描述 |
599
+ | -------- | ----------------------------- |
594
600
  | `number` | 当前应用 CPU 使用率(百分比) |
595
601
 
596
602
  **示例:**
@@ -12,7 +12,8 @@
12
12
 
13
13
  - **独立的执行环境**: 线程函数在独立的 JavaScript 环境中运行,无法访问主线程或其他作用域中的变量、函数或对象。
14
14
  - **闭包限制**: 即使线程函数是闭包形式,它也无法捕获外部变量。传递给 `thread.run` 的函数会被转换并在新的上下文中执行。
15
- - **数据通信**: 如果需要与主线程通信或使用外部数据,请使用 `sharedState` 全局对象。
15
+ - **启动参数**: 主线程可以向 `thread.run` 传入一个 Object,子线程通过全局变量 `__threadParams__` 读取。
16
+ - **数据通信**: 线程启动后的双向数据通信请使用 `sharedState` 全局对象。
16
17
  - **文件名限制**:执行的线程 js 文件名称必须以 `_thread.js` 结尾,例如 `worker_thread.js`。
17
18
 
18
19
  ## API 参考
@@ -24,14 +25,15 @@
24
25
  启动一个新的线程来执行指定的 JS 文件。
25
26
 
26
27
  ```typescript
27
- function run(threadJsFileName: string): Thread;
28
+ function run(threadJsFileName: string, params?: Record<string, any>): Thread;
28
29
  ```
29
30
 
30
31
  **参数:**
31
32
 
32
- | 参数名 | 类型 | 描述 |
33
- | ------------------ | -------- | ---------------- |
34
- | `threadJsFileName` | `string` | 线程 js 文件路径 |
33
+ | 参数名 | 类型 | 描述 |
34
+ | ------------------ | --------------------- | -------------------------------------------------- |
35
+ | `threadJsFileName` | `string` | 线程 js 文件路径 |
36
+ | `params` | `Record<string, any>` | 可选启动参数,只能传 Object;子线程通过 `__threadParams__` 读取 |
35
37
 
36
38
  **返回值:**
37
39
 
@@ -42,8 +44,13 @@ function run(threadJsFileName: string): Thread;
42
44
  **示例:**
43
45
 
44
46
  ```javascript
45
- // 启动一个简单的线程
46
- const t = thread.run("test_thread.js");
47
+ // 主线程传入启动参数
48
+ const t = thread.run("test_thread.js", { taskId: 1, title: "同步任务" });
49
+ ```
50
+
51
+ ```javascript
52
+ // test_thread.js
53
+ logi(`任务 ${__threadParams__.taskId}: ${__threadParams__.title}`);
47
54
  ```
48
55
 
49
56
  #### thread.stopAll - 停止所有线程
@@ -319,8 +319,8 @@ function 设置屏幕亮度(亮度: 数字): 布尔值;
319
319
 
320
320
  **返回值:**
321
321
 
322
- | 类型 | 描述 |
323
- | ------ | ------------------------ |
322
+ | 类型 | 描述 |
323
+ | ------ | ------------ |
324
324
  | 布尔值 | 是否设置成功 |
325
325
 
326
326
  **示例:**
package/docs/apicn/pip.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## 功能特性
6
6
 
7
- - **显示模式**:支持日志、保活和自定义三种显示模式
7
+ - **显示模式**:支持日志、保活和自定义三种显示模式;首次安装默认保活
8
8
  - **关闭控制**:支持主动关闭悬浮窗
9
9
  - **状态查询**:判断悬浮窗是否正在显示
10
10
  - **尺寸设置**:日志模式和自定义模式支持设置内容宽高,并按模式分别持久化
@@ -13,6 +13,12 @@
13
13
  - **CPU 管理**: 获取 CPU 使用率
14
14
  - **快点 Agent 服务**: 启动 Agent 服务
15
15
 
16
+ ## 常见问题
17
+
18
+ 1、获取剪切板每次都会弹窗
19
+
20
+ 从设置找到快点JS点进去->把从其他 App 粘贴设置为允许
21
+
16
22
  ## API 参考
17
23
 
18
24
  ### 应用管理
@@ -194,7 +200,9 @@ function 获取安装的应用列表(): {
194
200
  ```javascript
195
201
  const apps = $系统.获取安装的应用列表();
196
202
  for (const app of apps) {
197
- $打印信息日志(`${app.appName}: ${app.bundleIdentifier} (${app.bundleVersion})`);
203
+ $打印信息日志(
204
+ `${app.appName}: ${app.bundleIdentifier} (${app.bundleVersion})`,
205
+ );
198
206
  }
199
207
  ```
200
208
 
@@ -206,8 +214,8 @@ function 最近应用(): 布尔值;
206
214
 
207
215
  **返回值:**
208
216
 
209
- | 类型 | 描述 |
210
- | -------- | ---------------------- |
217
+ | 类型 | 描述 |
218
+ | -------- | ----------------------- |
211
219
  | `布尔值` | 是否成功打开 App 切换器 |
212
220
 
213
221
  **示例:**
@@ -435,13 +443,13 @@ function 获取内存使用信息(): {
435
443
 
436
444
  **返回值:**
437
445
 
438
- | 参数名 | 类型 | 描述 |
439
- | ----------------- | ---- | ---------------------------- |
440
- | `used` | 数字 | 当前应用占用(单位:MB) |
441
- | `available` | 数字 | 系统可用内存(单位:MB) |
442
- | `total` | 数字 | 系统总内存(单位:MB) |
443
- | `systemUsed` | 数字 | 系统已用内存(单位:MB) |
444
- | `usagePercentage` | 数字 | 系统内存占用率(百分比) |
446
+ | 参数名 | 类型 | 描述 |
447
+ | ----------------- | ---- | ------------------------ |
448
+ | `used` | 数字 | 当前应用占用(单位:MB) |
449
+ | `available` | 数字 | 系统可用内存(单位:MB) |
450
+ | `total` | 数字 | 系统总内存(单位:MB) |
451
+ | `systemUsed` | 数字 | 系统已用内存(单位:MB) |
452
+ | `usagePercentage` | 数字 | 系统内存占用率(百分比) |
445
453
 
446
454
  **说明:**
447
455
 
@@ -561,8 +569,8 @@ function 获取系统已用内存(): 数字;
561
569
 
562
570
  **返回值:**
563
571
 
564
- | 参数名 | 类型 | 描述 |
565
- | ------------ | ---- | -------------------------- |
572
+ | 参数名 | 类型 | 描述 |
573
+ | ------------ | ---- | ---------------------------- |
566
574
  | `systemUsed` | 数字 | 系统已用内存大小(单位:MB) |
567
575
 
568
576
  **说明:**
@@ -593,8 +601,8 @@ function 获取CPU使用率(): 数字;
593
601
 
594
602
  **返回值:**
595
603
 
596
- | 类型 | 描述 |
597
- | ------ | ---------------------------- |
604
+ | 类型 | 描述 |
605
+ | ------ | ----------------------------- |
598
606
  | `数字` | 当前应用 CPU 使用率(百分比) |
599
607
 
600
608
  **示例:**
@@ -12,7 +12,8 @@
12
12
 
13
13
  - **独立的执行环境**: 线程函数在独立的 JavaScript 环境中运行,无法访问主线程或其他作用域中的变量、函数或对象。
14
14
  - **闭包限制**: 即使线程函数是闭包形式,它也无法捕获外部变量。传递给 `$线程.运行` 的函数会被转换并在新的上下文中执行。
15
- - **数据通信**: 如果需要与主线程通信或使用外部数据,请使用 `$共享状态` 全局对象。
15
+ - **启动参数**: 主线程可以向 `$线程.运行` 传入一个 Object,子线程通过全局变量 `$线程参数` 读取。
16
+ - **数据通信**: 线程启动后的双向数据通信请使用 `$共享状态` 全局对象。
16
17
  - **文件名限制**:执行的线程 js 文件名称必须以 `_thread.js` 结尾,例如 `worker_thread.js`。
17
18
 
18
19
  ## API 参考
@@ -21,17 +22,18 @@
21
22
 
22
23
  #### $线程.运行 - 异步执行代码
23
24
 
24
- 启动一个新的线程来执行指定的函数。
25
+ 启动一个新的线程来执行指定的 JS 文件。
25
26
 
26
27
  ```typescript
27
- function 运行(线程函数: () => 无返回值): 线程;
28
+ function 运行(线程js文件名: 字符串, 启动参数?: 字典<任意类型>): 线程;
28
29
  ```
29
30
 
30
31
  **参数:**
31
32
 
32
- | 参数名 | 类型 | 描述 |
33
- | ---------- | ---------------- | ---------------------- |
34
- | `线程函数` | `() => 无返回值` | 要在子线程中执行的函数 |
33
+ | 参数名 | 类型 | 描述 |
34
+ | ---------------- | ---------------- | ---------------------------------------------- |
35
+ | `线程js文件名` | `字符串` | 线程 js 文件路径 |
36
+ | `启动参数` | `字典<任意类型>` | 可选启动参数,只能传 Object;子线程通过 `$线程参数` 读取 |
35
37
 
36
38
  **返回值:**
37
39
 
@@ -42,8 +44,13 @@ function 运行(线程函数: () => 无返回值): 线程;
42
44
  **示例:**
43
45
 
44
46
  ```javascript
45
- // 启动一个简单的线程
46
- const t = $线程.运行("test_thread.js");
47
+ // 主线程传入启动参数
48
+ const t = $线程.运行("test_thread.js", { 任务编号: 1, 标题: "同步任务" });
49
+ ```
50
+
51
+ ```javascript
52
+ // test_thread.js
53
+ $打印信息日志(`任务 ${$线程参数.任务编号}: ${$线程参数.标题}`);
47
54
  ```
48
55
 
49
56
  #### $线程.停止所有 - 停止所有线程
@@ -303,8 +303,8 @@ def setScreenBrightness(brightness: float) -> bool
303
303
 
304
304
  **返回值:**
305
305
 
306
- | 类型 | 描述 |
307
- | ------ | ------------------------ |
306
+ | 类型 | 描述 |
307
+ | ------ | ------------ |
308
308
  | `bool` | 是否设置成功 |
309
309
 
310
310
  **示例:**
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## 功能特性
6
6
 
7
- - **显示模式**:支持日志、保活和自定义三种显示模式
7
+ - **显示模式**:支持日志、保活和自定义三种显示模式;首次安装默认保活
8
8
  - **关闭控制**:支持主动关闭悬浮窗
9
9
  - **状态查询**:判断悬浮窗是否正在显示
10
10
  - **尺寸设置**:日志模式和自定义模式支持设置内容宽高,并按模式分别持久化
@@ -13,6 +13,12 @@
13
13
  - **CPU 管理**: 获取 CPU 使用率
14
14
  - **快点 Agent 服务**: 启动 快点 Agent 服务
15
15
 
16
+ ## 常见问题
17
+
18
+ 1、获取剪切板每次都会弹窗
19
+
20
+ 从设置找到快点JS点进去->把从其他 App 粘贴设置为允许
21
+
16
22
  ## 类型定义
17
23
 
18
24
  ### ActivateAppInfo
@@ -225,8 +231,8 @@ def recent() -> bool
225
231
 
226
232
  **返回值:**
227
233
 
228
- | 类型 | 描述 |
229
- | ------ | ---------------------- |
234
+ | 类型 | 描述 |
235
+ | ------ | ----------------------- |
230
236
  | `bool` | 是否成功打开 App 切换器 |
231
237
 
232
238
  **示例:**
@@ -513,6 +513,74 @@ GET /api/setVolume
513
513
  | --------- | ------- | ---- | ---- | -------- | ---- |
514
514
  | » success | boolean | true | none | 是否成功 | none |
515
515
 
516
+ ## GET 获取系统剪切板
517
+
518
+ GET /api/getClipboard
519
+
520
+ 该接口读取系统文本剪切板,不要求 API 键盘处于弹出状态。剪切板为空、内容不是文本或读取失败时,`data` 为 `""`。
521
+
522
+ > 返回示例
523
+
524
+ > 200 Response
525
+
526
+ ```json
527
+ {
528
+ "success": true,
529
+ "data": "示例文本"
530
+ }
531
+ ```
532
+
533
+ ### 返回结果
534
+
535
+ | 状态码 | 状态码含义 | 说明 | 数据模型 |
536
+ | ------ | ------------------------------------------------------- | ---- | -------- |
537
+ | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | none | Inline |
538
+
539
+ ### 返回数据结构
540
+
541
+ 状态码 **200**
542
+
543
+ | 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
544
+ | --------- | ------- | ---- | ---- | ---------- | -------------------------- |
545
+ | » success | boolean | true | none | 是否成功 | none |
546
+ | » data | string | true | none | 剪切板内容 | 空内容或读取失败时为 `""` |
547
+
548
+ ## GET 设置系统剪切板
549
+
550
+ GET /api/setClipboard
551
+
552
+ 该接口设置系统文本剪切板,不要求 API 键盘处于弹出状态。`text` 参数必须存在;传入空字符串可以清空文本剪切板。
553
+
554
+ ### 请求参数
555
+
556
+ | 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
557
+ | ---- | ----- | ------ | ---- | ---------- | ------------------------------------ |
558
+ | text | query | string | 是 | 剪切板内容 | 需要 URL 编码;空字符串表示清空剪切板 |
559
+
560
+ > 返回示例
561
+
562
+ > 200 Response
563
+
564
+ ```json
565
+ {
566
+ "success": true
567
+ }
568
+ ```
569
+
570
+ ### 返回结果
571
+
572
+ | 状态码 | 状态码含义 | 说明 | 数据模型 |
573
+ | ------ | ------------------------------------------------------- | ---- | -------- |
574
+ | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | none | Inline |
575
+
576
+ ### 返回数据结构
577
+
578
+ 状态码 **200**
579
+
580
+ | 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
581
+ | --------- | ------- | ---- | ---- | -------- | ---- |
582
+ | » success | boolean | true | none | 是否成功 | none |
583
+
516
584
  ## POST 登录接口
517
585
 
518
586
  POST /api/login
@@ -908,23 +976,6 @@ GET /mirror/flv
908
976
 
909
977
  响应类型为 `video/x-flv`,服务端持续输出 FLV 容器内的 H.264 视频 tag。
910
978
 
911
- ## WHEP 实时屏幕画面流
912
-
913
- POST /mirror/whep
914
-
915
- ### 请求参数
916
-
917
- | 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
918
- | ------------- | ----- | ------- | ---- | ------ | ----------------------------------- |
919
- | fps | query | integer | 否 | | 帧率,默认 10,范围 1-60 |
920
- | quality | query | number | 否 | | JPEG 源质量,默认 0.25,范围 0.1-1.0 |
921
- | scalingFactor | query | number | 否 | | 缩放比例,默认 1.0,范围 0.1-1.0 |
922
- | bitrate | query | number | 否 | | WebRTC 发送码率,单位 Mbps,默认 4 |
923
-
924
- ### 返回数据
925
-
926
- 请求 body 为 `application/sdp` 的 WebRTC offer;响应类型为 `application/sdp`,内容为 WebRTC answer。
927
-
928
979
  ## POST 执行脚本(仅支持JS脚本)
929
980
 
930
981
  POST /api/runScript
@@ -1634,6 +1685,51 @@ GET /api/control/pressButton
1634
1685
  | --------- | ------- | ---- | ---- | -------- | ---- |
1635
1686
  | » success | boolean | true | none | 是否成功 | none |
1636
1687
 
1688
+ ## POST 发送键盘按键或组合键
1689
+
1690
+ POST /api/control/sendKey
1691
+
1692
+ `keys` 支持整数或字符串元素。通用控制接口可能切换 Agent 与 HID 链路,跨链路使用时建议优先传键名或单个 ASCII 字符;整数编码需要与当前控制链路一致。
1693
+
1694
+ > Body 请求参数
1695
+
1696
+ ```json
1697
+ {
1698
+ "keys": ["COMMAND", "c"]
1699
+ }
1700
+ ```
1701
+
1702
+ ### 请求参数
1703
+
1704
+ | 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
1705
+ | ------ | ---- | ------ | ---- | ------ | ---------------------------- |
1706
+ | body | body | object | 是 | | none |
1707
+ | » keys | body | array | 是 | 按键 | 元素支持整数、键名或单个字符 |
1708
+
1709
+ > 返回示例
1710
+
1711
+ > 200 Response
1712
+
1713
+ ```json
1714
+ {
1715
+ "success": true
1716
+ }
1717
+ ```
1718
+
1719
+ ### 返回结果
1720
+
1721
+ | 状态码 | 状态码含义 | 说明 | 数据模型 |
1722
+ | ------ | ------------------------------------------------------- | ---- | -------- |
1723
+ | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | none | Inline |
1724
+
1725
+ ### 返回数据结构
1726
+
1727
+ 状态码 **200**
1728
+
1729
+ | 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
1730
+ | --------- | ------- | ---- | ---- | -------- | ---- |
1731
+ | » success | boolean | true | none | 是否成功 | none |
1732
+
1637
1733
  ## GET (仅键盘弹出可用)输入文字
1638
1734
 
1639
1735
  GET /api/control/input
@@ -2147,6 +2243,51 @@ GET /api/hid/pressButton
2147
2243
  | --------- | ------- | ---- | ---- | -------- | ---- |
2148
2244
  | » success | boolean | true | none | 是否成功 | none |
2149
2245
 
2246
+ ## POST 发送 HID 键盘按键或组合键
2247
+
2248
+ POST /api/hid/sendKey
2249
+
2250
+ `keys` 支持整数或字符串元素。字符串可使用 HID 键名或单个 ASCII 字符;整数使用 HID 模块的按键编码。
2251
+
2252
+ > Body 请求参数
2253
+
2254
+ ```json
2255
+ {
2256
+ "keys": ["COMMAND", "c"]
2257
+ }
2258
+ ```
2259
+
2260
+ ### 请求参数
2261
+
2262
+ | 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
2263
+ | ------ | ---- | ------ | ---- | ------ | ---------------------------- |
2264
+ | body | body | object | 是 | | none |
2265
+ | » keys | body | array | 是 | 按键 | 元素支持整数、键名或单个字符 |
2266
+
2267
+ > 返回示例
2268
+
2269
+ > 200 Response
2270
+
2271
+ ```json
2272
+ {
2273
+ "success": true
2274
+ }
2275
+ ```
2276
+
2277
+ ### 返回结果
2278
+
2279
+ | 状态码 | 状态码含义 | 说明 | 数据模型 |
2280
+ | ------ | ------------------------------------------------------- | ---- | -------- |
2281
+ | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | none | Inline |
2282
+
2283
+ ### 返回数据结构
2284
+
2285
+ 状态码 **200**
2286
+
2287
+ | 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
2288
+ | --------- | ------- | ---- | ---- | -------- | ---- |
2289
+ | » success | boolean | true | none | 是否成功 | none |
2290
+
2150
2291
  ## GET 快捷指令截图
2151
2292
 
2152
2293
  GET /api/hid/shortcutScreenshot
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ms-vite-plugin",
3
- "version": "1.4.35",
3
+ "version": "1.4.37",
4
4
  "type": "commonjs",
5
5
  "license": "MIT",
6
6
  "publishConfig": {