@e2e-dev/mobile 0.8.0-canary-20260928184528

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,5 @@
+@e2e-dev/mobile
+Copyright 2026 TesterArmy, Inc.
+
+This product includes software developed at TesterArmy, Inc.
+(https://tester.army).

package/README.md

@@ -0,0 +1,159 @@
+# @e2e-dev/mobile
+
+The mobile engine for [`e2e`](https://www.npmjs.com/package/e2e), built on
+[agent-device](https://github.com/callstack/agent-device): iOS simulators and
+Android emulators through the same `e2e/engine` contract the browser engine
+implements. A test written against `screen`, `expect`, `app`, and `agent` runs
+on a device target unchanged; nothing in `e2e` core knows this package exists.
+
+## Install
+
+Run `npx e2e init` and choose **Mobile (iOS/Android)** for a Settings
+example with optional AI testing. Init defaults to iOS on macOS and Android
+elsewhere; change the platform in `e2e.config.ts` when needed.
+Or add the packages to an existing project:
+
+```bash
+npm install --save-dev e2e @e2e-dev/mobile
+```
+
+`agent-device` needs Xcode with an iOS simulator runtime, or the Android SDK
+with an emulator. Run `npx agent-device doctor` once before handing the target
+to the runner.
+
+```ts title="e2e.config.ts"
+import type { E2EConfig } from 'e2e';
+import { createAgent } from 'e2e/agent';
+import { mobile } from '@e2e-dev/mobile';
+import { mobileTools } from '@e2e-dev/mobile/tools';
+import { gateway } from 'ai';
+
+const iphone = mobile({ platform: 'ios', app: 'Settings' });
+const pixel = mobile({ platform: 'android', app: 'com.android.settings' });
+
+export default {
+  targets: [
+    { name: 'iphone', engine: iphone },
+    { name: 'pixel', engine: pixel },
+  ],
+  workers: 1,
+  agents: {
+    default: createAgent({
+      model: gateway('openai/gpt-5.6-luna'),
+      tools: mobileTools(iphone, pixel),
+    }),
+  },
+} satisfies E2EConfig;
+```
+
+A test written against `agent`, `app`, `screen`, and `device` runs on both
+targets unchanged. Only a check that names a platform label (`General` on iOS,
+`Network & internet` on Android) needs `platforms: ['ios']` or
+`platforms: ['android']` on the test.
+
+Options:
+
+| Option | Meaning |
+| --- | --- |
+| `platform` | `'ios'` or `'android'`. |
+| `app` | Bundle id, package, or display name `app.open()` launches fresh; an attempt launches nothing on its own. Also unlocks `app.restart()` and `app.clearState()`. |
+| `appPath` | An iOS `.app` bundle or Android `.apk` installed once per worker before the first attempt, resolved against the project root. Without `app`, the installed bundle id or package is the app `app.open()` launches. |
+| `device` | Simulator or emulator name or UDID. A list is a pool: one worker per entry, worker slot `n` driving the `n`th. Omitted, every booted device of the platform is the pool, as many as the run has slots. |
+| `session` | agent-device session name, before the worker slot: slot `n` drives its device under `<session>-<n>`, `e2e-<target name>-<n>` by default. One run per session at a time. |
+| `snapshot` | `'full'` (default, includes static text) or `'interactive'` (actionable nodes only). |
+| `settle` | For agent actions: milliseconds the UI must hold still after an action before the agent observes again, default `150`; `false` skips the wait. A test's own steps never settle; `expect` verifies their outcome. |
+| `transition` | For a test's steps: milliseconds a control that appeared or moved with the last action gets to finish arriving before it is acted on, default `500`. Controls already in place before the action are acted on at once. |
+| `launchArguments` | Arguments every fresh launch of the pinned app carries (`app.open()`, `app.restart()`, `app.clearState()`): the process arguments on iOS, `am start` arguments on Android. The warm-up passes none. |
+| `permissions` | Permissions the pinned app holds on every fresh launch, `{ camera: 'grant', location: 'deny', notifications: 'reset' }`, set before the app starts and put back after `app.clearState()` reset them. |
+
+Every optional value also accepts `undefined`, so a config passes
+`device: process.env.E2E_DEVICE` or `appPath: process.env.E2E_APP_PATH`
+straight through, with no conditional spread.
+
+## What the engine declares
+
+- **Observation**: the accessibility tree, projected onto the role vocabulary
+  (iOS `Button` becomes `button`, `TextField` becomes `textbox`, `Cell` becomes
+  `listitem`; Android `android.widget.TextView` becomes `text`, `EditText`
+  becomes `textbox`, `Switch` becomes `switch`), with rects, a viewport, and
+  pixels on request with every secure field painted over. Element identifiers
+  (`ABOUT`, `android:id/title`) are the node's `testId`, what `getByTestId`
+  matches.
+- **Actions**: tap, double tap, long press, fill, clear, check/uncheck (when
+  the tree exposes the checked state; Android switches do not), focus on
+  editable fields, `Enter`, single-character keys, swipe within a node, drag.
+  `selectOption`, `setInputFiles`, `scrollIntoView`, `secondaryTap`, focus on
+  a control, and other keys fail with `UNSUPPORTED_CAPABILITY`.
+- **Location**: every `screen` query, plus agent-device selectors through
+  `device.locator('role=NavigationBar id=General')`.
+- **Viewport swipe**, `app.back()`, `app.restart()`, `app.clearState()`, and
+  redacted screenshots under the attempt artifact directory: the bounds of
+  every secure field are painted black before the file is kept, and a
+  screenshot that cannot be redacted is not written. No `state` capability: a
+  simulator has no portable session snapshot.
+
+## Trace cache
+
+The runner caches `agent.act` steps by their location anchor, and a device has
+no address bar. This engine reports one anyway: `<bundle id> / <screen
+title>`, with the title read off the navigation bar on iOS and the collapsing
+toolbar on Android. The app identity is part of the location, so two apps with
+a "General" screen never share an anchor. A step recorded on
+`com.apple.Preferences / General` replays only when that app is on that
+screen again, and a flow that stays within tap, type, and scroll replays with
+zero model calls. Pin `app` and call `app.open()` first, so steps start on
+the same screen, and
+prefer the grammar over the `open_app` tool inside a step: a tool call is a
+replay gap.
+
+## The `device` fixture
+
+Deterministic device management, recorded as `device.<method>` steps. Import
+`test` from this package to have it typed.
+
+```ts
+import { test } from '@e2e-dev/mobile';
+import { expect } from 'e2e';
+
+test('shows the version offline in dark mode', async ({ agent, device, screen }) => {
+  await device.setAppearance('dark');
+  await device.setNetwork('offline');
+  await agent.act('go to General, then About');
+  await expect(screen.getByRole('button', { name: /^iOS Version/ })).toBeVisible();
+  await expect(device.locator('role=NavigationBar id=About')).toBeVisible();
+});
+```
+
+Methods: `setNetwork`, `setAirplaneMode`, `setPermission`, `setLocation`,
+`clearLocation`, `setAppearance`, `setOrientation`, `setBiometrics`,
+`enrollBiometrics`, `installApp`, `openApp`, `closeApp`, `clearKeychain`,
+`foregroundApp`, `home`, `back`, `alert`, `dismissKeyboard`, `clipboard`,
+`setClipboard`, and the `locator` accessor.
+
+`installApp(appPath, { app, reinstall })` puts a build on the device from a
+test, for upgrade and fresh-install paths the `appPath` option cannot express.
+A plain install replaces the binary and keeps its data; `reinstall: true`
+removes the app named by `app` (default: the pinned app) first. It resolves to
+the bundle id or package to `openApp` the build by. `openApp` takes an app id,
+never a link; `openLink` opens one, under the navigation rule.
+
+## Agent tools
+
+`@e2e-dev/mobile/tools` exports `mobileTools(...engines)`: `open_app`,
+`swipe` (free-form, in logical pixels), and `alert` (accept or dismiss a
+system alert). It takes at least one engine. Pass every device engine the
+config declares: tool names are fixed, so two packs cannot be merged, and the
+pack dispatches each call to the engine whose attempt is running. Tools are
+scoped to the platforms of those engines, so a suite that mixes web and device
+targets can hand the pack to one `createAgent`.
+
+## Secrets
+
+`type_secret` and `screen.getByLabel(...).fill(secret)` fill declared secrets
+on a device: a credential's password into a secure field, a `secrets` entry
+into any editable input. The model never sees the value, and screenshots are
+withheld for the rest of the attempt.
+
+## Documentation
+
+Full documentation lives at [e2e.tester.army/docs](https://e2e.tester.army/docs).

package/dist/.build.json

@@ -0,0 +1 @@
+{"version":"0.8.0-canary-20260928184528"}

package/dist/actions.d.ts

@@ -0,0 +1,41 @@
+/** The action kinds a device surface declares, and the pointer dispatch that agrees with them. */
+import type { LocatorActionKind, PointerAction, PointerActionKind, ViewportPoint } from 'e2e/engine';
+import type { AgentDeviceClient } from './options.ts';
+/**
+ * The action kinds a device honors, declared so the harness offers exactly
+ * these: no `select` verb on a device (`selectOption`, `setInputFiles`, and
+ * `scrollIntoView` have no touch equivalent), and `perform` still refuses a
+ * declared kind one node cannot take (`check` on a toggle whose state is
+ * unknown, `focus` on anything but a field).
+ */
+/**
+ * How long a `longPress` holds when the caller names no duration: the agent's
+ * `long_press` tool and a test's bare `longPress()`. agent-device's own
+ * default is under half a second, shorter than a React Native `Pressable`'s
+ * `delayLongPress` of 500 ms, let alone the longer thresholds apps set, so a
+ * default hold there registers as a tap. One second clears them the way
+ * Detox's default does; a test that needs more passes `duration`.
+ */
+export declare const DEFAULT_LONG_PRESS_MS = 1000;
+export declare const DEVICE_ACTIONS: readonly LocatorActionKind[];
+/**
+ * The pointer actions a device honors at a bare point: agent-device presses
+ * and swipes by coordinates, so taps, double taps, long presses, and a swipe
+ * to another point land anywhere. A coordinate hover, secondary tap, or drag
+ * (a hold before the move, unlike a swipe) has no touch equivalent it exposes
+ * without a node, and a directional swipe at a bare point has no length, so
+ * only the screen root scrolls that way.
+ */
+export declare const DEVICE_POINTER_ACTIONS: readonly PointerActionKind[];
+/**
+ * Issues one pointer action at a screen point in logical pixels. `settle` is
+ * the device's quiet-wait options, spread onto the interaction as the node
+ * actions do. A double tap is two presses (`count: 2`), as it is on a node:
+ * agent-device's own double-tap gesture reaches a React Native `Pressable`
+ * on iOS as one press, while two presses in a row land about 285 ms apart.
+ * The kinds outside `DEVICE_POINTER_ACTIONS` never arrive: the harness
+ * routes only declared kinds. They are refused here so the switch stays
+ * exhaustive against the contract.
+ */
+export declare function pointerInteraction(client: AgentDeviceClient, point: ViewportPoint, action: PointerAction, settle: Record<string, unknown>): Promise<unknown>;
+//# sourceMappingURL=actions.d.ts.map

package/dist/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAElG,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGtD;;;;;;GAMG;AACH;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,OAAQ,CAAC;AAE3C,eAAO,MAAM,cAAc,EAAE,SAAS,iBAAiB,EAatD,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,EAAE,SAAS,iBAAiB,EAAiD,CAAC;AAEjH;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,iBAAiB,EACzB,KAAK,EAAE,aAAa,EACpB,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,OAAO,CAAC,OAAO,CAAC,CAiBlB"}

package/dist/actions.js

@@ -0,0 +1,70 @@
+/** The action kinds a device surface declares, and the pointer dispatch that agrees with them. */
+import { unsupported } from './support.js';
+/**
+ * The action kinds a device honors, declared so the harness offers exactly
+ * these: no `select` verb on a device (`selectOption`, `setInputFiles`, and
+ * `scrollIntoView` have no touch equivalent), and `perform` still refuses a
+ * declared kind one node cannot take (`check` on a toggle whose state is
+ * unknown, `focus` on anything but a field).
+ */
+/**
+ * How long a `longPress` holds when the caller names no duration: the agent's
+ * `long_press` tool and a test's bare `longPress()`. agent-device's own
+ * default is under half a second, shorter than a React Native `Pressable`'s
+ * `delayLongPress` of 500 ms, let alone the longer thresholds apps set, so a
+ * default hold there registers as a tap. One second clears them the way
+ * Detox's default does; a test that needs more passes `duration`.
+ */
+export const DEFAULT_LONG_PRESS_MS = 1_000;
+export const DEVICE_ACTIONS = [
+    'tap',
+    'doubleTap',
+    'longPress',
+    'fill',
+    'clear',
+    'press',
+    'check',
+    'uncheck',
+    'focus',
+    'hover',
+    'dragTo',
+    'swipe',
+];
+/**
+ * The pointer actions a device honors at a bare point: agent-device presses
+ * and swipes by coordinates, so taps, double taps, long presses, and a swipe
+ * to another point land anywhere. A coordinate hover, secondary tap, or drag
+ * (a hold before the move, unlike a swipe) has no touch equivalent it exposes
+ * without a node, and a directional swipe at a bare point has no length, so
+ * only the screen root scrolls that way.
+ */
+export const DEVICE_POINTER_ACTIONS = ['tap', 'doubleTap', 'longPress', 'swipeTo'];
+/**
+ * Issues one pointer action at a screen point in logical pixels. `settle` is
+ * the device's quiet-wait options, spread onto the interaction as the node
+ * actions do. A double tap is two presses (`count: 2`), as it is on a node:
+ * agent-device's own double-tap gesture reaches a React Native `Pressable`
+ * on iOS as one press, while two presses in a row land about 285 ms apart.
+ * The kinds outside `DEVICE_POINTER_ACTIONS` never arrive: the harness
+ * routes only declared kinds. They are refused here so the switch stays
+ * exhaustive against the contract.
+ */
+export function pointerInteraction(client, point, action, settle) {
+    const at = { x: point.x, y: point.y };
+    switch (action.kind) {
+        case 'tap':
+            return client.interactions.press({ ...at, ...settle });
+        case 'doubleTap':
+            return client.interactions.press({ ...at, count: 2, ...settle });
+        case 'longPress':
+            return client.interactions.longPress({ ...at, ...settle, durationMs: action.durationMs ?? DEFAULT_LONG_PRESS_MS });
+        case 'swipeTo':
+            return client.interactions.swipe({ from: at, to: { x: action.target.x, y: action.target.y } });
+        case 'secondaryTap':
+        case 'hover':
+        case 'dragTo':
+        case 'swipe':
+            throw unsupported(`agent-device cannot perform "${action.kind}" at a bare point`);
+    }
+}
+//# sourceMappingURL=actions.js.map

package/dist/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAIlG,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;;;;;GAMG;AACH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAC;AAE3C,MAAM,CAAC,MAAM,cAAc,GAAiC;IAC1D,KAAK;IACL,WAAW;IACX,WAAW;IACX,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,SAAS;IACT,OAAO;IACP,OAAO;IACP,QAAQ;IACR,OAAO;CACR,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAiC,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;AAEjH;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAyB,EACzB,KAAoB,EACpB,MAAqB,EACrB,MAA+B;IAE/B,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;IACtC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,KAAK;YACR,OAAO,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;QACzD,KAAK,WAAW;YACd,OAAO,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;QACnE,KAAK,WAAW;YACd,OAAO,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,qBAAqB,EAAE,CAAC,CAAC;QACrH,KAAK,SAAS;YACZ,OAAO,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACjG,KAAK,cAAc,CAAC;QACpB,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,OAAO;YACV,MAAM,WAAW,CAAC,gCAAgC,MAAM,CAAC,IAAI,mBAAmB,CAAC,CAAC;IACtF,CAAC;AACH,CAAC"}

package/dist/bindings.d.ts

@@ -0,0 +1,87 @@
+/**
+ * What one worker slot drives, and how it travels from the runner's `prepare`
+ * to the worker's `init`. Every way a pool comes by devices (a configured
+ * list, the booted devices it discovered, the leases a provider granted) is
+ * one `DeviceSource` that ends in one `SlotBinding` per slot, so the worker
+ * reads one shape through one environment variable, whatever produced it.
+ */
+import type { createAgentDeviceClient } from 'agent-device';
+import { type EngineFinishInfo, type EnginePrepareInfo } from 'e2e/engine';
+import type { MobileOptions } from './options.ts';
+type AgentDeviceClientConfig = NonNullable<Parameters<typeof createAgentDeviceClient>[0]>;
+/** An agent-device daemon other than the local one. */
+export interface DeviceDaemon {
+    /** Base URL answering agent-device's `GET /health` and `POST /rpc`. */
+    readonly baseUrl: string;
+    /** Bearer token the daemon expects, when it wants one. */
+    readonly authToken?: string | undefined;
+}
+/**
+ * agent-device client configuration the worker's client is created with, on
+ * top of the session name the engine owns and the `daemon` address: the lease
+ * scope a daemon resolves a hosted device by (`tenant`, `runId`, `leaseId`,
+ * `leaseBackend`, `leaseProvider`), the `stateDir` of a daemon other than the
+ * default one, provider options. JSON data only, since it travels to the
+ * worker through the environment; `session`, `daemonBaseUrl`,
+ * `daemonAuthToken`, and the transport are not part of it.
+ */
+export type DeviceClientConfig = Omit<AgentDeviceClientConfig, 'session' | 'daemonBaseUrl' | 'daemonAuthToken' | 'daemonTransport'>;
+/** How a worker's agent-device client reaches its device: which daemon, and with what configuration. */
+export type DeviceConnection = Pick<SlotBinding, 'daemon' | 'client'>;
+/** What one worker slot drives; `{}` leaves every choice to the local daemon. */
+export interface SlotBinding {
+    /** Device to select by name; absent, `deviceId` selects one, or the daemon picks a booted one. */
+    readonly device?: string | undefined;
+    /** Device to select by the id agent-device lists it under: a simulator UDID or an Android serial. */
+    readonly deviceId?: string | undefined;
+    /** The agent-device daemon to connect to; absent, the local one. */
+    readonly daemon?: DeviceDaemon | undefined;
+    /** Client configuration for that daemon; absent, the client's defaults. */
+    readonly client?: DeviceClientConfig | undefined;
+    /** App a provider already installed from `appPath`, so the worker installs nothing and opens this. */
+    readonly installedApp?: string | undefined;
+    /**
+     * App the warm-up in `prepare` opened in the slot's session, which the
+     * worker resumes: a permission command there already acts on it. Absent
+     * when nothing was opened, or the open failed. Every worker of the slot
+     * reads it, but only a worker that finds the session still open keeps it:
+     * one retired after a failing test closed it.
+     */
+    readonly sessionApp?: string | undefined;
+}
+/**
+ * Where a pool's devices come from. `bind` runs once per run and target in
+ * `prepare`; `finish` releases what `bind` acquired, when anything was.
+ */
+export interface DeviceSource {
+    /** Workers served per target, one per device, when known before `prepare`. */
+    readonly size?: number | undefined;
+    /** What a worker drives when its run had no `prepare`; `undefined` leaves the choice to the local daemon. */
+    readonly fallback?: readonly SlotBinding[] | undefined;
+    /** One binding per worker slot the run will use, `info.slots` at most and never none. */
+    bind(info: EnginePrepareInfo): Promise<readonly SlotBinding[]>;
+    finish?(info: EngineFinishInfo): Promise<void>;
+}
+/** What a binding calls its device in progress and error lines: the name, else the id, else nothing. */
+export declare function deviceLabel(binding: Pick<SlotBinding, 'device' | 'deviceId'> | undefined): string | undefined;
+/**
+ * The app a slot's `app.open()` launches, and its warm-up opens once: the
+ * `app` option, else the app the build `appPath` installed, once the suite's
+ * `device.installApp()` (or a device provider) has. `undefined` with a build
+ * nobody has installed and no `app`.
+ */
+export declare function pinnedApp(options: Pick<MobileOptions, 'app' | 'appPath'>, installedApp: string | undefined): string | undefined;
+/**
+ * The environment variable a target's bindings travel to the workers in: the
+ * name made environment-safe for reading, plus a digest of the exact name so
+ * `ios-a` and `ios.a` never share a key.
+ */
+export declare function bindingsVariable(targetName: string): string;
+/** Serializes the bindings for the environment: declared fields only, bounded. */
+export declare function encodeBindings(bindings: readonly SlotBinding[]): string;
+/** The bindings a `prepare` left in the environment, or `undefined` when there are none it can read. */
+export declare function decodeBindings(raw: string | undefined): readonly SlotBinding[] | undefined;
+/** A binding as JSON parses it back, or as a provider returned it: nothing the engine did not write is trusted. */
+export declare function isSlotBinding(value: unknown): value is SlotBinding;
+export {};
+//# sourceMappingURL=bindings.d.ts.map

package/dist/bindings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bindings.d.ts","sourceRoot":"","sources":["../src/bindings.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAoB,KAAK,gBAAgB,EAAE,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD,KAAK,uBAAuB,GAAG,WAAW,CAAC,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1F,uDAAuD;AACvD,MAAM,WAAW,YAAY;IAC3B,uEAAuE;IACvE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,uBAAuB,EAAE,SAAS,GAAG,eAAe,GAAG,iBAAiB,GAAG,iBAAiB,CAAC,CAAC;AAEpI,wGAAwG;AACxG,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,EAAE,QAAQ,GAAG,QAAQ,CAAC,CAAC;AAEtE,iFAAiF;AACjF,MAAM,WAAW,WAAW;IAC1B,kGAAkG;IAClG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,qGAAqG;IACrG,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,oEAAoE;IACpE,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAC3C,2EAA2E;IAC3E,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACjD,sGAAsG;IACtG,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,8EAA8E;IAC9E,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,6GAA6G;IAC7G,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,WAAW,EAAE,GAAG,SAAS,CAAC;IACvD,yFAAyF;IACzF,IAAI,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,SAAS,WAAW,EAAE,CAAC,CAAC;IAC/D,MAAM,CAAC,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChD;AAED,wGAAwG;AACxG,wBAAgB,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,GAAG,UAAU,CAAC,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAE7G;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,GAAG,SAAS,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAE/H;AASD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAI3D;AAED,kFAAkF;AAClF,wBAAgB,cAAc,CAAC,QAAQ,EAAE,SAAS,WAAW,EAAE,GAAG,MAAM,CAsBvE;AAED,wGAAwG;AACxG,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,WAAW,EAAE,GAAG,SAAS,CAS1F;AAMD,mHAAmH;AACnH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAWlE"}