ms-types 0.0.64 → 0.0.65

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ms-types",
3
- "version": "0.0.64",
3
+ "version": "0.0.65",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
@@ -1,2 +1,5 @@
1
1
  /// <reference path="全局模块.d.ts" />
2
2
  /// <reference path="动作模块.d.ts" />
3
+ /// <reference path="苹果OCR.d.ts" />
4
+ /// <reference path="配置模块.d.ts" />
5
+ /// <reference path="设备模块.d.ts" />
@@ -8,6 +8,9 @@ declare type 数组<T> = Array<T>;
8
8
  declare type 字典<T> = Record<字符串, T>;
9
9
  declare type 无返回值 = void;
10
10
 
11
+ declare const $真: 布尔值;
12
+ declare const $假: 布尔值;
13
+
11
14
  /**
12
15
  * 是否是调试模式
13
16
  */
@@ -0,0 +1,137 @@
1
+ /// <reference path="全局模块.d.ts" />
2
+ /**
3
+ * 文件模块 包含文件操作、文件内容读写等功能
4
+ */
5
+ declare namespace $文件 {
6
+ /**
7
+ * 获取应用内部目录
8
+ * @param 目录类型
9
+ * @returns 目录路径
10
+ * @example $文件.获取内部目录("documents")
11
+ */
12
+ function 获取内部目录(
13
+ 目录类型: "documents" | "library" | "temp" | "libraryCaches"
14
+ ): 字符串;
15
+ /**
16
+ * 获取应用数据目录
17
+ * @returns 目录路径
18
+ * @example $文件.获取数据目录()
19
+ */
20
+ function 获取数据目录(): 字符串;
21
+ /**
22
+ * 获取应用数据文件路径
23
+ * @param 文件名称 文件名
24
+ * @returns 文件路径
25
+ * @example $文件.获取数据文件("config.json")
26
+ */
27
+ function 获取数据文件(文件名称: 字符串): 字符串;
28
+ /**
29
+ * 创建文件
30
+ * @param 文件路径
31
+ * @returns 是否创建成功
32
+ * @example $文件.创建文件("config.json")
33
+ */
34
+ function 创建文件(文件路径: 字符串): 布尔值;
35
+ /**
36
+ * 创建目录
37
+ * @param 目录路径
38
+ * @returns 是否创建成功
39
+ * @example $文件.创建目录("config")
40
+ */
41
+ function 创建目录(目录路径: 字符串): 布尔值;
42
+ /**
43
+ * 删除文件或目录
44
+ * @param 文件或目录路径
45
+ * @returns 是否删除成功
46
+ * @example $文件.删除所有文件("config")
47
+ */
48
+ function 删除所有文件(文件或目录路径: 字符串): 布尔值;
49
+ /**
50
+ * 读取文件内容
51
+ * @param 文件路径
52
+ * @returns 文件内容
53
+ * @example $文件.读取文件("config.json")
54
+ */
55
+ function 读取文件(文件路径: 字符串): 字符串;
56
+ /**
57
+ * 读取资源文件
58
+ * @param 文件名
59
+ * @returns 文件内容
60
+ * @example $文件.读取资源文件("test.txt")
61
+ */
62
+ function 读取资源文件(文件名: 字符串): 字符串 | null;
63
+ /**
64
+ * 删除文件内容
65
+ * @param 文件路径 文件路径
66
+ * @param 行号 如果是-1 代表这个条件不生效
67
+ * @param 包含内容 如果是null 代表这个条件不生效
68
+ * @returns 是否删除成功
69
+ * @example $文件.删除指定行("config.json", 1, null)
70
+ */
71
+ function 删除指定行(
72
+ 文件路径: 字符串,
73
+ 行号: 数字,
74
+ 包含内容: 字符串 | null
75
+ ): 布尔值;
76
+ /**
77
+ * 列出目录下所有文件
78
+ * @param 目录路径
79
+ * @param 是否递归
80
+ * @returns 文件路径数组
81
+ * @example $文件.列出目录列表("config", true)
82
+ */
83
+ function 列出目录列表(目录路径: 字符串, 是否递归: 布尔值): 数组<字符串>;
84
+ /**
85
+ * 写入文件内容
86
+ * @param 文件路径
87
+ * @param 文件内容
88
+ * @returns 是否写入成功
89
+ * @example $文件.写入文件("config.json", "name=wda")
90
+ */
91
+ function 写入文件(文件路径: 字符串, 文件内容: 字符串): 布尔值;
92
+ /**
93
+ * 追加文件内容
94
+ * @param 文件路径
95
+ * @param 文件内容
96
+ * @returns 是否追加成功
97
+ * @example $文件.追加行("config.json", "name=wda")
98
+ */
99
+ function 追加行(文件路径: 字符串, 文件内容: 字符串): 布尔值;
100
+ /**
101
+ * 读取文件第N行内容
102
+ * @param 文件路径
103
+ * @param 行号
104
+ * @returns 行内容
105
+ * @example $文件.读取指定行("config.json", 1)
106
+ */
107
+ function 读取指定行(文件路径: 字符串, 行号: 数字): 字符串;
108
+ /**
109
+ * 读取文件所有行内容
110
+ * @param 文件路径
111
+ * @returns 行内容数组
112
+ * @example $文件.读取所有行("config.json")
113
+ */
114
+ function 读取所有行(文件路径: 字符串): 数组<字符串>;
115
+ /**
116
+ * 文件或者文件夹是否存在
117
+ * @param 文件路径
118
+ * @returns 是否存在
119
+ * @example $文件.文件是否存在("config.json")
120
+ */
121
+ function 文件是否存在(文件路径: 字符串): 布尔值;
122
+ /**
123
+ * 复制文件
124
+ * @param 源文件路径
125
+ * @param 目标文件路径
126
+ * @returns 是否复制成功
127
+ * @example $文件.复制文件("config.json", "config2.json")
128
+ */
129
+ function 复制文件(源文件路径: 字符串, 目标文件路径: 字符串): 布尔值;
130
+ /**
131
+ * 获取文件MD5值
132
+ * @param 文件路径
133
+ * @returns 文件MD5值
134
+ * @example $文件.计算文件MD5("config.json")
135
+ */
136
+ function 计算文件MD5(文件路径: 字符串): 字符串 | null;
137
+ }
@@ -0,0 +1,104 @@
1
+ /// <reference path="全局模块.d.ts" />
2
+
3
+ /**
4
+ * Apple OCR模块 使用Apple Vision框架进行文本识别
5
+ */
6
+ declare namespace $苹果OCR {
7
+ /**
8
+ * OCR识别结果接口
9
+ */
10
+ interface OCR识别结果 {
11
+ /** 识别的文本内容 */
12
+ text: string;
13
+ /** 识别置信度 (0-1) */
14
+ confidence: number;
15
+ /** 文本区域左上角 x 坐标 */
16
+ x: number;
17
+ /** 文本区域左上角 y 坐标 */
18
+ y: number;
19
+ /** 文本区域右下角 x 坐标 */
20
+ ex: number;
21
+ /** 文本区域右下角 y 坐标 */
22
+ ey: number;
23
+ /** 文本区域宽度 */
24
+ width: number;
25
+ /** 文本区域高度 */
26
+ height: number;
27
+ /** 文本区域中心点 x 坐标 */
28
+ centerX: number;
29
+ /** 文本区域中心点 y 坐标 */
30
+ centerY: number;
31
+ }
32
+
33
+ /**
34
+ * 执行OCR识别(使用Apple Vision框架)
35
+ * @param 输入源 输入源(imageId、URL字符串、文件路径或"screen","screen"表示使用当前屏幕)
36
+ * @param 图片边界框左上角x坐标 图片边界框左上角x坐标
37
+ * @param 图片边界框左上角y坐标 图片边界框左上角y坐标
38
+ * @param 图片边界框右下角x坐标 图片边界框右下角x坐标
39
+ * @param 图片边界框右下角y坐标 图片边界框右下角y坐标
40
+ * @param 识别语言数组 识别语言数组,默认为["zh-Hans", "en-US"]
41
+ * @returns 识别结果数组,包含文本、置信度、坐标等信息
42
+ * @example
43
+ * const results = $苹果OCR.识别("screen", 0, 0, 100, 100, ["zh-Hans", "en-US"])
44
+ * results.forEach(result => {
45
+ * logger.info(`文本: ${result.text}, 置信度: ${result.confidence}`)
46
+ * })
47
+ */
48
+ function 识别(
49
+ 输入源: 字符串,
50
+ 图片边界框左上角x坐标: 数字,
51
+ 图片边界框左上角y坐标: 数字,
52
+ 图片边界框右下角x坐标: 数字,
53
+ 图片边界框右下角y坐标: 数字,
54
+ 识别语言数组?: Array<字符串>
55
+ ): 数组<OCR识别结果>;
56
+
57
+ /**
58
+ * 执行OCR识别(仅识别数字)0-9.,+-
59
+ * @param 输入源 输入源(imageId、URL字符串、文件路径或"screen","screen"表示使用当前屏幕)
60
+ * @param 图片边界框左上角x坐标 图片边界框左上角x坐标
61
+ * @param 图片边界框左上角y坐标 图片边界框左上角y坐标
62
+ * @param 图片边界框右下角x坐标 图片边界框右下角x坐标
63
+ * @param 图片边界框右下角y坐标 图片边界框右下角y坐标
64
+ * @returns 识别结果数组,包含文本、置信度、坐标等信息
65
+ * @example
66
+ * const results = $苹果OCR.识别数字("screen", 0, 0, 100, 100)
67
+ * results.forEach(result => {
68
+ * logger.info(`文本: ${result.text}, 置信度: ${result.confidence}`)
69
+ * })
70
+ */
71
+ function 识别数字(
72
+ 输入源: 字符串,
73
+ 图片边界框左上角x坐标: 数字,
74
+ 图片边界框左上角y坐标: 数字,
75
+ 图片边界框右下角x坐标: 数字,
76
+ 图片边界框右下角y坐标: 数字
77
+ ): 数组<OCR识别结果>;
78
+
79
+ /**
80
+ * 执行OCR识别(查找指定文本)
81
+ * @param 输入源 输入源(imageId、URL字符串、文件路径或"screen","screen"表示使用当前屏幕)
82
+ * @param 要查找的文本数组 要查找的文本数组
83
+ * @param 图片边界框左上角x坐标 图片边界框左上角x坐标
84
+ * @param 图片边界框左上角y坐标 图片边界框左上角y坐标
85
+ * @param 图片边界框右下角x坐标 图片边界框右下角x坐标
86
+ * @param 图片边界框右下角y坐标 图片边界框右下角y坐标
87
+ * @param 识别语言数组 识别语言数组,默认为["zh-Hans", "en-US"]
88
+ * @returns 识别结果数组,包含文本、置信度、坐标等信息
89
+ * @example
90
+ * const results = $苹果OCR.查找文本("screen", ["123", "456"], 0, 0, 100, 100, ["zh-Hans", "en-US"])
91
+ * results.forEach(result => {
92
+ * logger.info(`文本: ${result.text}, 置信度: ${result.confidence}`)
93
+ * })
94
+ */
95
+ function 查找文本(
96
+ 输入源: 字符串,
97
+ 要查找的文本数组: 数组<字符串>,
98
+ 图片边界框左上角x坐标: 数字,
99
+ 图片边界框左上角y坐标: 数字,
100
+ 图片边界框右下角x坐标: 数字,
101
+ 图片边界框右下角y坐标: 数字,
102
+ 识别语言数组?: 数组<字符串>
103
+ ): 数组<OCR识别结果>;
104
+ }
@@ -0,0 +1,106 @@
1
+ /// <reference path="全局模块.d.ts" />
2
+ /**
3
+ * 设备模块 包含获取设备信息、设备操作等功能
4
+ */
5
+ declare namespace $设备 {
6
+ /**
7
+ * 获取电池信息
8
+ * @returns 电池信息
9
+ * @example $设备.获取电池状态()
10
+ */
11
+ function 获取电池状态(): {
12
+ /**
13
+ * 电池电量
14
+ */
15
+ level: number;
16
+ /**
17
+ * 是否充电
18
+ */
19
+ isCharging: boolean;
20
+ };
21
+ /**
22
+ * 获取设备ID
23
+ * @returns 设备ID
24
+ * @example $设备.获取设备ID()
25
+ */
26
+ function 获取设备ID(): 字符串;
27
+ /**
28
+ * 获取服务器设备ID
29
+ * @returns 服务器设备ID
30
+ * @example $设备.获取服务器设备ID()
31
+ */
32
+ function 获取服务器设备ID(): 字符串;
33
+ /**
34
+ * 获取设备名称
35
+ * @returns 设备名称
36
+ * @example $设备.获取设备名称()
37
+ */
38
+ function 获取设备名称(): 字符串;
39
+ /**
40
+ * 获取设备型号
41
+ * @returns 设备型号
42
+ * @example $设备.获取设备型号()
43
+ */
44
+ function 获取设备型号(): 字符串;
45
+ /**
46
+ * 获取屏幕大小
47
+ * @returns 屏幕大小
48
+ * @example $设备.获取屏幕宽高()
49
+ */
50
+ function 获取屏幕宽高(): {
51
+ /**
52
+ * 屏幕宽度
53
+ */
54
+ width: number;
55
+ /**
56
+ * 屏幕高度
57
+ */
58
+ height: number;
59
+ };
60
+ /**
61
+ * 获取屏幕实际大小
62
+ * @returns 屏幕实际大小
63
+ * @example $设备.获取屏幕实际宽高()
64
+ */
65
+ function 获取屏幕实际宽高(): {
66
+ /**
67
+ * 屏幕宽度
68
+ */
69
+ width: number;
70
+ /**
71
+ * 屏幕高度
72
+ */
73
+ height: number;
74
+ };
75
+ /**
76
+ * 获取屏幕缩放比例
77
+ * @returns 屏幕缩放比例
78
+ * @example $设备.获取屏幕缩放比例()
79
+ */
80
+ function 获取屏幕缩放比例(): number;
81
+ /**
82
+ * 获取设备方向 PORTRAIT 竖屏 LANDSCAPE 横屏
83
+ * @returns 设备方向
84
+ * @example $设备.获取设备方向()
85
+ */
86
+ function 获取设备方向(): "PORTRAIT" | "LANDSCAPE";
87
+ /**
88
+ * 获取系统版本 例如 16.7.11
89
+ * @returns 系统版本
90
+ * @example $设备.获取系统版本()
91
+ */
92
+ function 获取系统版本(): 字符串;
93
+ /**
94
+ * 获取局域网IP 例如 192.168.1.100
95
+ * @returns 局域网IP
96
+ * @example $设备.获取局域网IP()
97
+ */
98
+ function 获取局域网IP(): 字符串;
99
+ /**
100
+ * 振动
101
+ * @param 持续时间 持续时间 单位毫秒
102
+ * @param 强度 强度 0.0-1.0
103
+ * @example $设备.震动(1000, 0.5)
104
+ */
105
+ function 震动(持续时间: 数字, 强度: 数字): 无返回值;
106
+ }
@@ -0,0 +1,56 @@
1
+ /// <reference path="全局模块.d.ts" />
2
+
3
+ /**
4
+ * 配置模块 包含读取配置、更新配置、删除配置等功能
5
+ */
6
+ declare namespace $配置 {
7
+ /**
8
+ * 读取配置Int
9
+ * @param 配置键 配置key
10
+ * @returns 配置值
11
+ * @example $配置.读取整数("key")
12
+ */
13
+ function 读取整数(配置键: 字符串): 数字;
14
+ /**
15
+ * 读取配置Double
16
+ * @param 配置键 配置key
17
+ * @returns 配置值
18
+ * @example $配置.读取浮点数("key")
19
+ */
20
+ function 读取浮点数(配置键: 字符串): 数字;
21
+ /**
22
+ * 读取配置String
23
+ * @param 配置键 配置key
24
+ * @returns 配置值
25
+ * @example $配置.读取字符串("key")
26
+ */
27
+ function 读取字符串(配置键: 字符串): 字符串;
28
+ /**
29
+ * 读取配置Bool
30
+ * @param 配置键 配置key
31
+ * @returns 配置值
32
+ * @example $配置.读取布尔值("key")
33
+ */
34
+ function 读取布尔值(配置键: 字符串): 布尔值;
35
+ /**
36
+ * 获取所有配置JSON
37
+ * @returns 所有配置JSON
38
+ * @example $配置.读取所有配置()
39
+ */
40
+ function 读取所有配置(): 字典<任意类型>;
41
+ /**
42
+ * 更新配置
43
+ * @param 配置键 配置key
44
+ * @param 配置值 配置值
45
+ * @returns 更新是否成功
46
+ * @example $配置.更新配置("key", 100)
47
+ */
48
+ function 更新配置(配置键: 字符串, 配置值: 任意类型): 布尔值;
49
+ /**
50
+ * 删除配置
51
+ * @param key 配置key
52
+ * @returns 删除是否成功
53
+ * @example $配置.删除配置("key")
54
+ */
55
+ function 删除配置(配置键: 字符串): 布尔值;
56
+ }