npmpackage.info

@rpai/webdriver

Next-gen browser and mobile automation test framework for Node.js

1.0.3

9,185

MIT

TypeScript

347.11 kB

394 4.9

Installations

npm install @rpai/webdriver

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

^16.13 || >=18

Node Version

20.15.0

NPM Version

10.7.0 Score

53.5

Supply Chain

88.8

Quality

76.7

Maintenance

100

Vulnerability

97.9

License

Pull Requests

Open

13

Total

7,889

Closed

1,400

Merged

6,476

Issues

Open

198

Total

5,601

Closed

5,403

Releases

543

v9.9.1

Updated on Feb 14, 2025

v9.9.0

Updated on Feb 12, 2025

v8.42.0

Updated on Feb 12, 2025

v9.8.0

Updated on Feb 06, 2025

v9.7.3

Updated on Feb 05, 2025

v9.7.2

Updated on Jan 29, 2025

View All 543 releases

Contributors

621

View All 621 Contributors

Languages

TypeScript

JavaScript

EJS

CSS

Gherkin

Dockerfile

Vue

Svelte

HTML

TypeScript (94.46%)

JavaScript (3.3%)

EJS (1.45%)

CSS (0.68%)

Gherkin (0.07%)

Dockerfile (0.03%)

Vue (0.01%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

webdriverio

Download Statistics

Total Downloads

394

Last Day

Last Week

Last Month

Last Year

394

GitHub Statistics

MIT License

9,185 Stars

7,809 Commits

2,539 Forks

215 Watchers

30 Branches

621 Contributors

Updated on Feb 16, 2025

Maintainers

Package Meta Information

Latest Version

1.0.3

Package Id

@rpai/webdriver@1.0.3

Unpacked Size

347.11 kB

Size

65.50 kB

File Count

NPM Version

10.7.0

Node Version

20.15.0

Published on

Sep 27, 2024

Total Downloads

Cumulative downloads

Total Downloads

394

Last Day

Compared to previous day

Last Week

-16.7%

Compared to previous week

Last Month

85%

Compared to previous month

Last Year

394

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/node @types/ws deepmerge-ts got ky ws @rpai/wdio-config @rpai/wdio-logger @rpai/wdio-protocols @rpai/wdio-types @rpai/wdio-utils

WebDriver

A lightweight, non-opinionated implementation of the WebDriver and WebDriver BiDi specification including mobile commands supported by Appium

There are tons of Selenium and WebDriver binding implementations in the Node.js world. Every one of them has an opinionated API and recommended way to use it. This binding is the most non-opinionated you will find as it just represents the WebDriver specification and doesn't come with any extra or higher-level abstraction. It is lightweight and comes with support for the WebDriver specification and Appium's Mobile JSONWire Protocol.

The package supports the following protocols:

WebDriver
WebDriver Bidi
Appium
Chromium (additional Chromedriver specific commands)
Selenium (additional Selenium WebDriver specific commands)
Sauce Labs (Sauce Labs specific WebDriver extensions)
JSONWireProtocol (depcrecated)
Mobile JSONWireProtocol (depcrecated)

Commands are added to the client's protocol based on assumptions of provided capabilities. You can find more details about the commands by checking out the @wdio/protocols package. All commands come with TypeScript support.

Install

To install this package from NPM run:

1npm i webdriver

WebDriver Example

The following example demonstrates a simple Google Search scenario:

1import WebDriver from 'webdriver';
2
3const client = await WebDriver.newSession({
4    path: '/',
5    capabilities: { browserName: 'firefox' }
6})
7
8await client.navigateTo('https://www.google.com/ncr')
9
10const searchInput = await client.findElement('css selector', '#lst-ib')
11await client.elementSendKeys(searchInput['element-6066-11e4-a52e-4f735466cecf'], 'WebDriver')
12
13const searchBtn = await client.findElement('css selector', 'input[value="Google Search"]')
14await client.elementClick(searchBtn['element-6066-11e4-a52e-4f735466cecf'])
15
16console.log(await client.getTitle()) // outputs "WebDriver - Google Search"
17
18await 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:

1import WebDriver from 'webdriver'
2
3const browser = await WebDriver.newSession({
4    capabilities: {
5        webSocketUrl: true,
6        browserName: 'firefox'
7    }
8})
9
10await browser.sessionSubscribe({ events: ['log.entryAdded'] })
11
12/**
13 * returns: {"type":"console","method":"log","realm":null,"args":[{"type":"string","value":"Hello Bidi"}],"level":"info","text":"Hello Bidi","timestamp":1657282076037}
14 */
15browser.on('log.entryAdded', (entryAdded) => console.log('received %s', entryAdded))
16
17await browser.executeScript('console.log("Hello Bidi")', [])
18await browser.deleteSession()

Configuration

To create a WebDriver session call the newSession method on the WebDriver class and pass in your configurations:

1import WebDriver from 'webdriver'
2const client = await WebDriver.newSession(options)

The following options are available:

capabilities

Defines the capabilities you want to run in your Selenium session.

Type: Object
Required: true

logLevel

Level of logging verbosity.

protocol

Protocol to use when communicating with the Selenium standalone server (or driver).

Type: String
Default: http Options: http | https

hostname

Host of your WebDriver server.

Type: String
Default: 0.0.0.0

port

Port your WebDriver server is on.

Type: Number
Default: undefined

path

Path to WebDriver endpoint or grid server.

Type: String
Default: /

queryParams

Query parameters that are propagated to the driver server.

Type: Object Default: undefined

connectionRetryTimeout

Timeout for any WebDriver request to a driver or grid.

Type: Number
Default: 120000

connectionRetryCount

Count of request retries to the Selenium server.

Type: Number
Default: 3

agent

Allows you to use a custom http/https/http2 agent to make requests.

Type: Object
Default:

1{
2    http: new http.Agent({ keepAlive: true }),
3    https: new https.Agent({ keepAlive: true })
4}

transformRequest

Function intercepting HTTP request options before a WebDriver request is made

Type: (RequestOptions) => RequestOptions
Default: none

transformResponse

Function intercepting HTTP response objects after a WebDriver response has arrived

Type: (Response, RequestOptions) => Response
Default: none

No vulnerabilities found.

10

Security-Policy

Determines if the project has published a security policy.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

5

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 2

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/authorize.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/authorize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/expense.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/expense.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/publish.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-cloud.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/test-cloud.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-component.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/test-component.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-launch.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/test-launch.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-multiremote.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/test-multiremote.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-testrunner.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/test-testrunner.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/update.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/webdriverio/webdriverio/update.yaml/main?enable=pin
Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:1: pin your Docker image by updating mcr.microsoft.com/devcontainers/javascript-node:0-18 to mcr.microsoft.com/devcontainers/javascript-node:0-18@sha256:ed57dd8755b4e75a0426bd10ab1d3a60a22bb21fc2e093801375990978c42fb5
Warn: containerImage not pinned by hash: .gitpod/dev.dockerfile:1: pin your Docker image by updating gitpod/workspace-node to gitpod/workspace-node@sha256:ed977af45c8df79ddeeaf2f615419d7b8f5b842edcafc31d2d5abd897e72ffd9
Warn: npmCommand not pinned by hash: .devcontainer/Dockerfile:22-26
Warn: npmCommand not pinned by hash: .gitpod/dev.dockerfile:14-15
Info: 17 out of 24 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned
Info: 0 out of 2 containerImage dependencies pinned
Info: 0 out of 2 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.9

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @rpai/webdriver

@rpai/webdriverio

1.0.5

Next-gen browser and mobile automation test framework for Node.js

@rpai/wdio-logger

1.0.3

A helper utility for logging of WebdriverIO packages

@rpai/wdio-utils

1.0.3

A WDIO helper utility to provide several utility functions used across the project.

@rpai/wdio-types

1.0.1

Utility package providing type information for a variety of WebdriverIO interfaces