@sandboxrouter/sdk 0.2.0 → 0.3.1

package/dist/providers/limrun.d.ts

@@ -0,0 +1,77 @@
+import type { ComputerOs, ComputerProvider, ComputerSpec, ProviderComputer } from "../computers.js";
+/**
+ * Limrun: cloud Android emulators and iOS simulators, driven through `@limrun/api`.
+ * Control plane: `new Limrun({ apiKey })` -> androidInstances / iosInstances (create, get, delete).
+ * Device: createInstanceClient (Android) / Ios.createInstanceClient, built from the instance's
+ * status.apiUrl + status.token (a WebSocket; no API key needed).
+ * Docs: https://docs.limrun.com/docs/reference/sdk.md
+ *
+ * Canonical action mapping (coordinates are in the last screenshot's frame; iOS screenshots are
+ * the SDK's default "scaled" size, i.e. tap points, so they line up with taps):
+ *
+ *   screenshot             Android client.screenshot() (data URI) | iOS screenshot({ format: "png" })
+ *   left_click             tap(x, y); with `duration` (s) > 0 it is a long press of that length
+ *   right_click            long press (800 ms), the phone's context-menu gesture
+ *   double/triple_click    2 or 3 quick taps (Android: one `input tap` shell line; iOS: one performActions batch)
+ *   left_click_drag        swipe startCoordinate -> coordinate (Android `input swipe`; iOS touchDown/touchMove/touchUp)
+ *   scroll                 Android scrollScreen / scrollElement({x, y}) with amount = steps;
+ *                          iOS scroll(direction, steps x 100 points, { coordinate })
+ *   type                   Android setText(focused input) | iOS typeText(requireFocus: false)
+ *   key                    xdotool-style chords, see KEYS below; `repeat` presses it again
+ *   wait                   sleep `duration` seconds (default 1)
+ *   cursor_position, mouse_move, middle_click, left_mouse_down/up, hold_key, zoom
+ *                          error result: phones have no cursor, hover or held keys, and there is no
+ *                          in-process image crop
+ *
+ * Key table (case-insensitive xdotool names -> Android pressKey | iOS):
+ *   Return, Enter, KP_Enter     ENTER           | pressKey("enter")
+ *   BackSpace                   DEL             | pressKey("backspace")
+ *   Delete                      FORWARD_DEL     | pressKey("delete")
+ *   Tab                         TAB             | pressKey("tab")
+ *   Escape, Esc                 BACK            | pressKey("escape")
+ *   Back                        BACK            | error (no Back button on iOS)
+ *   Home, Super, XF86HomePage   HOME            | home button
+ *   Up/Down/Left/Right          DPAD_*          | pressKey("up" ...)
+ *   space                       SPACE           | pressKey("space")
+ *   XF86AudioRaiseVolume        VOLUME_UP       | volumeUp button
+ *   XF86AudioLowerVolume        VOLUME_DOWN     | volumeDown button
+ *   XF86AudioMute               VOLUME_MUTE     | error
+ *   Power, XF86PowerOff, Lock   POWER           | lock button
+ *   Menu                        MENU            | error
+ *   a single digit              KEYCODE_<d>     | the digit (Android reads a bare "4" as keycode 4 = BACK)
+ *   anything else               passed through  | passed through, lowercased
+ * Modifiers in a chord (ctrl+a): ctrl/control, shift, alt/option, super/meta/cmd/command.
+ */
+export declare class LimrunProvider implements ComputerProvider {
+    private apiKey;
+    private opts;
+    readonly id = "limrun";
+    /** Android emulators and iPhone simulators. Limrun also offers tablets/iPads, not routed here. */
+    readonly computerOs: ComputerOs[];
+    private sdk?;
+    constructor(apiKey?: string | undefined, opts?: {
+        /** e.g. "10m", up to "24h". Unset uses the organization default (Limrun's own default is 3m). */
+        inactivityTimeout?: string;
+        /** Region or region group, e.g. "us-west1" or "eu". Unset lets Limrun pick by proximity. */
+        region?: string;
+        baseURL?: string;
+    });
+    configured(): boolean;
+    /** @internal */
+    client(): Promise<{
+        mod: LimrunModule;
+        lim: LimrunClient;
+    }>;
+    createComputer(spec: ComputerSpec): Promise<ProviderComputer>;
+    /** Limrun ids don't say which platform they belong to, so try Android, then iOS. */
+    connectComputer(nativeId: string): Promise<ProviderComputer>;
+}
+type LimrunModule = typeof import("@limrun/api");
+type LimrunClient = InstanceType<LimrunModule["Limrun"]>;
+/** @internal "ctrl+Return" on android -> { key: "ENTER", modifiers: ["ctrl"] }. Throws if unavailable. */
+export declare function limrunKey(chord: string, os: "android" | "ios"): {
+    key: string;
+    modifiers: string[];
+    button?: string;
+};
+export {};