@mediar-ai/terminator 0.20.6
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/Cargo.toml +23 -0
- package/README.md +216 -0
- package/build.rs +4 -0
- package/index.d.ts +738 -0
- package/index.js +321 -0
- package/node_example.js +64 -0
- package/package.json +64 -0
- package/src/desktop.rs +520 -0
- package/src/element.rs +581 -0
- package/src/exceptions.rs +58 -0
- package/src/lib.rs +20 -0
- package/src/locator.rs +172 -0
- package/src/selector.rs +139 -0
- package/src/types.rs +308 -0
- package/sync-version.js +60 -0
- package/test-tree.js +83 -0
- package/tests/comprehensive-ui-elements.test.js +524 -0
- package/tests/element-chaining.test.js +158 -0
- package/tests/element-range.test.js +207 -0
- package/tests/element-scroll-into-view.test.js +256 -0
- package/tests/element-value.test.js +264 -0
- package/tests/locator-validate.test.js +260 -0
- package/tests/locator-waitfor.test.js +286 -0
- package/wrapper.d.ts +42 -0
- package/wrapper.js +170 -0
package/index.js
ADDED
|
@@ -0,0 +1,321 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/* prettier-ignore */
|
|
4
|
+
|
|
5
|
+
/* auto-generated by NAPI-RS */
|
|
6
|
+
|
|
7
|
+
const { existsSync, readFileSync } = require('fs')
|
|
8
|
+
const { join } = require('path')
|
|
9
|
+
|
|
10
|
+
const { platform, arch } = process
|
|
11
|
+
|
|
12
|
+
let nativeBinding = null
|
|
13
|
+
let localFileExisted = false
|
|
14
|
+
let loadError = null
|
|
15
|
+
|
|
16
|
+
function isMusl() {
|
|
17
|
+
// For Node 10
|
|
18
|
+
if (!process.report || typeof process.report.getReport !== 'function') {
|
|
19
|
+
try {
|
|
20
|
+
const lddPath = require('child_process').execSync('which ldd').toString().trim()
|
|
21
|
+
return readFileSync(lddPath, 'utf8').includes('musl')
|
|
22
|
+
} catch (e) {
|
|
23
|
+
return true
|
|
24
|
+
}
|
|
25
|
+
} else {
|
|
26
|
+
const { glibcVersionRuntime } = process.report.getReport().header
|
|
27
|
+
return !glibcVersionRuntime
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
switch (platform) {
|
|
32
|
+
case 'android':
|
|
33
|
+
switch (arch) {
|
|
34
|
+
case 'arm64':
|
|
35
|
+
localFileExisted = existsSync(join(__dirname, 'terminator.android-arm64.node'))
|
|
36
|
+
try {
|
|
37
|
+
if (localFileExisted) {
|
|
38
|
+
nativeBinding = require('./terminator.android-arm64.node')
|
|
39
|
+
} else {
|
|
40
|
+
nativeBinding = require('@mediar-ai/terminator-android-arm64')
|
|
41
|
+
}
|
|
42
|
+
} catch (e) {
|
|
43
|
+
loadError = e
|
|
44
|
+
}
|
|
45
|
+
break
|
|
46
|
+
case 'arm':
|
|
47
|
+
localFileExisted = existsSync(join(__dirname, 'terminator.android-arm-eabi.node'))
|
|
48
|
+
try {
|
|
49
|
+
if (localFileExisted) {
|
|
50
|
+
nativeBinding = require('./terminator.android-arm-eabi.node')
|
|
51
|
+
} else {
|
|
52
|
+
nativeBinding = require('@mediar-ai/terminator-android-arm-eabi')
|
|
53
|
+
}
|
|
54
|
+
} catch (e) {
|
|
55
|
+
loadError = e
|
|
56
|
+
}
|
|
57
|
+
break
|
|
58
|
+
default:
|
|
59
|
+
throw new Error(`Unsupported architecture on Android ${arch}`)
|
|
60
|
+
}
|
|
61
|
+
break
|
|
62
|
+
case 'win32':
|
|
63
|
+
switch (arch) {
|
|
64
|
+
case 'x64':
|
|
65
|
+
localFileExisted = existsSync(
|
|
66
|
+
join(__dirname, 'terminator.win32-x64-msvc.node')
|
|
67
|
+
)
|
|
68
|
+
try {
|
|
69
|
+
if (localFileExisted) {
|
|
70
|
+
nativeBinding = require('./terminator.win32-x64-msvc.node')
|
|
71
|
+
} else {
|
|
72
|
+
nativeBinding = require('@mediar-ai/terminator-win32-x64-msvc')
|
|
73
|
+
}
|
|
74
|
+
} catch (e) {
|
|
75
|
+
loadError = e
|
|
76
|
+
}
|
|
77
|
+
break
|
|
78
|
+
case 'ia32':
|
|
79
|
+
localFileExisted = existsSync(
|
|
80
|
+
join(__dirname, 'terminator.win32-ia32-msvc.node')
|
|
81
|
+
)
|
|
82
|
+
try {
|
|
83
|
+
if (localFileExisted) {
|
|
84
|
+
nativeBinding = require('./terminator.win32-ia32-msvc.node')
|
|
85
|
+
} else {
|
|
86
|
+
nativeBinding = require('@mediar-ai/terminator-win32-ia32-msvc')
|
|
87
|
+
}
|
|
88
|
+
} catch (e) {
|
|
89
|
+
loadError = e
|
|
90
|
+
}
|
|
91
|
+
break
|
|
92
|
+
case 'arm64':
|
|
93
|
+
localFileExisted = existsSync(
|
|
94
|
+
join(__dirname, 'terminator.win32-arm64-msvc.node')
|
|
95
|
+
)
|
|
96
|
+
try {
|
|
97
|
+
if (localFileExisted) {
|
|
98
|
+
nativeBinding = require('./terminator.win32-arm64-msvc.node')
|
|
99
|
+
} else {
|
|
100
|
+
nativeBinding = require('@mediar-ai/terminator-win32-arm64-msvc')
|
|
101
|
+
}
|
|
102
|
+
} catch (e) {
|
|
103
|
+
loadError = e
|
|
104
|
+
}
|
|
105
|
+
break
|
|
106
|
+
default:
|
|
107
|
+
throw new Error(`Unsupported architecture on Windows: ${arch}`)
|
|
108
|
+
}
|
|
109
|
+
break
|
|
110
|
+
case 'darwin':
|
|
111
|
+
localFileExisted = existsSync(join(__dirname, 'terminator.darwin-universal.node'))
|
|
112
|
+
try {
|
|
113
|
+
if (localFileExisted) {
|
|
114
|
+
nativeBinding = require('./terminator.darwin-universal.node')
|
|
115
|
+
} else {
|
|
116
|
+
nativeBinding = require('@mediar-ai/terminator-darwin-universal')
|
|
117
|
+
}
|
|
118
|
+
break
|
|
119
|
+
} catch {}
|
|
120
|
+
switch (arch) {
|
|
121
|
+
case 'x64':
|
|
122
|
+
localFileExisted = existsSync(join(__dirname, 'terminator.darwin-x64.node'))
|
|
123
|
+
try {
|
|
124
|
+
if (localFileExisted) {
|
|
125
|
+
nativeBinding = require('./terminator.darwin-x64.node')
|
|
126
|
+
} else {
|
|
127
|
+
nativeBinding = require('@mediar-ai/terminator-darwin-x64')
|
|
128
|
+
}
|
|
129
|
+
} catch (e) {
|
|
130
|
+
loadError = e
|
|
131
|
+
}
|
|
132
|
+
break
|
|
133
|
+
case 'arm64':
|
|
134
|
+
localFileExisted = existsSync(
|
|
135
|
+
join(__dirname, 'terminator.darwin-arm64.node')
|
|
136
|
+
)
|
|
137
|
+
try {
|
|
138
|
+
if (localFileExisted) {
|
|
139
|
+
nativeBinding = require('./terminator.darwin-arm64.node')
|
|
140
|
+
} else {
|
|
141
|
+
nativeBinding = require('@mediar-ai/terminator-darwin-arm64')
|
|
142
|
+
}
|
|
143
|
+
} catch (e) {
|
|
144
|
+
loadError = e
|
|
145
|
+
}
|
|
146
|
+
break
|
|
147
|
+
default:
|
|
148
|
+
throw new Error(`Unsupported architecture on macOS: ${arch}`)
|
|
149
|
+
}
|
|
150
|
+
break
|
|
151
|
+
case 'freebsd':
|
|
152
|
+
if (arch !== 'x64') {
|
|
153
|
+
throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
|
|
154
|
+
}
|
|
155
|
+
localFileExisted = existsSync(join(__dirname, 'terminator.freebsd-x64.node'))
|
|
156
|
+
try {
|
|
157
|
+
if (localFileExisted) {
|
|
158
|
+
nativeBinding = require('./terminator.freebsd-x64.node')
|
|
159
|
+
} else {
|
|
160
|
+
nativeBinding = require('@mediar-ai/terminator-freebsd-x64')
|
|
161
|
+
}
|
|
162
|
+
} catch (e) {
|
|
163
|
+
loadError = e
|
|
164
|
+
}
|
|
165
|
+
break
|
|
166
|
+
case 'linux':
|
|
167
|
+
switch (arch) {
|
|
168
|
+
case 'x64':
|
|
169
|
+
if (isMusl()) {
|
|
170
|
+
localFileExisted = existsSync(
|
|
171
|
+
join(__dirname, 'terminator.linux-x64-musl.node')
|
|
172
|
+
)
|
|
173
|
+
try {
|
|
174
|
+
if (localFileExisted) {
|
|
175
|
+
nativeBinding = require('./terminator.linux-x64-musl.node')
|
|
176
|
+
} else {
|
|
177
|
+
nativeBinding = require('@mediar-ai/terminator-linux-x64-musl')
|
|
178
|
+
}
|
|
179
|
+
} catch (e) {
|
|
180
|
+
loadError = e
|
|
181
|
+
}
|
|
182
|
+
} else {
|
|
183
|
+
localFileExisted = existsSync(
|
|
184
|
+
join(__dirname, 'terminator.linux-x64-gnu.node')
|
|
185
|
+
)
|
|
186
|
+
try {
|
|
187
|
+
if (localFileExisted) {
|
|
188
|
+
nativeBinding = require('./terminator.linux-x64-gnu.node')
|
|
189
|
+
} else {
|
|
190
|
+
nativeBinding = require('@mediar-ai/terminator-linux-x64-gnu')
|
|
191
|
+
}
|
|
192
|
+
} catch (e) {
|
|
193
|
+
loadError = e
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
break
|
|
197
|
+
case 'arm64':
|
|
198
|
+
if (isMusl()) {
|
|
199
|
+
localFileExisted = existsSync(
|
|
200
|
+
join(__dirname, 'terminator.linux-arm64-musl.node')
|
|
201
|
+
)
|
|
202
|
+
try {
|
|
203
|
+
if (localFileExisted) {
|
|
204
|
+
nativeBinding = require('./terminator.linux-arm64-musl.node')
|
|
205
|
+
} else {
|
|
206
|
+
nativeBinding = require('@mediar-ai/terminator-linux-arm64-musl')
|
|
207
|
+
}
|
|
208
|
+
} catch (e) {
|
|
209
|
+
loadError = e
|
|
210
|
+
}
|
|
211
|
+
} else {
|
|
212
|
+
localFileExisted = existsSync(
|
|
213
|
+
join(__dirname, 'terminator.linux-arm64-gnu.node')
|
|
214
|
+
)
|
|
215
|
+
try {
|
|
216
|
+
if (localFileExisted) {
|
|
217
|
+
nativeBinding = require('./terminator.linux-arm64-gnu.node')
|
|
218
|
+
} else {
|
|
219
|
+
nativeBinding = require('@mediar-ai/terminator-linux-arm64-gnu')
|
|
220
|
+
}
|
|
221
|
+
} catch (e) {
|
|
222
|
+
loadError = e
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
break
|
|
226
|
+
case 'arm':
|
|
227
|
+
if (isMusl()) {
|
|
228
|
+
localFileExisted = existsSync(
|
|
229
|
+
join(__dirname, 'terminator.linux-arm-musleabihf.node')
|
|
230
|
+
)
|
|
231
|
+
try {
|
|
232
|
+
if (localFileExisted) {
|
|
233
|
+
nativeBinding = require('./terminator.linux-arm-musleabihf.node')
|
|
234
|
+
} else {
|
|
235
|
+
nativeBinding = require('@mediar-ai/terminator-linux-arm-musleabihf')
|
|
236
|
+
}
|
|
237
|
+
} catch (e) {
|
|
238
|
+
loadError = e
|
|
239
|
+
}
|
|
240
|
+
} else {
|
|
241
|
+
localFileExisted = existsSync(
|
|
242
|
+
join(__dirname, 'terminator.linux-arm-gnueabihf.node')
|
|
243
|
+
)
|
|
244
|
+
try {
|
|
245
|
+
if (localFileExisted) {
|
|
246
|
+
nativeBinding = require('./terminator.linux-arm-gnueabihf.node')
|
|
247
|
+
} else {
|
|
248
|
+
nativeBinding = require('@mediar-ai/terminator-linux-arm-gnueabihf')
|
|
249
|
+
}
|
|
250
|
+
} catch (e) {
|
|
251
|
+
loadError = e
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
break
|
|
255
|
+
case 'riscv64':
|
|
256
|
+
if (isMusl()) {
|
|
257
|
+
localFileExisted = existsSync(
|
|
258
|
+
join(__dirname, 'terminator.linux-riscv64-musl.node')
|
|
259
|
+
)
|
|
260
|
+
try {
|
|
261
|
+
if (localFileExisted) {
|
|
262
|
+
nativeBinding = require('./terminator.linux-riscv64-musl.node')
|
|
263
|
+
} else {
|
|
264
|
+
nativeBinding = require('@mediar-ai/terminator-linux-riscv64-musl')
|
|
265
|
+
}
|
|
266
|
+
} catch (e) {
|
|
267
|
+
loadError = e
|
|
268
|
+
}
|
|
269
|
+
} else {
|
|
270
|
+
localFileExisted = existsSync(
|
|
271
|
+
join(__dirname, 'terminator.linux-riscv64-gnu.node')
|
|
272
|
+
)
|
|
273
|
+
try {
|
|
274
|
+
if (localFileExisted) {
|
|
275
|
+
nativeBinding = require('./terminator.linux-riscv64-gnu.node')
|
|
276
|
+
} else {
|
|
277
|
+
nativeBinding = require('@mediar-ai/terminator-linux-riscv64-gnu')
|
|
278
|
+
}
|
|
279
|
+
} catch (e) {
|
|
280
|
+
loadError = e
|
|
281
|
+
}
|
|
282
|
+
}
|
|
283
|
+
break
|
|
284
|
+
case 's390x':
|
|
285
|
+
localFileExisted = existsSync(
|
|
286
|
+
join(__dirname, 'terminator.linux-s390x-gnu.node')
|
|
287
|
+
)
|
|
288
|
+
try {
|
|
289
|
+
if (localFileExisted) {
|
|
290
|
+
nativeBinding = require('./terminator.linux-s390x-gnu.node')
|
|
291
|
+
} else {
|
|
292
|
+
nativeBinding = require('@mediar-ai/terminator-linux-s390x-gnu')
|
|
293
|
+
}
|
|
294
|
+
} catch (e) {
|
|
295
|
+
loadError = e
|
|
296
|
+
}
|
|
297
|
+
break
|
|
298
|
+
default:
|
|
299
|
+
throw new Error(`Unsupported architecture on Linux: ${arch}`)
|
|
300
|
+
}
|
|
301
|
+
break
|
|
302
|
+
default:
|
|
303
|
+
throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
if (!nativeBinding) {
|
|
307
|
+
if (loadError) {
|
|
308
|
+
throw loadError
|
|
309
|
+
}
|
|
310
|
+
throw new Error(`Failed to load native binding`)
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
const { Desktop, Element, Locator, Selector, PropertyLoadingMode, TextPosition, HighlightHandle } = nativeBinding
|
|
314
|
+
|
|
315
|
+
module.exports.Desktop = Desktop
|
|
316
|
+
module.exports.Element = Element
|
|
317
|
+
module.exports.Locator = Locator
|
|
318
|
+
module.exports.Selector = Selector
|
|
319
|
+
module.exports.PropertyLoadingMode = PropertyLoadingMode
|
|
320
|
+
module.exports.TextPosition = TextPosition
|
|
321
|
+
module.exports.HighlightHandle = HighlightHandle
|
package/node_example.js
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
const {
|
|
2
|
+
Desktop,
|
|
3
|
+
ElementNotFoundError,
|
|
4
|
+
PlatformError
|
|
5
|
+
} = require('.');
|
|
6
|
+
|
|
7
|
+
async function main() {
|
|
8
|
+
const desktop = new Desktop();
|
|
9
|
+
const root = desktop.root();
|
|
10
|
+
console.log('Root element:', root.role(), root.name());
|
|
11
|
+
|
|
12
|
+
// List applications
|
|
13
|
+
const apps = desktop.applications();
|
|
14
|
+
console.log('Applications:', apps.map(a => [a.role(), a.name()]));
|
|
15
|
+
|
|
16
|
+
// Find an element using a selector (async)
|
|
17
|
+
const locator = desktop.locator('role:button');
|
|
18
|
+
try {
|
|
19
|
+
const button = await locator.first(0); // timeout in ms (0 = immediate, no retry)
|
|
20
|
+
console.log('Found button:', button.role(), button.name());
|
|
21
|
+
await button.click();
|
|
22
|
+
} catch (e) {
|
|
23
|
+
if (e instanceof ElementNotFoundError) {
|
|
24
|
+
console.log('No button found:', e.message);
|
|
25
|
+
} else {
|
|
26
|
+
console.log('No button found or click failed:', e);
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
// Run a command (async)
|
|
31
|
+
try {
|
|
32
|
+
const cmd = await desktop.runCommand('echo hello', 'echo hello');
|
|
33
|
+
console.log('Command output:', cmd.stdout);
|
|
34
|
+
} catch (e) {
|
|
35
|
+
console.log('Command failed:', e);
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Screenshot (async)
|
|
39
|
+
try {
|
|
40
|
+
const screenshot = await desktop.captureScreen();
|
|
41
|
+
console.log(`Screenshot: ${screenshot.width}x${screenshot.height}, ${screenshot.imageData.length} bytes`);
|
|
42
|
+
} catch (e) {
|
|
43
|
+
console.log('Screenshot failed:', e);
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
// Error handling example
|
|
47
|
+
try {
|
|
48
|
+
desktop.application('NonExistentApp');
|
|
49
|
+
} catch (e) {
|
|
50
|
+
if (e instanceof PlatformError) {
|
|
51
|
+
console.log('Expected error:', e.message);
|
|
52
|
+
} else {
|
|
53
|
+
console.log('Unexpected error:', e);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
// Show help for Desktop (prints method names)
|
|
58
|
+
console.log('\nHelp for Desktop:');
|
|
59
|
+
console.log(Object.getOwnPropertyNames(Desktop.prototype));
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
main().catch(err => {
|
|
63
|
+
console.error('Fatal error:', err);
|
|
64
|
+
});
|
package/package.json
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
{
|
|
2
|
+
"author": "mediar-ai",
|
|
3
|
+
"bugs": {
|
|
4
|
+
"url": "https://github.com/mediar-ai/terminator/issues"
|
|
5
|
+
},
|
|
6
|
+
"description": "Node.js/TypeScript bindings for the Terminator Rust library (via napi-rs)",
|
|
7
|
+
"devDependencies": {
|
|
8
|
+
"@napi-rs/cli": "^2.18.4"
|
|
9
|
+
},
|
|
10
|
+
"engines": {
|
|
11
|
+
"node": ">= 10"
|
|
12
|
+
},
|
|
13
|
+
"homepage": "https://github.com/mediar-ai/terminator",
|
|
14
|
+
"keywords": [
|
|
15
|
+
"napi",
|
|
16
|
+
"rust",
|
|
17
|
+
"native",
|
|
18
|
+
"terminator",
|
|
19
|
+
"automation",
|
|
20
|
+
"desktop",
|
|
21
|
+
"gui",
|
|
22
|
+
"ui",
|
|
23
|
+
"testing",
|
|
24
|
+
"windows",
|
|
25
|
+
"macos",
|
|
26
|
+
"linux"
|
|
27
|
+
],
|
|
28
|
+
"main": "wrapper.js",
|
|
29
|
+
"name": "@mediar-ai/terminator",
|
|
30
|
+
"napi": {
|
|
31
|
+
"name": "terminator",
|
|
32
|
+
"triples": {
|
|
33
|
+
"additional": [
|
|
34
|
+
"aarch64-apple-darwin",
|
|
35
|
+
"aarch64-pc-windows-msvc"
|
|
36
|
+
]
|
|
37
|
+
}
|
|
38
|
+
},
|
|
39
|
+
"optionalDependencies": {
|
|
40
|
+
"@mediar-ai/terminator-win32-x64-msvc": "0.20.6",
|
|
41
|
+
"@mediar-ai/terminator-darwin-x64": "0.20.6",
|
|
42
|
+
"@mediar-ai/terminator-linux-x64-gnu": "0.20.6",
|
|
43
|
+
"@mediar-ai/terminator-darwin-arm64": "0.20.6",
|
|
44
|
+
"@mediar-ai/terminator-win32-arm64-msvc": "0.20.6"
|
|
45
|
+
},
|
|
46
|
+
"repository": {
|
|
47
|
+
"type": "git",
|
|
48
|
+
"url": "https://github.com/mediar-ai/terminator"
|
|
49
|
+
},
|
|
50
|
+
"scripts": {
|
|
51
|
+
"artifacts": "npx napi artifacts",
|
|
52
|
+
"build": "npm run sync-version && npx napi build --platform --release --strip",
|
|
53
|
+
"build:debug": "npm run sync-version && npx napi build --platform",
|
|
54
|
+
"prepublish:ci": "npm run sync-version",
|
|
55
|
+
"prepublishOnly": "npm run sync-version && npx napi prepublish -t npm",
|
|
56
|
+
"sync-version": "node sync-version.js",
|
|
57
|
+
"test": "npm run test:basic && npm run test:chaining",
|
|
58
|
+
"test-hook": "powershell.exe -ExecutionPolicy Bypass -File \"../../.git/hooks/pre-push.ps1\"",
|
|
59
|
+
"test:basic": "node node_example.js",
|
|
60
|
+
"test:chaining": "node tests/element-chaining.test.js"
|
|
61
|
+
},
|
|
62
|
+
"types": "wrapper.d.ts",
|
|
63
|
+
"version": "0.20.6"
|
|
64
|
+
}
|