@appium/coresim 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright OpenJS Foundation and other contributors, https://openjsf.org/
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,66 @@
+# @appium/coresim
+
+Fast, native control of the iOS/tvOS/watchOS/visionOS Simulator from Node.js — no `simctl`
+subprocess, no CLI output to parse.
+
+## Why
+
+Most tools drive the Simulator by shelling out to `simctl` and parsing its text output.
+`@appium/coresim` talks to the same underlying system directly, in-process. That means:
+
+- **Faster** — no process spawn per call.
+- **More reliable** — real errors instead of scraped stderr strings.
+- **Async by design** — every call returns a `Promise` and never blocks your app.
+
+## Install
+
+```sh
+npm install @appium/coresim
+```
+
+Works on any platform to install, but simulator control requires **macOS**. On other platforms
+(or when the Simulator isn't available), calls reject with a clear `NativeSimUnavailableError`
+instead of crashing.
+
+## Usage
+
+```ts
+import {NativeSimctl} from '@appium/coresim';
+
+const sim = new NativeSimctl();
+
+const devices = await sim.getDevices();
+console.log(devices.map((d) => `${d.name} (${d.state})`));
+
+const device = await sim.createDevice(
+  'My Test Device',
+  'com.apple.CoreSimulator.SimDeviceType.iPhone-15',
+  'com.apple.CoreSimulator.SimRuntime.iOS-17-4',
+);
+
+await sim.bootDevice(device.udid);
+await sim.waitForBoot(device.udid); // waits until the simulator is fully ready, not just "booted"
+
+await sim.installApp(device.udid, '/path/to/MyApp.app');
+await sim.launchApp(device.udid, 'com.example.MyApp');
+
+await sim.shutdownDevice(device.udid);
+await sim.deleteDevice(device.udid);
+```
+
+## What it can do
+
+- **Devices** — list, create, delete, boot, shut down, and erase simulators; check real boot
+  readiness with `getBootStatus()`/`waitForBoot()`.
+- **Apps** — install, remove, launch, terminate, and inspect apps.
+- **Processes** — spawn a process on the simulator and stream its stdout/stderr live.
+- **Simulator settings** — appearance (light/dark), accessibility (increase contrast, content
+  size), location, and permissions.
+- **Extras** — keychain certificates, push notifications, and Darwin notifications.
+
+## Status
+
+Early stage: core device and app lifecycle is implemented and tested; broader coverage is in
+progress.
+
+See [`CLAUDE.md`](./CLAUDE.md) for architecture details.

package/binding.gyp

@@ -0,0 +1,53 @@
+{
+  "targets": [
+    {
+      "target_name": "coresim",
+      "sources": [
+        "src/coresim.mm",
+        "src/native/objc_runtime.mm",
+        "src/native/nserror_bridge.mm",
+        "src/native/value_bridge.mm",
+        "src/native/sim_service_context.mm",
+        "src/native/sim_device_set.mm",
+        "src/native/sim_device.mm",
+        "src/native/tcc_privacy.mm",
+        "src/native/sim_pasteboard.mm",
+        "src/native/sim_process.mm",
+        "src/native/sim_screenshot.mm"
+      ],
+      "include_dirs": [
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      "dependencies": [
+        "<!(node -p \"require('node-addon-api').gyp\")"
+      ],
+      "cflags!": ["-fno-exceptions"],
+      "cflags_cc!": ["-fno-exceptions"],
+      "defines": ["NAPI_CPP_EXCEPTIONS", "NAPI_VERSION=8"],
+      "xcode_settings": {
+        "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
+        "GCC_ENABLE_OBJC_EXCEPTIONS": "YES",
+        "CLANG_ENABLE_OBJC_ARC": "YES",
+        "CLANG_CXX_LIBRARY": "libc++",
+        "CLANG_CXX_LANGUAGE_STANDARD": "c++17",
+        "MACOSX_DEPLOYMENT_TARGET": "12.0",
+        "GCC_OPTIMIZATION_LEVEL": "3",
+        "GCC_TREAT_WARNINGS_AS_ERRORS": "YES",
+        "WARNING_CFLAGS": [
+          "-Wall",
+          "-Wextra",
+          "-Wno-unused-parameter"
+        ],
+        "OTHER_CPLUSPLUSFLAGS": ["-O3", "-fPIC", "-fobjc-arc"],
+        "OTHER_LDFLAGS": [
+          "-framework", "Foundation",
+          "-framework", "AppKit",
+          "-framework", "CoreImage",
+          "-framework", "ImageIO",
+          "-framework", "IOSurface",
+          "-lsqlite3"
+        ]
+      }
+    }
+  ]
+}

package/lib/src/commands/app.d.ts

@@ -0,0 +1,88 @@
+import type { NativeSimctl } from '../native-simctl.js';
+declare module '../native-simctl.js' {
+    interface NativeSimctl {
+        installApp(udid: string, appPath: string, options?: Record<string, unknown>): Promise<void>;
+        removeApp(udid: string, bundleId: string, options?: Record<string, unknown>): Promise<void>;
+        launchApp(udid: string, bundleId: string, options?: Record<string, unknown>): Promise<number>;
+        terminateApp(udid: string, bundleId: string): Promise<void>;
+        isAppInstalled(udid: string, bundleId: string): Promise<boolean>;
+        appInfo(udid: string, bundleId: string): Promise<Record<string, unknown>>;
+        installedApps(udid: string): Promise<Record<string, unknown>>;
+        getAppContainer(udid: string, bundleId: string, containerType?: AppContainerType | string): Promise<string>;
+    }
+}
+/**
+ * Which of an app's on-disk containers {@link getAppContainer} should resolve — `'app'` (the
+ * `.app` bundle itself), `'data'` (its data container), `'groups'` (its sole App Group container,
+ * if it has exactly one), or any other string naming a specific App Group identifier.
+ */
+export type AppContainerType = 'app' | 'data' | 'groups';
+/**
+ * Installs an `.app` bundle onto the given device.
+ *
+ * @param udid — UDID of the target device
+ * @param appPath — path to the `.app` bundle on disk
+ * @param options — passed through to `installApplication:withOptions:error:`
+ */
+export declare function installApp(this: NativeSimctl, udid: string, appPath: string, options?: Record<string, unknown>): Promise<void>;
+/**
+ * Uninstalls an app from the given device.
+ *
+ * @param udid — UDID of the target device
+ * @param bundleId — bundle identifier of the app to remove
+ * @param options — passed through to `uninstallApplication:withOptions:error:`
+ */
+export declare function removeApp(this: NativeSimctl, udid: string, bundleId: string, options?: Record<string, unknown>): Promise<void>;
+/**
+ * Launches an installed app on the given device.
+ *
+ * @param udid — UDID of the target device
+ * @param bundleId — bundle identifier of the app to launch
+ * @param options — passed through to `launchApplicationWithID:options:error:`
+ * @returns the launched process's pid
+ */
+export declare function launchApp(this: NativeSimctl, udid: string, bundleId: string, options?: Record<string, unknown>): Promise<number>;
+/**
+ * @param udid — UDID of the target device
+ * @param bundleId — bundle identifier of the app to terminate
+ */
+export declare function terminateApp(this: NativeSimctl, udid: string, bundleId: string): Promise<void>;
+/**
+ * @param udid — UDID of the device to check
+ * @param bundleId — bundle identifier to look up
+ * @returns whether an app with that bundle identifier is installed
+ */
+export declare function isAppInstalled(this: NativeSimctl, udid: string, bundleId: string): Promise<boolean>;
+/**
+ * @param udid — UDID of the device to read from
+ * @param bundleId — bundle identifier of the installed app
+ * @returns the app's properties, as reported by `propertiesOfApplication:`
+ */
+export declare function appInfo(this: NativeSimctl, udid: string, bundleId: string): Promise<Record<string, unknown>>;
+/**
+ * @param udid — UDID of the device to read from
+ * @returns every installed app's properties, keyed by bundle identifier
+ */
+export declare function installedApps(this: NativeSimctl, udid: string): Promise<Record<string, unknown>>;
+/**
+ * Resolves the full filesystem path to one of an installed app's on-disk containers — the same
+ * paths {@link appInfo}'s `Path`/`DataContainer`/`GroupContainers` fields already carry, just
+ * picked out and normalized to a plain path (no new native call).
+ *
+ * @example
+ * // Resolve a specific App Group container by its identifier (see appInfo's GroupContainers
+ * // field, or catch the error thrown below, to discover which identifiers an app has)
+ * const groupPath = await sim.getAppContainer(udid, bundleId, 'group.com.example.myapp');
+ *
+ * @param udid — UDID of the (booted) device to read from
+ * @param bundleId — bundle identifier of the installed app
+ * @param containerType — see {@link AppContainerType}; defaults to `'app'`
+ * @returns the resolved container's path
+ * @throws if the requested container doesn't exist (e.g. `'data'` before the device has booted
+ * once with the app installed), if `'groups'` is ambiguous (more than one App Group container —
+ * pass the specific group identifier instead), or if a given group identifier doesn't match any
+ * of the app's App Group containers — in both of the latter cases, the error message lists the
+ * app's actual App Group identifiers
+ */
+export declare function getAppContainer(this: NativeSimctl, udid: string, bundleId: string, containerType?: AppContainerType | string): Promise<string>;
+//# sourceMappingURL=app.d.ts.map

package/lib/src/commands/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/commands/app.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAGtD,OAAO,QAAQ,qBAAqB,CAAC;IACnC,UAAU,YAAY;QACpB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5F,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5F,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9F,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5D,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QACjE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC1E,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC9D,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;KAC7G;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEzD;;;;;;GAMG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;GAMG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpG;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAEzG;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAElH;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAEtG;AAUD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,eAAe,CACnC,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,aAAa,GAAE,gBAAgB,GAAG,MAAc,GAC/C,OAAO,CAAC,MAAM,CAAC,CA4CjB"}

package/lib/src/commands/app.js

@@ -0,0 +1,133 @@
+import { fileURLToPath } from 'node:url';
+import { runCatchingAsync } from '../utils/index.js';
+/**
+ * Installs an `.app` bundle onto the given device.
+ *
+ * @param udid — UDID of the target device
+ * @param appPath — path to the `.app` bundle on disk
+ * @param options — passed through to `installApplication:withOptions:error:`
+ */
+export async function installApp(udid, appPath, options = {}) {
+    return runCatchingAsync(async () => (await this._findDevice(udid)).installApp(appPath, options));
+}
+/**
+ * Uninstalls an app from the given device.
+ *
+ * @param udid — UDID of the target device
+ * @param bundleId — bundle identifier of the app to remove
+ * @param options — passed through to `uninstallApplication:withOptions:error:`
+ */
+export async function removeApp(udid, bundleId, options = {}) {
+    return runCatchingAsync(async () => (await this._findDevice(udid)).uninstallApp(bundleId, options));
+}
+/**
+ * Launches an installed app on the given device.
+ *
+ * @param udid — UDID of the target device
+ * @param bundleId — bundle identifier of the app to launch
+ * @param options — passed through to `launchApplicationWithID:options:error:`
+ * @returns the launched process's pid
+ */
+export async function launchApp(udid, bundleId, options = {}) {
+    return runCatchingAsync(async () => (await this._findDevice(udid)).launchApp(bundleId, options));
+}
+/**
+ * @param udid — UDID of the target device
+ * @param bundleId — bundle identifier of the app to terminate
+ */
+export async function terminateApp(udid, bundleId) {
+    return runCatchingAsync(async () => (await this._findDevice(udid)).terminateApp(bundleId));
+}
+/**
+ * @param udid — UDID of the device to check
+ * @param bundleId — bundle identifier to look up
+ * @returns whether an app with that bundle identifier is installed
+ */
+export async function isAppInstalled(udid, bundleId) {
+    return runCatchingAsync(async () => bundleId in (await (await this._findDevice(udid)).installedApps()));
+}
+/**
+ * @param udid — UDID of the device to read from
+ * @param bundleId — bundle identifier of the installed app
+ * @returns the app's properties, as reported by `propertiesOfApplication:`
+ */
+export async function appInfo(udid, bundleId) {
+    return runCatchingAsync(async () => (await this._findDevice(udid)).propertiesOfApplication(bundleId));
+}
+/**
+ * @param udid — UDID of the device to read from
+ * @returns every installed app's properties, keyed by bundle identifier
+ */
+export async function installedApps(udid) {
+    return runCatchingAsync(async () => (await this._findDevice(udid)).installedApps());
+}
+/** Converts a `file://` URL string (as `appInfo`'s container fields report) to a plain fs path. */
+function toFsPath(fileUrl) {
+    if (typeof fileUrl !== 'string') {
+        return undefined;
+    }
+    return fileURLToPath(fileUrl).replace(/\/$/, '');
+}
+/**
+ * Resolves the full filesystem path to one of an installed app's on-disk containers — the same
+ * paths {@link appInfo}'s `Path`/`DataContainer`/`GroupContainers` fields already carry, just
+ * picked out and normalized to a plain path (no new native call).
+ *
+ * @example
+ * // Resolve a specific App Group container by its identifier (see appInfo's GroupContainers
+ * // field, or catch the error thrown below, to discover which identifiers an app has)
+ * const groupPath = await sim.getAppContainer(udid, bundleId, 'group.com.example.myapp');
+ *
+ * @param udid — UDID of the (booted) device to read from
+ * @param bundleId — bundle identifier of the installed app
+ * @param containerType — see {@link AppContainerType}; defaults to `'app'`
+ * @returns the resolved container's path
+ * @throws if the requested container doesn't exist (e.g. `'data'` before the device has booted
+ * once with the app installed), if `'groups'` is ambiguous (more than one App Group container —
+ * pass the specific group identifier instead), or if a given group identifier doesn't match any
+ * of the app's App Group containers — in both of the latter cases, the error message lists the
+ * app's actual App Group identifiers
+ */
+export async function getAppContainer(udid, bundleId, containerType = 'app') {
+    return runCatchingAsync(async () => {
+        const info = await this.appInfo(udid, bundleId);
+        if (containerType === 'app') {
+            const path = info.Path;
+            if (typeof path !== 'string') {
+                throw new Error(`No app bundle path was reported for '${bundleId}'`);
+            }
+            return path;
+        }
+        if (containerType === 'data') {
+            const path = toFsPath(info.DataContainer);
+            if (!path) {
+                throw new Error(`No data container was found for '${bundleId}' — has the device been booted since install?`);
+            }
+            return path;
+        }
+        const groupContainers = (info.GroupContainers ?? {});
+        if (containerType === 'groups') {
+            const entries = Object.entries(groupContainers);
+            if (entries.length === 0) {
+                throw new Error(`'${bundleId}' has no App Group containers`);
+            }
+            if (entries.length > 1) {
+                throw new Error(`'${bundleId}' has multiple App Group containers (${Object.keys(groupContainers).join(', ')}) — ` +
+                    `specify one by its group identifier instead of 'groups'`);
+            }
+            const path = toFsPath(entries[0][1]);
+            if (!path) {
+                throw new Error(`'${bundleId}''s App Group container has no reported path`);
+            }
+            return path;
+        }
+        const path = toFsPath(groupContainers[containerType]);
+        if (!path) {
+            const available = Object.keys(groupContainers);
+            const availability = available.length > 0 ? `available: ${available.join(', ')}` : 'it has no App Group containers at all';
+            throw new Error(`'${bundleId}' has no App Group container with identifier '${containerType}' — ${availability}`);
+        }
+        return path;
+    });
+}
+//# sourceMappingURL=app.js.map

package/lib/src/commands/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../../src/commands/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AAGvC,OAAO,EAAC,gBAAgB,EAAC,MAAM,mBAAmB,CAAC;AAsBnD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAE9B,IAAY,EACZ,OAAe,EACf,UAAmC,EAAE;IAErC,OAAO,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AACnG,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAE7B,IAAY,EACZ,QAAgB,EAChB,UAAmC,EAAE;IAErC,OAAO,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AACtG,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAE7B,IAAY,EACZ,QAAgB,EAChB,UAAmC,EAAE;IAErC,OAAO,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AACnG,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAqB,IAAY,EAAE,QAAgB;IACnF,OAAO,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AAC7F,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAqB,IAAY,EAAE,QAAgB;IACrF,OAAO,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;AAC1G,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAqB,IAAY,EAAE,QAAgB;IAC9E,OAAO,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC;AACxG,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAqB,IAAY;IAClE,OAAO,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC;AACtF,CAAC;AAED,mGAAmG;AACnG,SAAS,QAAQ,CAAC,OAAgB;IAChC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAEnC,IAAY,EACZ,QAAgB,EAChB,gBAA2C,KAAK;IAEhD,OAAO,gBAAgB,CAAC,KAAK,IAAI,EAAE;QACjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAChD,IAAI,aAAa,KAAK,KAAK,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;YACvB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,wCAAwC,QAAQ,GAAG,CAAC,CAAC;YACvE,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,aAAa,KAAK,MAAM,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC1C,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,oCAAoC,QAAQ,+CAA+C,CAAC,CAAC;YAC/G,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,eAAe,GAAG,CAAC,IAAI,CAAC,eAAe,IAAI,EAAE,CAA4B,CAAC;QAChF,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YAChD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,IAAI,QAAQ,+BAA+B,CAAC,CAAC;YAC/D,CAAC;YACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,KAAK,CACb,IAAI,QAAQ,wCAAwC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;oBAC/F,yDAAyD,CAC5D,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACrC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,IAAI,QAAQ,8CAA8C,CAAC,CAAC;YAC9E,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC/C,MAAM,YAAY,GAChB,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,uCAAuC,CAAC;YACxG,MAAM,IAAI,KAAK,CAAC,IAAI,QAAQ,iDAAiD,aAAa,OAAO,YAAY,EAAE,CAAC,CAAC;QACnH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC"}

package/lib/src/commands/biometric.d.ts

@@ -0,0 +1,33 @@
+import type { NativeSimctl } from '../native-simctl.js';
+declare module '../native-simctl.js' {
+    interface NativeSimctl {
+        isBiometricEnrolled(udid: string): Promise<boolean>;
+        enrollBiometric(udid: string, isEnabled?: boolean): Promise<void>;
+        sendBiometricMatch(udid: string, shouldMatch?: boolean, biometricName?: BiometricName): Promise<void>;
+    }
+}
+/** A simulated biometric sensor — Face ID is only available since iOS 11. */
+export type BiometricName = 'touchId' | 'faceId';
+/**
+ * @param udid — UDID of the device to read from
+ * @returns whether a biometric sensor is currently simulated as enrolled
+ */
+export declare function isBiometricEnrolled(this: NativeSimctl, udid: string): Promise<boolean>;
+/**
+ * Simulates enrolling (or un-enrolling) a biometric sensor — the prerequisite for
+ * {@link sendBiometricMatch} to have any effect.
+ *
+ * @param udid — UDID of the target device
+ * @param isEnabled — whether the device should report a biometric sensor as enrolled; defaults to `true`
+ */
+export declare function enrollBiometric(this: NativeSimctl, udid: string, isEnabled?: boolean): Promise<void>;
+/**
+ * Simulates a successful or failed biometric match attempt — only takes effect once
+ * {@link enrollBiometric} has enrolled the corresponding sensor.
+ *
+ * @param udid — UDID of the target device
+ * @param shouldMatch — whether the simulated attempt should succeed; defaults to `true`
+ * @param biometricName — which sensor to simulate; defaults to `'touchId'`
+ */
+export declare function sendBiometricMatch(this: NativeSimctl, udid: string, shouldMatch?: boolean, biometricName?: BiometricName): Promise<void>;
+//# sourceMappingURL=biometric.d.ts.map

package/lib/src/commands/biometric.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"biometric.d.ts","sourceRoot":"","sources":["../../../src/commands/biometric.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAEtD,OAAO,QAAQ,qBAAqB,CAAC;IACnC,UAAU,YAAY;QACpB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QACpD,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAClE,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACvG;CACF;AAED,6EAA6E;AAC7E,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,QAAQ,CAAC;AAUjD;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAE5F;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAMvG;AAED;;;;;;;GAOG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EACZ,WAAW,UAAO,EAClB,aAAa,GAAE,aAAyB,GACvC,OAAO,CAAC,IAAI,CAAC,CAWf"}

package/lib/src/commands/biometric.js

@@ -0,0 +1,44 @@
+// Simulator.app's own Features > Face ID/Touch ID menu drives the same two Darwin notifications
+// (see darwin-notification.ts) rather than any dedicated CoreSimulator API — no native call needed.
+const ENROLLMENT_NOTIFICATION_NAME = 'com.apple.BiometricKit.enrollmentChanged';
+const BIOMETRIC_DOMAIN_COMPONENTS = {
+    touchId: 'fingerTouch',
+    faceId: 'pearl',
+};
+/**
+ * @param udid — UDID of the device to read from
+ * @returns whether a biometric sensor is currently simulated as enrolled
+ */
+export async function isBiometricEnrolled(udid) {
+    return (await this.getDarwinNotificationState(udid, ENROLLMENT_NOTIFICATION_NAME)) === 1n;
+}
+/**
+ * Simulates enrolling (or un-enrolling) a biometric sensor — the prerequisite for
+ * {@link sendBiometricMatch} to have any effect.
+ *
+ * @param udid — UDID of the target device
+ * @param isEnabled — whether the device should report a biometric sensor as enrolled; defaults to `true`
+ */
+export async function enrollBiometric(udid, isEnabled = true) {
+    await this.setDarwinNotificationState(udid, ENROLLMENT_NOTIFICATION_NAME, isEnabled ? 1n : 0n);
+    await this.postDarwinNotification(udid, ENROLLMENT_NOTIFICATION_NAME);
+    if ((await isBiometricEnrolled.call(this, udid)) !== isEnabled) {
+        throw new Error(`Failed to set biometric enrolled state for '${udid}' to '${isEnabled}'`);
+    }
+}
+/**
+ * Simulates a successful or failed biometric match attempt — only takes effect once
+ * {@link enrollBiometric} has enrolled the corresponding sensor.
+ *
+ * @param udid — UDID of the target device
+ * @param shouldMatch — whether the simulated attempt should succeed; defaults to `true`
+ * @param biometricName — which sensor to simulate; defaults to `'touchId'`
+ */
+export async function sendBiometricMatch(udid, shouldMatch = true, biometricName = 'touchId') {
+    if (!Object.hasOwn(BIOMETRIC_DOMAIN_COMPONENTS, biometricName)) {
+        throw new Error(`'${biometricName}' is not a valid biometric — use one of: ${Object.keys(BIOMETRIC_DOMAIN_COMPONENTS).join(', ')}`);
+    }
+    const domainComponent = BIOMETRIC_DOMAIN_COMPONENTS[biometricName];
+    await this.postDarwinNotification(udid, `com.apple.BiometricKit_Sim.${domainComponent}.${shouldMatch ? '' : 'no'}match`);
+}
+//# sourceMappingURL=biometric.js.map

package/lib/src/commands/biometric.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"biometric.js","sourceRoot":"","sources":["../../../src/commands/biometric.ts"],"names":[],"mappings":"AAaA,gGAAgG;AAChG,oGAAoG;AACpG,MAAM,4BAA4B,GAAG,0CAA0C,CAAC;AAChF,MAAM,2BAA2B,GAAkC;IACjE,OAAO,EAAE,aAAa;IACtB,MAAM,EAAE,OAAO;CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAqB,IAAY;IACxE,OAAO,CAAC,MAAM,IAAI,CAAC,0BAA0B,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC,KAAK,EAAE,CAAC;AAC5F,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAqB,IAAY,EAAE,SAAS,GAAG,IAAI;IACtF,MAAM,IAAI,CAAC,0BAA0B,CAAC,IAAI,EAAE,4BAA4B,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC/F,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC;IACtE,IAAI,CAAC,MAAM,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CAAC,+CAA+C,IAAI,SAAS,SAAS,GAAG,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAEtC,IAAY,EACZ,WAAW,GAAG,IAAI,EAClB,gBAA+B,SAAS;IAExC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,2BAA2B,EAAE,aAAa,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CACb,IAAI,aAAa,4CAA4C,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACnH,CAAC;IACJ,CAAC;IACD,MAAM,eAAe,GAAG,2BAA2B,CAAC,aAAa,CAAC,CAAC;IACnE,MAAM,IAAI,CAAC,sBAAsB,CAC/B,IAAI,EACJ,8BAA8B,eAAe,IAAI,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAChF,CAAC;AACJ,CAAC"}