ms-vite-plugin 1.4.33 → 1.4.34

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.
Files changed (10) hide show
  1. package/docs/api/cloud.md +1 -0
  2. package/docs/api/netCard.md +51 -13
  3. package/docs/api/ui.md +25 -0
  4. package/docs/apicn/cloud.md +1 -0
  5. package/docs/apicn/netCard.md +51 -13
  6. package/docs/apicn/ui.md +25 -0
  7. package/docs/apipython/cloud.md +1 -0
  8. package/docs/apipython/netCard.md +51 -13
  9. package/docs/httpapi/api.md +12 -0
  10. package/package.json +1 -1
package/docs/api/cloud.md CHANGED
@@ -5,6 +5,7 @@
5
5
  ## 注意事项
6
6
 
7
7
  - `cloud` 只在主脚本上下文注册，不支持在线程脚本里调用。
8
+ - 授权卡密模式不可用。
8
9
  - 服务器事件只有一个主脚本监听槽位，多次调用 `onEvent` 会覆盖旧监听。
9
10
 
10
11
  ## 协议
package/docs/api/netCard.md CHANGED
@@ -11,10 +11,46 @@
11
11
  ## 注意事项
12
12
 
13
13
  1. **卡密安全**: 卡密信息应当妥善保管，避免在日志中明文输出
14
- 2. **API 调用顺序**: 验证卡密后，其他 api 才能调用
14
+ 2. **普通卡密模式**: 需要先调用 `netCard.verify(cardNo)` 验证卡密，验证通过后才能调用获取卡密信息、备注和云变量等接口
15
+ 3. **授权卡密模式**: App 打开加密 UI 或运行脚本前会完成授权和卡密验证，脚本中不需要重复让用户输入卡密，也不需要重复调用 `netCard.verify`
16
+ 4. **兼容旧脚本**: 授权卡密模式下调用 `netCard.verify` 会直接返回 `true`，用于兼容原来已经写了 `verify` 的脚本
15
17
 
16
18
  ## API 参考
17
19
 
20
+ ### 授权模式
21
+
22
+ #### isAuthCardMode - 判断是否为授权卡密模式
23
+
24
+ ```typescript
25
+ function isAuthCardMode(): boolean;
26
+ ```
27
+
28
+ **返回值：**
29
+
30
+ | 类型 | 描述 |
31
+ | --------- | ------------------------------------------------ |
32
+ | `boolean` | 当前 App 处于授权卡密模式返回 `true`，否则返回 `false` |
33
+
34
+ **说明：**
35
+
36
+ 授权卡密模式下，App 层会在打开加密 UI 或运行脚本前完成授权和卡密验证。脚本侧可以用该方法判断当前模式；返回 `true` 时，不需要再弹输入框让用户填写卡密，也不需要再调用 `netCard.verify`。
37
+
38
+ 普通卡密模式下，该方法返回 `false`，脚本仍需要按原流程调用 `netCard.verify(cardNo)`。
39
+
40
+ **示例：**
41
+
42
+ ```typescript
43
+ if (netCard.isAuthCardMode()) {
44
+ logi("当前为授权卡密模式，不需要重复验证卡密");
45
+ } else {
46
+ const cardNo = config.get("cardNo");
47
+ if (!netCard.verify(cardNo)) {
48
+ logger.error("卡密验证失败");
49
+ exit();
50
+ }
51
+ }
52
+ ```
53
+
18
54
  ### 卡密验证
19
55
 
20
56
  #### verify - 验证卡密
@@ -35,7 +71,13 @@ function verify(cardNo: string): boolean;
35
71
  | --------- | ----------------------------------------------- |
36
72
  | `boolean` | 验证结果，true 表示验证成功，false 表示验证失败 |
37
73
 
38
- **示例 1：**
74
+ **说明：**
75
+
76
+ 普通卡密模式下，该方法会请求普通卡密验证接口，验证成功后才能继续使用卡密信息、备注和云变量相关能力。
77
+
78
+ 授权卡密模式下，App 层已经完成授权和卡密验证，脚本侧不需要重复调用该方法；如果旧脚本仍然调用，方法会直接返回 `true`。
79
+
80
+ **示例 1：普通卡密模式**
39
81
 
40
82
  ```typescript
41
83
  // 验证卡密
@@ -51,19 +93,15 @@ if (isValid) {
51
93
  }
52
94
  ```
53
95
 
54
- **示例 2：**
96
+ **示例 2：跳过授权卡密模式的重复验证**
55
97
 
56
98
  ```typescript
57
- // 验证卡密 从配置中获取卡密
58
- const cardNo = config.get("cardNo");
59
- const isValid = netCard.verify(cardNo);
60
-
61
- if (isValid) {
62
- logi("卡密验证成功");
63
- } else {
64
- logger.error("卡密验证失败");
65
- // 注意卡密验证失败退出程序
66
- exit();
99
+ if (!netCard.isAuthCardMode()) {
100
+ const cardNo = config.get("cardNo");
101
+ if (!netCard.verify(cardNo)) {
102
+ logger.error("卡密验证失败");
103
+ exit();
104
+ }
67
105
  }
68
106
  ```
69
107
 
package/docs/api/ui.md CHANGED
@@ -656,6 +656,31 @@ ms.getServerDeviceId()
656
656
  });
657
657
  ```
658
658
 
659
+ #### getAuthCardNo - 获取缓存的授权卡密
660
+
661
+ ```typescript
662
+ declare function getAuthCardNo(): Promise<string>;
663
+ ```
664
+
665
+ **返回值：**
666
+
667
+ | 类型 | 描述 |
668
+ | ----------------- | ------------------------------------ |
669
+ | `Promise<string>` | 有缓存的授权卡密时返回卡密字符串，否则返回空字符串 |
670
+
671
+ **说明：**
672
+
673
+ 获取当前软件包缓存的授权卡密。没有加载软件或当前软件没有缓存授权卡密时返回空字符串。
674
+
675
+ **网页端示例：**
676
+
677
+ ```javascript
678
+ // 获取当前软件缓存的授权卡密
679
+ ms.getAuthCardNo().then((cardNo) => {
680
+ console.log("当前缓存授权卡密:", cardNo);
681
+ });
682
+ ```
683
+
659
684
  #### openURL - 调用浏览器打开 URL
660
685
 
661
686
  ```typescript
package/docs/apicn/cloud.md CHANGED
@@ -5,6 +5,7 @@
5
5
  ## 注意事项
6
6
 
7
7
  - `$云控` 只在主脚本上下文注册，不支持在线程脚本里调用。
8
+ - 授权卡密模式不可用。
8
9
  - 服务器事件只有一个主脚本监听槽位，多次调用 `监听事件回调` 会覆盖旧监听。
9
10
 
10
11
  ## 协议
package/docs/apicn/netCard.md CHANGED
@@ -11,10 +11,46 @@
11
11
  ## 注意事项
12
12
 
13
13
  1. **卡密安全**: 卡密信息应当妥善保管，避免在日志中明文输出
14
- 2. **API 调用顺序**: 验证卡密后，其他 api 才能调用
14
+ 2. **普通卡密模式**: 需要先调用 `$卡密.验证(卡密)` 验证卡密，验证通过后才能调用获取卡密信息、备注和云变量等接口
15
+ 3. **授权卡密模式**: App 打开加密 UI 或运行脚本前会完成授权和卡密验证，脚本中不需要重复让用户输入卡密，也不需要重复调用 `$卡密.验证`
16
+ 4. **兼容旧脚本**: 授权卡密模式下调用 `$卡密.验证` 会直接返回 `true`，用于兼容原来已经写了验证逻辑的脚本
15
17
 
16
18
  ## API 参考
17
19
 
20
+ ### 授权模式
21
+
22
+ #### 是否授权卡密模式 - 判断是否为授权卡密模式
23
+
24
+ ```typescript
25
+ function 是否授权卡密模式(): 布尔值;
26
+ ```
27
+
28
+ **返回值：**
29
+
30
+ | 类型 | 描述 |
31
+ | -------- | ------------------------------------------------ |
32
+ | `布尔值` | 当前 App 处于授权卡密模式返回 `true`，否则返回 `false` |
33
+
34
+ **说明：**
35
+
36
+ 授权卡密模式下，App 层会在打开加密 UI 或运行脚本前完成授权和卡密验证。脚本侧可以用该方法判断当前模式；返回 `true` 时，不需要再弹输入框让用户填写卡密，也不需要再调用 `$卡密.验证`。
37
+
38
+ 普通卡密模式下，该方法返回 `false`，脚本仍需要按原流程调用 `$卡密.验证(卡密)`。
39
+
40
+ **示例：**
41
+
42
+ ```typescript
43
+ if ($卡密.是否授权卡密模式()) {
44
+ $打印信息日志("当前为授权卡密模式，不需要重复验证卡密");
45
+ } else {
46
+ const 卡号 = $配置.获取("cardNo");
47
+ if (!$卡密.验证(卡号)) {
48
+ $打印错误日志("卡密验证失败");
49
+ $退出脚本();
50
+ }
51
+ }
52
+ ```
53
+
18
54
  ### 卡密验证
19
55
 
20
56
  #### 验证 - 验证卡密
@@ -35,7 +71,13 @@ function 验证(卡密: 字符串): 布尔值;
35
71
  | -------- | ----------------------------------------------- |
36
72
  | `布尔值` | 验证结果，true 表示验证成功，false 表示验证失败 |
37
73
 
38
- **示例 1：**
74
+ **说明：**
75
+
76
+ 普通卡密模式下，该方法会请求普通卡密验证接口，验证成功后才能继续使用卡密信息、备注和云变量相关能力。
77
+
78
+ 授权卡密模式下，App 层已经完成授权和卡密验证，脚本侧不需要重复调用该方法；如果旧脚本仍然调用，方法会直接返回 `true`。
79
+
80
+ **示例 1：普通卡密模式**
39
81
 
40
82
  ```typescript
41
83
  // 验证卡密
@@ -51,19 +93,15 @@ if (是否验证成功) {
51
93
  }
52
94
  ```
53
95
 
54
- **示例 2：**
96
+ **示例 2：跳过授权卡密模式的重复验证**
55
97
 
56
98
  ```typescript
57
- // 验证卡密 从配置中获取卡密
58
- const 卡号 = $配置.获取("cardNo");
59
- const 是否验证成功 = $卡密.验证(卡号);
60
-
61
- if (是否验证成功) {
62
- $打印信息日志("卡密验证成功");
63
- } else {
64
- $打印错误日志("卡密验证失败");
65
- // 注意卡密验证失败退出程序
66
- $退出脚本();
99
+ if (!$卡密.是否授权卡密模式()) {
100
+ const 卡号 = $配置.获取("cardNo");
101
+ if (!$卡密.验证(卡号)) {
102
+ $打印错误日志("卡密验证失败");
103
+ $退出脚本();
104
+ }
67
105
  }
68
106
  ```
69
107
 
package/docs/apicn/ui.md CHANGED
@@ -644,6 +644,31 @@ ms.getServerDeviceId()
644
644
  });
645
645
  ```
646
646
 
647
+ #### getAuthCardNo() - 获取缓存的授权卡密
648
+
649
+ ```typescript
650
+ declare function getAuthCardNo(): Promise<string>;
651
+ ```
652
+
653
+ **返回值：**
654
+
655
+ | 类型 | 描述 |
656
+ | ----------------- | ------------------------------------ |
657
+ | `Promise<string>` | 有缓存的授权卡密时返回卡密字符串，否则返回空字符串 |
658
+
659
+ **说明：**
660
+
661
+ 获取当前软件包缓存的授权卡密。没有加载软件或当前软件没有缓存授权卡密时返回空字符串。
662
+
663
+ **网页端示例：**
664
+
665
+ ```javascript
666
+ // 获取当前软件缓存的授权卡密
667
+ ms.getAuthCardNo().then((cardNo) => {
668
+ console.log("当前缓存授权卡密:", cardNo);
669
+ });
670
+ ```
671
+
647
672
  #### openURL() - 调用浏览器打开 URL
648
673
 
649
674
  ```typescript
package/docs/apipython/cloud.md CHANGED
@@ -6,6 +6,7 @@
6
6
 
7
7
  - Python 云控模块只支持英文方法，不提供中文方法。
8
8
  - `cloud` 只能在主脚本中调用，不支持在线程脚本里调用。
9
+ - 授权卡密模式不可用。
9
10
  - 服务器事件只有一个主脚本监听槽位，多次调用 `onEvent` 会覆盖旧监听。
10
11
 
11
12
  ## 协议
package/docs/apipython/netCard.md CHANGED
@@ -11,10 +11,47 @@
11
11
  ## 注意事项
12
12
 
13
13
  1. **卡密安全**: 卡密信息应当妥善保管，避免在日志中明文输出
14
- 2. **API 调用顺序**: 验证卡密后，其他 api 才能调用
14
+ 2. **普通卡密模式**: 需要先调用 `netcard.verify(cardNo)` 验证卡密，验证通过后才能调用获取卡密信息、备注和云变量等接口
15
+ 3. **授权卡密模式**: App 打开加密 UI 或运行脚本前会完成授权和卡密验证，脚本中不需要重复让用户输入卡密，也不需要重复调用 `netcard.verify`
16
+ 4. **兼容旧脚本**: 授权卡密模式下调用 `netcard.verify` 会直接返回 `True`，用于兼容原来已经写了 `verify` 的脚本
15
17
 
16
18
  ## API 参考
17
19
 
20
+ ### 授权模式
21
+
22
+ #### isAuthCardMode - 判断是否为授权卡密模式
23
+
24
+ ```python
25
+ def isAuthCardMode() -> bool
26
+ ```
27
+
28
+ **返回值：**
29
+
30
+ | 类型 | 描述 |
31
+ | ------ | ------------------------------------------------ |
32
+ | `bool` | 当前 App 处于授权卡密模式返回 `True`，否则返回 `False` |
33
+
34
+ **说明：**
35
+
36
+ 授权卡密模式下，App 层会在打开加密 UI 或运行脚本前完成授权和卡密验证。脚本侧可以用该方法判断当前模式；返回 `True` 时，不需要再弹输入框让用户填写卡密，也不需要再调用 `netcard.verify`。
37
+
38
+ 普通卡密模式下，该方法返回 `False`，脚本仍需要按原流程调用 `netcard.verify(cardNo)`。
39
+
40
+ **示例：**
41
+
42
+ ```python
43
+ from kuaijs import netcard, config, logger
44
+ import sys
45
+
46
+ if netcard.isAuthCardMode():
47
+ logger.info("当前为授权卡密模式，不需要重复验证卡密")
48
+ else:
49
+ cardNo = config.get("cardNo")
50
+ if not netcard.verify(cardNo):
51
+ logger.error("卡密验证失败")
52
+ sys.exit(0)
53
+ ```
54
+
18
55
  ### 卡密验证
19
56
 
20
57
  #### verify - 验证卡密
@@ -35,7 +72,13 @@ def verify(cardNo: str) -> bool
35
72
  | ------ | ----------------------------------------------- |
36
73
  | `bool` | 验证结果，True 表示验证成功，False 表示验证失败 |
37
74
 
38
- **示例 1：**
75
+ **说明：**
76
+
77
+ 普通卡密模式下，该方法会请求普通卡密验证接口，验证成功后才能继续使用卡密信息、备注和云变量相关能力。
78
+
79
+ 授权卡密模式下，App 层已经完成授权和卡密验证，脚本侧不需要重复调用该方法；如果旧脚本仍然调用，方法会直接返回 `True`。
80
+
81
+ **示例 1：普通卡密模式**
39
82
 
40
83
  ```python
41
84
  from kuaijs import netcard, logger
@@ -53,22 +96,17 @@ else:
53
96
  sys.exit(0)
54
97
  ```
55
98
 
56
- **示例 2：**
99
+ **示例 2：跳过授权卡密模式的重复验证**
57
100
 
58
101
  ```python
59
102
  from kuaijs import netcard, logger, config
60
103
  import sys
61
104
 
62
- # 验证卡密 从配置中获取卡密
63
- cardNo = config.get("cardNo")
64
- isValid = netcard.verify(cardNo)
65
-
66
- if isValid:
67
- logger.info("卡密验证成功")
68
- else:
69
- logger.error("卡密验证失败")
70
- # 注意卡密验证失败退出程序
71
- sys.exit(0)
105
+ if not netcard.isAuthCardMode():
106
+ cardNo = config.get("cardNo")
107
+ if not netcard.verify(cardNo):
108
+ logger.error("卡密验证失败")
109
+ sys.exit(0)
72
110
  ```
73
111
 
74
112
  ### 获取卡密信息
package/docs/httpapi/api.md CHANGED
@@ -632,9 +632,11 @@ GET /api/status
632
632
  "agentConnected": true,
633
633
  "isRun": true,
634
634
  "isDebugMode": true,
635
+ "isDebugAuth": true,
635
636
  "isAuth": true,
636
637
  "isRecording": true,
637
638
  "udid": "string",
639
+ "authMode": "user",
638
640
  "serverDeviceId": "string",
639
641
  "orientation": "PORTRAIT",
640
642
  "memory": {
@@ -692,9 +694,11 @@ GET /api/status
692
694
  | »» agentConnected | boolean | true | none | agent是否连接 | none |
693
695
  | »» isRun | boolean | true | none | 脚本是否启动 | none |
694
696
  | »» isDebugMode | boolean | true | none | 是否调试模式运行 | none |
697
+ | »» isDebugAuth | boolean | true | none | 是否拥有调试授权 | none |
695
698
  | »» isAuth | boolean | true | none | 是否授权 | none |
696
699
  | »» isRecording | boolean | true | none | 是否录屏中 | none |
697
700
  | »» udid | string | true | none | 设备唯一 UDID | none |
701
+ | »» authMode | string | true | none | 授权模式 | `user` 表示用户授权，`card` 表示授权卡密 |
698
702
  | »» serverDeviceId | string | true | none | 服务器设备ID | none |
699
703
  | »» orientation | string | true | none | 屏幕方向 | none |
700
704
  | »» memory | object | true | none | 内存状态 | 单位为 MB，字段与系统模块内存信息一致 |
@@ -721,6 +725,8 @@ GET /api/status
721
725
  | ----------- | ------------- |
722
726
  | orientation | PORTRAIT |
723
727
  | orientation | LANDSCAPE |
728
+ | authMode | user |
729
+ | authMode | card |
724
730
  | serverType | international |
725
731
  | serverType | domestic |
726
732
 
@@ -3111,9 +3117,11 @@ GET /mirror/image
3111
3117
  "agentConnected": true,
3112
3118
  "isRun": true,
3113
3119
  "isDebugMode": true,
3120
+ "isDebugAuth": true,
3114
3121
  "isAuth": true,
3115
3122
  "isRecording": true,
3116
3123
  "udid": "string",
3124
+ "authMode": "user",
3117
3125
  "serverDeviceId": "string",
3118
3126
  "orientation": "PORTRAIT",
3119
3127
  "memory": {
@@ -3160,9 +3168,11 @@ GET /mirror/image
3160
3168
  | agentConnected | boolean | true | none | agent是否连接 | none |
3161
3169
  | isRun | boolean | true | none | 脚本是否启动 | none |
3162
3170
  | isDebugMode | boolean | true | none | 是否调试模式运行 | none |
3171
+ | isDebugAuth | boolean | true | none | 是否拥有调试授权 | none |
3163
3172
  | isAuth | boolean | true | none | 是否授权 | none |
3164
3173
  | isRecording | boolean | true | none | 是否录屏中 | none |
3165
3174
  | udid | string | true | none | 设备唯一 UDID | none |
3175
+ | authMode | string | true | none | 授权模式 | `user` 表示用户授权，`card` 表示授权卡密 |
3166
3176
  | serverDeviceId | string | true | none | 服务器设备ID | none |
3167
3177
  | orientation | string | true | none | 屏幕方向 | none |
3168
3178
  | memory | object | true | none | 内存状态 | 单位为 MB，字段与系统模块内存信息一致 |
@@ -3189,5 +3199,7 @@ GET /mirror/image
3189
3199
  | ----------- | ------------- |
3190
3200
  | orientation | PORTRAIT |
3191
3201
  | orientation | LANDSCAPE |
3202
+ | authMode | user |
3203
+ | authMode | card |
3192
3204
  | serverType | international |
3193
3205
  | serverType | domestic |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ms-vite-plugin",
3
- "version": "1.4.33",
3
+ "version": "1.4.34",
4
4
  "type": "commonjs",
5
5
  "license": "MIT",
6
6
  "publishConfig": {