appium-xcuitest-driver 4.27.2 → 4.29.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [4.29.0](https://github.com/appium/appium-xcuitest-driver/compare/v4.28.0...v4.29.0) (2023-05-15)
+
+
+### Features
+
+* update docs and args for more execute methods ([5c4bd32](https://github.com/appium/appium-xcuitest-driver/commit/5c4bd3272701f191d5f1abd104deab31ed6b3595))
+
+
+### Bug Fixes
+
+* **deps:** appium upgrades ([70c13dc](https://github.com/appium/appium-xcuitest-driver/commit/70c13dc779c2423c3d726aa1dbf7fcedd496ca82))
+* **execute-methods:** begin migration of docstrings to sources ([316c012](https://github.com/appium/appium-xcuitest-driver/commit/316c012fad7d9b3306cbbe767195b351f60aa26d))
+
+## [4.28.0](https://github.com/appium/appium-xcuitest-driver/compare/v4.27.2...v4.28.0) (2023-05-14)
+
+
+### Features
+
+* Bump WDA ([#1680](https://github.com/appium/appium-xcuitest-driver/issues/1680)) ([2c07021](https://github.com/appium/appium-xcuitest-driver/commit/2c07021753b6c9b3c62639c79bcd769b17329c5c))
+
 ## [4.27.2](https://github.com/appium/appium-xcuitest-driver/compare/v4.27.1...v4.27.2) (2023-05-13)
 
 

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

@@ -1,12 +1,12 @@
 declare namespace _default {
     /**
-     * Returns ActiveApp info.
+     * Returns information about the active application.
      *
-     * @returns {Promise<object>} The response of `/wda/activeAppInfo'`
+     * @returns {Promise<import('./types').ActiveAppInfo>} Active app information
      * @throws {Error} if an error raised by command
      * @this {import('../driver').XCUITestDriver}
      */
-    function mobileGetActiveAppInfo(this: import("../driver").default): Promise<any>;
+    function mobileGetActiveAppInfo(this: import("../driver").default): Promise<import("./types").ActiveAppInfo>;
 }
 export default _default;
 //# sourceMappingURL=activeAppInfo.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"activeAppInfo.d.ts","sourceRoot":"","sources":["../../../lib/commands/activeAppInfo.js"],"names":[],"mappings":";IACE;;;;;;OAMG;IACH,iFAEC"}
+{"version":3,"file":"activeAppInfo.d.ts","sourceRoot":"","sources":["../../../lib/commands/activeAppInfo.js"],"names":[],"mappings":";IACE;;;;;;OAMG;IACH,6GAIC"}

package/build/lib/commands/activeAppInfo.js

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

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

@@ -1 +1 @@
-{"version":3,"file":"activeAppInfo.js","sourceRoot":"","sources":["../../../lib/commands/activeAppInfo.js"],"names":[],"mappings":";;AAAA,kBAAe;IACb;;;;;;OAMG;IACH,KAAK,CAAC,sBAAsB;QAC1B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;CACF,CAAC"}
+{"version":3,"file":"activeAppInfo.js","sourceRoot":"","sources":["../../../lib/commands/activeAppInfo.js"],"names":[],"mappings":";;AAAA,kBAAe;IACb;;;;;;OAMG;IACH,KAAK,CAAC,sBAAsB;QAC1B,OAAO,8CAA8C,CAAC,CACpD,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,KAAK,CAAC,CACrD,CAAC;IACJ,CAAC;CACF,CAAC"}

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

@@ -2,36 +2,45 @@ declare namespace _default {
     /**
      * @this {XCUITestDriver}
      */
-    function getAlertText(this: import("../driver").default): Promise<any>;
+    function getAlertText(this: import("../driver").default): Promise<string | null>;
     /**
      * @param {string} value
      * @this {XCUITestDriver}
+     * @returns {Promise<void>}
      */
-    function setAlertText(this: import("../driver").default, value: string): Promise<any>;
+    function setAlertText(this: import("../driver").default, value: string): Promise<void>;
     /**
      * @param { {buttonLabel?: string} } opts
+     * @returns {Promise<void>}
      * @this {XCUITestDriver}
      */
     function postAcceptAlert(this: import("../driver").default, opts?: {
         buttonLabel?: string | undefined;
-    }): Promise<any>;
+    }): Promise<void>;
     /**
      * @param { {buttonLabel?: string} } opts
+     * @returns {Promise<void>}
      * @this {XCUITestDriver}
      */
     function postDismissAlert(this: import("../driver").default, opts?: {
         buttonLabel?: string | undefined;
-    }): Promise<any>;
+    }): Promise<void>;
     /**
+     * @internal
      * @this {XCUITestDriver}
+     * @returns {Promise<string[]>} The list of button labels
      */
-    function getAlertButtons(this: import("../driver").default): Promise<any>;
+    function getAlertButtons(this: import("../driver").default): Promise<string[]>;
     /**
-     * @param {AlertAction} action
-     * @param {string} [buttonLabel]
+     * 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").default, action: AlertAction, buttonLabel?: string | undefined): Promise<any>;
+    function mobileHandleAlert(this: import("../driver").default, action: AlertAction, buttonLabel?: string | undefined): Promise<void | string[]>;
 }
 export default _default;
 export type AlertAction = 'accept' | 'dismiss' | 'getButtons';

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,uEAEC;IACD;;;OAGG;IACH,sFAEC;IACD;;;OAGG;IACH;;qBAEC;IACD;;;OAGG;IACH;;qBAEC;IACD;;OAEG;IACH,0EAEC;IACD;;;;OAIG;IACH,mIAcC;;;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":";IAcE;;OAEG;IACH,iFAEC;IACD;;;;OAIG;IACH,uFAEC;IACD;;;;OAIG;IACH;;sBAEC;IACD;;;;OAIG;IACH;;sBAEC;IACD;;;;OAIG;IACH,+EAEC;IACD;;;;;;;;OAQG;IACH,+IAcC;;;0BAIU,QAAQ,GAAC,SAAS,GAAC,YAAY;6BAI/B,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/alert.js

@@ -17,38 +17,47 @@ exports.default = {
      * @this {XCUITestDriver}
      */
     async getAlertText() {
-        return await this.proxyCommand('/alert/text', 'GET');
+        return /** @type {string|null} */ (await this.proxyCommand('/alert/text', 'GET'));
     },
     /**
      * @param {string} value
      * @this {XCUITestDriver}
+     * @returns {Promise<void>}
      */
     async setAlertText(value) {
-        return await this.proxyCommand('/alert/text', 'POST', { value });
+        await this.proxyCommand('/alert/text', 'POST', { value });
     },
     /**
      * @param { {buttonLabel?: string} } opts
+     * @returns {Promise<void>}
      * @this {XCUITestDriver}
      */
     async postAcceptAlert(opts = {}) {
-        return await this.proxyCommand('/alert/accept', 'POST', toAlertParams(opts));
+        await this.proxyCommand('/alert/accept', 'POST', toAlertParams(opts));
     },
     /**
      * @param { {buttonLabel?: string} } opts
+     * @returns {Promise<void>}
      * @this {XCUITestDriver}
      */
     async postDismissAlert(opts = {}) {
-        return await this.proxyCommand('/alert/dismiss', 'POST', toAlertParams(opts));
+        await this.proxyCommand('/alert/dismiss', 'POST', toAlertParams(opts));
     },
     /**
+     * @internal
      * @this {XCUITestDriver}
+     * @returns {Promise<string[]>} The list of button labels
      */
     async getAlertButtons() {
-        return await this.proxyCommand('/wda/alert/buttons', 'GET');
+        return /** @type {string[]} */ (await this.proxyCommand('/wda/alert/buttons', 'GET'));
     },
     /**
-     * @param {AlertAction} action
-     * @param {string} [buttonLabel]
+     * 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) {

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;QACpB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;KAChC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,kBAAe;IACb;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,KAAK;QACtB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,EAAC,KAAK,EAAC,CAAC,CAAC;IACjE,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,IAAI,GAAG,EAAE;QAC7B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/E,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAAI,GAAG,EAAE;QAC9B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IACD;;OAEG;IACH,KAAK,CAAC,eAAe;QACnB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,iBAAiB,CAAC,MAAM,EAAE,WAAW;QACzC,QAAQ,MAAM,EAAE;YACd,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;SACL;IACH,CAAC;CACF,CAAC;AAEF;;GAEG;AAEH;;GAEG"}
+{"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;QACpB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;KAChC;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;YACd,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;SACL;IACH,CAAC;CACF,CAAC;AAEF;;GAEG;AAEH;;GAEG"}

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

@@ -1,56 +1,87 @@
 declare namespace _default {
     /**
-     * @param {string} app
-     * @param {string} [strategy]
-     * @param {number} [timeoutMs]
+     * 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 {import('./types').AppInstallStrategy} [strategy] - One of possible app installation strategies on real devices. This argument is ignored on simulators. If not provided, then the value of `appium:appInstallStrategy` is used. If the latter is also not provided, then `serial` is used. See the description of `appium:appInstallStrategy` capability for more details on allowed values.
+     * @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).
+     * @privateRemarks Link to capability docs
+     * @returns {Promise<void>}
      * @this {XCUITestDriver}
      */
-    function mobileInstallApp(this: import("../driver").default, app: string, timeoutMs?: number | undefined, strategy?: string | undefined): Promise<void>;
+    function mobileInstallApp(this: import("../driver").default, app: string, timeoutMs?: number | undefined, strategy?: import("./types").AppInstallStrategy | undefined): Promise<void>;
     /**
-     * @param {string} bundleId
+     * Checks whether the given application is installed on the device under test.
+     *
+     * @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").default, bundleId: string): Promise<any>;
+    function mobileIsAppInstalled(this: import("../driver").default, bundleId: string): Promise<boolean>;
     /**
-     * @param {string} bundleId
+     * Removes/uninstalls the given application from the device under test.
+     *
+     * @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").default, bundleId: string): Promise<boolean>;
     /**
-     * @param {string} bundleId
-     * @param {any|any[]} [args]
-     * @param {any} [environment]
+     * 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").default, bundleId: string, args?: any, environment?: any): Promise<any>;
+    function mobileLaunchApp(this: import("../driver").default, bundleId: string, args?: string | string[] | undefined, environment?: any): Promise<void>;
     /**
-     * @param {string} bundleId
+     * 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").default, bundleId: string): Promise<any>;
+    function mobileTerminateApp(this: import("../driver").default, bundleId: string): Promise<boolean>;
     /**
-     * @param {string} bundleId
+     * 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").default, bundleId: string): Promise<any>;
+    function mobileActivateApp(this: import("../driver").default, bundleId: string): Promise<void>;
     /**
-     * Kill the given bundle id process via instruments service.
-     * @see https://github.com/YueChen-C/py-ios-device/blob/51f4683c5c3c385a015858ada07a5f1c62d3cf57/ios_device/cli/base.py#L220
-     * @param {string} bundleId
-     * @returns {Promise<boolean>} Returns true if the bundle id process was killed. Otherwise false.
+     * 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").default, bundleId: string): Promise<boolean>;
     /**
-     * Returns the current application state
+     * 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 - Options set, which must contain `bundleId` property
-     * @returns {Promise<import('./types').AppState>} The actual application state code. See
-     * https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
-     * to get the list of possible values.
+     * @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").default, bundleId: string): Promise<import("./types").AppState>;
+    function mobileQueryAppState(this: import("../driver").default, bundleId: string): Promise<import("./enum").AppState>;
     /**
      * @param {string} appPath
      * @param {object} opts
@@ -62,30 +93,32 @@ declare namespace _default {
      * @param {object} opts
      * @this {XCUITestDriver}
      */
-    function activateApp(this: import("../driver").default, bundleId: string, opts?: any, ...args: any[]): Promise<any>;
+    function activateApp(this: import("../driver").default, bundleId: string, opts?: any, ...args: any[]): Promise<void>;
     /**
      * @param {string} bundleId
      * @this {XCUITestDriver}
      */
-    function isAppInstalled(this: import("../driver").default, bundleId: string): Promise<any>;
+    function isAppInstalled(this: import("../driver").default, bundleId: string): Promise<boolean>;
     /**
      * @param {string} bundleId
      * @this {XCUITestDriver}
      */
-    function terminateApp(this: import("../driver").default, bundleId: string): Promise<any>;
+    function terminateApp(this: import("../driver").default, bundleId: string): Promise<void>;
     /**
      * @param {string} bundleId
      * @this {XCUITestDriver}
      */
-    function queryAppState(this: import("../driver").default, bundleId: string): Promise<import("./types").AppState>;
+    function queryAppState(this: import("../driver").default, bundleId: string): Promise<import("./enum").AppState>;
     /**
      * List applications installed on the real device under test
      *
-     * @param {'User'|'System'} [applicationType='User']
-     * @returns {Promise<Record<string,any>[]>} A list of apps, where each item is a map where keys are
-     * bundle identifiers and values are maps of platform-specific app properties.
+     * 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" | undefined): Promise<Record<string, any>[]>;
+    function mobileListApps(applicationType?: "User" | "System"): Promise<Record<string, any>[]>;
     /**
      * 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.
@@ -100,8 +133,9 @@ declare namespace _default {
      */
     function background(this: import("../driver").default, seconds?: number | {
         timeout: number | null;
-    } | undefined): Promise<any>;
+    } | undefined): Promise<unknown>;
 }
 export default _default;
 export type XCUITestDriver = import('../driver').XCUITestDriver;
+export type AppState = import('./enum').AppState;
 //# sourceMappingURL=app-management.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"app-management.d.ts","sourceRoot":"","sources":["../../../lib/commands/app-management.js"],"names":[],"mappings":";IAME;;;;;OAKG;IACH,wJAmBC;IACD;;;OAGG;IACH,iGAKC;IACD;;;OAGG;IACH,gGAiBC;IACD;;;;;OAKG;IACH,2HAUC;IACD;;;OAGG;IACH,+FAEC;IACD;;;OAGG;IACH,8FAEC;IAED;;;;;;OAMG;IACH,8FAOC;IAED;;;;;;;;OAQG;IACH,uHAEC;IAED;;;;OAIG;IACH,sHAEC;IACD;;;;OAIG;IACH,oHAGC;IACD;;;OAGG;IACH,2FAEC;IACD;;;OAGG;IACH,yFAEC;IACD;;;OAGG;IACH,iHAEC;IAED;;;;;;OAMG;IACH,yGAWC;IAED;;;;;;;;;;;OAWG;IACH;;iCAgCC;;;6BAIU,OAAO,WAAW,EAAE,cAAc"}
+{"version":3,"file":"app-management.d.ts","sourceRoot":"","sources":["../../../lib/commands/app-management.js"],"names":[],"mappings":";IAME;;;;;;;;;;OAUG;IACH,sLAmBC;IACD;;;;;;OAMG;IACH,qGAKC;IACD;;;;;;OAMG;IACH,gGAiBC;IACD;;;;;;;;;OASG;IACH,sJAUC;IACD;;;;;;;OAOG;IACH,mGAIC;IACD;;;;;;;;OAQG;IACH,+FAEC;IAED;;;;;;;;;;;;OAYG;IACH,8FAOC;IAED;;;;;;;;;OASG;IACH,sHAEC;IAED;;;;OAIG;IACH,sHAEC;IACD;;;;OAIG;IACH,qHAGC;IACD;;;OAGG;IACH,+FAEC;IACD;;;OAGG;IACH,0FAEC;IACD;;;OAGG;IACH,gHAEC;IAED;;;;;;;;OAQG;IACH,6FAWC;IAED;;;;;;;;;;;OAWG;IACH;;qCAgCC;;;6BAIU,OAAO,WAAW,EAAE,cAAc;uBAClC,OAAO,QAAQ,EAAE,QAAQ"}

package/build/lib/commands/app-management.js

@@ -9,9 +9,14 @@ const driver_1 = require("appium/driver");
 const appium_ios_device_1 = require("appium-ios-device");
 exports.default = {
     /**
-     * @param {string} app
-     * @param {string} [strategy]
-     * @param {number} [timeoutMs]
+     * 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 {import('./types').AppInstallStrategy} [strategy] - One of possible app installation strategies on real devices. This argument is ignored on simulators. If not provided, then the value of `appium:appInstallStrategy` is used. If the latter is also not provided, then `serial` is used. See the description of `appium:appInstallStrategy` capability for more details on allowed values.
+     * @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).
+     * @privateRemarks Link to capability docs
+     * @returns {Promise<void>}
      * @this {XCUITestDriver}
      */
     async mobileInstallApp(app, timeoutMs, strategy) {
@@ -27,7 +32,10 @@ exports.default = {
         this.log.info(`Installation of '${srcAppPath}' succeeded`);
     },
     /**
-     * @param {string} bundleId
+     * Checks whether the given application is installed on the device under test.
+     *
+     * @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}
      */
     async mobileIsAppInstalled(bundleId) {
@@ -37,7 +45,10 @@ exports.default = {
         return installed;
     },
     /**
-     * @param {string} bundleId
+     * Removes/uninstalls the given application from the device under test.
+     *
+     * @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}
      */
     async mobileRemoveApp(bundleId) {
@@ -57,9 +68,13 @@ exports.default = {
         }
     },
     /**
-     * @param {string} bundleId
-     * @param {any|any[]} [args]
-     * @param {any} [environment]
+     * 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}
      */
     async mobileLaunchApp(bundleId, args, environment) {
@@ -71,27 +86,42 @@ exports.default = {
         if (environment) {
             launchOptions.environment = environment;
         }
-        return await this.proxyCommand('/wda/apps/launch', 'POST', launchOptions);
+        await this.proxyCommand('/wda/apps/launch', 'POST', launchOptions);
     },
     /**
-     * @param {string} bundleId
+     * 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}
      */
     async mobileTerminateApp(bundleId) {
-        return await this.proxyCommand('/wda/apps/terminate', 'POST', { bundleId });
+        return /** @type {boolean} */ (await this.proxyCommand('/wda/apps/terminate', 'POST', { bundleId }));
     },
     /**
-     * @param {string} bundleId
+     * 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}
      */
     async mobileActivateApp(bundleId) {
-        return await this.proxyCommand('/wda/apps/activate', 'POST', { bundleId });
+        await this.proxyCommand('/wda/apps/activate', 'POST', { bundleId });
     },
     /**
-     * Kill the given bundle id process via instruments service.
-     * @see https://github.com/YueChen-C/py-ios-device/blob/51f4683c5c3c385a015858ada07a5f1c62d3cf57/ios_device/cli/base.py#L220
-     * @param {string} bundleId
-     * @returns {Promise<boolean>} Returns true if the bundle id process was killed. Otherwise false.
+     * 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}
      */
     async mobileKillApp(bundleId) {
@@ -102,16 +132,17 @@ exports.default = {
         return await this.opts.device.terminateApp(bundleId);
     },
     /**
-     * Returns the current application state
+     * 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 - Options set, which must contain `bundleId` property
-     * @returns {Promise<import('./types').AppState>} The actual application state code. See
-     * https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
-     * to get the list of possible values.
+     * @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}
      */
     async mobileQueryAppState(bundleId) {
-        return await this.proxyCommand('/wda/apps/state', 'POST', { bundleId });
+        return /** @type {AppState} */ (await this.proxyCommand('/wda/apps/state', 'POST', { bundleId }));
     },
     /**
      * @param {string} appPath
@@ -142,7 +173,7 @@ exports.default = {
      * @this {XCUITestDriver}
      */
     async terminateApp(bundleId) {
-        return await this.mobileTerminateApp(bundleId);
+        await this.mobileTerminateApp(bundleId);
     },
     /**
      * @param {string} bundleId
@@ -154,11 +185,13 @@ exports.default = {
     /**
      * List applications installed on the real device under test
      *
-     * @param {'User'|'System'} [applicationType='User']
-     * @returns {Promise<Record<string,any>[]>} A list of apps, where each item is a map where keys are
-     * bundle identifiers and values are maps of platform-specific app properties.
+     * 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
      */
-    async mobileListApps(applicationType) {
+    async mobileListApps(applicationType = 'User') {
         if (!this.isRealDevice()) {
             throw new driver_1.errors.NotImplementedError(`This extension is only supported on real devices`);
         }
@@ -218,5 +251,6 @@ exports.default = {
 };
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ * @typedef {import('./enum').AppState} AppState
  */
 //# sourceMappingURL=app-management.js.map

package/build/lib/commands/app-management.js.map

@@ -1 +1 @@
-{"version":3,"file":"app-management.js","sourceRoot":"","sources":["../../../lib/commands/app-management.js"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AACvB,4CAAwC;AACxC,0CAAqC;AACrC,yDAA2C;AAE3C,kBAAe;IACb;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ;QAC7C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAChE,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,eAAe,UAAU,YAAY,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,GAAG;YACvF,uEAAuE;YACvE,cAAc,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,CACzC,CAAC;QACF,IAAI,CAAC,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE;YAClC,IAAI,CAAC,GAAG,CAAC,aAAa,CACpB,uBAAuB,UAAU,uCAAuC,CACzE,CAAC;SACH;QACD,uEAAuE;QACvE,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAC/B,UAAU,EACV,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,EACrC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,kBAAkB,CACzC,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,UAAU,aAAa,CAAC,CAAC;IAC7D,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,QAAQ;QACjC,uEAAuE;QACvE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,QAAQ,OAAO,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,YAAY,CAAC,CAAC;QAC1E,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,QAAQ;QAC5B,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,wDAAwD,QAAQ,IAAI;YAClE,YAAY,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,eAAe;YAC1E,uEAAuE;YACvE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IACnB,GAAG,CACN,CAAC;QACF,IAAI;YACF,uEAAuE;YACvE,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC3C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,QAAQ,aAAa,CAAC,CAAC;YACpD,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,QAAQ,sBAAsB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7E,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IACD;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW;QAC/C,yEAAyE;QACzE,MAAM,aAAa,GAAG,EAAC,QAAQ,EAAC,CAAC;QACjC,IAAI,IAAI,EAAE;YACR,aAAa,CAAC,SAAS,GAAG,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC3D;QACD,IAAI,WAAW,EAAE;YACf,aAAa,CAAC,WAAW,GAAG,WAAW,CAAC;SACzC;QACD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IAC5E,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CAAC,QAAQ;QAC/B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC;IAC5E,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,QAAQ;QAC9B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE;YACxB,MAAM,IAAI,eAAM,CAAC,yBAAyB,CAAC,2BAA2B,CAAC,CAAC;SACzE;QAED,uEAAuE;QACvE,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CAAC,QAAQ;QAChC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,EAAC,SAAS,EAAE,QAAQ,EAAC,GAAG,EAAE;QAClD,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,GAAG,EAAE;QACnC,MAAM,EAAC,WAAW,EAAE,SAAS,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC;QAC5C,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IACjE,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,QAAQ;QAC3B,OAAO,MAAM,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,QAAQ;QACzB,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,QAAQ;QAC1B,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAAC,eAAe;QAClC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE;YACxB,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,kDAAkD,CAAC,CAAC;SAC1F;QAED,MAAM,OAAO,GAAG,MAAM,4BAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpF,IAAI;YACF,OAAO,MAAM,OAAO,CAAC,gBAAgB,CAAC,EAAC,eAAe,EAAC,CAAC,CAAC;SAC1D;gBAAS;YACR,OAAO,CAAC,KAAK,EAAE,CAAC;SACjB;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,OAAO;QACtB,MAAM,UAAU,GAAG,iBAAiB,CAAC;QACrC,MAAM,aAAa,GAAG,oBAAoB,CAAC;QAE3C,IAAI,QAAQ,CAAC;QACb,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,MAAM,cAAc,GAAG,CAAC,cAAc,EAAE,EAAE;YACxC,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;gBAClC,QAAQ,GAAG,UAAU,CAAC;aACvB;iBAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;gBACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;gBAC5C,IAAI,QAAQ,IAAI,CAAC,EAAE;oBACjB,MAAM,GAAG,EAAC,QAAQ,EAAC,CAAC;oBACpB,QAAQ,GAAG,aAAa,CAAC;iBAC1B;qBAAM;oBACL,QAAQ,GAAG,UAAU,CAAC;iBACvB;aACF;QACH,CAAC,CAAC;QACF,IAAI,OAAO,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,gBAAC,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE;YAChE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAChC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;SACzF;aAAM;YACL,cAAc,CAAC,OAAO,CAAC,CAAC;SACzB;QACD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,mDAAmD;gBACjD,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,4BAA4B,CACzD,CAAC;SACH;QACD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,UAAU,CAAC,CAAC;IACpF,CAAC;CACF,CAAC;AAEF;;GAEG"}
+{"version":3,"file":"app-management.js","sourceRoot":"","sources":["../../../lib/commands/app-management.js"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AACvB,4CAAwC;AACxC,0CAAqC;AACrC,yDAA2C;AAE3C,kBAAe;IACb;;;;;;;;;;OAUG;IACH,KAAK,CAAC,gBAAgB,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ;QAC7C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAChE,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,eAAe,UAAU,YAAY,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,GAAG;YACvF,uEAAuE;YACvE,cAAc,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,CACzC,CAAC;QACF,IAAI,CAAC,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE;YAClC,IAAI,CAAC,GAAG,CAAC,aAAa,CACpB,uBAAuB,UAAU,uCAAuC,CACzE,CAAC;SACH;QACD,uEAAuE;QACvE,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAC/B,UAAU,EACV,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,EACrC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,kBAAkB,CACzC,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,UAAU,aAAa,CAAC,CAAC;IAC7D,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CAAC,QAAQ;QACjC,uEAAuE;QACvE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,QAAQ,OAAO,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,YAAY,CAAC,CAAC;QAC1E,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAC,QAAQ;QAC5B,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,wDAAwD,QAAQ,IAAI;YAClE,YAAY,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,eAAe;YAC1E,uEAAuE;YACvE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IACnB,GAAG,CACN,CAAC;QACF,IAAI;YACF,uEAAuE;YACvE,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC3C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,QAAQ,aAAa,CAAC,CAAC;YACpD,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,QAAQ,sBAAsB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7E,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IACD;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW;QAC/C,yEAAyE;QACzE,MAAM,aAAa,GAAG,EAAC,QAAQ,EAAC,CAAC;QACjC,IAAI,IAAI,EAAE;YACR,aAAa,CAAC,SAAS,GAAG,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC3D;QACD,IAAI,WAAW,EAAE;YACf,aAAa,CAAC,WAAW,GAAG,WAAW,CAAC;SACzC;QACD,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACrE,CAAC;IACD;;;;;;;OAOG;IACH,KAAK,CAAC,kBAAkB,CAAC,QAAQ;QAC/B,OAAO,sBAAsB,CAAC,CAC5B,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAC,CAAC,CACnE,CAAC;IACJ,CAAC;IACD;;;;;;;;OAQG;IACH,KAAK,CAAC,iBAAiB,CAAC,QAAQ;QAC9B,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE;YACxB,MAAM,IAAI,eAAM,CAAC,yBAAyB,CAAC,2BAA2B,CAAC,CAAC;SACzE;QAED,uEAAuE;QACvE,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,mBAAmB,CAAC,QAAQ;QAChC,OAAO,uBAAuB,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,EAAC,SAAS,EAAE,QAAQ,EAAC,GAAG,EAAE;QAClD,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,GAAG,EAAE;QACnC,MAAM,EAAC,WAAW,EAAE,SAAS,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC;QAC5C,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IACjE,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,QAAQ;QAC3B,OAAO,MAAM,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,QAAQ;QACzB,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,QAAQ;QAC1B,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAAC,eAAe,GAAG,MAAM;QAC3C,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE;YACxB,MAAM,IAAI,eAAM,CAAC,mBAAmB,CAAC,kDAAkD,CAAC,CAAC;SAC1F;QAED,MAAM,OAAO,GAAG,MAAM,4BAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpF,IAAI;YACF,OAAO,MAAM,OAAO,CAAC,gBAAgB,CAAC,EAAC,eAAe,EAAC,CAAC,CAAC;SAC1D;gBAAS;YACR,OAAO,CAAC,KAAK,EAAE,CAAC;SACjB;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,OAAO;QACtB,MAAM,UAAU,GAAG,iBAAiB,CAAC;QACrC,MAAM,aAAa,GAAG,oBAAoB,CAAC;QAE3C,IAAI,QAAQ,CAAC;QACb,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,MAAM,cAAc,GAAG,CAAC,cAAc,EAAE,EAAE;YACxC,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;gBAClC,QAAQ,GAAG,UAAU,CAAC;aACvB;iBAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;gBACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;gBAC5C,IAAI,QAAQ,IAAI,CAAC,EAAE;oBACjB,MAAM,GAAG,EAAC,QAAQ,EAAC,CAAC;oBACpB,QAAQ,GAAG,aAAa,CAAC;iBAC1B;qBAAM;oBACL,QAAQ,GAAG,UAAU,CAAC;iBACvB;aACF;QACH,CAAC,CAAC;QACF,IAAI,OAAO,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,gBAAC,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE;YAChE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAChC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;SACzF;aAAM;YACL,cAAc,CAAC,OAAO,CAAC,CAAC;SACzB;QACD,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,mDAAmD;gBACjD,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,4BAA4B,CACzD,CAAC;SACH;QACD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,UAAU,CAAC,CAAC;IACpF,CAAC;CACF,CAAC;AAEF;;;GAGG"}

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

@@ -2,14 +2,14 @@ declare namespace _default {
     /**
      * Return the language-specific strings for an app
      *
-     * @param {string} language - the language to retrieve strings for
-     * @param {string|null} stringFile - the path to the localized strings file if not in the default location
+     * @param {string} language - The language abbreviation to fetch app strings mapping for. If no language is provided then strings for the 'en language would be returned
+     * @param {string|null} [stringFile=null] - Relative path to the corresponding .strings file starting from the corresponding .lproj folder, e.g., `base/main.strings`. If omitted, then Appium will make its best guess where the file is.
      *
-     * @returns A record of localized keys to localized text
+     * @returns {Promise<import('@appium/types').StringRecord<string>>} A record of localized keys to localized text
      *
      * @this {XCUITestDriver}
      */
-    function getStrings(this: import("../driver").default, language: string, stringFile?: string | null): Promise<{}>;
+    function getStrings(this: import("../driver").default, language: string, stringFile?: string | null | undefined): Promise<import("@appium/types").StringRecord<string>>;
 }
 export default _default;
 export type XCUITestDriver = import('../driver').XCUITestDriver;

package/build/lib/commands/app-strings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app-strings.d.ts","sourceRoot":"","sources":["../../../lib/commands/app-strings.js"],"names":[],"mappings":";IAGE;;;;;;;;;OASG;IACH,kHASC;;;6BAIU,OAAO,WAAW,EAAE,cAAc"}
+{"version":3,"file":"app-strings.d.ts","sourceRoot":"","sources":["../../../lib/commands/app-strings.js"],"names":[],"mappings":";IAGE;;;;;;;;;OASG;IACH,wKASC;;;6BAIU,OAAO,WAAW,EAAE,cAAc"}

package/build/lib/commands/app-strings.js

@@ -5,10 +5,10 @@ exports.default = {
     /**
      * Return the language-specific strings for an app
      *
-     * @param {string} language - the language to retrieve strings for
-     * @param {string|null} stringFile - the path to the localized strings file if not in the default location
+     * @param {string} language - The language abbreviation to fetch app strings mapping for. If no language is provided then strings for the 'en language would be returned
+     * @param {string|null} [stringFile=null] - Relative path to the corresponding .strings file starting from the corresponding .lproj folder, e.g., `base/main.strings`. If omitted, then Appium will make its best guess where the file is.
      *
-     * @returns A record of localized keys to localized text
+     * @returns {Promise<import('@appium/types').StringRecord<string>>} A record of localized keys to localized text
      *
      * @this {XCUITestDriver}
      */