appium-xcuitest-driver 10.14.4 → 10.14.6

package/lib/commands/lock.ts

@@ -0,0 +1,43 @@
+import B from 'bluebird';
+import type {XCUITestDriver} from '../driver';
+
+/**
+ * Lock the device (and optionally unlock the device after a certain amount of time)
+ *
+ * @param 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
+ */
+export async function lock(
+  this: XCUITestDriver,
+  seconds?: number | string,
+): Promise<void> {
+  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
+ */
+export async function unlock(this: XCUITestDriver): Promise<void> {
+  await this.proxyCommand('/wda/unlock', 'POST');
+}
+
+/**
+ * Determine whether the device is locked
+ *
+ * @returns `true` if the device is locked, `false` otherwise
+ */
+export async function isLocked(this: XCUITestDriver): Promise<boolean> {
+  return await this.proxyCommand<any, boolean>('/wda/locked', 'GET');
+}
+

package/lib/commands/{memory.js → memory.ts}

@@ -1,20 +1,24 @@
 import _ from 'lodash';
 import { errors } from 'appium/driver';
+import type {XCUITestDriver} from '../driver';
+import type {RealDevice} from '../device/real-device-management';
 
 /**
  * Simulates Low Memory warning on the given application
  *
  * @since Xcode 15
- * @param {string} bundleId - The bundle identifier of the target app. The app must be running
- * @this {XCUITestDriver}
- * @throws {Error} if the app is not running or is not installed
+ * @param bundleId - The bundle identifier of the target app. The app must be running
+ * @throws If the app is not running or is not installed
  */
-export async function mobileSendMemoryWarning(bundleId) {
+export async function mobileSendMemoryWarning(
+  this: XCUITestDriver,
+  bundleId: string,
+): Promise<void> {
   if (!this.isRealDevice()) {
     throw new Error('Memory warning simulation is only supported on real devices');
   }
 
-  const device = /** @type {import('../device/real-device-management').RealDevice} */ (this.device);
+  const device = this.device as RealDevice;
 
   const appInfos = await device.devicectl.listApps(bundleId);
   if (_.isEmpty(appInfos)) {
@@ -33,7 +37,6 @@ export async function mobileSendMemoryWarning(bundleId) {
   // Unfortunately devicectl does not provide more info which would
   // allow to connect a bundle id to a process id.
   const pattern = new RegExp(`^${_.escapeRegExp(appInfos[0].url)}[^/]+$`);
-  /** @type {number[]} */
   const pids = (await device.devicectl.listProcesses())
     .filter(({executable}) => pattern.test(executable))
     .map(({processIdentifier}) => processIdentifier);
@@ -46,6 +49,3 @@ export async function mobileSendMemoryWarning(bundleId) {
   await device.devicectl.sendMemoryWarning(pids[0]);
 }
 
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */

package/lib/commands/pasteboard.ts

@@ -0,0 +1,44 @@
+import _ from 'lodash';
+import { assertSimulator } from '../utils';
+import type {XCUITestDriver} from '../driver';
+import type {Simulator} from 'appium-ios-simulator';
+
+/**
+ * Sets the Simulator's pasteboard content to the given value.
+ *
+ * Does not work for real devices.
+ *
+ * @param content - The content to set
+ * @param encoding - The content's encoding
+ * @group Simulator Only
+ */
+export async function mobileSetPasteboard(
+  this: XCUITestDriver,
+  content: string,
+  encoding: BufferEncoding = 'utf8',
+): Promise<void> {
+  assertSimulator.call(this, 'Setting pasteboard content');
+  if (!_.isString(content)) {
+    // can be empty string
+    throw new Error('Pasteboard content is mandatory to set');
+  }
+  await (this.device as Simulator).simctl.setPasteboard(content, encoding);
+}
+
+/**
+ * Gets the Simulator's pasteboard content.
+ *
+ * Does not work for real devices.
+ *
+ * @param encoding - Expected encoding of returned string
+ * @group Simulator Only
+ * @returns The pasteboard content string
+ */
+export async function mobileGetPasteboard(
+  this: XCUITestDriver,
+  encoding: BufferEncoding = 'utf8',
+): Promise<string> {
+  assertSimulator.call(this, 'Getting pasteboard content');
+  return await (this.device as Simulator).simctl.getPasteboard(encoding);
+}
+

package/lib/commands/types.ts

@@ -334,6 +334,29 @@ export interface ProcessArguments {
   args: string[];
 }
 
+/**
+ * Accessibility audit item returned by the audit command.
+ */
+export interface AccessibilityAuditItem {
+  /**
+   * The detailed description of the found accessibility issue.
+   */
+  detailedDescription: string;
+  /**
+   * The compact description of the found accessibility issue.
+   */
+  compactDescription: string;
+  /**
+   * The name of the audit type this issue belongs to. Could be
+   * a number if the type name is unknown.
+   */
+  auditType: string | number;
+  /**
+   * The description of the element this issue was found for.
+   */
+  element: string;
+}
+
 /**
  * Pressable button names; used by the {@linkcode XCUITest.mobilePressButton mobile: pressButton} command.
  */

package/lib/driver.ts

@@ -41,7 +41,7 @@ import * as clipboardCommands from './commands/clipboard';
 import * as conditionCommands from './commands/condition';
 import * as contentSizeCommands from './commands/content-size';
 import * as contextCommands from './commands/context';
-import * as deviceInfoCommands from './commands/deviceInfo';
+import * as deviceInfoCommands from './commands/device-info';
 import * as elementCommands from './commands/element';
 import * as executeCommands from './commands/execute';
 import * as fileMovementCommands from './commands/file-movement';

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "10.14.4",
+  "version": "10.14.6",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "10.14.4",
+      "version": "10.14.6",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/strongbox": "^1.0.0-rc.1",
@@ -692,9 +692,9 @@
       }
     },
     "node_modules/appium-ios-remotexpc": {
-      "version": "0.24.1",
-      "resolved": "https://registry.npmjs.org/appium-ios-remotexpc/-/appium-ios-remotexpc-0.24.1.tgz",
-      "integrity": "sha512-LJ83A/cHx+CFOX9yGLoG+bsfgYiJdN1PSBDDe7FkZ/C6DGTi+5zvDxOwaBSLmhgEh6uae40EGK8/FbFiKwR4Kg==",
+      "version": "0.24.3",
+      "resolved": "https://registry.npmjs.org/appium-ios-remotexpc/-/appium-ios-remotexpc-0.24.3.tgz",
+      "integrity": "sha512-x76WZpWMLZ2p6coPwmfdqs9dSniAbb8wAAYe0QFD+b9jJtC1QmZjyXB2uEXD1dR871dEwJXUZbB5qKMWYQWNeg==",
       "license": "Apache-2.0",
       "optional": true,
       "dependencies": {
@@ -880,6 +880,27 @@
         "node": ">= 12.0.0"
       }
     },
+    "node_modules/appium/node_modules/ws": {
+      "version": "8.18.3",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.3.tgz",
+      "integrity": "sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=10.0.0"
+      },
+      "peerDependencies": {
+        "bufferutil": "^4.0.1",
+        "utf-8-validate": ">=5.0.2"
+      },
+      "peerDependenciesMeta": {
+        "bufferutil": {
+          "optional": true
+        },
+        "utf-8-validate": {
+          "optional": true
+        }
+      }
+    },
     "node_modules/archiver": {
       "version": "7.0.1",
       "resolved": "https://registry.npmjs.org/archiver/-/archiver-7.0.1.tgz",
@@ -4697,9 +4718,9 @@
       "license": "ISC"
     },
     "node_modules/ws": {
-      "version": "8.18.3",
-      "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.3.tgz",
-      "integrity": "sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg==",
+      "version": "8.19.0",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-8.19.0.tgz",
+      "integrity": "sha512-blAT2mjOEIi0ZzruJfIhb3nps74PRWTCz1IjglWEEpQl5XS/UNama6u2/rjFkDDouqr4L67ry+1aGIALViWjDg==",
       "license": "MIT",
       "engines": {
         "node": ">=10.0.0"

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "10.14.4",
+  "version": "10.14.6",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {

package/build/lib/commands/deviceInfo.d.ts

@@ -1,12 +0,0 @@
-/**
- * Returns the miscellaneous information about the device under test.
- *
- * Since XCUITest driver v4.2.0, this includes device information via lockdown in a real device.
- *
- * @returns {Promise<DeviceInfo | (DeviceInfo & LockdownInfo)>} The response of `/wda/device/info'`
- * @this {import('../driver').XCUITestDriver}
- */
-export function mobileGetDeviceInfo(this: import("../driver").XCUITestDriver): Promise<DeviceInfo | (DeviceInfo & LockdownInfo)>;
-export type DeviceInfo = import("./types").DeviceInfo;
-export type LockdownInfo = import("./types").LockdownInfo;
-//# sourceMappingURL=deviceInfo.d.ts.map

package/build/lib/commands/deviceInfo.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deviceInfo.d.ts","sourceRoot":"","sources":["../../../lib/commands/deviceInfo.js"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,+EAHa,OAAO,CAAC,UAAU,GAAG,CAAC,UAAU,GAAG,YAAY,CAAC,CAAC,CAc7D;yBAGY,OAAO,SAAS,EAAE,UAAU;2BAC5B,OAAO,SAAS,EAAE,YAAY"}

package/build/lib/commands/deviceInfo.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deviceInfo.js","sourceRoot":"","sources":["../../../lib/commands/deviceInfo.js"],"names":[],"mappings":";;AAUA,kDAWC;AArBD,yDAA4C;AAE5C;;;;;;;GAOG;AACI,KAAK,UAAU,mBAAmB;IACvC,MAAM,SAAS,GAAG,2CAA2C,CAAC,CAC5D,MAAM,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,CACnD,CAAC;IAEF,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QACxB,MAAM,YAAY,GAAG,MAAM,6BAAS,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrE,OAAO,EAAC,GAAG,SAAS,EAAE,GAAG,EAAC,YAAY,EAAC,EAAC,CAAC;IAC3C,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG"}

package/lib/commands/active-app-info.js

@@ -1,12 +0,0 @@
-/**
- * Returns information about the active application.
- *
- * @returns {Promise<import('./types').ActiveAppInfo>} Active app information
- * @throws {Error} if an error raised by command
- * @this {import('../driver').XCUITestDriver}
- */
-export async function mobileGetActiveAppInfo() {
-  return /** @type {import('./types').ActiveAppInfo} */ (
-    await this.proxyCommand('/wda/activeAppInfo', 'GET')
-  );
-}

package/lib/commands/audit.js

@@ -1,31 +0,0 @@
-/**
- * @typedef {Object} AccessibilityAuditItem
- * @property {string} detailedDescription The detailed description of the found accessibility issue.
- * @property {string} compactDescription The compact description of the found accessibility issue.
- * @property {string|number} auditType The name of the audit type this issue belongs to. Could be
- * a number if the type name is unknown.
- * @property {string} element The description of the element this issue was found for.
- */
-
-/**
- * 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/clipboard.js

@@ -1,35 +0,0 @@
-/**
- * Sets the primary clipboard's content on the device under test.
- *
- * @param {string} content - The content to be set as base64 encoded string.
- * @param {string} [contentType=plaintext] - The type of the content to set.
- *                                            Only `plaintext`, 'image and 'url' are supported.
- * @this {XCUITestDriver}
- */
-export async function setClipboard(content, contentType) {
-  await this.proxyCommand('/wda/setPasteboard', 'POST', {
-    content,
-    contentType,
-  });
-}
-
-/**
- * Gets the content of the primary clipboard on the device under test.
- *
- * @param {string} [contentType=plaintext] - The type of the content to get.
- *                                            Only `plaintext`, 'image and 'url' are supported.
- * @returns {Promise<string>} The actual clipboard content encoded into base64 string.
- * An empty string is returned if the clipboard contains no data.
- * @this {XCUITestDriver}
- */
-export async function getClipboard(contentType) {
-  return /** @type {string} */ (
-    await this.proxyCommand('/wda/getPasteboard', 'POST', {
-      contentType,
-    })
-  );
-}
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */

package/lib/commands/deviceInfo.js

@@ -1,27 +0,0 @@
-import {utilities} from 'appium-ios-device';
-
-/**
- * Returns the miscellaneous information about the device under test.
- *
- * Since XCUITest driver v4.2.0, this includes device information via lockdown in a real device.
- *
- * @returns {Promise<DeviceInfo | (DeviceInfo & LockdownInfo)>} The response of `/wda/device/info'`
- * @this {import('../driver').XCUITestDriver}
- */
-export async function mobileGetDeviceInfo() {
-  const infoByWda = /** @type {import('./types').DeviceInfo} */ (
-    await this.proxyCommand('/wda/device/info', 'GET')
-  );
-
-  if (this.isRealDevice()) {
-    const lockdownInfo = await utilities.getDeviceInfo(this.device.udid);
-    return {...infoByWda, ...{lockdownInfo}};
-  }
-
-  return infoByWda;
-}
-
-/**
- * @typedef {import('./types').DeviceInfo} DeviceInfo
- * @typedef {import('./types').LockdownInfo} LockdownInfo
- */

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