webdriver 7.20.6 → 8.0.0-alpha.213

package/README.md

@@ -1,13 +1,14 @@
 WebDriver
 =========
 
-> A lightweight, non-opinionated implementation of the [WebDriver specification](https://w3c.github.io/webdriver/webdriver-spec.html) including mobile commands supported by [Appium](http://appium.io/)
+> A lightweight, non-opinionated implementation of the [WebDriver](https://w3c.github.io/webdriver/webdriver-spec.html) and [WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) specification including mobile commands supported by [Appium](http://appium.io/)
 
 There are [tons](https://github.com/christian-bromann/awesome-selenium#javascript) of Selenium and WebDriver binding implementations in the Node.js world. Every one of them have an opinionated API and recommended way to use. This binding is the most non-opinionated you will find as it just represents the [WebDriver specification](https://w3c.github.io/webdriver/webdriver-spec.html) and doesn't come with any extra or higher level abstraction. It is lightweight and comes with support for the [WebDriver specification](https://w3c.github.io/webdriver/webdriver-spec.html) and Appium's [Mobile JSONWire Protocol](https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md).
 
 The package supports the following protocols:
 
 - [WebDriver](https://w3c.github.io/webdriver/)
+- [WebDriver Bidi](https://w3c.github.io/webdriver-bidi/)
 - [Appium](http://appium.io/)
 - [Chromium](http://chromedriver.chromium.org/) (additional Chromedriver specific commands)
 - [Selenium](https://www.selenium.dev/) (additional Selenium WebDriver specific commands)
@@ -25,31 +26,57 @@ To install this package from NPM run:
 npm i webdriver
 ```
 
-## Example
+## WebDriver Example
 
 The following example demonstrates a simple Google Search scenario:
 
 ```js
 import WebDriver from 'webdriver';
 
-(async () => {
-    const client = await WebDriver.newSession({
-        path: '/',
-        capabilities: { browserName: 'firefox' }
-    })
+const client = await WebDriver.newSession({
+    path: '/',
+    capabilities: { browserName: 'firefox' }
+})
 
-    await client.navigateTo('https://www.google.com/ncr')
+await client.navigateTo('https://www.google.com/ncr')
 
-    const searchInput = await client.findElement('css selector', '#lst-ib')
-    await client.elementSendKeys(searchInput['element-6066-11e4-a52e-4f735466cecf'], 'WebDriver')
+const searchInput = await client.findElement('css selector', '#lst-ib')
+await client.elementSendKeys(searchInput['element-6066-11e4-a52e-4f735466cecf'], 'WebDriver')
 
-    const searchBtn = await client.findElement('css selector', 'input[value="Google Search"]')
-    await client.elementClick(searchBtn['element-6066-11e4-a52e-4f735466cecf'])
+const searchBtn = await client.findElement('css selector', 'input[value="Google Search"]')
+await client.elementClick(searchBtn['element-6066-11e4-a52e-4f735466cecf'])
 
-    console.log(await client.getTitle()) // outputs "WebDriver - Google Search"
+console.log(await client.getTitle()) // outputs "WebDriver - Google Search"
 
-    await client.deleteSession()
-})()
+await client.deleteSession()
+```
+
+## WebDriver Bidi Example
+
+To connect to the WebDriver Bidi protocol you have to send along a `webSocketUrl` flag to tell the browser driver to opt-in to the protocol:
+
+```js
+import WebDriver from './packages/webdriver/build/index.js'
+
+const browser = await WebDriver.newSession({
+    capabilities: {
+        webSocketUrl: true,
+        browserName: 'firefox'
+    }
+})
+
+await browser.send({
+    method: 'session.subscribe',
+    params: { events: ['log.entryAdded'] }
+})
+
+/**
+ * returns: {"method":"log.entryAdded","params":{"type":"console","method":"log","realm":null,"args":[{"type":"string","value":"Hello Bidi"}],"level":"info","text":"Hello Bidi","timestamp":1657282076037}}
+ */
+browser.on('message', (data) => console.log('received %s', data))
+
+await browser.executeScript('console.log("Hello Bidi")', [])
+await browser.deleteSession()
 ```
 
 # Configuration

package/build/bidi.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+import { EventEmitter } from 'node:events';
+import WebSocket from 'ws';
+import { BidiRequest, BidiResponse } from '@wdio/protocols';
+export declare class BidiHandler extends EventEmitter {
+    #private;
+    private _webSocketUrl;
+    constructor(_webSocketUrl: string);
+    connect(): Promise<void>;
+    get socket(): WebSocket;
+    get isConnected(): boolean;
+    send(params: BidiRequest): Promise<BidiResponse>;
+    sendAsync(params: BidiRequest): void;
+}
+//# sourceMappingURL=bidi.d.ts.map

package/build/bidi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bidi.d.ts","sourceRoot":"","sources":["../src/bidi.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,SAAS,MAAM,IAAI,CAAA;AAE1B,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAK3D,qBAAa,WAAY,SAAQ,YAAY;;IAK5B,OAAO,CAAC,aAAa;gBAAb,aAAa,EAAE,MAAM;IAMnC,OAAO;IAOd,IAAI,MAAM,cAET;IAED,IAAI,WAAW,YAEd;IAEM,IAAI,CAAE,MAAM,EAAE,WAAW;IA6BzB,SAAS,CAAE,MAAM,EAAE,WAAW;CAQxC"}

package/build/bidi.js

@@ -0,0 +1,77 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _BidiHandler_id, _BidiHandler_ws, _BidiHandler_isConnected;
+import { EventEmitter } from 'node:events';
+import WebSocket from 'ws';
+import logger from '@wdio/logger';
+const log = logger('webdriver:BidiHandler');
+const RESPONSE_TIMEOUT = 1000 * 60;
+export class BidiHandler extends EventEmitter {
+    constructor(_webSocketUrl) {
+        super();
+        this._webSocketUrl = _webSocketUrl;
+        _BidiHandler_id.set(this, 0);
+        _BidiHandler_ws.set(this, void 0);
+        _BidiHandler_isConnected.set(this, false);
+        log.info(`Connect to webSocketUrl ${this._webSocketUrl}`);
+        __classPrivateFieldSet(this, _BidiHandler_ws, new WebSocket(this._webSocketUrl), "f");
+    }
+    connect() {
+        return new Promise((resolve) => __classPrivateFieldGet(this, _BidiHandler_ws, "f").on('open', () => {
+            __classPrivateFieldSet(this, _BidiHandler_isConnected, true, "f");
+            resolve();
+        }));
+    }
+    get socket() {
+        return __classPrivateFieldGet(this, _BidiHandler_ws, "f");
+    }
+    get isConnected() {
+        return __classPrivateFieldGet(this, _BidiHandler_isConnected, "f");
+    }
+    send(params) {
+        var _a;
+        if (!__classPrivateFieldGet(this, _BidiHandler_isConnected, "f")) {
+            throw new Error('No connection to WebDriver Bidi was established');
+        }
+        const id = __classPrivateFieldSet(this, _BidiHandler_id, (_a = __classPrivateFieldGet(this, _BidiHandler_id, "f"), ++_a), "f");
+        __classPrivateFieldGet(this, _BidiHandler_ws, "f").send(JSON.stringify({ id, ...params }));
+        return new Promise((resolve, reject) => {
+            const t = setTimeout(() => {
+                reject(new Error(`Request with id ${id} timed out`));
+                h.off('message', listener);
+            }, RESPONSE_TIMEOUT);
+            const listener = (data) => {
+                try {
+                    const payload = JSON.parse(data.toString());
+                    if (payload.id === id) {
+                        clearTimeout(t);
+                        h.off('message', listener);
+                        resolve(payload);
+                    }
+                }
+                catch (err) {
+                    log.error(`Failed parse message: ${err.message}`);
+                }
+            };
+            const h = __classPrivateFieldGet(this, _BidiHandler_ws, "f").on('message', listener);
+        });
+    }
+    sendAsync(params) {
+        var _a;
+        if (!__classPrivateFieldGet(this, _BidiHandler_isConnected, "f")) {
+            throw new Error('No connection to WebDriver Bidi was established');
+        }
+        const id = __classPrivateFieldSet(this, _BidiHandler_id, (_a = __classPrivateFieldGet(this, _BidiHandler_id, "f"), ++_a), "f");
+        __classPrivateFieldGet(this, _BidiHandler_ws, "f").send(JSON.stringify({ id, ...params }));
+    }
+}
+_BidiHandler_id = new WeakMap(), _BidiHandler_ws = new WeakMap(), _BidiHandler_isConnected = new WeakMap();

package/build/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cjs/index.ts"],"names":[],"mappings":""}

package/build/cjs/index.js

@@ -0,0 +1,28 @@
+module.exports = class WebDriver {
+    static async newSession(options, modifier, userPrototype = {}, customCommandWrapper) {
+        const WebDriver = (await import('../index.js')).default;
+        return WebDriver.newSession(options, modifier, userPrototype, customCommandWrapper);
+    }
+    /**
+     * allows user to attach to existing sessions
+     */
+    static async attachToSession(options, modifier, userPrototype = {}, commandWrapper) {
+        const WebDriver = (await import('../index.js')).default;
+        return WebDriver.attachToSession(options, modifier, userPrototype, commandWrapper);
+    }
+    /**
+     * Changes The instance session id and browser capabilities for the new session
+     * directly into the passed in browser object
+     *
+     * @param   {Object} instance  the object we get from a new browser session.
+     * @returns {string}           the new session id of the browser
+    */
+    static async reloadSession(instance) {
+        const WebDriver = (await import('../index.js')).default;
+        return WebDriver.reloadSession(instance);
+    }
+    static get WebDriver() {
+        return WebDriver;
+    }
+};
+

package/build/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/build/command.d.ts

@@ -1,5 +1,10 @@
-import type { CommandEndpoint } from '@wdio/protocols';
-import { WebDriverResponse } from './request';
-import { BaseClient } from './types';
-export default function (method: string, endpointUri: string, commandInfo: CommandEndpoint, doubleEncodeVariables?: boolean): (this: BaseClient, ...args: any[]) => Promise<WebDriverResponse>;
+import type { CommandEndpoint, BidiResponse } from '@wdio/protocols';
+import { BidiHandler } from './bidi.js';
+import type { WebDriverResponse } from './request';
+import type { BaseClient } from './types';
+interface BaseClientWithEventHandler extends BaseClient {
+    eventMiddleware: BidiHandler;
+}
+export default function (method: string, endpointUri: string, commandInfo: CommandEndpoint, doubleEncodeVariables?: boolean): (this: BaseClientWithEventHandler, ...args: any[]) => Promise<WebDriverResponse | BidiResponse | void>;
+export {};
 //# sourceMappingURL=command.d.ts.map

package/build/command.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAGtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAIpC,MAAM,CAAC,OAAO,WACV,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,eAAe,EAC5B,qBAAqB,UAAQ,UAIU,UAAU,WAAW,GAAG,EAAE,KAAG,QAAQ,iBAAiB,CAAC,CA2FjG"}
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAGpE,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAKzC,UAAU,0BAA2B,SAAQ,UAAU;IACnD,eAAe,EAAE,WAAW,CAAA;CAC/B;AAED,MAAM,CAAC,OAAO,WACV,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,eAAe,EAC5B,qBAAqB,UAAQ,UAIgB,0BAA0B,WAAW,GAAG,EAAE,KAAG,QAAQ,iBAAiB,GAAG,YAAY,GAAG,IAAI,CAAC,CAuG7I"}

package/build/command.js

@@ -1,15 +1,11 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const logger_1 = __importDefault(require("@wdio/logger"));
-const utils_1 = require("@wdio/utils");
-const factory_1 = __importDefault(require("./request/factory"));
-const log = (0, logger_1.default)('webdriver');
-function default_1(method, endpointUri, commandInfo, doubleEncodeVariables = false) {
+import logger from '@wdio/logger';
+import { commandCallStructure, isValidParameter, getArgumentType } from '@wdio/utils';
+import RequestFactory from './request/factory.js';
+const log = logger('webdriver');
+const BIDI_COMMANDS = ['send', 'sendAsync'];
+export default function (method, endpointUri, commandInfo, doubleEncodeVariables = false) {
     const { command, ref, parameters, variables = [], isHubCommand = false } = commandInfo;
-    return function protocolCommand(...args) {
+    return async function protocolCommand(...args) {
         let endpoint = endpointUri; // clone endpointUri in case we change it
         const commandParams = [...variables.map((v) => Object.assign(v, {
                 /**
@@ -40,7 +36,7 @@ function default_1(method, endpointUri, commandInfo, doubleEncodeVariables = fal
         for (const [it, arg] of Object.entries(args)) {
             const i = parseInt(it, 10);
             const commandParam = commandParams[i];
-            if (!(0, utils_1.isValidParameter)(arg, commandParam.type)) {
+            if (!isValidParameter(arg, commandParam.type)) {
                 /**
                  * ignore if argument is not required
                  */
@@ -48,8 +44,8 @@ function default_1(method, endpointUri, commandInfo, doubleEncodeVariables = fal
                     continue;
                 }
                 const actual = commandParam.type.endsWith('[]')
-                    ? `(${(Array.isArray(arg) ? arg : [arg]).map((a) => (0, utils_1.getArgumentType)(a))})[]`
-                    : (0, utils_1.getArgumentType)(arg);
+                    ? `(${(Array.isArray(arg) ? arg : [arg]).map((a) => getArgumentType(a))})[]`
+                    : getArgumentType(arg);
                 throw new Error(`Malformed type for "${commandParam.name}" parameter of command ${command}\n` +
                     `Expected: ${commandParam.type}\n` +
                     `Actual: ${actual}` +
@@ -68,22 +64,31 @@ function default_1(method, endpointUri, commandInfo, doubleEncodeVariables = fal
              */
             body[commandParams[i].name] = arg;
         }
-        const request = factory_1.default.getInstance(method, endpoint, body, isHubCommand);
+        /**
+         * Handle Bidi calls
+         */
+        if (this.sessionId && BIDI_COMMANDS.includes(command)) {
+            if (!this.eventMiddleware) {
+                throw new Error('Your WebDriver session doesn\'t support WebDriver Bidi');
+            }
+            return this.eventMiddleware[command](body.params);
+        }
+        const request = await RequestFactory.getInstance(method, endpoint, body, isHubCommand);
         request.on('performance', (...args) => this.emit('request.performance', ...args));
         this.emit('command', { method, endpoint, body });
-        log.info('COMMAND', (0, utils_1.commandCallStructure)(command, args));
+        log.info('COMMAND', commandCallStructure(command, args));
         return request.makeRequest(this.options, this.sessionId).then((result) => {
             if (result.value != null) {
                 log.info('RESULT', /screenshot|recording/i.test(command)
                     && typeof result.value === 'string' && result.value.length > 64
-                    ? `${result.value.substr(0, 61)}...` : result.value);
+                    ? `${result.value.slice(0, 61)}...`
+                    : result.value);
             }
             this.emit('result', { method, endpoint, body, result });
-            if (command === 'deleteSession') {
-                logger_1.default.clearLogger();
+            if (command === 'deleteSession' && !process.env.WDIO_WORKER_ID) {
+                logger.clearLogger();
             }
             return result.value;
         });
     };
 }
-exports.default = default_1;

package/build/constants.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.REG_EXPS = exports.DEFAULTS = void 0;
-exports.DEFAULTS = {
+export const DEFAULTS = {
     /**
      * protocol of automation driver
      */
@@ -139,7 +136,7 @@ exports.DEFAULTS = {
         default: true
     }
 };
-exports.REG_EXPS = {
+export const REG_EXPS = {
     commandName: /.*\/session\/[0-9a-f-]+\/(.*)/,
     execFn: /return \(([\s\S]*)\)\.apply\(null, arguments\)/
 };

package/build/index.d.ts

@@ -1,7 +1,7 @@
 import type { Options } from '@wdio/types';
-import command from './command';
-import { DEFAULTS } from './constants';
-import { getPrototype } from './utils';
+import command from './command.js';
+import { DEFAULTS } from './constants.js';
+import { getPrototype } from './utils.js';
 import type { Client, AttachOptions } from './types';
 export default class WebDriver {
     static newSession(options: Options.WebDriver, modifier?: (...args: any[]) => any, userPrototype?: {}, customCommandWrapper?: (...args: any[]) => any): Promise<Client>;
@@ -23,5 +23,5 @@ export default class WebDriver {
  * Helper methods consumed by webdriverio package
  */
 export { getPrototype, DEFAULTS, command };
-export * from './types';
+export * from './types.js';
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAgB,MAAM,aAAa,CAAA;AAExD,OAAO,OAAO,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAyB,YAAY,EAA0C,MAAM,SAAS,CAAA;AACrG,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAgB,MAAM,SAAS,CAAA;AAIlE,MAAM,CAAC,OAAO,OAAO,SAAS;WACb,UAAU,CACnB,OAAO,EAAE,OAAO,CAAC,SAAS,EAC1B,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAClC,aAAa,KAAK,EAClB,oBAAoB,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAC/C,OAAO,CAAC,MAAM,CAAC;IA4ClB;;OAEG;IACH,MAAM,CAAC,eAAe,CAClB,OAAO,CAAC,EAAE,aAAa,EACvB,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAClC,aAAa,KAAK,EAClB,cAAc,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GACzC,MAAM;IAwBT;;;;;;MAME;WACW,aAAa,CAAE,QAAQ,EAAE,MAAM;IAW5C,MAAM,KAAK,SAAS,qBAEnB;CACJ;AAED;;GAEG;AACH,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;AAC1C,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAgB,MAAM,aAAa,CAAA;AAExD,OAAO,OAAO,MAAM,cAAc,CAAA;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EACoB,YAAY,EACtC,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAgB,MAAM,SAAS,CAAA;AAIlE,MAAM,CAAC,OAAO,OAAO,SAAS;WACb,UAAU,CACnB,OAAO,EAAE,OAAO,CAAC,SAAS,EAC1B,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAClC,aAAa,KAAK,EAClB,oBAAoB,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAC/C,OAAO,CAAC,MAAM,CAAC;IAoDlB;;OAEG;IACH,MAAM,CAAC,eAAe,CAClB,OAAO,CAAC,EAAE,aAAa,EACvB,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAClC,aAAa,KAAK,EAClB,cAAc,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GACzC,MAAM;IAwBT;;;;;;MAME;WACW,aAAa,CAAE,QAAQ,EAAE,MAAM;IAW5C,MAAM,KAAK,SAAS,qBAEnB;CACJ;AAED;;GAEG;AACH,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;AAC1C,cAAc,YAAY,CAAA"}

package/build/index.js

@@ -1,55 +1,40 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.command = exports.DEFAULTS = exports.getPrototype = void 0;
-const path_1 = __importDefault(require("path"));
-const logger_1 = __importDefault(require("@wdio/logger"));
-const utils_1 = require("@wdio/utils");
-const config_1 = require("@wdio/config");
-const command_1 = __importDefault(require("./command"));
-exports.command = command_1.default;
-const constants_1 = require("./constants");
-Object.defineProperty(exports, "DEFAULTS", { enumerable: true, get: function () { return constants_1.DEFAULTS; } });
-const utils_2 = require("./utils");
-Object.defineProperty(exports, "getPrototype", { enumerable: true, get: function () { return utils_2.getPrototype; } });
-const log = (0, logger_1.default)('webdriver');
-class WebDriver {
+import path from 'node:path';
+import logger from '@wdio/logger';
+import { webdriverMonad, sessionEnvironmentDetector } from '@wdio/utils';
+import { validateConfig } from '@wdio/config';
+import command from './command.js';
+import { BidiHandler } from './bidi.js';
+import { DEFAULTS } from './constants.js';
+import { startWebDriverSession, getPrototype, getEnvironmentVars, setupDirectConnect } from './utils.js';
+const log = logger('webdriver');
+export default class WebDriver {
     static async newSession(options, modifier, userPrototype = {}, customCommandWrapper) {
-        const params = (0, config_1.validateConfig)(constants_1.DEFAULTS, options);
+        const params = validateConfig(DEFAULTS, options);
         if (!options.logLevels || !options.logLevels.webdriver) {
-            logger_1.default.setLevel('webdriver', params.logLevel);
+            logger.setLevel('webdriver', params.logLevel);
         }
         /**
          * Store all log events in a file
          */
         if (params.outputDir && !process.env.WDIO_LOG_PATH) {
-            process.env.WDIO_LOG_PATH = path_1.default.join(params.outputDir, 'wdio.log');
+            process.env.WDIO_LOG_PATH = path.join(params.outputDir, 'wdio.log');
         }
         log.info('Initiate new session using the WebDriver protocol');
         const requestedCapabilities = { ...params.capabilities };
-        const { sessionId, capabilities } = await (0, utils_2.startWebDriverSession)(params);
-        const environment = (0, utils_1.sessionEnvironmentDetector)({ capabilities, requestedCapabilities });
-        const environmentPrototype = (0, utils_2.getEnvironmentVars)(environment);
-        const protocolCommands = (0, utils_2.getPrototype)(environment);
+        const { sessionId, capabilities } = await startWebDriverSession(params);
+        const environment = sessionEnvironmentDetector({ capabilities, requestedCapabilities });
+        const environmentPrototype = getEnvironmentVars(environment);
+        const protocolCommands = getPrototype(environment);
         const prototype = { ...protocolCommands, ...environmentPrototype, ...userPrototype };
-        const monad = (0, utils_1.webdriverMonad)({ ...params, requestedCapabilities }, modifier, prototype);
-        const client = monad(sessionId, customCommandWrapper);
+        const monad = webdriverMonad({ ...params, requestedCapabilities }, modifier, prototype);
+        let handler;
+        if (capabilities.webSocketUrl) {
+            log.info(`Register BiDi handler for session with id ${sessionId}`);
+            const socketUrl = capabilities.webSocketUrl.replace('localhost', '127.0.0.1');
+            handler = new BidiHandler(socketUrl);
+            await handler.connect();
+        }
+        const client = monad(sessionId, customCommandWrapper, handler);
         /**
          * if the server responded with direct connect information, update the
          * client options to speak directly to the appium host instead of a load
@@ -58,7 +43,7 @@ class WebDriver {
          * behavior in the first place.
          */
         if (params.enableDirectConnect) {
-            (0, utils_2.setupDirectConnect)(client);
+            setupDirectConnect(client);
         }
         return client;
     }
@@ -71,18 +56,18 @@ class WebDriver {
         }
         // logLevel can be undefined in watch mode when SIGINT is called
         if (options.logLevel) {
-            logger_1.default.setLevel('webdriver', options.logLevel);
+            logger.setLevel('webdriver', options.logLevel);
         }
         options.capabilities = options.capabilities || {};
         options.isW3C = options.isW3C === false ? false : true;
-        options.protocol = options.protocol || constants_1.DEFAULTS.protocol.default;
-        options.hostname = options.hostname || constants_1.DEFAULTS.hostname.default;
-        options.port = options.port || constants_1.DEFAULTS.port.default;
-        options.path = options.path || constants_1.DEFAULTS.path.default;
-        const environmentPrototype = (0, utils_2.getEnvironmentVars)(options);
-        const protocolCommands = (0, utils_2.getPrototype)(options);
+        options.protocol = options.protocol || DEFAULTS.protocol.default;
+        options.hostname = options.hostname || DEFAULTS.hostname.default;
+        options.port = options.port || DEFAULTS.port.default;
+        options.path = options.path || DEFAULTS.path.default;
+        const environmentPrototype = getEnvironmentVars(options);
+        const protocolCommands = getPrototype(options);
         const prototype = { ...protocolCommands, ...environmentPrototype, ...userPrototype };
-        const monad = (0, utils_1.webdriverMonad)(options, modifier, prototype);
+        const monad = webdriverMonad(options, modifier, prototype);
         return monad(options.sessionId, commandWrapper);
     }
     /**
@@ -97,7 +82,7 @@ class WebDriver {
             ...instance.options,
             capabilities: instance.requestedCapabilities
         };
-        const { sessionId, capabilities } = await (0, utils_2.startWebDriverSession)(params);
+        const { sessionId, capabilities } = await startWebDriverSession(params);
         instance.sessionId = sessionId;
         instance.capabilities = capabilities;
         return sessionId;
@@ -106,5 +91,8 @@ class WebDriver {
         return WebDriver;
     }
 }
-exports.default = WebDriver;
-__exportStar(require("./types"), exports);
+/**
+ * Helper methods consumed by webdriverio package
+ */
+export { getPrototype, DEFAULTS, command };
+export * from './types.js';

package/build/request/browser.d.ts

@@ -1,10 +1,10 @@
-import { Options } from '@wdio/types';
-import WebDriverRequest from './index';
+import type { Options } from '@wdio/types';
+import WebDriverRequest from './index.js';
 declare type RequestLibOptions = Options.RequestLibOptions;
 declare type RequestOptions = Omit<Options.WebDriver, 'capabilities'>;
 export default class BrowserRequest extends WebDriverRequest {
     constructor(method: string, endpoint: string, body?: Record<string, unknown>, isHubCommand?: boolean);
-    protected _createOptions(options: RequestOptions, sessionId?: string): RequestLibOptions;
+    protected _createOptions(options: RequestOptions, sessionId?: string): Promise<RequestLibOptions>;
     protected _libRequest(url: URL, options: RequestLibOptions): Promise<{
         statusCode: number;
         body: unknown;

package/build/request/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/request/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAErC,OAAO,gBAAgB,MAAM,SAAS,CAAA;AAGtC,aAAK,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAA;AAClD,aAAK,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;AAU7D,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,gBAAgB;gBAE3C,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAE,OAAe;IAI5G,SAAS,CAAC,cAAc,CAAE,OAAO,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,iBAAiB;cAIzE,WAAW,CAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,iBAAiB;;;;IA+BjE,SAAS,CAAC,kBAAkB,IAAI,MAAM;CAGzC"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/request/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,gBAAgB,MAAM,YAAY,CAAA;AAEzC,aAAK,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAA;AAClD,aAAK,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;AAU7D,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,gBAAgB;gBAE3C,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAE,OAAe;cAI5F,cAAc,CAAE,OAAO,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;cAIxF,WAAW,CAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,iBAAiB;;;;IA+BjE,SAAS,CAAC,kBAAkB,IAAI,MAAM;CAGzC"}

package/build/request/browser.js

@@ -1,22 +1,17 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const logger_1 = __importDefault(require("@wdio/logger"));
-const index_1 = __importDefault(require("./index"));
-const ky_1 = __importDefault(require("ky"));
-const log = (0, logger_1.default)('webdriver');
+import ky from 'ky';
+import logger from '@wdio/logger';
+import WebDriverRequest from './index.js';
+const log = logger('webdriver');
 const UNSUPPORTED_OPTS = [
     'agent',
     'responseType',
     'searchParams',
 ];
-class BrowserRequest extends index_1.default {
+export default class BrowserRequest extends WebDriverRequest {
     constructor(method, endpoint, body, isHubCommand = false) {
         super(method, endpoint, body, isHubCommand);
     }
-    _createOptions(options, sessionId) {
+    async _createOptions(options, sessionId) {
         return super._createOptions(options, sessionId, true);
     }
     async _libRequest(url, options) {
@@ -38,7 +33,7 @@ class BrowserRequest extends index_1.default {
                 Authorization: `Basic ${encodedAuth}`
             };
         }
-        const res = await (0, ky_1.default)(url, kyOptions);
+        const res = await ky(url, kyOptions);
         return {
             statusCode: res.status,
             body: await res.json(),
@@ -48,4 +43,3 @@ class BrowserRequest extends index_1.default {
         return performance.now();
     }
 }
-exports.default = BrowserRequest;

package/build/request/factory.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="node" />
-import WebDriverRequest from './index';
-import type { URL as URLType } from 'url';
+import type { URL as URLType } from 'node:url';
+import WebDriverRequest from './index.js';
 export default class RequestFactory {
-    static getInstance(method: string, endpoint: string, body?: Record<string, unknown>, isHubCommand?: boolean): WebDriverRequest;
+    static getInstance(method: string, endpoint: string, body?: Record<string, unknown>, isHubCommand?: boolean): Promise<WebDriverRequest>;
 }
 export declare class URLFactory {
-    static getInstance(uri: string): URLType;
+    static getInstance(uri: string): Promise<URLType>;
 }
 //# sourceMappingURL=factory.d.ts.map

package/build/request/factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/request/factory.ts"],"names":[],"mappings":";AAAA,OAAO,gBAAgB,MAAM,SAAS,CAAA;AACtC,OAAO,KAAK,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,KAAK,CAAA;AAEzC,MAAM,CAAC,OAAO,OAAO,cAAc;IAC/B,MAAM,CAAC,WAAW,CACd,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,YAAY,GAAE,OAAe,GAC9B,gBAAgB;CAYtB;AAED,qBAAa,UAAU;IACnB,MAAM,CAAC,WAAW,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO;CAO5C"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/request/factory.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,UAAU,CAAA;AAI9C,OAAO,gBAAgB,MAAM,YAAY,CAAA;AAOzC,MAAM,CAAC,OAAO,OAAO,cAAc;WAClB,WAAW,CACpB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,YAAY,GAAE,OAAe,GAC9B,OAAO,CAAC,gBAAgB,CAAC;CAS/B;AAED,qBAAa,UAAU;WACN,WAAW,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAO3D"}