appium-uiautomator2-driver 3.10.0 → 4.0.0

package/build/lib/commands/gestures.d.ts

@@ -2,78 +2,169 @@
  * Performs a simple click/tap gesture
  *
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').ClickOptions} [opts={}]
+ * @param {string} [elementId] The id of the element to be clicked.
+ * If the element is missing then both click offset coordinates must be provided.
+ * If both the element id and offset are provided then the coordinates are parsed
+ * as relative offsets from the top left corner of the element.
+ * @param {number} [x] The x coordinate to click on.
+ * @param {number} [y] The y coordinate to click on.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-export function mobileClickGesture(this: import("../driver").AndroidUiautomator2Driver, opts?: import("./types").ClickOptions): Promise<void>;
+export function mobileClickGesture(this: import("../driver").AndroidUiautomator2Driver, elementId?: string, x?: number, y?: number): Promise<void>;
 /**
  * Performs a click that lasts for the given duration
  *
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').LongClickOptions} [opts={}]
+ * @param {string} [elementId] The id of the element to be clicked.
+ * If the element is missing then both click offset coordinates must be provided.
+ * If both the element id and offset are provided then the coordinates are parsed
+ * as relative offsets from the top left corner of the element.
+ * @param {number} [x] The x coordinate to click on.
+ * @param {number} [y] The y coordinate to click on.
+ * @param {number} [duration] Click duration in milliseconds. The value must not be negative.
+ * Default is 500.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-export function mobileLongClickGesture(this: import("../driver").AndroidUiautomator2Driver, opts?: import("./types").LongClickOptions): Promise<void>;
+export function mobileLongClickGesture(this: import("../driver").AndroidUiautomator2Driver, elementId?: string, x?: number, y?: number, duration?: number): Promise<void>;
 /**
  * Performs a click that lasts for the given duration
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').DoubleClickOptions} [opts={}]
+ * @param {string} [elementId] The id of the element to be clicked.
+ * If the element is missing then both click offset coordinates must be provided.
+ * If both the element id and offset are provided then the coordinates are parsed
+ * as relative offsets from the top left corner of the element.
+ * @param {number} [x] The x coordinate to click on.
+ * @param {number} [y] The y coordinate to click on.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-export function mobileDoubleClickGesture(this: import("../driver").AndroidUiautomator2Driver, opts?: import("./types").DoubleClickOptions): Promise<void>;
+export function mobileDoubleClickGesture(this: import("../driver").AndroidUiautomator2Driver, elementId?: string, x?: number, y?: number): Promise<void>;
 /**
  * Drags this object to the specified location.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').DragOptions} opts
+ * @param {string} [elementId] The id of the element to be dragged.
+ * If the element id is missing then the start coordinates must be provided.
+ * If both the element id and the start coordinates are provided then these
+ * coordinates are considered as offsets from the top left element corner.
+ * @param {number} [startX] The x coordinate where the dragging starts
+ * @param {number} [startY] The y coordinate where the dragging starts
+ * @param {number} [endX] The x coordinate where the dragging ends
+ * @param {number} [endY] The y coordinate where the dragging ends
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 2500 * displayDensity.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-export function mobileDragGesture(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").DragOptions): Promise<void>;
+export function mobileDragGesture(this: import("../driver").AndroidUiautomator2Driver, elementId?: string, startX?: number, startY?: number, endX?: number, endY?: number, speed?: number): Promise<void>;
 /**
  * Drags to the specified location.
  *
  * @throws {Error} if provided options are not valid
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').FlingOptions} opts
+ * @param {string} direction Direction of the fling.
+ * Acceptable values are: `up`, `down`, `left` and `right` (case insensitive).
+ * @param {string} [elementId] The id of the element to be flinged.
+ * If the element id is missing then fling bounding area must be provided.
+ * If both the element id and the fling bounding area are provided then this
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the fling bounding area.
+ * @param {number} [top] The top coordinate of the fling bounding area.
+ * @param {number} [width] The width of the fling bounding area.
+ * @param {number} [height] The height of the fling bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must be greater than the minimum fling velocity for the given view (50 by default).
+ * Default is 7500 * displayDensity.
  * @returns {Promise<boolean>} True if the object can still scroll in the given direction.
  */
-export function mobileFlingGesture(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").FlingOptions): Promise<boolean>;
+export function mobileFlingGesture(this: import("../driver").AndroidUiautomator2Driver, direction: string, elementId?: string, left?: number, top?: number, width?: number, height?: number, speed?: number): Promise<boolean>;
 /**
  * Performs a pinch close gesture.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').PinchOptions} opts
+ * @param {number} percent The size of the pinch as a percentage of the pinch area size.
+ * Valid values must be float numbers in range 0..1, where 1.0 is 100%
+ * @param {string} [elementId] The id of the element to be pinched.
+ * If the element id is missing then pinch bounding area must be provided.
+ * If both the element id and the pinch bounding area are provided then the
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the pinch bounding area.
+ * @param {number} [top] The top coordinate of the pinch bounding area.
+ * @param {number} [width] The width of the pinch bounding area.
+ * @param {number} [height] The height of the pinch bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 2500 * displayDensity.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-export function mobilePinchCloseGesture(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").PinchOptions): Promise<void>;
+export function mobilePinchCloseGesture(this: import("../driver").AndroidUiautomator2Driver, percent: number, elementId?: string, left?: number, top?: number, width?: number, height?: number, speed?: number): Promise<void>;
 /**
  * Performs a pinch open gesture.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').PinchOptions} opts
+ * @param {number} percent The size of the pinch as a percentage of the pinch area size.
+ * Valid values must be float numbers in range 0..1, where 1.0 is 100%
+ * @param {string} [elementId] The id of the element to be pinched.
+ * If the element id is missing then pinch bounding area must be provided.
+ * If both the element id and the pinch bounding area are provided then the
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the pinch bounding area.
+ * @param {number} [top] The top coordinate of the pinch bounding area.
+ * @param {number} [width] The width of the pinch bounding area.
+ * @param {number} [height] The height of the pinch bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 2500 * displayDensity.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-export function mobilePinchOpenGesture(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").PinchOptions): Promise<void>;
+export function mobilePinchOpenGesture(this: import("../driver").AndroidUiautomator2Driver, percent: number, elementId?: string, left?: number, top?: number, width?: number, height?: number, speed?: number): Promise<void>;
 /**
  * Performs a swipe gesture.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').SwipeOptions} opts
+ * @param {string} direction Direction of the swipe.
+ * Acceptable values are: `up`, `down`, `left` and `right` (case insensitive).
+ * @param {number} percent The size of the swipe as a percentage of the swipe area size.
+ * Valid values must be float numbers in range 0..1, where 1.0 is 100%.
+ * @param {string} [elementId] The id of the element to be swiped.
+ * If the element id is missing then swipe bounding area must be provided.
+ * If both the element id and the swipe bounding area are provided then the
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the swipe bounding area.
+ * @param {number} [top] The top coordinate of the swipe bounding area.
+ * @param {number} [width] The width of the swipe bounding area.
+ * @param {number} [height] The height of the swipe bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 5000 * displayDensity.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-export function mobileSwipeGesture(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").SwipeOptions): Promise<void>;
+export function mobileSwipeGesture(this: import("../driver").AndroidUiautomator2Driver, direction: string, percent: number, elementId?: string, left?: number, top?: number, width?: number, height?: number, speed?: number): Promise<void>;
 /**
  * Performs a scroll gesture.
  *
  * @throws {Error} if provided options are not valid
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').ScrollGestureOptions} opts
+ * @param {string} direction Direction of the scroll.
+ * Acceptable values are: `up`, `down`, `left` and `right` (case insensitive).
+ * @param {number} percent The size of the scroll as a percentage of the scrolling area size.
+ * Valid values must be float numbers greater than zero, where 1.0 is 100%.
+ * @param {string} [elementId] The id of the element to be scrolled.
+ * If the element id is missing then scroll bounding area must be provided.
+ * If both the element id and the scroll bounding area are provided then this
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the scroll bounding area.
+ * @param {number} [top] The top coordinate of the scroll bounding area.
+ * @param {number} [width] The width of the scroll bounding area.
+ * @param {number} [height] The height of the scroll bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 5000 * displayDensity.
  * @returns {Promise<boolean>} True if the object can still scroll in the given direction.
  */
-export function mobileScrollGesture(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").ScrollGestureOptions): Promise<boolean>;
+export function mobileScrollGesture(this: import("../driver").AndroidUiautomator2Driver, direction: string, percent: number, elementId?: string, left?: number, top?: number, width?: number, height?: number, speed?: number): Promise<boolean>;
 /**
  * Scrolls the given scrollable element `elementId` until `elementToId`
  * becomes visible. This function returns immediately if the `elementToId`
@@ -82,11 +173,16 @@ export function mobileScrollGesture(this: import("../driver").AndroidUiautomator
  * by scrolling its parent to the end step by step. The scroll direction (vertical or horizontal)
  * is detected automatically.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').ScrollElementToElementOpts} opts
+ * @param {string} elementId The identifier of the scrollable element, which is going to be scrolled.
+ * It is required this element is a valid scrollable container and it was located
+ * by `-android uiautomator` strategy.
+ * @param {string} elementToId The identifier of the item, which belongs to the scrollable element above,
+ * and which should become visible after the scrolling operation is finished.
+ * It is required this element was located by `-android uiautomator` strategy.
  * @returns {Promise<void>}
  * @throws {Error} if the scrolling operation cannot be performed
  */
-export function mobileScrollBackTo(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").ScrollElementToElementOpts): Promise<void>;
+export function mobileScrollBackTo(this: import("../driver").AndroidUiautomator2Driver, elementId: string, elementToId: string): Promise<void>;
 /**
  * Scrolls the given scrollable element until the element identified
  * by `strategy` and `selector` becomes visible. This function returns immediately if the
@@ -94,11 +190,23 @@ export function mobileScrollBackTo(this: import("../driver").AndroidUiautomator2
  * to the very beginning of the scrollable control and tries to reach the destination element
  * by scrolling its parent to the end step by step. The scroll direction (vertical or horizontal)
  * is detected automatically.
+ *
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').ScrollOptions} opts
+ * @param {string} strategy The following strategies are supported:
+ * - `accessibility id` (UiSelector().description)
+ * - `class name` (UiSelector().className)
+ * - `-android uiautomator` (UiSelector)
+ * @param {string} selector The corresponding lookup value for the given strategy.
+ * @param {string} [elementId] The identifier of an element. It is required this element is a valid scrollable container
+ * and it was located by `-android uiautomator` strategy.
+ * If this property is not provided then the first currently available scrollable view
+ * is selected for the interaction.
+ * @param {number} [maxSwipes] The maximum number of swipes to perform on the target scrollable view in order to reach
+ * the destination element. In case this value is unset then it would be retrieved from the
+ * scrollable element itself (via `getMaxSearchSwipes()` property).
  * @returns {Promise<void>}
  * @throws {Error} if the scrolling operation cannot be performed
  */
-export function mobileScroll(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").ScrollOptions): Promise<void>;
+export function mobileScroll(this: import("../driver").AndroidUiautomator2Driver, strategy: string, selector: string, elementId?: string, maxSwipes?: number): Promise<void>;
 export type AndroidUiautomator2Driver = import("../driver").AndroidUiautomator2Driver;
 //# sourceMappingURL=gestures.d.ts.map

package/build/lib/commands/gestures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gestures.d.ts","sourceRoot":"","sources":["../../../lib/commands/gestures.js"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,+FAJW,OAAO,SAAS,EAAE,YAAY,GAC5B,OAAO,CAAC,IAAI,CAAC,CAazB;AAED;;;;;;;GAOG;AACH,mGAJW,OAAO,SAAS,EAAE,gBAAgB,GAChC,OAAO,CAAC,IAAI,CAAC,CAczB;AAED;;;;;;GAMG;AACH,qGAJW,OAAO,SAAS,EAAE,kBAAkB,GAClC,OAAO,CAAC,IAAI,CAAC,CAazB;AAED;;;;;;GAMG;AACH,6FAJW,OAAO,SAAS,EAAE,WAAW,GAC3B,OAAO,CAAC,IAAI,CAAC,CAezB;AAED;;;;;;;GAOG;AACH,8FAHW,OAAO,SAAS,EAAE,YAAY,GAC5B,OAAO,CAAC,OAAO,CAAC,CAgB5B;AAED;;;;;;GAMG;AACH,mGAJW,OAAO,SAAS,EAAE,YAAY,GAC5B,OAAO,CAAC,IAAI,CAAC,CAezB;AAED;;;;;;GAMG;AACH,kGAJW,OAAO,SAAS,EAAE,YAAY,GAC5B,OAAO,CAAC,IAAI,CAAC,CAezB;AAED;;;;;;GAMG;AACH,8FAJW,OAAO,SAAS,EAAE,YAAY,GAC5B,OAAO,CAAC,IAAI,CAAC,CAgBzB;AAED;;;;;;;GAOG;AACH,+FAHW,OAAO,SAAS,EAAE,oBAAoB,GACpC,OAAO,CAAC,OAAO,CAAC,CAiB5B;AAED;;;;;;;;;;;GAWG;AACH,8FAJW,OAAO,SAAS,EAAE,0BAA0B,GAC1C,OAAO,CAAC,IAAI,CAAC,CAiBzB;AAED;;;;;;;;;;;GAWG;AACH,wFAJW,OAAO,SAAS,EAAE,aAAa,GAC7B,OAAO,CAAC,IAAI,CAAC,CAuBzB;wCAwCY,OAAO,WAAW,EAAE,yBAAyB"}
+{"version":3,"file":"gestures.d.ts","sourceRoot":"","sources":["../../../lib/commands/gestures.js"],"names":[],"mappings":"AAIA;;;;;;;;;;;;GAYG;AACH,oGATW,MAAM,MAIN,MAAM,MACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAYzB;AAED;;;;;;;;;;;;;;GAcG;AACH,wGAXW,MAAM,MAIN,MAAM,MACN,MAAM,aACN,MAAM,GAEJ,OAAO,CAAC,IAAI,CAAC,CAazB;AAED;;;;;;;;;;;GAWG;AACH,0GATW,MAAM,MAIN,MAAM,MACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAYzB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,mGAdW,MAAM,WAIN,MAAM,WACN,MAAM,SACN,MAAM,SACN,MAAM,UACN,MAAM,GAGJ,OAAO,CAAC,IAAI,CAAC,CAqBzB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,mGAfW,MAAM,cAEN,MAAM,SAIN,MAAM,QACN,MAAM,UACN,MAAM,WACN,MAAM,UACN,MAAM,GAGJ,OAAO,CAAC,OAAO,CAAC,CAuB5B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,sGAhBW,MAAM,cAEN,MAAM,SAIN,MAAM,QACN,MAAM,UACN,MAAM,WACN,MAAM,UACN,MAAM,GAGJ,OAAO,CAAC,IAAI,CAAC,CAsBzB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qGAhBW,MAAM,cAEN,MAAM,SAIN,MAAM,QACN,MAAM,UACN,MAAM,WACN,MAAM,UACN,MAAM,GAGJ,OAAO,CAAC,IAAI,CAAC,CAsBzB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,mGAlBW,MAAM,WAEN,MAAM,cAEN,MAAM,SAIN,MAAM,QACN,MAAM,UACN,MAAM,WACN,MAAM,UACN,MAAM,GAGJ,OAAO,CAAC,IAAI,CAAC,CAwBzB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,oGAjBW,MAAM,WAEN,MAAM,cAEN,MAAM,SAIN,MAAM,QACN,MAAM,UACN,MAAM,WACN,MAAM,UACN,MAAM,GAGJ,OAAO,CAAC,OAAO,CAAC,CAyB5B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,mGATW,MAAM,eAGN,MAAM,GAGJ,OAAO,CAAC,IAAI,CAAC,CAgBzB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,4FAfW,MAAM,YAIN,MAAM,cACN,MAAM,cAIN,MAAM,GAGJ,OAAO,CAAC,IAAI,CAAC,CAsBzB;wCAwCY,OAAO,WAAW,EAAE,yBAAyB"}

package/build/lib/commands/gestures.js

@@ -21,12 +21,16 @@ const driver_1 = require("appium/driver");
  * Performs a simple click/tap gesture
  *
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').ClickOptions} [opts={}]
+ * @param {string} [elementId] The id of the element to be clicked.
+ * If the element is missing then both click offset coordinates must be provided.
+ * If both the element id and offset are provided then the coordinates are parsed
+ * as relative offsets from the top left corner of the element.
+ * @param {number} [x] The x coordinate to click on.
+ * @param {number} [y] The y coordinate to click on.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-async function mobileClickGesture(opts = {}) {
-    const { elementId, x, y } = opts;
+async function mobileClickGesture(elementId, x, y) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/click', 'POST', {
         origin: toOrigin(elementId),
         offset: toPoint(x, y),
@@ -36,12 +40,18 @@ async function mobileClickGesture(opts = {}) {
  * Performs a click that lasts for the given duration
  *
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').LongClickOptions} [opts={}]
+ * @param {string} [elementId] The id of the element to be clicked.
+ * If the element is missing then both click offset coordinates must be provided.
+ * If both the element id and offset are provided then the coordinates are parsed
+ * as relative offsets from the top left corner of the element.
+ * @param {number} [x] The x coordinate to click on.
+ * @param {number} [y] The y coordinate to click on.
+ * @param {number} [duration] Click duration in milliseconds. The value must not be negative.
+ * Default is 500.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-async function mobileLongClickGesture(opts = {}) {
-    const { elementId, x, y, duration } = opts;
+async function mobileLongClickGesture(elementId, x, y, duration) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/long_click', 'POST', {
         origin: toOrigin(elementId),
         offset: toPoint(x, y),
@@ -51,12 +61,16 @@ async function mobileLongClickGesture(opts = {}) {
 /**
  * Performs a click that lasts for the given duration
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').DoubleClickOptions} [opts={}]
+ * @param {string} [elementId] The id of the element to be clicked.
+ * If the element is missing then both click offset coordinates must be provided.
+ * If both the element id and offset are provided then the coordinates are parsed
+ * as relative offsets from the top left corner of the element.
+ * @param {number} [x] The x coordinate to click on.
+ * @param {number} [y] The y coordinate to click on.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-async function mobileDoubleClickGesture(opts = {}) {
-    const { elementId, x, y } = opts;
+async function mobileDoubleClickGesture(elementId, x, y) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/double_click', 'POST', {
         origin: toOrigin(elementId),
         offset: toPoint(x, y),
@@ -65,12 +79,21 @@ async function mobileDoubleClickGesture(opts = {}) {
 /**
  * Drags this object to the specified location.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').DragOptions} opts
+ * @param {string} [elementId] The id of the element to be dragged.
+ * If the element id is missing then the start coordinates must be provided.
+ * If both the element id and the start coordinates are provided then these
+ * coordinates are considered as offsets from the top left element corner.
+ * @param {number} [startX] The x coordinate where the dragging starts
+ * @param {number} [startY] The y coordinate where the dragging starts
+ * @param {number} [endX] The x coordinate where the dragging ends
+ * @param {number} [endY] The y coordinate where the dragging ends
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 2500 * displayDensity.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-async function mobileDragGesture(opts) {
-    const { elementId, startX, startY, endX, endY, speed } = opts;
+async function mobileDragGesture(elementId, startX, startY, endX, endY, speed) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/drag', 'POST', {
         origin: toOrigin(elementId),
         start: toPoint(startX, startY),
@@ -83,11 +106,22 @@ async function mobileDragGesture(opts) {
  *
  * @throws {Error} if provided options are not valid
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').FlingOptions} opts
+ * @param {string} direction Direction of the fling.
+ * Acceptable values are: `up`, `down`, `left` and `right` (case insensitive).
+ * @param {string} [elementId] The id of the element to be flinged.
+ * If the element id is missing then fling bounding area must be provided.
+ * If both the element id and the fling bounding area are provided then this
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the fling bounding area.
+ * @param {number} [top] The top coordinate of the fling bounding area.
+ * @param {number} [width] The width of the fling bounding area.
+ * @param {number} [height] The height of the fling bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must be greater than the minimum fling velocity for the given view (50 by default).
+ * Default is 7500 * displayDensity.
  * @returns {Promise<boolean>} True if the object can still scroll in the given direction.
  */
-async function mobileFlingGesture(opts) {
-    const { elementId, left, top, width, height, direction, speed } = opts;
+async function mobileFlingGesture(direction, elementId, left, top, width, height, speed) {
     return /** @type {boolean} */ (await this.uiautomator2.jwproxy.command('/appium/gestures/fling', 'POST', {
         origin: toOrigin(elementId),
         area: toRect(left, top, width, height),
@@ -98,12 +132,23 @@ async function mobileFlingGesture(opts) {
 /**
  * Performs a pinch close gesture.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').PinchOptions} opts
+ * @param {number} percent The size of the pinch as a percentage of the pinch area size.
+ * Valid values must be float numbers in range 0..1, where 1.0 is 100%
+ * @param {string} [elementId] The id of the element to be pinched.
+ * If the element id is missing then pinch bounding area must be provided.
+ * If both the element id and the pinch bounding area are provided then the
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the pinch bounding area.
+ * @param {number} [top] The top coordinate of the pinch bounding area.
+ * @param {number} [width] The width of the pinch bounding area.
+ * @param {number} [height] The height of the pinch bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 2500 * displayDensity.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-async function mobilePinchCloseGesture(opts) {
-    const { elementId, left, top, width, height, percent, speed } = opts;
+async function mobilePinchCloseGesture(percent, elementId, left, top, width, height, speed) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/pinch_close', 'POST', {
         origin: toOrigin(elementId),
         area: toRect(left, top, width, height),
@@ -114,12 +159,23 @@ async function mobilePinchCloseGesture(opts) {
 /**
  * Performs a pinch open gesture.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').PinchOptions} opts
+ * @param {number} percent The size of the pinch as a percentage of the pinch area size.
+ * Valid values must be float numbers in range 0..1, where 1.0 is 100%
+ * @param {string} [elementId] The id of the element to be pinched.
+ * If the element id is missing then pinch bounding area must be provided.
+ * If both the element id and the pinch bounding area are provided then the
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the pinch bounding area.
+ * @param {number} [top] The top coordinate of the pinch bounding area.
+ * @param {number} [width] The width of the pinch bounding area.
+ * @param {number} [height] The height of the pinch bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 2500 * displayDensity.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-async function mobilePinchOpenGesture(opts) {
-    const { elementId, left, top, width, height, percent, speed } = opts;
+async function mobilePinchOpenGesture(percent, elementId, left, top, width, height, speed) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/pinch_open', 'POST', {
         origin: toOrigin(elementId),
         area: toRect(left, top, width, height),
@@ -130,12 +186,25 @@ async function mobilePinchOpenGesture(opts) {
 /**
  * Performs a swipe gesture.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').SwipeOptions} opts
+ * @param {string} direction Direction of the swipe.
+ * Acceptable values are: `up`, `down`, `left` and `right` (case insensitive).
+ * @param {number} percent The size of the swipe as a percentage of the swipe area size.
+ * Valid values must be float numbers in range 0..1, where 1.0 is 100%.
+ * @param {string} [elementId] The id of the element to be swiped.
+ * If the element id is missing then swipe bounding area must be provided.
+ * If both the element id and the swipe bounding area are provided then the
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the swipe bounding area.
+ * @param {number} [top] The top coordinate of the swipe bounding area.
+ * @param {number} [width] The width of the swipe bounding area.
+ * @param {number} [height] The height of the swipe bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 5000 * displayDensity.
  * @returns {Promise<void>}
  * @throws {Error} if provided options are not valid
  */
-async function mobileSwipeGesture(opts) {
-    const { elementId, left, top, width, height, direction, percent, speed } = opts;
+async function mobileSwipeGesture(direction, percent, elementId, left, top, width, height, speed) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/swipe', 'POST', {
         origin: toOrigin(elementId),
         area: toRect(left, top, width, height),
@@ -149,11 +218,24 @@ async function mobileSwipeGesture(opts) {
  *
  * @throws {Error} if provided options are not valid
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').ScrollGestureOptions} opts
+ * @param {string} direction Direction of the scroll.
+ * Acceptable values are: `up`, `down`, `left` and `right` (case insensitive).
+ * @param {number} percent The size of the scroll as a percentage of the scrolling area size.
+ * Valid values must be float numbers greater than zero, where 1.0 is 100%.
+ * @param {string} [elementId] The id of the element to be scrolled.
+ * If the element id is missing then scroll bounding area must be provided.
+ * If both the element id and the scroll bounding area are provided then this
+ * area is effectively ignored.
+ * @param {number} [left] The left coordinate of the scroll bounding area.
+ * @param {number} [top] The top coordinate of the scroll bounding area.
+ * @param {number} [width] The width of the scroll bounding area.
+ * @param {number} [height] The height of the scroll bounding area.
+ * @param {number} [speed] The speed at which to perform this gesture in pixels per second.
+ * The value must not be negative.
+ * Default is 5000 * displayDensity.
  * @returns {Promise<boolean>} True if the object can still scroll in the given direction.
  */
-async function mobileScrollGesture(opts) {
-    const { elementId, left, top, width, height, direction, percent, speed } = opts;
+async function mobileScrollGesture(direction, percent, elementId, left, top, width, height, speed) {
     return /** @type {boolean} */ (await this.uiautomator2.jwproxy.command('/appium/gestures/scroll', 'POST', {
         origin: toOrigin(elementId),
         area: toRect(left, top, width, height),
@@ -170,12 +252,16 @@ async function mobileScrollGesture(opts) {
  * by scrolling its parent to the end step by step. The scroll direction (vertical or horizontal)
  * is detected automatically.
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').ScrollElementToElementOpts} opts
+ * @param {string} elementId The identifier of the scrollable element, which is going to be scrolled.
+ * It is required this element is a valid scrollable container and it was located
+ * by `-android uiautomator` strategy.
+ * @param {string} elementToId The identifier of the item, which belongs to the scrollable element above,
+ * and which should become visible after the scrolling operation is finished.
+ * It is required this element was located by `-android uiautomator` strategy.
  * @returns {Promise<void>}
  * @throws {Error} if the scrolling operation cannot be performed
  */
-async function mobileScrollBackTo(opts) {
-    const { elementId, elementToId } = opts;
+async function mobileScrollBackTo(elementId, elementToId) {
     if (!elementId || !elementToId) {
         throw new driver_1.errors.InvalidArgumentError(`Both elementId and elementToId arguments must be provided`);
     }
@@ -188,13 +274,24 @@ async function mobileScrollBackTo(opts) {
  * to the very beginning of the scrollable control and tries to reach the destination element
  * by scrolling its parent to the end step by step. The scroll direction (vertical or horizontal)
  * is detected automatically.
+ *
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').ScrollOptions} opts
+ * @param {string} strategy The following strategies are supported:
+ * - `accessibility id` (UiSelector().description)
+ * - `class name` (UiSelector().className)
+ * - `-android uiautomator` (UiSelector)
+ * @param {string} selector The corresponding lookup value for the given strategy.
+ * @param {string} [elementId] The identifier of an element. It is required this element is a valid scrollable container
+ * and it was located by `-android uiautomator` strategy.
+ * If this property is not provided then the first currently available scrollable view
+ * is selected for the interaction.
+ * @param {number} [maxSwipes] The maximum number of swipes to perform on the target scrollable view in order to reach
+ * the destination element. In case this value is unset then it would be retrieved from the
+ * scrollable element itself (via `getMaxSearchSwipes()` property).
  * @returns {Promise<void>}
  * @throws {Error} if the scrolling operation cannot be performed
  */
-async function mobileScroll(opts) {
-    const { elementId, strategy, selector, maxSwipes, } = opts;
+async function mobileScroll(strategy, selector, elementId, maxSwipes) {
     if (!strategy || !selector) {
         throw new driver_1.errors.InvalidArgumentError(`Both strategy and selector arguments must be provided`);
     }

package/build/lib/commands/gestures.js.map

@@ -1 +1 @@
-{"version":3,"file":"gestures.js","sourceRoot":"","sources":["../../../lib/commands/gestures.js"],"names":[],"mappings":";;;;;AAYA,gDAUC;AAUD,wDAWC;AASD,4DAUC;AASD,8CAYC;AAUD,gDAcC;AASD,0DAYC;AASD,wDAYC;AASD,gDAaC;AAUD,kDAeC;AAcD,gDAcC;AAcD,oCAoBC;AAlQD,4CAAoC;AACpC,oDAAuB;AACvB,0CAAqC;AAErC;;;;;;;GAOG;AACI,KAAK,UAAU,kBAAkB,CAAC,IAAI,GAAG,EAAE;IAChD,MAAM,EAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAC,GAAG,IAAI,CAAC;IAC/B,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,wBAAwB,EACxB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;KACtB,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,sBAAsB,CAAC,IAAI,GAAG,EAAE;IACpD,MAAM,EAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC;IACzC,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,6BAA6B,EAC7B,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;QACrB,QAAQ;KACT,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,wBAAwB,CAAC,IAAI,GAAG,EAAE;IACtD,MAAM,EAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAC,GAAG,IAAI,CAAC;IAC/B,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,+BAA+B,EAC/B,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;KACtB,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CAAC,IAAI;IAC1C,MAAM,EAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAC,GAAG,IAAI,CAAC;IAC5D,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,uBAAuB,EACvB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;QAC9B,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC;QACxB,KAAK;KACN,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,kBAAkB,CAAC,IAAI;IAC3C,MAAM,EAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAC,GAAG,IAAI,CAAC;IACrE,OAAO,sBAAsB,CAAC,CAC5B,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,wBAAwB,EACxB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,SAAS;QACT,KAAK;KACN,CACF,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,uBAAuB,CAAC,IAAI;IAChD,MAAM,EAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,IAAI,CAAC;IACnE,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,8BAA8B,EAC9B,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,OAAO;QACP,KAAK;KACN,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAAC,IAAI;IAC/C,MAAM,EAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,IAAI,CAAC;IACnE,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,6BAA6B,EAC7B,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,OAAO;QACP,KAAK;KACN,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,kBAAkB,CAAC,IAAI;IAC3C,MAAM,EAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,IAAI,CAAC;IAC9E,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,wBAAwB,EACxB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,SAAS;QACT,OAAO;QACP,KAAK;KACN,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,mBAAmB,CAAC,IAAI;IAC5C,MAAM,EAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,IAAI,CAAC;IAC9E,OAAO,sBAAsB,CAAC,CAC5B,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,yBAAyB,EACzB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,SAAS;QACT,OAAO;QACP,KAAK;KACN,CACF,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,kBAAkB,CAAC,IAAI;IAC3C,MAAM,EAAC,SAAS,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC;IACtC,IAAI,CAAC,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,2DAA2D,CAC5D,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,mBAAmB,cAAI,CAAC,aAAa,CAAC,SAAS,CAAC,cAAc,cAAI,CAAC,aAAa,CAC9E,WAAW,CACZ,EAAE,EACH,MAAM,EACN,EAAE,CACH,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,YAAY,CAAC,IAAI;IACrC,MAAM,EACJ,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,SAAS,GACV,GAAG,IAAI,CAAC;IACT,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC3B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,uDAAuD,CACxD,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,qBAAqB,EACrB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,EAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAC;KACxC,CACF,CAAC;AACJ,CAAC;AAED,2BAA2B;AAE3B;;;;GAIG;AACH,SAAS,QAAQ,CAAC,OAAO;IACvB,OAAO,OAAO,CAAC,CAAC,CAAC,cAAI,CAAC,WAAW,CAAC,cAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7E,CAAC;AAED;;;;;GAKG;AACH,SAAS,OAAO,CAAC,CAAC,EAAE,CAAC;IACnB,OAAO,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7D,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM;IACtC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,EAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAC,CAAC;AACjC,CAAC;AAED,aAAa;AAEb;;GAEG"}
+{"version":3,"file":"gestures.js","sourceRoot":"","sources":["../../../lib/commands/gestures.js"],"names":[],"mappings":";;;;;AAiBA,gDASC;AAiBD,wDAUC;AAcD,4DASC;AAmBD,8CAkBC;AAsBD,gDAqBC;AAqBD,0DAmBC;AAqBD,wDAmBC;AAuBD,gDAqBC;AAwBD,kDAuBC;AAmBD,gDAaC;AA0BD,oCAmBC;AApZD,4CAAoC;AACpC,oDAAuB;AACvB,0CAAqC;AAErC;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,kBAAkB,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;IACtD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,wBAAwB,EACxB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;KACtB,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,sBAAsB,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ;IACpE,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,6BAA6B,EAC7B,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;QACrB,QAAQ;KACT,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,wBAAwB,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;IAC5D,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,+BAA+B,EAC/B,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;KACtB,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,iBAAiB,CACrC,SAAS,EACT,MAAM,EACN,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,KAAK;IAEL,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,uBAAuB,EACvB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;QAC9B,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC;QACxB,KAAK;KACN,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,kBAAkB,CACtC,SAAS,EACT,SAAS,EACT,IAAI,EACJ,GAAG,EACH,KAAK,EACL,MAAM,EACN,KAAK;IAEL,OAAO,sBAAsB,CAAC,CAC5B,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,wBAAwB,EACxB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,SAAS;QACT,KAAK;KACN,CACF,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,uBAAuB,CAC3C,OAAO,EACP,SAAS,EACT,IAAI,EACJ,GAAG,EACH,KAAK,EACL,MAAM,EACN,KAAK;IAEL,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,8BAA8B,EAC9B,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,OAAO;QACP,KAAK;KACN,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,sBAAsB,CAC1C,OAAO,EACP,SAAS,EACT,IAAI,EACJ,GAAG,EACH,KAAK,EACL,MAAM,EACN,KAAK;IAEL,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,6BAA6B,EAC7B,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,OAAO;QACP,KAAK;KACN,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,KAAK,UAAU,kBAAkB,CACtC,SAAS,EACT,OAAO,EACP,SAAS,EACT,IAAI,EACJ,GAAG,EACH,KAAK,EACL,MAAM,EACN,KAAK;IAEL,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,wBAAwB,EACxB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,SAAS;QACT,OAAO;QACP,KAAK;KACN,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,KAAK,UAAU,mBAAmB,CACvC,SAAS,EACT,OAAO,EACP,SAAS,EACT,IAAI,EACJ,GAAG,EACH,KAAK,EACL,MAAM,EACN,KAAK;IAEL,OAAO,sBAAsB,CAAC,CAC5B,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,yBAAyB,EACzB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,SAAS;QACT,OAAO;QACP,KAAK;KACN,CACF,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,kBAAkB,CAAC,SAAS,EAAE,WAAW;IAC7D,IAAI,CAAC,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,2DAA2D,CAC5D,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,mBAAmB,cAAI,CAAC,aAAa,CAAC,SAAS,CAAC,cAAc,cAAI,CAAC,aAAa,CAC9E,WAAW,CACZ,EAAE,EACH,MAAM,EACN,EAAE,CACH,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,YAAY,CAChC,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,SAAS;IAET,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC3B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,uDAAuD,CACxD,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,qBAAqB,EACrB,MAAM,EACN;QACE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,EAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAC;KACxC,CACF,CAAC;AACJ,CAAC;AAED,2BAA2B;AAE3B;;;;GAIG;AACH,SAAS,QAAQ,CAAC,OAAO;IACvB,OAAO,OAAO,CAAC,CAAC,CAAC,cAAI,CAAC,WAAW,CAAC,cAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7E,CAAC;AAED;;;;;GAKG;AACH,SAAS,OAAO,CAAC,CAAC,EAAE,CAAC;IACnB,OAAO,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7D,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM;IACtC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,EAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAC,CAAC;AACjC,CAAC;AAED,aAAa;AAEb;;GAEG"}

package/build/lib/commands/keyboard.d.ts

@@ -16,20 +16,27 @@ export function pressKeyCode(this: import("../driver").AndroidUiautomator2Driver
 export function longPressKeyCode(this: import("../driver").AndroidUiautomator2Driver, keycode: string | number, metastate: number, flags?: number): Promise<void>;
 /**
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').PressKeyOptions} opts
+ * @param {number} keycode A valid Android key code. See https://developer.android.com/reference/android/view/KeyEvent
+ * for the list of available key codes.
+ * @param {number} [metastate] An integer in which each bit set to 1 represents a pressed meta key. See
+ * https://developer.android.com/reference/android/view/KeyEvent for more details.
+ * @param {string} [flags] Flags for the particular key event. See
+ * https://developer.android.com/reference/android/view/KeyEvent for more details.
+ * @param {boolean} [isLongPress=false] Whether to emulate long key press
  * @returns {Promise<void>}
  */
-export function mobilePressKey(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").PressKeyOptions): Promise<void>;
+export function mobilePressKey(this: import("../driver").AndroidUiautomator2Driver, keycode: number, metastate?: number, flags?: string, isLongPress?: boolean): Promise<void>;
 /**
  * Types the given Unicode string.
  * It is expected that the focus is already put
  * to the destination input field before this method is called.
+ *
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').TypingOptions} opts
+ * @param {string | number | boolean} text The text to type. Can be a string, number or boolean.
  * @returns {Promise<boolean>} `true` if the input text has been successfully sent to adb
  * @throws {Error} if `text` property has not been provided
  */
-export function mobileType(this: import("../driver").AndroidUiautomator2Driver, opts: import("./types").TypingOptions): Promise<boolean>;
+export function mobileType(this: import("../driver").AndroidUiautomator2Driver, text: string | number | boolean): Promise<boolean>;
 /**
  * @this {AndroidUiautomator2Driver}
  * @param {import('appium-android-driver').SendKeysOpts} params

package/build/lib/commands/keyboard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../../lib/commands/keyboard.js"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,2FALW,MAAM,GAAC,MAAM,cACb,MAAM,UACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAYzB;AAED;;;;;;GAMG;AACH,+FALW,MAAM,GAAC,MAAM,aACb,MAAM,UACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAYzB;AAED;;;;GAIG;AACH,0FAHW,OAAO,SAAS,EAAE,eAAe,GAC/B,OAAO,CAAC,IAAI,CAAC,CAczB;AAED;;;;;;;;GAQG;AACH,sFAJW,OAAO,SAAS,EAAE,aAAa,GAC7B,OAAO,CAAC,OAAO,CAAC,CAS5B;AAED;;;;GAIG;AACH,wFAHW,OAAO,uBAAuB,EAAE,YAAY,GAC1C,OAAO,CAAC,IAAI,CAAC,CAQzB;AAED;;;;;GAKG;AACH,uFAJW,MAAM,GAAC,MAAM,cACb,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAKzB;wCAGY,OAAO,WAAW,EAAE,yBAAyB"}
+{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../../lib/commands/keyboard.js"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,2FALW,MAAM,GAAC,MAAM,cACb,MAAM,UACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAYzB;AAED;;;;;;GAMG;AACH,+FALW,MAAM,GAAC,MAAM,aACb,MAAM,UACN,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAYzB;AAED;;;;;;;;;;GAUG;AACH,6FATW,MAAM,cAEN,MAAM,UAEN,MAAM,gBAEN,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CAYzB;AAED;;;;;;;;;GASG;AACH,sFAJW,MAAM,GAAG,MAAM,GAAG,OAAO,GACvB,OAAO,CAAC,OAAO,CAAC,CAQ5B;AAED;;;;GAIG;AACH,wFAHW,OAAO,uBAAuB,EAAE,YAAY,GAC1C,OAAO,CAAC,IAAI,CAAC,CAQzB;AAED;;;;;GAKG;AACH,uFAJW,MAAM,GAAC,MAAM,cACb,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAKzB;wCAGY,OAAO,WAAW,EAAE,yBAAyB"}

package/build/lib/commands/keyboard.js

@@ -9,6 +9,7 @@ exports.mobilePressKey = mobilePressKey;
 exports.mobileType = mobileType;
 exports.doSendKeys = doSendKeys;
 exports.keyevent = keyevent;
+const driver_1 = require("appium/driver");
 const lodash_1 = __importDefault(require("lodash"));
 /**
  * @this {AndroidUiautomator2Driver}
@@ -40,11 +41,16 @@ async function longPressKeyCode(keycode, metastate, flags) {
 }
 /**
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').PressKeyOptions} opts
+ * @param {number} keycode A valid Android key code. See https://developer.android.com/reference/android/view/KeyEvent
+ * for the list of available key codes.
+ * @param {number} [metastate] An integer in which each bit set to 1 represents a pressed meta key. See
+ * https://developer.android.com/reference/android/view/KeyEvent for more details.
+ * @param {string} [flags] Flags for the particular key event. See
+ * https://developer.android.com/reference/android/view/KeyEvent for more details.
+ * @param {boolean} [isLongPress=false] Whether to emulate long key press
  * @returns {Promise<void>}
  */
-async function mobilePressKey(opts) {
-    const { keycode, metastate, flags, isLongPress = false } = opts;
+async function mobilePressKey(keycode, metastate, flags, isLongPress = false) {
     await this.uiautomator2.jwproxy.command(`/appium/device/${isLongPress ? 'long_' : ''}press_keycode`, 'POST', {
         keycode,
         metastate,
@@ -55,15 +61,15 @@ async function mobilePressKey(opts) {
  * Types the given Unicode string.
  * It is expected that the focus is already put
  * to the destination input field before this method is called.
+ *
  * @this {AndroidUiautomator2Driver}
- * @param {import('./types').TypingOptions} opts
+ * @param {string | number | boolean} text The text to type. Can be a string, number or boolean.
  * @returns {Promise<boolean>} `true` if the input text has been successfully sent to adb
  * @throws {Error} if `text` property has not been provided
  */
-async function mobileType(opts) {
-    const { text } = opts;
+async function mobileType(text) {
     if (lodash_1.default.isUndefined(text)) {
-        throw this.log.errorWithException(`The 'text' argument is mandatory`);
+        throw new driver_1.errors.InvalidArgumentError(`The 'text' argument is mandatory`);
     }
     return await this.settingsApp.typeUnicode(String(text));
 }