appium-xcuitest-driver 10.13.3 → 10.14.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [10.14.0](https://github.com/appium/appium-xcuitest-driver/compare/v10.13.4...v10.14.0) (2025-12-30)
+
+### Features
+
+* add documentation for customActions ([#2690](https://github.com/appium/appium-xcuitest-driver/issues/2690)) ([c8a0473](https://github.com/appium/appium-xcuitest-driver/commit/c8a04730a62353752a5142dab04115e3afe155db))
+
+## [10.13.4](https://github.com/appium/appium-xcuitest-driver/compare/v10.13.3...v10.13.4) (2025-12-30)
+
+### Miscellaneous Chores
+
+* Migrate various command modules to typescript (part 4) ([#2689](https://github.com/appium/appium-xcuitest-driver/issues/2689)) ([e7da99b](https://github.com/appium/appium-xcuitest-driver/commit/e7da99b79461927b785ec518475ee604c163fdc9))
+
 ## [10.13.3](https://github.com/appium/appium-xcuitest-driver/compare/v10.13.2...v10.13.3) (2025-12-28)
 
 ### Miscellaneous Chores

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

@@ -1,102 +1,121 @@
+import type { XCUITestDriver } from '../driver';
+import type { Viewport, ScreenInfo, ButtonName } from './types';
+import type { Size, Rect } from '@appium/types';
 /**
- * @this {XCUITestDriver}
+ * Gets the currently active element.
+ *
+ * In web context, returns the active element from the DOM.
+ * In native context, returns the active element from the current view.
+ *
+ * @returns The active element
  */
-export function active(this: import("../driver").XCUITestDriver): Promise<any>;
+export declare function active(this: XCUITestDriver): Promise<any>;
 /**
- * Trigger a touch/fingerprint match or match failure
+ * Trigger a touch/fingerprint match or match failure.
  *
- * @param {boolean} match - whether the match should be a success or failure
- * @this {XCUITestDriver}
+ * @param match - Whether the match should be a success or failure
  */
-export function touchId(this: import("../driver").XCUITestDriver, match?: boolean): Promise<void>;
+export declare function touchId(this: XCUITestDriver, match?: boolean): Promise<void>;
 /**
- * Toggle whether the device is enrolled in the touch ID program
- *
- * @param {boolean} isEnabled - whether to enable or disable the touch ID program
+ * Toggle whether the device is enrolled in the touch ID program.
  *
- * @this {XCUITestDriver}
+ * @param isEnabled - Whether to enable or disable the touch ID program
  */
-export function toggleEnrollTouchId(this: import("../driver").XCUITestDriver, isEnabled?: boolean): Promise<void>;
+export declare function toggleEnrollTouchId(this: XCUITestDriver, isEnabled?: boolean): Promise<void>;
 /**
- * Get the window size
- * @this {XCUITestDriver}
- * @returns {Promise<import('@appium/types').Size>}
+ * Get the window size.
+ *
+ * @returns The window size (width and height)
  */
-export function getWindowSize(this: import("../driver").XCUITestDriver): Promise<import("@appium/types").Size>;
+export declare function getWindowSize(this: XCUITestDriver): Promise<Size>;
 /**
  * Retrieves the actual device time.
  *
- * @param {string} format - The format specifier string. Read the [MomentJS documentation](https://momentjs.com/docs/) to get the full list of supported datetime format specifiers. The default format is `YYYY-MM-DDTHH:mm:ssZ`, which complies to ISO-8601.
- * @returns {Promise<string>} Formatted datetime string or the raw command output (if formatting fails)
- * @this {XCUITestDriver}
+ * @param format - The format specifier string. Read the [MomentJS documentation](https://momentjs.com/docs/) to get the full list of supported datetime format specifiers. The default format is `YYYY-MM-DDTHH:mm:ssZ`, which complies to ISO-8601.
+ * @returns Formatted datetime string or the raw command output (if formatting fails)
  */
-export function getDeviceTime(this: import("../driver").XCUITestDriver, format?: string): Promise<string>;
+export declare function getDeviceTime(this: XCUITestDriver, format?: string): Promise<string>;
 /**
- * Retrieves the current device time
+ * Retrieves the current device time.
+ *
+ * This is a wrapper around {@linkcode getDeviceTime}.
  *
- * @param {string} format - See {@linkcode getDeviceTime.format}
- * @returns {Promise<string>} Formatted datetime string or the raw command output if formatting fails
- * @this {XCUITestDriver}
+ * @param format - See {@linkcode getDeviceTime.format}
+ * @returns Formatted datetime string or the raw command output if formatting fails
  */
-export function mobileGetDeviceTime(this: import("../driver").XCUITestDriver, format?: string): Promise<string>;
+export declare function mobileGetDeviceTime(this: XCUITestDriver, format?: string): Promise<string>;
 /**
- * For W3C
- * @this {XCUITestDriver}
- * @return {Promise<import('@appium/types').Rect>}
+ * Gets the window rectangle (position and size).
+ *
+ * For W3C compatibility. In web context, returns the browser window dimensions.
+ * In native context, returns the device window dimensions.
+ *
+ * @returns The window rectangle
  */
-export function getWindowRect(this: import("../driver").XCUITestDriver): Promise<import("@appium/types").Rect>;
+export declare function getWindowRect(this: XCUITestDriver): Promise<Rect>;
 /**
- * @this {XCUITestDriver}
+ * Removes/uninstalls the given application from the device under test.
+ *
+ * This is a wrapper around {@linkcode mobileRemoveApp mobile: removeApp}.
+ *
+ * @param bundleId - The bundle identifier of the application to be removed
+ * @returns `true` if the application has been removed successfully; `false` otherwise
  */
-export function removeApp(this: import("../driver").XCUITestDriver, bundleId: any): Promise<boolean>;
+export declare function removeApp(this: XCUITestDriver, bundleId: string): Promise<boolean>;
 /**
- * @this {XCUITestDriver}
+ * Launches the app.
+ *
+ * @deprecated This API has been deprecated and is not supported anymore.
+ * Consider using corresponding 'mobile:' extensions to manage the state of the app under test.
+ * @throws {Error} Always throws an error indicating the API is deprecated
  */
-export function launchApp(this: import("../driver").XCUITestDriver): Promise<void>;
+export declare function launchApp(this: XCUITestDriver): Promise<void>;
 /**
- * @this {XCUITestDriver}
+ * Closes the app.
+ *
+ * @deprecated This API has been deprecated and is not supported anymore.
+ * Consider using corresponding 'mobile:' extensions to manage the state of the app under test.
+ * @throws {Error} Always throws an error indicating the API is deprecated
  */
-export function closeApp(this: import("../driver").XCUITestDriver): Promise<void>;
+export declare function closeApp(this: XCUITestDriver): Promise<void>;
 /**
- * @this {XCUITestDriver}
- * @param {string} url
- * @returns {Promise<void>}
+ * Sets the URL for the current session.
+ *
+ * In web context, navigates to the URL using the remote debugger.
+ * In native context on real devices, uses the proxy command.
+ * In native context on simulators, uses simctl to open the URL.
+ *
+ * @param url - The URL to navigate to
  */
-export function setUrl(this: import("../driver").XCUITestDriver, url: string): Promise<void>;
-export class setUrl {
-    /**
-     * @this {XCUITestDriver}
-     * @param {string} url
-     * @returns {Promise<void>}
-     */
-    constructor(this: import("../driver").XCUITestDriver, url: string);
-    curWebFrames: any[] | undefined;
-}
+export declare function setUrl(this: XCUITestDriver, url: string): Promise<void>;
 /**
  * Retrieves the viewport dimensions.
  *
  * The viewport is the device's screen size with status bar size subtracted if the latter is present/visible.
- * @returns {Promise<import('./types').Viewport>}
- * @this {XCUITestDriver}
+ *
+ * @returns The viewport rectangle
  */
-export function getViewportRect(this: import("../driver").XCUITestDriver): Promise<import("./types").Viewport>;
+export declare function getViewportRect(this: XCUITestDriver): Promise<Viewport>;
 /**
  * Get information about the screen.
  *
  * @privateRemarks memoized in constructor
- * @this {XCUITestDriver}
- * @returns {Promise<ScreenInfo>}
+ * @returns Screen information including dimensions, scale, and status bar size
  */
-export function getScreenInfo(this: import("../driver").XCUITestDriver): Promise<ScreenInfo>;
+export declare function getScreenInfo(this: XCUITestDriver): Promise<ScreenInfo>;
 /**
- * @this {XCUITestDriver}
+ * Gets the status bar height.
+ *
+ * @returns The height of the status bar in logical pixels
  */
-export function getStatusBarHeight(this: import("../driver").XCUITestDriver): Promise<number>;
+export declare function getStatusBarHeight(this: XCUITestDriver): Promise<number>;
 /**
- * memoized in constructor
- * @this {XCUITestDriver}
+ * Gets the device pixel ratio.
+ *
+ * @privateRemarks memoized in constructor
+ * @returns The device pixel ratio (scale factor)
  */
-export function getDevicePixelRatio(this: import("../driver").XCUITestDriver): Promise<number>;
+export declare function getDevicePixelRatio(this: XCUITestDriver): Promise<number>;
 /**
  * Emulates press action on the given physical device button.
  *
@@ -107,31 +126,16 @@ export function getDevicePixelRatio(this: import("../driver").XCUITestDriver): P
  *
  * Use {@linkcode mobilePerformIoHidEvent} to call a more universal API to perform a button press with duration on any supported device.
  *
- * @param {import('./types').ButtonName} name - The name of the button to be pressed.
- * @param {number} [durationSeconds] - The duration of the button press in seconds (float).
- * @this {XCUITestDriver}
+ * @param name - The name of the button to be pressed
+ * @param durationSeconds - The duration of the button press in seconds (float)
  */
-export function mobilePressButton(this: import("../driver").XCUITestDriver, name: import("./types").ButtonName, durationSeconds?: number): Promise<unknown>;
+export declare function mobilePressButton(this: XCUITestDriver, name: ButtonName, durationSeconds?: number): Promise<void>;
 /**
  * Process a string as speech and send it to Siri.
  *
  * Presents the Siri UI, if it is not currently active, and accepts a string which is then processed as if it were recognized speech. See [the documentation of `activateWithVoiceRecognitionText`](https://developer.apple.com/documentation/xctest/xcuisiriservice/2852140-activatewithvoicerecognitiontext?language=objc) for more details.
-
- * @param {string} text - Text to be sent to Siri
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
- */
-export function mobileSiriCommand(this: import("../driver").XCUITestDriver, text: string): Promise<void>;
-export type PressButtonOptions = {
-    /**
-     * - The name of the button to be pressed.
-     */
-    name: string;
-    /**
-     * - Duration in float seconds.
-     */
-    durationSeconds?: number | undefined;
-};
-export type XCUITestDriver = import("../driver").XCUITestDriver;
-export type ScreenInfo = import("./types").ScreenInfo;
+ *
+ * @param text - Text to be sent to Siri
+ */
+export declare function mobileSiriCommand(this: XCUITestDriver, text: string): Promise<void>;
 //# sourceMappingURL=general.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"general.d.ts","sourceRoot":"","sources":["../../../lib/commands/general.js"],"names":[],"mappings":"AAQA;;GAEG;AACH,+EAKC;AAED;;;;;GAKG;AACH,0EAHW,OAAO,iBAKjB;AACC;;;;;;GAMG;AACL,0FAJa,OAAO,iBAMnB;AAED;;;;GAIG;AACH,yEAFa,OAAO,CAAC,OAAO,eAAe,EAAE,IAAI,CAAC,CAKjD;AAED;;;;;;GAMG;AACH,iFAJW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAyC3B;AAED;;;;;;GAMG;AACH,uFAJW,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAK3B;AAED;;;;GAIG;AACH,yEAFY,OAAO,CAAC,OAAO,eAAe,EAAE,IAAI,CAAC,CAgBhD;AAED;;GAEG;AACH,qGAEC;AAED;;GAEG;AACH,mFAKC;AAED;;GAEG;AACH,kFAKC;AAED;;;;GAIG;AACH,sEAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAkBzB;;IArBD;;;;OAIG;IACH,2DAHW,MAAM,EAmBhB;IAVG,gCAAsB;;AAY1B;;;;;;GAMG;AACH,2EAHa,OAAO,CAAC,OAAO,SAAS,EAAE,QAAQ,CAAC,CAiB/C;AAED;;;;;;GAMG;AACH,yEAFa,OAAO,CAAC,UAAU,CAAC,CAI/B;AAED;;GAEG;AACH,8FAGC;AAED;;;GAGG;AACH,+FAGC;AAED;;;;;;;;;;;;;GAaG;AACH,kFAJW,OAAO,SAAS,EAAE,UAAU,oBAC5B,MAAM,oBAWhB;AAED;;;;;;;;GAQG;AACH,kFAJW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAQzB;;;;;UAIa,MAAM;;;;;;6BAKP,OAAO,WAAW,EAAE,cAAc;yBAClC,OAAO,SAAS,EAAE,UAAU"}
+{"version":3,"file":"general.d.ts","sourceRoot":"","sources":["../../../lib/commands/general.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAC,MAAM,SAAS,CAAC;AAC9D,OAAO,KAAK,EAAC,IAAI,EAAE,IAAI,EAAC,MAAM,eAAe,CAAC;AAK9C;;;;;;;GAOG;AACH,wBAAsB,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAK/D;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/E;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,cAAc,EAAE,SAAS,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/F;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAGvE;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,cAAc,EACpB,MAAM,SAAwB,GAC7B,OAAO,CAAC,MAAM,CAAC,CAsCjB;AAED;;;;;;;GAOG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,cAAc,EACpB,MAAM,SAAwB,GAC7B,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED;;;;;;;GAOG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAYvE;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAExF;AAED;;;;;;GAMG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAKnE;AAED;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlE;AAED;;;;;;;;GAQG;AACH,wBAAsB,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB7E;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAc7E;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAE7E;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAG9E;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAG/E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,UAAU,EAChB,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC,CAQf;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKzF"}

package/build/lib/commands/general.js

@@ -27,7 +27,12 @@ const appium_ios_device_1 = require("appium-ios-device");
 const teen_process_1 = require("teen_process");
 const MOMENT_FORMAT_ISO8601 = 'YYYY-MM-DDTHH:mm:ssZ';
 /**
- * @this {XCUITestDriver}
+ * Gets the currently active element.
+ *
+ * In web context, returns the active element from the DOM.
+ * In native context, returns the active element from the current view.
+ *
+ * @returns The active element
  */
 async function active() {
     if (this.isWebContext()) {
@@ -36,28 +41,25 @@ async function active() {
     return await this.proxyCommand(`/element/active`, 'GET');
 }
 /**
- * Trigger a touch/fingerprint match or match failure
+ * Trigger a touch/fingerprint match or match failure.
  *
- * @param {boolean} match - whether the match should be a success or failure
- * @this {XCUITestDriver}
+ * @param match - Whether the match should be a success or failure
  */
 async function touchId(match = true) {
     await this.mobileSendBiometricMatch('touchId', match);
 }
 /**
- * Toggle whether the device is enrolled in the touch ID program
- *
- * @param {boolean} isEnabled - whether to enable or disable the touch ID program
+ * Toggle whether the device is enrolled in the touch ID program.
  *
- * @this {XCUITestDriver}
+ * @param isEnabled - Whether to enable or disable the touch ID program
  */
 async function toggleEnrollTouchId(isEnabled = true) {
     await this.mobileEnrollBiometric(isEnabled);
 }
 /**
- * Get the window size
- * @this {XCUITestDriver}
- * @returns {Promise<import('@appium/types').Size>}
+ * Get the window size.
+ *
+ * @returns The window size (width and height)
  */
 async function getWindowSize() {
     const { width, height } = await this.getWindowRect();
@@ -66,9 +68,8 @@ async function getWindowSize() {
 /**
  * Retrieves the actual device time.
  *
- * @param {string} format - The format specifier string. Read the [MomentJS documentation](https://momentjs.com/docs/) to get the full list of supported datetime format specifiers. The default format is `YYYY-MM-DDTHH:mm:ssZ`, which complies to ISO-8601.
- * @returns {Promise<string>} Formatted datetime string or the raw command output (if formatting fails)
- * @this {XCUITestDriver}
+ * @param format - The format specifier string. Read the [MomentJS documentation](https://momentjs.com/docs/) to get the full list of supported datetime format specifiers. The default format is `YYYY-MM-DDTHH:mm:ssZ`, which complies to ISO-8601.
+ * @returns Formatted datetime string or the raw command output (if formatting fails)
  */
 async function getDeviceTime(format = MOMENT_FORMAT_ISO8601) {
     this.log.info('Attempting to capture iOS device date and time');
@@ -107,19 +108,23 @@ async function getDeviceTime(format = MOMENT_FORMAT_ISO8601) {
     return utc.format(format);
 }
 /**
- * Retrieves the current device time
+ * Retrieves the current device time.
+ *
+ * This is a wrapper around {@linkcode getDeviceTime}.
  *
- * @param {string} format - See {@linkcode getDeviceTime.format}
- * @returns {Promise<string>} Formatted datetime string or the raw command output if formatting fails
- * @this {XCUITestDriver}
+ * @param format - See {@linkcode getDeviceTime.format}
+ * @returns Formatted datetime string or the raw command output if formatting fails
  */
 async function mobileGetDeviceTime(format = MOMENT_FORMAT_ISO8601) {
     return await this.getDeviceTime(format);
 }
 /**
- * For W3C
- * @this {XCUITestDriver}
- * @return {Promise<import('@appium/types').Rect>}
+ * Gets the window rectangle (position and size).
+ *
+ * For W3C compatibility. In web context, returns the browser window dimensions.
+ * In native context, returns the device window dimensions.
+ *
+ * @returns The window rectangle
  */
 async function getWindowRect() {
     if (this.isWebContext()) {
@@ -131,32 +136,49 @@ async function getWindowRect() {
             '}';
         return await this.executeAtom('execute_script', [script]);
     }
-    return /** @type {import('@appium/types').Rect} */ (await this.proxyCommand('/window/rect', 'GET'));
+    return (await this.proxyCommand('/window/rect', 'GET'));
 }
 /**
- * @this {XCUITestDriver}
+ * Removes/uninstalls the given application from the device under test.
+ *
+ * This is a wrapper around {@linkcode mobileRemoveApp mobile: removeApp}.
+ *
+ * @param bundleId - The bundle identifier of the application to be removed
+ * @returns `true` if the application has been removed successfully; `false` otherwise
  */
 async function removeApp(bundleId) {
     return await this.mobileRemoveApp(bundleId);
 }
 /**
- * @this {XCUITestDriver}
+ * Launches the app.
+ *
+ * @deprecated This API has been deprecated and is not supported anymore.
+ * Consider using corresponding 'mobile:' extensions to manage the state of the app under test.
+ * @throws {Error} Always throws an error indicating the API is deprecated
  */
 async function launchApp() {
     throw new Error(`The launchApp API has been deprecated and is not supported anymore. ` +
         `Consider using corresponding 'mobile:' extensions to manage the state of the app under test.`);
 }
 /**
- * @this {XCUITestDriver}
+ * Closes the app.
+ *
+ * @deprecated This API has been deprecated and is not supported anymore.
+ * Consider using corresponding 'mobile:' extensions to manage the state of the app under test.
+ * @throws {Error} Always throws an error indicating the API is deprecated
  */
 async function closeApp() {
     throw new Error(`The closeApp API has been deprecated and is not supported anymore. ` +
         `Consider using corresponding 'mobile:' extensions to manage the state of the app under test.`);
 }
 /**
- * @this {XCUITestDriver}
- * @param {string} url
- * @returns {Promise<void>}
+ * Sets the URL for the current session.
+ *
+ * In web context, navigates to the URL using the remote debugger.
+ * In native context on real devices, uses the proxy command.
+ * In native context on simulators, uses simctl to open the URL.
+ *
+ * @param url - The URL to navigate to
  */
 async function setUrl(url) {
     this.log.debug(`Attempting to set url '${url}'`);
@@ -171,15 +193,15 @@ async function setUrl(url) {
         await this.proxyCommand('/url', 'POST', { url });
     }
     else {
-        await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.openUrl(url);
+        await this.device.simctl.openUrl(url);
     }
 }
 /**
  * Retrieves the viewport dimensions.
  *
  * The viewport is the device's screen size with status bar size subtracted if the latter is present/visible.
- * @returns {Promise<import('./types').Viewport>}
- * @this {XCUITestDriver}
+ *
+ * @returns The viewport rectangle
  */
 async function getViewportRect() {
     const scale = await this.getDevicePixelRatio();
@@ -199,22 +221,25 @@ async function getViewportRect() {
  * Get information about the screen.
  *
  * @privateRemarks memoized in constructor
- * @this {XCUITestDriver}
- * @returns {Promise<ScreenInfo>}
+ * @returns Screen information including dimensions, scale, and status bar size
  */
 async function getScreenInfo() {
-    return /** @type {ScreenInfo} */ (await this.proxyCommand('/wda/screen', 'GET'));
+    return (await this.proxyCommand('/wda/screen', 'GET'));
 }
 /**
- * @this {XCUITestDriver}
+ * Gets the status bar height.
+ *
+ * @returns The height of the status bar in logical pixels
  */
 async function getStatusBarHeight() {
     const { statusBarSize } = await this.getScreenInfo();
     return statusBarSize.height;
 }
 /**
- * memoized in constructor
- * @this {XCUITestDriver}
+ * Gets the device pixel ratio.
+ *
+ * @privateRemarks memoized in constructor
+ * @returns The device pixel ratio (scale factor)
  */
 async function getDevicePixelRatio() {
     const { scale } = await this.getScreenInfo();
@@ -230,9 +255,8 @@ async function getDevicePixelRatio() {
  *
  * Use {@linkcode mobilePerformIoHidEvent} to call a more universal API to perform a button press with duration on any supported device.
  *
- * @param {import('./types').ButtonName} name - The name of the button to be pressed.
- * @param {number} [durationSeconds] - The duration of the button press in seconds (float).
- * @this {XCUITestDriver}
+ * @param name - The name of the button to be pressed
+ * @param durationSeconds - The duration of the button press in seconds (float)
  */
 async function mobilePressButton(name, durationSeconds) {
     if (!name) {
@@ -247,10 +271,8 @@ async function mobilePressButton(name, durationSeconds) {
  * Process a string as speech and send it to Siri.
  *
  * Presents the Siri UI, if it is not currently active, and accepts a string which is then processed as if it were recognized speech. See [the documentation of `activateWithVoiceRecognitionText`](https://developer.apple.com/documentation/xctest/xcuisiriservice/2852140-activatewithvoicerecognitiontext?language=objc) for more details.
-
- * @param {string} text - Text to be sent to Siri
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
+ *
+ * @param text - Text to be sent to Siri
  */
 async function mobileSiriCommand(text) {
     if (!text) {
@@ -258,13 +280,4 @@ async function mobileSiriCommand(text) {
     }
     await this.proxyCommand('/wda/siri/activate', 'POST', { text });
 }
-/**
- * @typedef {Object} PressButtonOptions
- * @property {string} name - The name of the button to be pressed.
- * @property {number} [durationSeconds] - Duration in float seconds.
- */
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- * @typedef {import('./types').ScreenInfo} ScreenInfo
- */
 //# sourceMappingURL=general.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"general.js","sourceRoot":"","sources":["../../../lib/commands/general.js"],"names":[],"mappings":";;;;;AAWA,wBAKC;AAQD,0BAEC;AAQD,kDAEC;AAOD,sCAGC;AASD,sCAsCC;AASD,kDAEC;AAOD,sCAcC;AAKD,8BAEC;AAKD,8BAKC;AAKD,4BAKC;AAOD,wBAgBC;AASD,0CAcC;AASD,sCAEC;AAKD,gDAGC;AAMD,kDAGC;AAgBD,8CAQC;AAWD,8CAKC;AA1QD,oDAAuB;AACvB,0CAAqC;AACrC,sEAAqC;AACrC,yDAA4C;AAC5C,+CAAkC;AAElC,MAAM,qBAAqB,GAAG,sBAAsB,CAAC;AAErD;;GAEG;AACI,KAAK,UAAU,MAAM;IAC1B,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,OAAO,CAAC,KAAK,GAAG,IAAI;IACxC,MAAM,IAAI,CAAC,wBAAwB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AACxD,CAAC;AACC;;;;;;GAMG;AACE,KAAK,UAAU,mBAAmB,CAAC,SAAS,GAAG,IAAI;IACxD,MAAM,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;AAC9C,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,aAAa;IACjC,MAAM,EAAC,KAAK,EAAE,MAAM,EAAC,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IACnD,OAAO,EAAC,KAAK,EAAE,MAAM,EAAC,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CAAC,MAAM,GAAG,qBAAqB;IAChE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;IAChE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;QAC7E,MAAM,GAAG,GAAG,MAAM,CAAC;QACnB,MAAM,IAAI,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACtC,MAAM,WAAW,GAAG,uBAAuB,CAAC;QAC5C,MAAM,MAAM,GAAG,CAAC,MAAM,IAAA,mBAAI,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACrD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC;QACxF,MAAM,eAAe,GAAG,yBAAM,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACxD,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC;YAC/B,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,+BAA+B,MAAM,kBAAkB,GAAG,+BAA+B,CAC1F,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,2EAA2E;QAC3E,OAAO,eAAe,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,EAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAC,GAAG,MAAM,6BAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,SAAS,gBAAgB,SAAS,eAAe,QAAQ,EAAE,CAAC,CAAC;IAC1F,MAAM,GAAG,GAAG,yBAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC;IACzC,2DAA2D;IAC3D,6CAA6C;IAC7C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;QACnC,OAAO,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IACD,+CAA+C;IAC/C,2BAA2B;IAC3B,IAAI,gBAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9B,OAAO,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QACvC,OAAO,GAAG,CAAC,SAAS,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,8EAA8E,CAAC,CAAC;IAC9F,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,mBAAmB,CAAC,MAAM,GAAG,qBAAqB;IACtE,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,aAAa;IACjC,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,UAAU;YACvB,yBAAyB;YACzB,yBAAyB;YACzB,2BAA2B;YAC3B,4BAA4B;YAC9B,GAAG,CAAC;QACJ,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,2CAA2C,CAAC,CACjD,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,KAAK,CAAC,CAC/C,CAAC;AACJ,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,SAAS,CAAC,QAAQ;IACtC,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;AAC9C,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,SAAS;IAC7B,MAAM,IAAI,KAAK,CACb,sEAAsE;QACpE,8FAA8F,CACjG,CAAC;AACJ,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,QAAQ;IAC5B,MAAM,IAAI,KAAK,CACb,qEAAqE;QACnE,8FAA8F,CACjG,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,MAAM,CAAC,GAAG;IAC9B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,GAAG,GAAG,CAAC,CAAC;IAEjD,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACxB,iDAAiD;QACjD,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QACvB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO;IACT,CAAC;IAED,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,EAAC,GAAG,EAAC,CAAC,CAAC;IACjD,CAAC;SAAM,CAAC;QACN,MAAM,uDAAuD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClG,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,eAAe;IACnC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/C,mDAAmD;IACnD,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC;IAC9E,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IAE9C,2EAA2E;IAC3E,qEAAqE;IACrE,OAAO;QACL,IAAI,EAAE,CAAC;QACP,GAAG,EAAE,eAAe;QACpB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC;QAC3C,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,eAAe;KAChE,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,aAAa;IACjC,OAAO,yBAAyB,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC;AACnF,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,kBAAkB;IACtC,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IACnD,OAAO,aAAa,CAAC,MAAM,CAAC;AAC9B,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,mBAAmB;IACvC,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IAC3C,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,iBAAiB,CAAC,IAAI,EAAE,eAAe;IAC3D,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;QAC9D,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,oCAAoC,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAC,CAAC,CAAC;AAChG,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,iBAAiB,CAAC,IAAI;IAC1C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,8BAA8B,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,EAAC,IAAI,EAAC,CAAC,CAAC;AAChE,CAAC;AAED;;;;GAIG;AAEH;;;GAGG"}
+{"version":3,"file":"general.js","sourceRoot":"","sources":["../../../lib/commands/general.ts"],"names":[],"mappings":";;;;;AAoBA,wBAKC;AAOD,0BAEC;AAOD,kDAEC;AAOD,sCAGC;AAQD,sCAyCC;AAUD,kDAKC;AAUD,sCAYC;AAUD,8BAEC;AASD,8BAKC;AASD,4BAKC;AAWD,wBAgBC;AASD,0CAcC;AAQD,sCAEC;AAOD,gDAGC;AAQD,kDAGC;AAeD,8CAYC;AASD,8CAKC;AA7SD,oDAAuB;AACvB,0CAAqC;AACrC,sEAAqC;AACrC,yDAA4C;AAC5C,+CAAkC;AAMlC,MAAM,qBAAqB,GAAG,sBAAsB,CAAC;AAErD;;;;;;;GAOG;AACI,KAAK,UAAU,MAAM;IAC1B,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,OAAO,CAAuB,KAAK,GAAG,IAAI;IAC9D,MAAM,IAAI,CAAC,wBAAwB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,mBAAmB,CAAuB,SAAS,GAAG,IAAI;IAC9E,MAAM,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;AAC9C,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,aAAa;IACjC,MAAM,EAAC,KAAK,EAAE,MAAM,EAAC,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IACnD,OAAO,EAAC,KAAK,EAAE,MAAM,EAAC,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,aAAa,CAEjC,MAAM,GAAG,qBAAqB;IAE9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;IAChE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;QAC7E,MAAM,GAAG,GAAG,MAAM,CAAC;QACnB,MAAM,IAAI,GAAG,CAAC,sBAAsB,CAAC,CAAC;QACtC,MAAM,WAAW,GAAG,uBAAuB,CAAC;QAC5C,MAAM,MAAM,GAAG,CAAC,MAAM,IAAA,mBAAI,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACrD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC;QACxF,MAAM,eAAe,GAAG,yBAAM,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACxD,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC;YAC/B,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,+BAA+B,MAAM,kBAAkB,GAAG,+BAA+B,CAC1F,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,2EAA2E;QAC3E,OAAO,eAAe,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,EAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAC,GAAG,MAAM,6BAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,SAAS,gBAAgB,SAAS,eAAe,QAAQ,EAAE,CAAC,CAAC;IAC1F,MAAM,GAAG,GAAG,yBAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC;IACzC,2DAA2D;IAC3D,6CAA6C;IAC7C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;QACnC,OAAO,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IACD,+CAA+C;IAC/C,2BAA2B;IAC3B,IAAI,gBAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9B,OAAO,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QACvC,OAAO,GAAG,CAAC,SAAS,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,8EAA8E,CAAC,CAAC;IAC9F,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,mBAAmB,CAEvC,MAAM,GAAG,qBAAqB;IAE9B,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,aAAa;IACjC,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,UAAU;YACvB,yBAAyB;YACzB,yBAAyB;YACzB,2BAA2B;YAC3B,4BAA4B;YAC9B,GAAG,CAAC;QACJ,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,KAAK,CAAC,CAAS,CAAC;AAClE,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,SAAS,CAAuB,QAAgB;IACpE,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,SAAS;IAC7B,MAAM,IAAI,KAAK,CACb,sEAAsE;QACpE,8FAA8F,CACjG,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,QAAQ;IAC5B,MAAM,IAAI,KAAK,CACb,qEAAqE;QACnE,8FAA8F,CACjG,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,MAAM,CAAuB,GAAW;IAC5D,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,GAAG,GAAG,CAAC,CAAC;IAEjD,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACxB,iDAAiD;QACjD,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QACvB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO;IACT,CAAC;IAED,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,EAAC,GAAG,EAAC,CAAC,CAAC;IACjD,CAAC;SAAM,CAAC;QACN,MAAO,IAAI,CAAC,MAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,eAAe;IACnC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/C,mDAAmD;IACnD,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC;IAC9E,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IAE9C,2EAA2E;IAC3E,qEAAqE;IACrE,OAAO;QACL,IAAI,EAAE,CAAC;QACP,GAAG,EAAE,eAAe;QACpB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC;QAC3C,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,eAAe;KAChE,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,aAAa;IACjC,OAAO,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAe,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,kBAAkB;IACtC,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IACnD,OAAO,aAAa,CAAC,MAAM,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,mBAAmB;IACvC,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IAC3C,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,iBAAiB,CAErC,IAAgB,EAChB,eAAwB;IAExB,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;QAC9D,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,oCAAoC,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAC,CAAC,CAAC;AAChG,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CAAuB,IAAY;IACxE,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,8BAA8B,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,EAAC,IAAI,EAAC,CAAC,CAAC;AAChE,CAAC"}

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

@@ -1,68 +1,66 @@
+import type { XCUITestDriver } from '../driver';
+import type { LogEntry, LogListener } from './types';
+import type { LogDefRecord } from '@appium/types';
+import type { EventEmitter } from 'node:events';
+type XCUITestDriverLogTypes = keyof typeof SUPPORTED_LOG_TYPES;
+interface BiDiListenerProperties {
+    type: string;
+    srcEventName?: string;
+    context?: string;
+    entryTransformer?: (x: any) => LogEntry;
+}
+/**
+ * @privateRemarks The return types for these getters should be specified
+ */
+declare const SUPPORTED_LOG_TYPES: LogDefRecord;
+export declare const supportedLogTypes: LogDefRecord;
 /**
+ * Extracts logs of the specified type from the logs container.
  *
- * @param {XCUITestDriverLogTypes} logType
- * @param {Partial<Record<XCUITestDriverLogTypes,{getLogs(): Promise<any>}>>} [logsContainer]
- * @this {XCUITestDriver}
+ * @param logType - The type of log to extract
+ * @param logsContainer - Container holding log objects
+ * @returns The extracted logs
+ * @throws {Error} If logs are not available or the log type is not found
  */
-export function extractLogs(this: import("../driver").XCUITestDriver, logType: XCUITestDriverLogTypes, logsContainer?: Partial<Record<XCUITestDriverLogTypes, {
+export declare function extractLogs(this: XCUITestDriver, logType: XCUITestDriverLogTypes, logsContainer?: Partial<Record<XCUITestDriverLogTypes, {
     getLogs(): Promise<any>;
 }>>): Promise<any>;
 /**
- * @this {XCUITestDriver}
+ * Starts capturing iOS system logs.
+ *
+ * Initializes and starts capturing syslog and crashlog. Optionally starts Safari console and network logs
+ * if the corresponding capabilities are enabled.
+ *
+ * @returns `true` if syslog capture started successfully; `false` otherwise
  */
-export function startLogCapture(this: import("../driver").XCUITestDriver): Promise<boolean>;
-export class startLogCapture {
-    logs: import("../driver").DriverLogs;
-}
+export declare function startLogCapture(this: XCUITestDriver): Promise<boolean>;
 /**
  * Starts an iOS system logs broadcast websocket.
  *
- * The websocket listens on the same host and port as Appium.  The endpoint created is `/ws/session/:sessionId:/appium/syslog`.
+ * The websocket listens on the same host and port as Appium. The endpoint created is `/ws/session/:sessionId:/appium/syslog`.
  *
  * If the websocket is already running, this command does nothing.
  *
- * Each connected webcoket listener will receive syslog lines as soon as they are visible to Appium.
+ * Each connected websocket listener will receive syslog lines as soon as they are visible to Appium.
  * @see https://appiumpro.com/editions/55-using-mobile-execution-commands-to-continuously-stream-device-logs-with-appium
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
  */
-export function mobileStartLogsBroadcast(this: import("../driver").XCUITestDriver): Promise<void>;
-export class mobileStartLogsBroadcast {
-    _syslogWebsocketListener: ((logRecord: {
-        message: string;
-    }) => void) | null;
-}
+export declare function mobileStartLogsBroadcast(this: XCUITestDriver): Promise<void>;
 /**
- * Stops the syslog broadcasting wesocket server previously started by `mobile: startLogsBroadcast`.
+ * Stops the syslog broadcasting websocket server previously started by `mobile: startLogsBroadcast`.
+ *
  * If no websocket server is running, this command does nothing.
- * @this {XCUITestDriver}
- * @returns {Promise<void>}
  */
-export function mobileStopLogsBroadcast(this: import("../driver").XCUITestDriver): Promise<void>;
+export declare function mobileStopLogsBroadcast(this: XCUITestDriver): Promise<void>;
 /**
+ * Assigns a BiDi log listener to the given log emitter.
+ *
  * https://w3c.github.io/webdriver-bidi/#event-log-entryAdded
  *
- * @template {import('node:events').EventEmitter} EE
- * @this {XCUITestDriver}
- * @param {EE} logEmitter
- * @param {BiDiListenerProperties} properties
- * @returns {[EE, import('./types').LogListener]}
- */
-export function assignBiDiLogListener<EE extends import("node:events").EventEmitter>(this: import("../driver").XCUITestDriver, logEmitter: EE, properties: BiDiListenerProperties): [EE, import("./types").LogListener];
-export const supportedLogTypes: import("@appium/types").LogDefRecord;
-export type XCUITestDriver = import("../driver").XCUITestDriver;
-export type XCUITestDriverLogTypes = keyof typeof SUPPORTED_LOG_TYPES;
-export type AppiumServer = import("@appium/types").AppiumServer;
-export type BiDiListenerProperties = {
-    type: string;
-    srcEventName?: string | undefined;
-    context?: string | undefined;
-    entryTransformer?: ((x: any) => import("./types").LogEntry) | undefined;
-};
-/**
- * @type {import('@appium/types').LogDefRecord}
- * @privateRemarks The return types for these getters should be specified
+ * @template EE extends EventEmitter
+ * @param logEmitter - The event emitter to attach the listener to
+ * @param properties - Configuration for the BiDi listener
+ * @returns A tuple containing the log emitter and the listener function
  */
-declare const SUPPORTED_LOG_TYPES: import("@appium/types").LogDefRecord;
+export declare function assignBiDiLogListener<EE extends EventEmitter>(this: XCUITestDriver, logEmitter: EE, properties: BiDiListenerProperties): [EE, LogListener];
 export {};
 //# sourceMappingURL=log.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../lib/commands/log.js"],"names":[],"mappings":"AAqEA;;;;;GAKG;AACH,+EAJW,sBAAsB,kBACtB,OAAO,CAAC,MAAM,CAAC,sBAAsB,EAAC;IAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAA;CAAC,CAAC,CAAC,gBAwB3E;AAED;;GAEG;AACH,4FAqFC;;IApFC,qCAA2B;;AAsF7B;;;;;;;;;;;GAWG;AACH,oFAHa,OAAO,CAAC,IAAI,CAAC,CA8DzB;;IA5BK;;uBAIC;;AA0BP;;;;;GAKG;AACH,mFAFa,OAAO,CAAC,IAAI,CAAC,CAUzB;AAED;;;;;;;;GAQG;AACH,sCANkD,EAAE,SAAvC,OAAQ,aAAa,EAAE,YAAa,wDAEtC,EAAE,cACF,sBAAsB,GACpB,CAAC,EAAE,EAAE,OAAO,SAAS,EAAE,WAAW,CAAC,CAe/C;AAxOD,qEAAqD;6BAwPxC,OAAO,WAAW,EAAE,cAAc;qCAClC,MAAM,OAAO,mBAAmB;2BAChC,OAAO,eAAe,EAAE,YAAY;;UAKnC,MAAM;;;oCAGS,OAAO,SAAS,EAAE,QAAQ;;AA7SvD;;;GAGG;AACH,mCAHU,OAAO,eAAe,EAAE,YAAY,CAkC5C"}
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../lib/commands/log.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAC,QAAQ,EAAE,WAAW,EAAC,MAAM,SAAS,CAAC;AACnD,OAAO,KAAK,EAAC,YAAY,EAAyB,MAAM,eAAe,CAAC;AAExE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAU9C,KAAK,sBAAsB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAE/D,UAAU,sBAAsB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,QAAQ,CAAC;CACzC;AAED;;GAEG;AACH,QAAA,MAAM,mBAAmB,EAAE,YA4B1B,CAAC;AAQF,eAAO,MAAM,iBAAiB,cAAsB,CAAC;AAErD;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,sBAAsB,EAC/B,aAAa,GAAE,OAAO,CAAC,MAAM,CAAC,sBAAsB,EAAE;IAAC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAA;CAAC,CAAC,CAAM,GACrF,OAAO,CAAC,GAAG,CAAC,CAqBd;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAoF5E;AAED;;;;;;;;;GASG;AACH,wBAAsB,wBAAwB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAyDlF;AAED;;;;GAIG;AACH,wBAAsB,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAQjF;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,SAAS,YAAY,EAC3D,IAAI,EAAE,cAAc,EACpB,UAAU,EAAE,EAAE,EACd,UAAU,EAAE,sBAAsB,GACjC,CAAC,EAAE,EAAE,WAAW,CAAC,CAanB"}