@limrun/appium-xcuitest-driver 10.11.0-lim.4 → 10.14.6-lim.1

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

@@ -1,17 +0,0 @@
-import {assertSimulator as _assertSimulator} from '../utils';
-
-const assertSimulator = (driver) => _assertSimulator.call(driver, 'Keychain modification');
-
-/**
- * Clears keychains on a simulated device.
- *
- * @throws {Error} If current device is not a Simulator or there was an error
- * while clearing keychains.
- * @this {import('../driver').XCUITestDriver}
- * @group Simulator Only
- */
-export async function mobileClearKeychains() {
-  assertSimulator(this);
-
-  await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).clearKeychains();
-}

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 {BufferEncoding} 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
- */

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

@@ -1,71 +0,0 @@
-import { errors } from 'appium/driver';
-
-/**
- * List of subcommands for `simctl` we provide as mobile simctl command.
- * They accept 'device' target.
- */
-const SUBCOMMANDS_HAS_DEVICE = [
-  'boot',
-  'get_app_container',
-  'getenv',
-  'icloud_sync',
-  'install',
-  'install_app_data',
-  'io',
-  'keychain',
-  'launch',
-  'location',
-  'logverbose',
-  'openurl',
-  'pbcopy',
-  'pbpaste',
-  'privacy',
-  'push',
-  'shutdown',
-  'spawn',
-  'status_bar',
-  'terminate',
-  'ui',
-  'uninstall'
-];
-
-/**
- * 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.
- */
-export async function mobileSimctl(command, args = [], timeout = undefined) {
-  if (!this.isSimulator()) {
-    throw new errors.UnsupportedOperationError(`Only simulator is supported.`);
-  }
-
-  if (!this.opts.udid) {
-    throw new errors.InvalidArgumentError(`Unknown device or simulator UDID: '${this.opts.udid}'`);
-  }
-
-  if (!SUBCOMMANDS_HAS_DEVICE.includes(command)) {
-    throw new errors.InvalidArgumentError(`The given command '${command}' is not supported. ` +
-      `Available subcommands are ${SUBCOMMANDS_HAS_DEVICE.join(',')}`);
-  }
-
-  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.exec(
-    command,
-    {args: [this.opts.udid, ...args], timeout}
-  );
-}
-
-/**
- * @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
- */

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