@microsoft/webui 0.0.22 → 0.0.23

package/wasm/all/webui_wasm_all_bg.wasm.d.ts

@@ -0,0 +1,25 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_protocol_free: (a: number, b: number) => void;
+export const __wbg_streamingsession_free: (a: number, b: number) => void;
+export const build_protocol: (a: number, b: number, c: number, d: number, e: number) => void;
+export const protocol_new: (a: number, b: number, c: number, d: number, e: number) => void;
+export const protocol_render: (a: number, b: number, c: number, d: number, e: number) => void;
+export const protocol_renderComponentTemplates: (a: number, b: number, c: number, d: number, e: number) => void;
+export const protocol_renderPartial: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => void;
+export const protocol_renderStream: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+export const protocol_streamResponse: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+export const protocol_tokens: (a: number, b: number) => void;
+export const streamingsession_boundary: (a: number, b: number, c: number, d: number) => void;
+export const streamingsession_boundaryCount: (a: number) => number;
+export const streamingsession_finish: (a: number, b: number, c: number, d: number) => void;
+export const streamingsession_finished: (a: number) => number;
+export const streamingsession_update: (a: number, b: number, c: number, d: number, e: number) => void;
+export const streamingsession_writeBoundary: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+export const streamingsession_writeShell: (a: number, b: number, c: number, d: number) => void;
+export const __wbindgen_export: (a: number, b: number) => number;
+export const __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_export3: (a: number) => void;
+export const __wbindgen_add_to_stack_pointer: (a: number) => number;
+export const __wbindgen_export4: (a: number, b: number, c: number) => void;

package/wasm/handler/README.md

@@ -0,0 +1,36 @@
+# microsoft-webui-wasm
+
+WebAssembly bindings for the [WebUI](https://github.com/microsoft/webui) framework, built with `wasm-bindgen`.
+
+## Overview
+
+`microsoft-webui-wasm` can be built as three browser bundles:
+
+| Feature | Bundle | Exports |
+|---------|--------|---------|
+| `handler` | `webui_wasm_handler.js` | `Protocol` |
+| `parser` | `webui_wasm_parser.js` | `build_protocol` |
+| `all` | `webui_wasm_all.js` | Parser and handler exports |
+
+The default feature is `all`, which powers the online playground. Consumers that only need to render prebuilt protobuf protocol bytes should use the handler bundle to avoid shipping parser code.
+
+Construct `Protocol` once from protocol bytes. It exposes `render`,
+`renderStream`, `renderPartial`, `renderComponentTemplates`, and `tokens`.
+Streaming callbacks are coalesced around a 16 KiB target before crossing into
+JavaScript.
+
+## Building
+
+```bash
+cargo xtask build-wasm
+```
+
+This writes the three generated bundles under `docs/.webui-press/public/wasm/`.
+
+## Documentation
+
+See the [WebUI repository](https://github.com/microsoft/webui) for full usage guides and examples.
+
+## License
+
+MIT - Copyright (c) Microsoft Corporation.

package/wasm/handler/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "microsoft-webui-wasm",
+  "type": "module",
+  "collaborators": [
+    "Microsoft Edge"
+  ],
+  "description": "WebAssembly bindings for WebUI framework — powers the online playground",
+  "version": "0.0.23",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/webui"
+  },
+  "files": [
+    "webui_wasm_handler_bg.wasm",
+    "webui_wasm_handler.js",
+    "webui_wasm_handler.d.ts"
+  ],
+  "main": "webui_wasm_handler.js",
+  "homepage": "https://microsoft.github.io/webui",
+  "types": "webui_wasm_handler.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ],
+  "keywords": [
+    "webui",
+    "wasm",
+    "webassembly",
+    "ssr",
+    "rendering"
+  ]
+}

package/wasm/handler/webui_wasm_handler.d.ts

@@ -0,0 +1,146 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A decoded protocol with reusable indices for repeated WASM renders.
+ */
+export class Protocol {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Decode protobuf bytes once for repeated rendering.
+     */
+    constructor(protocol_bytes: Uint8Array, plugin?: string | null);
+    /**
+     * Render from an existing JSON string.
+     */
+    render(state_json: string, options?: object | null): string;
+    /**
+     * Return component template payloads for requested component tags.
+     */
+    renderComponentTemplates(component_tags: any, inventory_hex: string): string;
+    /**
+     * Produce a complete partial-navigation response.
+     */
+    renderPartial(state_json: string, entry_id: string, request_path: string, inventory_hex: string): string;
+    /**
+     * Stream from an existing JSON string in bounded chunks.
+     */
+    renderStream(state_json: string, on_chunk: Function, options?: object | null): void;
+    /**
+     * Open a host-driven progressive response for a streaming entry.
+     *
+     * Unlike `renderStream`, which pushes every chunk through one callback
+     * during a single synchronous call, the returned session hands each chunk
+     * back so the host owns the socket, the write order, and backpressure.
+     */
+    streamResponse(entry: string, request_path: string, options?: object | null): StreamingSession;
+    /**
+     * Return CSS token names in build order.
+     */
+    tokens(): any;
+}
+
+/**
+ * A progressive HTML response driven one chunk at a time from JavaScript.
+ *
+ * Every method returns the UTF-8 bytes it produced. Write them to the
+ * response and apply the host's own backpressure; the session holds no
+ * transport and never blocks on one.
+ *
+ * ```js
+ * const session = protocol.streamResponse('index.html', '/');
+ * const weather = session.boundary('weather-shell');
+ * controller.enqueue(session.writeShell(shellState));
+ * controller.enqueue(session.writeBoundary(weather, weatherState, 'updatable'));
+ * controller.enqueue(session.update(weather, forecast));
+ * controller.enqueue(session.finish(tailState));
+ * ```
+ */
+export class StreamingSession {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Resolve an authored boundary name to a stable integer handle.
+     *
+     * Resolve once outside the write loop; the handle costs nothing to reuse.
+     */
+    boundary(name: string): number;
+    /**
+     * Render the document tail and emit the terminal record.
+     */
+    finish(state_json: string): Uint8Array;
+    /**
+     * Push a projected state patch to a committed updatable boundary.
+     */
+    update(boundary: number, state_json: string): Uint8Array;
+    /**
+     * Render and commit the next boundary in declaration order.
+     *
+     * `mode` is `"final"` (default) or `"updatable"`. Only updatable
+     * boundaries accept later `update()` calls.
+     */
+    writeBoundary(boundary: number, state_json: string, mode?: string | null): Uint8Array;
+    /**
+     * Render everything before the first boundary.
+     */
+    writeShell(state_json: string): Uint8Array;
+    /**
+     * Number of compile-time boundaries declared by this entry.
+     */
+    readonly boundaryCount: number;
+    /**
+     * Whether the terminal record has been written.
+     */
+    readonly finished: boolean;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_protocol_free: (a: number, b: number) => void;
+    readonly __wbg_streamingsession_free: (a: number, b: number) => void;
+    readonly protocol_new: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly protocol_render: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly protocol_renderComponentTemplates: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly protocol_renderPartial: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => void;
+    readonly protocol_renderStream: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly protocol_streamResponse: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly protocol_tokens: (a: number, b: number) => void;
+    readonly streamingsession_boundary: (a: number, b: number, c: number, d: number) => void;
+    readonly streamingsession_boundaryCount: (a: number) => number;
+    readonly streamingsession_finish: (a: number, b: number, c: number, d: number) => void;
+    readonly streamingsession_finished: (a: number) => number;
+    readonly streamingsession_update: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly streamingsession_writeBoundary: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly streamingsession_writeShell: (a: number, b: number, c: number, d: number) => void;
+    readonly __wbindgen_export: (a: number, b: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export3: (a: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;