appium-xcuitest-driver 10.14.3 → 10.14.4

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

@@ -1 +1 @@
-{"version":3,"file":"iohid.d.ts","sourceRoot":"","sources":["../../../lib/commands/iohid.js"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;GAeG;AACH,wFALW,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAEZ,MAAM,GAAC,MAAM,oBAiBvB;6BAhCyC,aAAa"}
+{"version":3,"file":"iohid.d.ts","sourceRoot":"","sources":["../../../lib/commands/iohid.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,YAAY,EAAC,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAE9C;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,MAAM,GAC/B,OAAO,CAAC,IAAI,CAAC,CAcf"}

package/build/lib/commands/iohid.js

@@ -14,10 +14,9 @@ const hid_event_1 = require("./hid-event");
  * - `kHIDUsage_Csmr_Power` = `0x30` (Power)
  * - `kHIDUsage_Csmr_Snapshot` = `0x65` (Power + Home)
  *
- * @param {HIDPageEvent} page - The event page identifier
- * @param {HIDUsageEvent} usage - The event usage identifier (usages are defined per-page)
- * @param {number|string} durationSeconds - The event duration in float seconds (XCTest uses `0.005` for a single press event)
- * @this {import('../driver').XCUITestDriver}
+ * @param page - The event page identifier
+ * @param usage - The event usage identifier (usages are defined per-page)
+ * @param durationSeconds - The event duration in float seconds (XCTest uses `0.005` for a single press event)
  */
 async function mobilePerformIoHidEvent(page, usage, durationSeconds) {
     if (!isHIDPageEvent(page)) {
@@ -30,12 +29,10 @@ async function mobilePerformIoHidEvent(page, usage, durationSeconds) {
     if (Number.isNaN(duration)) {
         throw new driver_1.errors.InvalidArgumentError(`'durationSeconds' argument must be a valid number`);
     }
-    return await this.proxyCommand('/wda/performIoHidEvent', 'POST', { page, usage, duration });
+    await this.proxyCommand('/wda/performIoHidEvent', 'POST', { page, usage, duration });
 }
 /**
  * Type guard for {@linkcode HIDUsageEvent}
- * @param {any} value
- * @returns {value is HIDUsageEvent}
  */
 function isHIDUsageEvent(value) {
     if (typeof value === 'string') {
@@ -48,9 +45,7 @@ function isHIDUsageEvent(value) {
 }
 /**
  * Type guard for {@linkcode HIDPageEvent}
- * @param {any} value
- * @returns {value is HIDPageEvent}
- **/
+ */
 function isHIDPageEvent(value) {
     if (typeof value === 'string') {
         value = parseInt(value, 10);

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

@@ -1 +1 @@
-{"version":3,"file":"iohid.js","sourceRoot":"","sources":["../../../lib/commands/iohid.js"],"names":[],"mappings":";;AAmBA,0DAcC;AAjCD,0CAAqC;AACrC,2CAAwD;AAExD;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,uBAAuB,CAAC,IAAI,EAAE,KAAK,EAAE,eAAe;IACxE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,yDAAyD,CAC1D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,kDAAkD,CAAC,CAAC;IAC5F,CAAC;IACD,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC;IACrD,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,mDAAmD,CAAC,CAAC;IAC7F,CAAC;IACD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,wBAAwB,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;AAC5F,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,KAAK;IAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC9B,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,KAAK,IAAI,yBAAa,CAAC;AAChC,CAAC;AAED;;;;IAII;AACJ,SAAS,cAAc,CAAC,KAAK;IAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC9B,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,KAAK,IAAI,wBAAY,CAAC;AAC/B,CAAC"}
+{"version":3,"file":"iohid.js","sourceRoot":"","sources":["../../../lib/commands/iohid.ts"],"names":[],"mappings":";;AAmBA,0DAmBC;AAtCD,0CAAqC;AACrC,2CAAwD;AAGxD;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,uBAAuB,CAE3C,IAAkB,EAClB,KAAa,EACb,eAAgC;IAEhC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,yDAAyD,CAC1D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,kDAAkD,CAAC,CAAC;IAC5F,CAAC;IACD,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC;IACrD,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CAAC,mDAAmD,CAAC,CAAC;IAC7F,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,wBAAwB,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;AACrF,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CAAC,KAAU;IACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC9B,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,KAAK,IAAI,yBAAa,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CAAC,KAAU;IAChC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC9B,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,KAAK,IAAI,wBAAY,CAAC;AAC/B,CAAC"}

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

@@ -1,32 +1,35 @@
+import type { XCUITestDriver } from '../driver';
+import type { KeyboardKey } from './types';
 /**
- * @this {XCUITestDriver}
+ * Hides the keyboard.
+ *
  * @deprecated
  */
-export function hideKeyboard(this: import("../driver").XCUITestDriver, strategy: any, ...possibleKeys: any[]): Promise<boolean>;
+export declare function hideKeyboard(this: XCUITestDriver, strategy?: string, ...possibleKeys: string[]): Promise<boolean>;
 /**
- * @this {XCUITestDriver}
- * @param {string[]} keys
+ * Hides the keyboard using the specified key names.
+ *
+ * @param keys - Array of key names to use for dismissing the keyboard
  */
-export function mobileHideKeyboard(this: import("../driver").XCUITestDriver, keys?: string[]): Promise<void>;
+export declare function mobileHideKeyboard(this: XCUITestDriver, keys?: string[]): Promise<void>;
 /**
- * @this {XCUITestDriver}
+ * Checks whether the keyboard is currently shown.
+ *
+ * @returns `true` if the keyboard is shown, `false` otherwise
  */
-export function isKeyboardShown(this: import("../driver").XCUITestDriver): Promise<boolean>;
+export declare function isKeyboardShown(this: XCUITestDriver): Promise<boolean>;
 /**
  * Send keys to the given element or to the application under test.
  * This API is not supported on tvOS
  *
  * @since Xcode 15/iOS 17
- * @this {import('../driver').XCUITestDriver}
- * @param {(Key|string)[]} keys Array of keys to type.
+ * @param keys - Array of keys to type.
  * Each item could either be a string, that represents a key itself (see
  * https://developer.apple.com/documentation/xctest/xcuielement/1500604-typekey?language=objc
  * and https://developer.apple.com/documentation/xctest/xcuikeyboardkey?language=objc)
  * or a dictionary, if the key should also be entered with modifiers.
- * @param {string?} [elementId=null] uuid of the element to send keys to.
+ * @param elementId - UUID of the element to send keys to.
  * If the element is not provided then the keys will be sent to the current application.
  */
-export function mobileKeys(this: import("../driver").XCUITestDriver, keys: (Key | string)[], elementId?: string | null): Promise<unknown>;
-export type XCUITestDriver = import("../driver").XCUITestDriver;
-export type Key = import("./types").KeyboardKey;
+export declare function mobileKeys(this: XCUITestDriver, keys: (KeyboardKey | string)[], elementId?: string | null): Promise<void>;
 //# sourceMappingURL=keyboard.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../../lib/commands/keyboard.js"],"names":[],"mappings":"AAEA;;;GAGG;AACH,gIAKC;AAED;;;GAGG;AACH,oFAFW,MAAM,EAAE,iBAOlB;AAED;;GAEG;AACH,4FAOC;AAED;;;;;;;;;;;;;GAaG;AACH,2EARW,CAAC,GAAG,GAAC,MAAM,CAAC,EAAE,cAKd,MAAM,OAAC,oBAMjB;6BAGY,OAAO,WAAW,EAAE,cAAc;kBAIlC,OAAO,SAAS,EAAE,WAAW"}
+{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../../lib/commands/keyboard.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAEzC;;;;GAIG;AACH,wBAAsB,YAAY,CAChC,IAAI,EAAE,cAAc,EACpB,QAAQ,CAAC,EAAE,MAAM,EACjB,GAAG,YAAY,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,OAAO,CAAC,CAKlB;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,cAAc,EACpB,IAAI,GAAE,MAAM,EAAO,GAClB,OAAO,CAAC,IAAI,CAAC,CAIf;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAO5E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,CAAC,WAAW,GAAG,MAAM,CAAC,EAAE,EAC9B,SAAS,GAAE,MAAM,GAAG,IAAW,GAC9B,OAAO,CAAC,IAAI,CAAC,CAGf"}

package/build/lib/commands/keyboard.js

@@ -9,7 +9,8 @@ exports.isKeyboardShown = isKeyboardShown;
 exports.mobileKeys = mobileKeys;
 const lodash_1 = __importDefault(require("lodash"));
 /**
- * @this {XCUITestDriver}
+ * Hides the keyboard.
+ *
  * @deprecated
  */
 async function hideKeyboard(strategy, ...possibleKeys) {
@@ -19,17 +20,19 @@ async function hideKeyboard(strategy, ...possibleKeys) {
     return true;
 }
 /**
- * @this {XCUITestDriver}
- * @param {string[]} keys
+ * Hides the keyboard using the specified key names.
+ *
+ * @param keys - Array of key names to use for dismissing the keyboard
  */
 async function mobileHideKeyboard(keys = []) {
-    if (!keys.includes('done')) {
-        keys.push('done');
-    }
-    await this.proxyCommand('/wda/keyboard/dismiss', 'POST', { keyNames: keys });
+    await this.proxyCommand('/wda/keyboard/dismiss', 'POST', {
+        keyNames: keys.includes('done') ? keys : [...keys, 'done'],
+    });
 }
 /**
- * @this {XCUITestDriver}
+ * Checks whether the keyboard is currently shown.
+ *
+ * @returns `true` if the keyboard is shown, `false` otherwise
  */
 async function isKeyboardShown() {
     try {
@@ -45,23 +48,16 @@ async function isKeyboardShown() {
  * This API is not supported on tvOS
  *
  * @since Xcode 15/iOS 17
- * @this {import('../driver').XCUITestDriver}
- * @param {(Key|string)[]} keys Array of keys to type.
+ * @param keys - Array of keys to type.
  * Each item could either be a string, that represents a key itself (see
  * https://developer.apple.com/documentation/xctest/xcuielement/1500604-typekey?language=objc
  * and https://developer.apple.com/documentation/xctest/xcuikeyboardkey?language=objc)
  * or a dictionary, if the key should also be entered with modifiers.
- * @param {string?} [elementId=null] uuid of the element to send keys to.
+ * @param elementId - UUID of the element to send keys to.
  * If the element is not provided then the keys will be sent to the current application.
  */
 async function mobileKeys(keys, elementId = null) {
     const url = `/wda/element/${elementId || 0}/keyboardInput`;
-    return await this.proxyCommand(url, 'POST', { keys });
+    await this.proxyCommand(url, 'POST', { keys });
 }
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */
-/**
- * @typedef {import('./types').KeyboardKey} Key
- */
 //# sourceMappingURL=keyboard.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"keyboard.js","sourceRoot":"","sources":["../../../lib/commands/keyboard.js"],"names":[],"mappings":";;;;;AAMA,oCAKC;AAMD,gDAKC;AAKD,0CAOC;AAgBD,gCAGC;AArDD,oDAAuB;AAEvB;;;GAGG;AACI,KAAK,UAAU,YAAY,CAAC,QAAQ,EAAE,GAAG,YAAY;IAC1D,mCAAmC;IACnC,MAAM,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACzE,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACxC,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,kBAAkB,CAAC,IAAI,GAAG,EAAE;IAChD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC;IACD,MAAM,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,MAAM,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAC;AAC7E,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,eAAe;IACnC,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,2BAA2B,CAAC,YAAY,EAAE,yBAAyB,EAAE,KAAK,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;IACrD,MAAM,GAAG,GAAG,gBAAgB,SAAS,IAAI,CAAC,gBAAgB,CAAC;IAC3D,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACxD,CAAC;AAED;;GAEG;AAEH;;GAEG"}
+{"version":3,"file":"keyboard.js","sourceRoot":"","sources":["../../../lib/commands/keyboard.ts"],"names":[],"mappings":";;;;;AASA,oCASC;AAOD,gDAOC;AAOD,0CAOC;AAeD,gCAOC;AApED,oDAAuB;AAIvB;;;;GAIG;AACI,KAAK,UAAU,YAAY,CAEhC,QAAiB,EACjB,GAAG,YAAsB;IAEzB,mCAAmC;IACnC,MAAM,QAAQ,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACzE,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACxC,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,kBAAkB,CAEtC,OAAiB,EAAE;IAEnB,MAAM,IAAI,CAAC,YAAY,CAAC,uBAAuB,EAAE,MAAM,EAAE;QACvD,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;KAC3D,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe;IACnC,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,2BAA2B,CAAC,YAAY,EAAE,yBAAyB,EAAE,KAAK,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,UAAU,CAE9B,IAA8B,EAC9B,YAA2B,IAAI;IAE/B,MAAM,GAAG,GAAG,gBAAgB,SAAS,IAAI,CAAC,gBAAgB,CAAC;IAC3D,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACjD,CAAC"}

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

@@ -1,15 +1,17 @@
+import type { XCUITestDriver } from '../driver';
+import type { PushPayload, NotificationType } from './types';
 /**
  * Simulates push notification delivery to a simulated device.
  *
  * **Only "remote" push notifications are supported.** VoIP, Complication, File Provider, and other types are unsupported.
  *
  * Supported in Xcode SDK 11.4+.
- * @param {string} bundleId - The bundle identifier of the target application
- * @param {import('./types').PushPayload} payload - Valid push payload.
+ *
+ * @param bundleId - The bundle identifier of the target application
+ * @param payload - Valid push payload.
  * @group Simulator Only
- * @this {XCUITestDriver}
  */
-export function mobilePushNotification(this: import("../driver").XCUITestDriver, bundleId: string, payload: import("./types").PushPayload): Promise<void>;
+export declare function mobilePushNotification(this: XCUITestDriver, bundleId: string, payload: PushPayload): Promise<void>;
 /**
  * Blocks until the expected notification is delivered.
  *
@@ -17,12 +19,10 @@ export function mobilePushNotification(this: import("../driver").XCUITestDriver,
  * [`XCTNSNotificationExpectation`](https://developer.apple.com/documentation/xctest/xctnsnotificationexpectation?language=objc) and
  * [`XCTDarwinNotificationExpectation`](https://developer.apple.com/documentation/xctest/xctdarwinnotificationexpectation?language=objc) entities.
  *
- * @param {string} name - The name of the notification to expect
- * @param {import('./types').NotificationType} type - Which notification type to expect.
- * @param {number} timeoutSeconds - For how long to wait until the notification is delivered (in float seconds).
+ * @param name - The name of the notification to expect
+ * @param type - Which notification type to expect.
+ * @param timeoutSeconds - For how long to wait until the notification is delivered (in float seconds).
  * @throws A [`TimeoutError`](https://www.selenium.dev/selenium/docs/api/javascript/module/selenium-webdriver/lib/error_exports_TimeoutError.html) if the expected notification has not been delivered within the given timeout.
- * @this {XCUITestDriver}
  */
-export function mobileExpectNotification(this: import("../driver").XCUITestDriver, name: string, type?: import("./types").NotificationType, timeoutSeconds?: number): Promise<unknown>;
-export type XCUITestDriver = import("../driver").XCUITestDriver;
+export declare function mobileExpectNotification(this: XCUITestDriver, name: string, type?: NotificationType, timeoutSeconds?: number): Promise<void>;
 //# sourceMappingURL=notifications.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../../../lib/commands/notifications.js"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AACH,2FALW,MAAM,WACN,OAAO,SAAS,EAAE,WAAW,iBA8BvC;AAED;;;;;;;;;;;;GAYG;AACH,yFANW,MAAM,SACN,OAAO,SAAS,EAAE,gBAAgB,mBAClC,MAAM,oBAUhB;6BAGY,OAAO,WAAW,EAAE,cAAc"}
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../../../lib/commands/notifications.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAC,WAAW,EAAE,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAG3D;;;;;;;;;;GAUG;AACH,wBAAsB,sBAAsB,CAC1C,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,WAAW,GACnB,OAAO,CAAC,IAAI,CAAC,CA0Bf;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,wBAAwB,CAC5C,IAAI,EAAE,cAAc,EACpB,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,gBAA0B,EAChC,cAAc,GAAE,MAAW,GAC1B,OAAO,CAAC,IAAI,CAAC,CAMf"}

package/build/lib/commands/notifications.js

@@ -13,10 +13,10 @@ const lodash_1 = __importDefault(require("lodash"));
  * **Only "remote" push notifications are supported.** VoIP, Complication, File Provider, and other types are unsupported.
  *
  * Supported in Xcode SDK 11.4+.
- * @param {string} bundleId - The bundle identifier of the target application
- * @param {import('./types').PushPayload} payload - Valid push payload.
+ *
+ * @param bundleId - The bundle identifier of the target application
+ * @param payload - Valid push payload.
  * @group Simulator Only
- * @this {XCUITestDriver}
  */
 async function mobilePushNotification(bundleId, payload) {
     if (!this.isSimulator()) {
@@ -33,7 +33,7 @@ async function mobilePushNotification(bundleId, payload) {
         throw new driver_1.errors.InvalidArgumentError(`The 'payload.aps' value must be a valid dictionary. ` +
             `Got ${JSON.stringify(payload.aps)} instead`);
     }
-    return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).pushNotification({
+    await this.device.pushNotification({
         ...payload,
         'Simulator Target Bundle': bundleId,
     });
@@ -45,20 +45,16 @@ async function mobilePushNotification(bundleId, payload) {
  * [`XCTNSNotificationExpectation`](https://developer.apple.com/documentation/xctest/xctnsnotificationexpectation?language=objc) and
  * [`XCTDarwinNotificationExpectation`](https://developer.apple.com/documentation/xctest/xctdarwinnotificationexpectation?language=objc) entities.
  *
- * @param {string} name - The name of the notification to expect
- * @param {import('./types').NotificationType} type - Which notification type to expect.
- * @param {number} timeoutSeconds - For how long to wait until the notification is delivered (in float seconds).
+ * @param name - The name of the notification to expect
+ * @param type - Which notification type to expect.
+ * @param timeoutSeconds - For how long to wait until the notification is delivered (in float seconds).
  * @throws A [`TimeoutError`](https://www.selenium.dev/selenium/docs/api/javascript/module/selenium-webdriver/lib/error_exports_TimeoutError.html) if the expected notification has not been delivered within the given timeout.
- * @this {XCUITestDriver}
  */
 async function mobileExpectNotification(name, type = 'plain', timeoutSeconds = 60) {
-    return await this.proxyCommand('/wda/expectNotification', 'POST', {
+    await this.proxyCommand('/wda/expectNotification', 'POST', {
         name,
         type,
         timeout: timeoutSeconds,
     });
 }
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */
 //# sourceMappingURL=notifications.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../../../lib/commands/notifications.js"],"names":[],"mappings":";;;;;AAcA,wDA0BC;AAeD,4DAMC;AA7DD,0CAAqC;AACrC,oDAAuB;AAEvB;;;;;;;;;;GAUG;AACI,KAAK,UAAU,sBAAsB,CAAC,QAAQ,EAAE,OAAO;IAC5D,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,2DAA2D;YACzD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAC3C,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,sDAAsD;YACpD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAC/C,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,uDAAuD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,gBAAgB,CAAC;QAClG,GAAG,OAAO;QACV,yBAAyB,EAAE,QAAQ;KACpC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,wBAAwB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,EAAE,cAAc,GAAG,EAAE;IACtF,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,MAAM,EAAE;QAChE,IAAI;QACJ,IAAI;QACJ,OAAO,EAAE,cAAc;KACxB,CAAC,CAAC;AACL,CAAC;AAED;;GAEG"}
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../../../lib/commands/notifications.ts"],"names":[],"mappings":";;;;;AAiBA,wDA8BC;AAcD,4DAWC;AAxED,0CAAqC;AACrC,oDAAuB;AAKvB;;;;;;;;;;GAUG;AACI,KAAK,UAAU,sBAAsB,CAE1C,QAAgB,EAChB,OAAoB;IAEpB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,2DAA2D;YACzD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAC3C,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,eAAM,CAAC,oBAAoB,CACnC,sDAAsD;YACpD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAC/C,CAAC;IACJ,CAAC;IACD,MAAO,IAAI,CAAC,MAAoB,CAAC,gBAAgB,CAAC;QAChD,GAAG,OAAO;QACV,yBAAyB,EAAE,QAAQ;KACpC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,wBAAwB,CAE5C,IAAY,EACZ,OAAyB,OAAO,EAChC,iBAAyB,EAAE;IAE3B,MAAM,IAAI,CAAC,YAAY,CAAC,yBAAyB,EAAE,MAAM,EAAE;QACzD,IAAI;QACJ,IAAI;QACJ,OAAO,EAAE,cAAc;KACxB,CAAC,CAAC;AACL,CAAC"}

package/lib/commands/biometric.ts

@@ -0,0 +1,52 @@
+import {assertSimulator as _assertSimulator} from '../utils';
+import type {XCUITestDriver} from '../driver';
+import type {BiometricFeature} from './types';
+import type {Simulator} from 'appium-ios-simulator';
+
+const assertSimulator = (driver: XCUITestDriver): Simulator => _assertSimulator.call(driver, 'Biometric enrollment');
+
+/**
+ * Enrolls biometric authentication on a simulated device.
+ *
+ * @param isEnabled - Whether to enable/disable biometric enrollment.
+ * @throws If enrollment fails or the device is not a Simulator.
+ * @group Simulator Only
+ */
+export async function mobileEnrollBiometric(
+  this: XCUITestDriver,
+  isEnabled: boolean = true,
+): Promise<void> {
+  await assertSimulator(this).enrollBiometric(isEnabled);
+}
+
+/**
+ * Emulates biometric match or non-match event on a simulated device.
+ *
+ * The biometric feature is expected to be already enrolled via {@linkcode mobileEnrollBiometric|mobile: enrollBiometric} before executing this.
+ *
+ * @param type - The biometric feature name.
+ * @param match - If `true`, simulate biometric match. If `false`, simulate biometric non-match.
+ * @throws If matching fails or the device is not a Simulator.
+ * @group Simulator Only
+ */
+export async function mobileSendBiometricMatch(
+  this: XCUITestDriver,
+  type: BiometricFeature = 'touchId',
+  match: boolean = true,
+): Promise<void> {
+  await assertSimulator(this).sendBiometricMatch(match, type);
+}
+
+/**
+ * Checks whether the biometric feature is currently enrolled on a simulated device.
+ *
+ * @returns `true` if biometric is enrolled.
+ * @throws If the detection fails or the device is not a Simulator.
+ * @group Simulator Only
+ */
+export async function mobileIsBiometricEnrolled(
+  this: XCUITestDriver,
+): Promise<boolean> {
+  return await assertSimulator(this).isBiometricEnrolled();
+}
+

package/lib/commands/content-size.ts

@@ -0,0 +1,67 @@
+import _ from 'lodash';
+import {assertSimulator as _assertSimulator} from '../utils';
+import { errors } from 'appium/driver';
+import type {XCUITestDriver} from '../driver';
+import type {ContentSizeAction, ContentSizeResult} from './types';
+import type {Simulator} from 'appium-ios-simulator';
+
+const assertSimulator = (driver: XCUITestDriver): Simulator => _assertSimulator.call(driver, 'Content size ui command');
+
+const CONTENT_SIZE = [
+    'extra-small',
+    'small',
+    'medium',
+    'large',
+    'extra-large',
+    'extra-extra-large',
+    'extra-extra-extra-large',
+    'accessibility-medium',
+    'accessibility-large',
+    'accessibility-extra-large',
+    'accessibility-extra-extra-large',
+    'accessibility-extra-extra-extra-large',
+    'increment',
+    'decrement'
+] as const;
+
+/**
+ * Sets content size for the given simulator.
+ *
+ * @since Xcode 15 (but lower xcode could have this command)
+ * @param size - The content size action to set. Acceptable value is
+ *               extra-small, small, medium, large, extra-large, extra-extra-large,
+ *               extra-extra-extra-large, accessibility-medium, accessibility-large,
+ *               accessibility-extra-large, accessibility-extra-extra-large,
+ *               accessibility-extra-extra-extra-large with Xcode 16.2.
+ * @throws If the current platform does not support content size appearance changes
+ */
+export async function mobileSetContentSize(
+  this: XCUITestDriver,
+  size: ContentSizeAction,
+): Promise<void> {
+  if (!(CONTENT_SIZE as readonly string[]).includes(_.lowerCase(size))) {
+    throw new errors.InvalidArgumentError(
+      `The 'size' value is expected to be one of ${CONTENT_SIZE.join(',')}`
+    );
+  }
+
+  await assertSimulator(this).setContentSize(size);
+}
+
+/**
+ * Retrieves the current content size value from the given simulator.
+ *
+ * @since Xcode 15 (but lower xcode could have this command)
+ * @returns The content size value. Possible return value is
+ *          extra-small, small, medium, large, extra-large, extra-extra-large,
+ *          extra-extra-extra-large, accessibility-medium, accessibility-large,
+ *          accessibility-extra-large, accessibility-extra-extra-large,
+ *          accessibility-extra-extra-extra-large,
+ *          unknown or unsupported with Xcode 16.2.
+ */
+export async function mobileGetContentSize(
+  this: XCUITestDriver,
+): Promise<ContentSizeResult> {
+  return await assertSimulator(this).getContentSize() as ContentSizeResult;
+}
+

package/lib/commands/geolocation.ts

@@ -0,0 +1,55 @@
+import type {XCUITestDriver} from '../driver';
+
+export interface GeolocationInfo {
+  /** Measurement of distance north or south of the Equator, or `null` if {@linkcode XCUITestDriver.mobileSetSimulatedLocation} has not been called or {@linkcode mobileResetSimulatedLocation} has been called. */
+  latitude: number | null;
+  /** Measurement of distance east or west of the prime meridian, or `null` if {@linkcode XCUITestDriver.mobileSetSimulatedLocation} has not been called or {@linkcode mobileResetSimulatedLocation} has been called. */
+  longitude: number | null;
+}
+
+/**
+ * Retrieves the simulated geolocation value.
+ * Only works since Xcode 14.3/iOS 16.4
+ *
+ * @returns The current simulated geolocation
+ * @throws If the device under test does not support geolocation simulation.
+ * @since 4.18
+ */
+export async function mobileGetSimulatedLocation(
+  this: XCUITestDriver,
+): Promise<GeolocationInfo> {
+  return await this.proxyCommand<any, GeolocationInfo>('/wda/simulatedLocation', 'GET');
+}
+
+/**
+ * Sets simulated geolocation value.
+ * Only works since Xcode 14.3/iOS 16.4
+ *
+ * @param latitude - Latitude value
+ * @param longitude - Longitude value
+ * @throws If the device under test does not support geolocation simulation.
+ * @since 4.18
+ */
+export async function mobileSetSimulatedLocation(
+  this: XCUITestDriver,
+  latitude: number,
+  longitude: number,
+): Promise<void> {
+  await this.proxyCommand('/wda/simulatedLocation', 'POST', {latitude, longitude});
+}
+
+/**
+ * Resets simulated geolocation value.
+ * Only works since Xcode 14.3/iOS 16.4.
+ * ! Do not forget to reset the simulated geolocation value after your automated test is finished.
+ * ! If the value is not reset explicitly then the simulated one will remain until the next device restart.
+ *
+ * @throws If the device under test does not support geolocation simulation.
+ * @since 4.18
+ */
+export async function mobileResetSimulatedLocation(
+  this: XCUITestDriver,
+): Promise<void> {
+  await this.proxyCommand('/wda/simulatedLocation', 'DELETE');
+}
+

package/lib/commands/{iohid.js → iohid.ts}

@@ -1,5 +1,6 @@
 import {errors} from 'appium/driver';
 import {HIDUsageEvent, HIDPageEvent} from './hid-event';
+import type {XCUITestDriver} from '../driver';
 
 /**
  * Emulates triggering of the given low-level IO HID device event.
@@ -12,12 +13,16 @@ import {HIDUsageEvent, HIDPageEvent} from './hid-event';
  * - `kHIDUsage_Csmr_Power` = `0x30` (Power)
  * - `kHIDUsage_Csmr_Snapshot` = `0x65` (Power + Home)
  *
- * @param {HIDPageEvent} page - The event page identifier
- * @param {HIDUsageEvent} usage - The event usage identifier (usages are defined per-page)
- * @param {number|string} durationSeconds - The event duration in float seconds (XCTest uses `0.005` for a single press event)
- * @this {import('../driver').XCUITestDriver}
+ * @param page - The event page identifier
+ * @param usage - The event usage identifier (usages are defined per-page)
+ * @param durationSeconds - The event duration in float seconds (XCTest uses `0.005` for a single press event)
  */
-export async function mobilePerformIoHidEvent(page, usage, durationSeconds) {
+export async function mobilePerformIoHidEvent(
+  this: XCUITestDriver,
+  page: HIDPageEvent,
+  usage: number,
+  durationSeconds: number | string,
+): Promise<void> {
   if (!isHIDPageEvent(page)) {
     throw new errors.InvalidArgumentError(
       `'page' argument must be a valid HIDPageEvent identifier`,
@@ -30,15 +35,13 @@ export async function mobilePerformIoHidEvent(page, usage, durationSeconds) {
   if (Number.isNaN(duration)) {
     throw new errors.InvalidArgumentError(`'durationSeconds' argument must be a valid number`);
   }
-  return await this.proxyCommand('/wda/performIoHidEvent', 'POST', {page, usage, duration});
+  await this.proxyCommand('/wda/performIoHidEvent', 'POST', {page, usage, duration});
 }
 
 /**
  * Type guard for {@linkcode HIDUsageEvent}
- * @param {any} value
- * @returns {value is HIDUsageEvent}
  */
-function isHIDUsageEvent(value) {
+function isHIDUsageEvent(value: any): value is keyof typeof HIDUsageEvent {
   if (typeof value === 'string') {
     value = parseInt(value, 10);
   }
@@ -50,10 +53,8 @@ function isHIDUsageEvent(value) {
 
 /**
  * Type guard for {@linkcode HIDPageEvent}
- * @param {any} value
- * @returns {value is HIDPageEvent}
- **/
-function isHIDPageEvent(value) {
+ */
+function isHIDPageEvent(value: any): value is HIDPageEvent {
   if (typeof value === 'string') {
     value = parseInt(value, 10);
   }
@@ -62,3 +63,4 @@ function isHIDPageEvent(value) {
   }
   return value in HIDPageEvent;
 }
+

package/lib/commands/keyboard.ts

@@ -0,0 +1,70 @@
+import _ from 'lodash';
+import type {XCUITestDriver} from '../driver';
+import type {KeyboardKey} from './types';
+
+/**
+ * Hides the keyboard.
+ *
+ * @deprecated
+ */
+export async function hideKeyboard(
+  this: XCUITestDriver,
+  strategy?: string,
+  ...possibleKeys: string[]
+): Promise<boolean> {
+  // last parameter is the session id
+  const keyNames = _.compact(possibleKeys.slice(0, -1)).map((x) => `${x}`);
+  await this.mobileHideKeyboard(keyNames);
+  return true;
+}
+
+/**
+ * Hides the keyboard using the specified key names.
+ *
+ * @param keys - Array of key names to use for dismissing the keyboard
+ */
+export async function mobileHideKeyboard(
+  this: XCUITestDriver,
+  keys: string[] = [],
+): Promise<void> {
+  await this.proxyCommand('/wda/keyboard/dismiss', 'POST', {
+    keyNames: keys.includes('done') ? keys : [...keys, 'done'],
+  });
+}
+
+/**
+ * Checks whether the keyboard is currently shown.
+ *
+ * @returns `true` if the keyboard is shown, `false` otherwise
+ */
+export async function isKeyboardShown(this: XCUITestDriver): Promise<boolean> {
+  try {
+    await this.findNativeElementOrElements('class name', 'XCUIElementTypeKeyboard', false);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Send keys to the given element or to the application under test.
+ * This API is not supported on tvOS
+ *
+ * @since Xcode 15/iOS 17
+ * @param keys - Array of keys to type.
+ * Each item could either be a string, that represents a key itself (see
+ * https://developer.apple.com/documentation/xctest/xcuielement/1500604-typekey?language=objc
+ * and https://developer.apple.com/documentation/xctest/xcuikeyboardkey?language=objc)
+ * or a dictionary, if the key should also be entered with modifiers.
+ * @param elementId - UUID of the element to send keys to.
+ * If the element is not provided then the keys will be sent to the current application.
+ */
+export async function mobileKeys(
+  this: XCUITestDriver,
+  keys: (KeyboardKey | string)[],
+  elementId: string | null = null,
+): Promise<void> {
+  const url = `/wda/element/${elementId || 0}/keyboardInput`;
+  await this.proxyCommand(url, 'POST', { keys });
+}
+