appium-ios-simulator 8.0.11 → 8.0.13

package/lib/simulator-xcode-14.ts

@@ -1,15 +1,15 @@
-import { fs, timing, util } from '@appium/support';
-import { waitForCondition, retryInterval } from 'asyncbox';
-import { getDeveloperRoot, SIMULATOR_APP_NAME} from './utils';
-import { exec } from 'teen_process';
-import { log as defaultLog } from './logger';
+import {fs, timing, util} from '@appium/support';
+import {waitForCondition, retryInterval} from 'asyncbox';
+import {getDeveloperRoot, SIMULATOR_APP_NAME} from './utils';
+import {exec} from 'teen_process';
+import {log as defaultLog} from './logger';
 import EventEmitter from 'node:events';
 import AsyncLock from 'async-lock';
 import _ from 'lodash';
 import path from 'node:path';
 import B from 'bluebird';
-import { getPath as getXcodePath } from 'appium-xcode';
-import { Simctl } from 'node-simctl';
+import {getPath as getXcodePath} from 'appium-xcode';
+import {Simctl} from 'node-simctl';
 import * as appExtensions from './extensions/applications';
 import * as biometricExtensions from './extensions/biometric';
 import * as safariExtensions from './extensions/safari';
@@ -34,23 +34,26 @@ import type {
   KillUiClientOptions,
   ProcessInfo,
 } from './types';
-import type { XcodeVersion } from 'appium-xcode';
-import type { AppiumLogger, StringRecord } from '@appium/types';
+import type {XcodeVersion} from 'appium-xcode';
+import type {AppiumLogger, StringRecord} from '@appium/types';
 
 const SIMULATOR_SHUTDOWN_TIMEOUT = 15 * 1000;
 const STARTUP_LOCK = new AsyncLock();
 const UI_CLIENT_BUNDLE_ID = 'com.apple.iphonesimulator';
 const STARTUP_TIMEOUT_MS = 120 * 1000;
 
-export class SimulatorXcode14 extends EventEmitter implements
-  CoreSimulator,
-  HasSettings,
-  InteractsWithApps,
-  InteractsWithKeychain,
-  SupportsGeolocation,
-  HasMiscFeatures,
-  InteractsWithSafariBrowser,
-  SupportsBiometric {
+export class SimulatorXcode14
+  extends EventEmitter
+  implements
+    CoreSimulator,
+    HasSettings,
+    InteractsWithApps,
+    InteractsWithKeychain,
+    SupportsGeolocation,
+    HasMiscFeatures,
+    InteractsWithSafariBrowser,
+    SupportsBiometric
+{
   _keychainsBackupPath: string | null | undefined;
   _platformVersion: string | null | undefined;
   _webInspectorSocket: string | null | undefined;
@@ -410,8 +413,11 @@ export class SimulatorXcode14 extends EventEmitter implements
     try {
       await exec('open', args, {timeout: opts.startupTimeout});
     } catch (err: any) {
-      throw new Error(`Got an unexpected error while opening Simulator UI: ` +
-        err.stderr || err.stdout || err.message);
+      throw new Error(
+        `Got an unexpected error while opening Simulator UI: ` + err.stderr ||
+          err.stdout ||
+          err.message,
+      );
     }
   }
 
@@ -428,7 +434,8 @@ export class SimulatorXcode14 extends EventEmitter implements
       startupTimeout: this.startupTimeout,
     });
 
-    const [devicePreferences, commonPreferences] = settingsExtensions.compileSimulatorPreferences.bind(this)(opts);
+    const [devicePreferences, commonPreferences] =
+      settingsExtensions.compileSimulatorPreferences.bind(this)(opts);
     await settingsExtensions.updatePreferences.bind(this)(devicePreferences, commonPreferences);
 
     const timer = new timing.Timer().start();
@@ -441,7 +448,9 @@ export class SimulatorXcode14 extends EventEmitter implements
           return false;
         }
         if (await this.killUIClient({pid: uiClientPid})) {
-          this.log.info(`Detected the Simulator UI client was running and killed it. Verifying the current Simulator state`);
+          this.log.info(
+            `Detected the Simulator UI client was running and killed it. Verifying the current Simulator state`,
+          );
         }
         try {
           // Stopping the UI client kills all running servers for some early XCode versions. This is a known bug
@@ -450,22 +459,30 @@ export class SimulatorXcode14 extends EventEmitter implements
             intervalMs: 100,
           });
         } catch {
-          if (!await this.isRunning()) {
-            throw new Error(`Simulator with UDID '${this.udid}' cannot be transitioned to headless mode`);
+          if (!(await this.isRunning())) {
+            throw new Error(
+              `Simulator with UDID '${this.udid}' cannot be transitioned to headless mode`,
+            );
           }
           return false;
         }
-        this.log.info(`Booting Simulator with UDID '${this.udid}' in headless mode. ` +
-          `All UI-related capabilities are going to be ignored`);
+        this.log.info(
+          `Booting Simulator with UDID '${this.udid}' in headless mode. ` +
+            `All UI-related capabilities are going to be ignored`,
+        );
         await this.boot();
       } else {
         if (isServerRunning && uiClientPid) {
-          this.log.info(`Both Simulator with UDID '${this.udid}' and the UI client are currently running`);
+          this.log.info(
+            `Both Simulator with UDID '${this.udid}' and the UI client are currently running`,
+          );
           return false;
         }
         if (isServerRunning) {
-          this.log.info(`Simulator '${this.udid}' is booted while its UI is not visible. ` +
-            `Trying to restart it with the Simulator window visible`);
+          this.log.info(
+            `Simulator '${this.udid}' is booted while its UI is not visible. ` +
+              `Trying to restart it with the Simulator window visible`,
+          );
           await this.shutdown({timeout: SIMULATOR_SHUTDOWN_TIMEOUT});
         }
         await this.launchWindow(Boolean(uiClientPid), opts);
@@ -475,14 +492,18 @@ export class SimulatorXcode14 extends EventEmitter implements
 
     if (shouldWaitForBoot && opts.startupTimeout) {
       await this.waitForBoot(opts.startupTimeout);
-      this.log.info(`Simulator with UDID ${this.udid} booted in ${timer.getDuration().asSeconds.toFixed(3)}s`);
+      this.log.info(
+        `Simulator with UDID ${this.udid} booted in ${timer.getDuration().asSeconds.toFixed(3)}s`,
+      );
     }
 
     (async () => {
       try {
         await this.disableKeyboardIntroduction();
       } catch (e: any) {
-        this.log.info(`Cannot disable Simulator keyboard introduction. Original error: ${e.message}`);
+        this.log.info(
+          `Cannot disable Simulator keyboard introduction. Original error: ${e.message}`,
+        );
       }
     })();
   }
@@ -496,11 +517,8 @@ export class SimulatorXcode14 extends EventEmitter implements
    * @throws {Error} If sending the signal to the client process fails.
    */
   async killUIClient(opts: KillUiClientOptions = {}): Promise<boolean> {
-    const {
-      pid,
-      signal = 2,
-    } = opts;
-    const clientPid = pid || await this.getUIClientPid();
+    const {pid, signal = 2} = opts;
+    const clientPid = pid || (await this.getUIClientPid());
     if (!clientPid) {
       return false;
     }
@@ -526,9 +544,7 @@ export class SimulatorXcode14 extends EventEmitter implements
    * @throws {Error} If no process information could be retrieved.
    */
   async ps(): Promise<ProcessInfo[]> {
-    const {stdout} = await this.simctl.spawnProcess([
-      'launchctl', 'list'
-    ]);
+    const {stdout} = await this.simctl.spawnProcess(['launchctl', 'list']);
     /*
     Example match:
       PID	Status	Label
@@ -540,7 +556,8 @@ export class SimulatorXcode14 extends EventEmitter implements
       -	0	com.apple.DragUI.druid
       22076	0	UIKitApplication:com.apple.mobilesafari[2b0f][rb-legacy]
     */
-    const extractGroup = (lbl: string): string | null => lbl.includes(':') ? lbl.split(':')[0] : null;
+    const extractGroup = (lbl: string): string | null =>
+      lbl.includes(':') ? lbl.split(':')[0] : null;
     const extractName = (lbl: string): string => {
       let res = lbl;
       const colonIdx = res.indexOf(':');
@@ -561,7 +578,7 @@ export class SimulatorXcode14 extends EventEmitter implements
         continue;
       }
 
-      const [pidStr,, label] = trimmedLine.split(/\s+/);
+      const [pidStr, , label] = trimmedLine.split(/\s+/);
       const pid = parseInt(pidStr, 10);
       if (!pid || !label) {
         continue;
@@ -596,7 +613,7 @@ export class SimulatorXcode14 extends EventEmitter implements
       'RuntimeRoot',
       'System',
       'Library',
-      'LaunchDaemons'
+      'LaunchDaemons',
     );
   }
 
@@ -613,14 +630,18 @@ export class SimulatorXcode14 extends EventEmitter implements
   openUrl = safariExtensions.openUrl;
   scrubSafari = safariExtensions.scrubSafari;
   updateSafariSettings = safariExtensions.updateSafariSettings;
-  getWebInspectorSocket = safariExtensions.getWebInspectorSocket as unknown as () => Promise<string | null>;
+  getWebInspectorSocket = safariExtensions.getWebInspectorSocket as unknown as () => Promise<
+    string | null
+  >;
 
   isBiometricEnrolled = biometricExtensions.isBiometricEnrolled;
   enrollBiometric = biometricExtensions.enrollBiometric;
   sendBiometricMatch = biometricExtensions.sendBiometricMatch;
 
   backupKeychains = keychainExtensions.backupKeychains as unknown as () => Promise<boolean>;
-  restoreKeychains = keychainExtensions.restoreKeychains as unknown as (excludePatterns: string[]) => Promise<boolean>;
+  restoreKeychains = keychainExtensions.restoreKeychains as unknown as (
+    excludePatterns: string[],
+  ) => Promise<boolean>;
   clearKeychains = keychainExtensions.clearKeychains;
 
   setGeolocation = geolocationExtensions.setGeolocation;
@@ -646,4 +667,3 @@ export class SimulatorXcode14 extends EventEmitter implements
   setReduceTransparency = settingsExtensions.setReduceTransparency;
   disableKeyboardIntroduction = settingsExtensions.disableKeyboardIntroduction;
 }
-

package/lib/simulator-xcode-15.ts

@@ -1,9 +1,9 @@
-import { fs } from '@appium/support';
-import { exec } from 'teen_process';
+import {fs} from '@appium/support';
+import {exec} from 'teen_process';
 import path from 'node:path';
 import _ from 'lodash';
 import B from 'bluebird';
-import { SimulatorXcode14 } from './simulator-xcode-14';
+import {SimulatorXcode14} from './simulator-xcode-14';
 
 export class SimulatorXcode15 extends SimulatorXcode14 {
   private _systemAppBundleIds?: Set<string>;
@@ -18,7 +18,7 @@ export class SimulatorXcode15 extends SimulatorXcode14 {
   isAppInstalled = async (bundleId: string): Promise<boolean> => {
     try {
       const appContainer = await this.simctl.getAppContainer(bundleId);
-      return appContainer.endsWith('.app') && await fs.exists(appContainer);
+      return appContainer.endsWith('.app') && (await fs.exists(appContainer));
     } catch {
       // get_app_container subcommand fails for system applications,
       // as well as the hidden appinfo command
@@ -120,7 +120,9 @@ export class SimulatorXcode15 extends SimulatorXcode14 {
       const infoPlistPath = path.resolve(appRoot, 'Info.plist');
       try {
         const {stdout} = await exec('/usr/libexec/PlistBuddy', [
-          '-c', 'print CFBundleIdentifier', infoPlistPath
+          '-c',
+          'print CFBundleIdentifier',
+          infoPlistPath,
         ]);
         return _.trim(stdout);
       } catch {
@@ -135,4 +137,3 @@ export class SimulatorXcode15 extends SimulatorXcode14 {
     return this._systemAppBundleIds;
   }
 }
-

package/lib/simulator.ts

@@ -1,9 +1,9 @@
-import { SimulatorXcode14 } from './simulator-xcode-14';
-import { SimulatorXcode15 } from './simulator-xcode-15';
-import { getSimulatorInfo, assertXcodeVersion, MIN_SUPPORTED_XCODE_VERSION } from './utils';
+import {SimulatorXcode14} from './simulator-xcode-14';
+import {SimulatorXcode15} from './simulator-xcode-15';
+import {getSimulatorInfo, assertXcodeVersion, MIN_SUPPORTED_XCODE_VERSION} from './utils';
 import * as xcode from 'appium-xcode';
-import { log } from './logger';
-import type { Simulator, SimulatorLookupOptions } from './types';
+import {log} from './logger';
+import type {Simulator, SimulatorLookupOptions} from './types';
 
 /**
  * Finds and returns the corresponding Simulator instance for the given ID.
@@ -15,20 +15,17 @@ import type { Simulator, SimulatorLookupOptions } from './types';
  *   [node-simctl](github.com/appium/node-simctl).
  * @return Simulator object associated with the udid passed in.
  */
-export async function getSimulator(udid: string, opts: SimulatorLookupOptions = {}): Promise<Simulator> {
+export async function getSimulator(
+  udid: string,
+  opts: SimulatorLookupOptions = {},
+): Promise<Simulator> {
   let platform = opts.platform ?? 'iOS';
-  const {
-    checkExistence = true,
-    devicesSetPath,
-    logger,
-  } = opts;
+  const {checkExistence = true, devicesSetPath, logger} = opts;
 
-  const xcodeVersion = assertXcodeVersion(
-    await xcode.getVersion(true) as xcode.XcodeVersion
-  );
+  const xcodeVersion = assertXcodeVersion((await xcode.getVersion(true)) as xcode.XcodeVersion);
   if (checkExistence) {
     const simulatorInfo = await getSimulatorInfo(udid, {
-      devicesSetPath
+      devicesSetPath,
     });
 
     if (!simulatorInfo) {
@@ -39,7 +36,7 @@ export async function getSimulator(udid: string, opts: SimulatorLookupOptions =
   }
 
   (logger ?? log).info(
-    `Constructing ${platform} simulator for Xcode version ${xcodeVersion.versionString} with udid '${udid}'`
+    `Constructing ${platform} simulator for Xcode version ${xcodeVersion.versionString} with udid '${udid}'`,
   );
   let SimClass: typeof SimulatorXcode14 | typeof SimulatorXcode15;
   switch (xcodeVersion.major) {
@@ -58,4 +55,3 @@ export async function getSimulator(udid: string, opts: SimulatorLookupOptions =
   }
   return result;
 }
-

package/lib/types.ts

@@ -1,7 +1,7 @@
-import type { EventEmitter } from 'node:events';
-import type { Simctl } from 'node-simctl';
-import type { XcodeVersion } from 'appium-xcode';
-import type { AppiumLogger, StringRecord } from '@appium/types';
+import type {EventEmitter} from 'node:events';
+import type {Simctl} from 'node-simctl';
+import type {XcodeVersion} from 'appium-xcode';
+import type {AppiumLogger, StringRecord} from '@appium/types';
 
 export interface ProcessInfo {
   /**
@@ -288,13 +288,13 @@ export interface SimulatorLookupOptions {
   logger?: AppiumLogger;
 }
 
-export type Simulator = CoreSimulator
-  & InteractsWithSafariBrowser
-  & InteractsWithApps
-  & HasSettings
-  & InteractsWithApps
-  & SupportsBiometric
-  & SupportsGeolocation
-  & InteractsWithKeychain
-  & SupportsAppPermissions
-  & HasMiscFeatures;
+export type Simulator = CoreSimulator &
+  InteractsWithSafariBrowser &
+  InteractsWithApps &
+  HasSettings &
+  InteractsWithApps &
+  SupportsBiometric &
+  SupportsGeolocation &
+  InteractsWithKeychain &
+  SupportsAppPermissions &
+  HasMiscFeatures;

package/lib/utils.ts

@@ -1,12 +1,12 @@
-import { log } from './logger';
+import {log} from './logger';
 import _ from 'lodash';
-import { exec } from 'teen_process';
-import { waitForCondition } from 'asyncbox';
-import { getVersion } from 'appium-xcode';
-import type { XcodeVersion } from 'appium-xcode';
+import {exec} from 'teen_process';
+import {waitForCondition} from 'asyncbox';
+import {getVersion} from 'appium-xcode';
+import type {XcodeVersion} from 'appium-xcode';
 import path from 'node:path';
-import { Simctl } from 'node-simctl';
-import type { StringRecord } from '@appium/types';
+import {Simctl} from 'node-simctl';
+import type {StringRecord} from '@appium/types';
 // it's a hack needed to stub getDevices in tests
 import * as utilsModule from './utils';
 
@@ -45,7 +45,9 @@ async function pkill(appName: string, forceKill: boolean = false): Promise<numbe
  * @param timeout - Timeout in milliseconds (default: DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS).
  * @returns Promise that resolves when all simulators are killed.
  */
-export async function killAllSimulators(timeout: number = DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS): Promise<void> {
+export async function killAllSimulators(
+  timeout: number = DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS,
+): Promise<void> {
   log.debug('Killing all iOS Simulators');
   const xcodeVersion = await getVersion(true);
   if (_.isString(xcodeVersion)) {
@@ -65,7 +67,7 @@ export async function killAllSimulators(timeout: number = DEFAULT_SIM_SHUTDOWN_T
   try {
     const {stdout} = await exec('pgrep', ['-f', `${appName}.app/Contents/MacOS/`]);
     if (stdout.trim()) {
-      pids.push(...(stdout.trim().split(/\s+/)));
+      pids.push(...stdout.trim().split(/\s+/));
     }
   } catch (e: any) {
     if (e.code === 1) {
@@ -73,13 +75,15 @@ export async function killAllSimulators(timeout: number = DEFAULT_SIM_SHUTDOWN_T
       return;
     }
     if (_.isEmpty(pids)) {
-      log.warn(`pgrep error ${e.code} while detecting whether ${appName} is running. Trying to kill anyway.`);
+      log.warn(
+        `pgrep error ${e.code} while detecting whether ${appName} is running. Trying to kill anyway.`,
+      );
     }
   }
   if (!_.isEmpty(pids)) {
     log.debug(`Killing processes: ${pids.join(', ')}`);
     try {
-      await exec('kill', ['-9', ...(pids.map((pid) => `${pid}`))]);
+      await exec('kill', ['-9', ...pids.map((pid) => `${pid}`)]);
     } catch {}
   }
 
@@ -99,7 +103,9 @@ export async function killAllSimulators(timeout: number = DEFAULT_SIM_SHUTDOWN_T
       const state = sim.state.toLowerCase();
       const done = ['shutdown', 'unavailable', 'disconnected'].includes(state);
       if (!done) {
-        remainingDevices.push(`${sim.name} (${sim.sdk}, udid: ${sim.udid}) is still in state '${state}'`);
+        remainingDevices.push(
+          `${sim.name} (${sim.sdk}, udid: ${sim.udid}) is still in state '${state}'`,
+        );
       }
       return done;
     });
@@ -107,7 +113,7 @@ export async function killAllSimulators(timeout: number = DEFAULT_SIM_SHUTDOWN_T
   try {
     await waitForCondition(allSimsAreDown, {
       waitMs: timeout,
-      intervalMs: 200
+      intervalMs: 200,
     });
   } catch (err) {
     if (remainingDevices.length > 0) {
@@ -129,10 +135,11 @@ export interface SimulatorInfoOptions {
  * @param opts - Options including devicesSetPath.
  * @returns Promise that resolves to simulator info or undefined if not found.
  */
-export async function getSimulatorInfo(udid: string, opts: SimulatorInfoOptions = {}): Promise<any> {
-  const {
-    devicesSetPath
-  } = opts;
+export async function getSimulatorInfo(
+  udid: string,
+  opts: SimulatorInfoOptions = {},
+): Promise<any> {
+  const {devicesSetPath} = opts;
   // see the README for github.com/appium/node-simctl for example output of getDevices()
   const devices = _.toPairs(await utilsModule.getDevices({devicesSetPath}))
     .map((pair) => pair[1])
@@ -168,7 +175,7 @@ export function assertXcodeVersion<V extends XcodeVersion>(xcodeVersion: V): V {
   if (xcodeVersion.major < MIN_SUPPORTED_XCODE_VERSION) {
     throw new Error(
       `Tried to use an iOS simulator with xcode version ${xcodeVersion.versionString} but only Xcode version ` +
-      `${MIN_SUPPORTED_XCODE_VERSION} and up are supported`
+        `${MIN_SUPPORTED_XCODE_VERSION} and up are supported`,
     );
   }
   return xcodeVersion;

package/package.json

@@ -7,7 +7,7 @@
     "ios",
     "simctl"
   ],
-  "version": "8.0.11",
+  "version": "8.0.13",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -21,15 +21,13 @@
     "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
     "npm": ">=10"
   },
-  "main": "./build/index.js",
+  "main": "./build/lib/index.js",
   "bin": {},
   "directories": {
     "lib": "lib"
   },
   "files": [
-    "index.ts",
     "lib",
-    "build/index.*",
     "build/lib",
     "CHANGELOG.md"
   ],
@@ -52,6 +50,8 @@
     "dev": "npm run build -- --watch",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
+    "format": "prettier -w ./lib ./test",
+    "format:check": "prettier --check ./lib ./test",
     "prepare": "npm run build",
     "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.ts\"",
     "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.ts\""
@@ -81,7 +81,7 @@
     "semantic-release": "^25.0.2",
     "sinon": "^21.0.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.4.2"
+    "typescript": "^6.0.2"
   },
-  "types": "./build/index.d.ts"
+  "types": "./build/lib/index.d.ts"
 }

package/build/index.d.ts

@@ -1,5 +0,0 @@
-import { getSimulator } from './lib/simulator';
-import { killAllSimulators, simExists } from './lib/utils';
-export { getSimulator, killAllSimulators, simExists };
-export type * from './lib/types';
-//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,SAAS,EAAE,CAAC;AAEtD,mBAAmB,aAAa,CAAC"}

package/build/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAEjB,+CAA+C;AAGtC,6FAHA,wBAAY,OAGA;AAFrB,uCAA2D;AAEpC,kGAFd,yBAAiB,OAEc;AAAE,0FAFd,iBAAS,OAEc"}

package/index.ts

@@ -1,8 +0,0 @@
-// transpile:main
-
-import { getSimulator } from './lib/simulator';
-import { killAllSimulators, simExists } from './lib/utils';
-
-export { getSimulator, killAllSimulators, simExists };
-
-export type * from './lib/types';