@rerun-io/web-viewer 0.0.3 → 0.0.4

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": ";cAuBaA,SAASA"
 }

package/index.js

@@ -1,12 +1,15 @@
-/** @type {(typeof import("./re_viewer").WebHandle) | null} */
-let WebHandle = null;
-/** @returns {Promise<(typeof import("./re_viewer").WebHandle)>} */
+import init, { WebHandle } from "./re_viewer.js";
+
+/** @type {(import("./re_viewer").InitOutput) | null} */
+let module = null;
+
+/** @returns {Promise<(import("./re_viewer").InitOutput)>} */
 async function load() {
-  if (WebHandle) {
-    return WebHandle;
+  if (module) {
+    return module;
   }
-  WebHandle = (await import("./re_viewer")).WebHandle;
-  return WebHandle;
+  module = await init(new URL("./re_viewer_bg.wasm", import.meta.url));
+  return module;
 }
 
 /** @returns {string} */
@@ -19,7 +22,7 @@ function randomId() {
 }
 
 export class WebViewer {
-  /** @type {(import("./re_viewer").WebHandle) | null} */
+  /** @type {WebHandle | null} */
   #handle = null;
 
   /** @type {HTMLCanvasElement | null} */
@@ -35,8 +38,8 @@ export class WebViewer {
     canvas.id = randomId();
     parent.append(canvas);
 
-    let WebHandle_class = await load();
-    const handle = new WebHandle_class();
+    await load();
+    const handle = new WebHandle();
     await handle.start(canvas.id, url);
     if (handle.has_panicked()) {
       throw new Error(`Web viewer crashed: ${handle.panic_message()}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rerun-io/web-viewer",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "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,256 @@
+/* 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;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_webhandle_free: (a: number) => void;
+  readonly webhandle_new: () => number;
+  readonly webhandle_start: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly webhandle_destroy: (a: number) => void;
+  readonly webhandle_has_panicked: (a: number) => number;
+  readonly webhandle_panic_message: (a: number, b: number) => void;
+  readonly webhandle_panic_callstack: (a: number, b: number) => void;
+  readonly set_email: (a: number, b: number) => void;
+  readonly is_webgpu_build: () => number;
+  readonly wgpu_compute_pass_set_pipeline: (a: number, b: number) => void;
+  readonly wgpu_compute_pass_set_bind_group: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_compute_pass_set_push_constant: (a: number, b: number, c: number, d: number) => void;
+  readonly wgpu_compute_pass_insert_debug_marker: (a: number, b: number, c: number) => void;
+  readonly wgpu_compute_pass_push_debug_group: (a: number, b: number, c: number) => void;
+  readonly wgpu_compute_pass_pop_debug_group: (a: number) => void;
+  readonly wgpu_compute_pass_write_timestamp: (a: number, b: number, c: number) => void;
+  readonly wgpu_compute_pass_begin_pipeline_statistics_query: (a: number, b: number, c: number) => void;
+  readonly wgpu_compute_pass_end_pipeline_statistics_query: (a: number) => void;
+  readonly wgpu_compute_pass_dispatch_workgroups: (a: number, b: number, c: number, d: number) => void;
+  readonly wgpu_compute_pass_dispatch_workgroups_indirect: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_bundle_set_pipeline: (a: number, b: number) => void;
+  readonly wgpu_render_bundle_set_bind_group: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_bundle_set_vertex_buffer: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_bundle_set_push_constants: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_bundle_draw: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_bundle_draw_indexed: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+  readonly wgpu_render_bundle_draw_indirect: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_bundle_draw_indexed_indirect: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_pass_set_pipeline: (a: number, b: number) => void;
+  readonly wgpu_render_pass_set_bind_group: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_pass_set_vertex_buffer: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_pass_set_push_constants: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_pass_draw: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_pass_draw_indexed: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+  readonly wgpu_render_pass_draw_indirect: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_pass_draw_indexed_indirect: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_pass_multi_draw_indirect: (a: number, b: number, c: number, d: number) => void;
+  readonly wgpu_render_pass_multi_draw_indexed_indirect: (a: number, b: number, c: number, d: number) => void;
+  readonly wgpu_render_pass_multi_draw_indirect_count: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+  readonly wgpu_render_pass_multi_draw_indexed_indirect_count: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+  readonly wgpu_render_pass_set_blend_constant: (a: number, b: number) => void;
+  readonly wgpu_render_pass_set_scissor_rect: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_pass_set_viewport: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+  readonly wgpu_render_pass_set_stencil_reference: (a: number, b: number) => void;
+  readonly wgpu_render_pass_insert_debug_marker: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_pass_push_debug_group: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_pass_pop_debug_group: (a: number) => void;
+  readonly wgpu_render_pass_write_timestamp: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_pass_begin_pipeline_statistics_query: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_pass_end_pipeline_statistics_query: (a: number) => void;
+  readonly wgpu_render_pass_execute_bundles: (a: number, b: number, c: number) => void;
+  readonly wgpu_render_pass_set_index_buffer: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_bundle_set_index_buffer: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly wgpu_render_bundle_pop_debug_group: (a: number) => void;
+  readonly wgpu_render_bundle_insert_debug_marker: (a: number, b: number) => void;
+  readonly wgpu_render_bundle_push_debug_group: (a: number, b: number) => void;
+  readonly __wbg_readablestreamgetreaderoptions_free: (a: number) => void;
+  readonly readablestreamgetreaderoptions_mode: (a: number) => number;
+  readonly __wbg_pipeoptions_free: (a: number) => void;
+  readonly pipeoptions_preventClose: (a: number) => number;
+  readonly pipeoptions_preventCancel: (a: number) => number;
+  readonly pipeoptions_preventAbort: (a: number) => number;
+  readonly pipeoptions_signal: (a: number) => number;
+  readonly __wbg_intounderlyingsink_free: (a: number) => void;
+  readonly intounderlyingsink_write: (a: number, b: number) => number;
+  readonly intounderlyingsink_close: (a: number) => number;
+  readonly intounderlyingsink_abort: (a: number, b: number) => number;
+  readonly __wbg_intounderlyingbytesource_free: (a: number) => void;
+  readonly intounderlyingbytesource_type: (a: number, b: number) => void;
+  readonly intounderlyingbytesource_autoAllocateChunkSize: (a: number) => number;
+  readonly intounderlyingbytesource_start: (a: number, b: number) => void;
+  readonly intounderlyingbytesource_pull: (a: number, b: number) => number;
+  readonly intounderlyingbytesource_cancel: (a: number) => void;
+  readonly __wbg_queuingstrategy_free: (a: number) => void;
+  readonly queuingstrategy_highWaterMark: (a: number) => number;
+  readonly __wbg_intounderlyingsource_free: (a: number) => void;
+  readonly intounderlyingsource_pull: (a: number, b: number) => number;
+  readonly intounderlyingsource_cancel: (a: number) => void;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_export_2: WebAssembly.Table;
+  readonly _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h19f36e795f279e4e: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures__invoke0_mut__hbb2d466e4a580595: (a: number, b: number) => void;
+  readonly _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf64c3fc72d424f95: (a: number, b: number) => void;
+  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hcda1bc7f6baacddd: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h3960a85cd94e1623: (a: number, b: number, c: number) => void;
+  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h00f3b5d0b78ac098: (a: number, b: number, c: number) => void;
+  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf62c39bd238416f9: (a: number, b: number, c: number) => void;
+  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hefb91f3bd6a8bfc9: (a: number, b: number, c: number) => void;
+  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hbc8a650979ad564c: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly wasm_bindgen__convert__closures__invoke2_mut__h1cdbc2433d9b182f: (a: number, b: number, c: number, d: number) => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {SyncInitInput} module
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {InitInput | Promise<InitInput>} module_or_path
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path: InitInput | Promise<InitInput>): Promise<InitOutput>;