@phone-use/sdk 0.1.0

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/README.md

@@ -0,0 +1,103 @@
+# @phone-use/sdk
+
+Typed mobile-device SDK for AI agents: launch or connect to a device, observe
+the screen as structured elements, and act on it with auto-waiting, verified
+gestures. The engine-as-object API is deliberately Playwright-shaped —
+`launch → observe → act → close`.
+
+## Quick start (iOS Simulator)
+
+Requires macOS with Xcode (`xcrun simctl`) and an iOS Simulator runtime.
+Node >= 22 or Bun.
+
+```ts
+import { ios } from '@phone-use/sdk';
+
+const device = await ios.launch(); // creates + boots a dedicated simulator
+await device.apps.open('Settings');
+const result = await device.tap('General'); // resolves by label, auto-waits, verifies
+console.log(result.message, result.changed);
+await device.close(); // shuts the sim down and deletes it
+```
+
+Or with `await using` — the device closes itself at scope exit:
+
+```ts
+import { ios } from '@phone-use/sdk';
+
+await using device = await ios.connect(); // attach to the booted simulator
+await device.apps.open('Settings');
+console.log((await device.observe()).rendered);
+```
+
+## Platforms
+
+**iOS Simulator today.** Android support lands with the android engine
+(`android.launch()` / `android.connect()`) — the backend contract and config
+union already carry the Android shape, but there is no working Android engine
+in this release, so no example is shown.
+
+## Observe → act: portable actions
+
+`device.observe()` returns structured elements plus portable `Action`
+descriptors whose targets are **re-resolvable element queries** (id → exact
+label → substring → fuzzy, with `role`/`near` disambiguators) — not stale
+handles. `device.act(action)` re-resolves against the live screen and executes
+deterministically, so a recorded `Action[]` replays with zero model calls.
+
+Every verb auto-waits (target visible + enabled + screen settled) and returns
+a structured `{ success, message, ... }` result instead of throwing for normal
+outcomes like "not found" or "ambiguous — here are the candidates".
+
+## Errors
+
+Infrastructure failures throw `PhoneUseError` subclasses, each with a stable
+`code` and an explicit `retryable` flag:
+
+| Error | `code` | `retryable` |
+| --- | --- | --- |
+| `DeviceNotFoundError` | `DEVICE_NOT_FOUND` | no |
+| `DeviceInUseError` | `DEVICE_IN_USE` | yes |
+| `SessionNotFoundError` | `SESSION_NOT_FOUND` | no |
+| `TimeoutError` | `TIMEOUT` | yes |
+| `ActionFailedError` | `ACTION_FAILED` | yes |
+| `UnsupportedCapabilityError` | `UNSUPPORTED_CAPABILITY` | no |
+| `AbortedError` | `ABORTED` | no |
+| `PhoneUseError` (base) | `BACKEND_NOT_FOUND` / `UNKNOWN` | no |
+
+No backend/transport error type ever crosses the public API — everything is
+normalized at the boundary by `toPhoneUseError`.
+
+## `%name%` secrets
+
+Store secret values on the device and reference them by name — values are
+substituted only at the moment of typing, and redacted from results,
+observations, and stored actions:
+
+```ts
+device.secrets.set('password', process.env.APP_PASSWORD!);
+await device.type('%password%', { field: 'Password', submit: true });
+// result.message: 'filled "Password", pressed Return' — never the value
+```
+
+## Testing subpath
+
+`@phone-use/sdk/testing` ships the device-free test doubles the SDK's own
+suite runs on: `FakeBackend` (scripted snapshot screens, records every call),
+`el`/`screen` fixture sugar, and `scriptedExecRunner` for lifecycle tests.
+
+```ts
+import { FakeBackend, el, screen } from '@phone-use/sdk/testing';
+
+const backend = new FakeBackend({ screens: [screen([el({ ref: '1', label: 'General' })])] });
+```
+
+## Stability
+
+Pre-1.0: minor versions may break APIs. The `Action`/`CompiledSkill` *format*
+(`formatVersion: 0`) is explicitly unstable — it cannot responsibly freeze
+before both platforms exist. Pin exact versions.
+
+## License
+
+Apache-2.0

package/dist/backend-Cbr2tIN-.d.mts

@@ -0,0 +1,316 @@
+//#region src/device.d.ts
+/** Element geometry in screen points (same space as screenshot pixels at @1x). */
+type Rect = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+/**
+ * One accessibility-tree node as reported by a backend snapshot. The SDK's own
+ * vocabulary — structurally compatible with agent-device's nodes but never
+ * importing its types (docs/20 item 2: no backend type in the public API).
+ */
+type SnapshotNode = {
+  ref?: string | undefined;
+  type?: string | undefined;
+  role?: string | undefined;
+  label?: string | undefined;
+  value?: string | undefined;
+  identifier?: string | undefined;
+  enabled?: boolean | undefined;
+  selected?: boolean | undefined;
+  focused?: boolean | undefined;
+  interactionBlocked?: string | undefined;
+  rect?: Rect | undefined;
+};
+/** One backend snapshot: the node list plus the frontmost app when known. */
+type Snapshot = {
+  nodes: SnapshotNode[];
+  appName?: string | undefined;
+  appBundleId?: string | undefined;
+};
+/** Scroll gesture direction. */
+type ScrollDirection = 'up' | 'down' | 'left' | 'right';
+/** A press target: an element ref from a snapshot, or raw screen coordinates. */
+type PressTarget = {
+  ref: string;
+} | {
+  x: number;
+  y: number;
+};
+/** What to do with a system alert: read it, accept it, or dismiss it. */
+type AlertAction = 'get' | 'accept' | 'dismiss';
+/** Raw result of a backend's system-alert command. */
+type BackendAlertResult = {
+  alert?: {
+    title?: string | undefined;
+    message?: string | undefined;
+    buttons?: string[] | undefined;
+  } | null | undefined;
+  handled?: boolean | undefined;
+  button?: string | undefined;
+};
+/** What a backend reports after opening an app or URL. */
+type OpenAppResult = {
+  appName?: string | undefined;
+  appBundleId?: string | undefined;
+};
+/** A backend feature a caller can query via `backend.capabilities`. */
+type Capability = 'snapshot' | 'screenshot' | 'press' | 'longPress' | 'fill' | 'type' | 'key' | 'scroll' | 'pan' | 'waitForText' | 'alert' | 'home' | 'back' | 'openApp' | 'openUrl' | 'listApps' | 'closeSession';
+/** Every capability — what a full backend (agent-device iOS) declares. */
+declare const ALL_CAPABILITIES: readonly Capability[];
+//#endregion
+//#region src/errors.d.ts
+/**
+ * Stable machine-readable error codes carried by every {@link PhoneUseError}.
+ *
+ * Codes are deliberately string-identical to agent-device's where a concept
+ * maps 1:1 (DEVICE_NOT_FOUND, SESSION_NOT_FOUND, ...) so existing harness
+ * checks like `(e as {code?: string}).code === 'SESSION_NOT_FOUND'` keep
+ * working unchanged across the normalization boundary.
+ */
+type PhoneUseErrorCode = 'DEVICE_NOT_FOUND' | 'DEVICE_IN_USE' | 'SESSION_NOT_FOUND' | 'TIMEOUT' | 'ACTION_FAILED' | 'UNSUPPORTED_CAPABILITY' | 'BACKEND_NOT_FOUND' | 'ABORTED' | 'UNKNOWN';
+/** Structured, code-specific context attached to a {@link PhoneUseError}. */
+type PhoneUseErrorDetails = Record<string, unknown> & {
+  /** Preserved from agent-device details.hint — describeError renders it. */
+  hint?: string | undefined;
+  /** The raw backend code when we collapse to ACTION_FAILED. */
+  backendCode?: string | undefined;
+};
+/**
+ * Root of the typed error tree (docs/19 §Artifacts, errors; docs/20 item 2).
+ * Every backend method rejects only with PhoneUseError subclasses; agent-device
+ * (or any transport) errors are normalized at the boundary by
+ * {@link toPhoneUseError} so no backend type ever reaches the public API. Each
+ * error carries a stable `code` and an explicit `retryable` flag — the field
+ * agent loops need to decide retry-vs-replan.
+ */
+declare class PhoneUseError extends Error {
+  /** Stable machine-readable code — the field to branch on. */
+  readonly code: PhoneUseErrorCode;
+  /** Whether retrying the same call can plausibly succeed. */
+  readonly retryable: boolean;
+  /** Optional structured context (hint, raw backend code, ...). */
+  readonly details?: PhoneUseErrorDetails | undefined;
+  constructor(message: string, opts: {
+    code: PhoneUseErrorCode;
+    retryable: boolean;
+    details?: PhoneUseErrorDetails | undefined;
+    cause?: unknown;
+  });
+}
+/** No device matched the selection (`DEVICE_NOT_FOUND`, not retryable). */
+declare class DeviceNotFoundError extends PhoneUseError {
+  constructor(message: string, opts?: {
+    details?: PhoneUseErrorDetails | undefined;
+    cause?: unknown;
+  });
+}
+/** The device is held by another session (`DEVICE_IN_USE`, retryable). */
+declare class DeviceInUseError extends PhoneUseError {
+  constructor(message: string, opts?: {
+    details?: PhoneUseErrorDetails | undefined;
+    cause?: unknown;
+  });
+}
+/** No live session — the device/session was closed (`SESSION_NOT_FOUND`, not retryable). */
+declare class SessionNotFoundError extends PhoneUseError {
+  constructor(message: string, opts?: {
+    details?: PhoneUseErrorDetails | undefined;
+    cause?: unknown;
+  });
+}
+/** A deadline elapsed before the operation completed (`TIMEOUT`, retryable). */
+declare class TimeoutError extends PhoneUseError {
+  constructor(message: string, opts?: {
+    details?: PhoneUseErrorDetails | undefined;
+    cause?: unknown;
+  });
+}
+/** A device action failed to execute (`ACTION_FAILED`, retryable). */
+declare class ActionFailedError extends PhoneUseError {
+  constructor(message: string, opts?: {
+    details?: PhoneUseErrorDetails | undefined;
+    cause?: unknown;
+  });
+}
+/** The backend does not implement the capability (`UNSUPPORTED_CAPABILITY`, not retryable). */
+declare class UnsupportedCapabilityError extends PhoneUseError {
+  /** The backend that rejected the call. */
+  readonly backend: string;
+  /** The missing capability. */
+  readonly capability: string;
+  constructor(opts: {
+    backend: string;
+    capability: string;
+    cause?: unknown;
+  });
+}
+/**
+ * The caller's AbortSignal fired (`ABORTED`, not retryable). Abort is caller
+ * control flow, not a device outcome — never retried.
+ */
+declare class AbortedError extends PhoneUseError {
+  constructor(message?: string, opts?: {
+    cause?: unknown;
+  });
+}
+/**
+ * Boundary normalizer: ANY thrown value → PhoneUseError. agent-device AppError
+ * codes map per the table below; an existing PhoneUseError passes through
+ * untouched; unknown values wrap as UNKNOWN (not retryable). The original
+ * error always rides on `cause`; details (including hint) are preserved.
+ */
+declare function toPhoneUseError(err: unknown, ctx?: {
+  backend?: string;
+  capability?: string;
+}): PhoneUseError;
+//#endregion
+//#region src/config.d.ts
+/** Fields shared by every platform's device config (session/daemon pinning). */
+type CommonDeviceConfig = {
+  /** agent-device session name pinning. */
+  session?: string | undefined;
+  /** Remote daemon endpoint (API surface reserved; local-only this cycle). */
+  daemonBaseUrl?: string | undefined;
+  daemonAuthToken?: string | undefined;
+};
+/** iOS device selection: pin by udid, name match, or custom device set. */
+type IosDeviceConfig = CommonDeviceConfig & {
+  platform: 'ios';
+  /** Pin a specific simulator/device by udid. */
+  udid?: string | undefined;
+  /** Name match, e.g. "iPhone 16". */
+  device?: string | undefined;
+  /** Custom simulator device set directory. */
+  simulatorDeviceSet?: string | undefined;
+};
+/** Android device selection: pin by adb serial or name match. */
+type AndroidDeviceConfig = CommonDeviceConfig & {
+  platform: 'android';
+  /** Pin a specific device/emulator by adb serial. */
+  serial?: string | undefined;
+  /** Name match. */
+  device?: string | undefined;
+};
+/**
+ * Device configuration: a discriminated union on `platform`, never a
+ * stringly-typed capability blob (docs/19 §Backend contract, learning from
+ * Appium's leaks). Plain types — no zod in the SDK public API.
+ */
+type DeviceConfig = IosDeviceConfig | AndroidDeviceConfig;
+//#endregion
+//#region src/backend.d.ts
+/**
+ * The backend contract (docs/19 §Backend contract): a STRUCTURAL interface —
+ * any object with these methods is a backend — plus an optional
+ * {@link BaseDeviceBackend} class with the plumbing done (Appium BaseDriver
+ * ergonomics). Methods reject only with PhoneUseError subclasses; backends
+ * normalize their transport's errors at the boundary.
+ */
+interface DeviceBackend {
+  /** Stable backend identifier, e.g. `"agent-device"`. */
+  readonly backendName: string;
+  /** The capabilities this backend actually implements. */
+  readonly capabilities: ReadonlySet<Capability>;
+  /** Capture the accessibility tree of the frontmost app. */
+  snapshot(opts?: {
+    interactiveOnly?: boolean | undefined;
+    depth?: number | undefined;
+  }): Promise<Snapshot>;
+  /** Save a screenshot to `path` (optionally with `@ref` overlays drawn). */
+  screenshot(opts: {
+    path: string;
+    overlayRefs?: boolean | undefined;
+  }): Promise<{
+    path: string;
+  }>;
+  /** Tap an element ref or raw coordinates. */
+  press(target: PressTarget): Promise<void>;
+  /** Long-press an element ref. */
+  longPress(ref: string, durationMs?: number): Promise<void>;
+  /** Focus an element and replace its text. */
+  fill(ref: string, text: string): Promise<void>;
+  /** Type into whatever currently has keyboard focus. */
+  typeText(text: string): Promise<void>;
+  /** Press a hardware/keyboard key (Return only, this cycle). */
+  pressKey(key: 'return'): Promise<void>;
+  /** Scroll the active scroll view one step. */
+  scroll(direction: ScrollDirection): Promise<void>;
+  /** Coordinate drag: touch down at (x,y), move by (dx,dy). Operates picker wheels, sliders, carousels. */
+  pan(x: number, y: number, dx: number, dy: number, durationMs?: number): Promise<void>;
+  /** Block until `text` appears on screen or the timeout elapses. */
+  waitForText(text: string, timeoutMs?: number): Promise<void>;
+  /** Read/accept/dismiss the app's own alert via the transport's alert command. */
+  systemAlert(action: AlertAction): Promise<BackendAlertResult>;
+  /** Go to the home screen. */
+  home(): Promise<void>;
+  /** Navigate back (hardware back / nav-bar back). */
+  back(): Promise<void>;
+  /** Open an app by name/bundle id, or a URL (deep link). */
+  openApp(opts: {
+    app?: string | undefined;
+    url?: string | undefined;
+    relaunch?: boolean | undefined;
+  }): Promise<OpenAppResult>;
+  /** List installed app bundle ids. */
+  listApps(): Promise<string[]>;
+  /** Close the transport session (idempotent; safe when none is open). */
+  closeSession(): Promise<void>;
+}
+/**
+ * Optional plumbing base: every method rejects with a typed
+ * UnsupportedCapabilityError until overridden. Subclasses declare their
+ * capability set and override exactly what they support.
+ */
+declare abstract class BaseDeviceBackend implements DeviceBackend {
+  readonly backendName: string;
+  readonly capabilities: ReadonlySet<Capability>;
+  protected constructor(backendName: string, capabilities: Iterable<Capability>);
+  protected unsupported(capability: Capability): UnsupportedCapabilityError;
+  /** Throws UnsupportedCapabilityError unless this backend declares `capability`. */
+  requireCapability(capability: Capability): void;
+  snapshot(_opts?: {
+    interactiveOnly?: boolean | undefined;
+    depth?: number | undefined;
+  }): Promise<Snapshot>;
+  screenshot(_opts: {
+    path: string;
+    overlayRefs?: boolean | undefined;
+  }): Promise<{
+    path: string;
+  }>;
+  press(_target: PressTarget): Promise<void>;
+  longPress(_ref: string, _durationMs?: number): Promise<void>;
+  fill(_ref: string, _text: string): Promise<void>;
+  typeText(_text: string): Promise<void>;
+  pressKey(_key: 'return'): Promise<void>;
+  scroll(_direction: ScrollDirection): Promise<void>;
+  pan(_x: number, _y: number, _dx: number, _dy: number, _durationMs?: number): Promise<void>;
+  waitForText(_text: string, _timeoutMs?: number): Promise<void>;
+  systemAlert(_action: AlertAction): Promise<BackendAlertResult>;
+  home(): Promise<void>;
+  back(): Promise<void>;
+  openApp(_opts: {
+    app?: string | undefined;
+    url?: string | undefined;
+    relaunch?: boolean | undefined;
+  }): Promise<OpenAppResult>;
+  listApps(): Promise<string[]>;
+  closeSession(): Promise<void>;
+}
+/** Builds a backend from an optional {@link DeviceConfig}. */
+type BackendFactory = (config?: DeviceConfig) => DeviceBackend | Promise<DeviceBackend>;
+/**
+ * Register a backend factory under a unique name (the `phone-backend-*`
+ * convention for third parties). Throws if the name is already taken.
+ */
+declare function registerBackend(name: string, factory: BackendFactory): void;
+/** Look up a registered factory by name; throws `BACKEND_NOT_FOUND` if absent. */
+declare function getBackendFactory(name: string): BackendFactory;
+/** Names of every registered backend, in registration order. */
+declare function listBackends(): string[];
+//#endregion
+export { Snapshot as A, AlertAction as C, PressTarget as D, OpenAppResult as E, Rect as O, ALL_CAPABILITIES as S, Capability as T, PhoneUseErrorDetails as _, listBackends as a, UnsupportedCapabilityError as b, CommonDeviceConfig as c, AbortedError as d, ActionFailedError as f, PhoneUseErrorCode as g, PhoneUseError as h, getBackendFactory as i, SnapshotNode as j, ScrollDirection as k, DeviceConfig as l, DeviceNotFoundError as m, BaseDeviceBackend as n, registerBackend as o, DeviceInUseError as p, DeviceBackend as r, AndroidDeviceConfig as s, BackendFactory as t, IosDeviceConfig as u, SessionNotFoundError as v, BackendAlertResult as w, toPhoneUseError as x, TimeoutError as y };
+//# sourceMappingURL=backend-Cbr2tIN-.d.mts.map