ms-types 0.9.19 → 0.9.21

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.
package/types/pip.d.ts CHANGED
@@ -27,9 +27,10 @@ declare namespace pip {
27
27
  function closeWindow(): boolean;
28
28
  /**
29
29
  * 设置日志模式或自定义模式的悬浮窗内容尺寸
30
+ * 传入的宽高表示宽高比,不是最终像素尺寸;实际显示宽高由系统决定
30
31
  * 日志模式和自定义模式会分别持久化尺寸;保活模式返回 false
31
- * @param width 目标内容宽度
32
- * @param height 目标内容高度
32
+ * @param width 宽度方向比例值(与 height 共同决定宽高比,不是像素)
33
+ * @param height 高度方向比例值(与 width 共同决定宽高比,不是像素)
33
34
  * @returns true代表尺寸已提交,false代表当前模式不允许设置或宽高无效
34
35
  */
35
36
  function setContentSize(width: number, height: number): boolean;
@@ -6,6 +6,7 @@
6
6
  /// <reference path="云控模块.d.ts" />
7
7
  /// <reference path="配置模块.d.ts" />
8
8
  /// <reference path="苹果OCR.d.ts" />
9
+ /// <reference path="点阵OCR模块.d.ts" />
9
10
  /// <reference path="全局模块.d.ts" />
10
11
  /// <reference path="热更新模块.d.ts" />
11
12
  /// <reference path="日志模块.d.ts" />
@@ -26,9 +26,10 @@ declare namespace $悬浮窗 {
26
26
  function 切换到自定义模式(): 布尔值;
27
27
  /**
28
28
  * 设置日志模式或自定义模式的悬浮窗内容尺寸
29
+ * 传入的宽高表示宽高比,不是最终像素尺寸;实际显示宽高由系统决定
29
30
  * 日志模式和自定义模式会分别持久化尺寸;保活模式返回 false
30
- * @param 宽度 目标内容宽度
31
- * @param 高度 目标内容高度
31
+ * @param 宽度 宽度方向比例值(与高度共同决定宽高比,不是像素)
32
+ * @param 高度 高度方向比例值(与宽度共同决定宽高比,不是像素)
32
33
  * @returns true代表尺寸已提交,false代表当前模式不允许设置或宽高无效
33
34
  */
34
35
  function 设置内容尺寸(宽度: 数字, 高度: 数字): 布尔值;
@@ -1,134 +1,138 @@
1
- /// <reference path="全局模块.d.ts" />
2
- /**
3
- * 文件模块 包含文件操作、文件内容读写等功能
4
- */
5
- declare namespace $文件 {
6
- /**
7
- * 获取应用内部目录
8
- * @param 目录类型 documents 文档目录 library 库目录 temp 临时目录 libraryCaches 库缓存目录
9
- * @description 一般使用documents目录,其他目录不常用 documents目录下的文件,会在我的文件中显示
10
- * @returns 目录路径
11
- * @example $文件.获取内部目录("documents")
12
- */
13
- function 获取内部目录(
14
- 目录类型: "documents" | "library" | "temp" | "libraryCaches"
15
- ): 字符串;
16
- /**
17
- * 获取应用数据目录
18
- * @returns 目录路径
19
- * @example $文件.获取数据目录()
20
- */
21
- function 获取数据目录(): 字符串;
22
- /**
23
- * 获取应用数据文件路径
24
- * @param 文件名称 文件名
25
- * @returns 文件路径
26
- * @example $文件.获取数据文件("config.json")
27
- */
28
- function 获取数据文件路径(文件名称: 字符串): 字符串;
29
- /**
30
- * 创建文件
31
- * @param 文件路径
32
- * @returns 是否创建成功
33
- * @example $文件.创建文件("config.json")
34
- */
35
- function 创建文件(文件路径: 字符串): 布尔值;
36
- /**
37
- * 创建目录
38
- * @param 目录路径
39
- * @returns 是否创建成功
40
- * @example $文件.创建目录("config")
41
- */
42
- function 创建目录(目录路径: 字符串): 布尔值;
43
- /**
44
- * 删除文件或目录
45
- * @param 文件或目录路径
46
- * @returns 是否删除成功
47
- * @example $文件.删除所有文件("config")
48
- */
49
- function 删除所有文件(文件或目录路径: 字符串): 布尔值;
50
- /**
51
- * 读取文件内容
52
- * @param 文件路径
53
- * @returns 文件内容,如果读取失败返回 null
54
- * @example $文件.读取文件("config.json")
55
- */
56
- function 读取文件(文件路径: 字符串): 字符串 | null;
57
- /**
58
- * 读取资源文件
59
- * @param 文件名
60
- * @returns 文件内容
61
- * @example $文件.读取资源文件("test.txt")
62
- */
63
- function 读取资源文件(文件名: 字符串): 字符串 | null;
64
- /**
65
- * 删除文件内容
66
- * @param 文件路径 文件路径
67
- * @param 行号 如果是-1 代表这个条件不生效
68
- * @param 包含内容 如果是null 代表这个条件不生效
69
- * @returns 是否删除成功
70
- * @example $文件.删除指定行("config.json", 1, null)
71
- */
72
- function 删除指定行(文件路径: 字符串, 行号: 数字, 包含内容?: 字符串): 布尔值;
73
- /**
74
- * 列出目录下所有文件
75
- * @param 目录路径
76
- * @param 是否递归
77
- * @returns 文件路径数组
78
- * @example $文件.列出目录列表("config", true)
79
- */
80
- function 列出目录列表(目录路径: 字符串, 是否递归: 布尔值): 数组<字符串>;
81
- /**
82
- * 写入文件内容
83
- * @param 文件路径
84
- * @param 文件内容
85
- * @returns 是否写入成功
86
- * @example $文件.写入文件("config.json", "name=test")
87
- */
88
- function 写入文件(文件路径: 字符串, 文件内容: 字符串): 布尔值;
89
- /**
90
- * 追加文件内容
91
- * @param 文件路径
92
- * @param 文件内容
93
- * @returns 是否追加成功
94
- * @example $文件.追加行("config.json", "name=test")
95
- */
96
- function 追加行(文件路径: 字符串, 文件内容: 字符串): 布尔值;
97
- /**
98
- * 读取文件第N行内容
99
- * @param 文件路径
100
- * @param 行号
101
- * @returns 行内容,如果读取失败返回 null
102
- * @example $文件.读取指定行("config.json", 1)
103
- */
104
- function 读取指定行(文件路径: 字符串, 行号: 数字): 字符串 | null;
105
- /**
106
- * 读取文件所有行内容
107
- * @param 文件路径
108
- * @returns 行内容数组,如果读取失败返回 null
109
- * @example $文件.读取所有行("config.json")
110
- */
111
- function 读取所有行(文件路径: 字符串): 数组<字符串> | null;
112
- /**
113
- * 文件或者文件夹是否存在
114
- * @param 文件路径
115
- * @returns 是否存在
116
- * @example $文件.文件是否存在("config.json")
117
- */
118
- function 文件是否存在(文件路径: 字符串): 布尔值;
119
- /**
120
- * 复制文件
121
- * @param 源文件路径
122
- * @param 目标文件路径
123
- * @returns 是否复制成功
124
- * @example $文件.复制文件("config.json", "config2.json")
125
- */
126
- function 复制文件(源文件路径: 字符串, 目标文件路径: 字符串): 布尔值;
127
- /**
128
- * 获取文件MD5值
129
- * @param 文件路径
130
- * @returns 文件MD5值
131
- * @example $文件.计算文件MD5("config.json")
132
- */
133
- function 计算文件MD5(文件路径: 字符串): 字符串 | null;
134
- }
1
+ /// <reference path="全局模块.d.ts" />
2
+ /**
3
+ * 文件模块 包含文件操作、文件内容读写等功能
4
+ */
5
+ declare namespace $文件 {
6
+ /**
7
+ * 获取应用内部目录
8
+ * @param 目录类型 documents 文档目录 library 库目录 temp 临时目录 libraryCaches 库缓存目录
9
+ * @description 一般使用documents目录,其他目录不常用 documents目录下的文件,会在我的文件中显示
10
+ * @returns 目录路径
11
+ * @example $文件.获取内部目录("documents")
12
+ */
13
+ function 获取内部目录(
14
+ 目录类型: "documents" | "library" | "temp" | "libraryCaches"
15
+ ): 字符串;
16
+ /**
17
+ * 创建文件
18
+ * @param 文件路径
19
+ * @returns 是否创建成功
20
+ * @example $文件.创建文件("config.json")
21
+ */
22
+ function 创建文件(文件路径: 字符串): 布尔值;
23
+ /**
24
+ * 创建目录
25
+ * @param 目录路径
26
+ * @returns 是否创建成功
27
+ * @example $文件.创建目录("config")
28
+ */
29
+ function 创建目录(目录路径: 字符串): 布尔值;
30
+ /**
31
+ * 删除文件或目录
32
+ * @param 文件或目录路径
33
+ * @returns 是否删除成功
34
+ * @example $文件.删除所有文件("config")
35
+ */
36
+ function 删除所有文件(文件或目录路径: 字符串): 布尔值;
37
+ /**
38
+ * 读取文件内容
39
+ * @param 文件路径
40
+ * @returns 文件内容,如果读取失败返回 null
41
+ * @example $文件.读取文件("config.json")
42
+ */
43
+ function 读取文件(文件路径: 字符串): 字符串 | null;
44
+ /**
45
+ * 读取资源文件
46
+ * @param 文件名
47
+ * @returns 文件内容
48
+ * @example $文件.读取资源文件("test.txt")
49
+ */
50
+ function 读取资源文件(文件名: 字符串): 字符串 | null;
51
+ /**
52
+ * 获取 res 资源的本地文件路径
53
+ * @param 文件名 相对 res 目录的资源路径
54
+ * @returns 本地文件绝对路径,失败返回 null
55
+ * @example
56
+ * const 路径 = $文件.获取资源文件("model.bin");
57
+ * if (路径) {
58
+ * $文件.清理资源文件(路径);
59
+ * }
60
+ */
61
+ function 获取资源文件(文件名: 字符串): 字符串 | null;
62
+ /**
63
+ * 清理由获取资源文件得到的本地文件
64
+ * @param 文件路径 获取资源文件返回的文件路径
65
+ * @example $文件.清理资源文件(路径)
66
+ */
67
+ function 清理资源文件(文件路径: 字符串): void;
68
+ /**
69
+ * 删除文件内容
70
+ * @param 文件路径 文件路径
71
+ * @param 行号 如果是-1 代表这个条件不生效
72
+ * @param 包含内容 如果是null 代表这个条件不生效
73
+ * @returns 是否删除成功
74
+ * @example $文件.删除指定行("config.json", 1, null)
75
+ */
76
+ function 删除指定行(文件路径: 字符串, 行号: 数字, 包含内容?: 字符串): 布尔值;
77
+ /**
78
+ * 列出目录下所有文件
79
+ * @param 目录路径
80
+ * @param 是否递归
81
+ * @returns 文件路径数组
82
+ * @example $文件.列出目录列表("config", true)
83
+ */
84
+ function 列出目录列表(目录路径: 字符串, 是否递归: 布尔值): 数组<字符串>;
85
+ /**
86
+ * 写入文件内容
87
+ * @param 文件路径
88
+ * @param 文件内容
89
+ * @returns 是否写入成功
90
+ * @example $文件.写入文件("config.json", "name=test")
91
+ */
92
+ function 写入文件(文件路径: 字符串, 文件内容: 字符串): 布尔值;
93
+ /**
94
+ * 追加文件内容
95
+ * @param 文件路径
96
+ * @param 文件内容
97
+ * @returns 是否追加成功
98
+ * @example $文件.追加行("config.json", "name=test")
99
+ */
100
+ function 追加行(文件路径: 字符串, 文件内容: 字符串): 布尔值;
101
+ /**
102
+ * 读取文件第N行内容
103
+ * @param 文件路径
104
+ * @param 行号
105
+ * @returns 行内容,如果读取失败返回 null
106
+ * @example $文件.读取指定行("config.json", 1)
107
+ */
108
+ function 读取指定行(文件路径: 字符串, 行号: 数字): 字符串 | null;
109
+ /**
110
+ * 读取文件所有行内容
111
+ * @param 文件路径
112
+ * @returns 行内容数组,如果读取失败返回 null
113
+ * @example $文件.读取所有行("config.json")
114
+ */
115
+ function 读取所有行(文件路径: 字符串): 数组<字符串> | null;
116
+ /**
117
+ * 文件或者文件夹是否存在
118
+ * @param 文件路径
119
+ * @returns 是否存在
120
+ * @example $文件.文件是否存在("config.json")
121
+ */
122
+ function 文件是否存在(文件路径: 字符串): 布尔值;
123
+ /**
124
+ * 复制文件
125
+ * @param 源文件路径
126
+ * @param 目标文件路径
127
+ * @returns 是否复制成功
128
+ * @example $文件.复制文件("config.json", "config2.json")
129
+ */
130
+ function 复制文件(源文件路径: 字符串, 目标文件路径: 字符串): 布尔值;
131
+ /**
132
+ * 获取文件MD5值
133
+ * @param 文件路径
134
+ * @returns 文件MD5值
135
+ * @example $文件.计算文件MD5("config.json")
136
+ */
137
+ function 计算文件MD5(文件路径: 字符串): 字符串 | null;
138
+ }
@@ -0,0 +1,64 @@
1
+ /// <reference path="全局模块.d.ts" />
2
+
3
+ /** 固定像素尺寸的点阵 OCR(`kuaijs-dot-font` 字库)。 */
4
+ declare namespace $点阵OCR {
5
+ interface OCR字符 {
6
+ text: 字符串;
7
+ confidence: 数字;
8
+ x: 数字;
9
+ y: 数字;
10
+ ex: 数字;
11
+ ey: 数字;
12
+ width: 数字;
13
+ height: 数字;
14
+ centerX: 数字;
15
+ centerY: 数字;
16
+ }
17
+
18
+ /**
19
+ * 从资源路径加载字库并缓存。
20
+ * 常见路径如 `/fonts/default.json`;运行时会解析 `res` 目录。
21
+ * 字库 JSON 中每个字符自带前景色/偏色(`threshold`),识别时按各字颜色匹配。
22
+ * @returns 成功返回字库 ID,失败返回 `null`
23
+ */
24
+ function 加载字库(字库资源路径: 字符串): 字符串 | null;
25
+
26
+ /** 释放指定字库。未加载也视为成功。 */
27
+ function 释放(字库ID: 字符串): void;
28
+
29
+ /** 释放全部已加载的点阵字库。 */
30
+ function 释放全部(): void;
31
+
32
+ /**
33
+ * 识别文字并返回原图或全屏绝对坐标。
34
+ * 颜色按字库逐字自带的前景色/偏色匹配,无需额外传色。
35
+ * 结果按行从上到下、同行从左到右排列。
36
+ * @param 置信度阈值 相似度下限;`<=0` 时按 `0.8`;`>0.95` 时要求像素完全一致
37
+ */
38
+ function 识别绝对坐标(
39
+ 字库ID: 字符串,
40
+ 输入源: 字符串,
41
+ 左?: 数字,
42
+ 上?: 数字,
43
+ 右?: 数字,
44
+ 下?: 数字,
45
+ 置信度阈值?: 数字,
46
+ ): 数组<OCR字符>;
47
+
48
+ /**
49
+ * 先识别再按行查找目标串,返回命中位置的绝对坐标。
50
+ * `完整匹配=false`:行内子串包含;`完整匹配=true`:整行文本必须完全等于目标。
51
+ * 每个目标最多返回一次命中(最先匹配到的行)。
52
+ */
53
+ function 查找文本绝对坐标(
54
+ 字库ID: 字符串,
55
+ 输入源: 字符串,
56
+ 目标文本: 数组<字符串>,
57
+ 左?: 数字,
58
+ 上?: 数字,
59
+ 右?: 数字,
60
+ 下?: 数字,
61
+ 置信度阈值?: 数字,
62
+ 完整匹配?: 布尔值,
63
+ ): 数组<OCR字符>;
64
+ }
@@ -8,7 +8,7 @@ declare function $创建节点选择器(params?: {
8
8
  */
9
9
  maxDepth?: number;
10
10
  /**
11
- * 抓取模式:模式 1、模式 2,默认模式 1
11
+ * 抓取模式:模式 1、模式 2、模式 3,默认模式 1
12
12
  */
13
13
  mode?: number;
14
14
  }): $节点选择器;
@@ -102,6 +102,39 @@ declare interface $节点信息 {
102
102
  * 节点是否可接收事件 用于判断是否显示在屏幕上
103
103
  */
104
104
  hittable(): 布尔值;
105
+ /**
106
+ * 无障碍点击
107
+ */
108
+ tap(): 布尔值;
109
+ /**
110
+ * 无障碍双击
111
+ */
112
+ doubleTap(): 布尔值;
113
+ /**
114
+ * 无障碍长按
115
+ * @param duration 长按持续时间,单位毫秒
116
+ */
117
+ press(duration: 数字): 布尔值;
118
+ /**
119
+ * 将节点滚动到可见区域
120
+ */
121
+ scrollToVisible(): 布尔值;
122
+ /**
123
+ * 清空输入
124
+ */
125
+ clearInput(): 布尔值;
126
+ /**
127
+ * 追加输入(聚焦后输入)
128
+ * @param text 要输入的文本
129
+ */
130
+ input(text: 字符串): 布尔值;
131
+ /**
132
+ * 设置节点的值,按控件类型自动处理:
133
+ * - `XCUIElementTypePickerWheel`:传选项文案,如 `"1小时"`
134
+ * - 文本类控件(`TextField` / `SecureTextField` / `TextView` / `SearchField` 等):传要输入的文本(先聚焦再输入,不清空已有内容)
135
+ * @param text 目标值
136
+ */
137
+ setValue(text: 字符串): 布尔值;
105
138
  /**
106
139
  * 获取父节点
107
140
  */