webdriverio 8.22.1 → 8.23.0

package/README.md

@@ -3,7 +3,7 @@ WebdriverIO
 
 > Next-gen browser and mobile automation test framework for Node.js
 
-This package provides an easy to manage API and a lot of syntactical sugar on top of the WebDriver specification. You can use WebdriverIO as a standalone package or via a testrunner using [`@wdio/cli`](https://webdriver.io/docs/clioptions). WebdriverIO allows to run tests locally using the WebDriver or Chrome DevTools protocol as well as remote user agents using cloud providers like [Sauce Labs](https://saucelabs.com/).
+This package provides an easy-to-manage API and a lot of syntactical sugar on top of the WebDriver specification. You can use WebdriverIO as a standalone package or via a test runner using [`@wdio/cli`](https://webdriver.io/docs/clioptions). WebdriverIO allows you to run tests locally using the WebDriver or Chrome DevTools protocol as well as remote user agents using cloud providers like [Sauce Labs](https://saucelabs.com/).
 
 ## Installation
 
@@ -44,6 +44,6 @@ let browser
 })
 ```
 
-See the raw [protocol example](https://www.npmjs.com/package/webdriver#example) using the `webdriver` package to get a glance on the differences.
+See the raw [protocol example](https://www.npmjs.com/package/webdriver#example) using the `webdriver` package to get a glance at the differences.
 
 For more information on [options](https://webdriver.io/docs/options#webdriver-options), [multiremote usage](https://webdriver.io/docs/multiremote) or integration into [cloud services](https://webdriver.io/docs/cloudservices) please check out the [docs](https://webdriver.io/docs/gettingstarted).

package/build/commands/browser/$$.d.ts

@@ -1,5 +1,5 @@
 import type { ElementReference } from '@wdio/protocols';
-import type { Selector, ElementArray } from '../../types.js';
+import type { Selector } from '../../types.js';
 /**
  * The `$$` command is a short and handy way in order to fetch multiple elements on the page.
  * It returns a `ChainablePromiseArray` containing a set of WebdriverIO elements.
@@ -40,5 +40,5 @@ import type { Selector, ElementArray } from '../../types.js';
  * @type utility
  *
  */
-export declare function $$(this: WebdriverIO.Browser | WebdriverIO.Element, selector: Selector | ElementReference[] | WebdriverIO.Element[] | HTMLElement[]): Promise<ElementArray>;
+export declare function $$(this: WebdriverIO.Browser | WebdriverIO.Element, selector: Selector | ElementReference[] | WebdriverIO.Element[] | HTMLElement[]): Promise<WebdriverIO.ElementArray>;
 //# sourceMappingURL=$$.d.ts.map

package/build/commands/browser/$$.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"$$.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/$$.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAIvD,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAsB,EAAE,CACpB,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,EAC/C,QAAQ,EAAE,QAAQ,GAAG,gBAAgB,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,GAAG,WAAW,EAAE,yBAkBlF"}
+{"version":3,"file":"$$.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/$$.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAIvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAsB,EAAE,CACpB,IAAI,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,EAC/C,QAAQ,EAAE,QAAQ,GAAG,gBAAgB,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,GAAG,WAAW,EAAE,qCAkBlF"}

package/build/commands/browser/custom$$.d.ts

@@ -1,4 +1,3 @@
-import type { ElementArray } from '../../types.js';
 /**
  *
  * The `customs$$` allows you to use a custom strategy declared by using `browser.addLocatorStrategy`.
@@ -21,7 +20,7 @@ import type { ElementArray } from '../../types.js';
  * @alias custom$$
  * @param {string} strategyName
  * @param {*} strategyArguments
- * @return {ElementArray}
+ * @return {WebdriverIO.ElementArray}
  */
-export declare function custom$$(this: WebdriverIO.Browser, strategyName: string, ...strategyArguments: any[]): Promise<ElementArray>;
+export declare function custom$$(this: WebdriverIO.Browser, strategyName: string, ...strategyArguments: any[]): Promise<WebdriverIO.ElementArray>;
 //# sourceMappingURL=custom$$.d.ts.map

package/build/commands/browser/custom$$.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"custom$$.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/custom$$.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAmD,MAAM,gBAAgB,CAAA;AAEnG;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,QAAQ,CAC1B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,YAAY,EAAE,MAAM,EACpB,GAAG,iBAAiB,EAAE,GAAG,EAAE,GAC5B,OAAO,CAAC,YAAY,CAAC,CAuBvB"}
+{"version":3,"file":"custom$$.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/custom$$.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,QAAQ,CAC1B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,YAAY,EAAE,MAAM,EACpB,GAAG,iBAAiB,EAAE,GAAG,EAAE,GAC5B,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAuBnC"}

package/build/commands/browser/custom$$.js

@@ -23,7 +23,7 @@ import { ELEMENT_KEY } from '../../constants.js';
  * @alias custom$$
  * @param {string} strategyName
  * @param {*} strategyArguments
- * @return {ElementArray}
+ * @return {WebdriverIO.ElementArray}
  */
 export async function custom$$(strategyName, ...strategyArguments) {
     const strategy = this.strategies.get(strategyName);

package/build/commands/browser/custom$.js

@@ -45,5 +45,5 @@ export async function custom$(strategyName, ...strategyArguments) {
     if (res && typeof res[ELEMENT_KEY] === 'string') {
         return await getElement.call(this, strategyRef, res);
     }
-    throw Error('Your locator strategy script must return an element');
+    return await getElement.call(this, strategyRef, new Error('no such element'));
 }

package/build/commands/browser/emulate.d.ts

@@ -0,0 +1,59 @@
+type SupportedScopes = 'geolocation' | 'userAgent' | 'colorScheme' | 'onLine';
+interface EmulationOptions {
+    geolocation: Partial<GeolocationCoordinates>;
+    userAgent: string;
+    colorScheme: 'light' | 'dark';
+    onLine: boolean;
+}
+/**
+ * WebdriverIO allows you to emulate Web APIs using the `emulate` command. These Web APIs can then
+ * behave exactly as you specify it.
+ *
+ * Read more on this in the [Emulation](/docs/emulation) guidelines.
+ *
+ * :::info
+ *
+ * This feature requires WebDriver Bidi support for the browser. While recent versions of Chrome, Edge
+ * and Firefox have such support, Safari __does not__. For updates follow [wpt.fyi](https://wpt.fyi/results/webdriver/tests/bidi/script/add_preload_script/add_preload_script.py?label=experimental&label=master&aligned).
+ * Furthermore if you use a cloud vendor for spawning browsers, make sure your vendor also supports WebDriver Bidi.
+ *
+ * :::
+ *
+ * <example>
+    :emulateColorScheme.js
+    it('should open WebdriverIO using light color scheme', async () => {
+        await browser.emulate('colorScheme', 'light')
+        await browser.url('https://webdriver.io')
+        const backgroundColor = await browser.$('nav').getCSSProperty('background-color')
+        console.log(backgroundColor.parsed.hex) // outputs: "#efefef"
+    })
+    it('should open WebdriverIO using dark color scheme'm async () => {
+        await browser.emulate('colorScheme', 'dark')
+        await browser.url('https://webdriver.io')
+        const backgroundColor = await browser.$('nav').getCSSProperty('background-color')
+        console.log(backgroundColor.parsed.hex) // outputs: "#000000"
+    })
+ * </example>
+ *
+ * <example>
+    :emulateGeoLocation.js
+    it('should find my emulated geo location', async () => {
+        await browser.emulate('geolocation', {
+            latitude: 52.52,
+            longitude: 13.39,
+            accuracy: 100
+        })
+        await browser.url('https://www.google.com/maps')
+        await browser.$('aria/Show Your Location').click()
+        await browser.pause(5000)
+        console.log(await browser.getUrl()) // outputs: "https://www.google.com/maps/@52.52,13.39,16z?entry=ttu"
+    })
+ * </example>
+ *
+ * @param {string} scope feature of the browser you like to emulate, can be either `geolocation`, `userAgent`, `colorScheme` or `onLine`
+ * @param {EmulationOptions} options emulation option for specific scope
+ * @returns `void`
+ */
+export declare function emulate<Scope extends SupportedScopes>(this: WebdriverIO.Browser, scope: Scope, options: EmulationOptions[Scope]): Promise<void>;
+export {};
+//# sourceMappingURL=emulate.d.ts.map

package/build/commands/browser/emulate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emulate.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/emulate.ts"],"names":[],"mappings":"AAAA,KAAK,eAAe,GAAG,aAAa,GAAG,WAAW,GAAG,aAAa,GAAG,QAAQ,CAAA;AAE7E,UAAU,gBAAgB;IACtB,WAAW,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAC5C,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,OAAO,GAAG,MAAM,CAAA;IAC7B,MAAM,EAAE,OAAO,CAAA;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAsB,OAAO,CAAC,KAAK,SAAS,eAAe,EACvD,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAC,iBAuFnC"}

package/build/commands/browser/emulate.js

@@ -0,0 +1,127 @@
+/**
+ * WebdriverIO allows you to emulate Web APIs using the `emulate` command. These Web APIs can then
+ * behave exactly as you specify it.
+ *
+ * Read more on this in the [Emulation](/docs/emulation) guidelines.
+ *
+ * :::info
+ *
+ * This feature requires WebDriver Bidi support for the browser. While recent versions of Chrome, Edge
+ * and Firefox have such support, Safari __does not__. For updates follow [wpt.fyi](https://wpt.fyi/results/webdriver/tests/bidi/script/add_preload_script/add_preload_script.py?label=experimental&label=master&aligned).
+ * Furthermore if you use a cloud vendor for spawning browsers, make sure your vendor also supports WebDriver Bidi.
+ *
+ * :::
+ *
+ * <example>
+    :emulateColorScheme.js
+    it('should open WebdriverIO using light color scheme', async () => {
+        await browser.emulate('colorScheme', 'light')
+        await browser.url('https://webdriver.io')
+        const backgroundColor = await browser.$('nav').getCSSProperty('background-color')
+        console.log(backgroundColor.parsed.hex) // outputs: "#efefef"
+    })
+    it('should open WebdriverIO using dark color scheme'm async () => {
+        await browser.emulate('colorScheme', 'dark')
+        await browser.url('https://webdriver.io')
+        const backgroundColor = await browser.$('nav').getCSSProperty('background-color')
+        console.log(backgroundColor.parsed.hex) // outputs: "#000000"
+    })
+ * </example>
+ *
+ * <example>
+    :emulateGeoLocation.js
+    it('should find my emulated geo location', async () => {
+        await browser.emulate('geolocation', {
+            latitude: 52.52,
+            longitude: 13.39,
+            accuracy: 100
+        })
+        await browser.url('https://www.google.com/maps')
+        await browser.$('aria/Show Your Location').click()
+        await browser.pause(5000)
+        console.log(await browser.getUrl()) // outputs: "https://www.google.com/maps/@52.52,13.39,16z?entry=ttu"
+    })
+ * </example>
+ *
+ * @param {string} scope feature of the browser you like to emulate, can be either `geolocation`, `userAgent`, `colorScheme` or `onLine`
+ * @param {EmulationOptions} options emulation option for specific scope
+ * @returns `void`
+ */
+export async function emulate(scope, options) {
+    if (!this.isBidi) {
+        throw new Error('emulate command is only supported for Bidi');
+    }
+    if (scope === 'geolocation') {
+        if (!options) {
+            throw new Error('Missing geolocation emulation options');
+        }
+        const patchedFn = options instanceof Error
+            ? `cbError(new Error(${JSON.stringify(options.message)}))`
+            : `cbSuccess({
+                coords: ${JSON.stringify(options)},
+                timestamp: Date.now()
+            })`;
+        await this.scriptAddPreloadScript({
+            functionDeclaration: /*js*/ `() => {
+                Object.defineProperty(navigator.geolocation, 'getCurrentPosition', {
+                    value: (cbSuccess, cbError) => ${patchedFn}
+                })
+            }`
+        });
+        return;
+    }
+    if (scope === 'userAgent') {
+        if (typeof options !== 'string') {
+            throw new Error(`Expected userAgent emulation options to be a string, received ${typeof options}`);
+        }
+        await this.scriptAddPreloadScript({
+            functionDeclaration: /*js*/ `() => {
+                Object.defineProperty(navigator, 'userAgent', {
+                    value: ${JSON.stringify(options)}
+                })
+            }`
+        });
+        return;
+    }
+    if (scope === 'colorScheme') {
+        if (options !== 'light' && options !== 'dark') {
+            throw new Error(`Expected "colorScheme" emulation options to be either "light" or "dark", received "${options}"`);
+        }
+        await this.scriptAddPreloadScript({
+            functionDeclaration: /*js*/ `() => {
+                const originalMatchMedia = window.matchMedia
+                Object.defineProperty(window, 'matchMedia', {
+                    value: (query) => {
+                        const colorSchemeQuery = query.match(/\\(prefers-color-scheme:(\\s)*(dark|light)\\)/i)
+                        if (colorSchemeQuery) {
+                            const result = originalMatchMedia(query)
+                            Object.defineProperty(result, 'matches', {
+                                value: colorSchemeQuery[2] === "${options}",
+                                configurable: true
+                            })
+                            return result
+                        }
+
+                        return originalMatchMedia(query)
+                    },
+                    configurable: true
+                })
+            }`
+        });
+        return;
+    }
+    if (scope === 'onLine') {
+        if (typeof options !== 'boolean') {
+            throw new Error(`Expected "onLine" emulation options to be a boolean, received "${typeof options}"`);
+        }
+        await this.scriptAddPreloadScript({
+            functionDeclaration: /*js*/ `() => {
+                Object.defineProperty(navigator, 'onLine', {
+                    value: ${options}
+                })
+            }`
+        });
+        return;
+    }
+    return;
+}

package/build/commands/browser/react$$.d.ts

@@ -1,4 +1,4 @@
-import type { ReactSelectorOptions, ElementArray } from '../../types.js';
+import type { ReactSelectorOptions } from '../../types.js';
 /**
  *
  * The `react$$` command is a useful command to query multiple React Components
@@ -32,5 +32,5 @@ import type { ReactSelectorOptions, ElementArray } from '../../types.js';
  * @return {ElementArray}
  *
  */
-export declare function react$$(this: WebdriverIO.Browser, selector: string, { props, state }?: ReactSelectorOptions): Promise<ElementArray>;
+export declare function react$$(this: WebdriverIO.Browser, selector: string, { props, state }?: ReactSelectorOptions): Promise<WebdriverIO.ElementArray>;
 //# sourceMappingURL=react$$.d.ts.map

package/build/commands/browser/react$$.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react$$.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/react$$.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAIxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAsB,OAAO,CACzB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,QAAQ,EAAE,MAAM,EAChB,EAAE,KAAU,EAAE,KAAU,EAAE,GAAE,oBAAyB,yBAexD"}
+{"version":3,"file":"react$$.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/react$$.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAI1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAsB,OAAO,CACzB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,QAAQ,EAAE,MAAM,EAChB,EAAE,KAAU,EAAE,KAAU,EAAE,GAAE,oBAAyB,qCAexD"}

package/build/commands/browser/saveScreenshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"saveScreenshot.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/saveScreenshot.ts"],"names":[],"mappings":";AAGA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,cAAc,CAChC,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,QAAQ,EAAE,MAAM,mBA0BnB"}
+{"version":3,"file":"saveScreenshot.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/saveScreenshot.ts"],"names":[],"mappings":";AAGA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,cAAc,CAChC,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,QAAQ,EAAE,MAAM,mBAwBnB"}

package/build/commands/browser/saveScreenshot.js

@@ -37,10 +37,8 @@ export async function saveScreenshot(filepath) {
     await assertDirectoryExists(absoluteFilepath);
     let screenBuffer;
     if (this.isBidi) {
-        const { contexts } = await this.browsingContextGetTree({});
-        const { data } = await this.browsingContextCaptureScreenshot({
-            context: contexts[0].context
-        });
+        const context = await this.getWindowHandle();
+        const { data } = await this.browsingContextCaptureScreenshot({ context });
         screenBuffer = data;
     }
     else {

package/build/commands/browser/throttle.d.ts

@@ -1,3 +1,6 @@
 import type { ThrottleOptions } from '../../utils/interception/types.js';
-export declare function throttle(this: WebdriverIO.Browser, params: ThrottleOptions): Promise<null>;
+/**
+ * @deprecated use `browser.throttleNetwork` instead
+ */
+export declare function throttle(this: WebdriverIO.Browser, params: ThrottleOptions): Promise<void>;
 //# sourceMappingURL=throttle.d.ts.map

package/build/commands/browser/throttle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"throttle.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/throttle.ts"],"names":[],"mappings":"AA6CA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAmExE,wBAAsB,QAAQ,CAC1B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,MAAM,EAAE,eAAe,iBA0C1B"}
+{"version":3,"file":"throttle.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/throttle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAMxE;;GAEG;AACH,wBAAsB,QAAQ,CAC1B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,MAAM,EAAE,eAAe,iBAK1B"}

package/build/commands/browser/throttle.js

@@ -1,141 +1,11 @@
+import logger from '@wdio/logger';
+import { getBrowserObject } from '../../utils/index.js';
+const log = logger('webdriverio:throttle');
 /**
- * Throttle the network capabilities of the browser. This can help to
- * emulate certain scenarios where a user loses their internet connection
- * and your app needs to address that.
- *
- * There are many presets available with default configurations for ease of use.
- * They are `offline`, `GPRS`, `Regular2G`, `Good2G`, `Regular3G`, `Good3G`,
- * `Regular4G`, `DSL`, `WiFi`, `online`.
- *
- * You can see the values for these presets [in the source code](https://github.com/webdriverio/webdriverio/blob/6824e4eb118a8d20685f12f4bc42f13fd56f8a25/packages/webdriverio/src/commands/browser/throttle.js#L29).
- *
- * :::info
- *
- * Note that using the `throttle` command requires support for Chrome DevTools protocol and e.g.
- * can not be used when running automated tests in the cloud. Find out more in the
- * [Automation Protocols](/docs/automationProtocols) section.
- *
- * :::
- *
- * <example>
-    :throttle.js
-    it('should throttle the network', async () => {
-        // via static string preset
-        await browser.throttle('Regular3G')
-
-        // via custom values
-        await browser.throttle({
-            offline: false,
-            downloadThroughput: 200 * 1024 / 8,
-            uploadThroughput: 200 * 1024 / 8,
-            latency: 20
-        })
-    });
- * </example>
- *
- * @alias browser.throttle
- * @param {ThrottleOptions} params  parameters for throttling
- * @param {boolean}        params.offline              True to emulate internet disconnection.
- * @param {number}         params.latency              Minimum latency from request sent to response headers received (ms).
- * @param {number}         params.downloadThroughput   Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.
- * @param {number}         params.uploadThroughput     Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
- * @type utility
- *
+ * @deprecated use `browser.throttleNetwork` instead
  */
-import { getBrowserObject } from '../../utils/index.js';
-const NETWORK_PRESETS = {
-    'offline': {
-        offline: true,
-        downloadThroughput: 0,
-        uploadThroughput: 0,
-        latency: 1
-    },
-    'GPRS': {
-        offline: false,
-        downloadThroughput: 50 * 1024 / 8,
-        uploadThroughput: 20 * 1024 / 8,
-        latency: 500
-    },
-    'Regular2G': {
-        offline: false,
-        downloadThroughput: 250 * 1024 / 8,
-        uploadThroughput: 50 * 1024 / 8,
-        latency: 300
-    },
-    'Good2G': {
-        offline: false,
-        downloadThroughput: 450 * 1024 / 8,
-        uploadThroughput: 150 * 1024 / 8,
-        latency: 150
-    },
-    'Regular3G': {
-        offline: false,
-        downloadThroughput: 750 * 1024 / 8,
-        uploadThroughput: 250 * 1024 / 8,
-        latency: 100
-    },
-    'Good3G': {
-        offline: false,
-        downloadThroughput: 1.5 * 1024 * 1024 / 8,
-        uploadThroughput: 750 * 1024 / 8,
-        latency: 40
-    },
-    'Regular4G': {
-        offline: false,
-        downloadThroughput: 4 * 1024 * 1024 / 8,
-        uploadThroughput: 3 * 1024 * 1024 / 8,
-        latency: 20
-    },
-    'DSL': {
-        offline: false,
-        downloadThroughput: 2 * 1024 * 1024 / 8,
-        uploadThroughput: 1 * 1024 * 1024 / 8,
-        latency: 5
-    },
-    'WiFi': {
-        offline: false,
-        downloadThroughput: 30 * 1024 * 1024 / 8,
-        uploadThroughput: 15 * 1024 * 1024 / 8,
-        latency: 2
-    },
-    'online': {
-        offline: false,
-        latency: 0,
-        downloadThroughput: -1,
-        uploadThroughput: -1
-    }
-};
-const NETWORK_PRESET_TYPES = Object.keys(NETWORK_PRESETS);
 export async function throttle(params) {
-    if (
-    /**
-     * check string parameter
-     */
-    (typeof params !== 'string' || !NETWORK_PRESET_TYPES.includes(params)) &&
-        /**
-         * check object parameter
-         */
-        (typeof params !== 'object')) {
-        throw new Error(`Invalid parameter for "throttle". Expected it to be typeof object or one of the following values: ${NETWORK_PRESET_TYPES.join(', ')} but found "${params}"`);
-    }
-    /**
-     * use WebDriver extension if connected with cloud service
-     */
-    if (this.isSauce) {
-        const browser = getBrowserObject(this);
-        await browser.throttleNetwork(params);
-        return null;
-    }
-    // Connect to Chrome DevTools
-    await this.getPuppeteer();
-    if (!this.puppeteer) {
-        throw new Error('No Puppeteer connection could be established which is required to use this command');
-    }
-    const pages = await this.puppeteer.pages();
-    const client = await pages[0].target().createCDPSession();
-    // Set throttling property
-    await client.send('Network.emulateNetworkConditions', typeof params === 'string'
-        ? NETWORK_PRESETS[params]
-        : params);
-    return null;
+    log.warn('Command "throttle" is deprecated and will be removed with the next major version release! Use `throttleNetwork` instead.');
+    const browser = getBrowserObject(this);
+    await browser.throttleNetwork(params);
 }

package/build/commands/browser/throttleCPU.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Throttles the CPU to emulate a slower processor.
+ *
+ * :::info
+ *
+ * Note that using the `throttleCPU` command requires support for Chrome DevTools protocol and e.g.
+ * can not be used when running automated tests in the cloud. Find out more in the
+ * [Automation Protocols](/docs/automationProtocols) section.
+ *
+ * :::
+ *
+ * <example>
+    :throttleCPU.js
+    it('should throttle the CPU', async () => {
+        await browser.throttleCPU(2) // 2x slowdown
+    });
+ * </example>
+ *
+ * @alias browser.throttleCPU
+ * @param {number}         factor              slowdown factor (1 is no throttle, 2 is 2x slowdown, etc)
+ * @type utility
+ *
+ */
+export declare function throttleCPU(this: WebdriverIO.Browser, factor: number): Promise<void>;
+//# sourceMappingURL=throttleCPU.d.ts.map

package/build/commands/browser/throttleCPU.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"throttleCPU.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/throttleCPU.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,wBAAsB,WAAW,CAC7B,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,MAAM,EAAE,MAAM,iBAwBjB"}

package/build/commands/browser/throttleCPU.js

@@ -0,0 +1,41 @@
+/**
+ * Throttles the CPU to emulate a slower processor.
+ *
+ * :::info
+ *
+ * Note that using the `throttleCPU` command requires support for Chrome DevTools protocol and e.g.
+ * can not be used when running automated tests in the cloud. Find out more in the
+ * [Automation Protocols](/docs/automationProtocols) section.
+ *
+ * :::
+ *
+ * <example>
+    :throttleCPU.js
+    it('should throttle the CPU', async () => {
+        await browser.throttleCPU(2) // 2x slowdown
+    });
+ * </example>
+ *
+ * @alias browser.throttleCPU
+ * @param {number}         factor              slowdown factor (1 is no throttle, 2 is 2x slowdown, etc)
+ * @type utility
+ *
+ */
+export async function throttleCPU(factor) {
+    if (typeof factor !== 'number') {
+        throw new Error('Invalid factor for "throttleCPU". Expected it to be a number (int)');
+    }
+    const failedConnectionMessage = 'No Puppeteer connection could be established which is required to use this command';
+    // Connect to Chrome DevTools
+    await this.getPuppeteer();
+    if (!this.puppeteer) {
+        throw new Error(failedConnectionMessage);
+    }
+    const pages = await this.puppeteer.pages();
+    if (!pages.length) {
+        throw new Error(failedConnectionMessage);
+    }
+    const client = await pages[0].target().createCDPSession();
+    // Set CPU throttling
+    await client.send('Emulation.setCPUThrottlingRate', { rate: factor });
+}

package/build/commands/browser/throttleNetwork.d.ts

@@ -0,0 +1,3 @@
+import type { ThrottleOptions } from '../../utils/interception/types.js';
+export declare function throttleNetwork(this: WebdriverIO.Browser, params: ThrottleOptions): Promise<null>;
+//# sourceMappingURL=throttleNetwork.d.ts.map

package/build/commands/browser/throttleNetwork.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"throttleNetwork.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/throttleNetwork.ts"],"names":[],"mappings":"AA6CA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAmExE,wBAAsB,eAAe,CACjC,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,MAAM,EAAE,eAAe,iBAiD1B"}