appium-xcuitest-driver 10.14.3 → 10.14.5

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/clipboard.js

@@ -1,35 +0,0 @@
-/**
- * Sets the primary clipboard's content on the device under test.
- *
- * @param {string} content - The content to be set as base64 encoded string.
- * @param {string} [contentType=plaintext] - The type of the content to set.
- *                                            Only `plaintext`, 'image and 'url' are supported.
- * @this {XCUITestDriver}
- */
-export async function setClipboard(content, contentType) {
-  await this.proxyCommand('/wda/setPasteboard', 'POST', {
-    content,
-    contentType,
-  });
-}
-
-/**
- * Gets the content of the primary clipboard on the device under test.
- *
- * @param {string} [contentType=plaintext] - The type of the content to get.
- *                                            Only `plaintext`, 'image and 'url' are supported.
- * @returns {Promise<string>} The actual clipboard content encoded into base64 string.
- * An empty string is returned if the clipboard contains no data.
- * @this {XCUITestDriver}
- */
-export async function getClipboard(contentType) {
-  return /** @type {string} */ (
-    await this.proxyCommand('/wda/getPasteboard', 'POST', {
-      contentType,
-    })
-  );
-}
-
-/**
- * @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/increase-contrast.js

@@ -1,50 +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 INCREASE_CONTRAST_CONFIG = [
-    'enabled',
-    'disabled',
-];
-
-/**
- * Sets the increase contrast configuration for the given simulator.
- *
- * @since Xcode 15 (but lower xcode could have this command)
- * @param {IncreaseContrastAction} increaseContrast valid increase contrast configuration value.
- *                                                  Acceptable value is 'enabled' or 'disabled' with Xcode 16.2.
- * @throws {Error} if the current platform does not support content size appearance changes
- * @this {XCUITestDriver}
- */
-export async function mobileSetIncreaseContrast(increaseContrast) {
-  const simulator = assertSimulator(this);
-
-  if (!INCREASE_CONTRAST_CONFIG.includes(_.lowerCase(increaseContrast))) {
-    throw new errors.InvalidArgumentError(
-      `The 'increaseContrast' value is expected to be one of ${INCREASE_CONTRAST_CONFIG.join(',')}`
-    );
-  }
-
-  await simulator.setIncreaseContrast(increaseContrast);
-}
-
-/**
- * Retrieves the current increase contrast configuration value from the given simulator.
- *
- * @since Xcode 15 (but lower xcode could have this command)
- * @returns {Promise<IncreaseContrastResult>} the contrast configuration value.
- *                                      Possible return value is 'enabled', 'disabled',
- *                                      'unsupported' or 'unknown' with Xcode 16.2.
- * @this {XCUITestDriver}
- */
-export async function mobileGetIncreaseContrast() {
-  return /** @type {IncreaseContrastResult} */ (await assertSimulator(this).getIncreaseContrast());
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- * @typedef {import('./types').IncreaseContrastAction} IncreaseContrastAction
- * @typedef {import('./types').IncreaseContrastResult} IncreaseContrastResult
- */

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/lock.js

@@ -1,46 +0,0 @@
-import B from 'bluebird';
-
-/**
- * Lock the device (and optionally unlock the device after a certain amount of time)
- *
- * @param {number|string} [seconds] - the number of seconds after which to unlock the device. Set to `0` or leave empty to require manual unlock (do not automatically unlock).
- * @defaultValue 0
- * @this {XCUITestDriver}
- */
-export async function lock(seconds) {
-  await this.proxyCommand('/wda/lock', 'POST');
-  if (isNaN(Number(seconds))) {
-    return;
-  }
-
-  const floatSeconds = parseFloat(String(seconds));
-  if (floatSeconds <= 0) {
-    return;
-  }
-
-  await B.delay(floatSeconds * 1000);
-  await this.proxyCommand('/wda/unlock', 'POST');
-}
-
-/**
- * Unlock the device
- *
- * @this {XCUITestDriver}
- */
-export async function unlock() {
-  await this.proxyCommand('/wda/unlock', 'POST');
-}
-
-/**
- * Determine whether the device is locked
- *
- * @this {XCUITestDriver}
- * @returns {Promise<boolean>} `true` if the device is locked, `false` otherwise
- */
-export async function isLocked() {
-  return /** @type {boolean} */ (await this.proxyCommand('/wda/locked', 'GET'));
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */

package/lib/commands/pasteboard.js

@@ -1,43 +0,0 @@
-import _ from 'lodash';
-import { assertSimulator } from '../utils';
-
-/**
- * Sets the Simulator's pasteboard content to the given value.
- *
- * Does not work for real devices.
- * @param {string} content - The content to set
- * @param {string} encoding - The content's encoding
- * @group Simulator Only
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
- */
-export async function mobileSetPasteboard(content, encoding = 'utf8') {
-  assertSimulator.call(this, 'Setting pasteboard content');
-  if (!_.isString(content)) {
-    // can be empty string
-    throw new Error('Pasteboard content is mandatory to set');
-  }
-  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.setPasteboard(
-    content, /** @type {BufferEncoding} */ (encoding)
-  );
-}
-
-/**
- * Gets the Simulator's pasteboard content.
- *
- * Does not work for real devices.
- * @param {string} encoding - Expected encoding of returned string
- * @group Simulator Only
- * @this {XCUITestDriver}
- * @returns {Promise<string>} The pasteboard content string
- */
-export async function mobileGetPasteboard(encoding = 'utf8') {
-  assertSimulator.call(this, 'Getting pasteboard content');
-  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.getPasteboard(
-    /** @type {BufferEncoding} */ (encoding)
-  );
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */