appium-ios-simulator 7.0.2 → 8.0.0

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [8.0.0](https://github.com/appium/appium-ios-simulator/compare/v7.0.3...v8.0.0) (2025-11-22)
+
+### ⚠ BREAKING CHANGES
+
+* The minimum supported Xcode version is set to 14
+* Removed idb getter and setter from Simulator class
+
+### Features
+
+* Stop supporting Xcode versions below 14 ([#458](https://github.com/appium/appium-ios-simulator/issues/458)) ([8071076](https://github.com/appium/appium-ios-simulator/commit/807107669c69f1b01c14156c548e6f28fbc0470f))
+
+## [7.0.3](https://github.com/appium/appium-ios-simulator/compare/v7.0.2...v7.0.3) (2025-11-15)
+
+### Miscellaneous Chores
+
+* publish via trusted publisher ([#456](https://github.com/appium/appium-ios-simulator/issues/456)) ([8e1f1af](https://github.com/appium/appium-ios-simulator/commit/8e1f1af8b55311641b580b48f0ff28dfecf4fe59))
+
 ## [7.0.2](https://github.com/appium/appium-ios-simulator/compare/v7.0.1...v7.0.2) (2025-10-17)
 
 ### Miscellaneous Chores

package/README.md

@@ -36,7 +36,6 @@ assert.equal('Shutdown', (await sim.stat()).state);
 The following tools and utilities are not mandatory, but could be used by the appium-ios-simulator, if installed locally, to extend its functionality:
 
 - [Mobile Native Foundation](https://github.com/MobileNativeFoundation)
-- [IDB](https://github.com/facebook/idb)
 - [AppleSimulatorUtils](https://github.com/wix/AppleSimulatorUtils)
     - For `contacts`, `camera`, `faceid`, `health`, `homekit`, `notifications`, `speech` and `userTracking` permissions
 

package/build/lib/simulator-xcode-14.d.ts

@@ -1,8 +1,313 @@
-/**
- * @typedef {import('./types').SupportsGeolocation} SupportsGeolocation
- */
-export class SimulatorXcode14 extends SimulatorXcode11_4 {
+import EventEmitter from 'events';
+import { Simctl } from 'node-simctl';
+import * as appExtensions from './extensions/applications';
+import * as biometricExtensions from './extensions/biometric';
+import * as safariExtensions from './extensions/safari';
+import * as settingsExtensions from './extensions/settings';
+import * as permissionsExtensions from './extensions/permissions';
+import * as miscExtensions from './extensions/misc';
+import type { CoreSimulator, HasSettings, InteractsWithApps, InteractsWithKeychain, SupportsGeolocation, HasMiscFeatures, InteractsWithSafariBrowser, SupportsBiometric, DeviceStat, ShutdownOptions, RunOptions, StartUiClientOptions, KillUiClientOptions, ProcessInfo, CertificateOptions } from './types';
+import type { XcodeVersion } from 'appium-xcode';
+import type { AppiumLogger, StringRecord } from '@appium/types';
+export declare 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;
+    private readonly _udid;
+    private readonly _simctl;
+    private readonly _xcodeVersion;
+    private readonly _log;
+    /**
+     * Constructs the object with the `udid` and version of Xcode.
+     * Use the exported `getSimulator(udid)` method instead.
+     *
+     * @param udid - The Simulator ID.
+     * @param xcodeVersion - The target Xcode version in format {major, minor, build}.
+     * @param log - Optional logger instance.
+     */
+    constructor(udid: string, xcodeVersion: XcodeVersion, log?: AppiumLogger | null);
+    /**
+     * @returns The unique device identifier (UDID) of the simulator.
+     */
+    get udid(): string;
+    /**
+     * @returns The Simctl instance for interacting with the simulator.
+     */
+    get simctl(): Simctl;
+    /**
+     * @returns The Xcode version information.
+     */
+    get xcodeVersion(): XcodeVersion;
+    /**
+     * @returns The full path to the keychain directory for this simulator.
+     */
+    get keychainPath(): string;
+    /**
+     * @returns The logger instance used by this simulator.
+     */
+    get log(): AppiumLogger;
+    /**
+     * @returns The bundle identifier of the Simulator UI client.
+     */
+    get uiClientBundleId(): string;
+    /**
+     * @returns The maximum number of milliseconds to wait until Simulator booting is completed.
+     */
+    get startupTimeout(): number;
+    /**
+     * @returns The full path to the devices set where the current simulator is located.
+     * `null` value means that the default path is used.
+     */
+    get devicesSetPath(): string | null;
+    /**
+     * Set the full path to the devices set. It is recommended to set this value
+     * once right after Simulator instance is created and to not change it during
+     * the instance lifecycle.
+     *
+     * @param value - The full path to the devices set root on the local file system.
+     */
+    set devicesSetPath(value: string | null);
+    /**
+     * Retrieve the full path to the directory where Simulator stuff is located.
+     *
+     * @returns The path string.
+     */
+    getRootDir(): string;
+    /**
+     * Retrieve the full path to the directory where Simulator applications data is located.
+     *
+     * @returns The path string.
+     */
+    getDir(): string;
+    /**
+     * Retrieve the full path to the directory where Simulator logs are stored.
+     *
+     * @returns The path string.
+     */
+    getLogDir(): string;
+    /**
+     * Get the state and specifics of this simulator.
+     *
+     * @returns Simulator stats mapping, for example:
+     * { name: 'iPhone 4s',
+     *   udid: 'C09B34E5-7DCB-442E-B79C-AB6BC0357417',
+     *   state: 'Shutdown',
+     *   sdk: '8.3'
+     * }
+     */
+    stat(): Promise<DeviceStat | StringRecord<never>>;
+    /**
+     * Check if the Simulator has been booted at least once
+     * and has not been erased before.
+     *
+     * @returns True if the current Simulator has never been started before.
+     */
+    isFresh(): Promise<boolean>;
+    /**
+     * Retrieves the state of the current Simulator. One should distinguish the
+     * states of Simulator UI and the Simulator itself.
+     *
+     * @returns True if the current Simulator is running.
+     */
+    isRunning(): Promise<boolean>;
+    /**
+     * Checks if the simulator is in shutdown state.
+     * This method is necessary, because Simulator might also be
+     * in the transitional Shutting Down state right after the `shutdown`
+     * command has been issued.
+     *
+     * @returns True if the current Simulator is shut down.
+     */
+    isShutdown(): Promise<boolean>;
+    /**
+     * Retrieves the current process id of the UI client.
+     *
+     * @returns The process ID or null if the UI client is not running.
+     */
+    getUIClientPid(): Promise<string | null>;
+    /**
+     * Check the state of Simulator UI client.
+     *
+     * @returns True if UI client is running or false otherwise.
+     */
+    isUIClientRunning(): Promise<boolean>;
+    /**
+     * Get the platform version of the current Simulator.
+     *
+     * @returns SDK version, for example '18.3'.
+     */
+    getPlatformVersion(): Promise<string>;
+    /**
+     * Boots Simulator if not already booted.
+     * Does nothing if it is already running.
+     * This API does NOT wait until Simulator is fully booted.
+     *
+     * @throws {Error} If there was a failure while booting the Simulator.
+     */
+    boot(): Promise<void>;
+    /**
+     * Verify whether the Simulator booting is completed and/or wait for it
+     * until the timeout expires.
+     *
+     * @param startupTimeout - The number of milliseconds to wait until booting is completed.
+     */
+    waitForBoot(startupTimeout: number): Promise<void>;
+    /**
+     * Reset the current Simulator to the clean state.
+     * It is expected the simulator is in shutdown state when this API is called.
+     */
+    clean(): Promise<void>;
+    /**
+     * Delete the particular Simulator from devices list.
+     */
+    delete(): Promise<void>;
+    /**
+     * Shut down the current Simulator.
+     *
+     * @param opts - Shutdown options including timeout.
+     * @throws {Error} If Simulator fails to transition into Shutdown state after
+     * the given timeout.
+     */
+    shutdown(opts?: ShutdownOptions): Promise<void>;
+    /**
+     * Boots simulator and opens simulators UI Client if not already opened.
+     * In xcode 11.4, UI Client must be first launched, otherwise
+     * sim window stays minimized
+     *
+     * @param isUiClientRunning - whether the simulator UI client is already running.
+     * @param opts - arguments to start simulator UI client with.
+     */
+    launchWindow(isUiClientRunning: boolean, opts?: RunOptions): Promise<void>;
+    /**
+     * Start the Simulator UI client with the given arguments.
+     *
+     * @param opts - Simulator startup options.
+     */
+    startUIClient(opts?: StartUiClientOptions): Promise<void>;
+    /**
+     * Executes given Simulator with options. The Simulator will not be restarted if
+     * it is already running and the current UI state matches to `isHeadless` option.
+     *
+     * @param opts - One or more of available Simulator options.
+     */
+    run(opts?: RunOptions): Promise<void>;
+    /**
+     * Kill the UI client if it is running.
+     *
+     * @param opts - Options including process ID and signal number.
+     * @returns True if the UI client was successfully killed or false
+     *                   if it is not running.
+     * @throws {Error} If sending the signal to the client process fails.
+     */
+    killUIClient(opts?: KillUiClientOptions): Promise<boolean>;
+    /**
+     * Lists processes that are currently running on the given Simulator.
+     * The simulator must be in running state in order for this
+     * method to work properly.
+     *
+     * @returns The list of retrieved process information.
+     * @throws {Error} If no process information could be retrieved.
+     */
+    ps(): Promise<ProcessInfo[]>;
+    /**
+     * @returns The full path to the LaunchDaemons directory.
+     */
+    getLaunchDaemonsRoot(): Promise<string>;
+    /**
+     * Sets the geolocation for the simulator.
+     *
+     * @param latitude - The latitude coordinate.
+     * @param longitude - The longitude coordinate.
+     * @returns True if the geolocation was set successfully.
+     */
+    setGeolocation: (latitude: string | number, longitude: string | number) => Promise<boolean>;
+    /**
+     * Clears Keychains for the particular simulator in runtime (there is no need to stop it).
+     *
+     * @returns
+     * @throws {Error} If keychain cleanup has failed.
+     */
+    clearKeychains: () => Promise<void>;
+    /**
+     * Adds the given certificate to the booted simulator.
+     * The simulator could be in both running and shutdown states
+     * in order for this method to run as expected.
+     *
+     * @since Xcode 11.4
+     * @param payload the content of the PEM certificate
+     * @param opts Certificate options
+     * @returns True if the certificate was added successfully.
+     */
+    addCertificate: (payload: string, opts?: CertificateOptions) => Promise<boolean>;
+    /**
+     * Simulates push notification delivery to the booted simulator
+     *
+     * @since Xcode SDK 11.4
+     * @param payload - The object that describes Apple push notification content.
+     * It must contain a top-level "Simulator Target Bundle" key with a string value matching
+     * the target application's bundle identifier and "aps" key with valid Apple Push Notification values.
+     * For example:
+     * {
+     *   "Simulator Target Bundle": "com.apple.Preferences",
+     *   "aps": {
+     *     "alert": "This is a simulated notification!",
+     *     "badge": 3,
+     *     "sound": "default"
+     *   }
+     * }
+     */
+    pushNotification: (payload: StringRecord) => Promise<void>;
+    /**
+     * Sets UI appearance style.
+     * This function can only be called on a booted simulator.
+     *
+     * @since Xcode SDK 11.4
+     * @param value one of possible appearance values:
+     * - dark: to switch to the Dark mode
+     * - light: to switch to the Light mode
+     */
+    setAppearance: (value: string) => Promise<void>;
+    /**
+     * Gets the current UI appearance style
+     * This function can only be called on a booted simulator.
+     *
+     * @since Xcode SDK 11.4
+     * @returns the current UI appearance style.
+     * Possible values are:
+     * - dark: to switch to the Dark mode
+     * - light: to switch to the Light mode
+     */
+    getAppearance: () => Promise<string>;
+    installApp: typeof appExtensions.installApp;
+    getUserInstalledBundleIdsByBundleName: typeof appExtensions.getUserInstalledBundleIdsByBundleName;
+    isAppInstalled: typeof appExtensions.isAppInstalled;
+    removeApp: typeof appExtensions.removeApp;
+    launchApp: typeof appExtensions.launchApp;
+    terminateApp: typeof appExtensions.terminateApp;
+    isAppRunning: typeof appExtensions.isAppRunning;
+    scrubApp: typeof appExtensions.scrubApp;
+    openUrl: typeof safariExtensions.openUrl;
+    scrubSafari: typeof safariExtensions.scrubSafari;
+    updateSafariSettings: typeof safariExtensions.updateSafariSettings;
+    getWebInspectorSocket: () => Promise<string | null>;
+    isBiometricEnrolled: typeof biometricExtensions.isBiometricEnrolled;
+    enrollBiometric: typeof biometricExtensions.enrollBiometric;
+    sendBiometricMatch: typeof biometricExtensions.sendBiometricMatch;
+    backupKeychains: () => Promise<boolean>;
+    restoreKeychains: (excludePatterns: string[]) => Promise<boolean>;
+    shake: typeof miscExtensions.shake;
+    setPermission: typeof permissionsExtensions.setPermission;
+    setPermissions: typeof permissionsExtensions.setPermissions;
+    getPermission: typeof permissionsExtensions.getPermission;
+    updateSettings: typeof settingsExtensions.updateSettings;
+    setIncreaseContrast: typeof settingsExtensions.setIncreaseContrast;
+    getIncreaseContrast: typeof settingsExtensions.getIncreaseContrast;
+    setContentSize: typeof settingsExtensions.setContentSize;
+    getContentSize: typeof settingsExtensions.getContentSize;
+    configureLocalization: typeof settingsExtensions.configureLocalization;
+    setAutoFillPasswords: typeof settingsExtensions.setAutoFillPasswords;
+    setReduceMotion: typeof settingsExtensions.setReduceMotion;
+    setReduceTransparency: typeof settingsExtensions.setReduceTransparency;
+    disableKeyboardIntroduction: typeof settingsExtensions.disableKeyboardIntroduction;
 }
-export type SupportsGeolocation = import("./types").SupportsGeolocation;
-import { SimulatorXcode11_4 } from './simulator-xcode-11.4';
 //# sourceMappingURL=simulator-xcode-14.d.ts.map

package/build/lib/simulator-xcode-14.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"simulator-xcode-14.d.ts","sourceRoot":"","sources":["../../lib/simulator-xcode-14.js"],"names":[],"mappings":"AAEA;;GAEG;AAEH;CAYC;kCAfY,OAAO,SAAS,EAAE,mBAAmB;mCAHf,wBAAwB"}
+{"version":3,"file":"simulator-xcode-14.d.ts","sourceRoot":"","sources":["../../lib/simulator-xcode-14.ts"],"names":[],"mappings":"AAKA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAMlC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,KAAK,aAAa,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,mBAAmB,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAC;AAExD,OAAO,KAAK,kBAAkB,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,qBAAqB,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,0BAA0B,EAC1B,iBAAiB,EACjB,UAAU,EACV,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,mBAAmB,EACnB,WAAW,EACX,kBAAkB,EACnB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAOhE,qBAAa,gBAAiB,SAAQ,YAAa,YACjD,aAAa,EACb,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,0BAA0B,EAC1B,iBAAiB;IACjB,oBAAoB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAChD,gBAAgB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC5C,mBAAmB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;IAC7C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAe;IAEpC;;;;;;;OAOG;gBACS,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,GAAE,YAAY,GAAG,IAAW;IAgBrF;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,YAAY,CAE/B;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,YAAY,CAEtB;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED;;;OAGG;IACH,IAAI,cAAc,IAAI,MAAM,GAAG,IAAI,CAElC;IAED;;;;;;OAMG;IACH,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAEtC;IAED;;;;OAIG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;OAIG;IACH,MAAM,IAAI,MAAM;IAIhB;;;;OAIG;IACH,SAAS,IAAI,MAAM;IAInB;;;;;;;;;OASG;IACG,IAAI,IAAI,OAAO,CAAC,UAAU,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IAcvD;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAOjC;;;;;OAKG;IACG,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IASnC;;;;;;;OAOG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IASpC;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAe9C;;;;OAIG;IACG,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC;IAI3C;;;;OAIG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAQ3C;;;;;;OAMG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA4B3B;;;;;OAKG;IACG,WAAW,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxD;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAK5B;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;;;;;OAMG;IACG,QAAQ,CAAC,IAAI,GAAE,eAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBzD;;;;;;;OAOG;IACG,YAAY,CAAC,iBAAiB,EAAE,OAAO,EAAE,IAAI,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IASpF;;;;OAIG;IACG,aAAa,CAAC,IAAI,GAAE,oBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBnE;;;;;OAKG;IACG,GAAG,CAAC,IAAI,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAkE/C;;;;;;;OAOG;IACG,YAAY,CAAC,IAAI,GAAE,mBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBpE;;;;;;;OAOG;IACG,EAAE,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAmDlC;;OAEG;IACG,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC;IAqB7C;;;;;;OAMG;IACH,cAAc,GAAU,UAAU,MAAM,GAAG,MAAM,EAAE,WAAW,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC,CAG9F;IAEF;;;;;OAKG;IACH,cAAc,QAAa,OAAO,CAAC,IAAI,CAAC,CAEtC;IAEF;;;;;;;;;OASG;IACH,cAAc,GAAU,SAAS,MAAM,EAAE,OAAM,kBAAuB,KAAG,OAAO,CAAC,OAAO,CAAC,CAOvF;IAEF;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,GAAU,SAAS,YAAY,KAAG,OAAO,CAAC,IAAI,CAAC,CAE7D;IAEF;;;;;;;;OAQG;IACH,aAAa,GAAU,OAAO,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC,CAElD;IAEF;;;;;;;;;OASG;IACH,aAAa,QAAa,OAAO,CAAC,MAAM,CAAC,CAAsC;IAG/E,UAAU,kCAA4B;IACtC,qCAAqC,6DAAuD;IAC5F,cAAc,sCAAgC;IAC9C,SAAS,iCAA2B;IACpC,SAAS,iCAA2B;IACpC,YAAY,oCAA8B;IAC1C,YAAY,oCAA8B;IAC1C,QAAQ,gCAA0B;IAElC,OAAO,kCAA4B;IACnC,WAAW,sCAAgC;IAC3C,oBAAoB,+CAAyC;IAC7D,qBAAqB,EAAwD,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE1G,mBAAmB,iDAA2C;IAC9D,eAAe,6CAAuC;IACtD,kBAAkB,gDAA0C;IAE5D,eAAe,EAAoD,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1F,gBAAgB,EAAqD,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAErH,KAAK,8BAAwB;IAE7B,aAAa,6CAAuC;IACpD,cAAc,8CAAwC;IACtD,aAAa,6CAAuC;IAEpD,cAAc,2CAAqC;IACnD,mBAAmB,gDAA0C;IAC7D,mBAAmB,gDAA0C;IAC7D,cAAc,2CAAqC;IACnD,cAAc,2CAAqC;IACnD,qBAAqB,kDAA4C;IACjE,oBAAoB,iDAA2C;IAC/D,eAAe,4CAAsC;IACrD,qBAAqB,kDAA4C;IACjE,2BAA2B,wDAAkD;CAC9E"}