appium-uiautomator2-driver 6.7.5 → 6.7.7

package/build/lib/commands/gestures.js

@@ -14,21 +14,14 @@ exports.mobileSwipeGesture = mobileSwipeGesture;
 exports.mobileScrollGesture = mobileScrollGesture;
 exports.mobileScrollBackTo = mobileScrollBackTo;
 exports.mobileScroll = mobileScroll;
+const driver_1 = require("appium/driver");
 const support_1 = require("appium/support");
 const lodash_1 = __importDefault(require("lodash"));
-const driver_1 = require("appium/driver");
 /**
- * Performs a simple click/tap gesture
- *
- * @this {AndroidUiautomator2Driver}
- * @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
+ * Performs a simple click/tap gesture.
+ * @param elementId - Optional element to use as the origin for the click. If not provided, uses screen coordinates.
+ * @param x - Optional X offset from the element origin or screen.
+ * @param y - Optional Y offset from the element origin or screen.
  */
 async function mobileClickGesture(elementId, x, y) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/click', 'POST', {
@@ -37,19 +30,11 @@ async function mobileClickGesture(elementId, x, y) {
     });
 }
 /**
- * Performs a click that lasts for the given duration
- *
- * @this {AndroidUiautomator2Driver}
- * @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
+ * Performs a long click with an optional duration.
+ * @param elementId - Optional element to use as the origin for the long click.
+ * @param x - Optional X offset from the element origin or screen.
+ * @param y - Optional Y offset from the element origin or screen.
+ * @param duration - Optional duration of the long press in milliseconds.
  */
 async function mobileLongClickGesture(elementId, x, y, duration) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/long_click', 'POST', {
@@ -59,16 +44,10 @@ async function mobileLongClickGesture(elementId, x, y, duration) {
     });
 }
 /**
- * Performs a click that lasts for the given duration
- * @this {AndroidUiautomator2Driver}
- * @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
+ * Performs a double-click gesture.
+ * @param elementId - Optional element to use as the origin for the double click.
+ * @param x - Optional X offset from the element origin or screen.
+ * @param y - Optional Y offset from the element origin or screen.
  */
 async function mobileDoubleClickGesture(elementId, x, y) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/double_click', 'POST', {
@@ -77,21 +56,13 @@ async function mobileDoubleClickGesture(elementId, x, y) {
     });
 }
 /**
- * Drags this object to the specified location.
- * @this {AndroidUiautomator2Driver}
- * @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
+ * Drags from a start point to an end point.
+ * @param elementId - Optional element to use as the origin for the drag.
+ * @param startX - X coordinate of the drag start point.
+ * @param startY - Y coordinate of the drag start point.
+ * @param endX - X coordinate of the drag end point.
+ * @param endY - Y coordinate of the drag end point.
+ * @param speed - Optional speed of the drag gesture.
  */
 async function mobileDragGesture(elementId, startX, startY, endX, endY, speed) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/drag', 'POST', {
@@ -102,27 +73,18 @@ async function mobileDragGesture(elementId, startX, startY, endX, endY, speed) {
     });
 }
 /**
- * Drags to the specified location.
- *
- * @throws {Error} if provided options are not valid
- * @this {AndroidUiautomator2Driver}
- * @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.
+ * Performs a fling gesture and reports if further scrolling is possible.
+ * @param direction - Direction of the fling ('up', 'down', 'left', 'right').
+ * @param elementId - Optional element to use as the origin for the fling.
+ * @param left - Optional left coordinate of the fling area.
+ * @param top - Optional top coordinate of the fling area.
+ * @param width - Optional width of the fling area.
+ * @param height - Optional height of the fling area.
+ * @param speed - Optional speed of the fling gesture.
+ * @returns True if further scrolling is possible, false otherwise.
  */
 async function mobileFlingGesture(direction, elementId, left, top, width, height, speed) {
-    return /** @type {boolean} */ (await this.uiautomator2.jwproxy.command('/appium/gestures/fling', 'POST', {
+    return (await this.uiautomator2.jwproxy.command('/appium/gestures/fling', 'POST', {
         origin: toOrigin(elementId),
         area: toRect(left, top, width, height),
         direction,
@@ -130,23 +92,14 @@ async function mobileFlingGesture(direction, elementId, left, top, width, height
     }));
 }
 /**
- * Performs a pinch close gesture.
- * @this {AndroidUiautomator2Driver}
- * @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
+ * Performs a pinch-close gesture.
+ * @param percent - Percentage of the pinch (0-100).
+ * @param elementId - Optional element to use as the origin for the pinch.
+ * @param left - Optional left coordinate of the pinch area.
+ * @param top - Optional top coordinate of the pinch area.
+ * @param width - Optional width of the pinch area.
+ * @param height - Optional height of the pinch area.
+ * @param speed - Optional speed of the pinch gesture.
  */
 async function mobilePinchCloseGesture(percent, elementId, left, top, width, height, speed) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/pinch_close', 'POST', {
@@ -157,23 +110,14 @@ async function mobilePinchCloseGesture(percent, elementId, left, top, width, hei
     });
 }
 /**
- * Performs a pinch open gesture.
- * @this {AndroidUiautomator2Driver}
- * @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
+ * Performs a pinch-open gesture.
+ * @param percent - Percentage of the pinch (0-100).
+ * @param elementId - Optional element to use as the origin for the pinch.
+ * @param left - Optional left coordinate of the pinch area.
+ * @param top - Optional top coordinate of the pinch area.
+ * @param width - Optional width of the pinch area.
+ * @param height - Optional height of the pinch area.
+ * @param speed - Optional speed of the pinch gesture.
  */
 async function mobilePinchOpenGesture(percent, elementId, left, top, width, height, speed) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/pinch_open', 'POST', {
@@ -184,25 +128,15 @@ async function mobilePinchOpenGesture(percent, elementId, left, top, width, heig
     });
 }
 /**
- * Performs a swipe gesture.
- * @this {AndroidUiautomator2Driver}
- * @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
+ * Performs a swipe gesture for the given direction and percent.
+ * @param direction - Direction of the swipe ('up', 'down', 'left', 'right').
+ * @param percent - Percentage of the swipe distance (0-100).
+ * @param elementId - Optional element to use as the origin for the swipe.
+ * @param left - Optional left coordinate of the swipe area.
+ * @param top - Optional top coordinate of the swipe area.
+ * @param width - Optional width of the swipe area.
+ * @param height - Optional height of the swipe area.
+ * @param speed - Optional speed of the swipe gesture.
  */
 async function mobileSwipeGesture(direction, percent, elementId, left, top, width, height, speed) {
     await this.uiautomator2.jwproxy.command('/appium/gestures/swipe', 'POST', {
@@ -214,29 +148,19 @@ async function mobileSwipeGesture(direction, percent, elementId, left, top, widt
     });
 }
 /**
- * Performs a scroll gesture.
- *
- * @throws {Error} if provided options are not valid
- * @this {AndroidUiautomator2Driver}
- * @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.
+ * Performs a scroll gesture and reports if further scrolling is possible.
+ * @param direction - Direction of the scroll ('up', 'down', 'left', 'right').
+ * @param percent - Percentage of the scroll distance (0-100).
+ * @param elementId - Optional element to use as the origin for the scroll.
+ * @param left - Optional left coordinate of the scroll area.
+ * @param top - Optional top coordinate of the scroll area.
+ * @param width - Optional width of the scroll area.
+ * @param height - Optional height of the scroll area.
+ * @param speed - Optional speed of the scroll gesture.
+ * @returns True if further scrolling is possible, false otherwise.
  */
 async function mobileScrollGesture(direction, percent, elementId, left, top, width, height, speed) {
-    return /** @type {boolean} */ (await this.uiautomator2.jwproxy.command('/appium/gestures/scroll', 'POST', {
+    return (await this.uiautomator2.jwproxy.command('/appium/gestures/scroll', 'POST', {
         origin: toOrigin(elementId),
         area: toRect(left, top, width, height),
         direction,
@@ -245,21 +169,10 @@ async function mobileScrollGesture(direction, percent, elementId, left, top, wid
     }));
 }
 /**
- * Scrolls the given scrollable element `elementId` until `elementToId`
- * becomes visible. This function returns immediately if the `elementToId`
- * is already visible in the view port. Otherwise it would scroll
- * 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 {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
+ * Scrolls a scrollable element until a target element becomes visible.
+ * @param elementId - ID of the scrollable element.
+ * @param elementToId - ID of the target element to scroll to.
+ * @throws {errors.InvalidArgumentError} If either elementId or elementToId is not provided.
  */
 async function mobileScrollBackTo(elementId, elementToId) {
     if (!elementId || !elementToId) {
@@ -268,28 +181,12 @@ async function mobileScrollBackTo(elementId, elementToId) {
     await this.uiautomator2.jwproxy.command(`/appium/element/${support_1.util.unwrapElement(elementId)}/scroll_to/${support_1.util.unwrapElement(elementToId)}`, 'POST', {});
 }
 /**
- * Scrolls the given scrollable element until the element identified
- * by `strategy` and `selector` becomes visible. This function returns immediately if the
- * destination element is already visible in the view port. Otherwise it would scroll
- * 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 {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
+ * Scrolls until an element located by the given strategy is visible.
+ * @param strategy - Locator strategy to use (e.g., 'id', 'xpath', 'class name').
+ * @param selector - Selector string for the element to find.
+ * @param elementId - Optional element to use as the origin for scrolling.
+ * @param maxSwipes - Optional maximum number of swipes to perform.
+ * @throws {errors.InvalidArgumentError} If either strategy or selector is not provided.
  */
 async function mobileScroll(strategy, selector, elementId, maxSwipes) {
     if (!strategy || !selector) {
@@ -300,39 +197,15 @@ async function mobileScroll(strategy, selector, elementId, maxSwipes) {
         params: { strategy, selector, maxSwipes },
     });
 }
-// #region Internal Helpers
-/**
- *
- * @param {import('@appium/types').Element|string} [element]
- * @returns {import('@appium/types').Element|undefined}
- */
 function toOrigin(element) {
     return element ? support_1.util.wrapElement(support_1.util.unwrapElement(element)) : undefined;
 }
-/**
- *
- * @param {number} [x]
- * @param {number} [y]
- * @returns {Partial<import('@appium/types').Position>|undefined}
- */
 function toPoint(x, y) {
     return lodash_1.default.isFinite(x) && lodash_1.default.isFinite(y) ? { x, y } : undefined;
 }
-/**
- *
- * @param {number} [left]
- * @param {number} [top]
- * @param {number} [width]
- * @param {number} [height]
- * @returns {Partial<import('./types').RelativeRect>|undefined}
- */
 function toRect(left, top, width, height) {
     return [left, top, width, height].some((v) => !lodash_1.default.isFinite(v))
         ? undefined
         : { left, top, width, height };
 }
-// #endregion
-/**
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */
 //# sourceMappingURL=gestures.js.map

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"gestures.js","sourceRoot":"","sources":["../../../lib/commands/gestures.ts"],"names":[],"mappings":";;;;;AAaA,gDAUC;AASD,wDAYC;AAQD,4DAUC;AAWD,8CAeC;AAaD,gDAgBC;AAYD,0DAgBC;AAYD,wDAgBC;AAaD,gDAkBC;AAcD,kDAkBC;AAQD,gDAaC;AAUD,oCAcC;AAzRD,0CAAqC;AACrC,4CAAoC;AACpC,oDAAuB;AAKvB;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CAEtC,SAAkC,EAClC,CAAU,EACV,CAAU;IAEV,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,EAAE;QACxE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;KACtB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAE1C,SAAkC,EAClC,CAAU,EACV,CAAU,EACV,QAAiB;IAEjB,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,6BAA6B,EAAE,MAAM,EAAE;QAC7E,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;QACrB,QAAQ;KACT,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,wBAAwB,CAE5C,SAAkC,EAClC,CAAU,EACV,CAAU;IAEV,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,+BAA+B,EAAE,MAAM,EAAE;QAC/E,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;KACtB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,iBAAiB,CAErC,SAAkC,EAClC,MAAe,EACf,MAAe,EACf,IAAa,EACb,IAAa,EACb,KAAc;IAEd,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,uBAAuB,EAAE,MAAM,EAAE;QACvE,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,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,kBAAkB,CAEtC,SAAiB,EACjB,SAAkC,EAClC,IAAa,EACb,GAAY,EACZ,KAAc,EACd,MAAe,EACf,KAAc;IAEd,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,EAAE;QAChF,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,SAAS;QACT,KAAK;KACN,CAAC,CAAY,CAAC;AACjB,CAAC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,uBAAuB,CAE3C,OAAe,EACf,SAAkC,EAClC,IAAa,EACb,GAAY,EACZ,KAAc,EACd,MAAe,EACf,KAAc;IAEd,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,8BAA8B,EAAE,MAAM,EAAE;QAC9E,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,OAAO;QACP,KAAK;KACN,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,sBAAsB,CAE1C,OAAe,EACf,SAAkC,EAClC,IAAa,EACb,GAAY,EACZ,KAAc,EACd,MAAe,EACf,KAAc;IAEd,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,6BAA6B,EAAE,MAAM,EAAE;QAC7E,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;QACtC,OAAO;QACP,KAAK;KACN,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,kBAAkB,CAEtC,SAAiB,EACjB,OAAe,EACf,SAAkC,EAClC,IAAa,EACb,GAAY,EACZ,KAAc,EACd,MAAe,EACf,KAAc;IAEd,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,EAAE;QACxE,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,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,mBAAmB,CAEvC,SAAiB,EACjB,OAAe,EACf,SAAkC,EAClC,IAAa,EACb,GAAY,EACZ,KAAc,EACd,MAAe,EACf,KAAc;IAEd,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,yBAAyB,EAAE,MAAM,EAAE;QACjF,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,CAAC,CAAY,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CAEtC,SAAkB,EAClB,WAAoB;IAEpB,IAAI,CAAC,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,2DAA2D,CAAC,CAAC;IACrG,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CACrC,mBAAmB,cAAI,CAAC,aAAa,CAAC,SAAS,CAAC,cAAc,cAAI,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,EAC/F,MAAM,EACN,EAAE,CACH,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,YAAY,CAEhC,QAAgB,EAChB,QAAgB,EAChB,SAAkC,EAClC,SAAkB;IAElB,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC3B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,uDAAuD,CAAC,CAAC;IACjG,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,EAAE;QACrE,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC;QAC3B,MAAM,EAAE,EAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAC;KACxC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,OAAgC;IAChD,OAAO,OAAO,CAAC,CAAC,CAAE,cAAI,CAAC,WAAW,CAAC,cAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAmB,CAAC,CAAC,CAAC,SAAS,CAAC;AAChG,CAAC;AAED,SAAS,OAAO,CAAC,CAAU,EAAE,CAAU;IACrC,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,SAAS,MAAM,CAAC,IAAa,EAAE,GAAY,EAAE,KAAc,EAAE,MAAe;IAC1E,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,CAAE,EAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAkB,CAAC;AACnD,CAAC"}

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

@@ -1,54 +1,43 @@
+import type { AndroidUiautomator2Driver } from '../driver';
+import type { SendKeysOpts } from 'appium-android-driver';
 /**
- * @this {AndroidUiautomator2Driver}
- * @param {string|number} keycode
- * @param {number} [metastate]
- * @param {number} [flags]
- * @returns {Promise<void>}
+ * Presses a key code with optional metastate and flags.
+ * @param keycode - Android key code to press.
+ * @param metastate - Optional meta state modifier keys.
+ * @param flags - Optional flags for the key event.
  */
-export function pressKeyCode(this: import("../driver").AndroidUiautomator2Driver, keycode: string | number, metastate?: number, flags?: number): Promise<void>;
+export declare function pressKeyCode(this: AndroidUiautomator2Driver, keycode: string | number, metastate?: number, flags?: number): Promise<void>;
 /**
- * @this {AndroidUiautomator2Driver}
- * @param {string|number} keycode
- * @param {number} metastate
- * @param {number} [flags]
- * @returns {Promise<void>}
+ * Long presses a key code with optional metastate and flags.
+ * @param keycode - Android key code to long press.
+ * @param metastate - Meta state modifier keys.
+ * @param flags - Optional flags for the key event.
  */
-export function longPressKeyCode(this: import("../driver").AndroidUiautomator2Driver, keycode: string | number, metastate: number, flags?: number): Promise<void>;
+export declare function longPressKeyCode(this: AndroidUiautomator2Driver, keycode: string | number, metastate: number, flags?: number): Promise<void>;
 /**
- * @this {AndroidUiautomator2Driver}
- * @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>}
+ * Presses a key code with optional metastate, flags, and long press support.
+ * @param keycode - Android key code to press.
+ * @param metastate - Optional meta state modifier keys.
+ * @param flags - Optional flags for the key event.
+ * @param isLongPress - Whether to perform a long press. Defaults to false.
  */
-export function mobilePressKey(this: import("../driver").AndroidUiautomator2Driver, keycode: number, metastate?: number, flags?: string, isLongPress?: boolean): Promise<void>;
+export declare function mobilePressKey(this: 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 {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
+ * Types the given Unicode string. The focus should already be on the destination input field.
+ * @param text - Text to type. Can be a string, number, or boolean.
+ * @returns True if the input text has been successfully sent to adb.
+ * @throws {errors.InvalidArgumentError} If the text argument is not provided.
  */
-export function mobileType(this: import("../driver").AndroidUiautomator2Driver, text: string | number | boolean): Promise<boolean>;
+export declare function mobileType(this: AndroidUiautomator2Driver, text: string | number | boolean): Promise<boolean>;
 /**
- * @this {AndroidUiautomator2Driver}
- * @param {import('appium-android-driver').SendKeysOpts} params
- * @returns {Promise<void>}
+ * Sends keys to the current element.
+ * @param params - Options containing the text to send and optional replace flag.
  */
-export function doSendKeys(this: import("../driver").AndroidUiautomator2Driver, params: import("appium-android-driver").SendKeysOpts): Promise<void>;
+export declare function doSendKeys(this: AndroidUiautomator2Driver, params: SendKeysOpts): Promise<void>;
 /**
- * @this {AndroidUiautomator2Driver}
- * @param {string|number} keycode
- * @param {number} [metastate]
- * @returns {Promise<void>}
+ * Sends a key event to the device.
+ * @param keycode - Android key code to send.
+ * @param metastate - Optional meta state (ignored in this implementation).
  */
-export function keyevent(this: import("../driver").AndroidUiautomator2Driver, keycode: string | number, metastate?: number): Promise<void>;
-export type AndroidUiautomator2Driver = import("../driver").AndroidUiautomator2Driver;
+export declare function keyevent(this: AndroidUiautomator2Driver, keycode: string | number, metastate?: number): Promise<void>;
 //# sourceMappingURL=keyboard.d.ts.map

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../../lib/commands/keyboard.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,yBAAyB,EAAC,MAAM,WAAW,CAAC;AACzD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAExD;;;;;GAKG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,yBAAyB,EAC/B,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,SAAS,CAAC,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC,CAMf;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,yBAAyB,EAC/B,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC,CAMf;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,yBAAyB,EAC/B,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,MAAM,EACd,WAAW,GAAE,OAAe,GAC3B,OAAO,CAAC,IAAI,CAAC,CAMf;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,yBAAyB,EAC/B,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAC9B,OAAO,CAAC,OAAO,CAAC,CAKlB;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,yBAAyB,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAErG;AAED;;;;GAIG;AACH,wBAAsB,QAAQ,CAC5B,IAAI,EAAE,yBAAyB,EAC/B,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAGf"}

package/build/lib/commands/keyboard.js

@@ -12,11 +12,10 @@ exports.keyevent = keyevent;
 const driver_1 = require("appium/driver");
 const lodash_1 = __importDefault(require("lodash"));
 /**
- * @this {AndroidUiautomator2Driver}
- * @param {string|number} keycode
- * @param {number} [metastate]
- * @param {number} [flags]
- * @returns {Promise<void>}
+ * Presses a key code with optional metastate and flags.
+ * @param keycode - Android key code to press.
+ * @param metastate - Optional meta state modifier keys.
+ * @param flags - Optional flags for the key event.
  */
 async function pressKeyCode(keycode, metastate, flags) {
     await this.uiautomator2.jwproxy.command('/appium/device/press_keycode', 'POST', {
@@ -26,11 +25,10 @@ async function pressKeyCode(keycode, metastate, flags) {
     });
 }
 /**
- * @this {AndroidUiautomator2Driver}
- * @param {string|number} keycode
- * @param {number} metastate
- * @param {number} [flags]
- * @returns {Promise<void>}
+ * Long presses a key code with optional metastate and flags.
+ * @param keycode - Android key code to long press.
+ * @param metastate - Meta state modifier keys.
+ * @param flags - Optional flags for the key event.
  */
 async function longPressKeyCode(keycode, metastate, flags) {
     await this.uiautomator2.jwproxy.command('/appium/device/long_press_keycode', 'POST', {
@@ -40,15 +38,11 @@ async function longPressKeyCode(keycode, metastate, flags) {
     });
 }
 /**
- * @this {AndroidUiautomator2Driver}
- * @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>}
+ * Presses a key code with optional metastate, flags, and long press support.
+ * @param keycode - Android key code to press.
+ * @param metastate - Optional meta state modifier keys.
+ * @param flags - Optional flags for the key event.
+ * @param isLongPress - Whether to perform a long press. Defaults to false.
  */
 async function mobilePressKey(keycode, metastate, flags, isLongPress = false) {
     await this.uiautomator2.jwproxy.command(`/appium/device/${isLongPress ? 'long_' : ''}press_keycode`, 'POST', {
@@ -58,14 +52,10 @@ async function mobilePressKey(keycode, metastate, flags, isLongPress = false) {
     });
 }
 /**
- * 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 {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
+ * Types the given Unicode string. The focus should already be on the destination input field.
+ * @param text - Text to type. Can be a string, number, or boolean.
+ * @returns True if the input text has been successfully sent to adb.
+ * @throws {errors.InvalidArgumentError} If the text argument is not provided.
  */
 async function mobileType(text) {
     if (lodash_1.default.isUndefined(text)) {
@@ -74,24 +64,19 @@ async function mobileType(text) {
     return await this.settingsApp.typeUnicode(String(text));
 }
 /**
- * @this {AndroidUiautomator2Driver}
- * @param {import('appium-android-driver').SendKeysOpts} params
- * @returns {Promise<void>}
+ * Sends keys to the current element.
+ * @param params - Options containing the text to send and optional replace flag.
  */
 async function doSendKeys(params) {
     await this.uiautomator2.jwproxy.command('/keys', 'POST', params);
 }
 /**
- * @this {AndroidUiautomator2Driver}
- * @param {string|number} keycode
- * @param {number} [metastate]
- * @returns {Promise<void>}
+ * Sends a key event to the device.
+ * @param keycode - Android key code to send.
+ * @param metastate - Optional meta state (ignored in this implementation).
  */
 async function keyevent(keycode, metastate) {
     this.log.debug(`Ignoring metastate ${metastate}`);
     await this.adb.keyevent(keycode);
 }
-/**
- * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
- */
 //# sourceMappingURL=keyboard.js.map