@wdio/protocols 9.16.2 → 9.23.1

package/build/commands/appium.d.ts

@@ -20,7 +20,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Retrieve the capabilities of the current session.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#getsession
      * @deprecated Use `getAppiumSessionCapabilities` instead
      *
      */
@@ -29,7 +29,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * No description available, please see reference link.
-     * @ref https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts
+     * @ref https://appium.io/docs/en/latest/reference/api/mjsonwp/#getcurrentcontext
      *
      */
     getAppiumContext(): Promise<Context>;
@@ -37,7 +37,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * No description available, please see reference link.
-     * @ref https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts
+     * @ref https://appium.io/docs/en/latest/reference/api/mjsonwp/#setcontext
      *
      */
     switchAppiumContext(name: string): Promise<void>;
@@ -45,7 +45,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * No description available, please see reference link.
-     * @ref https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts
+     * @ref https://appium.io/docs/en/latest/reference/api/mjsonwp/#getcontexts
      *
      */
     getAppiumContexts(): Promise<Context[]>;
@@ -53,7 +53,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Retrieve the endpoints and BiDi commands supported in the current session.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/lib/protocol/routes.js
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#listcommands
      *
      */
     getAppiumCommands(): Promise<ProtocolCommandResponse>;
@@ -61,7 +61,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Retrieve the extension commands supported in the current session.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/lib/protocol/routes.js
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#listextensions
      *
      */
     getAppiumExtensions(): Promise<ProtocolCommandResponse>;
@@ -69,7 +69,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Retrieve the capabilities of the current session.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/lib/protocol/routes.js
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#getappiumsessioncapabilities
      *
      */
     getAppiumSessionCapabilities(): Promise<ProtocolCommandResponse>;
@@ -78,6 +78,7 @@ export default interface AppiumCommands {
      *
      * Perform a shake action on the device.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/
+     * @deprecated Use `driver.execute('mobile: shake')` instead
      *
      */
     shake(): Promise<void>;
@@ -86,6 +87,7 @@ export default interface AppiumCommands {
      *
      * Lock the device.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/
+     * @deprecated Use `driver.execute('mobile: lock', { ... })` instead
      *
      */
     lock(seconds?: number): Promise<void>;
@@ -94,6 +96,7 @@ export default interface AppiumCommands {
      *
      * Unlock the device.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/
+     * @deprecated Use `driver.execute('mobile: unlock')` instead
      *
      */
     unlock(): Promise<void>;
@@ -102,6 +105,7 @@ export default interface AppiumCommands {
      *
      * Check whether the device is locked or not.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/
+     * @deprecated Use `driver.execute('mobile: isLocked')` instead
      *
      */
     isLocked(): Promise<boolean>;
@@ -126,6 +130,7 @@ export default interface AppiumCommands {
      *
      * Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/
+     * @deprecated Use `driver.execute('mobile: getPerformanceDataTypes')` instead
      *
      */
     getPerformanceDataTypes(): Promise<string[]>;
@@ -134,6 +139,7 @@ export default interface AppiumCommands {
      *
      * Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/
+     * @deprecated Use `driver.execute('mobile: getPerformanceData', { ... })` instead
      *
      */
     getPerformanceData(packageName: string, dataType: string, dataReadTimeout?: number): Promise<string[]>;
@@ -142,6 +148,7 @@ export default interface AppiumCommands {
      *
      * Press a particular key on the device.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/
+     * @deprecated Use `driver.execute('mobile: pressKey', { ... })` instead
      *
      */
     pressKeyCode(keycode: number, metastate?: number, flags?: number): Promise<void>;
@@ -150,6 +157,7 @@ export default interface AppiumCommands {
      *
      * Press and hold a particular key code on the device.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/
+     * @deprecated Use `driver.execute('mobile: pressKey', { ... })` instead
      *
      */
     longPressKeyCode(keycode: number, metastate?: number, flags?: number): Promise<void>;
@@ -158,6 +166,7 @@ export default interface AppiumCommands {
      *
      * Send a key code to the device.
      * @ref https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints
+     * @deprecated Use `driver.execute('mobile: pressKey', { ... })` instead
      *
      */
     sendKeyEvent(keycode: string, metastate?: string): Promise<void>;
@@ -165,7 +174,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Rotate the device in three dimensions.
-     * @ref https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation
+     * @ref https://appium.io/docs/en/latest/reference/api/mjsonwp/#setrotation
      *
      */
     rotateDevice(x: number, y: number, z: number): Promise<void>;
@@ -174,6 +183,7 @@ export default interface AppiumCommands {
      *
      * Get the name of the current Android activity.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/
+     * @deprecated Use `driver.execute('mobile: getCurrentActivity')` instead
      *
      */
     getCurrentActivity(): Promise<string>;
@@ -182,6 +192,7 @@ export default interface AppiumCommands {
      *
      * Get the name of the current Android package.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/
+     * @deprecated Use `driver.execute('mobile: getCurrentPackage')` instead
      *
      */
     getCurrentPackage(): Promise<string>;
@@ -189,55 +200,55 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Install the given app onto the device.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/install-app/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#installapp
      *
      */
-    installApp(appPath: string): Promise<void>;
+    installApp(appPath: string, options?: object): Promise<void>;
     /**
      * Appium Protocol Command
      *
-     * Activate the given app onto the device
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/activate-app/
+     * Activate the given app on the device
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#activateapp
      *
      */
-    activateApp(appId: string): Promise<void>;
+    activateApp(appId?: string, bundleId?: string, options?: object): Promise<void>;
     /**
      * Appium Protocol Command
      *
      * Remove an app from the device.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/remove-app/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#removeapp
      *
      */
-    removeApp(appId: string): Promise<void>;
+    removeApp(appId?: string, bundleId?: string, options?: object): Promise<boolean>;
     /**
      * Appium Protocol Command
      *
      * Terminate the given app on the device
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/terminate-app/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#terminateapp
      *
      */
-    terminateApp(appId: string, options?: object): Promise<void>;
+    terminateApp(appId?: string, bundleId?: string, options?: object): Promise<void>;
     /**
      * Appium Protocol Command
      *
      * Check whether the specified app is installed on the device.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/is-app-installed/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#isappinstalled
      *
      */
-    isAppInstalled(appId: string): Promise<boolean>;
+    isAppInstalled(appId?: string, bundleId?: string): Promise<boolean>;
     /**
      * Appium Protocol Command
      *
      * Get the given app status on the device
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/app-state/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#queryappstate
      *
      */
-    queryAppState(appId: string): Promise<number>;
+    queryAppState(appId?: string, bundleId?: string): Promise<number>;
     /**
      * Appium Protocol Command
      *
      * Hide soft keyboard.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/hide-keyboard/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#hidekeyboard
      *
      */
     hideKeyboard(strategy?: string, key?: string, keyCode?: string, keyName?: string): Promise<void>;
@@ -245,7 +256,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Whether or not the soft keyboard is shown.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/keys/is-keyboard-shown/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#iskeyboardshown
      *
      */
     isKeyboardShown(): Promise<boolean>;
@@ -253,7 +264,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Place a file onto the device in a particular place.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/files/push-file/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#pushfile
      *
      */
     pushFile(path: string, data: string): Promise<void>;
@@ -261,7 +272,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Retrieve a file from the device's file system.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/files/pull-file/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#pullfile
      *
      */
     pullFile(path: string): Promise<string>;
@@ -269,15 +280,16 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Retrieve a folder from the device's file system.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/device/files/pull-folder/
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#pullfolder
      *
      */
-    pullFolder(path: string): Promise<void>;
+    pullFolder(path: string): Promise<string>;
     /**
      * Appium Protocol Command
      *
      * Toggle airplane mode on device.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/
+     * @deprecated Use `driver.execute('mobile: setConnectivity', { ... })` instead
      *
      */
     toggleAirplaneMode(): Promise<void>;
@@ -286,6 +298,7 @@ export default interface AppiumCommands {
      *
      * Switch the state of data service.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/
+     * @deprecated Use `driver.execute('mobile: setConnectivity', { ... })` instead
      *
      */
     toggleData(): Promise<void>;
@@ -294,6 +307,7 @@ export default interface AppiumCommands {
      *
      * Switch the state of the wifi service.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/
+     * @deprecated Use `driver.execute('mobile: setConnectivity', { ... })` instead
      *
      */
     toggleWiFi(): Promise<void>;
@@ -302,6 +316,7 @@ export default interface AppiumCommands {
      *
      * Switch the state of the location service.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/
+     * @deprecated Use `driver.execute('mobile: toggleGps')` instead
      *
      */
     toggleLocationServices(): Promise<void>;
@@ -310,14 +325,16 @@ export default interface AppiumCommands {
      *
      * Set network speed (Emulator only)
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/
+     * @deprecated Use `driver.execute('mobile: networkSpeed', { ... })` instead
      *
      */
     toggleNetworkSpeed(netspeed: string): Promise<void>;
     /**
      * Appium Protocol Command
      *
-     * Open Android notifications (Emulator only).
+     * Open Android notifications.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/
+     * @deprecated Use `driver.execute('mobile: openNotifications')` or `driver.execute('mobile: statusBar', { ... })` instead
      *
      */
     openNotifications(): Promise<void>;
@@ -326,6 +343,7 @@ export default interface AppiumCommands {
      *
      * Start an Android activity by providing package name and activity name.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/
+     * @deprecated Use `driver.execute('mobile: startActivity', { ... })` instead
      *
      */
     startActivity(appPackage: string, appActivity: string, appWaitPackage?: string, appWaitActivity?: string, intentAction?: string, intentCategory?: string, intentFlags?: string, optionalIntentArguments?: string, dontStopAppOnReset?: string): Promise<void>;
@@ -334,6 +352,7 @@ export default interface AppiumCommands {
      *
      * Retrieve visibility and bounds information of the status and navigation bars.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/
+     * @deprecated Use `driver.execute('mobile: getSystemBars')` instead
      *
      */
     getSystemBars(): Promise<object[]>;
@@ -350,6 +369,7 @@ export default interface AppiumCommands {
      *
      * Get display density from device.
      * @ref https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints
+     * @deprecated Use `driver.execute('mobile: getDisplayDensity')` instead
      *
      */
     getDisplayDensity(): Promise<any>;
@@ -358,6 +378,7 @@ export default interface AppiumCommands {
      *
      * Simulate a [touch id](https://support.apple.com/en-ca/ht201371) event (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true and the Simulator must be [enrolled](https://support.apple.com/en-ca/ht201371). When you set allowTouchIdEnroll to true, it will set the Simulator to be enrolled by default. The enrollment state can be [toggled](https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/index.html). This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/
+     * @deprecated Use `driver.execute('mobile: sendBiometricMatch', { ... })` instead
      *
      */
     touchId(match: boolean): Promise<void>;
@@ -366,6 +387,7 @@ export default interface AppiumCommands {
      *
      * Toggle the simulator being [enrolled](https://support.apple.com/en-ca/ht201371) to accept touchId (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true. When `allowTouchIdEnroll` is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state. This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/
+     * @deprecated Use `driver.execute('mobile: enrollBiometric', { ... })` instead
      *
      */
     toggleEnrollTouchId(enabled?: boolean): Promise<void>;
@@ -374,7 +396,7 @@ export default interface AppiumCommands {
      *
      * Launch an app on device.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/
-     * @deprecated For iOS, utilize `driver.execute('mobile: launchApp', { ... })`, and for Android, make use of `driver.execute('mobile: activateApp', { ... })`.
+     * @deprecated Use `driver.execute('mobile: launchApp', { ... })` (iOS) or `driver.execute('mobile: activateApp', { ... })` (Android) instead
      *
      */
     launchApp(): Promise<void>;
@@ -401,6 +423,7 @@ export default interface AppiumCommands {
      *
      * Get test coverage data.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/end-test-coverage/
+     * @deprecated Use `driver.execute('mobile: shell', { ... })` instead
      *
      */
     endCoverage(intent: string, path: string): Promise<void>;
@@ -409,6 +432,7 @@ export default interface AppiumCommands {
      *
      * Get app strings.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/
+     * @deprecated Use `driver.execute('mobile: getAppStrings', { ... })` instead
      *
      */
     getStrings(language?: string, stringFile?: string): Promise<StringsReturn>;
@@ -417,6 +441,7 @@ export default interface AppiumCommands {
      *
      * No description available, please see reference link.
      * @ref https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints
+     * @deprecated Use `driver.addValue(...)` or `driver.setValue(...)` instead
      *
      */
     setValueImmediate(elementId: string, text: string): Promise<void>;
@@ -425,22 +450,23 @@ export default interface AppiumCommands {
      *
      * Replace the value to element directly.
      * @ref https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints
+     * @deprecated Use `driver.addValue(...)` or `driver.setValue(...)` instead
      *
      */
     replaceValue(elementId: string, value: string): Promise<void>;
     /**
      * Appium Protocol Command
      *
-     * Retrieve the current settings on the device.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/session/settings/get-settings/
+     * Retrieve the current session settings.
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#getsettings
      *
      */
     getSettings(): Promise<SettingsReturn>;
     /**
      * Appium Protocol Command
      *
-     * Update the current setting on the device.
-     * @ref https://appium.github.io/appium.io/docs/en/commands/session/settings/update-settings/
+     * Update the session settings.
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#updatesettings
      *
      */
     updateSettings(settings: object): Promise<void>;
@@ -449,6 +475,7 @@ export default interface AppiumCommands {
      *
      * Callback url for asynchronous execution of JavaScript.
      * @ref https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints
+     * @deprecated Use `driver.executeAsyncScript(...)` instead
      *
      */
     receiveAsyncResponse(response: object): Promise<void>;
@@ -457,6 +484,7 @@ export default interface AppiumCommands {
      *
      * Make GSM call (Emulator only).
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/
+     * @deprecated Use `driver.execute('mobile: gsmCall', { ... })` instead
      *
      */
     gsmCall(phoneNumber: string, action: string): Promise<void>;
@@ -465,6 +493,7 @@ export default interface AppiumCommands {
      *
      * Set GSM signal strength (Emulator only).
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/
+     * @deprecated Use `driver.execute('mobile: gsmSignal', { ... })` instead
      *
      */
     gsmSignal(signalStrength: string, signalStrengh?: string): Promise<void>;
@@ -473,6 +502,7 @@ export default interface AppiumCommands {
      *
      * Set the battery percentage (Emulator only).
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/
+     * @deprecated Use `driver.execute('mobile: powerCapacity', { ... })` instead
      *
      */
     powerCapacity(percent: number): Promise<void>;
@@ -481,6 +511,7 @@ export default interface AppiumCommands {
      *
      * Set the state of the battery charger to connected or not (Emulator only).
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/
+     * @deprecated Use `driver.execute('mobile: powerAC', { ... })` instead
      *
      */
     powerAC(state: string): Promise<void>;
@@ -489,6 +520,7 @@ export default interface AppiumCommands {
      *
      * Set GSM voice state (Emulator only).
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/
+     * @deprecated Use `driver.execute('mobile: gsmVoice', { ... })` instead
      *
      */
     gsmVoice(state: string): Promise<void>;
@@ -497,6 +529,7 @@ export default interface AppiumCommands {
      *
      * Simulate an SMS message (Emulator only).
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/
+     * @deprecated Use `driver.execute('mobile: sendSms', { ... })` instead
      *
      */
     sendSms(phoneNumber: string, message: string): Promise<void>;
@@ -505,6 +538,7 @@ export default interface AppiumCommands {
      *
      * Authenticate users by using their finger print scans on supported emulators.
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/
+     * @deprecated Use `driver.execute('mobile: fingerPrint', { ... })` instead
      *
      */
     fingerPrint(fingerprintId: number): Promise<void>;
@@ -513,6 +547,7 @@ export default interface AppiumCommands {
      *
      * Set the content of the system clipboard
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/
+     * @deprecated Use `driver.execute('mobile: setClipboard', { ... })` instead
      *
      */
     setClipboard(content: string, contentType?: string, label?: string): Promise<string>;
@@ -521,6 +556,7 @@ export default interface AppiumCommands {
      *
      * Get the content of the system clipboard
      * @ref https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/
+     * @deprecated Use `driver.execute('mobile: getClipboard', { ... })` instead
      *
      */
     getClipboard(contentType?: string): Promise<string>;
@@ -529,6 +565,7 @@ export default interface AppiumCommands {
      *
      * This functionality is only available from within a native context. 'Touch Perform' works similarly to the other singular touch interactions, except that this allows you to chain together more than one touch action as one command. This is useful because Appium commands are sent over the network and there's latency between commands. This latency can make certain touch interactions impossible because some interactions need to be performed in one sequence. Vertical, for example, requires pressing down, moving to a different y coordinate, and then releasing. For it to work, there can't be a delay between the interactions.
      * @ref https://appium.github.io/appium.io/docs/en/commands/interactions/touch/touch-perform/
+     * @deprecated Use `driver.performActions(...)` instead
      *
      * @example
      * ```js
@@ -575,46 +612,48 @@ export default interface AppiumCommands {
      *
      * This functionality is only available from within a native context. Perform a multi touch action sequence.
      * @ref https://appium.github.io/appium.io/docs/en/commands/interactions/touch/multi-touch-perform/
+     * @deprecated Use `driver.performActions(...)` instead
      *
      */
     multiTouchPerform(actions: object[]): Promise<void>;
     /**
      * Appium Protocol Command
      *
-     * This command enables you to specify a WebdriverIO script as a string and transmit it to the Appium server for local execution on the server itself. This approach helps minimize potential latency associated with each command. ***To utilize this command with Appium 2.0, you must have the [`execute-driver-plugin`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin installed.***
-     * @ref https://github.com/appium/appium/blob/master/docs/en/commands/session/execute-driver.md
+     * Execute a script in a child process. This approach helps minimize potential latency associated with each command. ***Using this command in Appium 2 or later requires installing the [`execute-driver`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin.***
+     * @ref https://appium.io/docs/en/latest/reference/api/plugins/#executedriverscript
      *
      */
     executeDriverScript(script: string, type?: string, timeout?: number): Promise<ProtocolCommandResponse>;
     /**
      * Appium Protocol Command
      *
-     * Get events stored in appium server.
-     * @ref https://github.com/appium/appium/blob/master/docs/en/commands/session/events/get-events.md
+     * Get events logged in the current session.
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#getlogevents
      *
      */
-    getEvents(type: string[]): Promise<ProtocolCommandResponse>;
+    getEvents(type?: (string | string[])): Promise<ProtocolCommandResponse>;
     /**
      * Appium Protocol Command
      *
-     * Store a custom event.
-     * @ref https://github.com/appium/appium/blob/master/docs/en/commands/session/events/log-event.md
+     * Log a custom event.
+     * @ref https://appium.io/docs/en/latest/reference/api/appium/#logcustomevent
      *
      */
     logEvent(vendor: string, event: string): Promise<void>;
     /**
      * Appium Protocol Command
      *
-     * This feature conducts image comparisons utilizing the capabilities of the OpenCV framework. Please note that for this functionality to work, both the OpenCV framework and the opencv4nodejs module must be installed on the machine where the Appium server is operational. ***Furthermore, you'll need to have the [`images-plugin`](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin installed to use this feature with Appium 2.0.***
-     * @ref https://github.com/appium/appium/blob/master/packages/images-plugin/docs/image-comparison.md
+     * Compare two images using the specified mode of comparison. ***Using this command in Appium 2 or later requires installing the [`images`](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin.***
+     * @ref https://appium.io/docs/en/latest/reference/api/plugins/#compareimages
      *
      */
-    compareImages(mode: string, firstImage: string, secondImage: string, options: object): Promise<ProtocolCommandResponse>;
+    compareImages(mode: string, firstImage: string, secondImage: string, options?: object): Promise<ProtocolCommandResponse>;
     /**
      * Appium Protocol Command
      *
      * Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.setTimeouts(...)` instead
      *
      */
     implicitWait(ms: number): Promise<void>;
@@ -623,6 +662,7 @@ export default interface AppiumCommands {
      *
      * Determine an element's location on the screen once it has been scrolled into view.<br /><br />__Note:__ This is considered an internal command and should only be used to determine an element's location for correctly generating native events.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.getElementRect(...)` or `element.getLocation()` instead
      *
      */
     getLocationInView(elementId: string): Promise<ProtocolCommandResponse>;
@@ -631,14 +671,15 @@ export default interface AppiumCommands {
      *
      * Send a sequence of key strokes to the active element
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.performActions(...)` with `keyUp` and `keyDown` actions instead
      *
      */
     sendKeys(value: string[]): Promise<void>;
     /**
      * Appium Protocol Command
      *
-     * List all available engines on the machine. To use an engine, it has to be present in this list.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * List all available IME engines on the device. To use an engine, it has to be present in this list.
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#availableimeengines
      *
      */
     availableIMEEngines(): Promise<string[]>;
@@ -646,7 +687,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Get the name of the active IME engine. The name string is platform specific.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#getactiveimeengine
      *
      */
     getActiveIMEEngine(): Promise<string>;
@@ -654,7 +695,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Indicates whether IME input is active at the moment
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#isimeactivated
      *
      */
     isIMEActivated(): Promise<boolean>;
@@ -662,15 +703,15 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * De-activates the currently-active IME engine.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#deactivateimeengine
      *
      */
     deactivateIMEEngine(): Promise<void>;
     /**
      * Appium Protocol Command
      *
-     * Make an engines that is available
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * Activates an IME engine.
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#activateimeengine
      *
      */
     activateIMEEngine(engine: string): Promise<void>;
@@ -679,6 +720,7 @@ export default interface AppiumCommands {
      *
      * Set the amount of time, in milliseconds, that asynchronous scripts executed by `/session/:sessionId/execute_async` are permitted to run before they are aborted and a `Timeout` error is returned to the client.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.setTimeouts(...)` instead
      *
      */
     asyncScriptTimeout(ms: number): Promise<void>;
@@ -687,6 +729,7 @@ export default interface AppiumCommands {
      *
      * Submit a form element.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Please explicitly find and click the submit element
      *
      */
     submit(elementId: string): Promise<void>;
@@ -695,6 +738,7 @@ export default interface AppiumCommands {
      *
      * Determine an element's size in pixels. The size will be returned as a JSON object with `width` and `height` properties.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.getElementRect(...)` or `element.getSize()` instead
      *
      */
     getElementSize(elementId: string): Promise<ProtocolCommandResponse>;
@@ -703,6 +747,7 @@ export default interface AppiumCommands {
      *
      * Determine an element's location on the page. The point `(0, 0)` refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with `x` and `y` properties.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.getElementRect(...)` or `element.getLocation()` instead
      *
      */
     getElementLocation(elementId: string): Promise<ProtocolCommandResponse>;
@@ -711,6 +756,7 @@ export default interface AppiumCommands {
      *
      * Single tap on the touch enabled device.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.performActions(...)` with `pointerDown` and `pointerUp` actions instead
      *
      */
     touchClick(element: string): Promise<void>;
@@ -719,6 +765,7 @@ export default interface AppiumCommands {
      *
      * Finger down on the screen.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.performActions(...)` with a `pointerDown` action instead
      *
      */
     touchDown(x: number, y: number): Promise<void>;
@@ -727,6 +774,7 @@ export default interface AppiumCommands {
      *
      * Finger up on the screen.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.performActions(...)` with a `pointerUp` action instead
      *
      */
     touchUp(x: number, y: number): Promise<void>;
@@ -735,6 +783,7 @@ export default interface AppiumCommands {
      *
      * Finger move on the screen.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.performActions(...)` with a `pointerMove` action instead
      *
      */
     touchMove(x: number, y: number): Promise<void>;
@@ -743,6 +792,7 @@ export default interface AppiumCommands {
      *
      * Long press on the touch screen using finger motion events.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.performActions(...)` with `pointerDown`, `pause` and `pointerUp` actions instead
      *
      */
     touchLongClick(element: string): Promise<void>;
@@ -751,6 +801,7 @@ export default interface AppiumCommands {
      *
      * Flick on the touch screen using finger motion events. This flick command starts at a particular screen location.
      * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @deprecated Use `driver.performActions(...)` with `pointerDown`, `pointerMove` and `pointerUp` actions instead
      *
      */
     touchFlick(xoffset?: number, yoffset?: number, element?: string, speed?: number, xspeed?: number, yspeed?: number): Promise<void>;
@@ -758,7 +809,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Get the current device orientation.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#getorientation
      *
      */
     getOrientation(): Promise<string>;
@@ -766,7 +817,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Set the device orientation
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#setorientation
      *
      */
     setOrientation(orientation: string): Promise<void>;
@@ -774,7 +825,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Get the current geo location.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#getgeolocation
      *
      */
     getGeoLocation(): Promise<ProtocolCommandResponse>;
@@ -782,7 +833,7 @@ export default interface AppiumCommands {
      * Appium Protocol Command
      *
      * Set the current geo location.
-     * @ref https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints
+     * @ref https://appium.io/docs/en/latest/reference/api/jsonwp/#setgeolocation
      *
      */
     setGeoLocation(location: object): Promise<void>;