appium-xcuitest-driver 10.3.0 → 10.4.0

package/lib/commands/app-strings.js

@@ -1,31 +1,29 @@
 import {parseLocalizableStrings} from '../app-utils';
 
-export default {
-  /**
-   * Return the language-specific strings for an app
-   *
-   * @param {string} language - The language abbreviation to fetch app strings mapping for.
-   * If no language is provided then strings for the 'en language would be returned
-   * @param {string|null} [stringFile=null] - Relative path to the corresponding .strings
-   * file starting from the corresponding .lproj folder, e.g., `base/main.strings`. If omitted,
-   * then Appium will make its best guess where the file is.
-   *
-   * @returns {Promise<import('@appium/types').StringRecord<string>>} A record of localized keys to localized text
-   *
-   * @this {XCUITestDriver}
-   */
-  async getStrings(language, stringFile = null) {
-    this.log.debug(`Gettings strings for language '${language}' and string file '${stringFile}'`);
-    return await parseLocalizableStrings.bind(this)(
-      {
-        ...this.opts,
-        language,
-        stringFile,
-        strictMode: true,
-      },
-    );
-  },
-};
+/**
+ * Return the language-specific strings for an app
+ *
+ * @param {string} language - The language abbreviation to fetch app strings mapping for.
+ * If no language is provided then strings for the 'en language would be returned
+ * @param {string|null} [stringFile=null] - Relative path to the corresponding .strings
+ * file starting from the corresponding .lproj folder, e.g., `base/main.strings`. If omitted,
+ * then Appium will make its best guess where the file is.
+ *
+ * @returns {Promise<import('@appium/types').StringRecord<string>>} A record of localized keys to localized text
+ *
+ * @this {XCUITestDriver}
+ */
+export async function getStrings(language, stringFile = null) {
+  this.log.debug(`Gettings strings for language '${language}' and string file '${stringFile}'`);
+  return await parseLocalizableStrings.bind(this)(
+    {
+      ...this.opts,
+      language,
+      stringFile,
+      strictMode: true,
+    },
+  );
+}
 
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver

package/lib/commands/appearance.js

@@ -1,71 +1,69 @@
 import _ from 'lodash';
 import {util} from 'appium/support';
 
-export default {
-  /**
-   * 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}
-   */
-  async 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');
-    }
+/**
+ * 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('../driver').Simulator} */ (this.device).setAppearance(style));
-      } catch (e) {
-        this.log.debug(e.stack);
-      }
-    }
+  if (this.isSimulator()) {
     try {
-      return void (await this.proxyCommand('/wda/device/appearance', 'POST', {name: style}, false));
+      return void (await /** @type {import('../driver').Simulator} */ (this.device).setAppearance(style));
     } 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`);
-  },
+  }
+  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}
-   */
-  async mobileGetAppearance() {
-    if (util.compareVersions(/** @type {string} */ (this.opts.platformVersion), '<', '12.0')) {
-      return {style: 'unsupported'};
-    }
+/**
+ * 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('../driver').Simulator} */ (this.device).getAppearance()
-        );
-      } catch {}
-    }
-    if (!style) {
+  /** @type {Style|undefined} */
+  let style;
+  if (this.isSimulator()) {
+    try {
       style = /** @type {Style} */ (
-        /** @type {any} */ (await this.proxyCommand('/wda/device/info', 'GET'))
-          ?.userInterfaceStyle ?? 'unknown'
+        await /** @type {import('../driver').Simulator} */ (this.device).getAppearance()
       );
-    }
-    return {
-      style,
-    };
-  },
-};
+    } catch {}
+  }
+  if (!style) {
+    style = /** @type {Style} */ (
+      /** @type {any} */ (await this.proxyCommand('/wda/device/info', 'GET'))
+        ?.userInterfaceStyle ?? 'unknown'
+    );
+  }
+  return {
+    style,
+  };
+}
 
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver

package/lib/commands/audit.js

@@ -7,26 +7,24 @@
  * @property {string} element The description of the element this issue was found for.
  */
 
-export default {
-  /**
-   * Performs accessibility audit of the current application according to the given type or multiple types.
-   *
-   * @since Xcode 15/iOS 17
-   * @param {string[]?} auditTypes - One or more type names to perform the audit for.
-   * The full list of available names could be found at
-   * https://developer.apple.com/documentation/xctest/xcuiaccessibilityaudittype?language=objc
-   * If no type if provided explicitly then XCUIAccessibilityAuditTypeAll is assumed.
-   *
-   * @returns {Promise<AccessibilityAuditItem[]>} List of found issues or an empty list
-   *
-   * @this {XCUITestDriver}
-   */
-  async mobilePerformAccessibilityAudit(auditTypes) {
-    return /** @type {AccessibilityAuditItem[]} */ (
-      await this.proxyCommand('/wda/performAccessibilityAudit', 'POST', {auditTypes})
-    );
-  },
-};
+/**
+ * Performs accessibility audit of the current application according to the given type or multiple types.
+ *
+ * @since Xcode 15/iOS 17
+ * @param {string[]?} auditTypes - One or more type names to perform the audit for.
+ * The full list of available names could be found at
+ * https://developer.apple.com/documentation/xctest/xcuiaccessibilityaudittype?language=objc
+ * If no type if provided explicitly then XCUIAccessibilityAuditTypeAll is assumed.
+ *
+ * @returns {Promise<AccessibilityAuditItem[]>} List of found issues or an empty list
+ *
+ * @this {XCUITestDriver}
+ */
+export async function mobilePerformAccessibilityAudit(auditTypes) {
+  return /** @type {AccessibilityAuditItem[]} */ (
+    await this.proxyCommand('/wda/performAccessibilityAudit', 'POST', {auditTypes})
+  );
+}
 
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver

package/lib/commands/battery.js

@@ -1,46 +1,44 @@
 import log from '../logger.js';
 import { isIos18OrNewer } from '../utils.js';
 
-export default {
-  /**
-   * Reads the battery information from the device under test.
-   *
-   * This endpoint only returns reliable result on real devices.
-   *
-   * @returns {Promise<import('./types').BatteryInfo & {advanced: Record<string, any>}>}
-   * @this {import('../driver').XCUITestDriver}
-   */
-  async mobileGetBatteryInfo() {
-    let batteryInfoFromShimService;
-    if (isIos18OrNewer(this.opts) && this.isRealDevice()) {
-      let remoteXPCConnection;
-      try {
-        const {Services} = await import('appium-ios-remotexpc');
-        let { diagnosticsService, remoteXPC } = await Services.startDiagnosticsService(this.device.udid);
-        remoteXPCConnection = remoteXPC;
-        batteryInfoFromShimService = await diagnosticsService.ioregistry({
-          ioClass: 'IOPMPowerSource',
-          returnRawJson: true,
-        });
-      } catch (err) {
-        log.error(`Failed to get battery info from DiagnosticsService: ${err.message}`);
-      } finally {
-        if (remoteXPCConnection) {
-          log.info(`Closing remoteXPC connection for device ${this.device.udid}`);
-          await remoteXPCConnection.close();
-        }
+/**
+ * Reads the battery information from the device under test.
+ *
+ * This endpoint only returns reliable result on real devices.
+ *
+ * @returns {Promise<import('./types').BatteryInfo & {advanced: Record<string, any>}>}
+ * @this {import('../driver').XCUITestDriver}
+ */
+export async function mobileGetBatteryInfo() {
+  let batteryInfoFromShimService;
+  if (isIos18OrNewer(this.opts) && this.isRealDevice()) {
+    let remoteXPCConnection;
+    try {
+      const {Services} = await import('appium-ios-remotexpc');
+      let { diagnosticsService, remoteXPC } = await Services.startDiagnosticsService(this.device.udid);
+      remoteXPCConnection = remoteXPC;
+      batteryInfoFromShimService = await diagnosticsService.ioregistry({
+        ioClass: 'IOPMPowerSource',
+        returnRawJson: true,
+      });
+    } catch (err) {
+      log.error(`Failed to get battery info from DiagnosticsService: ${err.message}`);
+    } finally {
+      if (remoteXPCConnection) {
+        log.info(`Closing remoteXPC connection for device ${this.device.udid}`);
+        await remoteXPCConnection.close();
       }
     }
+  }
 
-    const batteryInfoFromWda = /** @type {import('./types').BatteryInfo}} */ (
-      await this.proxyCommand('/wda/batteryInfo', 'GET')
-    );
-    return {
-      ...batteryInfoFromWda,
-      advanced: batteryInfoFromShimService || {},
-    };
-  },
-};
+  const batteryInfoFromWda = /** @type {import('./types').BatteryInfo}} */ (
+    await this.proxyCommand('/wda/batteryInfo', 'GET')
+  );
+  return {
+    ...batteryInfoFromWda,
+    advanced: batteryInfoFromShimService || {},
+  };
+}
 
 /**
  * @typedef {import('./types').BatteryInfo} BatteryInfo

package/lib/commands/biometric.js

@@ -3,52 +3,50 @@ import {assertSimulator as _assertSimulator} from '../utils';
 
 const assertSimulator = _.partial(_assertSimulator, 'Biometric enrollment');
 
-export default {
-  /**
-   * 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}
-   */
-  async mobileEnrollBiometric(isEnabled = true) {
-    assertSimulator(this);
-
-    await /** @type {import('../driver').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}
-   */
-  async mobileSendBiometricMatch(type = 'touchId', match = true) {
-    assertSimulator(this);
-
-    await /** @type {import('../driver').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}
-   */
-  async mobileIsBiometricEnrolled() {
-    assertSimulator(this);
-
-    return await /** @type {import('../driver').Simulator} */ (this.device).isBiometricEnrolled();
-  },
-};
+/**
+ * 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('../driver').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('../driver').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('../driver').Simulator} */ (this.device).isBiometricEnrolled();
+}
 
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver