Proposed changes

Recently I noticed a few minor inconsistencies between some WebDriver & Appium protocol endpoints and their WDIO implementations. This PR aims to fix most of them, while also updating relevant documentation:

• setTimeouts: null values should be allowed (ref)

• addVirtualAuthenticator: protocol and transport should be required since they do not have a default value (ref)

  • This could be argued as a breaking change, but I am not sure this endpoint would have worked without providing these properties anyway.

• addCredential: userHandle should be optional and signCount should allow null values (ref)

  • signCount has also been changed to optional to fix TS issues, though it is required according to protocol. I believe this is still better than the other option of incorrectly keeping userHandle as required.

• setUserVerified: missing isUserVerified property (ref)

  • Similarly to addVirtualAuthenticator, might seem like a breaking change, but in practice it is unlikely to have worked without this property.

• installApp/activateApp/removeApp/terminateApp/isAppInstalled/queryAppState: should support bundleId and/or options parameters

• backgroundApp: restoration can be prevented with a -1 value, not null (docs issue)

• getEvents: type can also be string and should be optional

I've also added deprecation marks for all Appium/MJSONWP commands removed in Appium 3, and updated the documentation links for all remaining Appium commands.

There are 2 other Appium endpoints that I have not changed here, as they could be considered breaking:

• getDeviceTime uses the GET endpoint, but Appium also supports the POST endpoint with an optional format property
• stopRecordingScreen should be aligned with startRecordingScreen and only accept a single optional options property

Types of changes

• Polish (an improvement for an existing feature)
• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update (improvements to the project's docs)
• Specification changes (updates to WebDriver command specifications)
• Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

• I have read the CONTRIBUTING doc
• I have added tests that prove my fix is effective or that my feature works
• I have added the necessary documentation (if appropriate)
• I have added proper type definitions for new commands (if appropriate)

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

• This change is solely for v9 and doesn't need to be back-ported
• Back-ported PR at #XXXXX

Further comments

Reviewers: @webdriverio/project-committers