@rerun-io/web-viewer 0.0.3 → 0.0.5

package/README.md

@@ -12,12 +12,14 @@ Embed the Rerun web viewer within your app.
 npm i @rerun-io/web-viewer
 ```
 
-## Example
+## Usage
+
+The web viewer is an object which manages a canvas element:
 
 ```js
 import { WebViewer } from "@rerun-io/web-viewer";
 
-const URL = "...";
+const URL = "…";
 const parentElement = document.body;
 
 const viewer = new WebViewer();
@@ -27,9 +29,14 @@ await viewer.start(URL, parentElement);
 viewer.stop();
 ```
 
+You can style this canvas element however you wish.
+
+For a live example, see https://github.com/rerun-io/web-viewer-example.
+
 ℹ️ Note:
-This package only targets recent browsers.
-Your environment must support importing `.wasm` files as ES modules.
+This package only targets recent versions of browsers.
+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.map

@@ -10,5 +10,5 @@
 	"sourcesContent": [
 		null
 	],
-	"mappings": ";cAoBaA,SAASA"
+	"mappings": ";cAqBaA,SAASA"
 }

package/index.js

@@ -1,5 +1,6 @@
 /** @type {(typeof import("./re_viewer").WebHandle) | null} */
 let WebHandle = null;
+
 /** @returns {Promise<(typeof import("./re_viewer").WebHandle)>} */
 async function load() {
   if (WebHandle) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rerun-io/web-viewer",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Embed the Rerun web viewer in your app",
   "private": false,
   "scripts": {
@@ -26,16 +26,19 @@
     }
   },
   "files": [
-    "package.json",
-    "tsconfig.json",
     "index.d.ts",
     "index.d.ts.map",
     "index.js",
-    "re_viewer.js",
+    "package.json",
     "re_viewer_bg.js",
-    "re_viewer_bg.wasm"
+    "re_viewer_bg.wasm",
+    "re_viewer_bg.wasm.d.ts",
+    "re_viewer.d.ts",
+    "re_viewer.js",
+    "tsconfig.json"
   ],
   "devDependencies": {
     "dts-buddy": "^0.3.0"
   }
 }
+

package/re_viewer.d.ts

@@ -0,0 +1,135 @@
+/* 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` and `demo.rerun.io`.
+* @param {string} email
+*/
+export function set_email(email: string): void;
+/**
+* @returns {boolean}
+*/
+export function is_webgpu_build(): boolean;
+/**
+*/
+export class IntoUnderlyingByteSource {
+  free(): void;
+/**
+* @param {any} controller
+*/
+  start(controller: any): void;
+/**
+* @param {any} controller
+* @returns {Promise<any>}
+*/
+  pull(controller: any): Promise<any>;
+/**
+*/
+  cancel(): void;
+/**
+*/
+  readonly autoAllocateChunkSize: number;
+/**
+*/
+  readonly type: string;
+}
+/**
+*/
+export class IntoUnderlyingSink {
+  free(): void;
+/**
+* @param {any} chunk
+* @returns {Promise<any>}
+*/
+  write(chunk: any): Promise<any>;
+/**
+* @returns {Promise<any>}
+*/
+  close(): Promise<any>;
+/**
+* @param {any} reason
+* @returns {Promise<any>}
+*/
+  abort(reason: any): Promise<any>;
+}
+/**
+*/
+export class IntoUnderlyingSource {
+  free(): void;
+/**
+* @param {any} controller
+* @returns {Promise<any>}
+*/
+  pull(controller: any): Promise<any>;
+/**
+*/
+  cancel(): void;
+}
+/**
+* Raw options for [`pipeTo()`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/pipeTo).
+*/
+export class PipeOptions {
+  free(): void;
+/**
+*/
+  readonly preventAbort: boolean;
+/**
+*/
+  readonly preventCancel: boolean;
+/**
+*/
+  readonly preventClose: boolean;
+/**
+*/
+  readonly signal: AbortSignal | undefined;
+}
+/**
+*/
+export class QueuingStrategy {
+  free(): void;
+/**
+*/
+  readonly highWaterMark: number;
+}
+/**
+* Raw options for [`getReader()`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/getReader).
+*/
+export class ReadableStreamGetReaderOptions {
+  free(): void;
+/**
+*/
+  readonly mode: any;
+}
+/**
+*/
+export class WebHandle {
+  free(): void;
+/**
+*/
+  constructor();
+/**
+* The `url` is an optional URL to either an .rrd file over http, or a Rerun WebSocket server.
+* @param {string} canvas_id
+* @param {string | undefined} url
+* @returns {Promise<void>}
+*/
+  start(canvas_id: string, url?: string): Promise<void>;
+/**
+*/
+  destroy(): void;
+/**
+* @returns {boolean}
+*/
+  has_panicked(): boolean;
+/**
+* @returns {string | undefined}
+*/
+  panic_message(): string | undefined;
+/**
+* @returns {string | undefined}
+*/
+  panic_callstack(): string | undefined;
+}

package/re_viewer_bg.js

@@ -222,7 +222,7 @@ function makeMutClosure(arg0, arg1, dtor, f) {
     return real;
 }
 function __wbg_adapter_34(arg0, arg1) {
-    wasm._dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h26bff2fe5bb8091b(arg0, arg1);
+    wasm._dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h19f36e795f279e4e(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__h1d488392a2c0d13f(arg0, arg1, addHeapObject(arg2));
+    wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf62c39bd238416f9(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_b424bd9d109e243c() {
+export function __wbg_new_02033526dbe870ef() {
     const ret = new Error();
     return addHeapObject(ret);
 };
 
-export function __wbg_stack_2470b2f506a1b8ac(arg0, arg1) {
+export function __wbg_stack_0da49df82f1c2e5e(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_b356498904723165(arg0, arg1) {
+export function __wbg_warn_b1efb2be4ed0fa0b(arg0, arg1) {
     console.warn(getStringFromWasm0(arg0, arg1));
 };
 
-export function __wbg_info_a208c48409d76df8(arg0, arg1) {
+export function __wbg_info_24e0aa3b319f10d4(arg0, arg1) {
     console.info(getStringFromWasm0(arg0, arg1));
 };
 
-export function __wbg_debug_02d081a2eb0edf8f(arg0, arg1) {
+export function __wbg_debug_7bfb2f72cf3c5137(arg0, arg1) {
     console.debug(getStringFromWasm0(arg0, arg1));
 };
 
-export function __wbg_trace_cd675cecd21ae19b(arg0, arg1) {
+export function __wbg_trace_8e7ed7406eb38dfd(arg0, arg1) {
     console.trace(getStringFromWasm0(arg0, arg1));
 };
 
@@ -3059,53 +3059,53 @@ export function __wbindgen_closure_wrapper2348(arg0, arg1, arg2) {
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper5731(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 1734, __wbg_adapter_40);
+export function __wbindgen_closure_wrapper5754(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 1729, __wbg_adapter_40);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper5733(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 1734, __wbg_adapter_43);
+export function __wbindgen_closure_wrapper5756(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 1729, __wbg_adapter_43);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper5735(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 1734, __wbg_adapter_46);
+export function __wbindgen_closure_wrapper5758(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 1729, __wbg_adapter_46);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper19328(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 6674, __wbg_adapter_49);
+export function __wbindgen_closure_wrapper19354(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 6664, __wbg_adapter_49);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper19330(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 6674, __wbg_adapter_49);
+export function __wbindgen_closure_wrapper19356(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 6664, __wbg_adapter_49);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper19332(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 6674, __wbg_adapter_49);
+export function __wbindgen_closure_wrapper19358(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 6664, __wbg_adapter_49);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper19334(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 6674, __wbg_adapter_49);
+export function __wbindgen_closure_wrapper19360(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 6664, __wbg_adapter_49);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper19788(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 6921, __wbg_adapter_58);
+export function __wbindgen_closure_wrapper19814(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 6911, __wbg_adapter_58);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper20512(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 7326, __wbg_adapter_61);
+export function __wbindgen_closure_wrapper20537(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 7315, __wbg_adapter_61);
     return addHeapObject(ret);
 };
 
-export function __wbindgen_closure_wrapper20544(arg0, arg1, arg2) {
-    const ret = makeMutClosure(arg0, arg1, 7337, __wbg_adapter_64);
+export function __wbindgen_closure_wrapper20569(arg0, arg1, arg2) {
+    const ret = makeMutClosure(arg0, arg1, 7326, __wbg_adapter_64);
     return addHeapObject(ret);
 };
 

package/re_viewer_bg.wasm.d.ts

@@ -0,0 +1,97 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export function __wbg_webhandle_free(a: number): void;
+export function webhandle_new(): number;
+export function webhandle_start(a: number, b: number, c: number, d: number, e: number): number;
+export function webhandle_destroy(a: number): void;
+export function webhandle_has_panicked(a: number): number;
+export function webhandle_panic_message(a: number, b: number): void;
+export function webhandle_panic_callstack(a: number, b: number): void;
+export function set_email(a: number, b: number): void;
+export function is_webgpu_build(): number;
+export function wgpu_compute_pass_set_pipeline(a: number, b: number): void;
+export function wgpu_compute_pass_set_bind_group(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_compute_pass_set_push_constant(a: number, b: number, c: number, d: number): void;
+export function wgpu_compute_pass_insert_debug_marker(a: number, b: number, c: number): void;
+export function wgpu_compute_pass_push_debug_group(a: number, b: number, c: number): void;
+export function wgpu_compute_pass_pop_debug_group(a: number): void;
+export function wgpu_compute_pass_write_timestamp(a: number, b: number, c: number): void;
+export function wgpu_compute_pass_begin_pipeline_statistics_query(a: number, b: number, c: number): void;
+export function wgpu_compute_pass_end_pipeline_statistics_query(a: number): void;
+export function wgpu_compute_pass_dispatch_workgroups(a: number, b: number, c: number, d: number): void;
+export function wgpu_compute_pass_dispatch_workgroups_indirect(a: number, b: number, c: number): void;
+export function wgpu_render_bundle_set_pipeline(a: number, b: number): void;
+export function wgpu_render_bundle_set_bind_group(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_bundle_set_vertex_buffer(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_bundle_set_push_constants(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_bundle_draw(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_bundle_draw_indexed(a: number, b: number, c: number, d: number, e: number, f: number): void;
+export function wgpu_render_bundle_draw_indirect(a: number, b: number, c: number): void;
+export function wgpu_render_bundle_draw_indexed_indirect(a: number, b: number, c: number): void;
+export function wgpu_render_pass_set_pipeline(a: number, b: number): void;
+export function wgpu_render_pass_set_bind_group(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_pass_set_vertex_buffer(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_pass_set_push_constants(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_pass_draw(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_pass_draw_indexed(a: number, b: number, c: number, d: number, e: number, f: number): void;
+export function wgpu_render_pass_draw_indirect(a: number, b: number, c: number): void;
+export function wgpu_render_pass_draw_indexed_indirect(a: number, b: number, c: number): void;
+export function wgpu_render_pass_multi_draw_indirect(a: number, b: number, c: number, d: number): void;
+export function wgpu_render_pass_multi_draw_indexed_indirect(a: number, b: number, c: number, d: number): void;
+export function wgpu_render_pass_multi_draw_indirect_count(a: number, b: number, c: number, d: number, e: number, f: number): void;
+export function wgpu_render_pass_multi_draw_indexed_indirect_count(a: number, b: number, c: number, d: number, e: number, f: number): void;
+export function wgpu_render_pass_set_blend_constant(a: number, b: number): void;
+export function wgpu_render_pass_set_scissor_rect(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_pass_set_viewport(a: number, b: number, c: number, d: number, e: number, f: number, g: number): void;
+export function wgpu_render_pass_set_stencil_reference(a: number, b: number): void;
+export function wgpu_render_pass_insert_debug_marker(a: number, b: number, c: number): void;
+export function wgpu_render_pass_push_debug_group(a: number, b: number, c: number): void;
+export function wgpu_render_pass_pop_debug_group(a: number): void;
+export function wgpu_render_pass_write_timestamp(a: number, b: number, c: number): void;
+export function wgpu_render_pass_begin_pipeline_statistics_query(a: number, b: number, c: number): void;
+export function wgpu_render_pass_end_pipeline_statistics_query(a: number): void;
+export function wgpu_render_pass_execute_bundles(a: number, b: number, c: number): void;
+export function wgpu_render_pass_set_index_buffer(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_bundle_set_index_buffer(a: number, b: number, c: number, d: number, e: number): void;
+export function wgpu_render_bundle_pop_debug_group(a: number): void;
+export function wgpu_render_bundle_insert_debug_marker(a: number, b: number): void;
+export function wgpu_render_bundle_push_debug_group(a: number, b: number): void;
+export function __wbg_readablestreamgetreaderoptions_free(a: number): void;
+export function readablestreamgetreaderoptions_mode(a: number): number;
+export function __wbg_pipeoptions_free(a: number): void;
+export function pipeoptions_preventClose(a: number): number;
+export function pipeoptions_preventCancel(a: number): number;
+export function pipeoptions_preventAbort(a: number): number;
+export function pipeoptions_signal(a: number): number;
+export function __wbg_intounderlyingsink_free(a: number): void;
+export function intounderlyingsink_write(a: number, b: number): number;
+export function intounderlyingsink_close(a: number): number;
+export function intounderlyingsink_abort(a: number, b: number): number;
+export function __wbg_intounderlyingbytesource_free(a: number): void;
+export function intounderlyingbytesource_type(a: number, b: number): void;
+export function intounderlyingbytesource_autoAllocateChunkSize(a: number): number;
+export function intounderlyingbytesource_start(a: number, b: number): void;
+export function intounderlyingbytesource_pull(a: number, b: number): number;
+export function intounderlyingbytesource_cancel(a: number): void;
+export function __wbg_queuingstrategy_free(a: number): void;
+export function queuingstrategy_highWaterMark(a: number): number;
+export function __wbg_intounderlyingsource_free(a: number): void;
+export function intounderlyingsource_pull(a: number, b: number): number;
+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 _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h19f36e795f279e4e(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__hf62c39bd238416f9(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;
+export function __wbindgen_exn_store(a: number): void;
+export function wasm_bindgen__convert__closures__invoke2_mut__h1cdbc2433d9b182f(a: number, b: number, c: number, d: number): void;