@wdio/types 8.23.1 → 8.24.0
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/Services.d.ts +42 -0
- package/build/Services.d.ts.map +1 -1
- package/package.json +2 -2
package/build/Services.d.ts
CHANGED
|
@@ -34,6 +34,33 @@ export interface ServiceInstance extends HookFunctions {
|
|
|
34
34
|
capabilities?: RemoteCapability;
|
|
35
35
|
config?: TestrunnerOptions;
|
|
36
36
|
}
|
|
37
|
+
interface AssertionHookParams {
|
|
38
|
+
/**
|
|
39
|
+
* name of the matcher, e.g. `toHaveText` or `toBeClickable`
|
|
40
|
+
*/
|
|
41
|
+
matcherName: string;
|
|
42
|
+
/**
|
|
43
|
+
* Value that the user has passed in
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```
|
|
47
|
+
* expect(el).toBeClickable() // expectedValue is undefined
|
|
48
|
+
* expect(el).toHaveText('foo') // expectedValue is `'foo'`
|
|
49
|
+
* expect(el).toHaveAttribute('attr', 'value', { ... }) // expectedValue is `['attr', 'value]`
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
expectedValue?: any;
|
|
53
|
+
/**
|
|
54
|
+
* Options that the user has passed in, e.g. `expect(el).toHaveText('foo', { ignoreCase: true })` -> `{ ignoreCase: true }`
|
|
55
|
+
*/
|
|
56
|
+
options: object;
|
|
57
|
+
}
|
|
58
|
+
interface AfterAssertionHookParams extends AssertionHookParams {
|
|
59
|
+
result: {
|
|
60
|
+
message: () => string;
|
|
61
|
+
result: boolean;
|
|
62
|
+
};
|
|
63
|
+
}
|
|
37
64
|
export type ServiceEntry = (
|
|
38
65
|
/**
|
|
39
66
|
* e.g. `services: ['@wdio/sauce-service']`
|
|
@@ -202,5 +229,20 @@ export interface HookFunctions {
|
|
|
202
229
|
* @param error error in case something went wrong
|
|
203
230
|
*/
|
|
204
231
|
afterCommand?(commandName: string, args: any[], result: any, error?: Error): unknown | Promise<unknown>;
|
|
232
|
+
/**
|
|
233
|
+
* Runs before a WebdriverIO assertion library makes an assertion.
|
|
234
|
+
* @param commandName command name
|
|
235
|
+
* @param args arguments that command would receive
|
|
236
|
+
*/
|
|
237
|
+
beforeAssertion?(params: AssertionHookParams): unknown | Promise<unknown>;
|
|
238
|
+
/**
|
|
239
|
+
* Runs after a WebdriverIO command gets executed
|
|
240
|
+
* @param commandName command name
|
|
241
|
+
* @param args arguments that command would receive
|
|
242
|
+
* @param result result of the command
|
|
243
|
+
* @param error error in case something went wrong
|
|
244
|
+
*/
|
|
245
|
+
afterAssertion?(params: AfterAssertionHookParams): unknown | Promise<unknown>;
|
|
205
246
|
}
|
|
247
|
+
export {};
|
|
206
248
|
//# sourceMappingURL=Services.d.ts.map
|
package/build/Services.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Services.d.ts","sourceRoot":"","sources":["../src/Services.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAClG,OAAO,KAAK,EAAE,UAAU,IAAI,iBAAiB,EAAE,WAAW,IAAI,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACtG,OAAO,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE9D,MAAM,WAAW,cAAc;IAC3B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3B,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;IAC5B,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7C,cAAc,IAAI,MAAM,CAAA;IACxB,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM,CAAC,YAAY,CAAA;IACnC,UAAU,EAAE,GAAG,CAAA;IACf,WAAW,EAAE,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IACxB,KACI,OAAO,EAAE,WAAW,CAAC,oBAAoB,EACzC,MAAM,EAAE,IAAI,CAAC,kBAAkB,EAAE,cAAc,GAAG,MAAM,KAAK,CAAC,GAC/D,cAAc,CAAA;CACpB;AAED,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC7C,OAAO,EAAE,WAAW,CAAA;IACpB,QAAQ,CAAC,EAAE,WAAW,CAAA;CACzB;AAED,MAAM,WAAW,aAAa;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IACzB,KAAI,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,CAAC,kBAAkB,EAAE,cAAc,CAAC,GAAG,eAAe,CAAA;CACzH;AAED,MAAM,WAAW,aAAc,SAAQ,YAAY;IAC/C,OAAO,EAAE,YAAY,CAAA;IACrB,QAAQ,CAAC,EAAE,YAAY,CAAA;CAC1B;AAED,MAAM,WAAW,eAAgB,SAAQ,aAAa;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAED,MAAM,MAAM,YAAY,GAAG;AACvB;;GAEG;AACH,MAAM;AACN;;GAEG;AACH,aAAa;AACb;;GAEG;AACH,YAAY;AACZ;;;;;;GAMG;AACH;IAAC,MAAM;IAAE,WAAW,CAAC,aAAa;CAAC;AACnC;;;;;;GAMG;AACH;IAAC,YAAY;IAAE,WAAW,CAAC,aAAa;CAAC,CAC5C,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;KACf,CAAC,IAAI,MAAM,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE;CACjF,CAAA;AAED,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,SAAS,CAAC,CACN,MAAM,EAAE,iBAAiB,EACzB,YAAY,EAAE,kBAAkB,GACjC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;;OAOG;IACH,UAAU,CAAC,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,EAC/C,YAAY,EAAE,kBAAkB,EAChC,OAAO,EAAE,GAAG,GACb,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;;;OAQG;IACH,aAAa,CAAC,CACV,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,mBAAmB,EACzB,KAAK,EAAE,MAAM,EAAE,EACf,IAAI,EAAE,iBAAiB,EACvB,QAAQ,EAAE,MAAM,EAAE,GACnB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;OAMG;IACH,WAAW,CAAC,CACR,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,EAAE,MAAM,GAChB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;OAMG;IACH,MAAM,CAAC,CACH,YAAY,EAAE,gBAAgB,EAC9B,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,EAAE,GAAG,GACb,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;OAMG;IACH,KAAK,CAAC,CACF,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,gBAAgB,EAC9B,KAAK,EAAE,MAAM,EAAE,GAChB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;;OAOG;IACH,aAAa,CAAC,CACV,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,EAC/C,YAAY,EAAE,gBAAgB,EAC9B,KAAK,EAAE,MAAM,EAAE,EACf,GAAG,EAAE,MAAM,GACZ,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;OAKG;IACH,YAAY,CAAC,CACT,MAAM,EAAE,iBAAiB,EACzB,YAAY,EAAE,gBAAgB,EAC9B,KAAK,EAAE,MAAM,EAAE,GAChB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,CACL,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,GACrB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;OAGG;IACH,WAAW,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEtD;;;OAGG;IACH,UAAU,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAErD;;;;OAIG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEjE;;;;;;;;;OASG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEpF;;;;;;MAME;IACF,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAElF;;;;;;;MAOE;IACF,SAAS,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEtG;;;;OAIG;IACH,aAAa,CAAC,CACV,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,GAAG,EAAE,GACZ,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;OAMG;IACH,YAAY,CAAC,CACT,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,GAAG,EAAE,EACX,MAAM,EAAE,GAAG,EACX,KAAK,CAAC,EAAE,KAAK,GACd,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;
|
|
1
|
+
{"version":3,"file":"Services.d.ts","sourceRoot":"","sources":["../src/Services.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAClG,OAAO,KAAK,EAAE,UAAU,IAAI,iBAAiB,EAAE,WAAW,IAAI,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACtG,OAAO,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE9D,MAAM,WAAW,cAAc;IAC3B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3B,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;IAC5B,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7C,cAAc,IAAI,MAAM,CAAA;IACxB,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM,CAAC,YAAY,CAAA;IACnC,UAAU,EAAE,GAAG,CAAA;IACf,WAAW,EAAE,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IACxB,KACI,OAAO,EAAE,WAAW,CAAC,oBAAoB,EACzC,MAAM,EAAE,IAAI,CAAC,kBAAkB,EAAE,cAAc,GAAG,MAAM,KAAK,CAAC,GAC/D,cAAc,CAAA;CACpB;AAED,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC7C,OAAO,EAAE,WAAW,CAAA;IACpB,QAAQ,CAAC,EAAE,WAAW,CAAA;CACzB;AAED,MAAM,WAAW,aAAa;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IACzB,KAAI,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,CAAC,kBAAkB,EAAE,cAAc,CAAC,GAAG,eAAe,CAAA;CACzH;AAED,MAAM,WAAW,aAAc,SAAQ,YAAY;IAC/C,OAAO,EAAE,YAAY,CAAA;IACrB,QAAQ,CAAC,EAAE,YAAY,CAAA;CAC1B;AAED,MAAM,WAAW,eAAgB,SAAQ,aAAa;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC7B;AAED,UAAU,mBAAmB;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,GAAG,CAAA;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAClB;AACD,UAAU,wBAAyB,SAAQ,mBAAmB;IAC1D,MAAM,EAAE;QACJ,OAAO,EAAE,MAAM,MAAM,CAAA;QACrB,MAAM,EAAE,OAAO,CAAA;KAClB,CAAA;CACJ;AAED,MAAM,MAAM,YAAY,GAAG;AACvB;;GAEG;AACH,MAAM;AACN;;GAEG;AACH,aAAa;AACb;;GAEG;AACH,YAAY;AACZ;;;;;;GAMG;AACH;IAAC,MAAM;IAAE,WAAW,CAAC,aAAa;CAAC;AACnC;;;;;;GAMG;AACH;IAAC,YAAY;IAAE,WAAW,CAAC,aAAa;CAAC,CAC5C,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;KACf,CAAC,IAAI,MAAM,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE;CACjF,CAAA;AAED,MAAM,WAAW,aAAa;IAC1B;;;;OAIG;IACH,SAAS,CAAC,CACN,MAAM,EAAE,iBAAiB,EACzB,YAAY,EAAE,kBAAkB,GACjC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;;OAOG;IACH,UAAU,CAAC,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,EAC/C,YAAY,EAAE,kBAAkB,EAChC,OAAO,EAAE,GAAG,GACb,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;;;OAQG;IACH,aAAa,CAAC,CACV,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,mBAAmB,EACzB,KAAK,EAAE,MAAM,EAAE,EACf,IAAI,EAAE,iBAAiB,EACvB,QAAQ,EAAE,MAAM,EAAE,GACnB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;OAMG;IACH,WAAW,CAAC,CACR,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,EAAE,MAAM,GAChB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;OAMG;IACH,MAAM,CAAC,CACH,YAAY,EAAE,gBAAgB,EAC9B,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,EAAE,GAAG,GACb,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;OAMG;IACH,KAAK,CAAC,CACF,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,gBAAgB,EAC9B,KAAK,EAAE,MAAM,EAAE,GAChB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;;OAOG;IACH,aAAa,CAAC,CACV,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,EAC/C,YAAY,EAAE,gBAAgB,EAC9B,KAAK,EAAE,MAAM,EAAE,EACf,GAAG,EAAE,MAAM,GACZ,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;OAKG;IACH,YAAY,CAAC,CACT,MAAM,EAAE,iBAAiB,EACzB,YAAY,EAAE,gBAAgB,EAC9B,KAAK,EAAE,MAAM,EAAE,GAChB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,CACL,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,GACrB,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;OAGG;IACH,WAAW,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEtD;;;OAGG;IACH,UAAU,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAErD;;;;OAIG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEjE;;;;;;;;;OASG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEpF;;;;;;MAME;IACF,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAElF;;;;;;;MAOE;IACF,SAAS,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEtG;;;;OAIG;IACH,aAAa,CAAC,CACV,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,GAAG,EAAE,GACZ,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;;;OAMG;IACH,YAAY,CAAC,CACT,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,GAAG,EAAE,EACX,MAAM,EAAE,GAAG,EACX,KAAK,CAAC,EAAE,KAAK,GACd,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE7B;;;;OAIG;IACH,eAAe,CAAC,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEzE;;;;;;OAMG;IACH,cAAc,CAAC,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAChF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wdio/types",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.24.0",
|
|
4
4
|
"description": "Utility package providing type information for a variety of WebdriverIO interfaces",
|
|
5
5
|
"author": "Christian Bromann <mail@bromann.dev>",
|
|
6
6
|
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-types",
|
|
@@ -32,5 +32,5 @@
|
|
|
32
32
|
"dependencies": {
|
|
33
33
|
"@types/node": "^20.1.0"
|
|
34
34
|
},
|
|
35
|
-
"gitHead": "
|
|
35
|
+
"gitHead": "5fe7908a837461102ada6edf71c160f2c66dd88f"
|
|
36
36
|
}
|