appium-android-driver 12.4.8 → 12.4.10

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [12.4.10](https://github.com/appium/appium-android-driver/compare/v12.4.9...v12.4.10) (2025-12-20)
+
+### Miscellaneous Chores
+
+* Migrate more command modules to Typescript (part 4) ([#1041](https://github.com/appium/appium-android-driver/issues/1041)) ([ca117ac](https://github.com/appium/appium-android-driver/commit/ca117ac1a5781b94a2816028b5da04192ad146cf))
+
+## [12.4.9](https://github.com/appium/appium-android-driver/compare/v12.4.8...v12.4.9) (2025-12-19)
+
+### Miscellaneous Chores
+
+* Migrate command modules to typescript (part3) ([#1040](https://github.com/appium/appium-android-driver/issues/1040)) ([ebc73ba](https://github.com/appium/appium-android-driver/commit/ebc73bac7433c552c41bc241bfec535c30b3b157))
+
 ## [12.4.8](https://github.com/appium/appium-android-driver/compare/v12.4.7...v12.4.8) (2025-12-19)
 
 ### Miscellaneous Chores

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

@@ -1,102 +1,126 @@
+import type { Position, Size } from '@appium/types';
+import type { AndroidDriver } from '../driver';
+import type { DoSetElementValueOpts } from './types';
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} attribute
- * @param {string} elementId
- * @returns {Promise<string?>}
+ * Gets an attribute value from an element.
+ *
+ * @param attribute The name of the attribute to retrieve.
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the attribute value, or `null` if not found.
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
-export function getAttribute(this: import("../driver").AndroidDriver, attribute: string, elementId: string): Promise<string | null>;
+export declare function getAttribute(this: AndroidDriver, attribute: string, elementId: string): Promise<string | null>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<void>}
+ * Clicks on an element.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves when the click is performed.
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
-export function click(this: import("../driver").AndroidDriver, elementId: string): Promise<void>;
+export declare function click(this: AndroidDriver, elementId: string): Promise<void>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<string>}
+ * Gets the text content of an element.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's text content.
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
-export function getText(this: import("../driver").AndroidDriver, elementId: string): Promise<string>;
+export declare function getText(this: AndroidDriver, elementId: string): Promise<string>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<import('@appium/types').Position>}
+ * Gets the location of an element on the screen.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's position (x, y coordinates).
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
-export function getLocation(this: import("../driver").AndroidDriver, elementId: string): Promise<import("@appium/types").Position>;
+export declare function getLocation(this: AndroidDriver, elementId: string): Promise<Position>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<import('@appium/types').Size>}
+ * Gets the size of an element.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's size (width, height).
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
-export function getSize(this: import("../driver").AndroidDriver, elementId: string): Promise<import("@appium/types").Size>;
+export declare function getSize(this: AndroidDriver, elementId: string): Promise<Size>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<string>}
+ * Gets the class name of an element.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's class name.
  */
-export function getName(this: import("../driver").AndroidDriver, elementId: string): Promise<string>;
+export declare function getName(this: AndroidDriver, elementId: string): Promise<string>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<boolean>}
+ * Checks if an element is displayed.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to `true` if the element is displayed, `false` otherwise.
  */
-export function elementDisplayed(this: import("../driver").AndroidDriver, elementId: string): Promise<boolean>;
+export declare function elementDisplayed(this: AndroidDriver, elementId: string): Promise<boolean>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<boolean>}
+ * Checks if an element is enabled.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to `true` if the element is enabled, `false` otherwise.
  */
-export function elementEnabled(this: import("../driver").AndroidDriver, elementId: string): Promise<boolean>;
+export declare function elementEnabled(this: AndroidDriver, elementId: string): Promise<boolean>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<boolean>}
+ * Checks if an element is selected.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to `true` if the element is selected, `false` otherwise.
  */
-export function elementSelected(this: import("../driver").AndroidDriver, elementId: string): Promise<boolean>;
+export declare function elementSelected(this: AndroidDriver, elementId: string): Promise<boolean>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string|string[]} keys
- * @param {string} elementId
- * @param {boolean} [replace=false]
- * @returns {Promise<void>}
+ * Sets the value of an element.
+ *
+ * @param keys The text to set, either as a string or an array of strings (which will be joined).
+ * @param elementId The element identifier.
+ * @param replace If `true`, replaces the existing value. If `false`, appends to it. Defaults to `false`.
+ * @returns Promise that resolves when the value is set.
  */
-export function setElementValue(this: import("../driver").AndroidDriver, keys: string | string[], elementId: string, replace?: boolean): Promise<void>;
+export declare function setElementValue(this: AndroidDriver, keys: string | string[], elementId: string, replace?: boolean): Promise<void>;
 /**
+ * Sets the value of an element.
+ *
  * Reason for isolating doSetElementValue from setElementValue is for reusing setElementValue
  * across android-drivers (like appium-uiautomator2-driver) and to avoid code duplication.
  * Other android-drivers (like appium-uiautomator2-driver) need to override doSetElementValue
  * to facilitate setElementValue.
  *
- * @this {import('../driver').AndroidDriver}
- * @param {import('./types').DoSetElementValueOpts} params
- * @returns {Promise<void>}
+ * @param params The parameters for setting the element value.
+ * @returns Promise that resolves when the value is set.
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
-export function doSetElementValue(this: import("../driver").AndroidDriver, params: import("./types").DoSetElementValueOpts): Promise<void>;
+export declare function doSetElementValue(this: AndroidDriver, params: DoSetElementValueOpts): Promise<void>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string|string[]} keys
- * @param {string} elementId
- * @returns {Promise<void>}
+ * Sets the value of an element (appends to existing value).
+ *
+ * @param keys The text to set, either as a string or an array of strings (which will be joined).
+ * @param elementId The element identifier.
+ * @returns Promise that resolves when the value is set.
  */
-export function setValue(this: import("../driver").AndroidDriver, keys: string | string[], elementId: string): Promise<void>;
+export declare function setValue(this: AndroidDriver, keys: string | string[], elementId: string): Promise<void>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string|string[]} keys
- * @param {string} elementId
- * @returns {Promise<void>}
+ * Replaces the value of an element.
+ *
+ * @param keys The text to set, either as a string or an array of strings (which will be joined).
+ * @param elementId The element identifier.
+ * @returns Promise that resolves when the value is replaced.
  */
-export function replaceValue(this: import("../driver").AndroidDriver, keys: string | string[], elementId: string): Promise<void>;
+export declare function replaceValue(this: AndroidDriver, keys: string | string[], elementId: string): Promise<void>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string|string[]} keys
- * @param {string} elementId
- * @returns {Promise<void>}
+ * Sets the value of an element immediately using ADB input.
+ *
+ * @param keys The text to set, either as a string or an array of strings (which will be joined).
+ * @param elementId The element identifier.
+ * @returns Promise that resolves when the value is set.
  */
-export function setValueImmediate(this: import("../driver").AndroidDriver, keys: string | string[], elementId: string): Promise<void>;
+export declare function setValueImmediate(this: AndroidDriver, keys: string | string[], elementId: string): Promise<void>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<import('@appium/types').Position>}
+ * Gets the location of an element relative to the view.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's position (x, y coordinates).
  */
-export function getLocationInView(this: import("../driver").AndroidDriver, elementId: string): Promise<import("@appium/types").Position>;
+export declare function getLocationInView(this: AndroidDriver, elementId: string): Promise<Position>;
 //# sourceMappingURL=element.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../../../lib/commands/element.js"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,iFAJW,MAAM,aACN,MAAM,GACJ,OAAO,CAAC,MAAM,OAAC,CAAC,CAI5B;AAED;;;;GAIG;AACH,0EAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;;GAIG;AACH,4EAHW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAI3B;AAED;;;;GAIG;AACH,gFAHW,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,QAAQ,CAAC,CAIrD;AAED;;;;GAIG;AACH,4EAHW,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,IAAI,CAAC,CAIjD;AAED;;;;GAIG;AACH,4EAHW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAI3B;AAED;;;;GAIG;AACH,qFAHW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAI5B;AAED;;;;GAIG;AACH,mFAHW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAI5B;AAED;;;;GAIG;AACH,oFAHW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAI5B;AAED;;;;;;GAMG;AACH,+EALW,MAAM,GAAC,MAAM,EAAE,aACf,MAAM,YACN,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CASzB;AAED;;;;;;;;;GASG;AACH,mFAHW,OAAO,SAAS,EAAE,qBAAqB,GACrC,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;;;GAKG;AACH,wEAJW,MAAM,GAAC,MAAM,EAAE,aACf,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;;;GAKG;AACH,4EAJW,MAAM,GAAC,MAAM,EAAE,aACf,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;;;GAKG;AACH,iFAJW,MAAM,GAAC,MAAM,EAAE,aACf,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAQzB;AAED;;;;GAIG;AACH,sFAHW,MAAM,GACJ,OAAO,CAAC,OAAO,eAAe,EAAE,QAAQ,CAAC,CAIrD"}
+{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../../../lib/commands/element.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,QAAQ,EAAE,IAAI,EAAC,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,SAAS,CAAC;AAEnD;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAExB;AAED;;;;;;GAMG;AACH,wBAAsB,KAAK,CACzB,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;GAMG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,QAAQ,CAAC,CAEnB;AAED;;;;;;GAMG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;GAKG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC,CAElB;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC,CAElB;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC,CAElB;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CACnC,IAAI,EAAE,aAAa,EACnB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,SAAS,EAAE,MAAM,EACjB,OAAO,UAAQ,GACd,OAAO,CAAC,IAAI,CAAC,CAOf;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,aAAa,EACnB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAC5B,IAAI,EAAE,aAAa,EACnB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,aAAa,EACnB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,aAAa,EACnB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EACvB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAMf;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,QAAQ,CAAC,CAEnB"}

package/build/lib/commands/element.js

@@ -18,84 +18,99 @@ exports.setValueImmediate = setValueImmediate;
 exports.getLocationInView = getLocationInView;
 const driver_1 = require("appium/driver");
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} attribute
- * @param {string} elementId
- * @returns {Promise<string?>}
+ * Gets an attribute value from an element.
+ *
+ * @param attribute The name of the attribute to retrieve.
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the attribute value, or `null` if not found.
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
 async function getAttribute(attribute, elementId) {
     throw new driver_1.errors.NotImplementedError('Not implemented');
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<void>}
+ * Clicks on an element.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves when the click is performed.
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
 async function click(elementId) {
     throw new driver_1.errors.NotImplementedError('Not implemented');
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<string>}
+ * Gets the text content of an element.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's text content.
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
 async function getText(elementId) {
     throw new driver_1.errors.NotImplementedError('Not implemented');
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<import('@appium/types').Position>}
+ * Gets the location of an element on the screen.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's position (x, y coordinates).
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
 async function getLocation(elementId) {
     throw new driver_1.errors.NotImplementedError('Not implemented');
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<import('@appium/types').Size>}
+ * Gets the size of an element.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's size (width, height).
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
 async function getSize(elementId) {
     throw new driver_1.errors.NotImplementedError('Not implemented');
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<string>}
+ * Gets the class name of an element.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's class name.
  */
 async function getName(elementId) {
-    return /** @type {string} */ (await this.getAttribute('className', elementId));
+    return await this.getAttribute('className', elementId);
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<boolean>}
+ * Checks if an element is displayed.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to `true` if the element is displayed, `false` otherwise.
  */
 async function elementDisplayed(elementId) {
     return (await this.getAttribute('displayed', elementId)) === 'true';
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<boolean>}
+ * Checks if an element is enabled.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to `true` if the element is enabled, `false` otherwise.
  */
 async function elementEnabled(elementId) {
     return (await this.getAttribute('enabled', elementId)) === 'true';
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<boolean>}
+ * Checks if an element is selected.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to `true` if the element is selected, `false` otherwise.
  */
 async function elementSelected(elementId) {
     return (await this.getAttribute('selected', elementId)) === 'true';
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string|string[]} keys
- * @param {string} elementId
- * @param {boolean} [replace=false]
- * @returns {Promise<void>}
+ * Sets the value of an element.
+ *
+ * @param keys The text to set, either as a string or an array of strings (which will be joined).
+ * @param elementId The element identifier.
+ * @param replace If `true`, replaces the existing value. If `false`, appends to it. Defaults to `false`.
+ * @returns Promise that resolves when the value is set.
  */
 async function setElementValue(keys, elementId, replace = false) {
     const text = keys instanceof Array ? keys.join('') : keys;
@@ -106,53 +121,59 @@ async function setElementValue(keys, elementId, replace = false) {
     });
 }
 /**
+ * Sets the value of an element.
+ *
  * Reason for isolating doSetElementValue from setElementValue is for reusing setElementValue
  * across android-drivers (like appium-uiautomator2-driver) and to avoid code duplication.
  * Other android-drivers (like appium-uiautomator2-driver) need to override doSetElementValue
  * to facilitate setElementValue.
  *
- * @this {import('../driver').AndroidDriver}
- * @param {import('./types').DoSetElementValueOpts} params
- * @returns {Promise<void>}
+ * @param params The parameters for setting the element value.
+ * @returns Promise that resolves when the value is set.
+ * @throws {errors.NotImplementedError} This method is not implemented.
  */
 async function doSetElementValue(params) {
     throw new driver_1.errors.NotImplementedError('Not implemented');
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string|string[]} keys
- * @param {string} elementId
- * @returns {Promise<void>}
+ * Sets the value of an element (appends to existing value).
+ *
+ * @param keys The text to set, either as a string or an array of strings (which will be joined).
+ * @param elementId The element identifier.
+ * @returns Promise that resolves when the value is set.
  */
 async function setValue(keys, elementId) {
     return await this.setElementValue(keys, elementId, false);
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string|string[]} keys
- * @param {string} elementId
- * @returns {Promise<void>}
+ * Replaces the value of an element.
+ *
+ * @param keys The text to set, either as a string or an array of strings (which will be joined).
+ * @param elementId The element identifier.
+ * @returns Promise that resolves when the value is replaced.
  */
 async function replaceValue(keys, elementId) {
     return await this.setElementValue(keys, elementId, true);
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string|string[]} keys
- * @param {string} elementId
- * @returns {Promise<void>}
+ * Sets the value of an element immediately using ADB input.
+ *
+ * @param keys The text to set, either as a string or an array of strings (which will be joined).
+ * @param elementId The element identifier.
+ * @returns Promise that resolves when the value is set.
  */
 async function setValueImmediate(keys, elementId) {
     const text = Array.isArray(keys) ? keys.join('') : keys;
     // first, make sure we are focused on the element
     await this.click(elementId);
     // then send through adb
-    await this.adb.inputText(/** @type {string} */ (text));
+    await this.adb.inputText(text);
 }
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} elementId
- * @returns {Promise<import('@appium/types').Position>}
+ * Gets the location of an element relative to the view.
+ *
+ * @param elementId The element identifier.
+ * @returns Promise that resolves to the element's position (x, y coordinates).
  */
 async function getLocationInView(elementId) {
     return await this.getLocation(elementId);

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

@@ -1 +1 @@
-{"version":3,"file":"element.js","sourceRoot":"","sources":["../../../lib/commands/element.js"],"names":[],"mappings":";AAAA,sDAAsD;;AAUtD,oCAEC;AAOD,sBAEC;AAOD,0BAEC;AAOD,kCAEC;AAOD,0BAEC;AAOD,0BAEC;AAOD,4CAEC;AAOD,wCAEC;AAOD,0CAEC;AASD,0CAOC;AAYD,8CAEC;AAQD,4BAEC;AAQD,oCAEC;AAQD,8CAMC;AAOD,8CAEC;AA3JD,0CAAqC;AAErC;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAAC,SAAS,EAAE,SAAS;IACrD,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,KAAK,CAAC,SAAS;IACnC,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,OAAO,CAAC,SAAS;IACrC,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,WAAW,CAAC,SAAS;IACzC,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,OAAO,CAAC,SAAS;IACrC,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,OAAO,CAAC,SAAS;IACrC,OAAO,qBAAqB,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;AACjF,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,gBAAgB,CAAC,SAAS;IAC9C,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,KAAK,MAAM,CAAC;AACtE,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,cAAc,CAAC,SAAS;IAC5C,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,KAAK,MAAM,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe,CAAC,SAAS;IAC7C,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,KAAK,MAAM,CAAC;AACrE,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,GAAG,KAAK;IACpE,MAAM,IAAI,GAAG,IAAI,YAAY,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1D,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC;QAClC,SAAS;QACT,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAClB,OAAO;KACR,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,iBAAiB,CAAC,MAAM;IAC5C,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,QAAQ,CAAC,IAAI,EAAE,SAAS;IAC5C,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAAC,IAAI,EAAE,SAAS;IAChD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CAAC,IAAI,EAAE,SAAS;IACrD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxD,iDAAiD;IACjD,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC5B,wBAAwB;IACxB,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,iBAAiB,CAAC,SAAS;IAC/C,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"element.js","sourceRoot":"","sources":["../../../lib/commands/element.ts"],"names":[],"mappings":";AAAA,sDAAsD;;AAetD,oCAMC;AASD,sBAKC;AASD,0BAKC;AASD,kCAKC;AASD,0BAKC;AAQD,0BAKC;AAQD,4CAKC;AAQD,wCAKC;AAQD,0CAKC;AAUD,0CAYC;AAcD,8CAKC;AASD,4BAMC;AASD,oCAMC;AASD,8CAUC;AAQD,8CAKC;AAtOD,0CAAqC;AAKrC;;;;;;;GAOG;AACI,KAAK,UAAU,YAAY,CAEhC,SAAiB,EACjB,SAAiB;IAEjB,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,KAAK,CAEzB,SAAiB;IAEjB,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,OAAO,CAE3B,SAAiB;IAEjB,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,WAAW,CAE/B,SAAiB;IAEjB,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,OAAO,CAE3B,SAAiB;IAEjB,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,OAAO,CAE3B,SAAiB;IAEjB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,SAAS,CAAW,CAAC;AACnE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,gBAAgB,CAEpC,SAAiB;IAEjB,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,KAAK,MAAM,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,cAAc,CAElC,SAAiB;IAEjB,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,KAAK,MAAM,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,eAAe,CAEnC,SAAiB;IAEjB,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,KAAK,MAAM,CAAC;AACrE,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CAEnC,IAAuB,EACvB,SAAiB,EACjB,OAAO,GAAG,KAAK;IAEf,MAAM,IAAI,GAAG,IAAI,YAAY,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1D,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC;QAClC,SAAS;QACT,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAClB,OAAO;KACR,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,iBAAiB,CAErC,MAA6B;IAE7B,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,QAAQ,CAE5B,IAAuB,EACvB,SAAiB;IAEjB,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,YAAY,CAEhC,IAAuB,EACvB,SAAiB;IAEjB,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CAErC,IAAuB,EACvB,SAAiB;IAEjB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxD,iDAAiD;IACjD,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC5B,wBAAwB;IACxB,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CAErC,SAAiB;IAEjB,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;AAC3C,CAAC"}

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

@@ -1,26 +1,28 @@
+import type { Location } from '@appium/types';
+import type { AndroidDriver } from '../driver';
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {import('@appium/types').Location} location
- * @returns {Promise<import('@appium/types').Location>}
+ * Sets the device geolocation.
+ *
+ * @param location The geolocation object containing latitude, longitude, and altitude.
+ * @returns Promise that resolves to the current geolocation after setting it.
  */
-export function setGeoLocation(this: import("../driver").AndroidDriver, location: import("@appium/types").Location): Promise<import("@appium/types").Location>;
+export declare function setGeoLocation(this: AndroidDriver, location: Location): Promise<Location>;
 /**
  * Set the device geolocation.
  *
- * @this {import('../driver').AndroidDriver}
- * @param {number} latitude Valid latitude value.
- * @param {number} longitude Valid longitude value.
- * @param {number} [altitude] Valid altitude value.
- * @param {number} [satellites] Number of satellites being tracked (1-12). Available for emulators.
- * @param {number} [speed] Valid speed value.
+ * @param latitude Valid latitude value.
+ * @param longitude Valid longitude value.
+ * @param altitude Valid altitude value.
+ * @param satellites Number of satellites being tracked (1-12). Available for emulators.
+ * @param speed Valid speed value.
  * https://developer.android.com/reference/android/location/Location#setSpeed(float)
- * @param {number} [bearing] Valid bearing value. Available for real devices.
+ * @param bearing Valid bearing value. Available for real devices.
  * https://developer.android.com/reference/android/location/Location#setBearing(float)
- * @param {number} [accuracy] Valid accuracy value. Available for real devices.
+ * @param accuracy Valid accuracy value. Available for real devices.
  * https://developer.android.com/reference/android/location/Location#setAccuracy(float),
  * https://developer.android.com/reference/android/location/Criteria
  */
-export function mobileSetGeolocation(this: import("../driver").AndroidDriver, latitude: number, longitude: number, altitude?: number, satellites?: number, speed?: number, bearing?: number, accuracy?: number): Promise<void>;
+export declare function mobileSetGeolocation(this: AndroidDriver, latitude: number, longitude: number, altitude?: number, satellites?: number, speed?: number, bearing?: number, accuracy?: number): Promise<void>;
 /**
  * Sends an async request to refresh the GPS cache.
  *
@@ -28,43 +30,49 @@ export function mobileSetGeolocation(this: import("../driver").AndroidDriver, la
  * installed. In case the vanilla LocationManager is used the device API level
  * must be at version 30 (Android R) or higher.
  *
- * @this {import('../driver').AndroidDriver}
- * @param {number} [timeoutMs] The maximum number of milliseconds
+ * @param timeoutMs The maximum number of milliseconds
  * to block until GPS cache is refreshed. Providing zero or a negative
  * value to it skips waiting completely.
  * 20000ms by default.
- * @returns {Promise<void>}
+ * @returns Promise that resolves when the GPS cache refresh is initiated.
  */
-export function mobileRefreshGpsCache(this: import("../driver").AndroidDriver, timeoutMs?: number): Promise<void>;
+export declare function mobileRefreshGpsCache(this: AndroidDriver, timeoutMs?: number): Promise<void>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @returns {Promise<import('@appium/types').Location>}
+ * Gets the current device geolocation.
+ *
+ * @returns Promise that resolves to the current geolocation object.
  */
-export function getGeoLocation(this: import("../driver").AndroidDriver): Promise<import("@appium/types").Location>;
+export declare function getGeoLocation(this: AndroidDriver): Promise<Location>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @returns {Promise<import('@appium/types').Location>}
+ * Gets the current device geolocation.
+ *
+ * @returns Promise that resolves to the current geolocation object.
  */
-export function mobileGetGeolocation(this: import("../driver").AndroidDriver): Promise<import("@appium/types").Location>;
+export declare function mobileGetGeolocation(this: AndroidDriver): Promise<Location>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @returns {Promise<boolean>}
+ * Checks if location services are enabled.
+ *
+ * @returns Promise that resolves to `true` if location services are enabled, `false` otherwise.
  */
-export function isLocationServicesEnabled(this: import("../driver").AndroidDriver): Promise<boolean>;
+export declare function isLocationServicesEnabled(this: AndroidDriver): Promise<boolean>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @returns {Promise<void>}
+ * Toggles the location services state.
+ *
+ * @returns Promise that resolves when the location services state is toggled.
  */
-export function toggleLocationServices(this: import("../driver").AndroidDriver): Promise<void>;
+export declare function toggleLocationServices(this: AndroidDriver): Promise<void>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @returns {Promise<void>}
+ * Resets the geolocation to the default state.
+ *
+ * @returns Promise that resolves when the geolocation is reset.
+ * @throws {Error} If called on an emulator (geolocation reset does not work on emulators).
  */
-export function mobileResetGeolocation(this: import("../driver").AndroidDriver): Promise<void>;
+export declare function mobileResetGeolocation(this: AndroidDriver): Promise<void>;
 /**
- * @this {import('../driver').AndroidDriver}
- * @param {string} appId
- * @returns {Promise<void>}
+ * Sets the mock location permission for a specific app.
+ *
+ * @param appId The application package identifier.
+ * @returns Promise that resolves when the mock location permission is set.
  */
-export function setMockLocationApp(this: import("../driver").AndroidDriver, appId: string): Promise<void>;
+export declare function setMockLocationApp(this: AndroidDriver, appId: string): Promise<void>;
 //# sourceMappingURL=geolocation.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"geolocation.d.ts","sourceRoot":"","sources":["../../../lib/commands/geolocation.js"],"names":[],"mappings":"AAeA;;;;GAIG;AACH,kFAHW,OAAO,eAAe,EAAE,QAAQ,GAC9B,OAAO,CAAC,OAAO,eAAe,EAAE,QAAQ,CAAC,CAiBrD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wFAZW,MAAM,aACN,MAAM,aACN,MAAM,eACN,MAAM,UACN,MAAM,YAEN,MAAM,aAEN,MAAM,iBAsBhB;AAED;;;;;;;;;;;;;GAaG;AACH,2FANW,MAAM,GAIJ,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;GAGG;AACH,yEAFa,OAAO,CAAC,OAAO,eAAe,EAAE,QAAQ,CAAC,CASrD;AAED;;;GAGG;AACH,+EAFa,OAAO,CAAC,OAAO,eAAe,EAAE,QAAQ,CAAC,CAIrD;AAED;;;GAGG;AACH,oFAFa,OAAO,CAAC,OAAO,CAAC,CAI5B;AAED;;;GAGG;AACH,iFAFa,OAAO,CAAC,IAAI,CAAC,CAUzB;AAED;;;GAGG;AACH,iFAFa,OAAO,CAAC,IAAI,CAAC,CAOzB;AAID;;;;GAIG;AACH,mFAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAgCzB"}
+{"version":3,"file":"geolocation.d.ts","sourceRoot":"","sources":["../../../lib/commands/geolocation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AAG5C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,WAAW,CAAC;AAU7C;;;;;GAKG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,aAAa,EACnB,QAAQ,EAAE,QAAQ,GACjB,OAAO,CAAC,QAAQ,CAAC,CAenB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,aAAa,EACnB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,MAAM,EACnB,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAUf;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,aAAa,EACnB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,aAAa,GAClB,OAAO,CAAC,QAAQ,CAAC,CAOnB;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,aAAa,GAClB,OAAO,CAAC,QAAQ,CAAC,CAEnB;AAED;;;;GAIG;AACH,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,aAAa,GAClB,OAAO,CAAC,OAAO,CAAC,CAElB;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,CAC1C,IAAI,EAAE,aAAa,GAClB,OAAO,CAAC,IAAI,CAAC,CAQf;AAED;;;;;GAKG;AACH,wBAAsB,sBAAsB,CAC1C,IAAI,EAAE,aAAa,GAClB,OAAO,CAAC,IAAI,CAAC,CAKf;AAID;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,aAAa,EACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CA6Bf"}