@rerun-io/web-viewer 0.17.0-alpha.1 → 0.17.0-alpha.101

package/README.md

@@ -41,7 +41,7 @@ viewer.stop();
 ```
 
 The `rrd` in the snippet above should be a URL pointing to either:
-- A hosted `.rrd` file, such as <https://app.rerun.io/version/0.17.0-alpha.1/examples/dna.rrd>
+- A hosted `.rrd` file, such as <https://app.rerun.io/version/0.17.0-alpha.101/examples/dna.rrd>
 - A WebSocket connection to the SDK opened via the [`serve`](https://www.rerun.io/docs/reference/sdk-operating-modes#serve) API
 
 If `rrd` is not set, the Viewer will display the same welcome screen as <https://app.rerun.io>.

package/index.d.ts

@@ -1,256 +1,177 @@
-declare module '@rerun-io/web-viewer' {
-	export class WebViewer {
-		/**
-		 * Start the viewer.
-		 *
-		 * @param rrd URLs to `.rrd` files or WebSocket connections to our SDK.
-		 * @param parent The element to attach the canvas onto.
-		 * @param options Whether to hide the welcome screen.
-		 * */
-		start(rrd?: string | string[] | null | undefined, parent?: HTMLElement | null | undefined, options?: WebViewerOptions | null | undefined): Promise<void>;
-		/**
-		 * Returns `true` if the viewer is ready to connect to data sources.
-		 */
-		get ready(): boolean;
-		/**
-		 * Open a recording.
-		 *
-		 * The viewer must have been started via `WebViewer.start`.
-		 *
-		 * @param rrd URLs to `.rrd` files or WebSocket connections to our SDK.
-		 * @param options
-		 *        - follow_if_http: Whether Rerun should open the resource in "Following" mode when streaming
-		 *        from an HTTP url. Defaults to `false`. Ignored for non-HTTP URLs.
-		 */
-		open(rrd: string | string[], options?: {
-			follow_if_http?: boolean;
-		}): void;
-		/**
-		 * Close a recording.
-		 *
-		 * The viewer must have been started via `WebViewer.start`.
-		 *
-		 * @param rrd URLs to `.rrd` files or WebSocket connections to our SDK.
-		 */
-		close(rrd: string | string[]): void;
-		/**
-		 * Stop the viewer, freeing all associated memory.
-		 *
-		 * The same viewer instance may be started multiple times.
-		 */
-		stop(): void;
-		/**
-		 * Opens a new channel for sending log messages.
-		 *
-		 * The channel can be used to incrementally push `rrd` chunks into the viewer.
-		 *
-		 * @param channel_name used to identify the channel.
-		 *
-		 * */
-		open_channel(channel_name?: string): LogChannel;
-		/**
-		 * Force a panel to a specific state.
-		 *
-		 * */
-		override_panel_state(panel: Panel, state: PanelState): void;
-		/**
-		 * Toggle panel overrides set via `override_panel_state`.
-		 */
-		toggle_panel_overrides(): void;
-		/**
-		 * Toggle fullscreen mode.
-		 *
-		 * This does nothing if `allow_fullscreen` was not set to `true` when starting the viewer.
-		 *
-		 * Fullscreen mode works by updating the underlying `<canvas>` element's `style`:
-		 * - `position` to `fixed`
-		 * - width/height/top/left to cover the entire viewport
-		 *
-		 * When fullscreen mode is toggled off, the style is restored to its previous values.
-		 *
-		 * When fullscreen mode is toggled on, any other instance of the viewer on the page
-		 * which is already in fullscreen mode is toggled off. This means that it doesn't
-		 * have to be tracked manually.
-		 *
-		 * This functionality can also be directly accessed in the viewer:
-		 * - The maximize/minimize top panel button
-		 * - The `Toggle fullscreen` UI command (accessible via the command palette, CTRL+P)
-		 */
-		toggle_fullscreen(): void;
-		#private;
-	}
-	export class LogChannel {
-		
-		constructor(on_send: (data: Uint8Array) => void, on_close: () => void, get_state: () => 'ready' | 'starting' | 'stopped');
-		get ready(): boolean;
-		/**
-		 * Send an `rrd` containing log messages to the viewer.
-		 *
-		 * Does nothing if `!this.ready`.
-		 *
-		 * @param rrd_bytes Is an rrd file stored in a byte array, received via some other side channel.
-		 */
-		send_rrd(rrd_bytes: Uint8Array): void;
-		/**
-		 * Close the channel.
-		 *
-		 * Does nothing if `!this.ready`.
-		 */
-		close(): void;
-		#private;
-	}
-	export type Panel = "top" | "blueprint" | "selection" | "time";
-	export type PanelState = "hidden" | "collapsed" | "expanded";
-	export type Backend = "webgpu" | "webgl";
-	export type CanvasRect = {
-		width: string;
-		height: string;
-		top: string;
-		left: string;
-		bottom: string;
-		right: string;
-	};
-	export type CanvasStyle = {
-		canvas: CanvasRect & {
-			position: string;
-			transition: string;
-		};
-		document: {
-			overflow: string;
-		};
-	};
-	export type FullscreenOff = {
-		on: false;
-		saved_style: null;
-		saved_rect: null;
-	};
-	export type FullscreenOn = {
-		on: true;
-		saved_style: CanvasStyle;
-		saved_rect: DOMRect;
-	};
-	export type FullscreenState = (FullscreenOff | FullscreenOn);
-	export type WebViewerOptions = {
-		/**
-		 * Use a different example manifest.
-		 */
-		manifest_url?: string | undefined;
-		/**
-		 * Force the viewer to use a specific rendering backend.
-		 */
-		render_backend?: Backend | undefined;
-		/**
-		 * Whether to hide the welcome screen in favor of a simpler one.
-		 */
-		hide_welcome_screen?: boolean | undefined;
-		/**
-		 * Whether to allow the viewer to enter fullscreen mode.
-		 */
-		allow_fullscreen?: boolean | undefined;
-	};
-	export type FullscreenOptions = {
-		get_state: () => boolean;
-		on_toggle: () => void;
-	};
+export type Panel = "top" | "blueprint" | "selection" | "time";
+export type PanelState = "hidden" | "collapsed" | "expanded";
+export type Backend = "webgpu" | "webgl";
+export type CanvasRect = {
+    width: string;
+    height: string;
+    top: string;
+    left: string;
+    bottom: string;
+    right: string;
+};
+export type CanvasStyle = {
+    canvas: CanvasRect & {
+        position: string;
+        transition: string;
+        zIndex: string;
+    };
+    document: {
+        body: {
+            overflow: string;
+            scrollbarGutter: string;
+        };
+        root: {
+            overflow: string;
+            scrollbarGutter: string;
+        };
+    };
+};
+interface WebViewerOptions {
+    manifest_url?: string;
+    render_backend?: Backend;
+    hide_welcome_screen?: boolean;
+    allow_fullscreen?: boolean;
 }
-
-declare module '@rerun-io/web-viewer/re_viewer.js' {
-  /* tslint:disable */
-  /* eslint-disable */
-  /**
-  * Used to set the "email" property in the analytics config,
-  * in the same way as `rerun analytics email YOURNAME@rerun.io`.
-  *
-  * This one just panics when it fails, as it's only ever really run
-  * by rerun employees manually in `app.rerun.io`.
-  * */
-  export function set_email(email: string): void;
-
-  export class IntoUnderlyingByteSource {
-	free(): void;
-
-	start(controller: ReadableByteStreamController): void;
-
-	pull(controller: ReadableByteStreamController): Promise<any>;
-
-	cancel(): void;
-
-	readonly autoAllocateChunkSize: number;
-
-	readonly type: string;
-  }
-
-  export class IntoUnderlyingSink {
-	free(): void;
-
-	write(chunk: any): Promise<any>;
-
-	close(): Promise<any>;
-
-	abort(reason: any): Promise<any>;
-  }
-
-  export class IntoUnderlyingSource {
-	free(): void;
-
-	pull(controller: ReadableStreamDefaultController): Promise<any>;
-
-	cancel(): void;
-  }
-
-  export class WebHandle {
-	free(): void;
-
-	constructor(app_options: any);
-  /**
-  * - `url` is an optional URL to either an .rrd file over http, or a Rerun WebSocket server.
-  * - `manifest_url` is an optional URL to an `examples_manifest.json` file over http.
-  * - `force_wgpu_backend` is an optional string to force a specific backend, either `webgl` or `webgpu`.
-  * */
-	start(canvas_id: string): Promise<void>;
-
-	toggle_panel_overrides(): void;
-
-	override_panel_state(panel: string, state?: string): void;
-
-	destroy(): void;
-
-	has_panicked(): boolean;
-
-	panic_message(): string | undefined;
-
-	panic_callstack(): string | undefined;
-  /**
-  * Add a new receiver streaming data from the given url.
-  *
-  * If `follow_if_http` is `true`, and the url is an HTTP source, the viewer will open the stream
-  * in `Following` mode rather than `Playing` mode.
-  *
-  * Websocket streams are always opened in `Following` mode.
-  *
-  * It is an error to open a channel twice with the same id.
-  * 
-  */
-	add_receiver(url: string, follow_if_http?: boolean): void;
-
-	remove_receiver(url: string): void;
-  /**
-  * Open a new channel for streaming data.
-  *
-  * It is an error to open a channel twice with the same id.
-  * */
-	open_channel(id: string, channel_name: string): void;
-  /**
-  * Close an existing channel for streaming data.
-  *
-  * No-op if the channel is already closed.
-  * */
-	close_channel(id: string): void;
-  /**
-  * Add an rrd to the viewer directly from a byte array.
-  * */
-	send_rrd_to_channel(id: string, data: Uint8Array): void;
-  }
+interface WebViewerEvents {
+    fullscreen: boolean;
+    ready: void;
 }
-
+type WithValue<Events> = {
+    [K in keyof Events as Events[K] extends void ? never : K]: Events[K];
+};
+type WithoutValue<Events> = {
+    [K in keyof Events as Events[K] extends void ? K : never]: Events[K];
+};
+type Cancel = () => void;
+export declare class WebViewer {
+    #private;
+    constructor();
+    /**
+     * Start the viewer.
+     *
+     * @param rrd URLs to `.rrd` files or WebSocket connections to our SDK.
+     * @param parent The element to attach the canvas onto.
+     * @param options Whether to hide the welcome screen.
+     */
+    start(rrd: string | string[] | null, parent: HTMLElement | null, options: WebViewerOptions | null): Promise<void>;
+    /**
+     * Register an event listener.
+     *
+     * Returns a function which removes the listener when called.
+     */
+    on<E extends keyof WithValue<WebViewerEvents>>(event: E, callback: (value: WithValue<WebViewerEvents>[E]) => void): Cancel;
+    on<E extends keyof WithoutValue<WebViewerEvents>>(event: E, callback: () => void): Cancel;
+    /**
+     * Register an event listener which runs only once.
+     *
+     * Returns a function which removes the listener when called.
+     */
+    once<E extends keyof WithValue<WebViewerEvents>>(event: E, callback: (value: WithValue<WebViewerEvents>[E]) => void): Cancel;
+    once<E extends keyof WithoutValue<WebViewerEvents>>(event: E, callback: () => void): Cancel;
+    /**
+     * Unregister an event listener.
+     *
+     * The event emitter relies on referential equality to store callbacks.
+     * The `callback` passed in must be the exact same _instance_ of the function passed in to `on` or `once`.
+     */
+    off<E extends keyof WithValue<WebViewerEvents>>(event: E, callback: (value: WithValue<WebViewerEvents>[E]) => void): void;
+    off<E extends keyof WithoutValue<WebViewerEvents>>(event: E, callback: () => void): void;
+    /**
+     * Returns `true` if the viewer is ready to connect to data sources.
+     */
+    get ready(): boolean;
+    /**
+     * Open a recording.
+     *
+     * The viewer must have been started via `WebViewer.start`.
+     *
+     * @param rrd URLs to `.rrd` files or WebSocket connections to our SDK.
+     * @param options
+     *        - follow_if_http: Whether Rerun should open the resource in "Following" mode when streaming
+     *        from an HTTP url. Defaults to `false`. Ignored for non-HTTP URLs.
+     */
+    open(rrd: string | string[], options?: {
+        follow_if_http?: boolean;
+    }): void;
+    /**
+     * Close a recording.
+     *
+     * The viewer must have been started via `WebViewer.start`.
+     *
+     * @param rrd URLs to `.rrd` files or WebSocket connections to our SDK.
+     */
+    close(rrd: string | string[]): void;
+    /**
+     * Stop the viewer, freeing all associated memory.
+     *
+     * The same viewer instance may be started multiple times.
+     */
+    stop(): void;
+    /**
+     * Opens a new channel for sending log messages.
+     *
+     * The channel can be used to incrementally push `rrd` chunks into the viewer.
+     *
+     * @param channel_name used to identify the channel.
+     */
+    open_channel(channel_name?: string): LogChannel;
+    /**
+     * Force a panel to a specific state.
+     *
+     * @param panel
+     * @param state
+     */
+    override_panel_state(panel: Panel, state: PanelState): void;
+    /**
+     * Toggle panel overrides set via `override_panel_state`.
+     *
+     * @param value - set to a specific value. Toggles the previous value if not provided.
+     */
+    toggle_panel_overrides(value?: boolean | null): void;
+    /**
+     * Toggle fullscreen mode.
+     *
+     * This does nothing if `allow_fullscreen` was not set to `true` when starting the viewer.
+     *
+     * Fullscreen mode works by updating the underlying `<canvas>` element's `style`:
+     * - `position` to `fixed`
+     * - width/height/top/left to cover the entire viewport
+     *
+     * When fullscreen mode is toggled off, the style is restored to its previous values.
+     *
+     * When fullscreen mode is toggled on, any other instance of the viewer on the page
+     * which is already in fullscreen mode is toggled off. This means that it doesn't
+     * have to be tracked manually.
+     *
+     * This functionality can also be directly accessed in the viewer:
+     * - The maximize/minimize top panel button
+     * - The `Toggle fullscreen` UI command (accessible via the command palette, CTRL+P)
+     */
+    toggle_fullscreen(): void;
+}
+declare class LogChannel {
+    #private;
+    /**
+     * @param on_send
+     * @param on_close
+     * @param get_state
+     */
+    constructor(on_send: (data: Uint8Array) => void, on_close: () => void, get_state: () => "ready" | "starting" | "stopped");
+    get ready(): boolean;
+    /**
+     * Send an `rrd` containing log messages to the viewer.
+     *
+     * Does nothing if `!this.ready`.
+     *
+     * @param rrd_bytes Is an rrd file stored in a byte array, received via some other side channel.
+     */
+    send_rrd(rrd_bytes: Uint8Array): void;
+    /**
+     * Close the channel.
+     *
+     * Does nothing if `!this.ready`.
+     */
+    close(): void;
+}
+export {};
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1,28 +1 @@
-{
-	"version": 3,
-	"file": "index.d.ts",
-	"names": [
-		"WebViewer",
-		"LogChannel",
-		"Panel",
-		"PanelState",
-		"Backend",
-		"FullscreenOff",
-		"FullscreenOn",
-		"FullscreenState",
-		"set_email",
-		"IntoUnderlyingByteSource",
-		"IntoUnderlyingSink",
-		"IntoUnderlyingSource",
-		"WebHandle"
-	],
-	"sources": [
-		"index.js",
-		"re_viewer.d.ts"
-	],
-	"sourcesContent": [
-		null,
-		null
-	],
-	"mappings": ";cAiEaA,SAASA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAoVTC,UAAUA;;;;;;;;;;;;;;;;;;;;aAtXkCC,KAAKA;aAEZC,UAAUA;aAE3BC,OAAOA;;;;;;;;;;;;;;;;;;aAayBC,aAAaA;;;;;aAEJC,YAAYA;;;;;aAEzCC,eAAeA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBC1C5CC,SAASA;;eAGZC,wBAAwBA;;;;;;;;;;;;;;eAuBxBC,kBAAkBA;;;;;;;;;;eAmBlBC,oBAAoBA;;;;;;;;eAapBC,SAASA"
-}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAqCA,MAAM,MAAM,KAAK,GAAG,KAAK,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;AAC/D,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAC;AAC7D,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;AACzC,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,UAAU,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9E,QAAQ,EAAE;QACR,IAAI,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,MAAM,CAAA;SAAE,CAAC;QACpD,IAAI,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,CAAC;CACH,CAAC;AAEF,UAAU,gBAAgB;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAOD,UAAU,eAAe;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,KAAK,EAAE,IAAI,CAAC;CACb;AAcD,KAAK,SAAS,CAAC,MAAM,IAAI;KACtB,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;CACrE,CAAC;AAEF,KAAK,YAAY,CAAC,MAAM,IAAI;KACzB,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC;CACrE,CAAC;AAEF,KAAK,MAAM,GAAG,MAAM,IAAI,CAAC;AAEzB,qBAAa,SAAS;;;IAkBpB;;;;;;OAMG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,EAC7B,MAAM,EAAE,WAAW,GAAG,IAAI,EAC1B,OAAO,EAAE,gBAAgB,GAAG,IAAI,GAC/B,OAAO,CAAC,IAAI,CAAC;IA6DhB;;;;OAIG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,SAAS,CAAC,eAAe,CAAC,EAC3C,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GACvD,MAAM;IACT,EAAE,CAAC,CAAC,SAAS,MAAM,YAAY,CAAC,eAAe,CAAC,EAC9C,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,MAAM,IAAI,GACnB,MAAM;IAQT;;;;OAIG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,SAAS,CAAC,eAAe,CAAC,EAC7C,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GACvD,MAAM;IACT,IAAI,CAAC,CAAC,SAAS,MAAM,YAAY,CAAC,eAAe,CAAC,EAChD,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,MAAM,IAAI,GACnB,MAAM;IAQT;;;;;OAKG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,SAAS,CAAC,eAAe,CAAC,EAC5C,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GACvD,IAAI;IACP,GAAG,CAAC,CAAC,SAAS,MAAM,YAAY,CAAC,eAAe,CAAC,EAC/C,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,MAAM,IAAI,GACnB,IAAI;IAYP;;OAEG;IACH,IAAI,KAAK,YAER;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,GAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAA;KAAO;IAavE;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAa5B;;;;OAIG;IACH,IAAI;IAkBJ;;;;;;OAMG;IACH,YAAY,CAAC,YAAY,GAAE,MAA8B,GAAG,UAAU;IA4BtE;;;;;OAKG;IACH,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU;IASpD;;;;OAIG;IACH,sBAAsB,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI;IAS7C;;;;;;;;;;;;;;;;;;OAkBG;IACH,iBAAiB;CAsElB;AAED,cAAM,UAAU;;IAMd;;;;OAIG;gBAED,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,EACnC,QAAQ,EAAE,MAAM,IAAI,EACpB,SAAS,EAAE,MAAM,OAAO,GAAG,UAAU,GAAG,SAAS;IAOnD,IAAI,KAAK,YAER;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,EAAE,UAAU;IAK9B;;;;OAIG;IACH,KAAK;CAKN"}