@appium/types 0.25.3 → 1.0.0-rc.1
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/build/lib/command.d.ts +7 -7
- package/build/lib/command.d.ts.map +1 -1
- package/build/lib/driver.d.ts +21 -424
- package/build/lib/driver.d.ts.map +1 -1
- package/build/lib/server.d.ts +0 -7
- package/build/lib/server.d.ts.map +1 -1
- package/lib/command.ts +7 -7
- package/lib/driver.ts +24 -493
- package/lib/server.ts +0 -8
- package/package.json +10 -9
package/build/lib/command.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ export interface PayloadParams {
|
|
|
9
9
|
wrap?: string;
|
|
10
10
|
unwrap?: string;
|
|
11
11
|
required?: ReadonlyArray<string> | MultidimensionalReadonlyArray<string, 2>;
|
|
12
|
-
optional?: ReadonlyArray<string
|
|
12
|
+
optional?: ReadonlyArray<string>;
|
|
13
13
|
validate?: (obj: any, protocol: string) => boolean | string | undefined;
|
|
14
14
|
makeArgs?: (obj: any) => any;
|
|
15
15
|
}
|
|
@@ -158,11 +158,11 @@ export interface ErrorBiDiCommandResponse extends GenericBiDiCommandResponse {
|
|
|
158
158
|
}
|
|
159
159
|
export interface RestCommandItemParam {
|
|
160
160
|
/**
|
|
161
|
-
* Command
|
|
161
|
+
* Command parameter name
|
|
162
162
|
*/
|
|
163
163
|
name: string;
|
|
164
164
|
/**
|
|
165
|
-
* True if the
|
|
165
|
+
* True if the parameter is required for the given command
|
|
166
166
|
*/
|
|
167
167
|
required: boolean;
|
|
168
168
|
}
|
|
@@ -176,7 +176,7 @@ export interface RestCommandItem {
|
|
|
176
176
|
*/
|
|
177
177
|
deprecated?: boolean;
|
|
178
178
|
/**
|
|
179
|
-
*
|
|
179
|
+
* Optional infostring about the command's purpose or a comment
|
|
180
180
|
*/
|
|
181
181
|
info?: string;
|
|
182
182
|
/**
|
|
@@ -206,11 +206,11 @@ export interface RestCommandsMap {
|
|
|
206
206
|
}
|
|
207
207
|
export interface BiDiCommandItemParam {
|
|
208
208
|
/**
|
|
209
|
-
* Command
|
|
209
|
+
* Command parameter name
|
|
210
210
|
*/
|
|
211
211
|
name: string;
|
|
212
212
|
/**
|
|
213
|
-
* True if the
|
|
213
|
+
* True if the parameter is required for the given command
|
|
214
214
|
*/
|
|
215
215
|
required: boolean;
|
|
216
216
|
}
|
|
@@ -224,7 +224,7 @@ export interface BiDiCommandItem {
|
|
|
224
224
|
*/
|
|
225
225
|
deprecated?: boolean;
|
|
226
226
|
/**
|
|
227
|
-
*
|
|
227
|
+
* Optional infostring about the command's purpose or a comment
|
|
228
228
|
*/
|
|
229
229
|
info?: string;
|
|
230
230
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../lib/command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAE,6BAA6B,EAAC,MAAM,WAAW,CAAC;AACzE,OAAO,EAAC,MAAM,EAAE,aAAa,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,MAAM,EAAE,aAAa,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,YAAY,EAAC,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,6BAA6B,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5E,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,
|
|
1
|
+
{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../lib/command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAE,6BAA6B,EAAC,MAAM,WAAW,CAAC;AACzE,OAAO,EAAC,MAAM,EAAE,aAAa,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,MAAM,EAAE,aAAa,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,YAAY,EAAC,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,6BAA6B,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5E,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACjC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;IACxE,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC;CAC9B;AACD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,MAAM,GAC/D,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAC5B,CAAC,SAAS,MAAM,GAChB,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAC5B,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,MAAM;IAC/C,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,GAAG,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;QACzB,IAAI,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;QAC1B,MAAM,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;KAC7B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO,GAAG,OAAO,CAC5E,SAAQ,aAAa;IACrB;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,IAAI,GAAG,MAAM,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;CAChG;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,aAAa;IACtE;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;CACtE;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,MAAM;IAC/C,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,GAAG,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;QACzB,IAAI,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;QAC1B,MAAM,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;KAC7B,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IAC3D,OAAO,EAAE,MAAM,eAAe,CAC5B,QAAQ,CAAC,GAAG,CAAC,EACb,GAAG,SAAS,MAAM,GAAG,aAAa,GAAG,GAAG,SAAS,MAAM,GAAG,aAAa,GAAG,KAAK,CAChF,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;KAClC,CAAC;IAEF;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,oBAAoB;IACpF,OAAO,EAAE,MAAM,eAAe,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,oBAAoB;IACpF,OAAO,EAAE,MAAM,eAAe,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,MAAM,GACtE,QAAQ,CAAC,YAAY,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,GACjD,CAAC,SAAS,MAAM,GAChB,QAAQ,CAAC,YAAY,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,GACjD,KAAK,CAAC;AAEV,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,aAAc,SAAQ,oBAAoB;IACzD,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;CAC5B;AAGD,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,0BAA2B,SAAQ,0BAA0B;IAC5E,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,WAAW,wBAAyB,SAAQ,0BAA0B;IAC1E,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAC/C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IACjD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,0BAA0B;IACzC,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACjD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACnD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC,CAAC;CACtE;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,wBAAwB,CAAC;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B"}
|
package/build/lib/driver.d.ts
CHANGED
|
@@ -27,22 +27,13 @@ export interface ITimeoutCommands {
|
|
|
27
27
|
* @param pageLoad - the number in ms for the pageLoad timeout, used for the W3C command
|
|
28
28
|
* @param implicit - the number in ms for the implicit wait timeout, used for the W3C command
|
|
29
29
|
*/
|
|
30
|
-
timeouts(type
|
|
30
|
+
timeouts(type?: string, ms?: number | string, script?: number, pageLoad?: number, implicit?: number | string): Promise<void>;
|
|
31
31
|
/**
|
|
32
32
|
* Set the new command timeout
|
|
33
33
|
*
|
|
34
34
|
* @param ms - the timeout in ms
|
|
35
35
|
*/
|
|
36
36
|
setNewCommandTimeout(ms: number): void;
|
|
37
|
-
/**
|
|
38
|
-
* Set the implicit wait timeout
|
|
39
|
-
*
|
|
40
|
-
* @param ms - the timeout in ms
|
|
41
|
-
*
|
|
42
|
-
* @deprecated Use `timeouts` instead
|
|
43
|
-
*
|
|
44
|
-
*/
|
|
45
|
-
implicitWait(ms: number | string): Promise<void>;
|
|
46
37
|
/**
|
|
47
38
|
* A helper method (not a command) used to set the implicit wait value
|
|
48
39
|
*
|
|
@@ -70,39 +61,18 @@ export interface ITimeoutCommands {
|
|
|
70
61
|
* @param ms - the timeout in ms
|
|
71
62
|
*/
|
|
72
63
|
implicitWaitW3C(ms: number): Promise<void>;
|
|
73
|
-
/**
|
|
74
|
-
* Set the implicit wait value that was sent in via the JSONWP
|
|
75
|
-
*
|
|
76
|
-
* @param ms - the timeout in ms
|
|
77
|
-
* @deprecated
|
|
78
|
-
*/
|
|
79
|
-
implicitWaitMJSONWP(ms: number): Promise<void>;
|
|
80
64
|
/**
|
|
81
65
|
* Set the page load timeout value that was sent in via the W3C protocol
|
|
82
66
|
*
|
|
83
67
|
* @param ms - the timeout in ms
|
|
84
68
|
*/
|
|
85
69
|
pageLoadTimeoutW3C(ms: number): Promise<void>;
|
|
86
|
-
/**
|
|
87
|
-
* Set the page load timeout value that was sent in via the JSONWP
|
|
88
|
-
*
|
|
89
|
-
* @param ms - the timeout in ms
|
|
90
|
-
* @deprecated
|
|
91
|
-
*/
|
|
92
|
-
pageLoadTimeoutMJSONWP(ms: number): Promise<void>;
|
|
93
70
|
/**
|
|
94
71
|
* Set the script timeout value that was sent in via the W3C protocol
|
|
95
72
|
*
|
|
96
73
|
* @param ms - the timeout in ms
|
|
97
74
|
*/
|
|
98
75
|
scriptTimeoutW3C(ms: number): Promise<void>;
|
|
99
|
-
/**
|
|
100
|
-
* Set the script timeout value that was sent in via the JSONWP
|
|
101
|
-
*
|
|
102
|
-
* @param ms - the timeout in ms
|
|
103
|
-
* @deprecated
|
|
104
|
-
*/
|
|
105
|
-
scriptTimeoutMJSONWP(ms: number): Promise<void>;
|
|
106
76
|
/**
|
|
107
77
|
* Set Appium's new command timeout
|
|
108
78
|
*
|
|
@@ -147,12 +117,18 @@ export interface IExecuteCommands {
|
|
|
147
117
|
*/
|
|
148
118
|
executeMethod<TArgs extends readonly any[] | readonly [StringRecord<unknown>] = unknown[], TReturn = unknown>(script: string, args: TArgs): Promise<TReturn>;
|
|
149
119
|
}
|
|
150
|
-
|
|
120
|
+
/**
|
|
121
|
+
* Data returned by `AppiumDriver.getAppiumSessions`
|
|
122
|
+
*
|
|
123
|
+
* @typeParam C - The driver's constraints
|
|
124
|
+
*/
|
|
125
|
+
export interface TimestampedMultiSessionData<C extends Constraints = Constraints> {
|
|
151
126
|
id: string;
|
|
127
|
+
created: number;
|
|
152
128
|
capabilities: DriverCaps<C>;
|
|
153
129
|
}
|
|
154
130
|
/**
|
|
155
|
-
* Data returned by {@linkcode
|
|
131
|
+
* Data returned by {@linkcode ISessionHandler.getSession}.
|
|
156
132
|
*
|
|
157
133
|
* @typeParam C - The driver's constraints
|
|
158
134
|
* @typeParam T - Any extra data the driver stuffs in here
|
|
@@ -371,12 +347,6 @@ export interface ISessionHandler<C extends Constraints = Constraints, CreateResu
|
|
|
371
347
|
* @param driverData - the driver data for other currently-running sessions
|
|
372
348
|
*/
|
|
373
349
|
deleteSession(sessionId?: string, driverData?: DriverData[]): Promise<DeleteResult | void>;
|
|
374
|
-
/**
|
|
375
|
-
* Get data for all sessions running on an Appium server
|
|
376
|
-
*
|
|
377
|
-
* @returns A list of session data objects
|
|
378
|
-
*/
|
|
379
|
-
getSessions(): Promise<MultiSessionData[]>;
|
|
380
350
|
/**
|
|
381
351
|
* Get the data for the current session
|
|
382
352
|
*
|
|
@@ -481,6 +451,7 @@ export interface DriverStatus {
|
|
|
481
451
|
export interface Core<C extends Constraints, Settings extends StringRecord = StringRecord> {
|
|
482
452
|
shouldValidateCaps: boolean;
|
|
483
453
|
sessionId: string | null;
|
|
454
|
+
sessionCreationTimestampMs: number;
|
|
484
455
|
opts: DriverOpts<C>;
|
|
485
456
|
initialOpts: InitialOpts;
|
|
486
457
|
protocol?: Protocol;
|
|
@@ -500,10 +471,6 @@ export interface Core<C extends Constraints, Settings extends StringRecord = Str
|
|
|
500
471
|
isCommandsQueueEnabled: boolean;
|
|
501
472
|
eventHistory: EventHistory;
|
|
502
473
|
bidiEventSubs: Record<string, string[]>;
|
|
503
|
-
/**
|
|
504
|
-
* @deprecated Drivers no longer need to opt into BiDi support explicitly
|
|
505
|
-
*/
|
|
506
|
-
doesSupportBidi?: boolean;
|
|
507
474
|
updateBidiCommands(cmds: BidiModuleMap): void;
|
|
508
475
|
onUnexpectedShutdown(handler: () => any): void;
|
|
509
476
|
/**
|
|
@@ -581,6 +548,17 @@ export interface Driver<C extends Constraints = Constraints, CArgs extends Strin
|
|
|
581
548
|
* @returns The result of running the command
|
|
582
549
|
*/
|
|
583
550
|
executeCommand(cmd: string, ...args: any[]): Promise<any>;
|
|
551
|
+
/**
|
|
552
|
+
* A helper method to modify the command name before it's logged.
|
|
553
|
+
*
|
|
554
|
+
* Useful for resolving generic commands like 'execute' to a more specific
|
|
555
|
+
* name based on arguments (e.g., identifying custom extensions).
|
|
556
|
+
*
|
|
557
|
+
* @param cmd - The original command name
|
|
558
|
+
* @param args - Arguments passed to the command
|
|
559
|
+
* @returns A potentially updated command name
|
|
560
|
+
*/
|
|
561
|
+
clarifyCommandName?(cmd: string, args: string[]): string;
|
|
584
562
|
/** Execute a driver (WebDriver Bidi protocol) command by its name as defined in the bidi commands file
|
|
585
563
|
* @param bidiCmd - the name of the command in the bidi spec
|
|
586
564
|
* @param args - arguments to pass to the command
|
|
@@ -598,13 +576,6 @@ export interface Driver<C extends Constraints = Constraints, CArgs extends Strin
|
|
|
598
576
|
* session
|
|
599
577
|
*/
|
|
600
578
|
startNewCommandTimeout(): Promise<void>;
|
|
601
|
-
/**
|
|
602
|
-
* Reset the current session (run the delete session and create session subroutines)
|
|
603
|
-
*
|
|
604
|
-
* @deprecated Use explicit session management commands instead
|
|
605
|
-
* @privateRemarks This is implemented by `BaseDriver` and is used within `@appium/driver-test-support`
|
|
606
|
-
*/
|
|
607
|
-
reset(): Promise<void>;
|
|
608
579
|
/**
|
|
609
580
|
* The processed capabilities used to start the session represented by the current driver instance
|
|
610
581
|
*/
|
|
@@ -1028,144 +999,6 @@ export interface ExternalDriver<C extends Constraints = Constraints, Ctx = strin
|
|
|
1028
999
|
* @returns The formatted time
|
|
1029
1000
|
*/
|
|
1030
1001
|
getDeviceTime?(format?: string): Promise<string>;
|
|
1031
|
-
/**
|
|
1032
|
-
* List the performance data types supported by this driver, which can be used in a call to get
|
|
1033
|
-
* the performance data by type.
|
|
1034
|
-
*
|
|
1035
|
-
* @returns The list of types
|
|
1036
|
-
*
|
|
1037
|
-
* @deprecated
|
|
1038
|
-
*/
|
|
1039
|
-
getPerformanceDataTypes?(): Promise<string[]>;
|
|
1040
|
-
/**
|
|
1041
|
-
* Get the list of performance data associated with a given type
|
|
1042
|
-
*
|
|
1043
|
-
* @param packageName - the package name / id of the app to retrieve data for
|
|
1044
|
-
* @param dataType - the performance data type; one of those retrieved in a call to
|
|
1045
|
-
* getPerformanceDataTypes
|
|
1046
|
-
* @param dataReadTimeout - how long to wait for data before timing out
|
|
1047
|
-
*
|
|
1048
|
-
* @returns A list of performance data strings
|
|
1049
|
-
*
|
|
1050
|
-
* @deprecated
|
|
1051
|
-
*/
|
|
1052
|
-
getPerformanceData?(packageName: string, dataType: string, dataReadTimeout?: number): Promise<any>;
|
|
1053
|
-
/**
|
|
1054
|
-
* Press a device hardware key by its code for the default duration
|
|
1055
|
-
*
|
|
1056
|
-
* @param keycode - the keycode
|
|
1057
|
-
* @param metastate - the code denoting the simultaneous pressing of any meta keys (shift etc)
|
|
1058
|
-
* @param flags - the code denoting the combination of extra flags
|
|
1059
|
-
*
|
|
1060
|
-
* @deprecated
|
|
1061
|
-
*/
|
|
1062
|
-
pressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
|
|
1063
|
-
/**
|
|
1064
|
-
* Press a device hardware key by its code for a longer duration
|
|
1065
|
-
*
|
|
1066
|
-
* @param keycode - the keycode
|
|
1067
|
-
* @param metastate - the code denoting the simultaneous pressing of any meta keys (shift etc)
|
|
1068
|
-
* @param flags - the code denoting the combination of extra flags
|
|
1069
|
-
*
|
|
1070
|
-
* @deprecated
|
|
1071
|
-
*
|
|
1072
|
-
*/
|
|
1073
|
-
longPressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
|
|
1074
|
-
/**
|
|
1075
|
-
* Apply a synthetic fingerprint to the fingerprint detector of the device
|
|
1076
|
-
*
|
|
1077
|
-
* @param fingerprintId - the numeric ID of the fingerprint to use
|
|
1078
|
-
*
|
|
1079
|
-
* @deprecated
|
|
1080
|
-
*/
|
|
1081
|
-
fingerprint?(fingerprintId: number): Promise<void>;
|
|
1082
|
-
/**
|
|
1083
|
-
* Simulate sending an SMS message from a certain phone number to the device
|
|
1084
|
-
*
|
|
1085
|
-
* @param phoneNumber - the number to pretend the message is from
|
|
1086
|
-
* @param message - the SMS text
|
|
1087
|
-
*
|
|
1088
|
-
* @deprecated
|
|
1089
|
-
*/
|
|
1090
|
-
sendSMS?(phoneNumber: string, message: string): Promise<void>;
|
|
1091
|
-
/**
|
|
1092
|
-
* Simulate triggering a phone call from a phone number and having the device take an action in
|
|
1093
|
-
* response
|
|
1094
|
-
*
|
|
1095
|
-
* @param phoneNumber - the number to pretend the call is from
|
|
1096
|
-
* @param action - the action to take in response (accept, reject, etc...)
|
|
1097
|
-
*
|
|
1098
|
-
* @deprecated
|
|
1099
|
-
*/
|
|
1100
|
-
gsmCall?(phoneNumber: string, action: string): Promise<void>;
|
|
1101
|
-
/**
|
|
1102
|
-
* Simulate setting the GSM signal strength for a cell phone
|
|
1103
|
-
*
|
|
1104
|
-
* @param singalStrength - the strength in a driver-appropriate string
|
|
1105
|
-
*
|
|
1106
|
-
* @deprecated
|
|
1107
|
-
*/
|
|
1108
|
-
gsmSignal?(signalStrength: string | number): Promise<void>;
|
|
1109
|
-
/**
|
|
1110
|
-
* Do something with GSM voice (unclear; this should not be implemented anywhere)
|
|
1111
|
-
*
|
|
1112
|
-
* @param state - the state
|
|
1113
|
-
*
|
|
1114
|
-
* @deprecated
|
|
1115
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1116
|
-
*/
|
|
1117
|
-
gsmVoice?(state: string): Promise<void>;
|
|
1118
|
-
/**
|
|
1119
|
-
* Set the simulated power capacity of the device
|
|
1120
|
-
*
|
|
1121
|
-
* @param percent - how full the battery should become
|
|
1122
|
-
*
|
|
1123
|
-
* @deprecated
|
|
1124
|
-
*/
|
|
1125
|
-
powerCapacity?(percent: number): Promise<void>;
|
|
1126
|
-
/**
|
|
1127
|
-
* Set the AC-connected power state of the device
|
|
1128
|
-
*
|
|
1129
|
-
* @param state - whether the device is connected to power or not
|
|
1130
|
-
*
|
|
1131
|
-
* @deprecated
|
|
1132
|
-
*/
|
|
1133
|
-
powerAC?(state: string): Promise<void>;
|
|
1134
|
-
/**
|
|
1135
|
-
* Set the network speed of the device
|
|
1136
|
-
*
|
|
1137
|
-
* @param netspeed - the speed as a string, like '3G'
|
|
1138
|
-
*
|
|
1139
|
-
* @deprecated
|
|
1140
|
-
*/
|
|
1141
|
-
networkSpeed?(netspeed: string): Promise<void>;
|
|
1142
|
-
/**
|
|
1143
|
-
* Simulate a keyevent on the device
|
|
1144
|
-
*
|
|
1145
|
-
* @param keycode - the manufacturer defined keycode
|
|
1146
|
-
* @param metastate - the combination of meta startUnexpectedShutdown
|
|
1147
|
-
*
|
|
1148
|
-
* @deprecated
|
|
1149
|
-
*/
|
|
1150
|
-
keyevent?(keycode: string | number, metastate?: string | number): Promise<void>;
|
|
1151
|
-
/**
|
|
1152
|
-
* Get the current activity name
|
|
1153
|
-
*
|
|
1154
|
-
* @returns The activity name
|
|
1155
|
-
*
|
|
1156
|
-
* @deprecated
|
|
1157
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1158
|
-
*/
|
|
1159
|
-
getCurrentActivity?(): Promise<string>;
|
|
1160
|
-
/**
|
|
1161
|
-
* Get the current active app package name/id
|
|
1162
|
-
*
|
|
1163
|
-
* @returns The package name
|
|
1164
|
-
*
|
|
1165
|
-
* @deprecated
|
|
1166
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1167
|
-
*/
|
|
1168
|
-
getCurrentPackage?(): Promise<string>;
|
|
1169
1002
|
/**
|
|
1170
1003
|
* Install an app on a device
|
|
1171
1004
|
*
|
|
@@ -1252,148 +1085,6 @@ export interface ExternalDriver<C extends Constraints = Constraints, Ctx = strin
|
|
|
1252
1085
|
* @returns The base64-encoded zip file of the directory contents
|
|
1253
1086
|
*/
|
|
1254
1087
|
pullFolder?(path: string): Promise<string>;
|
|
1255
|
-
/**
|
|
1256
|
-
* Toggle airplane/flight mode for the device
|
|
1257
|
-
*
|
|
1258
|
-
* @deprecated
|
|
1259
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1260
|
-
*/
|
|
1261
|
-
toggleFlightMode?(): Promise<void>;
|
|
1262
|
-
/**
|
|
1263
|
-
* Toggle cell network data
|
|
1264
|
-
*
|
|
1265
|
-
* @deprecated
|
|
1266
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1267
|
-
*/
|
|
1268
|
-
toggleData?(): Promise<void>;
|
|
1269
|
-
/**
|
|
1270
|
-
* Toggle WiFi radio status
|
|
1271
|
-
*
|
|
1272
|
-
* @deprecated
|
|
1273
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1274
|
-
*/
|
|
1275
|
-
toggleWiFi?(): Promise<void>;
|
|
1276
|
-
/**
|
|
1277
|
-
* Toggle location services for the device
|
|
1278
|
-
*
|
|
1279
|
-
* @deprecated
|
|
1280
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1281
|
-
*/
|
|
1282
|
-
toggleLocationServices?(): Promise<void>;
|
|
1283
|
-
/**
|
|
1284
|
-
* Open the notifications shade/screen
|
|
1285
|
-
*
|
|
1286
|
-
* @deprecated
|
|
1287
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1288
|
-
*/
|
|
1289
|
-
openNotifications?(): Promise<void>;
|
|
1290
|
-
/**
|
|
1291
|
-
* Start an Android activity within an app
|
|
1292
|
-
*
|
|
1293
|
-
* @param appPackage - the app package id
|
|
1294
|
-
* @param appActivity - the activity name
|
|
1295
|
-
* @param appWaitPackage - the package id to wait for if different from the app package
|
|
1296
|
-
* @param appWaitActivity - the activity name to wait for being active if different from
|
|
1297
|
-
* appActivity
|
|
1298
|
-
* @param intentAction - the action for the intent to use to start the activity
|
|
1299
|
-
* @param intentCategory - the category for the intent
|
|
1300
|
-
* @param flags - the flags for the intent
|
|
1301
|
-
* @param optionalIntentArguments - additional arguments to be passed to launching the intent
|
|
1302
|
-
* @param dontStopAppOnReset - set to true to not stop the current app before launching the
|
|
1303
|
-
* activity
|
|
1304
|
-
*
|
|
1305
|
-
* @deprecated
|
|
1306
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1307
|
-
*/
|
|
1308
|
-
startActivity?(appPackage: string, appActivity: string, appWaitPackage?: string, appWaitActivity?: string, intentAction?: string, intentCategory?: string, intentFlags?: string, optionalIntentArguments?: string, dontStopAppOnReset?: boolean): Promise<void>;
|
|
1309
|
-
/**
|
|
1310
|
-
* Get information from the system bars of a device
|
|
1311
|
-
*
|
|
1312
|
-
* @returns An array of information objects of driver-specific shape
|
|
1313
|
-
*
|
|
1314
|
-
* @deprecated
|
|
1315
|
-
*/
|
|
1316
|
-
getSystemBars?(): Promise<unknown>;
|
|
1317
|
-
/**
|
|
1318
|
-
* Get the display's pixel density
|
|
1319
|
-
*
|
|
1320
|
-
* @returns The density
|
|
1321
|
-
*
|
|
1322
|
-
* @deprecated
|
|
1323
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1324
|
-
*/
|
|
1325
|
-
getDisplayDensity?(): Promise<number>;
|
|
1326
|
-
/**
|
|
1327
|
-
* End platform-specific code coverage tracing
|
|
1328
|
-
*
|
|
1329
|
-
* @param intent - the Android intent for the coverage activity
|
|
1330
|
-
* @param path - the path to place the results
|
|
1331
|
-
*
|
|
1332
|
-
* @deprecated
|
|
1333
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1334
|
-
*/
|
|
1335
|
-
endCoverage?(intent: string, path: string): Promise<void>;
|
|
1336
|
-
/**
|
|
1337
|
-
* Set the value of a text field but ensure the current value is replace and not appended
|
|
1338
|
-
*
|
|
1339
|
-
* @param value - the text to set
|
|
1340
|
-
* @param elementId - the element to set it in
|
|
1341
|
-
*
|
|
1342
|
-
* @deprecated
|
|
1343
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1344
|
-
*/
|
|
1345
|
-
replaceValue?(value: string, elementId: string): Promise<void>;
|
|
1346
|
-
/**
|
|
1347
|
-
* Check whether two elements are identical
|
|
1348
|
-
*
|
|
1349
|
-
* @param elementId - the first element's ID
|
|
1350
|
-
* @param otherElementId - the second element's ID
|
|
1351
|
-
*
|
|
1352
|
-
* @returns True if the elements are equal, false otherwise
|
|
1353
|
-
*
|
|
1354
|
-
* @deprecated
|
|
1355
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1356
|
-
*/
|
|
1357
|
-
equalsElement?(elementId: string, otherElementId: string): Promise<boolean>;
|
|
1358
|
-
/**
|
|
1359
|
-
* Get the list of IME engines
|
|
1360
|
-
*
|
|
1361
|
-
* @returns The list of IME engines
|
|
1362
|
-
*
|
|
1363
|
-
* @deprecated
|
|
1364
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1365
|
-
*/
|
|
1366
|
-
availableIMEEngines?(): Promise<string[]>;
|
|
1367
|
-
/**
|
|
1368
|
-
* Get the active IME engine
|
|
1369
|
-
*
|
|
1370
|
-
* @returns The name of the active engine
|
|
1371
|
-
*
|
|
1372
|
-
* @deprecated
|
|
1373
|
-
*/
|
|
1374
|
-
getActiveIMEEngine?(): Promise<string>;
|
|
1375
|
-
/**
|
|
1376
|
-
* Determine whether an IME is active
|
|
1377
|
-
*
|
|
1378
|
-
* @returns True if the IME is activated
|
|
1379
|
-
*
|
|
1380
|
-
* @deprecated
|
|
1381
|
-
*/
|
|
1382
|
-
isIMEActivated?(): Promise<boolean>;
|
|
1383
|
-
/**
|
|
1384
|
-
* Deactivate an IME engine
|
|
1385
|
-
*
|
|
1386
|
-
* @deprecated
|
|
1387
|
-
*/
|
|
1388
|
-
deactivateIMEEngine?(): Promise<void>;
|
|
1389
|
-
/**
|
|
1390
|
-
* Activate an IME engine
|
|
1391
|
-
*
|
|
1392
|
-
* @param engine - the name of the engine
|
|
1393
|
-
*
|
|
1394
|
-
* @deprecated
|
|
1395
|
-
*/
|
|
1396
|
-
activateIMEEngine?(engine: string): Promise<void>;
|
|
1397
1088
|
/**
|
|
1398
1089
|
* Get the device orientation
|
|
1399
1090
|
*
|
|
@@ -1406,89 +1097,6 @@ export interface ExternalDriver<C extends Constraints = Constraints, Ctx = strin
|
|
|
1406
1097
|
* @param orientation - the orientation string
|
|
1407
1098
|
*/
|
|
1408
1099
|
setOrientation?(orientation: string): Promise<void>;
|
|
1409
|
-
/**
|
|
1410
|
-
* Trigger a mouse button down
|
|
1411
|
-
*
|
|
1412
|
-
* @param button - the button ID
|
|
1413
|
-
*
|
|
1414
|
-
* @deprecated Use the Actions API instead
|
|
1415
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1416
|
-
*/
|
|
1417
|
-
buttonDown?(button?: number): Promise<void>;
|
|
1418
|
-
/**
|
|
1419
|
-
* Trigger a mouse button up
|
|
1420
|
-
*
|
|
1421
|
-
* @param button - the button ID
|
|
1422
|
-
*
|
|
1423
|
-
* @deprecated Use the Actions API instead
|
|
1424
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1425
|
-
*/
|
|
1426
|
-
buttonUp?(button?: number): Promise<void>;
|
|
1427
|
-
/**
|
|
1428
|
-
* Click the current mouse location
|
|
1429
|
-
*
|
|
1430
|
-
* @param button - the button ID
|
|
1431
|
-
*
|
|
1432
|
-
* @deprecated Use the Actions API instead
|
|
1433
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1434
|
-
*/
|
|
1435
|
-
clickCurrent?(button?: number): Promise<void>;
|
|
1436
|
-
/**
|
|
1437
|
-
* Double-click the current mouse location
|
|
1438
|
-
*
|
|
1439
|
-
* @deprecated Use the Actions API instead
|
|
1440
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1441
|
-
*/
|
|
1442
|
-
doubleClick?(): Promise<void>;
|
|
1443
|
-
/**
|
|
1444
|
-
* Perform a touch down event at the location specified
|
|
1445
|
-
*
|
|
1446
|
-
* @param x - the x coordinate
|
|
1447
|
-
* @param y - the y coordinate
|
|
1448
|
-
*
|
|
1449
|
-
* @deprecated Use the Actions API instead
|
|
1450
|
-
*/
|
|
1451
|
-
touchDown?(element: string, x: number, y: number): Promise<void>;
|
|
1452
|
-
/**
|
|
1453
|
-
* Perform a touch up event at the location specified
|
|
1454
|
-
*
|
|
1455
|
-
* @param x - the x coordinate
|
|
1456
|
-
* @param y - the y coordinate
|
|
1457
|
-
*
|
|
1458
|
-
* @deprecated Use the Actions API instead
|
|
1459
|
-
*/
|
|
1460
|
-
touchUp?(element: string, x: number, y: number): Promise<void>;
|
|
1461
|
-
/**
|
|
1462
|
-
* Perform a touch move event at the location specified
|
|
1463
|
-
*
|
|
1464
|
-
* @param x - the x coordinate
|
|
1465
|
-
* @param y - the y coordinate
|
|
1466
|
-
*
|
|
1467
|
-
* @deprecated Use the Actions API instead
|
|
1468
|
-
*/
|
|
1469
|
-
touchMove?(element: string, x: number, y: number): Promise<void>;
|
|
1470
|
-
/**
|
|
1471
|
-
* Perform a long touch down event at the location specified
|
|
1472
|
-
*
|
|
1473
|
-
* @param elementId - the id of the element to long touch
|
|
1474
|
-
*
|
|
1475
|
-
* @deprecated Use the Actions API instead
|
|
1476
|
-
*/
|
|
1477
|
-
touchLongClick?(element: string, x: number, y: number, duration: number): Promise<void>;
|
|
1478
|
-
/**
|
|
1479
|
-
* Perform a flick event at the location specified
|
|
1480
|
-
*
|
|
1481
|
-
* @param element - the element to make coordinates relative to
|
|
1482
|
-
* @param xSpeed - the horizontal flick speed (in driver-specific units)
|
|
1483
|
-
* @param ySpeed - the vertical flick speed (in driver-specific units)
|
|
1484
|
-
* @param xOffset - the x coordinate
|
|
1485
|
-
* @param yOffset - the y coordinate
|
|
1486
|
-
* @param speed - the speed (unclear how this relates to xSpeed and ySpeed)
|
|
1487
|
-
*
|
|
1488
|
-
* @deprecated Use the Actions API instead
|
|
1489
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1490
|
-
*/
|
|
1491
|
-
flick?(element?: string, xSpeed?: number, ySpeed?: number, xOffset?: number, yOffset?: number, speed?: number): Promise<void>;
|
|
1492
1100
|
/**
|
|
1493
1101
|
* Get the virtual or real geographical location of a device
|
|
1494
1102
|
*
|
|
@@ -1523,17 +1131,6 @@ export interface ExternalDriver<C extends Constraints = Constraints, Ctx = strin
|
|
|
1523
1131
|
* @returns The list of context names
|
|
1524
1132
|
*/
|
|
1525
1133
|
getContexts?(): Promise<Ctx[]>;
|
|
1526
|
-
/**
|
|
1527
|
-
* Get the index of an element on the page
|
|
1528
|
-
*
|
|
1529
|
-
* @param elementId - the element id
|
|
1530
|
-
*
|
|
1531
|
-
* @returns The page index
|
|
1532
|
-
*
|
|
1533
|
-
* @deprecated
|
|
1534
|
-
* @privateRemarks Not implemented in `appium-xcuitest-driver`
|
|
1535
|
-
*/
|
|
1536
|
-
getPageIndex?(elementId: string): Promise<string>;
|
|
1537
1134
|
/**
|
|
1538
1135
|
* Get the network connection state of a device
|
|
1539
1136
|
* @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes}
|