@wdio/types 8.23.0 → 8.24.0

package/build/Services.d.ts

@@ -4,7 +4,7 @@ import type { DesiredCapabilities, RemoteCapability, RemoteCapabilities } from '
 import type { Testrunner as TestrunnerOptions, WebdriverIO as WebdriverIOOptions } from './Options.js';
 import type { Suite, Test, TestResult } from './Frameworks.js';
 export interface RunnerInstance {
-    initialise(): Promise<void>;
+    initialize(): Promise<void>;
     shutdown(): Promise<boolean>;
     closeSession?: (cid: number) => Promise<void>;
     getWorkerCount(): number;
@@ -34,6 +34,33 @@ export interface ServiceInstance extends HookFunctions {
     capabilities?: RemoteCapability;
     config?: TestrunnerOptions;
 }
+interface AssertionHookParams {
+    /**
+     * name of the matcher, e.g. `toHaveText` or `toBeClickable`
+     */
+    matcherName: string;
+    /**
+     * Value that the user has passed in
+     *
+     * @example
+     * ```
+     * expect(el).toBeClickable() // expectedValue is undefined
+     * expect(el).toHaveText('foo') // expectedValue is `'foo'`
+     * expect(el).toHaveAttribute('attr', 'value', { ... }) // expectedValue is `['attr', 'value]`
+     * ```
+     */
+    expectedValue?: any;
+    /**
+     * Options that the user has passed in, e.g. `expect(el).toHaveText('foo', { ignoreCase: true })` -> `{ ignoreCase: true }`
+     */
+    options: object;
+}
+interface AfterAssertionHookParams extends AssertionHookParams {
+    result: {
+        message: () => string;
+        result: boolean;
+    };
+}
 export type ServiceEntry = (
 /**
  * e.g. `services: ['@wdio/sauce-service']`
@@ -89,12 +116,12 @@ export interface HookFunctions {
      */
     onComplete?(exitCode: number, config: Omit<TestrunnerOptions, 'capabilities'>, capabilities: RemoteCapabilities, results: any): unknown | Promise<unknown>;
     /**
-     * Gets executed before a worker process is spawned and can be used to initialise specific service
+     * Gets executed before a worker process is spawned and can be used to initialize specific service
      * for that worker as well as modify runtime environments in an async fashion.
      * @param cid       capability id (e.g 0-0)
      * @param caps      object containing capabilities for session that will be spawn in the worker
      * @param specs     specs to be run in the worker process
-     * @param args      object that will be merged with the main configuration once worker is initialised
+     * @param args      object that will be merged with the main configuration once worker is initialized
      * @param execArgv  list of string arguments passed to the worker process
      */
     onWorkerStart?(cid: string, caps: DesiredCapabilities, specs: string[], args: TestrunnerOptions, execArgv: string[]): unknown | Promise<unknown>;
@@ -202,5 +229,20 @@ export interface HookFunctions {
      * @param error        error in case something went wrong
      */
     afterCommand?(commandName: string, args: any[], result: any, error?: Error): unknown | Promise<unknown>;
+    /**
+     * Runs before a WebdriverIO assertion library makes an assertion.
+     * @param commandName command name
+     * @param args        arguments that command would receive
+     */
+    beforeAssertion?(params: AssertionHookParams): unknown | Promise<unknown>;
+    /**
+     * Runs after a WebdriverIO command gets executed
+     * @param commandName  command name
+     * @param args         arguments that command would receive
+     * @param result       result of the command
+     * @param error        error in case something went wrong
+     */
+    afterAssertion?(params: AfterAssertionHookParams): unknown | Promise<unknown>;
 }
+export {};
 //# sourceMappingURL=Services.d.ts.map

package/build/Services.d.ts.map

@@ -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;CAChC"}
+{"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

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/types",
-  "version": "8.23.0",
+  "version": "8.24.0",
   "description": "Utility package providing type information for a variety of WebdriverIO interfaces",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-types",
@@ -32,5 +32,5 @@
   "dependencies": {
     "@types/node": "^20.1.0"
   },
-  "gitHead": "b17ce5f554deb8588cc156ad9676bd4bd13defe7"
+  "gitHead": "5fe7908a837461102ada6edf71c160f2c66dd88f"
 }