@limrun/ui 0.15.1 → 0.16.0

package/README.md

@@ -6,6 +6,16 @@ types and helpers for building inspect, search, and agent interfaces.
 
 See [examples](../../examples/) to see how it can be used.
 
+## Frameless embeds
+
+`@limrun/ui` bundles Limrun's device frames and boot logos as inline images, about
+600 KB. Embeds that render the bare screen can import `@limrun/ui/lite` instead: the same
+`RemoteControl` API without any artwork, so `showFrame` has nothing to draw and the boot
+logo is omitted. Pass your own images through the `assets` prop if you want frames back.
+
+`onConnectionStateChange` reports `connecting`, `connected`, `reconnecting`, `failed`, and
+`terminated` so a host can show status text without tracking the retry logic.
+
 ## Simulated cameras
 
 `RemoteControl` responds automatically when an app in the instance opens,

package/dist/components/remote-control-framed.d.ts

@@ -0,0 +1,2 @@
+import { RemoteControlHandle, RemoteControlProps } from './remote-control';
+export declare const RemoteControl: import('react').ForwardRefExoticComponent<RemoteControlProps & import('react').RefAttributes<RemoteControlHandle>>;

package/dist/components/remote-control.d.ts

@@ -28,6 +28,15 @@ export interface RemoteControlProps {
      * etc.). It is not called for ordinary network drops.
      */
     onTerminated?: () => void;
+    /**
+     * Device frame and boot-logo images. The default export bundles Limrun's
+     * frames; `@limrun/ui/lite` omits them so a frameless embed stays small.
+     */
+    assets?: RemoteControlAssets;
+    /**
+     * Coarse connection lifecycle, for status UI outside the component.
+     */
+    onConnectionStateChange?: (state: RemoteControlConnectionState) => void;
     /**
      * Enable the inspect overlay. When set, the component starts polling the
      * accessibility tree and draws boxes over each element on top of the
@@ -247,5 +256,15 @@ export interface RemoteControlHandle {
     setInspectSelection: (element: AxElement | null) => void;
     getAxStatus: () => AxStatus;
 }
+type DevicePlatform = 'ios' | 'android';
 export declare const withAuthenticationToken: (url: string, token: string) => string;
+export type RemoteControlConnectionState = 'connecting' | 'connected' | 'reconnecting' | 'failed' | 'terminated';
+export type RemoteControlPlatformAssets = {
+    frame?: string;
+    frameLandscape?: string;
+    tabletFrame?: string;
+    tabletFrameLandscape?: string;
+    loadingLogo?: string;
+};
+export type RemoteControlAssets = Partial<Record<DevicePlatform, RemoteControlPlatformAssets>>;
 export declare const RemoteControl: React.ForwardRefExoticComponent<RemoteControlProps & React.RefAttributes<RemoteControlHandle>>;

package/dist/frame-assets.d.ts

@@ -0,0 +1,2 @@
+import { RemoteControlAssets } from './components/remote-control';
+export declare const defaultRemoteControlAssets: RemoteControlAssets;