appium-xcuitest-driver 10.14.2 → 10.14.4

package/lib/commands/appearance.js

@@ -1,71 +0,0 @@
-import _ from 'lodash';
-import {util} from 'appium/support';
-
-/**
- * Set the device's UI appearance style
- *
- * @since iOS 12.0
- * @param {'dark'|'light'} style - The appearance style to set
- * @throws {Error} if the current platform does not support UI appearance changes
- * @this {XCUITestDriver}
- */
-export async function mobileSetAppearance(style) {
-  if (!['light', 'dark'].includes(_.toLower(style))) {
-    throw new Error(`The 'style' value is expected to equal either 'light' or 'dark'`);
-  }
-  if (util.compareVersions(/** @type {string} */ (this.opts.platformVersion), '<', '12.0')) {
-    throw new Error('Changing appearance is only supported since iOS 12');
-  }
-
-  if (this.isSimulator()) {
-    try {
-      return void (await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).setAppearance(style));
-    } catch (e) {
-      this.log.debug(e.stack);
-    }
-  }
-  try {
-    return void (await this.proxyCommand('/wda/device/appearance', 'POST', {name: style}, false));
-  } catch (e) {
-    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 {Promise<{style: Style}>}
- * @this {XCUITestDriver}
- */
-export async function mobileGetAppearance() {
-  if (util.compareVersions(/** @type {string} */ (this.opts.platformVersion), '<', '12.0')) {
-    return {style: 'unsupported'};
-  }
-
-  /** @type {Style|undefined} */
-  let style;
-  if (this.isSimulator()) {
-    try {
-      style = /** @type {Style} */ (
-        await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).getAppearance()
-      );
-    } catch {}
-  }
-  if (!style) {
-    style = /** @type {Style} */ (
-      /** @type {any} */ (await this.proxyCommand('/wda/device/info', 'GET'))
-        ?.userInterfaceStyle ?? 'unknown'
-    );
-  }
-  return {
-    style,
-  };
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- * @typedef {import('./types').Style} Style
- */

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
- */

package/lib/commands/permissions.js

@@ -1,85 +0,0 @@
-import _ from 'lodash';
-import {PermissionService} from './enum';
-import {assertSimulator as _assertSimulator} from '../utils';
-
-const assertSimulator = (driver) => _assertSimulator.call(driver, 'Permission-related operations');
-
-/**
- * Resets the given permission for the active application under test.
- * Works for both Simulator and real devices using Xcode SDK 11.4+
- *
- * @param {PermissionService|number} 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 {Error} If permission reset fails on the device.
- * @this {XCUITestDriver}
- */
-export async function mobileResetPermission(service) {
-  if (!service) {
-    throw new Error(`The 'service' option is expected to be present`);
-  }
-  let resource;
-  if (_.isString(service)) {
-    resource = PermissionService[_.toLower(service)];
-    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 {string} bundleId - Bundle identifier of the target application
- * @param {import('./enum').PermissionService} service - Service name
- * @returns {Promise<import('./types').PermissionState>} Either 'yes', 'no', 'unset' or 'limited'
- * @throws {Error} If permission getting fails or the device is not a Simulator.
- * @this {XCUITestDriver}
- * @group Simulator Only
- */
-export async function mobileGetPermission(bundleId, service) {
-  if (!service) {
-    throw new Error(`The 'service' option is expected to be present`);
-  }
-  assertSimulator(this);
-
-  return /** @type {import('./types').PermissionState} */ (
-    await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).getPermission(
-      bundleId, String(service)
-    )
-  );
-}
-
-/**
- * Set application permission state on Simulator.
- *
- * @param {Record<Partial<import('./types').AccessRule>, import('./types').PermissionState>} access - One or more access rules to set.
- * @param {string} bundleId - Bundle identifier of the target application
- * @since Xcode SDK 11.4
- * @throws {Error} If permission setting fails or the device is not a Simulator.
- * @group Simulator Only
- * @this {XCUITestDriver}
- */
-export async function mobileSetPermissions(access, bundleId) {
-  if (!_.isPlainObject(access)) {
-    throw new Error(`The 'access' option is expected to be a map`);
-  }
-  assertSimulator(this);
-
-  await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).setPermissions(bundleId, access);
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */

package/lib/commands/timeouts.js

@@ -1,68 +0,0 @@
-/**
- * @this {XCUITestDriver}
- */
-export async function pageLoadTimeoutW3C(ms) {
-  await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
-}
-
-/**
- * @this {XCUITestDriver}
- */
-export async function pageLoadTimeoutMJSONWP(ms) {
-  await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
-}
-
-/**
- * @this {XCUITestDriver}
- */
-export async function scriptTimeoutW3C(ms) {
-  // XXX: this is synchronous
-  await this.setAsyncScriptTimeout(this.parseTimeoutArgument(ms));
-}
-
-/**
- * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
- *
- * @param {number} ms - the timeout
- * @this {XCUITestDriver}
- * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
- */
-export async function scriptTimeoutMJSONWP(ms) {
-  await this.asyncScriptTimeout(ms);
-}
-
-/**
- * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
- *
- * @param {number} ms - the timeout
- *
- * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
- * @this {XCUITestDriver}
- */
-export async function asyncScriptTimeout(ms) {
-  await this.scriptTimeoutW3C(ms);
-}
-
-/**
- * @this {XCUITestDriver}
- */
-export function setPageLoadTimeout(ms) {
-  ms = parseInt(ms, 10);
-  this.pageLoadMs = ms;
-  if (this._remote) {
-    this.remote.pageLoadMs = ms;
-  }
-  this.log.debug(`Set page load timeout to ${ms}ms`);
-}
-
-/**
- * @this {XCUITestDriver}
- */
-export function setAsyncScriptTimeout(ms) {
-  this.asyncWaitMs = ms;
-  this.log.debug(`Set async script timeout to ${ms}ms`);
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */