appium-xcuitest-driver 10.10.0 → 10.11.0

package/lib/commands/biometric.js

@@ -1,7 +1,6 @@
-import _ from 'lodash';
 import {assertSimulator as _assertSimulator} from '../utils';
 
-const assertSimulator = _.partial(_assertSimulator, 'Biometric enrollment');
+const assertSimulator = (driver) => _assertSimulator.call(driver, 'Biometric enrollment');
 
 /**
  * Enrolls biometric authentication on a simulated device.

package/lib/commands/condition.js

@@ -1,6 +1,6 @@
 import {INSTRUMENT_CHANNEL, services} from 'appium-ios-device';
 import _ from 'lodash';
-import { isIos18OrNewer } from '../utils.js';
+import { isIos18OrNewer } from '../utils';
 
 /**
  * Get all available ConditionInducer configuration information, which can be used with

package/lib/commands/content-size.js

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import {assertSimulator as _assertSimulator} from '../utils';
 import { errors } from 'appium/driver';
 
-const assertSimulator = _.partial(_assertSimulator, 'Content size ui command');
+const assertSimulator = (driver) => _assertSimulator.call(driver, 'Content size ui command');
 
 const CONTENT_SIZE = [
     'extra-small',

package/lib/commands/find.js

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import CssConverter from '../css-converter';
+import {CssConverter} from '../css-converter';
 import {errors} from 'appium/driver';
 import {util} from 'appium/support';
 

package/lib/commands/increase-contrast.js

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import {assertSimulator as _assertSimulator} from '../utils';
 import { errors } from 'appium/driver';
 
-const assertSimulator = _.partial(_assertSimulator, 'Content size ui command');
+const assertSimulator = (driver) => _assertSimulator.call(driver, 'Content size ui command');
 
 const INCREASE_CONTRAST_CONFIG = [
     'enabled',

package/lib/commands/keychains.js

@@ -1,7 +1,6 @@
-import _ from 'lodash';
 import {assertSimulator as _assertSimulator} from '../utils';
 
-const assertSimulator = _.partial(_assertSimulator, 'Keychain modification');
+const assertSimulator = (driver) => _assertSimulator.call(driver, 'Keychain modification');
 
 /**
  * Clears keychains on a simulated device.

package/lib/commands/localization.js

@@ -1,7 +1,6 @@
-import _ from 'lodash';
 import {assertSimulator as _assertSimulator} from '../utils';
 
-const assertSimulator = _.partial(_assertSimulator, 'Localization configuration');
+const assertSimulator = (driver) => _assertSimulator.call(driver, 'Localization configuration');
 
 /**
  * Change localization settings on the currently booted simulator

package/lib/commands/pasteboard.js

@@ -1,3 +1,6 @@
+import _ from 'lodash';
+import { assertSimulator } from '../utils';
+
 /**
  * Sets the Simulator's pasteboard content to the given value.
  *
@@ -9,10 +12,8 @@
  * @this {XCUITestDriver}
  */
 export async function mobileSetPasteboard(content, encoding = 'utf8') {
-  if (!this.isSimulator()) {
-    throw new Error('Setting pasteboard content is not supported on real devices');
-  }
-  if (!content) {
+  assertSimulator.call(this, 'Setting pasteboard content');
+  if (!_.isString(content)) {
     // can be empty string
     throw new Error('Pasteboard content is mandatory to set');
   }
@@ -31,10 +32,10 @@ export async function mobileSetPasteboard(content, encoding = 'utf8') {
  * @returns {Promise<string>} The pasteboard content string
  */
 export async function mobileGetPasteboard(encoding = 'utf8') {
-  if (!this.isSimulator()) {
-    throw new Error('Getting pasteboard content is not supported on real devices');
-  }
-  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.getPasteboard(encoding);
+  assertSimulator.call(this, 'Getting pasteboard content');
+  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.getPasteboard(
+    /** @type {BufferEncoding} */ (encoding)
+  );
 }
 
 /**

package/lib/commands/permissions.js

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import {PermissionService} from './enum';
 import {assertSimulator as _assertSimulator} from '../utils';
 
-const assertSimulator = _.partial(_assertSimulator, 'Permission-related operations');
+const assertSimulator = (driver) => _assertSimulator.call(driver, 'Permission-related operations');
 
 /**
  * Resets the given permission for the active application under test.

package/lib/{css-converter.js → css-converter.ts}

@@ -1,9 +1,38 @@
 import {createParser} from 'css-selector-parser';
 import _ from 'lodash';
 import {errors} from 'appium/driver';
-import log from './logger.js';
-
-const CssConverter = {};
+import {log} from './logger';
+import type {
+  AstAttribute,
+  AstPseudoClass,
+  AstRule,
+  AstSelector,
+  AstClassName,
+  AstTagName,
+  AstId,
+} from 'css-selector-parser';
+
+export const CssConverter = {
+  toIosClassChainSelector(cssSelector: string): string {
+    let cssObj: AstSelector;
+    try {
+      cssObj = parseCssSelector(cssSelector);
+    } catch (e: any) {
+      log.debug(e.stack);
+      throw new errors.InvalidSelectorError(
+        `Invalid CSS selector '${cssSelector}'. Reason: '${e.message}'`,
+      );
+    }
+    try {
+      return parseCssObject(cssObj);
+    } catch (e: any) {
+      log.debug(e.stack);
+      throw new errors.InvalidSelectorError(
+        `Unsupported CSS selector '${cssSelector}'. Reason: '${e.message}'`,
+      );
+    }
+  },
+};
 
 const parseCssSelector = createParser({
   syntax: {
@@ -26,18 +55,15 @@ const parseCssSelector = createParser({
   substitutes: true,
 });
 
-const BOOLEAN_ATTRS = ['visible', 'accessible', 'accessibility-container', 'enabled'];
+const BOOLEAN_ATTRS = ['visible', 'accessible', 'accessibility-container', 'enabled'] as const;
 
-const NUMERIC_ATTRS = ['index'];
+const NUMERIC_ATTRS = ['index'] as const;
 
-const STR_ATTRS = ['label', 'name', 'value', 'type'];
+const STR_ATTRS = ['label', 'name', 'value', 'type'] as const;
 
 const ALL_ATTRS = [...BOOLEAN_ATTRS, ...NUMERIC_ATTRS, ...STR_ATTRS];
 
-/**
- * @type {[string, string[]][]}
- */
-const ATTRIBUTE_ALIASES = [
+const ATTRIBUTE_ALIASES: [string, string[]][] = [
   ['name', ['id']],
   ['index', ['nth-child']],
 ];
@@ -45,10 +71,10 @@ const ATTRIBUTE_ALIASES = [
 /**
  * Convert hyphen separated word to camel case
  *
- * @param {string?} str
- * @returns {string} The hyphen separated word translated to camel case
+ * @param str
+ * @returns The hyphen separated word translated to camel case
  */
-function toCamelCase(str) {
+function toCamelCase(str: string | null | undefined): string {
   if (!str) {
     return '';
   }
@@ -62,12 +88,11 @@ function toCamelCase(str) {
 /**
  * Get the boolean from a CSS object. If empty, return true. If not true/false/empty, throw exception
  *
- * @param {import('css-selector-parser').AstAttribute|import('css-selector-parser').AstPseudoClass} cssAttr
- * @returns {string} Either 'true' or 'false'. If value is empty, return 'true'
+ * @param cssAttr
+ * @returns Either 'true' or 'false'. If value is empty, return 'true'
  */
-function requireBoolean(cssAttr) {
-  // @ts-ignore We only support strings
-  const attrValue = cssAttr.value?.value;
+function requireBoolean(cssAttr: AstAttribute | AstPseudoClass): string {
+  const attrValue = (cssAttr as any).value?.value;
   const val = _.toLower(attrValue) || 'true'; // an omitted boolean attribute means 'true' (e.g.: input[checked] means checked is true)
   switch (val) {
     case '0':
@@ -89,14 +114,14 @@ function requireBoolean(cssAttr) {
  * Converts to lowercase and if an attribute name is an alias for something else, return
  * what it is an alias for
  *
- * @param {import('css-selector-parser').AstAttribute|import('css-selector-parser').AstPseudoClass} cssEntity
- * @returns {string} The canonical attribute name
+ * @param cssEntity
+ * @returns The canonical attribute name
  */
-function requireEntityName(cssEntity) {
+function requireEntityName(cssEntity: AstAttribute | AstPseudoClass): string {
   const entityName = cssEntity.name.toLowerCase();
 
   // Check if it's supported and if it is, return it
-  if (ALL_ATTRS.includes(entityName)) {
+  if (ALL_ATTRS.includes(entityName as any)) {
     return entityName.toLowerCase();
   }
 
@@ -115,12 +140,11 @@ function requireEntityName(cssEntity) {
 /**
  * Convert a CSS attribute into a UiSelector method call
  *
- * @param {import('css-selector-parser').AstAttribute} cssAttr CSS attribute object
- * @returns {string|{index: string|undefined}} CSS attribute parsed as UiSelector
+ * @param cssAttr CSS attribute object
+ * @returns CSS attribute parsed as UiSelector
  */
-function parseAttr(cssAttr) {
-  // @ts-ignore We only care for strings
-  const attrValue = cssAttr.value?.value;
+function parseAttr(cssAttr: AstAttribute): string | {index: string | undefined} {
+  const attrValue = (cssAttr as any).value?.value;
   if (!_.isString(attrValue) && !_.isEmpty(attrValue)) {
     throw new TypeError(
       `'${cssAttr.name}=${attrValue}' is an invalid attribute. ` +
@@ -130,7 +154,7 @@ function parseAttr(cssAttr) {
   const attrName = toCamelCase(requireEntityName(cssAttr));
 
   // Validate that it's a supported attribute
-  if (!STR_ATTRS.includes(attrName) && !BOOLEAN_ATTRS.includes(attrName)) {
+  if (!STR_ATTRS.includes(attrName as any) && !BOOLEAN_ATTRS.includes(attrName as any)) {
     throw new Error(
       `'${attrName}' is not supported. Supported attributes are ` +
         `'${[...STR_ATTRS, ...BOOLEAN_ATTRS].join(', ')}'`,
@@ -141,11 +165,11 @@ function parseAttr(cssAttr) {
   if (attrName === 'index') {
     return {index: attrValue};
   }
-  if (BOOLEAN_ATTRS.includes(attrName)) {
+  if (BOOLEAN_ATTRS.includes(attrName as any)) {
     return `${attrName} == ${requireBoolean(cssAttr)}`;
   }
 
-  let value = attrValue || '';
+  const value = attrValue || '';
   if (value === '') {
     return `[${attrName} LIKE ${value}]`;
   }
@@ -173,12 +197,11 @@ function parseAttr(cssAttr) {
 /**
  * Convert a CSS pseudo class to a UiSelector
  *
- * @param {import('css-selector-parser').AstPseudoClass} cssPseudo
- * @returns {string|{index: string|undefined}|undefined} Pseudo selector parsed as UiSelector
+ * @param cssPseudo
+ * @returns Pseudo selector parsed as UiSelector
  */
-function parsePseudo(cssPseudo) {
-  // @ts-ignore We only care for strings
-  const argValue = cssPseudo.argument?.value;
+function parsePseudo(cssPseudo: AstPseudoClass): string | {index: string | undefined} | undefined {
+  const argValue = (cssPseudo as any).argument?.value;
   if (!_.isString(argValue) && !_.isEmpty(argValue)) {
     throw new TypeError(
       `'${cssPseudo.name}=${argValue}'. ` +
@@ -188,7 +211,7 @@ function parsePseudo(cssPseudo) {
 
   const pseudoName = requireEntityName(cssPseudo);
 
-  if (BOOLEAN_ATTRS.includes(pseudoName)) {
+  if (BOOLEAN_ATTRS.includes(pseudoName as any)) {
     return `${toCamelCase(pseudoName)} == ${requireBoolean(cssPseudo)}`;
   }
 
@@ -199,9 +222,9 @@ function parsePseudo(cssPseudo) {
 
 /**
  * Convert a CSS rule to a UiSelector
- * @param {import('css-selector-parser').AstRule} cssRule CSS rule definition
+ * @param cssRule CSS rule definition
  */
-function parseCssRule(cssRule) {
+function parseCssRule(cssRule: AstRule): string {
   if (cssRule.combinator && ![' ', '>'].includes(cssRule.combinator)) {
     throw new Error(
       `'${cssRule.combinator}' is not a supported combinator. ` +
@@ -210,9 +233,7 @@ function parseCssRule(cssRule) {
   }
 
   let iosClassChainSelector = '';
-  const astClassNames = /** @type {import('css-selector-parser').AstClassName[]} */ (
-    cssRule.items.filter(({type}) => type === 'ClassName')
-  );
+  const astClassNames = cssRule.items.filter(({type}) => type === 'ClassName') as AstClassName[];
   const classNames = astClassNames.map(({name}) => name);
   if (classNames.length) {
     throw new errors.InvalidSelectorError(`'${[cssRule || '', ...classNames].join('.')}'
@@ -220,9 +241,7 @@ function parseCssRule(cssRule) {
       dots separating them`);
   }
 
-  const astTag = /** @type {import('css-selector-parser').AstTagName|undefined} */ (
-    cssRule.items.find(({type}) => type === 'TagName')
-  );
+  const astTag = cssRule.items.find(({type}) => type === 'TagName') as AstTagName | undefined;
   let tagName = astTag?.name ?? '';
   if (tagName && tagName !== '*' && !_.startsWith(_.toLower(tagName), 'xcuielementtype')) {
     const capitalizedTagName = tagName.charAt(0).toUpperCase() + tagName.slice(1);
@@ -230,36 +249,31 @@ function parseCssRule(cssRule) {
   }
   iosClassChainSelector += tagName || '*';
 
-  /** @type {(string|{index: string|undefined}|undefined)[]} */
-  const attrs = [];
+  const attrs: (string | {index: string | undefined} | undefined)[] = [];
 
-  const astIds = /** @type {import('css-selector-parser').AstId[]} */ (
-    cssRule.items.filter(({type}) => type === 'Id')
-  );
+  const astIds = cssRule.items.filter(({type}) => type === 'Id') as AstId[];
   const ids = astIds.map(({name}) => name);
   if (ids.length) {
     attrs.push(`name == "${ids[0]}"`);
   }
-  const attributes = /** @type {import('css-selector-parser').AstAttribute[]} */ (
-    cssRule.items.filter(({type}) => type === 'Attribute')
-  );
+  const attributes = cssRule.items.filter(({type}) => type === 'Attribute') as AstAttribute[];
   for (const attr of attributes) {
     attrs.push(parseAttr(attr));
   }
-  const pseudoClasses = /** @type {import('css-selector-parser').AstPseudoClass[]} */ (
-    cssRule.items.filter(({type}) => type === 'PseudoClass')
-  );
+  const pseudoClasses = cssRule.items.filter(({type}) => type === 'PseudoClass') as AstPseudoClass[];
   for (const pseudo of pseudoClasses) {
     attrs.push(parsePseudo(pseudo));
   }
-  const nonIndexAttrs = attrs.filter((attr) => _.isString(attr));
+  const nonIndexAttrs = attrs.filter((attr) => _.isString(attr)) as string[];
   if (!_.isEmpty(nonIndexAttrs)) {
     iosClassChainSelector += `[\`${nonIndexAttrs.join(' AND ')}\`]`;
   }
 
-  const indexAttr = attrs.find((attr) => _.isObject(attr) && attr.index);
+  const indexAttr = attrs.find(
+    (attr) => _.isObject(attr) && (attr as {index: string}).index
+  ) as {index: string} | undefined;
   if (indexAttr) {
-    iosClassChainSelector += `[${/** @type { {index: string} } */ (indexAttr).index}]`;
+    iosClassChainSelector += `[${indexAttr.index}]`;
   }
 
   if (cssRule.nestedRule) {
@@ -272,40 +286,13 @@ function parseCssRule(cssRule) {
 /**
  * Convert CSS object to iOS Class Chain selector
  *
- * @param {import('css-selector-parser').AstSelector} css CSS object
- * @returns {string} The CSS object parsed as a UiSelector
+ * @param css CSS object
+ * @returns The CSS object parsed as a UiSelector
  */
-function parseCssObject(css) {
+function parseCssObject(css: AstSelector): string {
   if (!_.isEmpty(css.rules)) {
     return parseCssRule(css.rules[0]);
   }
 
   throw new Error('No rules could be parsed out of the current selector');
 }
-
-/**
- * Convert a CSS selector to a iOS Class Chain selector
- * @param {string} cssSelector CSS Selector
- * @returns {string} The CSS selector converted to an iOS Class Chain
- */
-CssConverter.toIosClassChainSelector = function toIosClassChainSelector(cssSelector) {
-  let cssObj;
-  try {
-    cssObj = parseCssSelector(cssSelector);
-  } catch (e) {
-    log.debug(e.stack);
-    throw new errors.InvalidSelectorError(
-      `Invalid CSS selector '${cssSelector}'. Reason: '${e.message}'`,
-    );
-  }
-  try {
-    return parseCssObject(cssObj);
-  } catch (e) {
-    log.debug(e.stack);
-    throw new errors.InvalidSelectorError(
-      `Unsupported CSS selector '${cssSelector}'. Reason: '${e.message}'`,
-    );
-  }
-};
-
-export default CssConverter;

package/lib/device/real-device-management.ts

@@ -4,7 +4,7 @@ import {fs, tempDir, mkdirp, zip, util, timing} from 'appium/support';
 import path from 'path';
 import {services, utilities, INSTRUMENT_CHANNEL} from 'appium-ios-device';
 import {buildSafariPreferences, SAFARI_BUNDLE_ID} from '../app-utils';
-import defaultLogger from '../logger';
+import {log as defaultLogger} from '../logger';
 import { Devicectl } from 'node-devicectl';
 import type { AppiumLogger } from '@appium/types';
 import type { XCUITestDriver } from '../driver';

package/lib/device/simulator-management.ts

@@ -6,6 +6,7 @@ import {util, timing} from 'appium/support';
 import {UDID_AUTO, normalizePlatformName} from '../utils';
 import {buildSafariPreferences} from '../app-utils';
 import type { XCUITestDriver } from '../driver';
+import type { DeviceInfo } from 'node-simctl';
 
 const APPIUM_SIM_PREFIX = 'appiumTest';
 
@@ -19,11 +20,15 @@ export async function createSim(this: XCUITestDriver): Promise<Simulator> {
   const platform = normalizePlatformName(this.opts.platformName);
   const simctl = new Simctl({devicesSetPath});
   if (!deviceName) {
-    let deviceNames: string | string[] = 'none';
+    let deviceNames: string[] = [];
     try {
-      deviceNames = (await simctl
-        .getDevices(platformVersion, platform))
-        .map(({deviceName}) => deviceName);
+      const devices = platformVersion
+        ? await simctl.getDevices(platformVersion, platform)
+        : await simctl.getDevices(null, platform);
+      const nameMapper = (device: DeviceInfo) => device.name;
+      deviceNames = Array.isArray(devices)
+        ? devices.map(nameMapper)
+        : _.flatMap(_.values(devices)).map(nameMapper);
     } catch {}
     throw new Error(
       `'deviceName' must be provided in order to create a new Simulator for ${platform} platform. ` +

package/lib/driver.ts

@@ -601,7 +601,7 @@ export class XCUITestDriver
     this.opts.useNewWDA = util.hasValue(this.opts.useNewWDA) ? this.opts.useNewWDA : false;
 
     if (caps.commandTimeouts) {
-      caps.commandTimeouts = normalizeCommandTimeouts(caps.commandTimeouts);
+      caps.commandTimeouts = normalizeCommandTimeouts(caps.commandTimeouts as string | Record<string, number>);
     }
 
     if (_.isString(caps.webDriverAgentUrl)) {
@@ -1547,9 +1547,11 @@ export class XCUITestDriver
       };
     }
 
-    const appBundleVersion = this.isRealDevice()
-      ? (await (this.device as RealDevice).fetchAppInfo(bundleId))?.CFBundleVersion
-      : BUNDLE_VERSION_PATTERN.exec(await (this.device as Simulator).simctl.appInfo(bundleId))?.[1];
+    const appBundleVersion = (
+      this.isRealDevice()
+        ? (await (this.device as RealDevice).fetchAppInfo(bundleId))
+        : (await (this.device as Simulator).simctl.appInfo(bundleId))
+    )?.CFBundleVersion;
     this.log.debug(`CFBundleVersion from installed app info: ${appBundleVersion}`);
     if (!appBundleVersion) {
       return {

package/lib/logger.ts

@@ -0,0 +1,3 @@
+import {logger} from 'appium/support';
+
+export const log = logger.getLogger('XCUITest');