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

package/CHANGELOG.md

@@ -1,3 +1,97 @@
+## [10.14.6](https://github.com/appium/appium-xcuitest-driver/compare/v10.14.5...v10.14.6) (2026-01-07)
+
+### Miscellaneous Chores
+
+* Migrate the rest of commands to typescript (part 10) ([#2697](https://github.com/appium/appium-xcuitest-driver/issues/2697)) ([73a5cde](https://github.com/appium/appium-xcuitest-driver/commit/73a5cdee66df6df5d78e4518c603d4dad2b780d7))
+
+## [10.14.5](https://github.com/appium/appium-xcuitest-driver/compare/v10.14.4...v10.14.5) (2026-01-06)
+
+### Miscellaneous Chores
+
+* Migrate various commands to typescript (part 9) ([#2695](https://github.com/appium/appium-xcuitest-driver/issues/2695)) ([615b21f](https://github.com/appium/appium-xcuitest-driver/commit/615b21f166ad967e9cb6b3962c9dfed1c7b267e3))
+
+## [10.14.4](https://github.com/appium/appium-xcuitest-driver/compare/v10.14.3...v10.14.4) (2026-01-05)
+
+### Miscellaneous Chores
+
+* Migrate various commands to typescript (part 8) ([#2694](https://github.com/appium/appium-xcuitest-driver/issues/2694)) ([a8438e3](https://github.com/appium/appium-xcuitest-driver/commit/a8438e3d3bd497ba5c3c8b11c03927463a364213))
+
+## [10.14.3](https://github.com/appium/appium-xcuitest-driver/compare/v10.14.2...v10.14.3) (2026-01-04)
+
+### Miscellaneous Chores
+
+* Migrate various command modules to typescript (part 7) ([#2693](https://github.com/appium/appium-xcuitest-driver/issues/2693)) ([1286364](https://github.com/appium/appium-xcuitest-driver/commit/128636475c1eac6ea5c73da3dcebb2eb9d539c4d))
+
+## [10.14.2](https://github.com/appium/appium-xcuitest-driver/compare/v10.14.1...v10.14.2) (2026-01-01)
+
+### Miscellaneous Chores
+
+* Migrate various command modules to typescript (part 6) ([#2692](https://github.com/appium/appium-xcuitest-driver/issues/2692)) ([3736824](https://github.com/appium/appium-xcuitest-driver/commit/37368246181f2e4096ce80ae76e3d458ea39c711))
+
+## [10.14.1](https://github.com/appium/appium-xcuitest-driver/compare/v10.14.0...v10.14.1) (2025-12-31)
+
+### Miscellaneous Chores
+
+* Migrate various command modules to typescript (part 5) ([#2691](https://github.com/appium/appium-xcuitest-driver/issues/2691)) ([0cd46fd](https://github.com/appium/appium-xcuitest-driver/commit/0cd46fdc6fb62df5ee61e8008f53a65f1aec4c5d))
+
+## [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
+
+* Migrate various command modules to typescript ([#2688](https://github.com/appium/appium-xcuitest-driver/issues/2688)) ([43489ba](https://github.com/appium/appium-xcuitest-driver/commit/43489ba00eef50c1e026ba878c31859de63849e9))
+
+## [10.13.2](https://github.com/appium/appium-xcuitest-driver/compare/v10.13.1...v10.13.2) (2025-12-23)
+
+### Miscellaneous Chores
+
+* Migrate various command modules (part 2) ([#2687](https://github.com/appium/appium-xcuitest-driver/issues/2687)) ([3b47a66](https://github.com/appium/appium-xcuitest-driver/commit/3b47a664379bf5b1d20472ce83c74ce34ab7a661))
+
+## [10.13.1](https://github.com/appium/appium-xcuitest-driver/compare/v10.13.0...v10.13.1) (2025-12-23)
+
+### Bug Fixes
+
+* prevent raising error in safari session ([#2686](https://github.com/appium/appium-xcuitest-driver/issues/2686)) ([7c7f5cb](https://github.com/appium/appium-xcuitest-driver/commit/7c7f5cbe6d27634ce52d9024b40673973be0289c))
+
+## [10.13.0](https://github.com/appium/appium-xcuitest-driver/compare/v10.12.2...v10.13.0) (2025-12-23)
+
+### Features
+
+* Migrate various command modules to typescript (part 1) ([#2683](https://github.com/appium/appium-xcuitest-driver/issues/2683)) ([c0b53ba](https://github.com/appium/appium-xcuitest-driver/commit/c0b53ba8fd212ce09f9d4c4d45f869a7c3f40fd2))
+
+## [10.12.2](https://github.com/appium/appium-xcuitest-driver/compare/v10.12.1...v10.12.2) (2025-12-22)
+
+### Miscellaneous Chores
+
+* **deps:** bump teen_process from 3.0.6 to 4.0.4 ([#2684](https://github.com/appium/appium-xcuitest-driver/issues/2684)) ([005e984](https://github.com/appium/appium-xcuitest-driver/commit/005e9846229fc2d4bcb468758f4e653a295599e6))
+
+## [10.12.1](https://github.com/appium/appium-xcuitest-driver/compare/v10.12.0...v10.12.1) (2025-12-22)
+
+### Miscellaneous Chores
+
+* Bump major appium-webdriveragent version to 11 ([#2682](https://github.com/appium/appium-xcuitest-driver/issues/2682)) ([c70e413](https://github.com/appium/appium-xcuitest-driver/commit/c70e4138a151932b4cd5a81b020660b0220f70f3))
+
+## [10.12.0](https://github.com/appium/appium-xcuitest-driver/compare/v10.11.0...v10.12.0) (2025-12-18)
+
+### Features
+
+* Add `enforceCustomSnapshots` setting ([#2680](https://github.com/appium/appium-xcuitest-driver/issues/2680)) ([6758bee](https://github.com/appium/appium-xcuitest-driver/commit/6758beea9d8580d8e4d983b213b07cb96c5e63de))
+
+### Miscellaneous Chores
+
+* **deps:** bump asyncbox from 3.0.0 to 4.0.1 ([#2681](https://github.com/appium/appium-xcuitest-driver/issues/2681)) ([6998151](https://github.com/appium/appium-xcuitest-driver/commit/6998151da802a57276e2149eb21844e087f0430a))
+
 ## [10.11.0](https://github.com/appium/appium-xcuitest-driver/compare/v10.10.1...v10.11.0) (2025-12-13)
 
 ### Features

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

@@ -1,9 +1,10 @@
+import type { XCUITestDriver } from '../driver';
+import type { ActiveAppInfo } from './types';
 /**
  * Returns information about the active application.
  *
- * @returns {Promise<import('./types').ActiveAppInfo>} Active app information
+ * @returns 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>;
+export declare function mobileGetActiveAppInfo(this: XCUITestDriver): Promise<ActiveAppInfo>;
 //# sourceMappingURL=active-app-info.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"active-app-info.d.ts","sourceRoot":"","sources":["../../../lib/commands/active-app-info.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAE3C;;;;;GAKG;AACH,wBAAsB,sBAAsB,CAC1C,IAAI,EAAE,cAAc,GACnB,OAAO,CAAC,aAAa,CAAC,CAExB"}

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

@@ -4,11 +4,10 @@ exports.mobileGetActiveAppInfo = mobileGetActiveAppInfo;
 /**
  * Returns information about the active application.
  *
- * @returns {Promise<import('./types').ActiveAppInfo>} Active app information
+ * @returns 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'));
+    return await this.proxyCommand('/wda/activeAppInfo', 'GET');
 }
 //# sourceMappingURL=active-app-info.js.map

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

@@ -1 +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"}
+{"version":3,"file":"active-app-info.js","sourceRoot":"","sources":["../../../lib/commands/active-app-info.ts"],"names":[],"mappings":";;AASA,wDAIC;AAVD;;;;;GAKG;AACI,KAAK,UAAU,sBAAsB;IAG1C,OAAO,MAAM,IAAI,CAAC,YAAY,CAAyB,oBAAoB,EAAE,KAAK,CAAC,CAAC;AACtF,CAAC"}

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

@@ -1,45 +1,40 @@
+import type { XCUITestDriver } from '../driver';
+export type AlertAction = 'accept' | 'dismiss' | 'getButtons';
 /**
- * @this {XCUITestDriver}
- */
-export function getAlertText(this: import("../driver").XCUITestDriver): Promise<string | null>;
-/**
- * @param {string} value
- * @this {XCUITestDriver}
- * @returns {Promise<void>}
+ * Gets the text of the currently displayed alert.
+ *
+ * @returns The alert text, or null if no alert is displayed
  */
-export function setAlertText(this: import("../driver").XCUITestDriver, value: string): Promise<void>;
+export declare function getAlertText(this: XCUITestDriver): Promise<string | null>;
 /**
- * @param { {buttonLabel?: string} } opts
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
+ * Sets the text in an alert input field.
+ *
+ * @param value - The text to set
  */
-export function postAcceptAlert(this: import("../driver").XCUITestDriver, opts?: {
-    buttonLabel?: string;
-}): Promise<void>;
+export declare function setAlertText(this: XCUITestDriver, value: string): Promise<void>;
 /**
- * @param { {buttonLabel?: string} } opts
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
+ * Accepts the currently displayed alert.
+ *
+ * @param opts - Options including optional button label
  */
-export function postDismissAlert(this: import("../driver").XCUITestDriver, opts?: {
-    buttonLabel?: string;
-}): Promise<void>;
+export declare function postAcceptAlert(this: XCUITestDriver, opts?: AlertOptions): Promise<void>;
 /**
- * @internal
- * @this {XCUITestDriver}
- * @returns {Promise<string[]>} The list of button labels
+ * Dismisses the currently displayed alert.
+ *
+ * @param opts - Options including optional button label
  */
-export function getAlertButtons(this: import("../driver").XCUITestDriver): Promise<string[]>;
+export declare function postDismissAlert(this: XCUITestDriver, opts?: AlertOptions): Promise<void>;
 /**
  * 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.
+ * @param action - The actual action to apply
+ * @param buttonLabel - The name of the button used to perform the chosen alert action. Only makes sense if the action is `accept` or `dismiss`
+ * @returns If `action` is `getButtons`, a list of alert button labels; 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;
+export declare function mobileHandleAlert(this: XCUITestDriver, action: AlertAction, buttonLabel?: string): Promise<string[] | void>;
+interface AlertOptions {
+    buttonLabel?: string;
+}
+export {};
 //# 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":"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"}
+{"version":3,"file":"alert.d.ts","sourceRoot":"","sources":["../../../lib/commands/alert.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAE9C,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,CAAC;AAE9D;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAE/E;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,cAAc,EACpB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CACnC,IAAI,EAAE,cAAc,EACpB,IAAI,GAAE,YAAiB,GACtB,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,cAAc,EACpB,IAAI,GAAE,YAAiB,GACtB,OAAO,CAAC,IAAI,CAAC,CAEf;AAYD;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,WAAW,EACnB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAc1B;AAUD,UAAU,YAAY;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/build/lib/commands/alert.js

@@ -7,51 +7,53 @@ exports.postDismissAlert = postDismissAlert;
 exports.getAlertButtons = getAlertButtons;
 exports.mobileHandleAlert = mobileHandleAlert;
 /**
- * @this {XCUITestDriver}
+ * Gets the text of the currently displayed alert.
+ *
+ * @returns The alert text, or null if no alert is displayed
  */
 async function getAlertText() {
-    return /** @type {string|null} */ (await this.proxyCommand('/alert/text', 'GET'));
+    return await this.proxyCommand('/alert/text', 'GET');
 }
 /**
- * @param {string} value
- * @this {XCUITestDriver}
- * @returns {Promise<void>}
+ * Sets the text in an alert input field.
+ *
+ * @param value - The text to set
  */
 async function setAlertText(value) {
     await this.proxyCommand('/alert/text', 'POST', { value });
 }
 /**
- * @param { {buttonLabel?: string} } opts
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
+ * Accepts the currently displayed alert.
+ *
+ * @param opts - Options including optional button label
  */
 async function postAcceptAlert(opts = {}) {
     await this.proxyCommand('/alert/accept', 'POST', toAlertParams(opts));
 }
 /**
- * @param { {buttonLabel?: string} } opts
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
+ * Dismisses the currently displayed alert.
+ *
+ * @param opts - Options including optional button label
  */
 async function postDismissAlert(opts = {}) {
     await this.proxyCommand('/alert/dismiss', 'POST', toAlertParams(opts));
 }
 /**
+ * Gets the list of button labels from the currently displayed alert.
+ *
+ * @returns The list of button labels
  * @internal
- * @this {XCUITestDriver}
- * @returns {Promise<string[]>} The list of button labels
  */
 async function getAlertButtons() {
-    return /** @type {string[]} */ (await this.proxyCommand('/wda/alert/buttons', 'GET'));
+    return 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.
+ * @param action - The actual action to apply
+ * @param buttonLabel - The name of the button used to perform the chosen alert action. Only makes sense if the action is `accept` or `dismiss`
+ * @returns If `action` is `getButtons`, a list of alert button labels; otherwise nothing
  * @remarks This should really be separate commands.
- * @this {XCUITestDriver}
  */
 async function mobileHandleAlert(action, buttonLabel) {
     switch (action) {
@@ -66,11 +68,6 @@ async function mobileHandleAlert(action, buttonLabel) {
                 `'${action}' is provided instead.`);
     }
 }
-/**
- *
- * @param { {buttonLabel?: string} } opts
- * @returns { {name?: string} }
- */
 function toAlertParams(opts = {}) {
     const params = {};
     if (opts.buttonLabel) {
@@ -78,10 +75,4 @@ function toAlertParams(opts = {}) {
     }
     return params;
 }
-/**
- * @typedef {'accept'|'dismiss'|'getButtons'} AlertAction
- */
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */
 //# sourceMappingURL=alert.js.map

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"alert.js","sourceRoot":"","sources":["../../../lib/commands/alert.ts"],"names":[],"mappings":";;AASA,oCAEC;AAOD,oCAKC;AAOD,0CAKC;AAOD,4CAKC;AAQD,0CAEC;AAUD,8CAkBC;AAjFD;;;;GAIG;AACI,KAAK,UAAU,YAAY;IAChC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAqB,aAAa,EAAE,KAAK,CAAC,CAAC;AAC3E,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,YAAY,CAEhC,KAAa;IAEb,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,EAAC,KAAK,EAAC,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe,CAEnC,OAAqB,EAAE;IAEvB,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;AACxE,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,gBAAgB,CAEpC,OAAqB,EAAE;IAEvB,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;AACzE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,eAAe;IACnC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAgB,oBAAoB,EAAE,KAAK,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,iBAAiB,CAErC,MAAmB,EACnB,WAAoB;IAEpB,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,SAAS,aAAa,CAAC,OAAqB,EAAE;IAC5C,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -1,65 +1,58 @@
+import type { XCUITestDriver } from '../driver';
+import type { AppState } from './enum';
 /**
  * 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.
+ * @param app - See docs for `appium:app` capability
+ * @param 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.
+ * @param 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>;
+export declare function mobileInstallApp(this: 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}
+ * @param bundleId - The bundle identifier of the application to be checked
+ * @returns `true` if the application is installed; `false` otherwise
  */
-export function mobileIsAppInstalled(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+export declare function mobileIsAppInstalled(this: 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}
+ * @param bundleId - The bundle identifier of the application to be removed
+ * @returns `true` if the application has been removed successfully; `false` otherwise
  */
-export function mobileRemoveApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+export declare function mobileRemoveApp(this: 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}
+ * @param bundleId - The bundle identifier of the application to be launched
+ * @param args - One or more command line arguments for the app. If the app is already running then this argument is ignored.
+ * @param environment - Environment variables mapping for the app. If the app is already running then this argument is ignored.
  */
-export function mobileLaunchApp(this: import("../driver").XCUITestDriver, bundleId: string, args?: string | string[], environment?: object): Promise<void>;
+export declare function mobileLaunchApp(this: XCUITestDriver, bundleId: string, args?: string | string[], environment?: Record<string, any>): 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}
+ * @param bundleId - The bundle identifier of the application to be terminated
+ * @returns `true` if the app has been terminated successfully; `false` otherwise
  */
-export function mobileTerminateApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+export declare function mobileTerminateApp(this: 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}
+ * @param bundleId - The bundle identifier of the application to be activated
  */
-export function mobileActivateApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<void>;
+export declare function mobileActivateApp(this: XCUITestDriver, bundleId: string): Promise<void>;
 /**
  * Kill the given app on the real device under test by instruments service.
  *
@@ -68,86 +61,116 @@ export function mobileActivateApp(this: import("../driver").XCUITestDriver, bund
  * @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
+ * @param bundleId - The bundle identifier of the application to be killed
+ * @returns `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>;
+export declare function mobileKillApp(this: 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
+ * @param bundleId - The bundle identifier of the application to be queried
+ * @returns 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>;
+export declare function mobileQueryAppState(this: XCUITestDriver, bundleId: string): Promise<AppState>;
 /**
- * @param {string} appPath
- * @param {object} opts
- * @this {XCUITestDriver}
+ * Installs the given application to the device under test.
+ *
+ * This is a wrapper around {@linkcode mobileInstallApp mobile: installApp}.
+ *
+ * @param appPath - Path to the application bundle or .ipa/.app file
+ * @param opts - Installation options
+ * @param opts.timeoutMs - Maximum time to wait for installation to complete (in milliseconds)
+ * @param opts.strategy - If `true`, checks the version before installing and skips if already installed
  */
-export function installApp(appPath: string, { timeoutMs, strategy }?: object): Promise<void>;
+export declare function installApp(this: XCUITestDriver, appPath: string, opts?: {
+    timeoutMs?: number;
+    strategy?: boolean;
+}): Promise<void>;
 /**
- * @param {string} bundleId
- * @param {object} opts
- * @this {XCUITestDriver}
+ * Activates the given app on the device under test.
+ *
+ * This is a wrapper around {@linkcode mobileLaunchApp mobile: launchApp}. If the app is already
+ * running, it will be activated (brought to foreground). If the app is not installed or cannot
+ * be launched, an exception is thrown.
+ *
+ * @param bundleId - The bundle identifier of the application to be activated
+ * @param opts - Launch options
+ * @param opts.environment - Environment variables mapping for the app
+ * @param opts.arguments - Command line arguments for the app
  */
-export function activateApp(bundleId: string, opts?: object, ...args: any[]): Promise<any>;
+export declare function activateApp(this: XCUITestDriver, bundleId: string, opts?: {
+    environment?: Record<string, any>;
+    arguments?: string[];
+}): Promise<void>;
 /**
- * @param {string} bundleId
- * @this {XCUITestDriver}
+ * Checks whether the given application is installed on the device under test.
+ *
+ * This is a wrapper around {@linkcode mobileIsAppInstalled mobile: isAppInstalled}.
+ * Offload apps are treated as not installed.
+ *
+ * @param bundleId - The bundle identifier of the application to be checked
+ * @returns `true` if the application is installed; `false` otherwise
  */
-export function isAppInstalled(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+export declare function isAppInstalled(this: XCUITestDriver, bundleId: string): Promise<boolean>;
 /**
- * @param {string} bundleId
- * @this {XCUITestDriver}
- * @returns {Promise<boolean>}
+ * Terminates the given app on the device under test.
+ *
+ * This is a wrapper around {@linkcode mobileTerminateApp mobile: terminateApp}.
+ * The command performs termination via XCTest's `terminate` API. If the app is not installed,
+ * an exception is thrown. If the app is not running, nothing is done.
+ *
+ * @param bundleId - The bundle identifier of the application to be terminated
+ * @returns `true` if the app has been terminated successfully; `false` otherwise
  */
-export function terminateApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+export declare function terminateApp(this: XCUITestDriver, bundleId: string): Promise<boolean>;
 /**
- * @param {string} bundleId
- * @this {XCUITestDriver}
+ * Queries the state of an installed application from the device under test.
+ *
+ * This is a wrapper around {@linkcode mobileQueryAppState mobile: queryAppState}.
+ * If the app with the given `bundleId` is not installed, an exception will be thrown.
+ *
+ * @param bundleId - The bundle identifier of the application to be queried
+ * @returns The actual application state code
+ * @see https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc
  */
-export function queryAppState(this: import("../driver").XCUITestDriver, bundleId: string): Promise<import("./enum").AppState>;
+export declare function queryAppState(this: XCUITestDriver, bundleId: string): Promise<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.
+ * @param applicationType - The type of applications to list.
+ * @returns 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>[]>;
+export declare function mobileListApps(this: XCUITestDriver, 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
+ * @param bundleId Application bundle identifier
+ * @returns true if any files from the app's data container have been deleted
  */
-export function mobileClearApp(this: import("../driver").XCUITestDriver, bundleId: string): Promise<boolean>;
+export declare function mobileClearApp(this: 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.
+ * Closes the app (simulates device home button press).
  *
- * @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;
+ * It is possible to restore the app after a timeout or keep it minimized based on the parameter value.
+ *
+ * @param seconds - Timeout configuration. Accepts:
+ *   - A positive number (seconds): app will be restored after the specified number of seconds
+ *   - A negative number or zero: app will not be restored (kept minimized)
+ *   - `undefined` or `null`: app will not be restored (kept minimized)
+ *   - An object with `timeout` property:
+ *     - `{timeout: 5000}`: app will be restored after 5 seconds (timeout in milliseconds)
+ *     - `{timeout: null}` or `{timeout: -2}`: app will not be restored
+ */
+export declare function background(this: XCUITestDriver, seconds?: number | {
+    timeout?: number | null;
+}): Promise<void>;
 //# 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":"AAYA;;;;;;;;;;;;GAYG;AACH,gFATW,MAAM,cACN,MAAM,iBAEN,OAAO,GAGL,OAAO,CAAC,IAAI,CAAC,CA2CzB;AAED;;;;;;;GAOG;AACH,yFAJW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAO5B;AAED;;;;;;;GAOG;AACH,oFAJW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAgB5B;AAED;;;;;;;;;GASG;AACH,oFANW,MAAM,SACN,MAAM,GAAC,MAAM,EAAE,gBACf,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAazB;AAED;;;;;;;GAOG;AACH,uFAJW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAO5B;AAED;;;;;;;;GAQG;AACH,sFAJW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAKzB;AAED;;;;;;;;;;;;GAYG;AACH,kFALW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAY5B;AAED;;;;;;;;;GASG;AACH,wFALW,MAAM,GACJ,OAAO,CAAC,QAAQ,CAAC,CAM7B;AAED;;;;GAIG;AACH,oCAJW,MAAM,4BACN,MAAM,iBAMhB;AAED;;;;GAIG;AACH,sCAJW,MAAM,SACN,MAAM,gCAOhB;AAED;;;GAGG;AACH,mFAHW,MAAM,oBAKhB;AAED;;;;GAIG;AACH,iFAJW,MAAM,GAEJ,OAAO,CAAC,OAAO,CAAC,CAI5B;AAED;;;GAGG;AACH,kFAHW,MAAM,sCAKhB;AAED;;;;;;;;GAQG;AACH,iDALW,MAAM,GAAC,QAAQ,GACb,OAAO,CAAC,MAAM,CAAC,MAAM,EAAC,GAAG,CAAC,EAAE,CAAC,CAezC;AAED;;;;;;;;GAQG;AACH,mFAJW,MAAM,GAEJ,OAAO,CAAC,OAAO,CAAC,CA6B5B;AAED;;;;;;;;;;;GAWG;AACH,+EARW,MAAM,GAAC;IAAC,OAAO,EAAE,MAAM,OAAC,CAAA;CAAC,oBAwCnC;6BAGY,OAAO,WAAW,EAAE,cAAc;uBAClC,OAAO,QAAQ,EAAE,QAAQ"}
+{"version":3,"file":"app-management.d.ts","sourceRoot":"","sources":["../../../lib/commands/app-management.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,QAAQ,CAAC;AAIrC;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,cAAc,EACpB,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,EAClB,YAAY,CAAC,EAAE,OAAO,GACrB,OAAO,CAAC,IAAI,CAAC,CAwCf;AAED;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAIlB;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CACnC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAalB;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CACnC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,EACxB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAChC,OAAO,CAAC,IAAI,CAAC,CAaf;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAElB;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAMlB;AAED;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,QAAQ,CAAC,CAEnB;AAED;;;;;;;;;GASG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,MAAM,EACf,IAAI,GAAE;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAM,GAClD,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE;IAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CAAM,GACnE,OAAO,CAAC,IAAI,CAAC,CAGf;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAElB;AAED;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAElB;AAED;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,QAAQ,CAAC,CAEnB;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,cAAc,EACpB,eAAe,GAAE,MAAM,GAAG,QAAiB,GAC1C,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,CAWhC;AAED;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CA2BlB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,cAAc,EACpB,OAAO,CAAC,EAAE,MAAM,GAAG;IAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAC,GAC3C,OAAO,CAAC,IAAI,CAAC,CAgCf"}