appium-xcuitest-driver 10.14.3 → 10.14.4

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

@@ -1,5 +1,8 @@
 import {errors} from 'appium/driver';
 import _ from 'lodash';
+import type {XCUITestDriver} from '../driver';
+import type {PushPayload, NotificationType} from './types';
+import type {Simulator} from 'appium-ios-simulator';
 
 /**
  * Simulates push notification delivery to a simulated device.
@@ -7,12 +10,16 @@ import _ from '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}
  */
-export async function mobilePushNotification(bundleId, payload) {
+export async function mobilePushNotification(
+  this: XCUITestDriver,
+  bundleId: string,
+  payload: PushPayload,
+): Promise<void> {
   if (!this.isSimulator()) {
     throw new Error('This extension only works on Simulator');
   }
@@ -34,7 +41,7 @@ export async function mobilePushNotification(bundleId, payload) {
         `Got ${JSON.stringify(payload.aps)} instead`,
     );
   }
-  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).pushNotification({
+  await (this.device as Simulator).pushNotification({
     ...payload,
     'Simulator Target Bundle': bundleId,
   });
@@ -47,20 +54,21 @@ export 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}
  */
-export async function mobileExpectNotification(name, type = 'plain', timeoutSeconds = 60) {
-  return await this.proxyCommand('/wda/expectNotification', 'POST', {
+export async function mobileExpectNotification(
+  this: XCUITestDriver,
+  name: string,
+  type: NotificationType = 'plain',
+  timeoutSeconds: number = 60,
+): Promise<void> {
+  await this.proxyCommand('/wda/expectNotification', 'POST', {
     name,
     type,
     timeout: timeoutSeconds,
   });
 }
 
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "10.14.3",
+  "version": "10.14.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "10.14.3",
+      "version": "10.14.4",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/strongbox": "^1.0.0-rc.1",

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "10.14.3",
+  "version": "10.14.4",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {

package/lib/commands/biometric.js

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

package/lib/commands/content-size.js

@@ -1,68 +0,0 @@
-import _ from 'lodash';
-import {assertSimulator as _assertSimulator} from '../utils';
-import { errors } from 'appium/driver';
-
-const assertSimulator = (driver) => _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'
-];
-
-/**
- * Sets content size for the given simulator.
- *
- * @since Xcode 15 (but lower xcode could have this command)
- * @param {ContentSizeAction} 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 {Error} if the current platform does not support content size appearance changes
- * @this {XCUITestDriver}
- */
-export async function mobileSetContentSize(size) {
-  const simulator = assertSimulator(this);
-
-  if (!CONTENT_SIZE.includes(_.lowerCase(size))) {
-    throw new errors.InvalidArgumentError(
-      `The 'size' value is expected to be one of ${CONTENT_SIZE.join(',')}`
-    );
-  }
-
-  await simulator.setContentSize(size);
-}
-
-/**
- * Retrieves the current content size value from the given simulator.
- *
- * @since Xcode 15 (but lower xcode could have this command)
- * @returns {Promise<ContentSizeResult>} 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.
- * @this {XCUITestDriver}
- */
-export async function mobileGetContentSize() {
-  return /** @type {ContentSizeResult} */ (await assertSimulator(this).getContentSize());
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- * @typedef {import('./types').ContentSizeAction} ContentSizeAction
- * @typedef {import('./types').ContentSizeResult} ContentSizeResult
- */

package/lib/commands/geolocation.js

@@ -1,56 +0,0 @@
-/**
- * @typedef {Object} GeolocationInfo
- * @property {number|null} latitude Measurement of distance north or south of the Equator, or
- * `null` if {@linkcode XCUITestDriver.mobileSetSimulatedLocation} has not been called or {@linkcode
- * resetSimulatedLocation} has been called.
- * @property {number|null} longitude Measurement of distance east or west of the prime meridian, or
- * `null` if {@linkcode XCUITestDriver.mobileSetSimulatedLocation} has not been called or {@linkcode
- * resetSimulatedLocation} has been called.
- */
-
-/**
- * Retrieves the simulated geolocation value.
- * Only works since Xcode 14.3/iOS 16.4
- *
- * @returns {Promise<GeolocationInfo>}
- * @throws {Error} If the device under test does not support gelolocation simulation.
- * @since 4.18
- * @this {XCUITestDriver}
- */
-export async function mobileGetSimulatedLocation() {
-  return await this.proxyCommand('/wda/simulatedLocation', 'GET');
-}
-
-/**
- * Sets simulated geolocation value.
- * Only works since Xcode 14.3/iOS 16.4
- *
- * @param {number} latitude
- * @param {number} longitude
- * @returns {Promise<void>}
- * @throws {Error} If the device under test does not support gelolocation simulation.
- * @since 4.18
- * @this {XCUITestDriver}
- */
-export async function mobileSetSimulatedLocation(latitude, longitude) {
-  return 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.
- *
- * @returns {Promise<void>}
- * @throws {Error} If the device under test does not support gelolocation simulation.
- * @since 4.18
- * @this {XCUITestDriver}
- */
-export async function mobileResetSimulatedLocation() {
-  return await this.proxyCommand('/wda/simulatedLocation', 'DELETE');
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */

package/lib/commands/keyboard.js

@@ -1,62 +0,0 @@
-import _ from 'lodash';
-
-/**
- * @this {XCUITestDriver}
- * @deprecated
- */
-export async function hideKeyboard(strategy, ...possibleKeys) {
-  // last parameter is the session id
-  const keyNames = _.compact(possibleKeys.slice(0, -1)).map((x) => `${x}`);
-  await this.mobileHideKeyboard(keyNames);
-  return true;
-}
-
-/**
- * @this {XCUITestDriver}
- * @param {string[]} keys
- */
-export async function mobileHideKeyboard(keys = []) {
-  if (!keys.includes('done')) {
-    keys.push('done');
-  }
-  await this.proxyCommand('/wda/keyboard/dismiss', 'POST', {keyNames: keys});
-}
-
-/**
- * @this {XCUITestDriver}
- */
-export async function isKeyboardShown() {
-  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
- * @this {import('../driver').XCUITestDriver}
- * @param {(Key|string)[]} 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.
- * If the element is not provided then the keys will be sent to the current application.
- */
-export async function mobileKeys(keys, elementId = null) {
-  const url = `/wda/element/${elementId || 0}/keyboardInput`;
-  return await this.proxyCommand(url, 'POST', { keys });
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */
-
-/**
- * @typedef {import('./types').KeyboardKey} Key
- */