Repository navigation
Expand file tree
/
Copy pathindex.ts
More file actions
434 lines (382 loc) · 15.6 KB
/
Copy pathindex.ts
File metadata and controls
434 lines (382 loc) · 15.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
import type { ClipboardCommandOptions } from '@agent-device/contracts/client';
import { DEVICE_ROTATIONS, parseDeviceRotation } from '@agent-device/contracts/device';
import { type BackMode, BACK_MODES } from '@agent-device/contracts/back-mode';
import {
TV_REMOTE_BUTTONS,
TV_REMOTE_BUTTON_USAGE,
parseTvRemoteButton,
tvRemoteDurationMode,
} from '@agent-device/contracts/tv-remote';
import { AppError } from '@agent-device/kernel/errors';
import type { CommandSchemaOverride } from '@agent-device/command-registry/command-schema';
import {
commonInputFromFlags,
direct,
optionalString,
request,
requiredDaemonString,
} from '../cli-grammar/common.ts';
import type { CliReader, DaemonWriter } from '../cli-grammar/types.ts';
import { enumField, integerField, requiredField, stringField } from '../command-input.ts';
import { compactRecord } from '../input-readers.ts';
import { defineCommandFacet, defineCommandFamilyFromFacets } from '../family/types.ts';
import { defineFieldCommandMetadata } from '../field-command-contract.ts';
import {
postActionObservationCliFlags,
postActionObservationFields,
} from '../post-action-observation-grammar.ts';
import { systemCliOutputFormatters } from './output.ts';
const APPSTATE_COMMAND_NAME = 'appstate';
const BACK_COMMAND_NAME = 'back';
const HOME_COMMAND_NAME = 'home';
const ORIENTATION_COMMAND_NAME = 'orientation';
const APP_SWITCHER_COMMAND_NAME = 'app-switcher';
const ACTION_BUTTON_COMMAND_NAME = 'action-button';
const KEYBOARD_COMMAND_NAME = 'keyboard';
const CLIPBOARD_COMMAND_NAME = 'clipboard';
const TV_REMOTE_COMMAND_NAME = 'tv-remote';
const TV_REMOTE_LONGPRESS_PRESET_MS = 500;
const CLIPBOARD_ACTION_VALUES = ['read', 'write'] as const;
const KEYBOARD_METADATA_ACTION_VALUES = ['status', 'dismiss', 'enter', 'return'] as const;
const appStateCommandDescription = 'Show foreground app/activity';
const backCommandDescription =
'Navigate back in the app or through system navigation. Use in-app for the app navigation stack and system when the platform back behavior is required.';
const homeCommandDescription =
'Send the selected device to its home screen. This leaves the app session open but moves the foreground away from the app.';
const orientationCommandDescription = 'Set device orientation on iOS and Android';
const appSwitcherCommandDescription =
'Open the device app switcher to inspect or change foreground apps. This changes the visible system UI and may move focus away from the current app.';
const keyboardCommandDescription =
'Inspect Android keyboard visibility/type or press/dismiss the device keyboard. To hide the keyboard, use keyboard dismiss. It taps the keyboard dismiss/hide key when one is exposed, verifies the keyboard closed, and reports UNSUPPORTED_OPERATION when no dismiss key exists \u2014 background taps are never attempted.';
const clipboardCommandDescription =
'Read the current device clipboard text, or replace its contents with the given text. Android runs both through the clipboard service shell command, and a build that implements none (Android 16 does not) refuses with UNSUPPORTED_OPERATION rather than reporting an empty clipboard.';
const actionButtonCommandDescription =
'Press the iPhone Action Button. The press reaches the system exactly as a hardware press does, so a Shortcut or App Intent assigned to the button fires whether the app is foregrounded, backgrounded, or terminated. The app is never activated first and nothing is re-captured after: the press preserves the app state it found.';
const tvRemoteCommandDescription =
'Press or long-press a TV remote or D-pad button on Android TV, tvOS, or Vega OS. Choose the button and optional hold duration through the input fields. The aliases ok, center, and enter all map to select.';
const appStateCommandMetadata = defineFieldCommandMetadata(
APPSTATE_COMMAND_NAME,
appStateCommandDescription,
{},
);
const backCommandMetadata = defineFieldCommandMetadata(BACK_COMMAND_NAME, backCommandDescription, {
mode: enumField(BACK_MODES),
...postActionObservationFields(BACK_COMMAND_NAME),
});
const homeCommandMetadata = defineFieldCommandMetadata(
HOME_COMMAND_NAME,
homeCommandDescription,
{},
);
const orientationCommandMetadata = defineFieldCommandMetadata(
ORIENTATION_COMMAND_NAME,
orientationCommandDescription,
{
orientation: requiredField(enumField(DEVICE_ROTATIONS)),
},
);
const appSwitcherCommandMetadata = defineFieldCommandMetadata(
APP_SWITCHER_COMMAND_NAME,
appSwitcherCommandDescription,
{},
);
const actionButtonCommandMetadata = defineFieldCommandMetadata(
ACTION_BUTTON_COMMAND_NAME,
actionButtonCommandDescription,
{},
);
const keyboardCommandMetadata = defineFieldCommandMetadata(
KEYBOARD_COMMAND_NAME,
keyboardCommandDescription,
{
action: enumField(KEYBOARD_METADATA_ACTION_VALUES),
},
);
const clipboardCommandMetadata = defineFieldCommandMetadata(
CLIPBOARD_COMMAND_NAME,
clipboardCommandDescription,
{
action: requiredField(enumField(CLIPBOARD_ACTION_VALUES)),
text: stringField(),
},
);
const tvRemoteCommandMetadata = defineFieldCommandMetadata(
TV_REMOTE_COMMAND_NAME,
tvRemoteCommandDescription,
{
button: requiredField(enumField(TV_REMOTE_BUTTONS)),
durationMs: integerField(
`Press duration in milliseconds. tvOS and Vega OS use the exact hold duration; Android TV maps any positive value to an ADB longpress (${tvRemoteDurationMode('android')}).`,
{
min: 0,
},
),
},
);
const appStateCliSchema = {} as const satisfies CommandSchemaOverride;
const backCliSchema = {
usageOverride: 'back [--in-app|--system] [--settle]',
usageFlags: [],
allowedFlags: ['backMode', ...postActionObservationCliFlags(BACK_COMMAND_NAME)],
} as const satisfies CommandSchemaOverride;
const homeCliSchema = {} as const satisfies CommandSchemaOverride;
const appSwitcherCliSchema = {} as const satisfies CommandSchemaOverride;
const actionButtonCliSchema = {} as const satisfies CommandSchemaOverride;
const orientationCliSchema = {
usageOverride: 'orientation <portrait|portrait-upside-down|landscape-left|landscape-right>',
positionalArgs: ['orientation'],
} as const satisfies CommandSchemaOverride;
const keyboardCliSchema = {
usageOverride: 'keyboard [status|get|dismiss|enter|return]',
positionalArgs: ['action?'],
} as const satisfies CommandSchemaOverride;
const clipboardCliSchema = {
usageOverride: 'clipboard read | clipboard write <text>',
listUsageOverride: 'clipboard read | clipboard write <text>',
positionalArgs: ['read|write', 'text?'],
allowsExtraPositionals: true,
} as const satisfies CommandSchemaOverride;
const tvRemoteCliSchema = {
usageOverride: `tv-remote [press|longpress] ${TV_REMOTE_BUTTON_USAGE}`,
listUsageOverride: 'tv-remote press|longpress <button> [--duration-ms <ms>]',
positionalArgs: ['press|longpress?', 'button'],
allowedFlags: ['durationMs'],
} as const satisfies CommandSchemaOverride;
export const appStateCliReader: CliReader = (_positionals, flags) => commonInputFromFlags(flags);
export const homeCliReader: CliReader = (_positionals, flags) => commonInputFromFlags(flags);
export const appSwitcherCliReader: CliReader = (_positionals, flags) => commonInputFromFlags(flags);
export const actionButtonCliReader: CliReader = (_positionals, flags) =>
commonInputFromFlags(flags);
export const backCliReader: CliReader = (_positionals, flags) => ({
...commonInputFromFlags(flags),
mode: flags.backMode,
});
export const orientationCliReader: CliReader = (positionals, flags) => ({
...commonInputFromFlags(flags),
orientation: parseDeviceRotation(positionals[0]),
});
export const keyboardCliReader: CliReader = (positionals, flags) => ({
...commonInputFromFlags(flags),
...readKeyboardInput(positionals),
});
export const clipboardCliReader: CliReader = (positionals, flags) => ({
...commonInputFromFlags(flags),
...readClipboardInput(positionals),
});
export const tvRemoteCliReader: CliReader = (positionals, flags) => ({
...commonInputFromFlags(flags),
...readTvRemoteInput(positionals, flags.durationMs),
});
export const appStateDaemonWriter: DaemonWriter = direct(APPSTATE_COMMAND_NAME);
export const backDaemonWriter: DaemonWriter = (input) =>
request(BACK_COMMAND_NAME, [], {
...input,
backMode: readBackMode(input.mode),
});
export const homeDaemonWriter: DaemonWriter = direct(HOME_COMMAND_NAME);
export const orientationDaemonWriter: DaemonWriter = direct(ORIENTATION_COMMAND_NAME, (input) => [
requiredDaemonString(input.orientation, 'orientation requires orientation'),
]);
export const appSwitcherDaemonWriter: DaemonWriter = direct(APP_SWITCHER_COMMAND_NAME);
export const actionButtonDaemonWriter: DaemonWriter = direct(ACTION_BUTTON_COMMAND_NAME);
export const keyboardDaemonWriter: DaemonWriter = direct(KEYBOARD_COMMAND_NAME, (input) =>
optionalString(input.action),
);
export const clipboardDaemonWriter: DaemonWriter = direct(CLIPBOARD_COMMAND_NAME, (input) =>
clipboardPositionals(input as ClipboardCommandOptions),
);
export const tvRemoteDaemonWriter: DaemonWriter = direct(TV_REMOTE_COMMAND_NAME, (input) => [
requiredDaemonString(input.button, 'tv-remote requires button'),
]);
const appStateCommandFacet = defineCommandFacet({
name: APPSTATE_COMMAND_NAME,
text: {
summary: 'Show the foreground app and activity',
},
metadata: appStateCommandMetadata,
run: (client, input) => client.command.appState(input),
cliSchema: appStateCliSchema,
cliReader: appStateCliReader,
daemonWriter: appStateDaemonWriter,
cliOutputFormatter: systemCliOutputFormatters.appstate,
});
const backCommandFacet = defineCommandFacet({
name: BACK_COMMAND_NAME,
text: {
summary: 'Navigate back in the app or system',
},
metadata: backCommandMetadata,
run: (client, input) => client.command.back(input),
cliSchema: backCliSchema,
cliReader: backCliReader,
daemonWriter: backDaemonWriter,
cliOutputFormatter: systemCliOutputFormatters.back,
});
const homeCommandFacet = defineCommandFacet({
name: HOME_COMMAND_NAME,
text: {
summary: 'Go to the device home screen',
},
metadata: homeCommandMetadata,
run: (client, input) => client.command.home(input),
cliSchema: homeCliSchema,
cliReader: homeCliReader,
daemonWriter: homeDaemonWriter,
cliOutputFormatter: systemCliOutputFormatters.home,
});
const orientationCommandFacet = defineCommandFacet({
name: ORIENTATION_COMMAND_NAME,
text: {
summary: 'Set device orientation',
},
metadata: orientationCommandMetadata,
run: (client, input) => client.command.orientation(input),
cliSchema: orientationCliSchema,
cliReader: orientationCliReader,
daemonWriter: orientationDaemonWriter,
cliOutputFormatter: systemCliOutputFormatters.orientation,
});
const appSwitcherCommandFacet = defineCommandFacet({
name: APP_SWITCHER_COMMAND_NAME,
text: {
summary: 'Open the device app switcher',
},
metadata: appSwitcherCommandMetadata,
run: (client, input) => client.command.appSwitcher(input),
cliSchema: appSwitcherCliSchema,
cliReader: appSwitcherCliReader,
daemonWriter: appSwitcherDaemonWriter,
cliOutputFormatter: systemCliOutputFormatters['app-switcher'],
});
const keyboardCommandFacet = defineCommandFacet({
name: KEYBOARD_COMMAND_NAME,
text: {
summary: 'Inspect, press, or dismiss the device keyboard',
},
metadata: keyboardCommandMetadata,
run: (client, input) => client.command.keyboard(input),
cliSchema: keyboardCliSchema,
cliReader: keyboardCliReader,
daemonWriter: keyboardDaemonWriter,
cliOutputFormatter: systemCliOutputFormatters.keyboard,
});
const clipboardCommandFacet = defineCommandFacet({
name: CLIPBOARD_COMMAND_NAME,
text: {
summary: 'Read or write device clipboard text',
},
metadata: clipboardCommandMetadata,
run: (client, input) => client.command.clipboard(input as ClipboardCommandOptions),
cliSchema: clipboardCliSchema,
cliReader: clipboardCliReader,
daemonWriter: clipboardDaemonWriter,
cliOutputFormatter: systemCliOutputFormatters.clipboard,
});
const actionButtonCommandFacet = defineCommandFacet({
name: ACTION_BUTTON_COMMAND_NAME,
text: {
summary: 'Press the iPhone Action Button',
cliDetail:
'iPhone and iPad only. The runner asks the device for the button and reports unsupported when that model has none.',
},
metadata: actionButtonCommandMetadata,
run: (client, input) => client.command.actionButton(input),
cliSchema: actionButtonCliSchema,
cliReader: actionButtonCliReader,
daemonWriter: actionButtonDaemonWriter,
cliOutputFormatter: systemCliOutputFormatters['action-button'],
});
const tvRemoteCommandFacet = defineCommandFacet({
name: TV_REMOTE_COMMAND_NAME,
text: {
summary: 'Press a TV remote/D-pad button',
cliDetail: 'longpress holds for 500ms by default; --duration-ms overrides the preset.',
},
metadata: tvRemoteCommandMetadata,
run: (client, input) => client.command.tvRemote(input),
cliSchema: tvRemoteCliSchema,
cliReader: tvRemoteCliReader,
daemonWriter: tvRemoteDaemonWriter,
cliOutputFormatter: systemCliOutputFormatters['tv-remote'],
});
export const systemCommandFamily = defineCommandFamilyFromFacets({
name: 'system',
commands: [
appStateCommandFacet,
backCommandFacet,
homeCommandFacet,
orientationCommandFacet,
appSwitcherCommandFacet,
actionButtonCommandFacet,
keyboardCommandFacet,
clipboardCommandFacet,
tvRemoteCommandFacet,
],
});
function readBackMode(value: unknown): BackMode | undefined {
return value === 'in-app' || value === 'system' ? value : undefined;
}
function clipboardPositionals(input: ClipboardCommandOptions): string[] {
return input.action === 'read' ? ['read'] : ['write', input.text];
}
function readKeyboardInput(positionals: string[]): Record<string, unknown> {
if (positionals.length > 1) {
throw new AppError('INVALID_ARGS', 'keyboard accepts at most one action argument.');
}
return compactRecord({ action: readKeyboardAction(positionals[0]) });
}
function readClipboardInput(positionals: string[]): Record<string, unknown> {
const action = positionals[0]?.toLowerCase();
if (action !== 'read' && action !== 'write') {
throw new AppError('INVALID_ARGS', 'clipboard requires a subcommand: read or write.');
}
if (action === 'read') {
if (positionals.length !== 1) {
throw new AppError('INVALID_ARGS', 'clipboard read does not accept additional arguments.');
}
return { action };
}
if (positionals.length < 2) {
throw new AppError('INVALID_ARGS', 'clipboard write requires text.');
}
return { action, text: positionals.slice(1).join(' ') };
}
function readTvRemoteInput(
positionals: string[],
durationMs: number | undefined,
): Record<string, unknown> {
const subcommand = positionals[0]?.toLowerCase();
const isNamedAction = subcommand === 'press' || subcommand === 'longpress';
const args = isNamedAction ? positionals.slice(1) : positionals;
if (args.length !== 1) {
throw new AppError(
'INVALID_ARGS',
`tv-remote requires exactly one button: ${TV_REMOTE_BUTTONS.join(', ')}.`,
);
}
const effectiveDurationMs =
durationMs ?? (subcommand === 'longpress' ? TV_REMOTE_LONGPRESS_PRESET_MS : undefined);
return compactRecord({
button: parseTvRemoteButton(args[0]),
durationMs: effectiveDurationMs,
});
}
function readKeyboardAction(
value: string | undefined,
): 'status' | 'dismiss' | 'enter' | 'return' | undefined {
const action = value?.toLowerCase();
if (action === 'get') return 'status';
if (
action === undefined ||
action === 'status' ||
action === 'dismiss' ||
action === 'enter' ||
action === 'return'
) {
return action;
}
throw new AppError(
'INVALID_ARGS',
'keyboard action must be status, get, dismiss, enter, or return.',
);
}