appium-xcuitest-driver 10.8.4 → 10.9.1

package/lib/commands/pasteboard.js

@@ -16,7 +16,7 @@ export async function mobileSetPasteboard(content, encoding = 'utf8') {
     // can be empty string
     throw new Error('Pasteboard content is mandatory to set');
   }
-  return await /** @type {import('../driver').Simulator} */ (this.device).simctl.setPasteboard(
+  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.setPasteboard(
     content, /** @type {BufferEncoding} */ (encoding)
   );
 }
@@ -34,7 +34,7 @@ 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('../driver').Simulator} */ (this.device).simctl.getPasteboard(encoding);
+  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.getPasteboard(encoding);
 }
 
 /**

package/lib/commands/pcap.js

@@ -1,4 +1,4 @@
-import { Pyidevice } from '../real-device-clients/py-ios-device-client';
+import { Pyidevice } from '../device/clients/py-ios-device-client';
 import {fs, tempDir, util} from 'appium/support';
 import {encodeBase64OrUpload} from '../utils';
 import {errors} from 'appium/driver';

package/lib/commands/permissions.js

@@ -55,7 +55,7 @@ export async function mobileGetPermission(bundleId, service) {
   assertSimulator(this);
 
   return /** @type {import('./types').PermissionState} */ (
-    await /** @type {import('../driver').Simulator} */ (this.device).getPermission(
+    await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).getPermission(
       bundleId, String(service)
     )
   );
@@ -77,7 +77,7 @@ export async function mobileSetPermissions(access, bundleId) {
   }
   assertSimulator(this);
 
-  await /** @type {import('../driver').Simulator} */ (this.device).setPermissions(bundleId, access);
+  await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).setPermissions(bundleId, access);
 }
 
 /**

package/lib/commands/proxy-helper.js

@@ -69,9 +69,6 @@ export async function proxyCommand(url, method, body, isSessionCommand = true) {
     );
   }
 
-  if (!this.wda) {
-    throw new Error('Cannot call proxyCommand without WDA driver active');
-  }
   const proxy = isSessionCommand ? this.wda.jwproxy : this.wda.noSessionProxy;
   if (!proxy) {
     throw new Error('Cannot call proxyCommand without WDA proxy active');

package/lib/commands/screenshots.js

@@ -60,7 +60,7 @@ export async function getScreenshot() {
   // simulator attempt
   if (this.isSimulator()) {
     this.log.info(`Falling back to 'simctl io screenshot' API`);
-    const payload = await /** @type {import('../driver').Simulator} */ (this.device).simctl.getScreenshot();
+    const payload = await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.getScreenshot();
     if (!payload) {
       throw new errors.UnableToCaptureScreen();
     }

package/lib/commands/simctl.js

@@ -53,7 +53,7 @@ export async function mobileSimctl(command, args = [], timeout = undefined) {
       `Available subcommands are ${SUBCOMMANDS_HAS_DEVICE.join(',')}`);
   }
 
-  return await /** @type {import('./../driver').Simulator} */ (this.device).simctl.exec(
+  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.exec(
     command,
     {args: [this.opts.udid, ...args], timeout}
   );

package/lib/commands/web.js

@@ -960,7 +960,7 @@ export async function mobileUpdateSafariPreferences(preferences) {
   }
 
   this.log.debug(`About to update Safari preferences: ${JSON.stringify(preferences)}`);
-  await /** @type {import('../driver').Simulator} */ (this.device).updateSafariSettings(preferences);
+  await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).updateSafariSettings(preferences);
 }
 
 /**

package/lib/commands/xctest-record-screen.js

@@ -32,7 +32,7 @@ const SUBDIRECTORY = 'Attachments';
  * @returns {Promise<string>} The full path to the screen recording movie
  */
 async function retrieveRecodingFromSimulator(uuid) {
-  const device = /** @type {import('../driver').Simulator} */ (this.device);
+  const device = /** @type {import('appium-ios-simulator').Simulator} */ (this.device);
   const dataRoot = /** @type {string} */ (device.getDir());
   // On Simulators the path looks like
   // $HOME/Library/Developer/CoreSimulator/Devices/F8E1968A-8443-4A9A-AB86-27C54C36A2F6/data/Containers/Data/InternalDaemon/4E3FE8DF-AD0A-41DA-B6EC-C35E5798C219/Attachments/A044DAF7-4A58-4CD5-95C3-29B4FE80C377

package/lib/{desired-caps.js → desired-caps.ts}

@@ -1,8 +1,10 @@
+import type {Constraints} from '@appium/types';
+
 // These platform names should be valid in simulator name
-const PLATFORM_NAME_IOS = 'iOS';
-const PLATFORM_NAME_TVOS = 'tvOS';
+export const PLATFORM_NAME_IOS = 'iOS';
+export const PLATFORM_NAME_TVOS = 'tvOS';
 
-const desiredCapConstraints = /** @type {const} */ ({
+export const desiredCapConstraints = {
   platformName: {
     // override
     presence: true,
@@ -391,7 +393,6 @@ const desiredCapConstraints = /** @type {const} */ ({
     isString: true,
     inclusionCaseInsensitive: ['none', 'eager', 'normal']
   }
-});
+} as const satisfies Constraints;
 
-export {desiredCapConstraints, PLATFORM_NAME_IOS, PLATFORM_NAME_TVOS};
-export default desiredCapConstraints;
+export type XCUITestDriverConstraints = typeof desiredCapConstraints;

package/lib/{real-device-clients → device/clients}/py-ios-device-client.ts

@@ -4,7 +4,7 @@ import path from 'path';
 import { BaseDeviceClient } from './base-device-client';
 import type { BaseDeviceClientOptions, InstallProfileArgs } from './base-device-client';
 import type { TeenProcessExecResult } from 'teen_process';
-import type { CertificateList } from '../commands/types';
+import type { CertificateList } from '../../commands/types';
 
 // https://github.com/YueChen-C/py-ios-device
 

package/lib/{device-log → device/log}/helpers.ts

@@ -1,4 +1,4 @@
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 import { fs } from 'appium/support';
 import { createInterface } from 'node:readline';
 import _ from 'lodash';

package/lib/{device-log → device/log}/ios-crash-log.ts

@@ -2,13 +2,13 @@ import {fs, tempDir, util} from 'appium/support';
 import B from 'bluebird';
 import path from 'path';
 import _ from 'lodash';
-import {Pyidevice} from '../real-device-clients/py-ios-device-client';
+import {Pyidevice} from '../clients/py-ios-device-client';
 import {IOSLog} from './ios-log';
 import { toLogEntry, grepFile } from './helpers';
 import type { AppiumLogger } from '@appium/types';
-import type { BaseDeviceClient } from '../real-device-clients/base-device-client';
+import type { BaseDeviceClient } from '../clients/base-device-client';
 import type { Simulator } from 'appium-ios-simulator';
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 
 // The file format has been changed from '.crash' to '.ips' since Monterey.
 const CRASH_REPORTS_GLOB_PATTERN = '**/*.@(crash|ips)';

package/lib/{device-log → device/log}/ios-log.ts

@@ -1,6 +1,6 @@
 import {EventEmitter} from 'events';
 import { LRUCache } from 'lru-cache';
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 import type { AppiumLogger } from '@appium/types';
 import {logger} from 'appium/support';
 

package/lib/{device-log → device/log}/line-consuming-log.ts

@@ -1,6 +1,6 @@
 import {IOSLog} from './ios-log';
 import { toLogEntry } from './helpers';
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 
 type TSerializedEntry = [string, number];
 

package/lib/{device-log → device/log}/safari-console-log.ts

@@ -7,7 +7,7 @@ import {
   MAX_BUFFERED_EVENTS_COUNT
 } from './helpers';
 import { IOSLog } from './ios-log';
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 
 const LOG_LEVELS_MAP = {
   error: 'SEVERE',

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

@@ -709,8 +709,9 @@ export function applySafariStartupArgs(this: XCUITestDriver): boolean {
   const args = _.toPairs(prefs)
     .flatMap(([key, value]) => [_.startsWith(key, '-') ? key : `-${key}`, String(value)]);
   defaultLogger.debug(`Generated Safari command line arguments: ${args.join(' ')}`);
-  if (_.isPlainObject(this.opts.processArguments)) {
-    this.opts.processArguments.args = [...(this.opts.processArguments.args ?? []), ...args];
+  const processArguments = this.opts.processArguments as {args: string[]} | undefined;
+  if (processArguments && _.isPlainObject(processArguments)) {
+    processArguments.args = [...(processArguments.args ?? []), ...args];
   } else {
     this.opts.processArguments = {args};
   }

package/lib/device/simulator-management.ts

@@ -157,7 +157,7 @@ export async function runSimulatorReset(
     const isKeychainsBackupSuccessful = (keychainsExcludePatterns || keepKeyChains) && (await device.backupKeychains());
     await device.clean();
     if (isKeychainsBackupSuccessful) {
-      await device.restoreKeychains(keychainsExcludePatterns || []);
+      await device.restoreKeychains(keychainsExcludePatterns?.split(',')?.map(_.trim) || []);
       this.log.info(`Successfully restored keychains after full reset`);
     } else if (keychainsExcludePatterns || keepKeyChains) {
       this.log.warn(