appium-xcuitest-driver 10.14.2 → 10.14.3

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

@@ -1,27 +1,21 @@
+import type { XCUITestDriver } from '../driver';
+export interface SimctlExecResponse {
+    /** The output of standard out. */
+    stdout: string;
+    /** The output of standard error. */
+    stderr: string;
+    /** Return code. */
+    code: number;
+}
 /**
  * Run the given command with arguments as `xcrun simctl` subcommand.
  * This method works behind the 'simctl' security flag.
- * @this {XCUITestDriver}
- * @param {string} command Subcommand to run with `xcrun simctl`
- * @param {string[]} [args=[]] arguments for the subcommand. The arguments should be after <device> in the help.
- * @param {number|undefined} timeout - The maximum number of milliseconds
- * @returns {Promise<SimctlExecResponse>}
- * @throws {Error} If the simctl subcommand command returns non-zero return code, or the given subcommand was invalid.
+ *
+ * @param command - Subcommand to run with `xcrun simctl`. Must be one of the supported commands.
+ * @param args - Arguments for the subcommand. The arguments should be after <device> in the help.
+ * @param timeout - The maximum number of milliseconds
+ * @returns The execution result with stdout, stderr, and return code
+ * @throws If the simctl subcommand command returns non-zero return code, or the given subcommand was invalid.
  */
-export function mobileSimctl(this: import("../driver").XCUITestDriver, command: string, args?: string[], timeout?: number | undefined): Promise<SimctlExecResponse>;
-export type SimctlExecResponse = {
-    /**
-     * The output of standard out.
-     */
-    stdout: string;
-    /**
-     * The output of standard error.
-     */
-    stderr: string;
-    /**
-     * Return code.
-     */
-    code: number;
-};
-export type XCUITestDriver = import("../driver").XCUITestDriver;
+export declare function mobileSimctl(this: XCUITestDriver, command: string, args?: string[], timeout?: number): Promise<SimctlExecResponse>;
 //# sourceMappingURL=simctl.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"simctl.d.ts","sourceRoot":"","sources":["../../../lib/commands/simctl.js"],"names":[],"mappings":"AA+BA;;;;;;;;;GASG;AACH,gFANW,MAAM,SACN,MAAM,EAAE,YACR,MAAM,GAAC,SAAS,GACd,OAAO,CAAC,kBAAkB,CAAC,CA0BvC;;;;;YAIa,MAAM;;;;YACN,MAAM;;;;UACN,MAAM;;6BAIP,OAAO,WAAW,EAAE,cAAc"}
+{"version":3,"file":"simctl.d.ts","sourceRoot":"","sources":["../../../lib/commands/simctl.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAgC9C,MAAM,WAAW,kBAAkB;IACjC,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,MAAM,EAAO,EACnB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,CAuB7B"}

package/build/lib/commands/simctl.js

@@ -33,14 +33,14 @@ const SUBCOMMANDS_HAS_DEVICE = [
 /**
  * Run the given command with arguments as `xcrun simctl` subcommand.
  * This method works behind the 'simctl' security flag.
- * @this {XCUITestDriver}
- * @param {string} command Subcommand to run with `xcrun simctl`
- * @param {string[]} [args=[]] arguments for the subcommand. The arguments should be after <device> in the help.
- * @param {number|undefined} timeout - The maximum number of milliseconds
- * @returns {Promise<SimctlExecResponse>}
- * @throws {Error} If the simctl subcommand command returns non-zero return code, or the given subcommand was invalid.
+ *
+ * @param command - Subcommand to run with `xcrun simctl`. Must be one of the supported commands.
+ * @param args - Arguments for the subcommand. The arguments should be after <device> in the help.
+ * @param timeout - The maximum number of milliseconds
+ * @returns The execution result with stdout, stderr, and return code
+ * @throws If the simctl subcommand command returns non-zero return code, or the given subcommand was invalid.
  */
-async function mobileSimctl(command, args = [], timeout = undefined) {
+async function mobileSimctl(command, args = [], timeout) {
     if (!this.isSimulator()) {
         throw new driver_1.errors.UnsupportedOperationError(`Only simulator is supported.`);
     }
@@ -51,20 +51,11 @@ async function mobileSimctl(command, args = [], timeout = undefined) {
         throw new driver_1.errors.InvalidArgumentError(`The given command '${command}' is not supported. ` +
             `Available subcommands are ${SUBCOMMANDS_HAS_DEVICE.join(',')}`);
     }
-    const result = await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.exec(command, { args: [this.opts.udid, ...args], timeout });
+    const result = await this.device.simctl.exec(command, { args: [this.opts.udid, ...args], timeout });
     return {
         stdout: result?.stdout ?? '',
         stderr: result?.stderr ?? '',
         code: result?.code ?? 0
     };
 }
-/**
- * @typedef {Object} SimctlExecResponse
- * @property {string} stdout The output of standard out.
- * @property {string} stderr The output of standard error.
- * @property {number} code Return code.
- */
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */
 //# sourceMappingURL=simctl.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"simctl.js","sourceRoot":"","sources":["../../../lib/commands/simctl.js"],"names":[],"mappings":";;AAyCA,oCAuBC;AAhED,0CAAuC;AAEvC;;;GAGG;AACH,MAAM,sBAAsB,GAAG;IAC7B,MAAM;IACN,mBAAmB;IACnB,QAAQ;IACR,aAAa;IACb,SAAS;IACT,kBAAkB;IAClB,IAAI;IACJ,UAAU;IACV,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,SAAS;IACT,QAAQ;IACR,SAAS;IACT,SAAS;IACT,MAAM;IACN,UAAU;IACV,OAAO;IACP,YAAY;IACZ,WAAW;IACX,IAAI;IACJ,WAAW;CACZ,CAAC;AAEF;;;;;;;;;GASG;AACI,KAAK,UAAU,YAAY,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,OAAO,GAAG,SAAS;IACxE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,eAAM,CAAC,yBAAyB,CAAC,8BAA8B,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACpB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,sCAAsC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IACjG,CAAC;IAED,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,sBAAsB,OAAO,sBAAsB;YACvF,6BAA6B,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,uDAAuD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CACpG,OAAO,EACP,EAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,OAAO,EAAC,CAC3C,CAAC;IACF,OAAO;QACL,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE;QAC5B,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE;QAC5B,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC;KACxB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AAEH;;GAEG"}
+{"version":3,"file":"simctl.js","sourceRoot":"","sources":["../../../lib/commands/simctl.ts"],"names":[],"mappings":";;AAoDA,oCA4BC;AAhFD,0CAAuC;AAIvC;;;GAGG;AACH,MAAM,sBAAsB,GAAG;IAC7B,MAAM;IACN,mBAAmB;IACnB,QAAQ;IACR,aAAa;IACb,SAAS;IACT,kBAAkB;IAClB,IAAI;IACJ,UAAU;IACV,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,SAAS;IACT,QAAQ;IACR,SAAS;IACT,SAAS;IACT,MAAM;IACN,UAAU;IACV,OAAO;IACP,YAAY;IACZ,WAAW;IACX,IAAI;IACJ,WAAW;CACH,CAAC;AAWX;;;;;;;;;GASG;AACI,KAAK,UAAU,YAAY,CAEhC,OAAe,EACf,OAAiB,EAAE,EACnB,OAAgB;IAEhB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,eAAM,CAAC,yBAAyB,CAAC,8BAA8B,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACpB,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,sCAAsC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IACjG,CAAC;IAED,IAAI,CAAE,sBAA4C,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACrE,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,sBAAsB,OAAO,sBAAsB;YACvF,6BAA6B,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,MAAM,GAAG,MAAO,IAAI,CAAC,MAAoB,CAAC,MAAM,CAAC,IAAI,CACzD,OAAgD,EAChD,EAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,OAAO,EAAC,CAC3C,CAAC;IACF,OAAO;QACL,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE;QAC5B,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE;QAC5B,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC;KACxB,CAAC;AACJ,CAAC"}

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

@@ -1,53 +1,46 @@
+import type { XCUITestDriver } from '../driver';
 /**
- * @this {XCUITestDriver}
+ * Sets the page load timeout using W3C protocol.
+ *
+ * @param ms - Timeout in milliseconds
  */
-export function pageLoadTimeoutW3C(this: import("../driver").XCUITestDriver, ms: any): Promise<void>;
+export declare function pageLoadTimeoutW3C(this: XCUITestDriver, ms: number): Promise<void>;
 /**
- * @this {XCUITestDriver}
+ * Sets the page load timeout using MJSONWP protocol.
+ *
+ * @param ms - Timeout in milliseconds
  */
-export function pageLoadTimeoutMJSONWP(this: import("../driver").XCUITestDriver, ms: any): Promise<void>;
+export declare function pageLoadTimeoutMJSONWP(this: XCUITestDriver, ms: number): Promise<void>;
 /**
- * @this {XCUITestDriver}
+ * Sets the async script timeout using W3C protocol.
+ *
+ * @param ms - Timeout in milliseconds
  */
-export function scriptTimeoutW3C(this: import("../driver").XCUITestDriver, ms: any): Promise<void>;
+export declare function scriptTimeoutW3C(this: XCUITestDriver, ms: number): Promise<void>;
 /**
  * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
  *
- * @param {number} ms - the timeout
- * @this {XCUITestDriver}
+ * @param ms - The timeout in milliseconds
  * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
  */
-export function scriptTimeoutMJSONWP(this: import("../driver").XCUITestDriver, ms: number): Promise<void>;
+export declare function scriptTimeoutMJSONWP(this: XCUITestDriver, ms: number): Promise<void>;
 /**
  * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
  *
- * @param {number} ms - the timeout
- *
+ * @param ms - The timeout in milliseconds
  * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
- * @this {XCUITestDriver}
  */
-export function asyncScriptTimeout(this: import("../driver").XCUITestDriver, ms: number): Promise<void>;
+export declare function asyncScriptTimeout(this: XCUITestDriver, ms: number): Promise<void>;
 /**
- * @this {XCUITestDriver}
+ * Sets the page load timeout.
+ *
+ * @param ms - Timeout in milliseconds
  */
-export function setPageLoadTimeout(this: import("../driver").XCUITestDriver, ms: any): void;
-export class setPageLoadTimeout {
-    /**
-     * @this {XCUITestDriver}
-     */
-    constructor(this: import("../driver").XCUITestDriver, ms: any);
-    pageLoadMs: any;
-}
+export declare function setPageLoadTimeout(this: XCUITestDriver, ms: number): void;
 /**
- * @this {XCUITestDriver}
+ * Sets the async script timeout.
+ *
+ * @param ms - Timeout in milliseconds
  */
-export function setAsyncScriptTimeout(this: import("../driver").XCUITestDriver, ms: any): void;
-export class setAsyncScriptTimeout {
-    /**
-     * @this {XCUITestDriver}
-     */
-    constructor(this: import("../driver").XCUITestDriver, ms: any);
-    asyncWaitMs: any;
-}
-export type XCUITestDriver = import("../driver").XCUITestDriver;
+export declare function setAsyncScriptTimeout(this: XCUITestDriver, ms: number): void;
 //# sourceMappingURL=timeouts.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"timeouts.d.ts","sourceRoot":"","sources":["../../../lib/commands/timeouts.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,qGAEC;AAED;;GAEG;AACH,yGAEC;AAED;;GAEG;AACH,mGAGC;AAED;;;;;;GAMG;AACH,mFAJW,MAAM,iBAMhB;AAED;;;;;;;GAOG;AACH,iFALW,MAAM,iBAOhB;AAED;;GAEG;AACH,4FAOC;;IAVD;;OAEG;IACH,+DAOC;IALC,gBAAoB;;AAOtB;;GAEG;AACH,+FAGC;;IAND;;OAEG;IACH,+DAGC;IAFC,iBAAqB;;6BAKV,OAAO,WAAW,EAAE,cAAc"}
+{"version":3,"file":"timeouts.d.ts","sourceRoot":"","sources":["../../../lib/commands/timeouts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAE9C;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,cAAc,EACpB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,CAC1C,IAAI,EAAE,cAAc,EACpB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,cAAc,EACpB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,IAAI,CAAC,CAGf;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,cAAc,EACpB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,cAAc,EACpB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,cAAc,EACpB,EAAE,EAAE,MAAM,GACT,IAAI,CAON;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,cAAc,EACpB,EAAE,EAAE,MAAM,GACT,IAAI,CAGN"}

package/build/lib/commands/timeouts.js

@@ -8,19 +8,25 @@ exports.asyncScriptTimeout = asyncScriptTimeout;
 exports.setPageLoadTimeout = setPageLoadTimeout;
 exports.setAsyncScriptTimeout = setAsyncScriptTimeout;
 /**
- * @this {XCUITestDriver}
+ * Sets the page load timeout using W3C protocol.
+ *
+ * @param ms - Timeout in milliseconds
  */
 async function pageLoadTimeoutW3C(ms) {
     await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
 }
 /**
- * @this {XCUITestDriver}
+ * Sets the page load timeout using MJSONWP protocol.
+ *
+ * @param ms - Timeout in milliseconds
  */
 async function pageLoadTimeoutMJSONWP(ms) {
     await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
 }
 /**
- * @this {XCUITestDriver}
+ * Sets the async script timeout using W3C protocol.
+ *
+ * @param ms - Timeout in milliseconds
  */
 async function scriptTimeoutW3C(ms) {
     // XXX: this is synchronous
@@ -29,8 +35,7 @@ async function scriptTimeoutW3C(ms) {
 /**
  * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
  *
- * @param {number} ms - the timeout
- * @this {XCUITestDriver}
+ * @param ms - The timeout in milliseconds
  * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
  */
 async function scriptTimeoutMJSONWP(ms) {
@@ -39,19 +44,19 @@ async function scriptTimeoutMJSONWP(ms) {
 /**
  * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
  *
- * @param {number} ms - the timeout
- *
+ * @param ms - The timeout in milliseconds
  * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
- * @this {XCUITestDriver}
  */
 async function asyncScriptTimeout(ms) {
     await this.scriptTimeoutW3C(ms);
 }
 /**
- * @this {XCUITestDriver}
+ * Sets the page load timeout.
+ *
+ * @param ms - Timeout in milliseconds
  */
 function setPageLoadTimeout(ms) {
-    ms = parseInt(ms, 10);
+    ms = parseInt(String(ms), 10);
     this.pageLoadMs = ms;
     if (this._remote) {
         this.remote.pageLoadMs = ms;
@@ -59,13 +64,12 @@ function setPageLoadTimeout(ms) {
     this.log.debug(`Set page load timeout to ${ms}ms`);
 }
 /**
- * @this {XCUITestDriver}
+ * Sets the async script timeout.
+ *
+ * @param ms - Timeout in milliseconds
  */
 function setAsyncScriptTimeout(ms) {
     this.asyncWaitMs = ms;
     this.log.debug(`Set async script timeout to ${ms}ms`);
 }
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */
 //# sourceMappingURL=timeouts.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"timeouts.js","sourceRoot":"","sources":["../../../lib/commands/timeouts.js"],"names":[],"mappings":";;AAGA,gDAEC;AAKD,wDAEC;AAKD,4CAGC;AASD,oDAEC;AAUD,gDAEC;AAKD,gDAOC;AAKD,sDAGC;AA/DD;;GAEG;AACI,KAAK,UAAU,kBAAkB,CAAC,EAAE;IACzC,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,sBAAsB,CAAC,EAAE;IAC7C,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,gBAAgB,CAAC,EAAE;IACvC,2BAA2B;IAC3B,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CAAC,EAAE;IAC3C,MAAM,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,kBAAkB,CAAC,EAAE;IACzC,MAAM,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,EAAE;IACnC,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACtB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;IACrB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,EAAE,CAAC;IAC9B,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,EAAE;IACtC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACtB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,IAAI,CAAC,CAAC;AACxD,CAAC;AAED;;GAEG"}
+{"version":3,"file":"timeouts.js","sourceRoot":"","sources":["../../../lib/commands/timeouts.ts"],"names":[],"mappings":";;AAOA,gDAKC;AAOD,wDAKC;AAOD,4CAMC;AAQD,oDAKC;AAQD,gDAKC;AAOD,gDAUC;AAOD,sDAMC;AA3FD;;;;GAIG;AACI,KAAK,UAAU,kBAAkB,CAEtC,EAAU;IAEV,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,sBAAsB,CAE1C,EAAU;IAEV,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,gBAAgB,CAEpC,EAAU;IAEV,2BAA2B;IAC3B,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC;AAClE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,oBAAoB,CAExC,EAAU;IAEV,MAAM,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CAEtC,EAAU;IAEV,MAAM,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;AAClC,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAEhC,EAAU;IAEV,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9B,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;IACrB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,EAAE,CAAC;IAC9B,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB,CAEnC,EAAU;IAEV,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACtB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,IAAI,CAAC,CAAC;AACxD,CAAC"}

package/lib/commands/alert.ts

@@ -0,0 +1,98 @@
+import type {XCUITestDriver} from '../driver';
+
+export type AlertAction = 'accept' | 'dismiss' | 'getButtons';
+
+/**
+ * Gets the text of the currently displayed alert.
+ *
+ * @returns The alert text, or null if no alert is displayed
+ */
+export async function getAlertText(this: XCUITestDriver): Promise<string | null> {
+  return await this.proxyCommand<any, string | null>('/alert/text', 'GET');
+}
+
+/**
+ * Sets the text in an alert input field.
+ *
+ * @param value - The text to set
+ */
+export async function setAlertText(
+  this: XCUITestDriver,
+  value: string,
+): Promise<void> {
+  await this.proxyCommand('/alert/text', 'POST', {value});
+}
+
+/**
+ * Accepts the currently displayed alert.
+ *
+ * @param opts - Options including optional button label
+ */
+export async function postAcceptAlert(
+  this: XCUITestDriver,
+  opts: AlertOptions = {},
+): Promise<void> {
+  await this.proxyCommand('/alert/accept', 'POST', toAlertParams(opts));
+}
+
+/**
+ * Dismisses the currently displayed alert.
+ *
+ * @param opts - Options including optional button label
+ */
+export async function postDismissAlert(
+  this: XCUITestDriver,
+  opts: AlertOptions = {},
+): Promise<void> {
+  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
+ */
+export async function getAlertButtons(this: XCUITestDriver): Promise<string[]> {
+  return await this.proxyCommand<any, string[]>('/wda/alert/buttons', 'GET');
+}
+
+/**
+ * Tries to apply the given action to the currently visible alert.
+ *
+ * @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.
+ */
+export async function mobileHandleAlert(
+  this: XCUITestDriver,
+  action: AlertAction,
+  buttonLabel?: string,
+): Promise<string[] | void> {
+  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.`,
+      );
+  }
+}
+
+function toAlertParams(opts: AlertOptions = {}): {name?: string} {
+  const params: {name?: string} = {};
+  if (opts.buttonLabel) {
+    params.name = opts.buttonLabel;
+  }
+  return params;
+}
+
+interface AlertOptions {
+  buttonLabel?: string;
+}

package/lib/commands/appearance.ts

@@ -0,0 +1,70 @@
+import _ from 'lodash';
+import {util} from 'appium/support';
+import type {XCUITestDriver} from '../driver';
+import type {Style} from './types';
+import type {Simulator} from 'appium-ios-simulator';
+
+/**
+ * Set the device's UI appearance style
+ *
+ * @since iOS 12.0
+ * @param style - The appearance style to set
+ * @throws If the current platform does not support UI appearance changes
+ */
+export async function mobileSetAppearance(
+  this: XCUITestDriver,
+  style: 'dark' | 'light',
+): Promise<void> {
+  if (!['light', 'dark'].includes(_.toLower(style))) {
+    throw new Error(`The 'style' value is expected to equal either 'light' or 'dark'`);
+  }
+  if (util.compareVersions(this.opts.platformVersion as string, '<', '12.0')) {
+    throw new Error('Changing appearance is only supported since iOS 12');
+  }
+
+  if (this.isSimulator()) {
+    try {
+      await (this.device as Simulator).setAppearance(style);
+      return;
+    } catch (e: any) {
+      this.log.debug(e.stack);
+    }
+  }
+  try {
+    await this.proxyCommand('/wda/device/appearance', 'POST', {name: style}, false);
+    return;
+  } catch (e: any) {
+    this.log.debug(e.stack);
+  }
+  // Fall back to the ugly Siri workaround if the current SDK is too old
+  await this.mobileSiriCommand(`Turn ${_.toLower(style) === 'dark' ? 'on' : 'off'} dark mode`);
+}
+
+/**
+ * Get the device's UI appearance style.
+ *
+ * @since Xcode SDK 11
+ * @returns The current appearance style
+ */
+export async function mobileGetAppearance(
+  this: XCUITestDriver,
+): Promise<{style: Style}> {
+  if (util.compareVersions(this.opts.platformVersion as string, '<', '12.0')) {
+    return {style: 'unsupported'};
+  }
+
+  let style: Style | undefined;
+  if (this.isSimulator()) {
+    try {
+      style = await (this.device as Simulator).getAppearance() as Style;
+    } catch {}
+  }
+  if (!style) {
+    const deviceInfo = await this.proxyCommand<any, {userInterfaceStyle?: string}>('/wda/device/info', 'GET');
+    style = (deviceInfo?.userInterfaceStyle ?? 'unknown') as Style;
+  }
+  return {
+    style: style as Style,
+  };
+}
+

package/lib/commands/permissions.ts

@@ -0,0 +1,90 @@
+import _ from 'lodash';
+import {PermissionService} from './enum';
+import {assertSimulator as _assertSimulator} from '../utils';
+import type {XCUITestDriver} from '../driver';
+import type {PermissionState} from './types';
+import type {Simulator} from 'appium-ios-simulator';
+
+/**
+ * Resets the given permission for the active application under test.
+ * Works for both Simulator and real devices using Xcode SDK 11.4+
+ *
+ * @param service - One of the available service names. This could also be an integer protected resource identifier; see [this list](https://developer.apple.com/documentation/xctest/xcuiprotectedresource?language=objc)
+ * @throws If permission reset fails on the device.
+ */
+export async function mobileResetPermission(
+  this: XCUITestDriver,
+  service: PermissionService | number,
+): Promise<void> {
+  if (!service) {
+    throw new Error(`The 'service' option is expected to be present`);
+  }
+  let resource: number;
+  if (_.isString(service)) {
+    resource = PermissionService[_.toLower(service) as keyof typeof PermissionService];
+    if (!resource) {
+      throw new Error(
+        `The 'service' value must be one of ` + `${JSON.stringify(_.keys(PermissionService))}`,
+      );
+    }
+  } else if (_.isInteger(service)) {
+    resource = service;
+  } else {
+    throw new Error(
+      `The 'service' value must be either a string or an integer. ` +
+        `'${service}' is passed instead`,
+    );
+  }
+
+  await this.proxyCommand('/wda/resetAppAuth', 'POST', {resource});
+}
+
+/**
+ * Gets application permission state on a simulated device.
+ *
+ * **This method requires [WIX applesimutils](https://github.com/wix/AppleSimulatorUtils) to be installed on the Appium server host.**
+ *
+ * @param bundleId - Bundle identifier of the target application
+ * @param service - Service name
+ * @returns Either 'yes', 'no', 'unset' or 'limited'
+ * @throws If permission getting fails or the device is not a Simulator.
+ * @group Simulator Only
+ */
+export async function mobileGetPermission(
+  this: XCUITestDriver,
+  bundleId: string,
+  service: PermissionService,
+): Promise<PermissionState> {
+  if (!service) {
+    throw new Error(`The 'service' option is expected to be present`);
+  }
+  assertSimulator(this);
+
+  return await (this.device as Simulator).getPermission(
+    bundleId, String(service)
+  ) as PermissionState;
+}
+
+/**
+ * Set application permission state on Simulator.
+ *
+ * @param access - One or more access rules to set.
+ * @param bundleId - Bundle identifier of the target application
+ * @since Xcode SDK 11.4
+ * @throws If permission setting fails or the device is not a Simulator.
+ * @group Simulator Only
+ */
+export async function mobileSetPermissions(
+  this: XCUITestDriver,
+  access: Record<string, PermissionState>,
+  bundleId: string,
+): Promise<void> {
+  if (!_.isPlainObject(access)) {
+    throw new Error(`The 'access' option is expected to be a map`);
+  }
+  assertSimulator(this);
+
+  await (this.device as Simulator).setPermissions(bundleId, access);
+}
+
+const assertSimulator = (driver: XCUITestDriver) => _assertSimulator.call(driver, 'Permission-related operations');

package/lib/commands/{proxy-helper.js → proxy-helper.ts}

@@ -1,12 +1,13 @@
 import {errors, routeToCommandName} from 'appium/driver';
 import B from 'bluebird';
+import type {XCUITestDriver} from '../driver';
 
 const GET = 'GET';
 const POST = 'POST';
 const DELETE = 'DELETE';
-const SUPPORTED_METHODS = Object.freeze(new Set(/** @type {const} */ ([GET, POST, DELETE])));
+const SUPPORTED_METHODS = Object.freeze(new Set([GET, POST, DELETE] as const));
 
-const WDA_ROUTES = /** @type {const} */ ({
+const WDA_ROUTES = {
   '/wda/screen': {
     GET: 'getScreenInfo',
   },
@@ -43,22 +44,30 @@ const WDA_ROUTES = /** @type {const} */ ({
   '/wda/locked': {
     GET: 'isLocked',
   },
-});
+} as const;
+
+export type AllowedHttpMethod = 'GET' | 'POST' | 'DELETE';
 
 /**
  * Proxies a command to WebDriverAgent
- * @template [TReq=any]
- * @template [TRes=unknown]
- * @param {string} url
- * @param {AllowedHttpMethod} method
- * @param {TReq} [body]
- * @param {boolean} isSessionCommand
- * @this {import('../driver').XCUITestDriver}
- * @returns {Promise<TRes>}
+ *
+ * @template TReq - Request body type
+ * @template TRes - Response type
+ * @param url - The endpoint URL
+ * @param method - HTTP method to use
+ * @param body - Optional request body
+ * @param isSessionCommand - Whether this is a session command (default: true)
+ * @returns Promise resolving to the response
  */
-export async function proxyCommand(url, method, body, isSessionCommand = true) {
+export async function proxyCommand<TReq = any, TRes = unknown>(
+  this: XCUITestDriver,
+  url: string,
+  method: AllowedHttpMethod,
+  body?: TReq,
+  isSessionCommand: boolean = true,
+): Promise<TRes> {
   if (this.shutdownUnexpectedly) {
-    return /** @type {TRes} */ (undefined);
+    return undefined as TRes;
   }
 
   if (!url) {
@@ -83,12 +92,12 @@ export async function proxyCommand(url, method, body, isSessionCommand = true) {
   }
 
   if (!timeout) {
-    return /** @type {TRes} */ (await proxy.command(url, method, body));
+    return await proxy.command(url, method, body) as TRes;
   }
 
   this.log.debug(`Setting custom timeout to ${timeout} ms for '${cmdName}' command`);
   try {
-    return /** @type {TRes} */ (await B.resolve(proxy.command(url, method, body)).timeout(timeout));
+    return await B.resolve(proxy.command(url, method, body)).timeout(timeout) as TRes;
   } catch (e) {
     if (!(e instanceof B.Promise.TimeoutError)) {
       throw e;
@@ -102,18 +111,9 @@ export async function proxyCommand(url, method, body, isSessionCommand = true) {
   }
 }
 
-/**
- * @param {string} endpoint
- * @param {AllowedHttpMethod} method
- * @returns {string|undefined}
- */
-function wdaRouteToCommandName(endpoint, method) {
+function wdaRouteToCommandName(endpoint: string, method: AllowedHttpMethod): string | undefined {
   if (endpoint in WDA_ROUTES) {
-    return WDA_ROUTES[endpoint][method];
+    return WDA_ROUTES[endpoint as keyof typeof WDA_ROUTES]?.[method];
   }
 }
 
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- * @typedef {'GET'|'POST'|'DELETE'} AllowedHttpMethod
- */