@rerun-io/web-viewer 0.11.0-rc.2 → 0.11.0

package/README.md

@@ -12,6 +12,8 @@ Embed the Rerun web viewer within your app.
   </picture>
 </p>
 
+This package is framework-agnostic. A React wrapper is available at <https://www.npmjs.com/package/@rerun-io/web-viewer-react>.
+
 ## Install
 
 ```
@@ -29,22 +31,27 @@ The web viewer is an object which manages a canvas element:
 ```js
 import { WebViewer } from "@rerun-io/web-viewer";
 
-const URL = "…";
+const rrd = "…";
 const parentElement = document.body;
 
 const viewer = new WebViewer();
-await viewer.start(URL, parentElement);
+await viewer.start(rrd, parentElement);
 // …
 viewer.stop();
 ```
 
-You can style this canvas element however you wish.
+The `rrd` in the snippet above should be a URL pointing to either:
+- A hosted `.rrd` file, such as <https://demo.rerun.io/version/0.11.0/examples/dna/data.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>.
 
-For a live example, see https://github.com/rerun-io/web-viewer-example.
+For a full example, see https://github.com/rerun-io/web-viewer-example.
+You can open the example via CodeSandbox: https://codesandbox.io/s/github/rerun-io/web-viewer-example
 
 ℹ️ Note:
 This package only targets recent versions of browsers.
-If your target browser does not support Wasm imports, you may need to install additional plugins for your bundler.
+If your target browser does not support Wasm imports or top-level await, you may need to install additional plugins for your bundler.
 
 ## Development
 

package/index.d.ts

@@ -1,7 +1,17 @@
 declare module '@rerun-io/web-viewer' {
 	export class WebViewer {
-		
-		start(url: string, parent?: HTMLElement | undefined): Promise<this>;
+		/**
+		 * Start the viewer.
+		 *
+		 * @param rrd Optional URL to an `.rrd` file or a WebSocket connection to our SDK.
+		 * @param parent The element to attach the canvas onto.
+		 * */
+		start(rrd?: string | undefined, parent?: HTMLElement | undefined): Promise<this>;
+		/**
+		 * Stop the viewer, freeing all associated memory.
+		 *
+		 * The same viewer instance may be started multiple times.
+		 */
 		stop(): void;
 		#private;
 	}

package/index.js

@@ -29,18 +29,22 @@ export class WebViewer {
   #canvas = null;
 
   /**
-   * @param {string} url
-   * @param {HTMLElement} [parent]
+   * Start the viewer.
+   *
+   * @param {string} [rrd] Optional URL to an `.rrd` file or a WebSocket connection to our SDK.
+   * @param {HTMLElement} [parent] The element to attach the canvas onto.
    * @returns {Promise<this>}
    */
-  async start(url, parent = document.body) {
+  async start(rrd, parent = document.body) {
+    if (this.#canvas || this.#handle) return this;
+
     const canvas = document.createElement("canvas");
     canvas.id = randomId();
     parent.append(canvas);
 
     let WebHandle_class = await load();
     const handle = new WebHandle_class();
-    await handle.start(canvas.id, url);
+    await handle.start(canvas.id, rrd);
     if (handle.has_panicked()) {
       throw new Error(`Web viewer crashed: ${handle.panic_message()}`);
     }
@@ -51,6 +55,11 @@ export class WebViewer {
     return this;
   }
 
+  /**
+   * Stop the viewer, freeing all associated memory.
+   *
+   * The same viewer instance may be started multiple times.
+   */
   stop() {
     const canvas = this.#canvas;
     this.#canvas = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rerun-io/web-viewer",
-  "version": "0.11.0-rc.2",
+  "version": "0.11.0",
   "description": "Embed the Rerun web viewer in your app",
   "private": false,
   "scripts": {

package/re_viewer_bg.js

@@ -222,7 +222,7 @@ function makeMutClosure(arg0, arg1, dtor, f) {
     return real;
 }
 function __wbg_adapter_34(arg0, arg1) {
-    wasm.wasm_bindgen__convert__closures__invoke0_mut__h4e9cae6d6fc22dfc(arg0, arg1);
+    wasm.wasm_bindgen__convert__closures__invoke0_mut__h4d9356db3b382851(arg0, arg1);
 }
 
 function __wbg_adapter_37(arg0, arg1) {
@@ -256,7 +256,7 @@ function __wbg_adapter_49(arg0, arg1, arg2) {
 }
 
 function __wbg_adapter_58(arg0, arg1, arg2) {
-    wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h05437f072e049986(arg0, arg1, addHeapObject(arg2));
+    wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hb6c91d6a883cccef(arg0, arg1, addHeapObject(arg2));
 }
 
 function __wbg_adapter_61(arg0, arg1, arg2) {
@@ -709,12 +709,12 @@ export function __wbg_stack_21698d2a5852e13e(arg0, arg1) {
     getInt32Memory0()[arg0 / 4 + 0] = ptr1;
 };
 
-export function __wbg_new_287714cd5c6f18a9() {
+export function __wbg_new_0903e6940a560550() {
     const ret = new Error();
     return addHeapObject(ret);
 };
 
-export function __wbg_stack_90ed2cb26a44af6d(arg0, arg1) {
+export function __wbg_stack_fc23607ceb8c8fbf(arg0, arg1) {
     const ret = getObject(arg1).stack;
     const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len1 = WASM_VECTOR_LEN;
@@ -2678,19 +2678,19 @@ export function __wbg_matches_0f7e350783b542c2(arg0) {
     return ret;
 };
 
-export function __wbg_warn_dffc7c9a4d0b138d(arg0, arg1) {
+export function __wbg_warn_15e5227af2df42e7(arg0, arg1) {
     console.warn(getStringFromWasm0(arg0, arg1));
 };
 
-export function __wbg_info_29fe28d65b2f584e(arg0, arg1) {
+export function __wbg_info_400b2eea0b4c0ff9(arg0, arg1) {
     console.info(getStringFromWasm0(arg0, arg1));
 };
 
-export function __wbg_debug_2049441b2d4a6151(arg0, arg1) {
+export function __wbg_debug_79e9757132ad993c(arg0, arg1) {
     console.debug(getStringFromWasm0(arg0, arg1));
 };
 
-export function __wbg_trace_8ebe5a732b4b5eb8(arg0, arg1) {
+export function __wbg_trace_f505d9f2cc9953a6(arg0, arg1) {
     console.trace(getStringFromWasm0(arg0, arg1));
 };
 
@@ -3049,63 +3049,63 @@ export function __wbindgen_memory() {
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper1804(arg0, arg1, arg2) {
+export function __wbindgen_closure_wrapper1797(arg0, arg1, arg2) {
     const ret = makeMutClosure(arg0, arg1, 475, __wbg_adapter_34);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper2425(arg0, arg1, arg2) {
+export function __wbindgen_closure_wrapper2420(arg0, arg1, arg2) {
     const ret = makeMutClosure(arg0, arg1, 619, __wbg_adapter_37);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper4138(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 1163, __wbg_adapter_40);
+export function __wbindgen_closure_wrapper4144(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 1169, __wbg_adapter_40);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper4140(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 1163, __wbg_adapter_43);
+export function __wbindgen_closure_wrapper4146(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 1169, __wbg_adapter_43);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper4142(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 1163, __wbg_adapter_46);
+export function __wbindgen_closure_wrapper4148(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 1169, __wbg_adapter_46);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper20063(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 6984, __wbg_adapter_49);
+export function __wbindgen_closure_wrapper20075(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 6994, __wbg_adapter_49);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper20065(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 6984, __wbg_adapter_49);
+export function __wbindgen_closure_wrapper20077(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 6994, __wbg_adapter_49);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper20067(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 6984, __wbg_adapter_49);
+export function __wbindgen_closure_wrapper20079(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 6994, __wbg_adapter_49);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper20069(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 6984, __wbg_adapter_49);
+export function __wbindgen_closure_wrapper20081(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 6994, __wbg_adapter_49);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper20877(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 7530, __wbg_adapter_58);
+export function __wbindgen_closure_wrapper20889(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 7540, __wbg_adapter_58);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper21250(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 7639, __wbg_adapter_61);
+export function __wbindgen_closure_wrapper21262(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 7649, __wbg_adapter_61);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper21282(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 7650, __wbg_adapter_64);
+export function __wbindgen_closure_wrapper21294(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 7660, __wbg_adapter_64);
     return addHeapObject(ret);
 };
 

package/re_viewer_bg.wasm.d.ts

@@ -82,14 +82,14 @@ export function intounderlyingsource_cancel(a: number): void;
 export function __wbindgen_malloc(a: number, b: number): number;
 export function __wbindgen_realloc(a: number, b: number, c: number, d: number): number;
 export const __wbindgen_export_2: WebAssembly.Table;
-export function wasm_bindgen__convert__closures__invoke0_mut__h4e9cae6d6fc22dfc(a: number, b: number): void;
+export function wasm_bindgen__convert__closures__invoke0_mut__h4d9356db3b382851(a: number, b: number): void;
 export function wasm_bindgen__convert__closures__invoke0_mut__hbb2d466e4a580595(a: number, b: number): void;
 export function _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf64c3fc72d424f95(a: number, b: number): void;
 export function _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hcda1bc7f6baacddd(a: number, b: number, c: number): void;
 export function __wbindgen_add_to_stack_pointer(a: number): number;
 export function _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h3960a85cd94e1623(a: number, b: number, c: number): void;
 export function _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h00f3b5d0b78ac098(a: number, b: number, c: number): void;
-export function _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h05437f072e049986(a: number, b: number, c: number): void;
+export function _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hb6c91d6a883cccef(a: number, b: number, c: number): void;
 export function _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hefb91f3bd6a8bfc9(a: number, b: number, c: number): void;
 export function _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hbc8a650979ad564c(a: number, b: number, c: number): void;
 export function __wbindgen_free(a: number, b: number, c: number): void;