appium-xcuitest-driver 10.2.2 → 10.4.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [10.4.0](https://github.com/appium/appium-xcuitest-driver/compare/v10.3.0...v10.4.0) (2025-11-02)
+
+### Features
+
+* Make command exports more straightforward ([#2646](https://github.com/appium/appium-xcuitest-driver/issues/2646)) ([254bc04](https://github.com/appium/appium-xcuitest-driver/commit/254bc0468bba9cee4437286495ba7c0273ddd16e))
+
+## [10.3.0](https://github.com/appium/appium-xcuitest-driver/compare/v10.2.2...v10.3.0) (2025-11-02)
+
+### Features
+
+* Switch to devicectl module usage ([#2644](https://github.com/appium/appium-xcuitest-driver/issues/2644)) ([7e7e642](https://github.com/appium/appium-xcuitest-driver/commit/7e7e64263a225e90bf48d1e14b7fd961acba9ede))
+
 ## [10.2.2](https://github.com/appium/appium-xcuitest-driver/compare/v10.2.1...v10.2.2) (2025-10-17)
 
 ### Miscellaneous Chores

package/build/lib/commands/active-app-info.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns information about the active application.
+ *
+ * @returns {Promise<import('./types').ActiveAppInfo>} Active app information
+ * @throws {Error} if an error raised by command
+ * @this {import('../driver').XCUITestDriver}
+ */
+export function mobileGetActiveAppInfo(this: import("../driver").XCUITestDriver): Promise<import("./types").ActiveAppInfo>;
+//# sourceMappingURL=active-app-info.d.ts.map

package/build/lib/commands/active-app-info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"active-app-info.d.ts","sourceRoot":"","sources":["../../../lib/commands/active-app-info.js"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,kFAJa,OAAO,CAAC,OAAO,SAAS,EAAE,aAAa,CAAC,CAQpD"}

package/build/lib/commands/active-app-info.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobileGetActiveAppInfo = mobileGetActiveAppInfo;
+/**
+ * Returns information about the active application.
+ *
+ * @returns {Promise<import('./types').ActiveAppInfo>} Active app information
+ * @throws {Error} if an error raised by command
+ * @this {import('../driver').XCUITestDriver}
+ */
+async function mobileGetActiveAppInfo() {
+    return /** @type {import('./types').ActiveAppInfo} */ (await this.proxyCommand('/wda/activeAppInfo', 'GET'));
+}
+//# sourceMappingURL=active-app-info.js.map

package/build/lib/commands/active-app-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"active-app-info.js","sourceRoot":"","sources":["../../../lib/commands/active-app-info.js"],"names":[],"mappings":";;AAOA,wDAIC;AAXD;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB;IAC1C,OAAO,8CAA8C,CAAC,CACpD,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,KAAK,CAAC,CACrD,CAAC;AACJ,CAAC"}

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

@@ -1,48 +1,45 @@
-declare namespace _default {
-    /**
-     * @this {XCUITestDriver}
-     */
-    function getAlertText(this: import("../driver").XCUITestDriver): Promise<string | null>;
-    /**
-     * @param {string} value
-     * @this {XCUITestDriver}
-     * @returns {Promise<void>}
-     */
-    function setAlertText(this: import("../driver").XCUITestDriver, value: string): Promise<void>;
-    /**
-     * @param { {buttonLabel?: string} } opts
-     * @returns {Promise<void>}
-     * @this {XCUITestDriver}
-     */
-    function postAcceptAlert(this: import("../driver").XCUITestDriver, opts?: {
-        buttonLabel?: string;
-    }): Promise<void>;
-    /**
-     * @param { {buttonLabel?: string} } opts
-     * @returns {Promise<void>}
-     * @this {XCUITestDriver}
-     */
-    function postDismissAlert(this: import("../driver").XCUITestDriver, opts?: {
-        buttonLabel?: string;
-    }): Promise<void>;
-    /**
-     * @internal
-     * @this {XCUITestDriver}
-     * @returns {Promise<string[]>} The list of button labels
-     */
-    function getAlertButtons(this: import("../driver").XCUITestDriver): Promise<string[]>;
-    /**
-     * Tries to apply the given action to the currently visible alert.
-     *
-     * @param {AlertAction} action - The actual action to apply.
-     * @param {string} [buttonLabel] - The name of the button used to perform the chosen alert action. Only makes sense if the action is `accept` or `dismiss`.
-     * @returns {Promise<string[]|void>} If `action` is `getButtons`, a list of alert button labelsp; otherwise nothing.
-     * @remarks This should really be separate commands.
-     * @this {XCUITestDriver}
-     */
-    function mobileHandleAlert(this: import("../driver").XCUITestDriver, action: AlertAction, buttonLabel?: string): Promise<string[] | void>;
-}
-export default _default;
+/**
+ * @this {XCUITestDriver}
+ */
+export function getAlertText(this: import("../driver").XCUITestDriver): Promise<string | null>;
+/**
+ * @param {string} value
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+export function setAlertText(this: import("../driver").XCUITestDriver, value: string): Promise<void>;
+/**
+ * @param { {buttonLabel?: string} } opts
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+export function postAcceptAlert(this: import("../driver").XCUITestDriver, opts?: {
+    buttonLabel?: string;
+}): Promise<void>;
+/**
+ * @param { {buttonLabel?: string} } opts
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+export function postDismissAlert(this: import("../driver").XCUITestDriver, opts?: {
+    buttonLabel?: string;
+}): Promise<void>;
+/**
+ * @internal
+ * @this {XCUITestDriver}
+ * @returns {Promise<string[]>} The list of button labels
+ */
+export function getAlertButtons(this: import("../driver").XCUITestDriver): Promise<string[]>;
+/**
+ * Tries to apply the given action to the currently visible alert.
+ *
+ * @param {AlertAction} action - The actual action to apply.
+ * @param {string} [buttonLabel] - The name of the button used to perform the chosen alert action. Only makes sense if the action is `accept` or `dismiss`.
+ * @returns {Promise<string[]|void>} If `action` is `getButtons`, a list of alert button labelsp; otherwise nothing.
+ * @remarks This should really be separate commands.
+ * @this {XCUITestDriver}
+ */
+export function mobileHandleAlert(this: import("../driver").XCUITestDriver, action: AlertAction, buttonLabel?: string): Promise<string[] | void>;
 export type AlertAction = "accept" | "dismiss" | "getButtons";
 export type XCUITestDriver = import("../driver").XCUITestDriver;
 //# sourceMappingURL=alert.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"alert.d.ts","sourceRoot":"","sources":["../../../lib/commands/alert.js"],"names":[],"mappings":";IAcE;;OAEG;IACH,wFAEC;IACD;;;;OAIG;IACH,uEAJW,MAAM,GAEJ,OAAO,CAAC,IAAI,CAAC,CAIzB;IACD;;;;OAIG;IACH,0EAJY;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAC,GACrB,OAAO,CAAC,IAAI,CAAC,CAKzB;IACD;;;;OAIG;IACH,2EAJY;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAC,GACrB,OAAO,CAAC,IAAI,CAAC,CAKzB;IACD;;;;OAIG;IACH,oEAFa,OAAO,CAAC,MAAM,EAAE,CAAC,CAI7B;IACD;;;;;;;;OAQG;IACH,6EANW,WAAW,gBACX,MAAM,GACJ,OAAO,CAAC,MAAM,EAAE,GAAC,IAAI,CAAC,CAkBlC;;;0BAIU,QAAQ,GAAC,SAAS,GAAC,YAAY;6BAI/B,OAAO,WAAW,EAAE,cAAc"}
+{"version":3,"file":"alert.d.ts","sourceRoot":"","sources":["../../../lib/commands/alert.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,+FAEC;AAED;;;;GAIG;AACH,8EAJW,MAAM,GAEJ,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;;GAIG;AACH,iFAJY;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAC,GACrB,OAAO,CAAC,IAAI,CAAC,CAKzB;AAED;;;;GAIG;AACH,kFAJY;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAC,GACrB,OAAO,CAAC,IAAI,CAAC,CAKzB;AAED;;;;GAIG;AACH,2EAFa,OAAO,CAAC,MAAM,EAAE,CAAC,CAI7B;AAED;;;;;;;;GAQG;AACH,oFANW,WAAW,gBACX,MAAM,GACJ,OAAO,CAAC,MAAM,EAAE,GAAC,IAAI,CAAC,CAkBlC;0BAgBY,QAAQ,GAAC,SAAS,GAAC,YAAY;6BAI/B,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/alert.js

@@ -1,5 +1,71 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAlertText = getAlertText;
+exports.setAlertText = setAlertText;
+exports.postAcceptAlert = postAcceptAlert;
+exports.postDismissAlert = postDismissAlert;
+exports.getAlertButtons = getAlertButtons;
+exports.mobileHandleAlert = mobileHandleAlert;
+/**
+ * @this {XCUITestDriver}
+ */
+async function getAlertText() {
+    return /** @type {string|null} */ (await this.proxyCommand('/alert/text', 'GET'));
+}
+/**
+ * @param {string} value
+ * @this {XCUITestDriver}
+ * @returns {Promise<void>}
+ */
+async function setAlertText(value) {
+    await this.proxyCommand('/alert/text', 'POST', { value });
+}
+/**
+ * @param { {buttonLabel?: string} } opts
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+async function postAcceptAlert(opts = {}) {
+    await this.proxyCommand('/alert/accept', 'POST', toAlertParams(opts));
+}
+/**
+ * @param { {buttonLabel?: string} } opts
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+async function postDismissAlert(opts = {}) {
+    await this.proxyCommand('/alert/dismiss', 'POST', toAlertParams(opts));
+}
+/**
+ * @internal
+ * @this {XCUITestDriver}
+ * @returns {Promise<string[]>} The list of button labels
+ */
+async function getAlertButtons() {
+    return /** @type {string[]} */ (await this.proxyCommand('/wda/alert/buttons', 'GET'));
+}
+/**
+ * Tries to apply the given action to the currently visible alert.
+ *
+ * @param {AlertAction} action - The actual action to apply.
+ * @param {string} [buttonLabel] - The name of the button used to perform the chosen alert action. Only makes sense if the action is `accept` or `dismiss`.
+ * @returns {Promise<string[]|void>} If `action` is `getButtons`, a list of alert button labelsp; otherwise nothing.
+ * @remarks This should really be separate commands.
+ * @this {XCUITestDriver}
+ */
+async function mobileHandleAlert(action, buttonLabel) {
+    switch (action) {
+        case 'accept':
+            return await this.postAcceptAlert({ buttonLabel });
+        case 'dismiss':
+            return await this.postDismissAlert({ buttonLabel });
+        case 'getButtons':
+            return await this.getAlertButtons();
+        default:
+            throw new Error(`The 'action' value should be either 'accept', 'dismiss' or 'getButtons'. ` +
+                `'${action}' is provided instead.`);
+    }
+}
 /**
  *
  * @param { {buttonLabel?: string} } opts
@@ -12,68 +78,6 @@ function toAlertParams(opts = {}) {
     }
     return params;
 }
-exports.default = {
-    /**
-     * @this {XCUITestDriver}
-     */
-    async getAlertText() {
-        return /** @type {string|null} */ (await this.proxyCommand('/alert/text', 'GET'));
-    },
-    /**
-     * @param {string} value
-     * @this {XCUITestDriver}
-     * @returns {Promise<void>}
-     */
-    async setAlertText(value) {
-        await this.proxyCommand('/alert/text', 'POST', { value });
-    },
-    /**
-     * @param { {buttonLabel?: string} } opts
-     * @returns {Promise<void>}
-     * @this {XCUITestDriver}
-     */
-    async postAcceptAlert(opts = {}) {
-        await this.proxyCommand('/alert/accept', 'POST', toAlertParams(opts));
-    },
-    /**
-     * @param { {buttonLabel?: string} } opts
-     * @returns {Promise<void>}
-     * @this {XCUITestDriver}
-     */
-    async postDismissAlert(opts = {}) {
-        await this.proxyCommand('/alert/dismiss', 'POST', toAlertParams(opts));
-    },
-    /**
-     * @internal
-     * @this {XCUITestDriver}
-     * @returns {Promise<string[]>} The list of button labels
-     */
-    async getAlertButtons() {
-        return /** @type {string[]} */ (await this.proxyCommand('/wda/alert/buttons', 'GET'));
-    },
-    /**
-     * Tries to apply the given action to the currently visible alert.
-     *
-     * @param {AlertAction} action - The actual action to apply.
-     * @param {string} [buttonLabel] - The name of the button used to perform the chosen alert action. Only makes sense if the action is `accept` or `dismiss`.
-     * @returns {Promise<string[]|void>} If `action` is `getButtons`, a list of alert button labelsp; otherwise nothing.
-     * @remarks This should really be separate commands.
-     * @this {XCUITestDriver}
-     */
-    async mobileHandleAlert(action, buttonLabel) {
-        switch (action) {
-            case 'accept':
-                return await this.postAcceptAlert({ buttonLabel });
-            case 'dismiss':
-                return await this.postDismissAlert({ buttonLabel });
-            case 'getButtons':
-                return await this.getAlertButtons();
-            default:
-                throw new Error(`The 'action' value should be either 'accept', 'dismiss' or 'getButtons'. ` +
-                    `'${action}' is provided instead.`);
-        }
-    },
-};
 /**
  * @typedef {'accept'|'dismiss'|'getButtons'} AlertAction
  */

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

@@ -1 +1 @@
-{"version":3,"file":"alert.js","sourceRoot":"","sources":["../../../lib/commands/alert.js"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,SAAS,aAAa,CAAC,IAAI,GAAG,EAAE;IAC9B,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,kBAAe;IACb;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,OAAO,0BAA0B,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC;IACpF,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,KAAK;QACtB,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,EAAC,KAAK,EAAC,CAAC,CAAC;IAC1D,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,IAAI,GAAG,EAAE;QAC7B,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAI,GAAG,EAAE;QAC9B,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IACzE,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,eAAe;QACnB,OAAO,uBAAuB,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC,CAAC;IACxF,CAAC;IACD;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CAAC,MAAM,EAAE,WAAW;QACzC,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,QAAQ;gBACX,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,EAAC,WAAW,EAAC,CAAC,CAAC;YACnD,KAAK,SAAS;gBACZ,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,EAAC,WAAW,EAAC,CAAC,CAAC;YACpD,KAAK,YAAY;gBACf,OAAO,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;YACtC;gBACE,MAAM,IAAI,KAAK,CACb,2EAA2E;oBACzE,IAAI,MAAM,wBAAwB,CACrC,CAAC;QACN,CAAC;IACH,CAAC;CACF,CAAC;AAEF;;GAEG;AAEH;;GAEG"}
+{"version":3,"file":"alert.js","sourceRoot":"","sources":["../../../lib/commands/alert.js"],"names":[],"mappings":";;AAGA,oCAEC;AAOD,oCAEC;AAOD,0CAEC;AAOD,4CAEC;AAOD,0CAEC;AAWD,8CAcC;AAlED;;GAEG;AACI,KAAK,UAAU,YAAY;IAChC,OAAO,0BAA0B,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC;AACpF,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,YAAY,CAAC,KAAK;IACtC,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,EAAC,KAAK,EAAC,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe,CAAC,IAAI,GAAG,EAAE;IAC7C,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;AACxE,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,gBAAgB,CAAC,IAAI,GAAG,EAAE;IAC9C,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;AACzE,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe;IACnC,OAAO,uBAAuB,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC,CAAC;AACxF,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,iBAAiB,CAAC,MAAM,EAAE,WAAW;IACzD,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,EAAC,WAAW,EAAC,CAAC,CAAC;QACnD,KAAK,SAAS;YACZ,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,EAAC,WAAW,EAAC,CAAC,CAAC;QACpD,KAAK,YAAY;YACf,OAAO,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QACtC;YACE,MAAM,IAAI,KAAK,CACb,2EAA2E;gBACzE,IAAI,MAAM,wBAAwB,CACrC,CAAC;IACN,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,IAAI,GAAG,EAAE;IAC9B,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AAEH;;GAEG"}

package/build/lib/commands/app-management.d.ts

@@ -1,156 +1,153 @@
-declare namespace _default {
-    /**
-     * Installs the given application to the device under test.
-     *
-     * Please ensure the app is built for a correct architecture and is signed with a proper developer signature (for real devices) prior to calling this.
-     * @param {string} app - See docs for `appium:app` capability
-     * @param {number} [timeoutMs] - The maximum time to wait until app install is finished (in ms) on real devices.
-     * If not provided, then the value of `appium:appPushTimeout` capability is used. If the capability is not provided then the default is 240000ms (4 minutes).
-     * @param {boolean} [checkVersion] - If the application installation follows currently installed application's version status if provided.
-     * No checking occurs if no this option.
-     * @privateRemarks Link to capability docs
-     * @returns {Promise<void>}
-     * @this {XCUITestDriver}
-     */
-    function mobileInstallApp(this: import("../driver").XCUITestDriver, app: string, timeoutMs?: number, checkVersion?: boolean): Promise<void>;
-    /**
-     * Checks whether the given application is installed on the device under test.
-     * Offload app is handled as not installed.
-     *
-     * @param {string} bundleId - The bundle identifier of the application to be checked
-     * @returns {Promise<boolean>} `true` if the application is installed; `false` otherwise
-     * @this {XCUITestDriver}
-     */
-    function mobileIsAppInstalled(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
-    /**
-     * Removes/uninstalls the given application from the device under test.
-     * Offload app data could also be removed.
-     *
-     * @param {string} bundleId - The bundle identifier of the application to be removed
-     * @returns {Promise<boolean>} `true` if the application has been removed successfully; `false` otherwise
-     * @this {XCUITestDriver}
-     */
-    function mobileRemoveApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
-    /**
-     * Executes the given app on the device under test.
-     *
-     * If the app is already running it will be activated. If the app is not installed or cannot be launched then an exception is thrown.
-     * @param {string} bundleId - The bundle identifier of the application to be launched
-     * @param {string|string[]} [args] - One or more command line arguments for the app. If the app is already running then this argument is ignored.
-     * @param {object} [environment] - Environment variables mapping for the app. If the app is already running then this argument is ignored.
-     * @returns {Promise<void>}
-     * @this {XCUITestDriver}
-     */
-    function mobileLaunchApp(this: import("../driver").XCUITestDriver, bundleId: string, args?: string | string[], environment?: object): Promise<void>;
-    /**
-     * Terminates the given app on the device under test.
-     *
-     * This command performs termination via [XCTest's `terminate`](https://developer.apple.com/documentation/xctest/xcuiapplication/1500637-terminate) API. If the app is not installed an exception is thrown. If the app is not running then nothing is done.
-     * @param {string} bundleId - The bundle identifier of the application to be terminated
-     * @returns {Promise<boolean>} `true` if the app has been terminated successfully; `false` otherwise
-     * @this {XCUITestDriver}
-     */
-    function mobileTerminateApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
-    /**
-     * Activate the given app on the device under test.
-     *
-     * This pushes the app to the foreground if it is running in the background.  An exception is thrown if the app is not install or isn't running.  Nothing is done if the app is already in the foreground.
-     *
-     * @param {string} bundleId - The bundle identifier of the application to be activated
-     * @returns {Promise<void>}
-     * @this {XCUITestDriver}
-     */
-    function mobileActivateApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<void>;
-    /**
-     * Kill the given app on the real device under test by instruments service.
-     *
-     * If the app is not running or kill failed, then nothing is done.
-     *
-     * @remarks `appium-xcuitest-driver` v4.4 does not require `py-ios-device` to be installed.
-     * @privateRemarks See implementation at https://github.com/YueChen-C/py-ios-device/blob/51f4683c5c3c385a015858ada07a5f1c62d3cf57/ios_device/cli/base.py#L220
-     * @see https://github.com/YueChen-C/py-ios-device
-     * @param {string} bundleId - The bundle identifier of the application to be killed
-     * @returns {Promise<boolean>} `true` if the app has been killed successfully; `false` otherwise
-     * @group Real Device Only
-     * @this {XCUITestDriver}
-     */
-    function mobileKillApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
-    /**
-     * Queries the state of an installed application from the device under test.
-     *
-     * If the app with the given `bundleId` is not installed, an exception will be thrown.
-     *
-     * @param {string} bundleId - The bundle identifier of the application to be queried
-     * @returns {Promise<AppState>} The actual application state code
-     * @see https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
-     * @this {XCUITestDriver}
-     */
-    function mobileQueryAppState(this: import("../driver").XCUITestDriver, bundleId: string): Promise<AppState>;
-    /**
-     * @param {string} appPath
-     * @param {object} opts
-     * @this {XCUITestDriver}
-     */
-    function installApp(appPath: string, { timeoutMs, strategy }?: object): Promise<void>;
-    /**
-     * @param {string} bundleId
-     * @param {object} opts
-     * @this {XCUITestDriver}
-     */
-    function activateApp(bundleId: string, opts?: object, ...args: any[]): Promise<void>;
-    /**
-     * @param {string} bundleId
-     * @this {XCUITestDriver}
-     */
-    function isAppInstalled(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
-    /**
-     * @param {string} bundleId
-     * @this {XCUITestDriver}
-     * @returns {Promise<boolean>}
-     */
-    function terminateApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
-    /**
-     * @param {string} bundleId
-     * @this {XCUITestDriver}
-     */
-    function queryAppState(this: import("../driver").XCUITestDriver, bundleId: string): Promise<import("./enum").AppState>;
-    /**
-     * List applications installed on the real device under test
-     *
-     * Read [Pushing/Pulling files](https://appium.io/docs/en/writing-running-appium/ios/ios-xctest-file-movement/) for more details.
-     * @param {'User'|'System'} applicationType - The type of applications to list.
-     * @returns {Promise<Record<string,any>[]>} A list of apps where each item is a mapping of bundle identifiers to maps of platform-specific app properties.
-     * @remarks Having `UIFileSharingEnabled` set to `true` in the return app properties map means this app supports file upload/download in its `documents` container.
-     * @group Real Device Only
-     */
-    function mobileListApps(applicationType?: "User" | "System"): Promise<Record<string, any>[]>;
-    /**
-     * Deletes application data files, so it could start from the clean state next time
-     * it is launched.
-     * This API only works on a Simulator.
-     *
-     * @param {string} bundleId Application bundle identifier
-     * @this {XCUITestDriver}
-     * @returns {Promise<boolean>} true if any files from the app's data container have been deleted
-     */
-    function mobileClearApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
-    /**
-     * Close app (simulate device home button). It is possible to restore
-     * the app after the timeout or keep it minimized based on the parameter value.
-     *
-     * @param {number|{timeout: number?}} [seconds]
-     * - any positive number of seconds: come back after X seconds
-     * - any negative number of seconds or zero: never come back
-     * - undefined/null: never come back
-     * - {timeout: 5000}: come back after 5 seconds
-     * - {timeout: null}, {timeout: -2}: never come back
-     * @this {XCUITestDriver}
-     */
-    function background(this: import("../driver").XCUITestDriver, seconds?: number | {
-        timeout: number | null;
-    }): Promise<unknown>;
-}
-export default _default;
+/**
+ * Installs the given application to the device under test.
+ *
+ * Please ensure the app is built for a correct architecture and is signed with a proper developer signature (for real devices) prior to calling this.
+ * @param {string} app - See docs for `appium:app` capability
+ * @param {number} [timeoutMs] - The maximum time to wait until app install is finished (in ms) on real devices.
+ * If not provided, then the value of `appium:appPushTimeout` capability is used. If the capability is not provided then the default is 240000ms (4 minutes).
+ * @param {boolean} [checkVersion] - If the application installation follows currently installed application's version status if provided.
+ * No checking occurs if no this option.
+ * @privateRemarks Link to capability docs
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+export function mobileInstallApp(this: import("../driver").XCUITestDriver, app: string, timeoutMs?: number, checkVersion?: boolean): Promise<void>;
+/**
+ * Checks whether the given application is installed on the device under test.
+ * Offload app is handled as not installed.
+ *
+ * @param {string} bundleId - The bundle identifier of the application to be checked
+ * @returns {Promise<boolean>} `true` if the application is installed; `false` otherwise
+ * @this {XCUITestDriver}
+ */
+export function mobileIsAppInstalled(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+/**
+ * Removes/uninstalls the given application from the device under test.
+ * Offload app data could also be removed.
+ *
+ * @param {string} bundleId - The bundle identifier of the application to be removed
+ * @returns {Promise<boolean>} `true` if the application has been removed successfully; `false` otherwise
+ * @this {XCUITestDriver}
+ */
+export function mobileRemoveApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+/**
+ * Executes the given app on the device under test.
+ *
+ * If the app is already running it will be activated. If the app is not installed or cannot be launched then an exception is thrown.
+ * @param {string} bundleId - The bundle identifier of the application to be launched
+ * @param {string|string[]} [args] - One or more command line arguments for the app. If the app is already running then this argument is ignored.
+ * @param {object} [environment] - Environment variables mapping for the app. If the app is already running then this argument is ignored.
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+export function mobileLaunchApp(this: import("../driver").XCUITestDriver, bundleId: string, args?: string | string[], environment?: object): Promise<void>;
+/**
+ * Terminates the given app on the device under test.
+ *
+ * This command performs termination via [XCTest's `terminate`](https://developer.apple.com/documentation/xctest/xcuiapplication/1500637-terminate) API. If the app is not installed an exception is thrown. If the app is not running then nothing is done.
+ * @param {string} bundleId - The bundle identifier of the application to be terminated
+ * @returns {Promise<boolean>} `true` if the app has been terminated successfully; `false` otherwise
+ * @this {XCUITestDriver}
+ */
+export function mobileTerminateApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+/**
+ * Activate the given app on the device under test.
+ *
+ * This pushes the app to the foreground if it is running in the background.  An exception is thrown if the app is not install or isn't running.  Nothing is done if the app is already in the foreground.
+ *
+ * @param {string} bundleId - The bundle identifier of the application to be activated
+ * @returns {Promise<void>}
+ * @this {XCUITestDriver}
+ */
+export function mobileActivateApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<void>;
+/**
+ * Kill the given app on the real device under test by instruments service.
+ *
+ * If the app is not running or kill failed, then nothing is done.
+ *
+ * @remarks `appium-xcuitest-driver` v4.4 does not require `py-ios-device` to be installed.
+ * @privateRemarks See implementation at https://github.com/YueChen-C/py-ios-device/blob/51f4683c5c3c385a015858ada07a5f1c62d3cf57/ios_device/cli/base.py#L220
+ * @see https://github.com/YueChen-C/py-ios-device
+ * @param {string} bundleId - The bundle identifier of the application to be killed
+ * @returns {Promise<boolean>} `true` if the app has been killed successfully; `false` otherwise
+ * @group Real Device Only
+ * @this {XCUITestDriver}
+ */
+export function mobileKillApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+/**
+ * Queries the state of an installed application from the device under test.
+ *
+ * If the app with the given `bundleId` is not installed, an exception will be thrown.
+ *
+ * @param {string} bundleId - The bundle identifier of the application to be queried
+ * @returns {Promise<AppState>} The actual application state code
+ * @see https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
+ * @this {XCUITestDriver}
+ */
+export function mobileQueryAppState(this: import("../driver").XCUITestDriver, bundleId: string): Promise<AppState>;
+/**
+ * @param {string} appPath
+ * @param {object} opts
+ * @this {XCUITestDriver}
+ */
+export function installApp(appPath: string, { timeoutMs, strategy }?: object): Promise<void>;
+/**
+ * @param {string} bundleId
+ * @param {object} opts
+ * @this {XCUITestDriver}
+ */
+export function activateApp(bundleId: string, opts?: object, ...args: any[]): Promise<any>;
+/**
+ * @param {string} bundleId
+ * @this {XCUITestDriver}
+ */
+export function isAppInstalled(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+/**
+ * @param {string} bundleId
+ * @this {XCUITestDriver}
+ * @returns {Promise<boolean>}
+ */
+export function terminateApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+/**
+ * @param {string} bundleId
+ * @this {XCUITestDriver}
+ */
+export function queryAppState(this: import("../driver").XCUITestDriver, bundleId: string): Promise<import("./enum").AppState>;
+/**
+ * List applications installed on the real device under test
+ *
+ * Read [Pushing/Pulling files](https://appium.io/docs/en/writing-running-appium/ios/ios-xctest-file-movement/) for more details.
+ * @param {'User'|'System'} applicationType - The type of applications to list.
+ * @returns {Promise<Record<string,any>[]>} A list of apps where each item is a mapping of bundle identifiers to maps of platform-specific app properties.
+ * @remarks Having `UIFileSharingEnabled` set to `true` in the return app properties map means this app supports file upload/download in its `documents` container.
+ * @group Real Device Only
+ */
+export function mobileListApps(applicationType?: "User" | "System"): Promise<Record<string, any>[]>;
+/**
+ * Deletes application data files, so it could start from the clean state next time
+ * it is launched.
+ * This API only works on a Simulator.
+ *
+ * @param {string} bundleId Application bundle identifier
+ * @this {XCUITestDriver}
+ * @returns {Promise<boolean>} true if any files from the app's data container have been deleted
+ */
+export function mobileClearApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+/**
+ * Close app (simulate device home button). It is possible to restore
+ * the app after the timeout or keep it minimized based on the parameter value.
+ *
+ * @param {number|{timeout: number?}} [seconds]
+ * - any positive number of seconds: come back after X seconds
+ * - any negative number of seconds or zero: never come back
+ * - undefined/null: never come back
+ * - {timeout: 5000}: come back after 5 seconds
+ * - {timeout: null}, {timeout: -2}: never come back
+ * @this {XCUITestDriver}
+ */
+export function background(this: import("../driver").XCUITestDriver, seconds?: number | {
+    timeout: number | null;
+}): Promise<unknown>;
 export type XCUITestDriver = import("../driver").XCUITestDriver;
 export type AppState = import("./enum").AppState;
 //# sourceMappingURL=app-management.d.ts.map