appium-ios-simulator 8.1.3 → 8.2.1

package/build/lib/utils/index.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.killAllSimulators = exports.readBundleIdFromPlist = exports.getUiClientAppPath = exports.assertXcodeVersion = exports.getMacAppPidByBundleId = exports.simExists = exports.getSimulatorInfo = exports.getDevices = exports.generateDefaultsCommandArgs = exports.toXmlArg = exports.NSUserDefaults = exports.MIN_DEVICE_HUB_XCODE_VERSION = exports.MIN_SUPPORTED_XCODE_VERSION = exports.DEVICE_HUB_UI_CLIENT_BUNDLE_ID = exports.SIMULATOR_UI_CLIENT_BUNDLE_ID = exports.MOBILE_SAFARI_BUNDLE_ID = exports.SAFARI_STARTUP_TIMEOUT_MS = void 0;
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "SAFARI_STARTUP_TIMEOUT_MS", { enumerable: true, get: function () { return constants_1.SAFARI_STARTUP_TIMEOUT_MS; } });
+Object.defineProperty(exports, "MOBILE_SAFARI_BUNDLE_ID", { enumerable: true, get: function () { return constants_1.MOBILE_SAFARI_BUNDLE_ID; } });
+Object.defineProperty(exports, "SIMULATOR_UI_CLIENT_BUNDLE_ID", { enumerable: true, get: function () { return constants_1.SIMULATOR_UI_CLIENT_BUNDLE_ID; } });
+Object.defineProperty(exports, "DEVICE_HUB_UI_CLIENT_BUNDLE_ID", { enumerable: true, get: function () { return constants_1.DEVICE_HUB_UI_CLIENT_BUNDLE_ID; } });
+Object.defineProperty(exports, "MIN_SUPPORTED_XCODE_VERSION", { enumerable: true, get: function () { return constants_1.MIN_SUPPORTED_XCODE_VERSION; } });
+Object.defineProperty(exports, "MIN_DEVICE_HUB_XCODE_VERSION", { enumerable: true, get: function () { return constants_1.MIN_DEVICE_HUB_XCODE_VERSION; } });
+var defaults_1 = require("./defaults");
+Object.defineProperty(exports, "NSUserDefaults", { enumerable: true, get: function () { return defaults_1.NSUserDefaults; } });
+Object.defineProperty(exports, "toXmlArg", { enumerable: true, get: function () { return defaults_1.toXmlArg; } });
+Object.defineProperty(exports, "generateDefaultsCommandArgs", { enumerable: true, get: function () { return defaults_1.generateDefaultsCommandArgs; } });
+var get_devices_1 = require("./get-devices");
+Object.defineProperty(exports, "getDevices", { enumerable: true, get: function () { return get_devices_1.getDevices; } });
+var devices_1 = require("./devices");
+Object.defineProperty(exports, "getSimulatorInfo", { enumerable: true, get: function () { return devices_1.getSimulatorInfo; } });
+Object.defineProperty(exports, "simExists", { enumerable: true, get: function () { return devices_1.simExists; } });
+var process_1 = require("./process");
+Object.defineProperty(exports, "getMacAppPidByBundleId", { enumerable: true, get: function () { return process_1.getMacAppPidByBundleId; } });
+var xcode_1 = require("./xcode");
+Object.defineProperty(exports, "assertXcodeVersion", { enumerable: true, get: function () { return xcode_1.assertXcodeVersion; } });
+Object.defineProperty(exports, "getUiClientAppPath", { enumerable: true, get: function () { return xcode_1.getUiClientAppPath; } });
+Object.defineProperty(exports, "readBundleIdFromPlist", { enumerable: true, get: function () { return xcode_1.readBundleIdFromPlist; } });
+var lifecycle_1 = require("./lifecycle");
+Object.defineProperty(exports, "killAllSimulators", { enumerable: true, get: function () { return lifecycle_1.killAllSimulators; } });
+//# sourceMappingURL=index.js.map

package/build/lib/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/utils/index.ts"],"names":[],"mappings":";;;AAAA,yCAOqB;AANnB,sHAAA,yBAAyB,OAAA;AACzB,oHAAA,uBAAuB,OAAA;AACvB,0HAAA,6BAA6B,OAAA;AAC7B,2HAAA,8BAA8B,OAAA;AAC9B,wHAAA,2BAA2B,OAAA;AAC3B,yHAAA,4BAA4B,OAAA;AAG9B,uCAAiF;AAAzE,0GAAA,cAAc,OAAA;AAAE,oGAAA,QAAQ,OAAA;AAAE,uHAAA,2BAA2B,OAAA;AAC7D,6CAAyC;AAAjC,yGAAA,UAAU,OAAA;AAClB,qCAAsD;AAA9C,2GAAA,gBAAgB,OAAA;AAAE,oGAAA,SAAS,OAAA;AACnC,qCAAiD;AAAzC,iHAAA,sBAAsB,OAAA;AAC9B,iCAAsF;AAA9E,2GAAA,kBAAkB,OAAA;AAAE,2GAAA,kBAAkB,OAAA;AAAE,8GAAA,qBAAqB,OAAA;AACrE,yCAA8C;AAAtC,8GAAA,iBAAiB,OAAA"}

package/build/lib/utils/lifecycle.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @param timeout - Timeout in milliseconds (default: DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS).
+ * @returns Promise that resolves when all simulators are killed.
+ */
+export declare function killAllSimulators(timeout?: number): Promise<void>;
+//# sourceMappingURL=lifecycle.d.ts.map

package/build/lib/utils/lifecycle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycle.d.ts","sourceRoot":"","sources":["../../../lib/utils/lifecycle.ts"],"names":[],"mappings":"AAcA;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,GAAE,MAAwC,GAChD,OAAO,CAAC,IAAI,CAAC,CAuCf"}

package/build/lib/utils/lifecycle.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.killAllSimulators = killAllSimulators;
+const logger_1 = require("../logger");
+const teen_process_1 = require("teen_process");
+const asyncbox_1 = require("asyncbox");
+const appium_xcode_1 = require("appium-xcode");
+const constants_1 = require("./constants");
+const get_devices_1 = require("./get-devices");
+const process_1 = require("./process");
+const DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS = 60000;
+/**
+ * @param timeout - Timeout in milliseconds (default: DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS).
+ * @returns Promise that resolves when all simulators are killed.
+ */
+async function killAllSimulators(timeout = DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS) {
+    logger_1.log.debug('Killing all iOS Simulators');
+    const xcodeVersion = await (0, appium_xcode_1.getVersion)(true);
+    const uiClientBundleId = xcodeVersion.major >= constants_1.MIN_DEVICE_HUB_XCODE_VERSION
+        ? constants_1.DEVICE_HUB_UI_CLIENT_BUNDLE_ID
+        : constants_1.SIMULATOR_UI_CLIENT_BUNDLE_ID;
+    const startedMs = performance.now();
+    try {
+        await (0, teen_process_1.exec)('xcrun', ['simctl', 'shutdown', 'all'], { timeout });
+    }
+    catch (err) {
+        logger_1.log.debug(`Failed to shutdown all simulators: ${err.stderr || err.message}`);
+    }
+    const uiClientPid = await (0, process_1.getMacAppPidByBundleId)(uiClientBundleId);
+    if (uiClientPid) {
+        logger_1.log.debug(`Killing UI client '${uiClientBundleId}' (pid ${uiClientPid})`);
+        await (0, process_1.killMacAppByBundleId)(uiClientBundleId);
+    }
+    else {
+        logger_1.log.debug(`UI client '${uiClientBundleId}' is not running`);
+    }
+    try {
+        await (0, asyncbox_1.waitForCondition)(allSimsAreDown, {
+            waitMs: Math.max(1000, startedMs + timeout - performance.now()),
+            intervalMs: 200,
+        });
+    }
+    catch (err) {
+        const remainingDevices = await getNonShutdownDeviceDescriptions();
+        const message = remainingDevices.length > 0
+            ? `The following devices are still not in the correct state after ${timeout} ms:\n` +
+                remainingDevices.map((device) => `    ${device}`).join('\n')
+            : `Timed out after ${timeout} ms waiting for all simulators to shut down`;
+        throw new Error(message, { cause: err });
+    }
+}
+async function allSimsAreDown() {
+    try {
+        return (await getNonShutdownDeviceDescriptions()).length === 0;
+    }
+    catch {
+        return false;
+    }
+}
+async function getNonShutdownDeviceDescriptions() {
+    const devices = Object.values(await (0, get_devices_1.getDevices)()).flat();
+    return devices
+        .filter((sim) => !['shutdown', 'unavailable', 'disconnected'].includes(sim.state.toLowerCase()))
+        .map((sim) => `${sim.name} (${sim.sdk}, udid: ${sim.udid}) is still in state '${sim.state.toLowerCase()}'`);
+}
+//# sourceMappingURL=lifecycle.js.map

package/build/lib/utils/lifecycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycle.js","sourceRoot":"","sources":["../../../lib/utils/lifecycle.ts"],"names":[],"mappings":";;AAkBA,8CAyCC;AA3DD,sCAA8B;AAC9B,+CAAkD;AAClD,uCAA0C;AAC1C,+CAAwC;AACxC,2CAIqB;AACrB,+CAAyC;AACzC,uCAAuE;AAEvE,MAAM,+BAA+B,GAAG,KAAK,CAAC;AAE9C;;;GAGG;AACI,KAAK,UAAU,iBAAiB,CACrC,UAAkB,+BAA+B;IAEjD,YAAG,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;IACxC,MAAM,YAAY,GAAG,MAAM,IAAA,yBAAU,EAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,gBAAgB,GACpB,YAAY,CAAC,KAAK,IAAI,wCAA4B;QAChD,CAAC,CAAC,0CAA8B;QAChC,CAAC,CAAC,yCAA6B,CAAC;IAEpC,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,CAAC;QACH,MAAM,IAAA,mBAAI,EAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,YAAG,CAAC,KAAK,CACP,sCAAuC,GAAiB,CAAC,MAAM,IAAK,GAAa,CAAC,OAAO,EAAE,CAC5F,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,IAAA,gCAAsB,EAAC,gBAAgB,CAAC,CAAC;IACnE,IAAI,WAAW,EAAE,CAAC;QAChB,YAAG,CAAC,KAAK,CAAC,sBAAsB,gBAAgB,UAAU,WAAW,GAAG,CAAC,CAAC;QAC1E,MAAM,IAAA,8BAAoB,EAAC,gBAAgB,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,YAAG,CAAC,KAAK,CAAC,cAAc,gBAAgB,kBAAkB,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAC;QACH,MAAM,IAAA,2BAAgB,EAAC,cAAc,EAAE;YACrC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAC/D,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,gBAAgB,GAAG,MAAM,gCAAgC,EAAE,CAAC;QAClE,MAAM,OAAO,GACX,gBAAgB,CAAC,MAAM,GAAG,CAAC;YACzB,CAAC,CAAC,kEAAkE,OAAO,QAAQ;gBACjF,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9D,CAAC,CAAC,mBAAmB,OAAO,6CAA6C,CAAC;QAC9E,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,GAAG,EAAC,CAAC,CAAC;IACzC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,cAAc;IAC3B,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,gCAAgC,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IACjE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,KAAK,UAAU,gCAAgC;IAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,IAAA,wBAAU,GAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACzD,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;SAC/F,GAAG,CACF,CAAC,GAAG,EAAE,EAAE,CACN,GAAG,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,GAAG,WAAW,GAAG,CAAC,IAAI,wBAAwB,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,CAC/F,CAAC;AACN,CAAC"}

package/build/lib/utils/process.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @param bundleId - The bundle identifier of a running macOS application.
+ * @returns The process ID or null if the application is not running.
+ */
+export declare function getMacAppPidByBundleId(bundleId: string): Promise<string | null>;
+/**
+ * @param bundleId - The bundle identifier of a running macOS application.
+ * @returns True if the kill command succeeded.
+ */
+export declare function killMacAppByBundleId(bundleId: string): Promise<boolean>;
+//# sourceMappingURL=process.d.ts.map

package/build/lib/utils/process.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"process.d.ts","sourceRoot":"","sources":["../../../lib/utils/process.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAsB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CASrF;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAQ7E"}

package/build/lib/utils/process.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMacAppPidByBundleId = getMacAppPidByBundleId;
+exports.killMacAppByBundleId = killMacAppByBundleId;
+const logger_1 = require("../logger");
+const teen_process_1 = require("teen_process");
+/**
+ * @param bundleId - The bundle identifier of a running macOS application.
+ * @returns The process ID or null if the application is not running.
+ */
+async function getMacAppPidByBundleId(bundleId) {
+    let stdout;
+    try {
+        ({ stdout } = await (0, teen_process_1.exec)('lsappinfo', ['info', '-only', 'pid', bundleId]));
+    }
+    catch {
+        return null;
+    }
+    const match = stdout.trim().match(/"pid"=(\d+)/);
+    return match?.[1] ?? null;
+}
+/**
+ * @param bundleId - The bundle identifier of a running macOS application.
+ * @returns True if the kill command succeeded.
+ */
+async function killMacAppByBundleId(bundleId) {
+    try {
+        await (0, teen_process_1.exec)('lsappinfo', ['kill', '-hard', bundleId]);
+        return true;
+    }
+    catch (e) {
+        logger_1.log.debug(`Could not kill '${bundleId}' via lsappinfo: ${e.stderr || e.message}`);
+        return false;
+    }
+}
+//# sourceMappingURL=process.js.map

package/build/lib/utils/process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process.js","sourceRoot":"","sources":["../../../lib/utils/process.ts"],"names":[],"mappings":";;AAOA,wDASC;AAMD,oDAQC;AA9BD,sCAA8B;AAC9B,+CAAkC;AAElC;;;GAGG;AACI,KAAK,UAAU,sBAAsB,CAAC,QAAgB;IAC3D,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,CAAC,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,WAAW,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC3E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACjD,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC5B,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,oBAAoB,CAAC,QAAgB;IACzD,IAAI,CAAC;QACH,MAAM,IAAA,mBAAI,EAAC,WAAW,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,YAAG,CAAC,KAAK,CAAC,mBAAmB,QAAQ,oBAAoB,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAClF,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}

package/build/lib/utils/types.d.ts

@@ -0,0 +1,4 @@
+export interface SimulatorInfoOptions {
+    devicesSetPath?: string | null;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/lib/utils/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../lib/utils/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC"}

package/build/lib/utils/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/lib/utils/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../lib/utils/types.ts"],"names":[],"mappings":""}

package/build/lib/utils/xcode.d.ts

@@ -0,0 +1,23 @@
+import { type XcodeVersion } from 'appium-xcode';
+/**
+ * @param bundleId - The bundle identifier of the Simulator UI client.
+ * @param xcodeVersion - The active Xcode version.
+ * @returns The full path to the UI client app in the active Xcode installation.
+ * @throws {Error} If no matching app is found in the active Xcode folder.
+ */
+export declare function getUiClientAppPath(bundleId: string, xcodeVersion: XcodeVersion): Promise<string>;
+/**
+ * Asserts that the Xcode version meets the minimum supported version requirement.
+ *
+ * @template V - The Xcode version type.
+ * @param xcodeVersion - The Xcode version to check.
+ * @returns The same Xcode version if it meets the requirement.
+ * @throws {Error} If the Xcode version is below the minimum supported version.
+ */
+export declare function assertXcodeVersion<V extends XcodeVersion>(xcodeVersion: V): V;
+/**
+ * @param infoPlistPath - The full path to an Info.plist file.
+ * @returns The bundle identifier or null if it cannot be read.
+ */
+export declare function readBundleIdFromPlist(infoPlistPath: string): Promise<string | null>;
+//# sourceMappingURL=xcode.d.ts.map

package/build/lib/utils/xcode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xcode.d.ts","sourceRoot":"","sources":["../../../lib/utils/xcode.ts"],"names":[],"mappings":"AAGA,OAAO,EAAU,KAAK,YAAY,EAAC,MAAM,cAAc,CAAC;AAGxD;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,MAAM,CAAC,CA2BjB;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAQ7E;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAWzF"}

package/build/lib/utils/xcode.js

@@ -0,0 +1,73 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUiClientAppPath = getUiClientAppPath;
+exports.assertXcodeVersion = assertXcodeVersion;
+exports.readBundleIdFromPlist = readBundleIdFromPlist;
+const support_1 = require("@appium/support");
+const teen_process_1 = require("teen_process");
+const node_path_1 = __importDefault(require("node:path"));
+const appium_xcode_1 = require("appium-xcode");
+const constants_1 = require("./constants");
+/**
+ * @param bundleId - The bundle identifier of the Simulator UI client.
+ * @param xcodeVersion - The active Xcode version.
+ * @returns The full path to the UI client app in the active Xcode installation.
+ * @throws {Error} If no matching app is found in the active Xcode folder.
+ */
+async function getUiClientAppPath(bundleId, xcodeVersion) {
+    const devRoot = await (0, appium_xcode_1.getPath)();
+    const applicationsDir = xcodeVersion.major >= constants_1.MIN_DEVICE_HUB_XCODE_VERSION
+        ? node_path_1.default.resolve(devRoot, '..', 'Applications')
+        : node_path_1.default.resolve(devRoot, 'Applications');
+    if (await support_1.fs.exists(applicationsDir)) {
+        const appPaths = (await support_1.fs.readdir(applicationsDir))
+            .filter((entry) => entry.endsWith('.app'))
+            .map((entry) => node_path_1.default.resolve(applicationsDir, entry));
+        const apps = await Promise.all(appPaths.map(async (appPath) => ({
+            appPath,
+            bundleId: await readBundleIdFromPlist(node_path_1.default.resolve(appPath, 'Contents', 'Info.plist')),
+        })));
+        const match = apps.find((app) => app.bundleId === bundleId);
+        if (match) {
+            return match.appPath;
+        }
+    }
+    throw new Error(`Could not find UI client app with bundle id '${bundleId}' under '${applicationsDir}' ` +
+        `(active Xcode developer root: ${devRoot})`);
+}
+/**
+ * Asserts that the Xcode version meets the minimum supported version requirement.
+ *
+ * @template V - The Xcode version type.
+ * @param xcodeVersion - The Xcode version to check.
+ * @returns The same Xcode version if it meets the requirement.
+ * @throws {Error} If the Xcode version is below the minimum supported version.
+ */
+function assertXcodeVersion(xcodeVersion) {
+    if (xcodeVersion.major < constants_1.MIN_SUPPORTED_XCODE_VERSION) {
+        throw new Error(`Tried to use an iOS simulator with xcode version ${xcodeVersion.versionString} but only Xcode version ` +
+            `${constants_1.MIN_SUPPORTED_XCODE_VERSION} and up are supported`);
+    }
+    return xcodeVersion;
+}
+/**
+ * @param infoPlistPath - The full path to an Info.plist file.
+ * @returns The bundle identifier or null if it cannot be read.
+ */
+async function readBundleIdFromPlist(infoPlistPath) {
+    try {
+        const { stdout } = await (0, teen_process_1.exec)('/usr/libexec/PlistBuddy', [
+            '-c',
+            'print CFBundleIdentifier',
+            infoPlistPath,
+        ]);
+        return stdout.trim() || null;
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=xcode.js.map

package/build/lib/utils/xcode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xcode.js","sourceRoot":"","sources":["../../../lib/utils/xcode.ts"],"names":[],"mappings":";;;;;AAYA,gDA8BC;AAUD,gDAQC;AAMD,sDAWC;AA7ED,6CAAmC;AACnC,+CAAkC;AAClC,0DAA6B;AAC7B,+CAAwD;AACxD,2CAAsF;AAEtF;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CACtC,QAAgB,EAChB,YAA0B;IAE1B,MAAM,OAAO,GAAG,MAAM,IAAA,sBAAO,GAAE,CAAC;IAChC,MAAM,eAAe,GACnB,YAAY,CAAC,KAAK,IAAI,wCAA4B;QAChD,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,cAAc,CAAC;QAC7C,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAE5C,IAAI,MAAM,YAAE,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,CAAC,MAAM,YAAE,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;aACjD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;aACzC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC;QACxD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAC5B,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;YAC/B,OAAO;YACP,QAAQ,EAAE,MAAM,qBAAqB,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;SACvF,CAAC,CAAC,CACJ,CAAC;QACF,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;QAC5D,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,KAAK,CAAC,OAAO,CAAC;QACvB,CAAC;IACH,CAAC;IAED,MAAM,IAAI,KAAK,CACb,gDAAgD,QAAQ,YAAY,eAAe,IAAI;QACrF,iCAAiC,OAAO,GAAG,CAC9C,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAyB,YAAe;IACxE,IAAI,YAAY,CAAC,KAAK,GAAG,uCAA2B,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CACb,oDAAoD,YAAY,CAAC,aAAa,0BAA0B;YACtG,GAAG,uCAA2B,uBAAuB,CACxD,CAAC;IACJ,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,qBAAqB,CAAC,aAAqB;IAC/D,IAAI,CAAC;QACH,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,yBAAyB,EAAE;YACrD,IAAI;YACJ,0BAA0B;YAC1B,aAAa;SACd,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/lib/extensions/settings.ts

@@ -1,4 +1,4 @@
-import {NSUserDefaults, generateDefaultsCommandArgs} from '../defaults-utils';
+import {NSUserDefaults, generateDefaultsCommandArgs} from '../utils';
 import path from 'node:path';
 import {exec} from 'teen_process';
 import AsyncLock from 'async-lock';

package/lib/simulator-xcode-14.ts

@@ -1,12 +1,12 @@
 import {fs, timing, util} from '@appium/support';
 import {waitForCondition, retryInterval} from 'asyncbox';
-import {getDeveloperRoot, SIMULATOR_APP_NAME} from './utils';
+import {getMacAppPidByBundleId, getUiClientAppPath, SIMULATOR_UI_CLIENT_BUNDLE_ID} from './utils';
+import {getPath} from 'appium-xcode';
 import {exec} from 'teen_process';
 import {log as defaultLog} from './logger';
 import EventEmitter from 'node:events';
 import AsyncLock from 'async-lock';
 import path from 'node:path';
-import {getPath as getXcodePath} from 'appium-xcode';
 import {Simctl} from 'node-simctl';
 import * as appExtensions from './extensions/applications';
 import * as biometricExtensions from './extensions/biometric';
@@ -37,7 +37,6 @@ 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
@@ -110,6 +109,7 @@ export class SimulatorXcode14
   private readonly _simctl: Simctl;
   private readonly _xcodeVersion: XcodeVersion;
   private readonly _log: AppiumLogger;
+  private _uiClientAppPath: Promise<string> | undefined;
 
   /**
    * Constructs the object with the `udid` and version of Xcode.
@@ -174,7 +174,7 @@ export class SimulatorXcode14
    * @returns The bundle identifier of the Simulator UI client.
    */
   get uiClientBundleId(): string {
-    return UI_CLIENT_BUNDLE_ID;
+    return SIMULATOR_UI_CLIENT_BUNDLE_ID;
   }
 
   /**
@@ -305,18 +305,11 @@ export class SimulatorXcode14
    * @returns The process ID or null if the UI client is not running.
    */
   async getUIClientPid(): Promise<string | null> {
-    let stdout: string;
-    try {
-      ({stdout} = await exec('pgrep', ['-fn', `${SIMULATOR_APP_NAME}/Contents/MacOS/`]));
-    } catch {
-      return null;
-    }
-    if (isNaN(parseInt(stdout, 10))) {
-      return null;
+    const pid = await getMacAppPidByBundleId(this.uiClientBundleId);
+    if (pid) {
+      this.log.debug(`Got UI client PID: ${pid}`);
     }
-    stdout = stdout.trim();
-    this.log.debug(`Got Simulator UI client PID: ${stdout}`);
-    return stdout;
+    return pid;
   }
 
   /**
@@ -456,14 +449,14 @@ export class SimulatorXcode14
       ...opts,
     };
 
-    const simulatorApp = path.resolve(await getXcodePath(), 'Applications', SIMULATOR_APP_NAME);
-    const args = ['-Fn', simulatorApp];
-    this.log.info(`Starting Simulator UI: ${util.quote(['open', ...args])}`);
+    const uiClientApp = await this._getUiClientAppPath();
+    const args = ['-Fn', uiClientApp];
+    this.log.info(`Starting UI client: ${util.quote(['open', ...args])}`);
     try {
       await exec('open', args, {timeout: startUiOpts.startupTimeout});
     } catch (err: any) {
       throw new Error(
-        `Got an unexpected error while opening Simulator UI: ${err.stderr || err.stdout || err.message}`,
+        `Got an unexpected error while opening UI client: ${err.stderr || err.stdout || err.message}`,
         {cause: err},
       );
     }
@@ -647,7 +640,7 @@ export class SimulatorXcode14
    * @returns The full path to the LaunchDaemons directory.
    */
   async getLaunchDaemonsRoot(): Promise<string> {
-    const devRoot = await getDeveloperRoot();
+    const devRoot = await getPath();
     return path.resolve(
       devRoot,
       'Platforms',
@@ -666,4 +659,11 @@ export class SimulatorXcode14
       'LaunchDaemons',
     );
   }
+
+  private async _getUiClientAppPath(): Promise<string> {
+    if (!this._uiClientAppPath) {
+      this._uiClientAppPath = getUiClientAppPath(this.uiClientBundleId, this.xcodeVersion);
+    }
+    return this._uiClientAppPath;
+  }
 }

package/lib/simulator-xcode-15.ts

@@ -1,6 +1,6 @@
 import {fs} from '@appium/support';
-import {exec} from 'teen_process';
 import path from 'node:path';
+import {readBundleIdFromPlist} from './utils';
 import {SimulatorXcode14} from './simulator-xcode-14';
 
 export class SimulatorXcode15 extends SimulatorXcode14 {
@@ -114,23 +114,12 @@ export class SimulatorXcode15 extends SimulatorXcode14 {
     }
 
     const appsRoot = path.resolve(await this._getSystemRoot(), 'Applications');
-    const fetchBundleId = async (appRoot: string): Promise<string | null> => {
-      const infoPlistPath = path.resolve(appRoot, 'Info.plist');
-      try {
-        const {stdout} = await exec('/usr/libexec/PlistBuddy', [
-          '-c',
-          'print CFBundleIdentifier',
-          infoPlistPath,
-        ]);
-        return stdout.trim();
-      } catch {
-        return null;
-      }
-    };
     const allApps = (await fs.readdir(appsRoot))
       .filter((x) => x.endsWith('.app'))
       .map((x) => path.join(appsRoot, x));
-    const bundleIds = await Promise.all(allApps.map(fetchBundleId));
+    const bundleIds = await Promise.all(
+      allApps.map((appRoot) => readBundleIdFromPlist(path.resolve(appRoot, 'Info.plist'))),
+    );
     this._systemAppBundleIds = new Set(bundleIds.filter((x): x is string => x !== null));
     return this._systemAppBundleIds;
   }

package/lib/simulator-xcode-27.ts

@@ -0,0 +1,9 @@
+import {DEVICE_HUB_UI_CLIENT_BUNDLE_ID} from './utils';
+import {SimulatorXcode15} from './simulator-xcode-15';
+
+export class SimulatorXcode27 extends SimulatorXcode15 {
+  /** @inheritdoc */
+  override get uiClientBundleId(): string {
+    return DEVICE_HUB_UI_CLIENT_BUNDLE_ID;
+  }
+}

package/lib/simulator.ts

@@ -1,6 +1,12 @@
 import {SimulatorXcode14} from './simulator-xcode-14';
 import {SimulatorXcode15} from './simulator-xcode-15';
-import {getSimulatorInfo, assertXcodeVersion, MIN_SUPPORTED_XCODE_VERSION} from './utils';
+import {SimulatorXcode27} from './simulator-xcode-27';
+import {
+  assertXcodeVersion,
+  getSimulatorInfo,
+  MIN_DEVICE_HUB_XCODE_VERSION,
+  MIN_SUPPORTED_XCODE_VERSION,
+} from './utils';
 import * as xcode from 'appium-xcode';
 import {log} from './logger';
 import type {Simulator, SimulatorLookupOptions} from './types';
@@ -38,15 +44,13 @@ export async function getSimulator(
   (logger ?? log).info(
     `Constructing ${platform} simulator for Xcode version ${xcodeVersion.versionString} with udid '${udid}'`,
   );
-  let SimClass: typeof SimulatorXcode14 | typeof SimulatorXcode15;
-  switch (xcodeVersion.major) {
-    case MIN_SUPPORTED_XCODE_VERSION:
-      SimClass = SimulatorXcode14;
-      break;
-    case 15:
-    default:
-      SimClass = SimulatorXcode15;
-      break;
+  let SimClass: typeof SimulatorXcode14 | typeof SimulatorXcode15 | typeof SimulatorXcode27;
+  if (xcodeVersion.major === MIN_SUPPORTED_XCODE_VERSION) {
+    SimClass = SimulatorXcode14;
+  } else if (xcodeVersion.major >= MIN_DEVICE_HUB_XCODE_VERSION) {
+    SimClass = SimulatorXcode27;
+  } else {
+    SimClass = SimulatorXcode15;
   }
 
   const result = new SimClass(udid, xcodeVersion, logger);

package/lib/utils/constants.ts

@@ -0,0 +1,6 @@
+export const SAFARI_STARTUP_TIMEOUT_MS = 25 * 1000;
+export const MOBILE_SAFARI_BUNDLE_ID = 'com.apple.mobilesafari';
+export const SIMULATOR_UI_CLIENT_BUNDLE_ID = 'com.apple.iphonesimulator';
+export const DEVICE_HUB_UI_CLIENT_BUNDLE_ID = 'com.apple.dt.Devices';
+export const MIN_SUPPORTED_XCODE_VERSION = 14;
+export const MIN_DEVICE_HUB_XCODE_VERSION = 27;

package/lib/{defaults-utils.ts → utils/defaults.ts}

@@ -1,6 +1,6 @@
 import {DOMParser, XMLSerializer, type Document, type Element} from '@xmldom/xmldom';
 import {exec} from 'teen_process';
-import {log} from './logger';
+import {log} from '../logger';
 import {util} from '@appium/support';
 
 export class NSUserDefaults {

package/lib/utils/devices.ts

@@ -0,0 +1,25 @@
+import type {SimulatorInfoOptions} from './types';
+import {getDevices} from './get-devices';
+
+/**
+ * @param udid - The simulator UDID.
+ * @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;
+  // see the README for github.com/appium/node-simctl for example output of getDevices()
+  const devices = Object.values(await getDevices({devicesSetPath})).flat();
+  return devices.find((sim: any) => sim.udid === udid);
+}
+
+/**
+ * @param udid - The simulator UDID.
+ * @returns Promise that resolves to true if simulator exists, false otherwise.
+ */
+export async function simExists(udid: string): Promise<boolean> {
+  return !!(await getSimulatorInfo(udid));
+}

package/lib/utils/get-devices.ts

@@ -0,0 +1,10 @@
+import {Simctl} from 'node-simctl';
+import type {StringRecord} from '@appium/types';
+
+/**
+ * @param simctlOpts - Optional simctl options
+ * @returns Promise that resolves to a record of devices grouped by SDK version
+ */
+export async function getDevices(simctlOpts?: StringRecord): Promise<Record<string, any[]>> {
+  return await new Simctl(simctlOpts).getDevices();
+}

package/lib/utils/index.ts

@@ -0,0 +1,15 @@
+export {
+  SAFARI_STARTUP_TIMEOUT_MS,
+  MOBILE_SAFARI_BUNDLE_ID,
+  SIMULATOR_UI_CLIENT_BUNDLE_ID,
+  DEVICE_HUB_UI_CLIENT_BUNDLE_ID,
+  MIN_SUPPORTED_XCODE_VERSION,
+  MIN_DEVICE_HUB_XCODE_VERSION,
+} from './constants';
+export type {SimulatorInfoOptions} from './types';
+export {NSUserDefaults, toXmlArg, generateDefaultsCommandArgs} from './defaults';
+export {getDevices} from './get-devices';
+export {getSimulatorInfo, simExists} from './devices';
+export {getMacAppPidByBundleId} from './process';
+export {assertXcodeVersion, getUiClientAppPath, readBundleIdFromPlist} from './xcode';
+export {killAllSimulators} from './lifecycle';

package/lib/utils/lifecycle.ts

@@ -0,0 +1,78 @@
+import {log} from '../logger';
+import {exec, type ExecError} from 'teen_process';
+import {waitForCondition} from 'asyncbox';
+import {getVersion} from 'appium-xcode';
+import {
+  DEVICE_HUB_UI_CLIENT_BUNDLE_ID,
+  MIN_DEVICE_HUB_XCODE_VERSION,
+  SIMULATOR_UI_CLIENT_BUNDLE_ID,
+} from './constants';
+import {getDevices} from './get-devices';
+import {getMacAppPidByBundleId, killMacAppByBundleId} from './process';
+
+const DEFAULT_SIM_SHUTDOWN_TIMEOUT_MS = 60000;
+
+/**
+ * @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> {
+  log.debug('Killing all iOS Simulators');
+  const xcodeVersion = await getVersion(true);
+  const uiClientBundleId =
+    xcodeVersion.major >= MIN_DEVICE_HUB_XCODE_VERSION
+      ? DEVICE_HUB_UI_CLIENT_BUNDLE_ID
+      : SIMULATOR_UI_CLIENT_BUNDLE_ID;
+
+  const startedMs = performance.now();
+  try {
+    await exec('xcrun', ['simctl', 'shutdown', 'all'], {timeout});
+  } catch (err: unknown) {
+    log.debug(
+      `Failed to shutdown all simulators: ${(err as ExecError).stderr || (err as Error).message}`,
+    );
+  }
+
+  const uiClientPid = await getMacAppPidByBundleId(uiClientBundleId);
+  if (uiClientPid) {
+    log.debug(`Killing UI client '${uiClientBundleId}' (pid ${uiClientPid})`);
+    await killMacAppByBundleId(uiClientBundleId);
+  } else {
+    log.debug(`UI client '${uiClientBundleId}' is not running`);
+  }
+
+  try {
+    await waitForCondition(allSimsAreDown, {
+      waitMs: Math.max(1000, startedMs + timeout - performance.now()),
+      intervalMs: 200,
+    });
+  } catch (err) {
+    const remainingDevices = await getNonShutdownDeviceDescriptions();
+    const message =
+      remainingDevices.length > 0
+        ? `The following devices are still not in the correct state after ${timeout} ms:\n` +
+          remainingDevices.map((device) => `    ${device}`).join('\n')
+        : `Timed out after ${timeout} ms waiting for all simulators to shut down`;
+    throw new Error(message, {cause: err});
+  }
+}
+
+async function allSimsAreDown(): Promise<boolean> {
+  try {
+    return (await getNonShutdownDeviceDescriptions()).length === 0;
+  } catch {
+    return false;
+  }
+}
+
+async function getNonShutdownDeviceDescriptions(): Promise<string[]> {
+  const devices = Object.values(await getDevices()).flat();
+  return devices
+    .filter((sim) => !['shutdown', 'unavailable', 'disconnected'].includes(sim.state.toLowerCase()))
+    .map(
+      (sim) =>
+        `${sim.name} (${sim.sdk}, udid: ${sim.udid}) is still in state '${sim.state.toLowerCase()}'`,
+    );
+}