@appium/types 1.0.0-rc.1 → 1.0.1

package/lib/driver.ts

@@ -1,18 +1,30 @@
 import type {EventEmitter} from 'node:events';
 import type {Merge} from 'type-fest';
-import type {ActionSequence} from './action';
-import type {Capabilities, DriverCaps, W3CCapabilities, W3CDriverCaps} from './capabilities';
+import type {Capabilities, DriverCaps, W3CCapabilities} from './capabilities';
 import type {
   BidiModuleMap,
   BiDiResultData,
   ExecuteMethodMap,
   MethodMap,
-} from './command';
+} from './command-maps';
+import type {
+  DefaultCreateSessionResult,
+  DefaultDeleteSessionResult,
+  DriverData,
+  EventHistory,
+  IImplementedCommands,
+  IWDClassicCommands,
+  IAppiumCommands,
+  IJSONWPCommands,
+  IMJSONWPCommands,
+  IOtherProtocolCommands,
+} from './commands';
+import type {Constraints} from './constraints';
 import type {ServerArgs} from './config';
 import type {HTTPHeaders, HTTPMethod} from './http';
 import type {AppiumLogger} from './logger';
 import type {AppiumServer, UpdateServerCallback} from './server';
-import type {Class, Element, StringRecord} from './util';
+import type {Class, StringRecord} from './util';
 import type internal from 'node:stream';
 
 /**
@@ -23,456 +35,6 @@ export interface IDeviceSettings<T extends StringRecord> {
   getSettings(): T;
 }
 
-export interface ITimeoutCommands {
-  /**
-   * Set the various timeouts associated with a session
-   * @see {@link https://w3c.github.io/webdriver/#set-timeouts}
-   *
-   * @param type - used only for the old (JSONWP) command, the type of the timeout
-   * @param ms - used only for the old (JSONWP) command, the ms for the timeout
-   * @param script - the number in ms for the script timeout, used for the W3C command
-   * @param pageLoad - the number in ms for the pageLoad timeout, used for the W3C command
-   * @param implicit - the number in ms for the implicit wait timeout, used for the W3C command
-   */
-  timeouts(
-    type?: string,
-    ms?: number | string,
-    script?: number,
-    pageLoad?: number,
-    implicit?: number | string,
-  ): Promise<void>;
-
-  /**
-   * Set the new command timeout
-   *
-   * @param ms - the timeout in ms
-   */
-  setNewCommandTimeout(ms: number): void;
-
-  /**
-   * A helper method (not a command) used to set the implicit wait value
-   *
-   * @param ms - the implicit wait in ms
-   */
-  setImplicitWait(ms: number): void;
-
-  /**
-   * Periodically retry an async function up until the currently set implicit wait timeout
-   *
-   * @param condition - the behaviour to retry until it returns truthy
-   *
-   * @returns The return value of the condition
-   */
-  implicitWaitForCondition(condition: (...args: any[]) => Promise<any>): Promise<unknown>;
-
-  /**
-   * Get the current timeouts
-   * @see {@link https://w3c.github.io/webdriver/#get-timeouts}
-   *
-   * @returns A map of timeout names to ms values
-   */
-  getTimeouts(): Promise<Record<string, number>>;
-
-  /**
-   * Set the implicit wait value that was sent in via the W3C protocol
-   *
-   * @param ms - the timeout in ms
-   */
-  implicitWaitW3C(ms: number): Promise<void>;
-
-  /**
-   * Set the page load timeout value that was sent in via the W3C protocol
-   *
-   * @param ms - the timeout in ms
-   */
-  pageLoadTimeoutW3C(ms: number): Promise<void>;
-
-  /**
-   * Set the script timeout value that was sent in via the W3C protocol
-   *
-   * @param ms - the timeout in ms
-   */
-  scriptTimeoutW3C(ms: number): Promise<void>;
-
-  /**
-   * Set Appium's new command timeout
-   *
-   * @param ms - the timeout in ms
-   */
-  newCommandTimeout(ms: number): Promise<void>;
-
-  /**
-   * Get a timeout value from a number or a string
-   *
-   * @param ms - the timeout value as a number or a string
-   *
-   * @returns The timeout as a number in ms
-   */
-  parseTimeoutArgument(ms: number | string): number;
-}
-
-export interface IEventCommands {
-  /**
-   * Add a custom-named event to the Appium event log
-   *
-   * @param vendor - the name of the vendor or tool the event belongs to, to namespace the event
-   * @param event - the name of the event itself
-   */
-  logCustomEvent(vendor: string, event: string): Promise<void>;
-
-  /**
-   * Get a list of events that have occurred in the current session
-   *
-   * @param type - filter the returned events by including one or more types
-   *
-   * @returns The event history for the session
-   */
-  getLogEvents(type?: string | string[]): Promise<EventHistory | Record<string, number>>;
-}
-
-export interface IExecuteCommands {
-  /**
-   * Call an `Execute Method` by its name with the given arguments. This method will check that the
-   * driver has registered the method matching the name, and send it the arguments.
-   *
-   * @param script - the name of the Execute Method
-   * @param args - a singleton array containing an arguments object
-   *
-   * @returns The result of calling the Execute Method
-   */
-  executeMethod<
-    TArgs extends readonly any[] | readonly [StringRecord<unknown>] = unknown[],
-    TReturn = unknown,
-  >(
-    script: string,
-    args: TArgs,
-  ): Promise<TReturn>;
-}
-
-/**
- * Data returned by `AppiumDriver.getAppiumSessions`
- *
- * @typeParam C - The driver's constraints
- */
-export interface TimestampedMultiSessionData<C extends Constraints = Constraints> {
-  id: string;
-  created: number; // Unix timestamp in milliseconds
-  capabilities: DriverCaps<C>;
-}
-
-/**
- * Data returned by {@linkcode ISessionHandler.getSession}.
- *
- * @typeParam C - The driver's constraints
- * @typeParam T - Any extra data the driver stuffs in here
- * @privateRemarks The content of this object looks implementation-specific and in practice is not well-defined.  It's _possible_ to fully type this in the future.
- */
-export type SingularSessionData<
-  C extends Constraints = Constraints,
-  T extends StringRecord = StringRecord,
-> = DriverCaps<C> & {
-  events?: EventHistory;
-  error?: string;
-} & T;
-
-/**
- * Data returned by {@linkcode ISessionCommands.getAppiumSessionCapabilities}.
- *
- * @typeParam C - The driver's constraints
- * @typeParam T - Any extra data the driver stuffs in here
- */
-export type SessionCapabilities<
-  C extends Constraints = Constraints,
-  T extends StringRecord = StringRecord,
-> = {
-  capabilities: DriverCaps<C>;
-} & T;
-
-export interface IFindCommands {
-  /**
-   * Find a UI element given a locator strategy and a selector, erroring if it can't be found
-   * @see {@link https://w3c.github.io/webdriver/#find-element}
-   *
-   * @param strategy - the locator strategy
-   * @param selector - the selector to combine with the strategy to find the specific element
-   *
-   * @returns The element object encoding the element id which can be used in element-related
-   * commands
-   */
-  findElement(strategy: string, selector: string): Promise<Element>;
-
-  /**
-   * Find a a list of all UI elements matching a given a locator strategy and a selector
-   * @see {@link https://w3c.github.io/webdriver/#find-elements}
-   *
-   * @param strategy - the locator strategy
-   * @param selector - the selector to combine with the strategy to find the specific elements
-   *
-   * @returns A possibly-empty list of element objects
-   */
-  findElements(strategy: string, selector: string): Promise<Element[]>;
-
-  /**
-   * Find a UI element given a locator strategy and a selector, erroring if it can't be found. Only
-   * look for elements among the set of descendants of a given element
-   * @see {@link https://w3c.github.io/webdriver/#find-element-from-element}
-   *
-   * @param strategy - the locator strategy
-   * @param selector - the selector to combine with the strategy to find the specific element
-   * @param elementId - the id of the element to use as the search basis
-   *
-   * @returns The element object encoding the element id which can be used in element-related
-   * commands
-   */
-  findElementFromElement(strategy: string, selector: string, elementId: string): Promise<Element>;
-
-  /**
-   * Find a a list of all UI elements matching a given a locator strategy and a selector. Only
-   * look for elements among the set of descendants of a given element
-   * @see {@link https://w3c.github.io/webdriver/#find-elements-from-element}
-   *
-   * @param strategy - the locator strategy
-   * @param selector - the selector to combine with the strategy to find the specific elements
-   * @param elementId - the id of the element to use as the search basis
-   *
-   * @returns A possibly-empty list of element objects
-   */
-  findElementsFromElement(
-    strategy: string,
-    selector: string,
-    elementId: string,
-  ): Promise<Element[]>;
-
-  /**
-   * Find an element from a shadow root
-   * @see {@link https://w3c.github.io/webdriver/#find-element-from-shadow-root}
-   * @param strategy - the locator strategy
-   * @param selector - the selector to combine with the strategy to find the specific elements
-   * @param shadowId - the id of the element to use as the search basis
-   *
-   * @returns The element inside the shadow root matching the selector
-   */
-  findElementFromShadowRoot?(
-    strategy: string,
-    selector: string,
-    shadowId: string,
-  ): Promise<Element>;
-
-  /**
-   * Find elements from a shadow root
-   * @see {@link https://w3c.github.io/webdriver/#find-element-from-shadow-root}
-   * @param strategy - the locator strategy
-   * @param selector - the selector to combine with the strategy to find the specific elements
-   * @param shadowId - the id of the element to use as the search basis
-   *
-   * @returns A possibly empty list of elements inside the shadow root matching the selector
-   */
-  findElementsFromShadowRoot?(
-    strategy: string,
-    selector: string,
-    shadowId: string,
-  ): Promise<Element[]>;
-
-  /**
-   * A helper method that returns one or more UI elements based on the search criteria
-   *
-   * @param strategy - the locator strategy
-   * @param selector - the selector
-   * @param mult - whether or not we want to find multiple elements
-   * @param context - the element to use as the search context basis if desiredCapabilities
-   *
-   * @returns A single element or list of elements
-   */
-  findElOrEls(strategy: string, selector: string, mult: true, context?: any): Promise<Element[]>;
-  findElOrEls(strategy: string, selector: string, mult: false, context?: any): Promise<Element>;
-
-  /**
-   * This is a wrapper for {@linkcode findElOrEls} that validates locator strategies
-   * and implements the `appium:printPageSourceOnFindFailure` capability
-   *
-   * @param strategy - the locator strategy
-   * @param selector - the selector
-   * @param mult - whether or not we want to find multiple elements
-   * @param context - the element to use as the search context basis if desiredCapabilities
-   *
-   * @returns A single element or list of elements
-   */
-  findElOrElsWithProcessing(
-    strategy: string,
-    selector: string,
-    mult: true,
-    context?: any,
-  ): Promise<Element[]>;
-  findElOrElsWithProcessing(
-    strategy: string,
-    selector: string,
-    mult: false,
-    context?: any,
-  ): Promise<Element>;
-
-  /**
-   * Get the current page/app source as HTML/XML
-   * @see {@link https://w3c.github.io/webdriver/#get-page-source}
-   *
-   * @returns The UI hierarchy in a platform-appropriate format (e.g., HTML for a web page)
-   */
-  getPageSource(): Promise<string>;
-}
-
-export interface ILogCommands {
-  /**
-   * Definition of the available log types
-   */
-  supportedLogTypes: Readonly<LogDefRecord>;
-
-  /**
-   * Get available log types as a list of strings
-   */
-  getLogTypes(): Promise<string[]>;
-
-  /**
-   * Get the log for a given log type.
-   *
-   * @param logType - Name/key of log type as defined in {@linkcode ILogCommands.supportedLogTypes}.
-   */
-  getLog(logType: string): Promise<any>;
-}
-
-export interface IBidiCommands {
-  bidiSubscribe(events: string[], contexts: string[]): Promise<void>;
-  bidiUnsubscribe(events: string[], contexts: string[]): Promise<void>;
-  bidiStatus(): Promise<DriverStatus>;
-}
-
-/**
- * A record of {@linkcode LogDef} objects, keyed by the log type name.
- * Used in {@linkcode ILogCommands.supportedLogTypes}
- */
-export type LogDefRecord = Record<string, LogDef>;
-
-/**
- * A definition of a log type
- */
-export interface LogDef {
-  /**
-   * Description of the log type.
-   *
-   * The only place this is used is in error messages if the client provides an invalid log type
-   * via {@linkcode ILogCommands.getLog}.
-   */
-  description: string;
-  /**
-   * Returns all the log data for the given type
-   *
-   * This implementation *should* drain, truncate or otherwise reset the log buffer.
-   */
-  getter: (driver: any) => Promise<unknown> | unknown;
-}
-
-export interface ISettingsCommands<T extends object = object> {
-  /**
-   * Update the session's settings dictionary with a new settings object
-   *
-   * @param settings - A key-value map of setting names to values. Settings not named in the map
-   * will not have their value adjusted.
-   */
-  updateSettings: (settings: T) => Promise<void>;
-
-  /**
-   * Get the current settings for the session
-   *
-   * @returns The settings object
-   */
-  getSettings(): Promise<T>;
-}
-
-/**
- * @see {@linkcode ISessionHandler}
- */
-export type DefaultCreateSessionResult<C extends Constraints> = [
-  sessionId: string,
-  capabilities: DriverCaps<C>,
-];
-
-/**
- * @see {@linkcode ISessionHandler}
- */
-export type DefaultDeleteSessionResult = void;
-
-/**
- * An interface which creates and deletes sessions.
- */
-export interface ISessionHandler<
-  C extends Constraints = Constraints,
-  CreateResult = DefaultCreateSessionResult<C>,
-  DeleteResult = DefaultDeleteSessionResult,
-  SessionData extends StringRecord = StringRecord,
-> {
-  /**
-   * Start a new automation session
-   * @see {@link https://w3c.github.io/webdriver/#new-session}
-   *
-   * @privateRemarks
-   * The shape of this method is strange because it used to support both JSONWP and W3C
-   * capabilities. This will likely change in the future to simplify.
-   *
-   * @param w3cCaps1 - the new session capabilities
-   * @param w3cCaps2 - another place the new session capabilities could be sent (typically left undefined)
-   * @param w3cCaps3 - another place the new session capabilities could be sent (typically left undefined)
-   * @param driverData - a list of DriverData objects representing other sessions running for this
-   * driver on the same Appium server. This information can be used to help ensure no conflict of
-   * resources
-   *
-   * @returns The capabilities object representing the created session
-   */
-  createSession(
-    w3cCaps1: W3CDriverCaps<C>,
-    w3cCaps2?: W3CDriverCaps<C>,
-    w3cCaps3?: W3CDriverCaps<C>,
-    driverData?: DriverData[],
-  ): Promise<CreateResult>;
-
-  /**
-   * Stop an automation session
-   * @see {@link https://w3c.github.io/webdriver/#delete-session}
-   *
-   * @param sessionId - the id of the session that is to be deleted
-   * @param driverData - the driver data for other currently-running sessions
-   */
-  deleteSession(sessionId?: string, driverData?: DriverData[]): Promise<DeleteResult | void>;
-
-  /**
-   * Get the data for the current session
-   *
-   * @returns A session data object
-   */
-  getSession(): Promise<SingularSessionData<C, SessionData>>;
-}
-
-/**
- * Custom session data for a driver.
- */
-export type DriverData = Record<string, unknown>;
-
-export interface Constraint {
-  readonly presence?: boolean | Readonly<{allowEmpty: boolean}>;
-  readonly isString?: boolean;
-  readonly isNumber?: boolean;
-  readonly isBoolean?: boolean;
-  readonly isObject?: boolean;
-  readonly isArray?: boolean;
-  readonly deprecated?: boolean;
-  readonly inclusion?: Readonly<[string, ...string[]]>;
-  readonly inclusionCaseInsensitive?: Readonly<[string, ...string[]]>;
-}
-
-/**
- * A collection of constraints describing the allowed capabilities for a driver.
- */
-export type Constraints = {
-  readonly [name: string]: Constraint;
-};
-
 export interface DriverHelpers {
   configureApp: (
     app: string,
@@ -490,83 +52,8 @@ export type SettingsUpdateListener<T extends Record<string, unknown> = Record<st
   curValue: unknown,
 ) => Promise<void>;
 
-// WebDriver
-
-export interface Rect {
-  x: number;
-  y: number;
-  width: number;
-  height: number;
-}
-
-export type NewWindowType = 'tab' | 'window';
-
-export interface NewWindow {
-  handle: string;
-  type: NewWindowType;
-}
-
-export interface Cookie {
-  name: string;
-  value: string;
-  path?: string;
-  domain?: string;
-  secure?: boolean;
-  httpOnly?: boolean;
-  expiry?: number;
-  sameSite?: 'Lax' | 'Strict';
-}
-
-// JSONWP
-export type Size = Pick<Rect, 'width' | 'height'>;
-
-export type Position = Pick<Rect, 'x' | 'y'>;
-
-export interface Location {
-  latitude: number;
-  longitude: number;
-  altitude?: number;
-}
-
-export interface Rotation {
-  x: number;
-  y: number;
-  z: number;
-}
-
-// Web Authentication
-
-export interface Credential {
-  credentialId: string;
-  isResidentCredential: boolean;
-  rpId: string;
-  privateKey: string;
-  userHandle?: string;
-  signCount: number;
-  largeBlob?: string;
-}
-
-export type Orientation = 'LANDSCAPE' | 'PORTRAIT';
-
-export interface EventHistory {
-  commands: EventHistoryCommand[];
-  [key: string]: any;
-}
-
-export interface EventHistoryCommand {
-  cmd: string;
-  startTime: number;
-  endTime: number;
-}
-
 export type Protocol = 'MJSONWP' | 'W3C';
 
-export interface DriverStatus {
-  ready: boolean,
-  message: string,
-  [key: string]: any;
-}
-
 /**
  * Methods and properties which both `AppiumDriver` and `BaseDriver` inherit.
  *
@@ -662,13 +149,7 @@ export interface Driver<
   CreateResult = DefaultCreateSessionResult<C>,
   DeleteResult = DefaultDeleteSessionResult,
   SessionData extends StringRecord = StringRecord,
-> extends ILogCommands,
-    IFindCommands,
-    ISettingsCommands<Settings>,
-    ITimeoutCommands,
-    IEventCommands,
-    IExecuteCommands,
-    ISessionHandler<C, CreateResult, DeleteResult, SessionData>,
+> extends IImplementedCommands<C, Settings, CreateResult, DeleteResult, SessionData>,
     Core<C, Settings> {
   /**
    * The set of command line arguments set for this driver
@@ -773,8 +254,8 @@ export interface Driver<
 }
 
 /**
- * External drivers must subclass `BaseDriver`, and can implement any of these methods.
- * None of these are implemented within Appium itself.
+ * External drivers must subclass `BaseDriver`, and can implement any methods from this interface.
+ * None of these methods are implemented within Appium itself.
  */
 export interface ExternalDriver<
   C extends Constraints = Constraints,
@@ -784,747 +265,12 @@ export interface ExternalDriver<
   CreateResult = DefaultCreateSessionResult<C>,
   DeleteResult = DefaultDeleteSessionResult,
   SessionData extends StringRecord = StringRecord,
-> extends Driver<C, CArgs, Settings, CreateResult, DeleteResult, SessionData> {
-  // WebDriver spec commands
-
-  /**
-   * Navigate to a given url
-   * @see {@link https://w3c.github.io/webdriver/#navigate-to}
-   *
-   * @param url - the url
-   */
-  setUrl?(url: string): Promise<void>;
-
-  /**
-   * Get the current url
-   * @see {@link https://w3c.github.io/webdriver/#get-current-url}
-   *
-   * @returns The url
-   */
-  getUrl?(): Promise<string>;
-
-  /**
-   * Navigate back in the page history
-   * @see {@link https://w3c.github.io/webdriver/#back}
-   */
-  back?(): Promise<void>;
-
-  /**
-   * Navigate forward in the page history
-   * @see {@link https://w3c.github.io/webdriver/#forward}
-   */
-  forward?(): Promise<void>;
-
-  /**
-   * Refresh the page
-   * @see {@link https://w3c.github.io/webdriver/#refresh}
-   */
-  refresh?(): Promise<void>;
-
-  /**
-   * Get the current page title
-   * @see {@link https://w3c.github.io/webdriver/#get-title}
-   *
-   * @returns The title
-   *
-   * @example
-   * ```js
-   * await driver.getTitle()
-   * ```
-   * ```py
-   * driver.title
-   * ```
-   * ```java
-   * driver.getTitle();
-   * ```
-   */
-  title?(): Promise<string>;
-
-  /**
-   * Get the handle (id) associated with the current browser window
-   * @see {@link https://w3c.github.io/webdriver/#get-window-handle}
-   *
-   * @returns The handle string
-   */
-  getWindowHandle?(): Promise<string>;
-
-  /**
-   * Close the current browsing context (window)
-   * @see {@link https://w3c.github.io/webdriver/#close-window}
-   *
-   * @returns An array of window handles representing currently-open windows
-   */
-  closeWindow?(): Promise<string[]>;
-
-  /**
-   * Switch to a specified window
-   * @see {@link https://w3c.github.io/webdriver/#switch-to-window}
-   *
-   * @param handle - the window handle of the window to make active
-   */
-  setWindow?(handle: string): Promise<void>;
-
-  /**
-   * Get a set of handles representing open browser windows
-   * @see {@link https://w3c.github.io/webdriver/#get-window-handles}
-   *
-   * @returns An array of window handles representing currently-open windows
-   */
-  getWindowHandles?(): Promise<string[]>;
-
-  /**
-   * Create a new browser window
-   * @see {@link https://w3c.github.io/webdriver/#new-window}
-   *
-   * @param type - a hint to the driver whether to create a "tab" or "window"
-   *
-   * @returns An object containing the handle of the newly created window and its type
-   */
-  createNewWindow?(type?: NewWindowType): Promise<NewWindow>;
-
-  /**
-   * Switch the current browsing context to a frame
-   * @see {@link https://w3c.github.io/webdriver/#switch-to-frame}
-   *
-   * @param id - the frame id, index, or `null` (indicating the top-level context)
-   */
-  setFrame?(id: null | number | string): Promise<void>;
-
-  /**
-   * Set the current browsing context to the parent of the current context
-   * @see {@link https://w3c.github.io/webdriver/#switch-to-parent-frame}
-   */
-  switchToParentFrame?(): Promise<void>;
-
-  /**
-   * Get the size and position of the current window
-   * @see {@link https://w3c.github.io/webdriver/#get-window-rect}
-   *
-   * @returns A `Rect` JSON object with x, y, width, and height properties
-   */
-  getWindowRect?(): Promise<Rect>;
-
-  /**
-   * Set the current window's size and position
-   * @see {@link https://w3c.github.io/webdriver/#set-window-rect}
-   *
-   * @param x - the screen coordinate for the new left edge of the window
-   * @param y - the screen coordinate for the new top edge of the window
-   * @param width - the width in pixels to resize the window to
-   * @param height - the height in pixels to resize the window to
-   *
-   * @returns The actual `Rect` of the window after running the command
-   */
-  setWindowRect?(x: number, y: number, width: number, height: number): Promise<Rect>;
-
-  /**
-   * Run the window-manager specific 'maximize' operation on the current window
-   * @see {@link https://w3c.github.io/webdriver/#maximize-window}
-   *
-   * @returns The actual `Rect` of the window after running the command
-   */
-  maximizeWindow?(): Promise<Rect>;
-
-  /**
-   * Run the window-manager specific 'minimize' operation on the current window
-   * @see {@link https://w3c.github.io/webdriver/#minimize-window}
-   *
-   * @returns The actual `Rect` of the window after running the command
-   */
-  minimizeWindow?(): Promise<Rect>;
-
-  /**
-   * Put the current window into full screen mode
-   * @see {@link https://w3c.github.io/webdriver/#fullscreen-window}
-   *
-   * @returns The actual `Rect` of the window after running the command
-   */
-  fullScreenWindow?(): Promise<Rect>;
-
-  /**
-   * Get the active element
-   * @see {@link https://w3c.github.io/webdriver/#get-active-element}
-   *
-   * @returns The JSON object encapsulating the active element reference
-   */
-  active?(): Promise<Element>;
-
-  /**
-   * Get the shadow root of an element
-   * @see {@link https://w3c.github.io/webdriver/#get-element-shadow-root}
-   *
-   * @param elementId - the id of the element to retrieve the shadow root for
-   *
-   * @returns The shadow root for an element, as an element
-   */
-  elementShadowRoot?(elementId: string): Promise<Element>;
-
-  /**
-   * Determine if the reference element is selected or not
-   * @see {@link https://w3c.github.io/webdriver/#is-element-selected}
-   *
-   * @param elementId - the id of the element
-   *
-   * @returns True if the element is selected, False otherwise
-   */
-  elementSelected?(elementId: string): Promise<boolean>;
-
-  /**
-   * Retrieve the value of an element's attribute
-   * @see {@link https://w3c.github.io/webdriver/#get-element-attribute}
-   *
-   * @param name - the attribute name
-   * @param elementId - the id of the element
-   *
-   * @returns The attribute value
-   */
-  getAttribute?(name: string, elementId: string): Promise<string | null>;
-
-  /**
-   * Retrieve the value of a named property of an element's JS object
-   * @see {@link https://w3c.github.io/webdriver/#get-element-property}
-   *
-   * @param name - the object property name
-   * @param elementId - the id of the element
-   *
-   * @returns The property value
-   */
-  getProperty?(name: string, elementId: string): Promise<string | null>;
-
-  /**
-   * Retrieve the value of a CSS property of an element
-   * @see {@link https://w3c.github.io/webdriver/#get-element-css-value}
-   *
-   * @param name - the CSS property name
-   * @param elementId - the id of the element
-   *
-   * @returns The property value
-   */
-  getCssProperty?(name: string, elementId: string): Promise<string>;
-
-  /**
-   * Get the text of an element as rendered
-   * @see {@link https://w3c.github.io/webdriver/#get-element-text}
-   *
-   * @param elementId - the id of the element
-   *
-   * @returns The text rendered for the element
-   */
-  getText?(elementId: string): Promise<string>;
-
-  /**
-   * Get the tag name of an element
-   * @see {@link https://w3c.github.io/webdriver/#get-element-tag-name}
-   *
-   * @param elementId - the id of the element
-   *
-   * @returns The tag name
-   */
-  getName?(elementId: string): Promise<string>;
-
-  /**
-   * Get the dimensions and position of an element
-   * @see {@link https://w3c.github.io/webdriver/#get-element-rect}
-   *
-   * @param elementId - the id of the element
-   *
-   * @returns The Rect object containing x, y, width, and height properties
-   */
-  getElementRect?(elementId: string): Promise<Rect>;
-
-  /**
-   * Determine whether an element is enabled
-   * @see {@link https://w3c.github.io/webdriver/#is-element-enabled}
-   *
-   * @param elementId - the id of the element
-   *
-   * @returns True if the element is enabled, False otherwise
-   */
-  elementEnabled?(elementId: string): Promise<boolean>;
-
-  /**
-   * Get the WAI-ARIA role of an element
-   * @see {@link https://w3c.github.io/webdriver/#get-computed-role}
-   *
-   * @param elementId - the id of the element
-   *
-   * @returns The role
-   */
-  getComputedRole?(elementId: string): Promise<string | null>;
-
-  /**
-   * Get the accessible name/label of an element
-   * @see {@link https://w3c.github.io/webdriver/#get-computed-label}
-   *
-   * @param elementId - the id of the element
-   *
-   * @returns The accessible name
-   */
-  getComputedLabel?(elementId: string): Promise<string | null>;
-
-  /**
-   * Determine whether an element is displayed
-   * @see {@link https://w3c.github.io/webdriver/#element-displayedness}
-   *
-   * @param elementId - the id of the element
-   *
-   * @returns True if any part of the element is rendered within the viewport, False otherwise
-   */
-  elementDisplayed?(elementId: string): Promise<boolean>;
-
-  /**
-   * Click/tap an element
-   * @see {@link https://w3c.github.io/webdriver/#element-click}
-   *
-   * @param elementId - the id of the element
-   */
-  click?(elementId: string): Promise<void>;
-
-  /**
-   * Clear the text/value of an editable element
-   * @see {@link https://w3c.github.io/webdriver/#element-clear}
-   *
-   * @param elementId - the id of the element
-   */
-  clear?(elementId: string): Promise<void>;
-
-  /**
-   * Send keystrokes to an element (or otherwise set its value)
-   * @see {@link https://w3c.github.io/webdriver/#element-send-keys}
-   *
-   * @param text - the text to send to the element
-   * @param elementId - the id of the element
-   */
-  setValue?(text: string, elementId: string): Promise<void>;
-
-  /**
-   * Execute JavaScript (or some other kind of script) in the browser/app context
-   * @see {@link https://w3c.github.io/webdriver/#execute-script}
-   *
-   * @param script - the string to be evaluated as the script, which will be made the body of an
-   * anonymous function in the case of JS
-   * @param args - the list of arguments to be applied to the script as a function
-   *
-   * @returns The return value of the script execution
-   */
-  execute?(script: string, args: unknown[]): Promise<unknown>;
-
-  /**
-   * Execute JavaScript (or some other kind of script) in the browser/app context, asynchronously
-   * @see {@link https://w3c.github.io/webdriver/#execute-async-script}
-   *
-   * @param script - the string to be evaluated as the script, which will be made the body of an
-   * anonymous function in the case of JS
-   * @param args - the list of arguments to be applied to the script as a function
-   *
-   * @returns The promise resolution of the return value of the script execution (or an error
-   * object if the promise is rejected)
-   */
-  executeAsync?(script: string, args: unknown[]): Promise<unknown>;
-
-  /**
-   * Get all cookies known to the browsing context
-   * @see {@link https://w3c.github.io/webdriver/#get-all-cookies}
-   *
-   * @returns A list of serialized cookies
-   */
-  getCookies?(): Promise<Cookie[]>;
-
-  /**
-   * Get a cookie by name
-   * @see {@link https://w3c.github.io/webdriver/#get-named-cookie}
-   *
-   * @param name - the name of the cookie
-   *
-   * @returns A serialized cookie
-   */
-  getCookie?(name: string): Promise<Cookie>;
-
-  /**
-   * Add a cookie to the browsing context
-   * @see {@link https://w3c.github.io/webdriver/#add-cookie}
-   *
-   * @param cookie - the cookie data including properties like name, value, path, domain,
-   * secure, httpOnly, expiry, and samesite
-   */
-  setCookie?(cookie: Cookie): Promise<void>;
-
-  /**
-   * Delete a named cookie
-   * @see {@link https://w3c.github.io/webdriver/#delete-cookie}
-   *
-   * @param name - the name of the cookie to delete
-   */
-  deleteCookie?(name: string): Promise<void>;
-
-  /**
-   * Delete all cookies
-   * @see {@link https://w3c.github.io/webdriver/#delete-all-cookies}
-   */
-  deleteCookies?(): Promise<void>;
-
-  /**
-   * Perform touch or keyboard actions
-   * @see {@link https://w3c.github.io/webdriver/#perform-actions}
-   *
-   * @param actions - the action sequence
-   */
-  performActions?(actions: ActionSequence[]): Promise<void>;
-
-  /**
-   * Release all keys or buttons that are currently pressed
-   * @see {@link https://w3c.github.io/webdriver/#release-actions}
-   */
-  releaseActions?(): Promise<void>;
-
-  /**
-   * Dismiss a simple dialog/alert
-   * @see {@link https://w3c.github.io/webdriver/#dismiss-alert}
-   */
-  postDismissAlert?(): Promise<void>;
-
-  /**
-   * Accept a simple dialog/alert
-   * @see {@link https://w3c.github.io/webdriver/#accept-alert}
-   */
-  postAcceptAlert?(): Promise<void>;
-
-  /**
-   * Get the text of the displayed alert
-   * @see {@link https://w3c.github.io/webdriver/#get-alert-text}
-   *
-   * @returns The text of the alert
-   */
-  getAlertText?(): Promise<string | null>;
-
-  /**
-   * Set the text field of an alert prompt
-   * @see {@link https://w3c.github.io/webdriver/#send-alert-text}
-   *
-   * @param text - the text to send to the prompt
-   */
-  setAlertText?(text: string): Promise<void>;
-
-  /**
-   * Get a screenshot of the current document as rendered
-   * @see {@link https://w3c.github.io/webdriver/#take-screenshot}
-   *
-   * @returns A base64-encoded string representing the PNG image data
-   */
-  getScreenshot?(): Promise<string>;
-
-  /**
-   * Get an image of a single element as rendered on screen
-   * @see {@link https://w3c.github.io/webdriver/#take-element-screenshot}
-   *
-   * @param elementId - the id of the element
-   *
-   * @returns A base64-encoded string representing the PNG image data for the element rect
-   */
-  getElementScreenshot?(elementId: string): Promise<string>;
-
-  // Appium W3C WebDriver Extension
-
-  /**
-   * Get the current time on the device under timeouts
-   *
-   * @param format - the date/time format you would like the response into
-   *
-   * @returns The formatted time
-   */
-  getDeviceTime?(format?: string): Promise<string>;
-
-  /**
-   * Install an app on a device
-   *
-   * @param appPath - the absolute path to a local app or a URL of a downloadable app bundle
-   * @param options - driver-specific install options
-   */
-  installApp?(appPath: string, options?: unknown): Promise<void>;
-
-  /**
-   * Launch an app
-   *
-   * @param appId - the package or bundle ID of the application
-   * @param options - driver-specific launch options
-   */
-  activateApp?(appId: string, options?: unknown): Promise<void>;
-
-  /**
-   * Remove / uninstall an app
-   *
-   * @param appId - the package or bundle ID of the application
-   * @param options - driver-specific launch options
-   *
-   * @returns `true` if successful
-   */
-  removeApp?(appId: string, options?: unknown): Promise<boolean>;
-
-  /**
-   * Quit / terminate / stop a running application
-   *
-   * @param appId - the package or bundle ID of the application
-   * @param options - driver-specific launch options
-   */
-  terminateApp?(appId: string, options?: unknown): Promise<boolean>;
-
-  /**
-   * Determine whether an app is installed
-   *
-   * @param appId - the package or bundle ID of the application
-   */
-  isAppInstalled?(appId: string): Promise<boolean>;
-
-  /**
-   * Get the running state of an app
-   *
-   * @param appId - the package or bundle ID of the application
-   *
-   * @returns A number representing the state. `0` means not installed, `1` means not running, `2`
-   * means running in background but suspended, `3` means running in the background, and `4` means
-   * running in the foreground
-   */
-  queryAppState?(appId: string): Promise<0 | 1 | 2 | 3 | 4>;
-
-  /**
-   * Attempt to hide a virtual keyboard
-   *
-   * @param strategy - the driver-specific name of a hiding strategy to follow
-   * @param key - the text of a key to use to hide the keyboard
-   * @param keyCode - a key code to trigger to hide the keyboard
-   * @param keyName - the name of a key to use to hide the keyboard
-   *
-   * @returns Whether the keyboard was successfully hidden. May never return `false` on some platforms
-   */
-  hideKeyboard?(
-    strategy?: string,
-    key?: string,
-    keyCode?: string,
-    keyName?: string,
-  ): Promise<boolean>;
-
-  /**
-   * Determine whether the keyboard is shown
-   *
-   * @returns Whether the keyboard is shown
-   */
-  isKeyboardShown?(): Promise<boolean>;
-
-  /**
-   * Push data to a file at a remote path on the device
-   *
-   * @param path - the remote path on the device to create the file at
-   * @param data - the base64-encoded data which will be decoded and written to `path`
-   */
-  pushFile?(path: string, data: string): Promise<void>;
-
-  /**
-   * Retrieve the data from a file on the device at a given path
-   *
-   * @param path - the remote path on the device to pull file data from
-   *
-   * @returns The base64-encoded file data
-   */
-  pullFile?(path: string): Promise<string>;
-
-  /**
-   * Retrieve the data from a folder on the device at a given path
-   *
-   * @param path - the remote path of a directory on the device
-   *
-   * @returns The base64-encoded zip file of the directory contents
-   */
-  pullFolder?(path: string): Promise<string>;
-
-  /**
-   * Get the device orientation
-   *
-   * @returns The orientation string
-   */
-  getOrientation?(): Promise<string>;
-
-  /**
-   * Set the device orientation
-   *
-   * @param orientation - the orientation string
-   */
-  setOrientation?(orientation: string): Promise<void>;
-
-  /**
-   * Get the virtual or real geographical location of a device
-   *
-   * @returns The location
-   */
-  getGeoLocation?(): Promise<Location>;
-
-  /**
-   * Set the virtual geographical location of a device
-   *
-   * @param location - the location including latitude and longitude
-   * @returns The complete location
-   */
-  setGeoLocation?(location: Partial<Location>): Promise<Location>;
-
-  // MJSONWIRE
-
-  /**
-   * Get the currently active context
-   * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts}
-   *
-   * @returns The context name
-   */
-  getCurrentContext?(): Promise<Ctx | null>;
-
-  /**
-   * Switch to a context by name
-   * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts}
-   *
-   * @param name - the context name
-   */
-  setContext?(name: string, ...args: any[]): Promise<void>;
-
-  /**
-   * Get the list of available contexts
-   * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts}
-   *
-   * @returns The list of context names
-   */
-  getContexts?(): Promise<Ctx[]>;
-
-  /**
-   * Get the network connection state of a device
-   * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes}
-   *
-   * @returns A number which is a bitmask representing categories like Data, Wifi, and Airplane
-   * mode status
-   */
-  getNetworkConnection?(): Promise<number>;
-
-  /**
-   * Set the network connection of the device
-   * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes}
-   *
-   * @param type - the bitmask representing network state
-   * @returns A number which is a bitmask representing categories like Data, Wifi, and Airplane
-   * mode status
-   */
-  setNetworkConnection?(type: number): Promise<number>;
-
-  /**
-   * Get the current rotation state of the device
-   * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation}
-   *
-   * @returns The Rotation object consisting of x, y, and z rotation values (0 <= n <= 360)
-   */
-  getRotation?(): Promise<Rotation>;
-
-  /**
-   * Set the device rotation state
-   * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation}
-   *
-   * @param x - the degree to which the device is rotated around the x axis (0 <= x <= 360)
-   * @param y - the degree to which the device is rotated around the y axis (0 <= y <= 360)
-   * @param z - the degree to which the device is rotated around the z axis (0 <= z <= 360)
-   */
-  setRotation?(x: number, y: number, z: number): Promise<void>;
-
-  // Chromium DevTools
-
-  /**
-   * Execute a devtools command
-   *
-   * @param cmd - the command
-   * @param params - any command-specific command parameters
-   *
-   * @returns The result of the command execution
-   */
-  executeCdp?(cmd: string, params: unknown): Promise<unknown>;
-
-  // Web Authentication
-
-  /**
-   * Add a virtual authenticator to a browser
-   * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-add-virtual-authenticator}
-   *
-   * @param protocol  - the protocol
-   * @param transport - a valid AuthenticatorTransport value
-   * @param hasResidentKey - whether there is a resident key
-   * @param hasUserVerification - whether the authenticator has user verification
-   * @param isUserConsenting - whether it is a user consenting authenticator
-   * @param isUserVerified - whether the user is verified
-   *
-   * @returns The authenticator ID
-   */
-  addVirtualAuthenticator?(
-    protocol: 'ctap/u2f' | 'ctap2' | 'ctap2_1',
-    transport: string,
-    hasResidentKey?: boolean,
-    hasUserVerification?: boolean,
-    isUserConsenting?: boolean,
-    isUserVerified?: boolean,
-  ): Promise<string>;
-
-  /**
-   * Remove a virtual authenticator
-   * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-virtual-authenticator}
-   *
-   * @param authenticatorId - the ID returned in the call to add the authenticator
-   */
-  removeVirtualAuthenticator?(authenticatorId: string): Promise<void>;
-
-  /**
-   * Inject a public key credential source into a virtual authenticator
-   * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-add-credential}
-   *
-   * @param credentialId - the base64 encoded credential ID
-   * @param isResidentCredential - if true, a client-side credential, otherwise a server-side
-   * credential
-   * @param rpId - the relying party ID the credential is scoped to
-   * @param privateKey - the base64 encoded private key package
-   * @param userHandle - the base64 encoded user handle
-   * @param signCount - the initial value for a signature counter
-   */
-  addAuthCredential?(
-    credentialId: string,
-    isResidentCredential: boolean,
-    rpId: string,
-    privateKey: string,
-    userHandle: string,
-    signCount: number,
-    authenticatorId: string,
-  ): Promise<void>;
-
-  /**
-   * Get the list of public key credential sources
-   * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-get-credentials}
-   *
-   * @returns The list of Credentials
-   */
-  getAuthCredential?(): Promise<Credential[]>;
-
-  /**
-   * Remove all auth credentials
-   * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-remove-all-credentials}
-   */
-  removeAllAuthCredentials?(): Promise<void>;
-
-  /**
-   * Remove a specific auth credential
-   *
-   * @param credentialId - the credential ID
-   * @param authenticatorId - the authenticator ID
-   */
-  removeAuthCredential?(credentialId: string, authenticatorId: string): Promise<void>;
-
-  /**
-   * Set the isUserVerified property of an authenticator
-   * @see {@link https://www.w3.org/TR/webauthn-2/#sctn-automation-set-user-verified}
-   *
-   * @param isUserVerified - the value of the isUserVerified property
-   * @param authenticatorId - the authenticator id
-   */
-  setUserAuthVerified?(isUserVerified: boolean, authenticatorId: string): Promise<void>;
-
+> extends Driver<C, CArgs, Settings, CreateResult, DeleteResult, SessionData>,
+    IWDClassicCommands,
+    IAppiumCommands,
+    IJSONWPCommands,
+    IMJSONWPCommands<Ctx>,
+    IOtherProtocolCommands {
   /**
    * Proxy a command to a connected WebDriver server
    *