@limrun/appium-xcuitest-driver 10.11.0-lim.3 → 10.14.6-lim.1

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

@@ -1,108 +1,124 @@
+import type { Element, Position, Size, Rect } from '@appium/types';
+import type { XCUITestDriver } from '../driver';
+import type { AtomsElement } from './types';
 /**
- * @this {XCUITestDriver}
+ * Checks whether an element is displayed.
+ *
+ * @param el - Element or element ID
  */
-export function elementDisplayed(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
+export declare function elementDisplayed(this: XCUITestDriver, el: Element | string): Promise<boolean>;
 /**
- * @this {XCUITestDriver}
+ * Checks whether an element is enabled.
+ *
+ * @param el - Element or element ID
  */
-export function elementEnabled(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
+export declare function elementEnabled(this: XCUITestDriver, el: Element | string): Promise<boolean>;
 /**
- * @this {XCUITestDriver}
+ * Checks whether an element is selected.
+ *
+ * @param el - Element or element ID
  */
-export function elementSelected(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
+export declare function elementSelected(this: XCUITestDriver, el: Element | string): Promise<boolean>;
 /**
- * @this {XCUITestDriver}
+ * Gets the tag/name of an element.
+ *
+ * @param el - Element or element ID
  */
-export function getName(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
+export declare function getName(this: XCUITestDriver, el: Element | string): Promise<string>;
 /**
- * @this {XCUITestDriver}
+ * Gets a native attribute (non-web) from an element.
+ *
+ * @param attribute - Attribute name
+ * @param el - Element or element ID
  */
-export function getNativeAttribute(this: import("../driver").XCUITestDriver, attribute: any, el: any): Promise<string | null>;
+export declare function getNativeAttribute(this: XCUITestDriver, attribute: string, el: Element | string): Promise<string | null>;
 /**
- * @this {XCUITestDriver}
+ * Gets an element attribute (web or native).
+ *
+ * @param attribute - Attribute name
+ * @param el - Element or element ID
  */
-export function getAttribute(this: import("../driver").XCUITestDriver, attribute: any, el: any): Promise<any>;
+export declare function getAttribute(this: XCUITestDriver, attribute: string, el: Element | string): Promise<string | null>;
 /**
- * @this {XCUITestDriver}
+ * Gets an element property (web) or native attribute fallback.
+ *
+ * @param property - Property name
+ * @param el - Element or element ID
  */
-export function getProperty(this: import("../driver").XCUITestDriver, property: any, el: any): Promise<any>;
+export declare function getProperty(this: XCUITestDriver, property: string, el: Element | string): Promise<string | null>;
 /**
- * @this {XCUITestDriver}
+ * Gets the text content of an element.
+ *
+ * @param el - Element or element ID
  */
-export function getText(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
+export declare function getText(this: XCUITestDriver, el: Element | string): Promise<string>;
 /**
- * @this {XCUITestDriver}
- * @returns {Promise<import('@appium/types').Rect>}
+ * Gets the bounding rect of an element.
+ *
+ * @param el - Element or element ID
  */
-export function getElementRect(this: import("../driver").XCUITestDriver, el: any): Promise<import("@appium/types").Rect>;
+export declare function getElementRect(this: XCUITestDriver, el: Element | string): Promise<Rect>;
 /**
- * Get the position of an element on screen
+ * Gets the top-left location of an element.
  *
- * @param {string|Element} elementId - the element ID
- * @returns {Promise<Position>} The position of the element
- * @deprecated Use {@linkcode XCUITestDriver.getElementRect} instead
- * @this {XCUITestDriver}
+ * @param elementId - Element or element ID
  */
-export function getLocation(this: import("../driver").XCUITestDriver, elementId: string | Element): Promise<Position>;
+export declare function getLocation(this: XCUITestDriver, elementId: Element | string): Promise<Position>;
 /**
- * Alias for {@linkcode XCUITestDriver.getLocation}
- * @param {string|Element} elementId - the element ID
- * @returns {Promise<Position>} The position of the element
- * @deprecated Use {@linkcode XCUITestDriver.getElementRect} instead
- * @this {XCUITestDriver}
+ * Alias for getLocation.
+ *
+ * @param elementId - Element or element ID
  */
-export function getLocationInView(this: import("../driver").XCUITestDriver, elementId: string | Element): Promise<Position>;
+export declare function getLocationInView(this: XCUITestDriver, elementId: Element | string): Promise<Position>;
 /**
- * Get the size of an element
- * @param {string|Element} el - the element ID
- * @returns {Promise<Size>} The position of the element
- * @this {XCUITestDriver}
+ * Gets the size of an element.
+ *
+ * @param el - Element or element ID
  */
-export function getSize(this: import("../driver").XCUITestDriver, el: string | Element): Promise<Size>;
+export declare function getSize(this: XCUITestDriver, el: Element | string): Promise<Size>;
 /**
- * Alias for {@linkcode setValue}
+ * Legacy alias for setValue; always types via keyboard.
  *
- * @param {string} value - the value to set
- * @param {string} el - the element to set the value of
- * @deprecated
- * @this {XCUITestDriver}
+ * @param value - Value to set
+ * @param el - Element or element ID
  */
-export function setValueImmediate(this: import("../driver").XCUITestDriver, value: string, el: string): Promise<void>;
+export declare function setValueImmediate(this: XCUITestDriver, value: string | string[] | number, el: Element | string): Promise<void>;
 /**
- * @this {XCUITestDriver}
+ * Sets an element value (native or web).
+ *
+ * @param value - Value to set
+ * @param el - Element or element ID
  */
-export function setValue(this: import("../driver").XCUITestDriver, value: any, el: any): Promise<void>;
+export declare function setValue(this: XCUITestDriver, value: string | string[] | number, el: Element | string): Promise<void>;
 /**
- * Set value with Atom for Web. This method calls `type` atom only.
- * Expected to be called as part of {@linkcode setValue}.
- * @this {XCUITestDriver}
- * @param {import('./types').AtomsElement<string>} atomsElement A target element to type the given value.
- * @param {string|string[]} value The actual text to type.
+ * Types text into a web element using atoms.
+ *
+ * @param atomsElement - Target atoms element
+ * @param value - Text to type
  */
-export function setValueWithWebAtom(this: import("../driver").XCUITestDriver, atomsElement: import("./types").AtomsElement<string>, value: string | string[]): Promise<void>;
+export declare function setValueWithWebAtom(this: XCUITestDriver, atomsElement: AtomsElement<string>, value: string | string[] | number): Promise<void>;
 /**
- * Send keys to the app
- * @param {string[]} value - Array of keys to send
- * @this {XCUITestDriver}
- * @deprecated Use {@linkcode XCUITestDriver.setValue} instead
+ * Sends raw key sequences via WDA.
+ *
+ * @param value - Keys to send
  */
-export function keys(this: import("../driver").XCUITestDriver, value: string[]): Promise<void>;
+export declare function keys(this: XCUITestDriver, value: string[] | string | number): Promise<void>;
 /**
- * @this {XCUITestDriver}
+ * Clears the contents of an element.
+ *
+ * @param el - Element or element ID
  */
-export function clear(this: import("../driver").XCUITestDriver, el: any): Promise<void>;
+export declare function clear(this: XCUITestDriver, el: Element | string): Promise<void>;
 /**
- * @this {XCUITestDriver}
+ * Gets content size for table/collection views (native only).
+ *
+ * @param el - Element or element ID
  */
-export function getContentSize(this: import("../driver").XCUITestDriver, el: any): Promise<string>;
+export declare function getContentSize(this: XCUITestDriver, el: Element | string): Promise<string>;
 /**
- * @this {XCUITestDriver}
- * @returns {Promise<Rect>}
+ * Gets the native rect of an element (no web fallback).
+ *
+ * @param el - Element or element ID
  */
-export function getNativeRect(this: import("../driver").XCUITestDriver, el: any): Promise<Rect>;
-export type XCUITestDriver = import("../driver").XCUITestDriver;
-export type Element = import("@appium/types").Element;
-export type Position = import("@appium/types").Position;
-export type Size = import("@appium/types").Size;
-export type Rect = import("@appium/types").Rect;
+export declare function getNativeRect(this: XCUITestDriver, el: Element | string): Promise<Rect>;
 //# 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;;GAEG;AACH,kGAQC;AAED;;GAEG;AACH,gGAQC;AAED;;GAEG;AACH,iGAQC;AAED;;GAEG;AACH,yFASC;AAED;;GAEG;AACH,8HAkBC;AAED;;GAEG;AACH,8GAOC;AAED;;GAEG;AACH,4GAOC;AAED;;GAEG;AACH,yFAOC;AAED;;;GAGG;AACH,mFAFa,OAAO,CAAC,OAAO,eAAe,EAAE,IAAI,CAAC,CAYjD;AAED;;;;;;;GAOG;AACH,iFALW,MAAM,GAAC,OAAO,GACZ,OAAO,CAAC,QAAQ,CAAC,CAuB7B;AAED;;;;;;GAMG;AACH,uFALW,MAAM,GAAC,OAAO,GACZ,OAAO,CAAC,QAAQ,CAAC,CAM7B;AAED;;;;;GAKG;AACH,sEAJW,MAAM,GAAC,OAAO,GACZ,OAAO,CAAC,IAAI,CAAC,CAWzB;AAED;;;;;;;GAOG;AACH,mFALW,MAAM,MACN,MAAM,iBAUhB;AAED;;GAEG;AACH,uGAmBC;AAED;;;;;;GAMG;AACH,4FAHW,OAAO,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,SACtC,MAAM,GAAC,MAAM,EAAE,iBAqBzB;AAED;;;;;GAKG;AACH,sEAJW,MAAM,EAAE,iBAQlB;AAED;;GAEG;AACH,wFAQC;AAED;;GAEG;AACH,mGA4EC;AAED;;;GAGG;AACH,kFAFa,OAAO,CAAC,IAAI,CAAC,CAIzB;6BAiDY,OAAO,WAAW,EAAE,cAAc;sBAClC,OAAO,eAAe,EAAE,OAAO;uBAC/B,OAAO,eAAe,EAAE,QAAQ;mBAChC,OAAO,eAAe,EAAE,IAAI;mBAC5B,OAAO,eAAe,EAAE,IAAI"}
+{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../../../lib/commands/element.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAC,MAAM,eAAe,CAAC;AACjE,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,SAAS,CAAC;AAE1C;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAOnG;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAOjG;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAOlG;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAQzF;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,cAAc,EACpB,SAAS,EAAE,MAAM,EACjB,EAAE,EAAE,OAAO,GAAG,MAAM,GACnB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAgBxB;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,cAAc,EACpB,SAAS,EAAE,MAAM,EACjB,EAAE,EAAE,OAAO,GAAG,MAAM,GACnB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAOxB;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,OAAO,GAAG,MAAM,GACnB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAOxB;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAOzF;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAQ9F;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAkBtG;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAE5G;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAOvF;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,cAAc,EACpB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EACjC,EAAE,EAAE,OAAO,GAAG,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CAKf;AAED;;;;;GAKG;AACH,wBAAsB,QAAQ,CAC5B,IAAI,EAAE,cAAc,EACpB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EACjC,EAAE,EAAE,OAAO,GAAG,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CAmBf;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,cAAc,EACpB,YAAY,EAAE,YAAY,CAAC,MAAM,CAAC,EAClC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAChC,OAAO,CAAC,IAAI,CAAC,CAmBf;AAED;;;;GAIG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAIjG;AAED;;;;GAIG;AACH,wBAAsB,KAAK,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAQrF;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAmEhG;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG7F"}