ms-vite-plugin 1.4.38 → 1.4.39

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.
Binary file
Binary file
package/docs/api/file.md CHANGED
@@ -47,50 +47,6 @@ logi(`文档目录: ${documentsDir}`);
47
47
  logi(`临时目录: ${tempDir}`);
48
48
  ```
49
49
 
50
- #### getDataDir - 获取应用数据目录路径。
51
-
52
- ```typescript
53
- function getDataDir(): string;
54
- ```
55
-
56
- **返回值:**
57
-
58
- | 类型 | 描述 |
59
- | -------- | ---------------- |
60
- | `string` | 应用数据目录路径 |
61
-
62
- **示例:**
63
-
64
- ```javascript
65
- const dataDir = file.getDataDir();
66
- logi(`数据目录: ${dataDir}`);
67
- ```
68
-
69
- #### getDataFile - 获取应用数据文件的完整路径。
70
-
71
- ```typescript
72
- function getDataFile(file: string): string;
73
- ```
74
-
75
- **参数:**
76
-
77
- | 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
78
- | ------ | ------ | -------- | ------ | ------------ |
79
- | `file` | string | 是 | - | 文件名或路径 |
80
-
81
- **返回值:**
82
-
83
- | 类型 | 描述 |
84
- | -------- | ------------ |
85
- | `string` | 文件完整路径 |
86
-
87
- **示例:**
88
-
89
- ```javascript
90
- const configPath = file.getDataFile("config.json");
91
- logi(`配置文件路径: ${configPath}`);
92
- ```
93
-
94
50
  #### mkdirs - 创建目录(支持递归创建)。
95
51
 
96
52
  ```typescript
@@ -328,6 +284,54 @@ if (config) {
328
284
  }
329
285
  ```
330
286
 
287
+ #### getResFile - 获取 `res` 资源的本地文件路径。
288
+
289
+ 适用于需要真实文件路径的场景(如模型文件、音视频)。用完后应调用 `cleanupResFile`。
290
+
291
+ ```typescript
292
+ function getResFile(fileName: string): string | null;
293
+ ```
294
+
295
+ **参数:**
296
+
297
+ | 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
298
+ | ---------- | ------ | -------- | ------ | --------------------- |
299
+ | `fileName` | string | 是 | - | 相对 `res` 目录的路径 |
300
+
301
+ **返回值:**
302
+
303
+ | 类型 | 描述 |
304
+ | -------------- | ----------------------------------------- |
305
+ | `string\|null` | 本地文件绝对路径;失败或不存在时返回 null |
306
+
307
+ **示例:**
308
+
309
+ ```javascript
310
+ const path = file.getResFile("model.bin");
311
+ if (path) {
312
+ // 使用 path ...
313
+ file.cleanupResFile(path);
314
+ }
315
+ ```
316
+
317
+ #### cleanupResFile - 清理由 `getResFile` 得到的本地文件。
318
+
319
+ ```typescript
320
+ function cleanupResFile(path: string): void;
321
+ ```
322
+
323
+ **参数:**
324
+
325
+ | 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
326
+ | ------ | ------ | -------- | ------ | ------------------------- |
327
+ | `path` | string | 是 | - | `getResFile` 返回的文件路径 |
328
+
329
+ **示例:**
330
+
331
+ ```javascript
332
+ file.cleanupResFile(path);
333
+ ```
334
+
331
335
  #### writeFile - 写入文件内容(覆盖原有内容)。
332
336
 
333
337
  ```typescript
package/docs/api/pip.md CHANGED
@@ -7,7 +7,7 @@
7
7
  - **显示模式**:支持日志、保活和自定义三种显示模式;首次安装默认保活
8
8
  - **关闭控制**:支持主动关闭悬浮窗
9
9
  - **状态查询**:判断悬浮窗是否正在显示
10
- - **尺寸设置**:日志模式和自定义模式支持设置内容宽高,并按模式分别持久化
10
+ - **尺寸设置**:日志模式和自定义模式支持设置内容宽高比(实际显示尺寸由系统决定),并按模式分别持久化
11
11
  - **日志显示**:日志模式支持设置日志文字大小
12
12
  - **自定义文本**:自定义模式支持文本、换行、文字颜色、背景色和文字大小
13
13
 
@@ -129,14 +129,14 @@ const success = pip.closeWindow();
129
129
  function setContentSize(width: number, height: number): boolean;
130
130
  ```
131
131
 
132
- 设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸;悬浮窗关闭状态和保活模式不会生效。
132
+ 设置日志模式或自定义模式的悬浮窗内容尺寸。传入的宽高表示宽高比,不是最终像素尺寸;悬浮窗实际显示的宽高由系统决定。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸;悬浮窗关闭状态和保活模式不会生效。
133
133
 
134
134
  **参数:**
135
135
 
136
136
  | 参数 | 类型 | 必填 | 描述 |
137
137
  | -------- | ---------------- | ---- | ---------------------------------------------- |
138
- | `width` | `number` | 是 | 目标内容宽度 |
139
- | `height` | `number` | 是 | 目标内容高度 |
138
+ | `width` | `number` | 是 | 宽度方向比例值(与 `height` 共同决定宽高比,不是像素) |
139
+ | `height` | `number` | 是 | 高度方向比例值(与 `width` 共同决定宽高比,不是像素) |
140
140
 
141
141
  **返回值:**
142
142
 
@@ -47,50 +47,6 @@ $打印信息日志(`文档目录: ${文档目录}`);
47
47
  $打印信息日志(`临时目录: ${临时目录}`);
48
48
  ```
49
49
 
50
- #### 获取数据目录
51
-
52
- ```typescript
53
- function 获取数据目录(): 字符串;
54
- ```
55
-
56
- **返回值:**
57
-
58
- | 类型 | 描述 |
59
- | -------- | ---------------- |
60
- | `字符串` | 应用数据目录路径 |
61
-
62
- **示例:**
63
-
64
- ```javascript
65
- const 数据目录 = $文件.获取数据目录();
66
- $打印信息日志(`数据目录: ${数据目录}`);
67
- ```
68
-
69
- #### 获取数据文件路径
70
-
71
- ```typescript
72
- function 获取数据文件路径(文件名称: 字符串): 字符串;
73
- ```
74
-
75
- **参数:**
76
-
77
- | 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
78
- | ---------- | ------ | -------- | ------ | ------------ |
79
- | `文件名称` | 字符串 | 是 | - | 文件名或路径 |
80
-
81
- **返回值:**
82
-
83
- | 类型 | 描述 |
84
- | -------- | ------------ |
85
- | `字符串` | 文件完整路径 |
86
-
87
- **示例:**
88
-
89
- ```javascript
90
- const 配置文件路径 = $文件.获取数据文件路径("config.json");
91
- $打印信息日志(`配置文件路径: ${配置文件路径}`);
92
- ```
93
-
94
50
  #### 创建目录 - 创建目录(支持递归创建)。
95
51
 
96
52
  ```typescript
@@ -331,6 +287,54 @@ if (配置文件内容) {
331
287
  }
332
288
  ```
333
289
 
290
+ #### 获取资源文件 - 获取 `res` 资源的本地文件路径。
291
+
292
+ 适用于需要真实文件路径的场景(如模型文件、音视频)。用完后应调用 `清理资源文件`。
293
+
294
+ ```typescript
295
+ function 获取资源文件(文件名: 字符串): 字符串 | null;
296
+ ```
297
+
298
+ **参数:**
299
+
300
+ | 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
301
+ | -------- | ------ | -------- | ------ | --------------------- |
302
+ | `文件名` | 字符串 | 是 | - | 相对 `res` 目录的路径 |
303
+
304
+ **返回值:**
305
+
306
+ | 类型 | 描述 |
307
+ | -------------- | ------------------------------------------ |
308
+ | `字符串\|null` | 本地文件绝对路径;失败或不存在时返回 null |
309
+
310
+ **示例:**
311
+
312
+ ```javascript
313
+ const 路径 = $文件.获取资源文件("model.bin");
314
+ if (路径) {
315
+ // 使用 路径 ...
316
+ $文件.清理资源文件(路径);
317
+ }
318
+ ```
319
+
320
+ #### 清理资源文件 - 清理由 `获取资源文件` 得到的本地文件。
321
+
322
+ ```typescript
323
+ function 清理资源文件(文件路径: 字符串): void;
324
+ ```
325
+
326
+ **参数:**
327
+
328
+ | 参数名 | 类型 | 是否必填 | 默认值 | 描述 |
329
+ | ---------- | ------ | -------- | ------ | ---------------------------- |
330
+ | `文件路径` | 字符串 | 是 | - | `获取资源文件` 返回的文件路径 |
331
+
332
+ **示例:**
333
+
334
+ ```javascript
335
+ $文件.清理资源文件(路径);
336
+ ```
337
+
334
338
  #### 写入文件 - 写入文件内容(覆盖原有内容)。
335
339
 
336
340
  ```typescript
package/docs/apicn/pip.md CHANGED
@@ -7,7 +7,7 @@
7
7
  - **显示模式**:支持日志、保活和自定义三种显示模式;首次安装默认保活
8
8
  - **关闭控制**:支持主动关闭悬浮窗
9
9
  - **状态查询**:判断悬浮窗是否正在显示
10
- - **尺寸设置**:日志模式和自定义模式支持设置内容宽高,并按模式分别持久化
10
+ - **尺寸设置**:日志模式和自定义模式支持设置内容宽高比(实际显示尺寸由系统决定),并按模式分别持久化
11
11
  - **日志显示**:日志模式支持设置日志文字大小
12
12
  - **自定义文本**:自定义模式支持文本、换行、文字颜色、背景色和文字大小
13
13
 
@@ -129,14 +129,14 @@ const 是否成功 = $悬浮窗.关闭悬浮窗();
129
129
  function 设置内容尺寸(宽度: 数字, 高度: 数字): 布尔值;
130
130
  ```
131
131
 
132
- 设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸;悬浮窗关闭状态和保活模式不会生效。
132
+ 设置日志模式或自定义模式的悬浮窗内容尺寸。传入的宽高表示宽高比,不是最终像素尺寸;悬浮窗实际显示的宽高由系统决定。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸;悬浮窗关闭状态和保活模式不会生效。
133
133
 
134
134
  **参数:**
135
135
 
136
136
  | 参数 | 类型 | 必填 | 描述 |
137
137
  | ------ | ------------- | ---- | ---------------------------------------------- |
138
- | `宽度` | `数字` | 是 | 目标内容宽度 |
139
- | `高度` | `数字` | 是 | 目标内容高度 |
138
+ | `宽度` | `数字` | 是 | 宽度方向比例值(与高度共同决定宽高比,不是像素) |
139
+ | `高度` | `数字` | 是 | 高度方向比例值(与宽度共同决定宽高比,不是像素) |
140
140
 
141
141
  **返回值:**
142
142
 
@@ -48,52 +48,6 @@ print(documents_dir)
48
48
  print(temp_dir)
49
49
  ```
50
50
 
51
- #### getDataDir - 获取应用数据目录路径
52
-
53
- ```python
54
- def getDataDir() -> str
55
- ```
56
-
57
- **返回值:**
58
-
59
- | 类型 | 描述 |
60
- | ----- | ---------------- |
61
- | `str` | 应用数据目录路径 |
62
-
63
- **示例:**
64
-
65
- ```python
66
- from kuaijs import file
67
- data_dir = file.getDataDir()
68
- print(data_dir)
69
- ```
70
-
71
- #### getDataFile - 获取应用数据文件的完整路径
72
-
73
- ```python
74
- def getDataFile(file: str) -> str
75
- ```
76
-
77
- **参数:**
78
-
79
- | 参数名 | 类型 | 是否必填 | 描述 |
80
- | ------ | ---- | -------- | ------------ |
81
- | `file` | str | 是 | 文件名或路径 |
82
-
83
- **返回值:**
84
-
85
- | 类型 | 描述 |
86
- | ----- | ------------ |
87
- | `str` | 文件完整路径 |
88
-
89
- **示例:**
90
-
91
- ```python
92
- from kuaijs import file
93
- config_path = file.getDataFile("config.json")
94
- print(config_path)
95
- ```
96
-
97
51
  #### mkdirs - 创建目录(支持递归创建)
98
52
 
99
53
  ```python
@@ -281,7 +235,7 @@ def readFile(path: str) -> Optional[str]
281
235
 
282
236
  ```python
283
237
  from kuaijs import file
284
- p = file.getDataFile("read.txt")
238
+ p = file.getInternalDir("documents") + "/read.txt"
285
239
  file.writeFile(p, "line1\nline2")
286
240
  print(file.readFile(p))
287
241
  ```
@@ -315,6 +269,55 @@ if config:
315
269
  print(config)
316
270
  ```
317
271
 
272
+ #### getResFile - 获取 res 资源的本地文件路径
273
+
274
+ 适用于需要真实文件路径的场景(如模型文件、音视频)。用完后应调用 `cleanupResFile`。
275
+
276
+ ```python
277
+ def getResFile(fileName: str) -> Optional[str]
278
+ ```
279
+
280
+ **参数:**
281
+
282
+ | 参数名 | 类型 | 是否必填 | 描述 |
283
+ | ---------- | ---- | -------- | --------------------- |
284
+ | `fileName` | str | 是 | 相对 `res` 目录的路径 |
285
+
286
+ **返回值:**
287
+
288
+ | 类型 | 描述 |
289
+ | ------------- | ---------------------------------------- |
290
+ | `str \| None` | 本地文件绝对路径;失败或不存在时返回 None |
291
+
292
+ **示例:**
293
+
294
+ ```python
295
+ from kuaijs import file
296
+ path = file.getResFile("model.bin")
297
+ if path:
298
+ # 使用 path ...
299
+ file.cleanupResFile(path)
300
+ ```
301
+
302
+ #### cleanupResFile - 清理由 getResFile 得到的本地文件
303
+
304
+ ```python
305
+ def cleanupResFile(path: str) -> None
306
+ ```
307
+
308
+ **参数:**
309
+
310
+ | 参数名 | 类型 | 是否必填 | 描述 |
311
+ | ------ | ---- | -------- | -------------------------- |
312
+ | `path` | str | 是 | `getResFile` 返回的文件路径 |
313
+
314
+ **示例:**
315
+
316
+ ```python
317
+ from kuaijs import file
318
+ file.cleanupResFile(path)
319
+ ```
320
+
318
321
  #### writeFile - 写入文件内容(覆盖)
319
322
 
320
323
  ```python
@@ -7,7 +7,7 @@
7
7
  - **显示模式**:支持日志、保活和自定义三种显示模式;首次安装默认保活
8
8
  - **关闭控制**:支持主动关闭悬浮窗
9
9
  - **状态查询**:判断悬浮窗是否正在显示
10
- - **尺寸设置**:日志模式和自定义模式支持设置内容宽高,并按模式分别持久化
10
+ - **尺寸设置**:日志模式和自定义模式支持设置内容宽高比(实际显示尺寸由系统决定),并按模式分别持久化
11
11
  - **日志显示**:日志模式支持设置日志文字大小
12
12
  - **自定义文本**:自定义模式支持文本、换行、文字颜色、背景色和文字大小
13
13
 
@@ -133,7 +133,7 @@ success = pip.closeWindow()
133
133
 
134
134
  ### setContentSize - 设置内容尺寸
135
135
 
136
- 设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸;悬浮窗关闭状态和保活模式不会生效。
136
+ 设置日志模式或自定义模式的悬浮窗内容尺寸。传入的宽高表示宽高比,不是最终像素尺寸;悬浮窗实际显示的宽高由系统决定。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸;悬浮窗关闭状态和保活模式不会生效。
137
137
 
138
138
  ```python
139
139
  def setContentSize(width: float, height: float) -> bool
@@ -143,8 +143,8 @@ def setContentSize(width: float, height: float) -> bool
143
143
 
144
144
  | 参数 | 类型 | 必填 | 描述 |
145
145
  | -------- | ---------------- | ---- | ----------------------------- |
146
- | `width` | `float` | 是 | 目标内容宽度 |
147
- | `height` | `float` | 是 | 目标内容高度 |
146
+ | `width` | `float` | 是 | 宽度方向比例值(与 `height` 共同决定宽高比,不是像素) |
147
+ | `height` | `float` | 是 | 高度方向比例值(与 `width` 共同决定宽高比,不是像素) |
148
148
 
149
149
  **返回值:**
150
150
 
@@ -585,12 +585,13 @@ GET /api/setClipboard
585
585
 
586
586
  POST /api/login
587
587
 
588
- 用户授权模式下,该接口会使用账号密码执行登录。授权卡密模式下,该接口是兼容旧控制端的空操作,会直接返回成功,不读取请求体字段,也不执行账号登录。
588
+ 用户授权模式下,该接口会使用账号密码执行登录。授权卡密模式下,该接口是兼容旧控制端的空操作,会直接返回成功,不读取请求体字段,不切换服务器类型,也不执行账号登录。
589
589
 
590
590
  > Body 请求参数
591
591
 
592
592
  ```json
593
593
  {
594
+ "serverType": "domestic",
594
595
  "username": "string",
595
596
  "password": "string"
596
597
  }
@@ -601,9 +602,17 @@ POST /api/login
601
602
  | 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
602
603
  | ------------ | ---- | ------ | ---- | ---------- | ---- |
603
604
  | body | body | object | 是 | | none |
605
+ | » serverType | body | string | 是 | 服务器类型 | 用户授权模式下使用;授权卡密模式下忽略 |
604
606
  | » username | body | string | 是 | 用户名 | 用户授权模式下使用;授权卡密模式下忽略 |
605
607
  | » password | body | string | 是 | 密码 | 用户授权模式下使用;授权卡密模式下忽略 |
606
608
 
609
+ #### 枚举值
610
+
611
+ | 属性 | 值 |
612
+ | ------------ | ------------- |
613
+ | » serverType | domestic |
614
+ | » serverType | international |
615
+
607
616
  > 返回示例
608
617
 
609
618
  > 200 Response
@@ -713,6 +722,7 @@ GET /api/status
713
722
  "isVolumeControlEnabled": true,
714
723
  "agentVersion": "string",
715
724
  "appVersion": "string",
725
+ "serverType": "international",
716
726
  "isHidConnected": true,
717
727
  "isShowUI": true,
718
728
  "isLogin": true,
@@ -773,6 +783,7 @@ GET /api/status
773
783
  | »» isVolumeControlEnabled | boolean | true | none | 是否开启了音量键启停 | none |
774
784
  | »» agentVersion | string | true | none | agent版本号 | none |
775
785
  | »» appVersion | string | true | none | app版本号 | none |
786
+ | »» serverType | string | true | none | 授权服务器类型 | none |
776
787
  | »» isHidConnected | boolean | true | none | hid设备是否连接 | none |
777
788
  | »» isShowUI | boolean | true | none | 实现显示了 UI | none |
778
789
  | »» isLogin | boolean | true | none | 是否登录 | none |
@@ -786,6 +797,8 @@ GET /api/status
786
797
  | orientation | LANDSCAPE |
787
798
  | authMode | user |
788
799
  | authMode | card |
800
+ | serverType | international |
801
+ | serverType | domestic |
789
802
 
790
803
  ## GET App切到前台
791
804
 
@@ -3310,6 +3323,7 @@ GET /mirror/image
3310
3323
  "isVolumeControlEnabled": true,
3311
3324
  "agentVersion": "string",
3312
3325
  "appVersion": "string",
3326
+ "serverType": "international",
3313
3327
  "isHidConnected": true,
3314
3328
  "isShowUI": true,
3315
3329
  "isLogin": true,
@@ -3359,6 +3373,7 @@ GET /mirror/image
3359
3373
  | isVolumeControlEnabled | boolean | true | none | 是否开启了音量键启停 | none |
3360
3374
  | agentVersion | string | true | none | agent版本号 | none |
3361
3375
  | appVersion | string | true | none | app版本号 | none |
3376
+ | serverType | string | true | none | 授权服务器类型 | none |
3362
3377
  | isHidConnected | boolean | true | none | hid设备是否连接 | none |
3363
3378
  | isShowUI | boolean | true | none | 实现显示了 UI | none |
3364
3379
  | isLogin | boolean | true | none | 是否登录 | none |
@@ -3372,3 +3387,5 @@ GET /mirror/image
3372
3387
  | orientation | LANDSCAPE |
3373
3388
  | authMode | user |
3374
3389
  | authMode | card |
3390
+ | serverType | international |
3391
+ | serverType | domestic |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ms-vite-plugin",
3
- "version": "1.4.38",
3
+ "version": "1.4.39",
4
4
  "type": "commonjs",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
@@ -44,4 +44,4 @@
44
44
  "@types/ws": "^8.18.1",
45
45
  "typescript": "~6.0.3"
46
46
  }
47
- }
47
+ }