@appium/types 0.10.1 → 0.10.3

package/build/lib/driver.d.ts

@@ -1,10 +1,21 @@
 /// <reference types="node" />
 import type { EventEmitter } from 'events';
-import { Element, ActionSequence } from './action';
-import { HTTPMethod, AppiumServer, UpdateServerCallback, Class, AppiumLogger, StringRecord, ConstraintsToCaps, BaseDriverCapConstraints, W3CCapabilities, Capabilities } from '.';
-import { ServerArgs } from './config';
 import { Entries } from 'type-fest';
-import { MethodMap, ExecuteMethodMap } from './command';
+import { ActionSequence } from './action';
+import { Capabilities, DriverCaps, W3CCapabilities, W3CDriverCaps } from './capabilities';
+import { ExecuteMethodMap, MethodMap } from './command';
+import { ServerArgs } from './config';
+import { HTTPHeaders, HTTPMethod } from './http';
+import { AppiumLogger } from './logger';
+import { AppiumServer, UpdateServerCallback } from './server';
+import { Class, StringRecord, Element } from './util';
+/**
+ * Interface implemented by the `DeviceSettings` class in `@appium/base-driver`
+ */
+export interface IDeviceSettings<T extends StringRecord> {
+    update(newSettings: T): Promise<void>;
+    getSettings(): T;
+}
 export interface ITimeoutCommands {
     /**
      * Set the various timeouts associated with a session
@@ -29,6 +40,7 @@ export interface ITimeoutCommands {
      * @param ms - the timeout in ms
      *
      * @deprecated Use `timeouts` instead
+     *
      */
     implicitWait(ms: number | string): Promise<void>;
     /**
@@ -135,7 +147,7 @@ export interface ISessionCommands {
      *
      * @returns A session data object
      */
-    getSession(): Promise<SingularSessionData>;
+    getSession<C extends Constraints>(): Promise<SingularSessionData<C>>;
 }
 export interface IExecuteCommands {
     /**
@@ -147,13 +159,13 @@ export interface IExecuteCommands {
      *
      * @returns The result of calling the Execute Method
      */
-    executeMethod<TReturn = any>(script: string, args: [StringRecord] | any[]): Promise<TReturn>;
+    executeMethod<TArgs extends readonly any[] | readonly [StringRecord<unknown>] = unknown[], TReturn = unknown>(script: string, args: TArgs): Promise<TReturn>;
 }
-export interface MultiSessionData<C extends Constraints = BaseDriverCapConstraints, Extra extends StringRecord | void = void> {
+export interface MultiSessionData<C extends Constraints = Constraints> {
     id: string;
-    capabilities: Capabilities<C, Extra>;
+    capabilities: DriverCaps<C>;
 }
-export type SingularSessionData<C extends Constraints = BaseDriverCapConstraints, Extra extends StringRecord | void = void> = Capabilities<C, Extra> & {
+export type SingularSessionData<C extends Constraints = Constraints> = DriverCaps<C> & {
     events?: EventHistory;
     error?: string;
 };
@@ -269,7 +281,7 @@ export interface ILogCommands {
      *
      * @param logType - Name/key of log type as defined in {@linkcode ILogCommands.supportedLogTypes}.
      */
-    getLog(logType: string): Promise<any[]>;
+    getLog(logType: string): Promise<unknown[]>;
 }
 /**
  * A record of {@linkcode LogDef} objects, keyed by the log type name.
@@ -292,9 +304,9 @@ export interface LogDef {
      *
      * This implementation *should* drain, truncate or otherwise reset the log buffer.
      */
-    getter: <C extends Constraints, T = any>(driver: Driver<C>) => Promise<T[]>;
+    getter: (driver: any) => Promise<unknown[]> | unknown[];
 }
-export interface ISettingsCommands {
+export interface ISettingsCommands<T extends StringRecord = StringRecord> {
     /**
      * Update the session's settings dictionary with a new settings object
      *
@@ -307,9 +319,23 @@ export interface ISettingsCommands {
      *
      * @returns The settings object
      */
-    getSettings(): Promise<StringRecord>;
+    getSettings(): Promise<T>;
 }
-export interface SessionHandler<CreateResult, DeleteResult, C extends Constraints = BaseDriverCapConstraints, Extra extends StringRecord | void = void> {
+/**
+ * @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> {
     /**
      * Start a new automation session
      * @see {@link https://w3c.github.io/webdriver/#new-session}
@@ -327,7 +353,7 @@ export interface SessionHandler<CreateResult, DeleteResult, C extends Constraint
      *
      * @returns The capabilities object representing the created session
      */
-    createSession(w3cCaps1: W3CCapabilities<C, Extra>, w3cCaps2?: W3CCapabilities<C, Extra>, w3cCaps3?: W3CCapabilities<C, Extra>, driverData?: DriverData[]): Promise<CreateResult>;
+    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}
@@ -341,19 +367,6 @@ export interface SessionHandler<CreateResult, DeleteResult, C extends Constraint
  * Custom session data for a driver.
  */
 export type DriverData = Record<string, unknown>;
-/**
- * Extensions can define new methods for the Appium server to map to command names, of the same
- * format as used in Appium's `routes.js`.
- *
- *
- * @example
- * {
- *   '/session/:sessionId/new_method': {
- *     GET: {command: 'getNewThing'},
- *     POST: {command: 'setNewThing', payloadParams: {required: ['someParam']}}
- *   }
- * }
- */
 export interface Constraint {
     readonly presence?: boolean | Readonly<{
         allowEmpty: boolean;
@@ -364,22 +377,23 @@ export interface Constraint {
     readonly isObject?: boolean;
     readonly isArray?: boolean;
     readonly deprecated?: boolean;
-    readonly inclusion?: Readonly<[any, ...any[]]>;
-    readonly inclusionCaseInsensitive?: Readonly<[any, ...any[]]>;
+    readonly inclusion?: Readonly<[string, ...string[]]>;
+    readonly inclusionCaseInsensitive?: Readonly<[string, ...string[]]>;
+}
+/**
+ * A collection of constraints describing the allowed capabilities for a driver.
+ */
+export interface Constraints {
+    [name: string]: Constraint;
 }
-export type Constraints = Readonly<Record<string, Constraint>>;
-export interface DriverHelpers<C extends Constraints> {
-    configureApp: (app: string, supportedAppExtensions: string[]) => Promise<string>;
+export interface DriverHelpers {
+    configureApp: (app: string, supportedAppExtensions?: string | string[] | ConfigureAppOptions) => Promise<string>;
     isPackageOrBundle: (app: string) => boolean;
     duplicateKeys: <T>(input: T, firstKey: string, secondKey: string) => T;
     parseCapsArray: (cap: string | string[]) => string[];
-    generateDriverLogPrefix: (obj: Core<C>, sessionId?: string) => string;
+    generateDriverLogPrefix: <C extends Constraints>(obj: Core<C>, sessionId?: string) => string;
 }
 export type SettingsUpdateListener<T extends Record<string, unknown> = Record<string, unknown>> = (prop: keyof T, newValue: unknown, curValue: unknown) => Promise<void>;
-export interface DeviceSettings<T = any> {
-    update(newSettings: Record<string, T>): Promise<void>;
-    getSettings(): Record<string, T>;
-}
 export interface Rect {
     x: number;
     y: number;
@@ -461,13 +475,13 @@ export interface EventHistoryCommand {
  *
  * This should not be used directly by external code.
  */
-export interface Core<C extends Constraints = BaseDriverCapConstraints> {
+export interface Core<C extends Constraints, Settings extends StringRecord = StringRecord> {
     shouldValidateCaps: boolean;
     sessionId: string | null;
     opts: DriverOpts<C>;
-    initialOpts: ServerArgs;
+    initialOpts: Partial<DriverOpts<C>>;
     protocol?: string;
-    helpers: DriverHelpers<C>;
+    helpers: DriverHelpers;
     basePath: string;
     relaxedSecurityEnabled: boolean;
     allowInsecure: string[];
@@ -477,9 +491,9 @@ export interface Core<C extends Constraints = BaseDriverCapConstraints> {
     locatorStrategies: string[];
     webLocatorStrategies: string[];
     eventEmitter: EventEmitter;
-    settings: DeviceSettings;
+    settings: IDeviceSettings<Settings>;
     log: AppiumLogger;
-    driverData?: DriverData;
+    driverData: DriverData;
     isCommandsQueueEnabled: boolean;
     eventHistory: EventHistory;
     onUnexpectedShutdown(handler: () => any): void;
@@ -515,7 +529,7 @@ export interface Core<C extends Constraints = BaseDriverCapConstraints> {
      * ```
      */
     getStatus(): Promise<any>;
-    sessionExists(sessionId: string): boolean;
+    sessionExists(sessionId?: string): boolean;
     isW3CProtocol(): boolean;
     isMjsonwpProtocol(): boolean;
     isFeatureEnabled(name: string): boolean;
@@ -537,13 +551,17 @@ export interface Core<C extends Constraints = BaseDriverCapConstraints> {
  *
  * `C` should be the constraints of the driver.
  * `CArgs` would be the shape of `cliArgs`.
- * `Ctx` would be the type of the element context (e.g., string, dictionary of some sort, etc.)
+ * `Settings` is the shape of the raw device settings object (see {@linkcode IDeviceSettings})
  */
-export interface Driver<C extends Constraints = Constraints, CArgs extends StringRecord = StringRecord> extends ISessionCommands, ILogCommands, IFindCommands, ISettingsCommands, ITimeoutCommands, IEventCommands, IExecuteCommands, SessionHandler<[sessionId: string, caps: any], void, C>, Core {
+export interface Driver<C extends Constraints = Constraints, CArgs extends StringRecord = StringRecord, Settings extends StringRecord = StringRecord, CreateResult = DefaultCreateSessionResult<C>, DeleteResult = DefaultDeleteSessionResult> extends ISessionCommands, ILogCommands, IFindCommands, ISettingsCommands<Settings>, ITimeoutCommands, IEventCommands, IExecuteCommands, ISessionHandler<C, CreateResult, DeleteResult>, Core<C, Settings> {
     /**
      * The set of command line arguments set for this driver
      */
     cliArgs: CArgs;
+    server?: AppiumServer;
+    serverHost?: string;
+    serverPort?: number;
+    serverPath?: string;
     /**
      * Execute a driver (WebDriver-protocol) command by its name as defined in the routes file
      *
@@ -569,6 +587,7 @@ export interface Driver<C extends Constraints = Constraints, CArgs extends Strin
      * Reset the current session (run the delete session and create session subroutines)
      *
      * @deprecated Use explicit session management commands instead
+     * @privateRemarks This is implemented by `BaseDriver` and is used within `@appium/driver-test-support`
      */
     reset(): Promise<void>;
     /**
@@ -598,11 +617,7 @@ export interface Driver<C extends Constraints = Constraints, CArgs extends Strin
  * External drivers must subclass `BaseDriver`, and can implement any of these methods.
  * None of these are implemented within Appium itself.
  */
-export interface ExternalDriver<C extends Constraints = Constraints> extends Driver<C> {
-    server?: AppiumServer;
-    serverHost?: string;
-    serverPort?: number;
-    serverPath?: string;
+export interface ExternalDriver<C extends Constraints = Constraints, Ctx = string> extends Driver<C> {
     /**
      * Navigate to a given url
      * @see {@link https://w3c.github.io/webdriver/#navigate-to}
@@ -990,12 +1005,6 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns A base64-encoded string representing the PNG image data for the element rect
      */
     getElementScreenshot?(elementId: string): Promise<string>;
-    /**
-     * Shake the device
-     *
-     * @deprecated
-     */
-    mobileShake?(): Promise<void>;
     /**
      * Get the current time on the device under timeouts
      *
@@ -1004,47 +1013,6 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns The formatted time
      */
     getDeviceTime?(format?: string): Promise<string>;
-    /**
-     * Lock the device, and optionally unlock the device after a certain amount of time
-     *
-     * @param seconds - the number of seconds after which to unlock the device. Set to zero or leave
-     * empty to not unlock the device automatically
-     *
-     * @deprecated
-     */
-    lock?(seconds?: number): Promise<void>;
-    /**
-     * Unlock the device
-     *
-     * @deprecated
-     */
-    unlock?(): Promise<void>;
-    /**
-     * Determine whether the device is locked
-     *
-     * @returns True if the device is locked, false otherwise
-     *
-     * @deprecated
-     */
-    isLocked?(): Promise<boolean>;
-    /**
-     * Direct Appium to start recording the device screen
-     *
-     * @param options - parameters for screen recording
-     *
-     * @deprecated
-     */
-    startRecordingScreen?(options?: StartScreenRecordOptions): Promise<void>;
-    /**
-     * Direct Appium to stop screen recording and return the video
-     *
-     * @param options - parameters for stopping like video Uploading
-     *
-     * @returns The base64-encoded video data
-     *
-     * @deprecated
-     */
-    stopRecordingScreen?(options?: StopScreenRecordOptions): Promise<string>;
     /**
      * List the performance data types supported by this driver, which can be used in a call to get
      * the performance data by type.
@@ -1052,6 +1020,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns The list of types
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     getPerformanceDataTypes?(): Promise<string[]>;
     /**
@@ -1065,6 +1034,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns A list of performance data strings
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     getPerformanceData?(packageName: string, dataType: string, dataReadTimeout?: number): Promise<string[]>;
     /**
@@ -1075,6 +1045,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param flags - the code denoting the combination of extra flags
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     pressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
     /**
@@ -1085,6 +1056,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param flags - the code denoting the combination of extra flags
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     longPressKeyCode?(keycode: number, metastate?: number, flags?: number): Promise<void>;
     /**
@@ -1093,6 +1065,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param fingerprintId - the numeric ID of the fingerprint to use
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     fingerprint?(fingerprintId: number): Promise<void>;
     /**
@@ -1102,6 +1075,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param message - the SMS text
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     sendSMS?(phoneNumber: string, message: string): Promise<void>;
     /**
@@ -1112,6 +1086,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param action - the action to take in response (accept, reject, etc...)
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     gsmCall?(phoneNumber: string, action: string): Promise<void>;
     /**
@@ -1120,6 +1095,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param singalStrength - the strength in a driver-appropriate string
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     gsmSignal?(signalStrength: string): Promise<void>;
     /**
@@ -1128,6 +1104,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param state - the state
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     gsmVoice?(state: string): Promise<void>;
     /**
@@ -1136,6 +1113,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param percent - how full the battery should become
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     powerCapacity?(percent: number): Promise<void>;
     /**
@@ -1144,6 +1122,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param state - whether the device is connected to power or not
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     powerAC?(state: string): Promise<void>;
     /**
@@ -1152,6 +1131,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param netspeed - the speed as a string, like '3G'
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     networkSpeed?(netspeed: string): Promise<void>;
     /**
@@ -1161,6 +1141,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param metastate - the combination of meta startUnexpectedShutdown
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     keyevent?(keycode: string, metastate?: string): Promise<void>;
     /**
@@ -1174,6 +1155,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param elementId - if we're rotating around an element
      *
      * @deprecated Use setRotation instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     mobileRotation?(x: number, y: number, radius: number, rotation: number, touchCount: number, duration: string, elementId?: string): Promise<void>;
     /**
@@ -1182,6 +1164,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns The activity name
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     getCurrentActivity?(): Promise<string>;
     /**
@@ -1190,6 +1173,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns The package name
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     getCurrentPackage?(): Promise<string>;
     /**
@@ -1231,10 +1215,11 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      *
      * @param appId - the package or bundle ID of the application
      *
-     * @returns A number representing the state. 0 means not installed, 1 means not running, 3 means
-     * running in the background, and 4 means running in the foreground
+     * @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 | 3 | 4>;
+    queryAppState?(appId: string): Promise<0 | 1 | 2 | 3 | 4>;
     /**
      * Attempt to hide a virtual keyboard
      *
@@ -1277,30 +1262,35 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * Toggle airplane/flight mode for the device
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     toggleFlightMode?(): Promise<void>;
     /**
      * Toggle cell network data
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     toggleData?(): Promise<void>;
     /**
      * Toggle WiFi radio status
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     toggleWiFi?(): Promise<void>;
     /**
      * Toggle location services for the device
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     toggleLocationServices?(): Promise<void>;
     /**
      * Open the notifications shade/screen
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     openNotifications?(): Promise<void>;
     /**
@@ -1319,6 +1309,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * activity
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     startActivity?(appPackage: string, appActivity: string, appWaitPackage?: string, appWaitActivity?: string, intentAction?: string, intentCategory?: string, intentFlags?: string, optionalIntentArguments?: string, dontStopAppOnReset?: boolean): Promise<void>;
     /**
@@ -1327,6 +1318,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns An array of information objects of driver-specific shape
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     getSystemBars?(): Promise<unknown[]>;
     /**
@@ -1335,44 +1327,9 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns The density
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     getDisplayDensity?(): Promise<number>;
-    /**
-     * Trigger a touch/fingerprint match or match failure
-     *
-     * @param match - whether the match should be a success or failure
-     *
-     * @deprecated
-     */
-    touchId?(match: boolean): Promise<void>;
-    /**
-     * Toggle whether the device is enrolled in the touch ID program
-     *
-     * @param enabled - whether to enable or disable the touch ID program
-     *
-     * @deprecated
-     */
-    toggleEnrollTouchId?(enabled: boolean): Promise<void>;
-    /**
-     * Start the session after it has been started.
-     *
-     * @deprecated Don't use this, it never made sense.
-     */
-    launchApp?(): Promise<void>;
-    /**
-     * Stop the session without stopping the session
-     *
-     * @deprecated Don't use this, it never made sense.
-     */
-    closeApp?(): Promise<void>;
-    /**
-     * Background (close) the app either permanently or for a certain amount of time
-     *
-     * @param seconds - the number of seconds to background the app for, or `null` for permanently
-     *
-     * @deprecated
-     */
-    background?(seconds: null | number): Promise<void>;
     /**
      * End platform-specific code coverage tracing
      *
@@ -1380,28 +1337,9 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param path - the path to place the results
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     endCoverage?(intent: string, path: string): Promise<void>;
-    /**
-     * Return the language-specific strings for an app
-     *
-     * @param language - the language to retrieve strings for
-     * @param stringFile - the path to the localized strings file if not in the default location
-     *
-     * @returns A record of localized keys to localized text
-     *
-     * @deprecated
-     */
-    getStrings?(language?: string, stringFile?: string): Promise<Record<string, unknown>>;
-    /**
-     * Set the value, but like, now? Don't use this.
-     *
-     * @param value - the value to set
-     * @param elementId - the element to set the value of
-     *
-     * @deprecated
-     */
-    setValueImmediate?(value: string, elementId: string): Promise<void>;
     /**
      * Set the value of a text field but ensure the current value is replace and not appended
      *
@@ -1409,83 +1347,9 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param elementId - the element to set it in
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     replaceValue?(value: string, elementId: string): Promise<void>;
-    /**
-     * Collect the response of an async script execution? It's unclear what this is for. Don't use
-     * it.
-     *
-     * @param response - idk
-     *
-     * @deprecated
-     */
-    receiveAsyncResponse?(response: unknown): Promise<void>;
-    /**
-     * Set the contents of the device clipboard
-     *
-     * @param content - the text to set
-     * @param contentType - the media type if not text
-     * @param label - the label if not text
-     *
-     * @deprecated
-     */
-    setClipboard?(content: string, contentType?: string, label?: string): Promise<void>;
-    /**
-     * Get the contents of the device clipboard, converted into an appropriate media type
-     *
-     * @param contentType - the media type if not text
-     *
-     * @returns The text or media content (base64-encoded) of the clipboard
-     *
-     * @deprecated
-     */
-    getClipboard?(contentType?: string): Promise<string>;
-    /**
-     * Set the async execute script timeout
-     *
-     * @param ms - the timeout
-     *
-     * @deprecated Use the W3C timeouts command instead
-     */
-    asyncScriptTimeout?(ms: number): Promise<void>;
-    /**
-     * Get the window size
-     *
-     * @returns The size (width and height)
-     *
-     * @deprecated Use getWindowRect instead
-     */
-    getWindowSize?(): Promise<Size>;
-    /**
-     * Get the position of an element on screen
-     *
-     * @param elementId - the element ID
-     *
-     * @returns The position of the element
-     *
-     * @deprecated Use getElementRect instead
-     */
-    getLocation?(elementId: string): Promise<Position>;
-    /**
-     * Get the position of an element on screen within a certain other view
-     *
-     * @param elementId - the element ID
-     *
-     * @returns The position of the element
-     *
-     * @deprecated Use getElementRect instead
-     */
-    getLocationInView?(elementId: string): Promise<Position>;
-    /**
-     * Get the size of an element
-     *
-     * @param elementId - the element ID
-     *
-     * @returns The size of the element
-     *
-     * @deprecated Use getElementRect instead
-     */
-    getSize?(elementId: string): Promise<Size>;
     /**
      * Check whether two elements are identical
      *
@@ -1495,30 +1359,16 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns True if the elements are equal, false otherwise
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     equalsElement?(elementId: string, otherElementId: string): Promise<boolean>;
-    /**
-     * Submit the form an element is in
-     *
-     * @param elementId - the element ID
-     *
-     * @deprecated
-     */
-    submit?(elementId: string): Promise<void>;
-    /**
-     * Send keys to the app
-     *
-     * @param value: the array of keys to send
-     *
-     * @deprecated Use the W3C send keys method instead
-     */
-    keys?(value: string[]): Promise<void>;
     /**
      * Get the list of IME engines
      *
      * @returns The list of IME engines
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     availableIMEEngines?(): Promise<string[]>;
     /**
@@ -1527,6 +1377,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns The name of the active engine
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     getActiveIMEEngine?(): Promise<string>;
     /**
@@ -1535,12 +1386,14 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns True if the IME is activated
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     isIMEActivated?(): Promise<boolean>;
     /**
      * Deactivate an IME engine
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     deactivateIMEEngine?(): Promise<void>;
     /**
@@ -1549,6 +1402,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param engine - the name of the engine
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     activateIMEEngine?(engine: string): Promise<void>;
     /**
@@ -1563,22 +1417,13 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param orientation - the orientation string
      */
     setOrientation?(orientation: string): Promise<void>;
-    /**
-     * Move the mouse pointer to a particular screen location
-     *
-     * @param element - the element ID if the move is relative to an element
-     * @param xOffset - the x offset
-     * @param yOffset - the y offset
-     *
-     * @deprecated Use the Actions API instead
-     */
-    moveTo?(element?: null | string, xOffset?: number, yOffset?: number): Promise<void>;
     /**
      * Trigger a mouse button down
      *
      * @param button - the button ID
      *
      * @deprecated Use the Actions API instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     buttonDown?(button?: number): Promise<void>;
     /**
@@ -1587,6 +1432,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param button - the button ID
      *
      * @deprecated Use the Actions API instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     buttonUp?(button?: number): Promise<void>;
     /**
@@ -1595,12 +1441,14 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param button - the button ID
      *
      * @deprecated Use the Actions API instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     clickCurrent?(button?: number): Promise<void>;
     /**
      * Double-click the current mouse location
      *
      * @deprecated Use the Actions API instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     doubleClick?(): Promise<void>;
     /**
@@ -1610,6 +1458,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param y - the y coordinate
      *
      * @deprecated Use the Actions API instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     touchDown?(x: number, y: number): Promise<void>;
     /**
@@ -1619,6 +1468,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param y - the y coordinate
      *
      * @deprecated Use the Actions API instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     touchUp?(x: number, y: number): Promise<void>;
     /**
@@ -1628,6 +1478,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param y - the y coordinate
      *
      * @deprecated Use the Actions API instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     touchMove?(x: number, y: number): Promise<void>;
     /**
@@ -1636,6 +1487,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param elementId - the id of the element to long touch
      *
      * @deprecated Use the Actions API instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     touchLongClick?(elementId: string): Promise<void>;
     /**
@@ -1649,6 +1501,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param speed - the speed (unclear how this relates to xSpeed and ySpeed)
      *
      * @deprecated Use the Actions API instead
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     flick?(element?: string, xSpeed?: number, ySpeed?: number, xOffset?: number, yOffset?: number, speed?: number): Promise<void>;
     /**
@@ -1669,21 +1522,21 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      *
      * @returns The context name
      */
-    getCurrentContext?(): Promise<string | null>;
+    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): Promise<void>;
+    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<string[]>;
+    getContexts?(): Promise<Ctx[]>;
     /**
      * Get the index of an element on the page
      *
@@ -1692,6 +1545,7 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @returns The page index
      *
      * @deprecated
+     * @privateRemarks Not implemented in `appium-xcuitest-driver`
      */
     getPageIndex?(elementId: string): Promise<string>;
     /**
@@ -1709,23 +1563,6 @@ export interface ExternalDriver<C extends Constraints = Constraints> extends Dri
      * @param type - the bitmask representing network state
      */
     setNetworkConnection?(type: number): Promise<void>;
-    /**
-     * Perform a set of touch actions
-     *
-     * @param actions - the old MJSONWP style touch action objects
-     *
-     * @deprecated Use the W3C Actions API instead
-     */
-    performTouch?(actions: unknown): Promise<void>;
-    /**
-     * Perform a set of touch actions
-     *
-     * @param actions - the old MJSONWP style touch action objects
-     * @param elementId - the id of an element if actions are restricted to one element
-     *
-     * @deprecated Use the W3C Actions API instead
-     */
-    performMultiAction?(actions: unknown, elementId: string): Promise<void>;
     /**
      * Get the current rotation state of the device
      * @see {@link https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation}
@@ -1851,16 +1688,104 @@ export interface ExtraDriverOpts {
  *
  * The combination happens within Appium prior to calling the constructor.
  */
-export type DriverOpts<C extends Constraints = BaseDriverCapConstraints> = ServerArgs & ExtraDriverOpts & Partial<ConstraintsToCaps<C>>;
+export type DriverOpts<C extends Constraints> = ServerArgs & ExtraDriverOpts & DriverCaps<C>;
 /**
  * An instance method of a driver class, whose name may be referenced by {@linkcode MethodDef.command}, and serves as an Appium command.
  *
  * Note that this signature differs from a `PluginCommand`.
  */
-export type DriverCommand<TArgs = any, TRetval = unknown> = (...args: TArgs[]) => Promise<TRetval>;
-export type DriverCommands<TArgs = any, TReturn = unknown> = Record<string, DriverCommand<TArgs, TReturn>>;
+export type DriverCommand<TArgs extends readonly any[] = any[], TRetval = unknown> = (...args: TArgs) => Promise<TRetval>;
 /**
  * Tuple of an HTTP method with a regex matching a request path
  */
 export type RouteMatcher = [HTTPMethod, RegExp];
+/**
+ * Result of the {@linkcode onPostProcess ConfigureAppOptions.onPostProcess} callback.
+ */
+export interface PostProcessResult {
+    /**
+     * The full past to the post-processed application package on the local file system .
+     *
+     * This might be a file or a folder path.
+     */
+    appPath: string;
+}
+/**
+ * Information about a cached app instance.
+ */
+export interface CachedAppInfo {
+    /**
+     * SHA1 hash of the package if it is a file (and not a folder)
+     */
+    packageHash: string;
+    /**
+     * Date instance; the value of the file's `Last-Modified` header
+     */
+    lastModified?: Date;
+    /**
+     * `true` if the file contains an `immutable` mark in `Cache-control` header
+     */
+    immutable?: boolean;
+    /**
+     * Integer representation of `maxAge` parameter in `Cache-control` header
+     */
+    maxAge?: number;
+    /**
+     * The timestamp this item has been added to the cache (measured in Unix epoch milliseconds)
+     */
+    timestamp?: number;
+    /**
+     * An object containing either `file` property with SHA1 hash of the file or `folder` property
+     * with total amount of cached files and subfolders
+     */
+    integrity?: {
+        file?: string;
+    } | {
+        folder?: number;
+    };
+    /**
+     * The full path to the cached app
+     */
+    fullPath?: string;
+}
+/**
+ * Options for the post-processing step
+ *
+ * The generic can be supplied if using `axios`, where `headers` is a fancy object.
+ */
+export interface PostProcessOptions<Headers = HTTPHeaders> {
+    /**
+     * The information about the previously cached app instance (if exists)
+     */
+    cachedAppInfo?: CachedAppInfo;
+    /**
+     * Whether the app has been downloaded from a remote URL
+     */
+    isUrl?: boolean;
+    /**
+     * Optional headers object.
+     *
+     * Only present if `isUrl` is `true` and if the server responds to `HEAD` requests. All header names are normalized to lowercase.
+     */
+    headers?: Headers;
+    /**
+     * A string containing full path to the preprocessed application package (either downloaded or a local one)
+     */
+    appPath?: string;
+}
+export interface ConfigureAppOptions {
+    /**
+     *
+     * Optional function, which should be applied to the application after it is
+     * downloaded/preprocessed.
+     *
+     * This function may be async and is expected to accept single object parameter. The function is
+     * expected to either return a falsy value, which means the app must not be cached and a fresh
+     * copy of it is downloaded each time, _or_ if this function returns an object containing an
+     * `appPath` property, then the integrity of it will be verified and stored into the cache.
+     * @returns
+     */
+    onPostProcess?: (obj: PostProcessOptions) => Promise<PostProcessResult | undefined> | PostProcessResult | undefined;
+    supportedExtensions: string[];
+}
 //# sourceMappingURL=driver.d.ts.map