appium-xcuitest-driver 10.2.2 → 10.4.0

package/lib/commands/condition.js

@@ -1,6 +1,104 @@
 import {INSTRUMENT_CHANNEL, services} from 'appium-ios-device';
 import _ from 'lodash';
 
+/**
+ * Get all available ConditionInducer configuration information, which can be used with
+ * {@linkcode XCUITestDriver.enableConditionInducer}
+ * @returns {Promise<Condition[]>}
+ * @since 4.9.0
+ * @see {@link https://help.apple.com/xcode/mac/current/#/dev308429d42}
+ * @this {XCUITestDriver}
+ */
+export async function listConditionInducers() {
+  requireConditionInducerCompatibleDevice.bind(this);
+  const conditionInducerService = await services.startInstrumentService(this.device.udid);
+  try {
+    const ret = await conditionInducerService.callChannel(
+      INSTRUMENT_CHANNEL.CONDITION_INDUCER,
+      'availableConditionInducers',
+    );
+    return ret.selector;
+  } finally {
+    conditionInducerService.close();
+  }
+}
+
+/**
+ * Enable a "condition inducer". You can create a condition on a connected device to test your app under adverse conditions,
+ * such as poor network connectivity or thermal constraints. When you start a device condition,
+ * the operating system on the device behaves as if its environment has changed. The device
+ * condition remains active until you stop the device condition or disconnect the device. For
+ * example, you can start a device condition, run your app, monitor your app's energy usage, and
+ * then stop the condition.
+ *
+ * (Note: the socket needs to remain connected during operation)
+ * (Note: Device conditions are available only for real devices running iOS 13.0 and later.)
+ *
+ * @param {string} conditionID - Determine which condition IDs are available with the {@linkcode XCUITestDriver.listConditionInducers} command
+ * @param {string} profileID - Determine which profile IDs are available with the {@linkcode XCUITestDriver.listConditionInducers} command
+ * @returns {Promise<boolean>} `true` if enabling the condition succeeded
+ * @throws {Error} If you try to start another Condition and the previous Condition has not stopped
+ * @since 4.9.0
+ * @see {@link https://help.apple.com/xcode/mac/current/#/dev308429d42}
+ * @this {XCUITestDriver}
+ */
+export async function enableConditionInducer(conditionID, profileID) {
+  requireConditionInducerCompatibleDevice.bind(this);
+  if (this._conditionInducerService && !this._conditionInducerService._socketClient.destroyed) {
+    throw this.log.errorWithException(
+      `Condition inducer has been started. A condition is already active.`
+    );
+  }
+  this._conditionInducerService = await services.startInstrumentService(this.device.udid);
+  const ret = await this._conditionInducerService.callChannel(
+    INSTRUMENT_CHANNEL.CONDITION_INDUCER,
+    'enableConditionWithIdentifier:profileIdentifier:',
+    conditionID,
+    profileID,
+  );
+  if (!_.isBoolean(ret.selector)) {
+    this._conditionInducerService.close();
+    this._conditionInducerService = null;
+    throw this.log.errorWithException(`Enable condition inducer error: '${JSON.stringify(ret.selector)}'`);
+  }
+  return ret.selector;
+}
+
+/**
+ * Disable a condition inducer enabled with {@linkcode XCUITestDriver.enableConditionInducer} Usually
+ * a persistent connection is maintained after the condition inducer is enabled, and this method
+ * is only valid for the currently enabled connection. If the connection is disconnected, the
+ * condition inducer will be automatically disabled
+ *
+ * (Note: this is also automatically called upon session cleanup)
+ * @returns {Promise<boolean>} `true` if disable the condition succeeded
+ * @since 4.9.0
+ * @see {@link https://help.apple.com/xcode/mac/current/#/dev308429d42}
+ * @this {XCUITestDriver}
+ */
+export async function disableConditionInducer() {
+  if (!this._conditionInducerService) {
+    this.log.warn('Condition inducer server is not started');
+    return false;
+  }
+  try {
+    const ret = await this._conditionInducerService.callChannel(
+      INSTRUMENT_CHANNEL.CONDITION_INDUCER,
+      'disableActiveCondition',
+    );
+    if (!_.isBoolean(ret.selector)) {
+      this.log.warn(`Disable condition inducer error: '${JSON.stringify(ret.selector)}'`);
+      return false;
+    }
+    return ret.selector;
+  } finally {
+    if (this._conditionInducerService) {
+      this._conditionInducerService.close();
+      this._conditionInducerService = null;
+    }
+  }
+}
+
 /**
  * @this {XCUITestDriver}
  * @returns {void}
@@ -52,106 +150,6 @@ function requireConditionInducerCompatibleDevice() {
  * }
  */
 
-export default {
-  /**
-   * Get all available ConditionInducer configuration information, which can be used with
-   * {@linkcode XCUITestDriver.enableConditionInducer}
-   * @returns {Promise<Condition[]>}
-   * @since 4.9.0
-   * @see {@link https://help.apple.com/xcode/mac/current/#/dev308429d42}
-   * @this {XCUITestDriver}
-   */
-  async listConditionInducers() {
-    requireConditionInducerCompatibleDevice.bind(this);
-    const conditionInducerService = await services.startInstrumentService(this.device.udid);
-    try {
-      const ret = await conditionInducerService.callChannel(
-        INSTRUMENT_CHANNEL.CONDITION_INDUCER,
-        'availableConditionInducers',
-      );
-      return ret.selector;
-    } finally {
-      conditionInducerService.close();
-    }
-  },
-
-  /**
-   * Enable a "condition inducer". You can create a condition on a connected device to test your app under adverse conditions,
-   * such as poor network connectivity or thermal constraints. When you start a device condition,
-   * the operating system on the device behaves as if its environment has changed. The device
-   * condition remains active until you stop the device condition or disconnect the device. For
-   * example, you can start a device condition, run your app, monitor your app’s energy usage, and
-   * then stop the condition.
-   *
-   * (Note: the socket needs to remain connected during operation)
-   * (Note: Device conditions are available only for real devices running iOS 13.0 and later.)
-   *
-   * @param {string} conditionID - Determine which condition IDs are available with the {@linkcode XCUITestDriver.listConditionInducers} command
-   * @param {string} profileID - Determine which profile IDs are available with the {@linkcode XCUITestDriver.listConditionInducers} command
-   * @returns {Promise<boolean>} `true` if enabling the condition succeeded
-   * @throws {Error} If you try to start another Condition and the previous Condition has not stopped
-   * @since 4.9.0
-   * @see {@link https://help.apple.com/xcode/mac/current/#/dev308429d42}
-   * @this {XCUITestDriver}
-   */
-  async enableConditionInducer(conditionID, profileID) {
-    requireConditionInducerCompatibleDevice.bind(this);
-    if (this._conditionInducerService && !this._conditionInducerService._socketClient.destroyed) {
-      throw this.log.errorWithException(
-        `Condition inducer has been started. A condition is already active.`
-      );
-    }
-    this._conditionInducerService = await services.startInstrumentService(this.device.udid);
-    const ret = await this._conditionInducerService.callChannel(
-      INSTRUMENT_CHANNEL.CONDITION_INDUCER,
-      'enableConditionWithIdentifier:profileIdentifier:',
-      conditionID,
-      profileID,
-    );
-    if (!_.isBoolean(ret.selector)) {
-      this._conditionInducerService.close();
-      this._conditionInducerService = null;
-      throw this.log.errorWithException(`Enable condition inducer error: '${JSON.stringify(ret.selector)}'`);
-    }
-    return ret.selector;
-  },
-
-  /**
-   * Disable a condition inducer enabled with {@linkcode XCUITestDriver.enableConditionInducer} Usually
-   * a persistent connection is maintained after the condition inducer is enabled, and this method
-   * is only valid for the currently enabled connection. If the connection is disconnected, the
-   * condition inducer will be automatically disabled
-   *
-   * (Note: this is also automatically called upon session cleanup)
-   * @returns {Promise<boolean>} `true` if disable the condition succeeded
-   * @since 4.9.0
-   * @see {@link https://help.apple.com/xcode/mac/current/#/dev308429d42}
-   * @this {XCUITestDriver}
-   */
-  async disableConditionInducer() {
-    if (!this._conditionInducerService) {
-      this.log.warn('Condition inducer server is not started');
-      return false;
-    }
-    try {
-      const ret = await this._conditionInducerService.callChannel(
-        INSTRUMENT_CHANNEL.CONDITION_INDUCER,
-        'disableActiveCondition',
-      );
-      if (!_.isBoolean(ret.selector)) {
-        this.log.warn(`Disable condition inducer error: '${JSON.stringify(ret.selector)}'`);
-        return false;
-      }
-      return ret.selector;
-    } finally {
-      if (this._conditionInducerService) {
-        this._conditionInducerService.close();
-        this._conditionInducerService = null;
-      }
-    }
-  },
-};
-
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
  */

package/lib/commands/content-size.js

@@ -21,47 +21,45 @@ const CONTENT_SIZE = [
     'decrement'
 ];
 
-export default {
-  /**
-   * 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}
-   */
-  async mobileSetContentSize(size) {
-    const simulator = assertSimulator(this);
+/**
+ * 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(',')}`
-      );
-    }
+  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);
-  },
+  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}
-   */
-  async mobileGetContentSize() {
-    return /** @type {ContentSizeResult} */ (await assertSimulator(this).getContentSize());
-  },
-};
+/**
+ * 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