appium-xcuitest-driver 8.1.0 → 8.3.0

package/lib/commands/file-movement.js

@@ -72,17 +72,14 @@ function verifyIsSubPath(originalPath, root) {
  *
  * @param {string} udid
  * @param {string} [bundleId]
- * @param {string} [containerType]
  * @returns {Promise<any>}
  */
-async function createAfcClient(udid, bundleId, containerType) {
+async function createAfcClient(udid, bundleId) {
   if (!bundleId) {
     return await services.startAfcService(udid);
   }
   const service = await services.startHouseArrestService(udid);
-  return isDocumentsContainer(containerType)
-    ? await service.vendDocuments(bundleId)
-    : await service.vendContainer(bundleId);
+  return await service.vendContainer(bundleId);
 }
 
 /**
@@ -103,7 +100,7 @@ function isDocumentsContainer(containerType) {
 async function createService(remotePath) {
   if (CONTAINER_PATH_PATTERN.test(remotePath)) {
     const {bundleId, pathInContainer, containerType} = await parseContainerPath.bind(this)(remotePath);
-    const service = await createAfcClient(this.device.udid, bundleId, containerType);
+    const service = await createAfcClient(this.device.udid, bundleId);
     const relativePath = isDocumentsContainer(containerType)
       ? path.join(CONTAINER_DOCUMENTS_PATH, pathInContainer)
       : pathInContainer;

package/lib/commands/increase-contrast.js

@@ -0,0 +1,52 @@
+import _ from 'lodash';
+import {assertSimulator as _assertSimulator} from '../utils';
+import { errors } from 'appium/driver';
+
+const assertSimulator = _.partial(_assertSimulator, 'Content size ui command');
+
+const INCREASE_CONTRAST_CONFIG = [
+    'enabled',
+    'disabled',
+];
+
+export default {
+  /**
+   * Sets the increase contrast configuration for the given simulator.
+   *
+   * @since Xcode 15 (but lower xcode could have this command)
+   * @param {IncreaseContrastAction} increaseContrast valid increase constrast 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}
+   */
+  async 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}
+   */
+  async 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/index.js

@@ -9,6 +9,7 @@ import biometricExtensions from './biometric';
 import certificateExtensions from './certificate';
 import clipboardExtensions from './clipboard';
 import conditionExtensions from './condition';
+import contentSizeExtensions from './content-size';
 import contextExtensions from './context';
 import deviceInfoExtensions from './deviceInfo';
 import elementExtensions from './element';
@@ -18,6 +19,7 @@ import findExtensions from './find';
 import generalExtensions from './general';
 import geolocationExtensions from './geolocation';
 import gestureExtensions from './gesture';
+import increaseContrastExtensions from './increase-contrast';
 import iohidExtensions from './iohid';
 import keychainsExtensions from './keychains';
 import keyboardExtensions from './keyboard';
@@ -55,6 +57,7 @@ export default {
   certificateExtensions,
   clipboardExtensions,
   conditionExtensions,
+  contentSizeExtensions,
   contextExtensions,
   deviceInfoExtensions,
   elementExtensions,
@@ -64,6 +67,7 @@ export default {
   generalExtensions,
   geolocationExtensions,
   gestureExtensions,
+  increaseContrastExtensions,
   iohidExtensions,
   keychainsExtensions,
   keyboardExtensions,

package/lib/commands/types.ts

@@ -337,6 +337,60 @@ export type ButtonName = AnyCase<
  */
 export type Style = 'dark' | 'light' | 'unsupported' | 'unknown';
 
+/**
+ * Returned in the {@linkcode XCUITest.mobileGetIncreaseContrast mobile: getIncreaseContrast} command response.
+ */
+export type IncreaseContrastResult =
+    | 'enabled'
+    | 'disabled'
+    | 'unsupported'
+    | 'unknown';
+
+/**
+ * Argument in the {@linkcode XCUITest.mobileSetIncreaseContrast mobile: setIncreaseContrast} command.
+ */
+export type IncreaseContrastAction =
+    | 'enabled'
+    | 'disabled';
+
+/**
+ * Argument in the {@linkcode XCUITest.mobileSetContentSize mobile: setContentSize} command.
+ */
+export type ContentSizeAction =
+    | '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';
+
+/**
+ * Returned in the {@linkcode XCUITest.mobileGetContentSize mobile: getContentSize} command response.
+ */
+export type ContentSizeResult =
+    | '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'
+    | 'unsupported';
+
 export interface ScreenInfo {
   /**
    * Status bar dimensions

package/lib/driver.js

@@ -1825,6 +1825,20 @@ export class XCUITestDriver extends BaseDriver {
   mobileSetAppearance = commands.appearanceExtensions.mobileSetAppearance;
   mobileGetAppearance = commands.appearanceExtensions.mobileGetAppearance;
 
+  /*------------+
+   | INCREASE CONTRAST |
+   +------------+*/
+
+  mobileSetIncreaseContrast = commands.increaseContrastExtensions.mobileSetIncreaseContrast;
+  mobileGetIncreaseContrast = commands.increaseContrastExtensions.mobileGetIncreaseContrast;
+
+  /*------------+
+   | CONTENT SIZE |
+   +------------+*/
+
+  mobileSetContentSize = commands.contentSizeExtensions.mobileSetContentSize;
+  mobileGetContentSize = commands.contentSizeExtensions.mobileGetContentSize;
+
   /*------------+
    | AUDIT      |
    +------------+*/

package/lib/execute-method-map.ts

@@ -333,6 +333,24 @@ export const executeMethodMap = {
       required: ['style'],
     },
   },
+  'mobile: getIncreaseContrast': {
+    command: 'mobileGetIncreaseContrast'
+  },
+  'mobile: setIncreaseContrast': {
+    command: 'mobileSetIncreaseContrast',
+    params: {
+      required: ['increaseContrast'],
+    },
+  },
+  'mobile: contentSize': {
+    command: 'mobileGetContentSize'
+  },
+  'mobile: setContentSize': {
+    command: 'mobileSetContentSize',
+    params: {
+      required: ['size'],
+    },
+  },
   'mobile: getClipboard': {
     command: 'getClipboard',
     params: {

package/lib/utils.js

@@ -466,15 +466,18 @@ function requireArgs(argNames, opts = {}) {
 }
 
 /**
- * Asserts that the given driver is running on a Simulator.
+ * Asserts that the given driver is running on a Simulator and return
+ * the simlator instance.
  *
  * @param {string} action - Description of action
  * @param {import('./driver').XCUITestDriver} driver
+ * @returns {Simulator}
  */
 export function assertSimulator(action, driver) {
   if (!driver.isSimulator()) {
     throw new Error(`${_.upperFirst(action)} can only be performed on Simulator`);
   }
+  return /** @type{Simulator} */ (driver.device);
 }
 
 /**
@@ -536,4 +539,5 @@ export {
 
 /**
  * @typedef {import('appium-xcode').XcodeVersion} XcodeVersion
+ * @typedef {import('appium-ios-simulator').Simulator} Simulator
  */

package/npm-shrinkwrap.json

@@ -1,18 +1,18 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "8.1.0",
+  "version": "8.3.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "8.1.0",
+      "version": "8.3.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@colors/colors": "^1.6.0",
         "appium-idb": "^1.6.13",
         "appium-ios-device": "^2.8.0",
-        "appium-ios-simulator": "^6.1.7",
+        "appium-ios-simulator": "^6.2.0",
         "appium-remote-debugger": "^12.1.1",
         "appium-webdriveragent": "^9.0.1",
         "appium-xcode": "^5.1.4",
@@ -25,7 +25,7 @@
         "lru-cache": "^10.0.0",
         "moment": "^2.29.4",
         "moment-timezone": "^0.x",
-        "node-simctl": "^7.6.0",
+        "node-simctl": "^7.7.1",
         "portscanner": "^2.2.0",
         "semver": "^7.5.4",
         "source-map-support": "^0.x",
@@ -112,6 +112,12 @@
         "spdy": "4.0.2"
       }
     },
+    "node_modules/@appium/base-driver/node_modules/@types/lodash": {
+      "version": "4.17.14",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.14.tgz",
+      "integrity": "sha512-jsxagdikDiDBeIRaPYtArcT8my4tN1og7MtMRquFT3XNA6axxyHDRUemqDz/taRDdOUn0GnGHRCuff4q48sW9A==",
+      "license": "MIT"
+    },
     "node_modules/@appium/base-driver/node_modules/type-fest": {
       "version": "4.31.0",
       "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.31.0.tgz",
@@ -159,6 +165,18 @@
         "npm": ">=8"
       }
     },
+    "node_modules/@appium/docutils/node_modules/semver": {
+      "version": "7.6.3",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz",
+      "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==",
+      "license": "ISC",
+      "bin": {
+        "semver": "bin/semver.js"
+      },
+      "engines": {
+        "node": ">=10"
+      }
+    },
     "node_modules/@appium/docutils/node_modules/type-fest": {
       "version": "4.31.0",
       "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.31.0.tgz",
@@ -296,6 +314,18 @@
         "sharp": "0.33.5"
       }
     },
+    "node_modules/@appium/support/node_modules/semver": {
+      "version": "7.6.3",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz",
+      "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==",
+      "license": "ISC",
+      "bin": {
+        "semver": "bin/semver.js"
+      },
+      "engines": {
+        "node": ">=10"
+      }
+    },
     "node_modules/@appium/support/node_modules/type-fest": {
       "version": "4.31.0",
       "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.31.0.tgz",
@@ -560,9 +590,9 @@
       }
     },
     "node_modules/@types/express-serve-static-core": {
-      "version": "5.0.5",
-      "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-5.0.5.tgz",
-      "integrity": "sha512-GLZPrd9ckqEBFMcVM/qRFAP0Hg3qiVEojgEFsx/N/zKXsBzbGF6z5FBDpZ0+Xhp1xr+qRZYjfGr1cWHB9oFHSA==",
+      "version": "5.0.6",
+      "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-5.0.6.tgz",
+      "integrity": "sha512-3xhRnjJPkULekpSzgtoNYYcTWgEZkp4myc+Saevii5JPnHNvHMRlBSHDbs7Bh1iPPoVTERHEZXyhyLbMEsExsA==",
       "license": "MIT",
       "dependencies": {
         "@types/node": "*",
@@ -614,9 +644,9 @@
       "license": "MIT"
     },
     "node_modules/@types/lodash": {
-      "version": "4.17.14",
-      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.14.tgz",
-      "integrity": "sha512-jsxagdikDiDBeIRaPYtArcT8my4tN1og7MtMRquFT3XNA6axxyHDRUemqDz/taRDdOUn0GnGHRCuff4q48sW9A==",
+      "version": "4.17.15",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.15.tgz",
+      "integrity": "sha512-w/P33JFeySuhN6JLkysYUK2gEmy9kHHFN7E8ro0tkfmlDOgxBDzWEZ/J8cWA+fHqFevpswDTFZnDx+R9lbL6xw==",
       "license": "MIT"
     },
     "node_modules/@types/method-override": {
@@ -650,9 +680,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "22.10.7",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.7.tgz",
-      "integrity": "sha512-V09KvXxFiutGp6B7XkpaDXlNadZxrzajcY50EuoLIpQ6WWYCSvf19lVIazzfIzQvhUN2HjX12spLojTnhuKlGg==",
+      "version": "22.12.0",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.12.0.tgz",
+      "integrity": "sha512-Fll2FZ1riMjNmlmJOdAyY5pUbkftXslB5DgEzlIuNaiWhXd00FhWxVC/r4yV/4wBb9JfImTu+jiSvXTkJ7F/gA==",
       "license": "MIT",
       "dependencies": {
         "undici-types": "~6.20.0"
@@ -871,9 +901,9 @@
       }
     },
     "node_modules/appium-ios-simulator": {
-      "version": "6.1.17",
-      "resolved": "https://registry.npmjs.org/appium-ios-simulator/-/appium-ios-simulator-6.1.17.tgz",
-      "integrity": "sha512-GrQqHWSp5JAp8F3FS8X2mVzXHkdTf9mwN8rX2xTg1G/yFQBmQw/3/wJPUhCVm/hFHXYSPIHYMClprdKRjhTGuQ==",
+      "version": "6.2.0",
+      "resolved": "https://registry.npmjs.org/appium-ios-simulator/-/appium-ios-simulator-6.2.0.tgz",
+      "integrity": "sha512-VpFMKSVQBoRVnp86sXt2nr4qtOGm23sQytCDWGDsQ1povIb3RG5Lyato6IQYAI5VRPesDois3DgOAR70DnnauQ==",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/support": "^6.0.0",
@@ -883,7 +913,7 @@
         "asyncbox": "^3.0.0",
         "bluebird": "^3.5.1",
         "lodash": "^4.2.1",
-        "node-simctl": "^7.4.1",
+        "node-simctl": "^7.7.1",
         "semver": "^7.0.0",
         "source-map-support": "^0.x",
         "teen_process": "^2.0.0"
@@ -2601,6 +2631,7 @@
       "version": "4.4.2",
       "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz",
       "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==",
+      "deprecated": "This package is deprecated. Use the optional chaining (?.) operator instead.",
       "license": "MIT"
     },
     "node_modules/lodash.isfinite": {
@@ -2781,9 +2812,9 @@
       }
     },
     "node_modules/moment-timezone": {
-      "version": "0.5.46",
-      "resolved": "https://registry.npmjs.org/moment-timezone/-/moment-timezone-0.5.46.tgz",
-      "integrity": "sha512-ZXm9b36esbe7OmdABqIWJuBBiLLwAjrN7CE+7sYdCCx82Nabt1wHDj8TVseS59QIlfFPbOoiBPm6ca9BioG4hw==",
+      "version": "0.5.47",
+      "resolved": "https://registry.npmjs.org/moment-timezone/-/moment-timezone-0.5.47.tgz",
+      "integrity": "sha512-UbNt/JAWS0m/NJOebR0QMRHBk0hu03r5dx9GK8Cs0AS3I81yDcOc9k+DytPItgVvBP7J6Mf6U2n3BPAacAV9oA==",
       "license": "MIT",
       "dependencies": {
         "moment": "^2.29.4"
@@ -2916,9 +2947,9 @@
       }
     },
     "node_modules/node-simctl": {
-      "version": "7.6.5",
-      "resolved": "https://registry.npmjs.org/node-simctl/-/node-simctl-7.6.5.tgz",
-      "integrity": "sha512-YOylJayVx4bVuCC/VkApHrV3jVHQ2vVcZb3h61WlozL9/G9y49GfCQBZ9Ij4bk+RQCbs0u4ClTydB+JqjXL3ZQ==",
+      "version": "7.7.1",
+      "resolved": "https://registry.npmjs.org/node-simctl/-/node-simctl-7.7.1.tgz",
+      "integrity": "sha512-MnCFJTusdKlZC2fmU+xfEpisN6ddNbBIBCH/IU+o4BjBPQWFVPZMSXr5slPX51QX05F1NbuiczTZyr88cJMqVQ==",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/logger": "^1.3.0",
@@ -3310,12 +3341,6 @@
         "url": "https://github.com/sponsors/ljharb"
       }
     },
-    "node_modules/queue-tick": {
-      "version": "1.0.1",
-      "resolved": "https://registry.npmjs.org/queue-tick/-/queue-tick-1.0.1.tgz",
-      "integrity": "sha512-kJt5qhMxoszgU/62PLP1CJytzd2NKetjSRnyuj31fDd3Rlcz3fzlFdFLD1SItunPwyqEOkca6GbV612BWfaBag==",
-      "license": "MIT"
-    },
     "node_modules/range-parser": {
       "version": "1.2.1",
       "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz",
@@ -3530,9 +3555,9 @@
       "optional": true
     },
     "node_modules/semver": {
-      "version": "7.6.3",
-      "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz",
-      "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==",
+      "version": "7.7.0",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.0.tgz",
+      "integrity": "sha512-DrfFnPzblFmNrIZzg5RzHegbiRWg7KMR7btwi2yjHwx06zsUbO5g613sVwEV7FTwmzJu+Io0lJe2GJ3LxqpvBQ==",
       "license": "ISC",
       "bin": {
         "semver": "bin/semver.js"
@@ -3958,13 +3983,12 @@
       }
     },
     "node_modules/streamx": {
-      "version": "2.21.1",
-      "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.21.1.tgz",
-      "integrity": "sha512-PhP9wUnFLa+91CPy3N6tiQsK+gnYyUNuk15S3YG/zjYE7RuPeCjJngqnzpC31ow0lzBHQ+QGO4cNJnd0djYUsw==",
+      "version": "2.22.0",
+      "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.22.0.tgz",
+      "integrity": "sha512-sLh1evHOzBy/iWRiR6d1zRcLao4gGZr3C1kzNz4fopCOKJb6xD9ub8Mpi9Mr1R6id5o43S+d93fI48UC5uM9aw==",
       "license": "MIT",
       "dependencies": {
         "fast-fifo": "^1.3.2",
-        "queue-tick": "^1.0.1",
         "text-decoder": "^1.1.0"
       },
       "optionalDependencies": {

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "8.1.0",
+  "version": "8.3.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -79,7 +79,7 @@
     "@colors/colors": "^1.6.0",
     "appium-idb": "^1.6.13",
     "appium-ios-device": "^2.8.0",
-    "appium-ios-simulator": "^6.1.7",
+    "appium-ios-simulator": "^6.2.0",
     "appium-remote-debugger": "^12.1.1",
     "appium-webdriveragent": "^9.0.1",
     "appium-xcode": "^5.1.4",
@@ -92,7 +92,7 @@
     "lru-cache": "^10.0.0",
     "moment": "^2.29.4",
     "moment-timezone": "^0.x",
-    "node-simctl": "^7.6.0",
+    "node-simctl": "^7.7.1",
     "portscanner": "^2.2.0",
     "semver": "^7.5.4",
     "source-map-support": "^0.x",