microsoft-webui-node

Node.js native addon for the WebUI framework, built with napi-rs.

Overview

microsoft-webui-node compiles to a platform-specific .node addon that exposes WebUI's rendering API to Node.js hosts (e.g. Express, Fastify) without spawning a subprocess.

Host-driven streaming

Protocol.streamResponse(entry, requestPath, options) returns a StreamingSession. State and patch arguments are JSON strings. start, resume, and advance return:

{
  bytes: Buffer,
  done: boolean,
  boundary?: { instanceId, declarationId, owner, name, key }
}

Method	Result
`start(stateJson)`	Shell bytes through the first descriptor or terminal
`resume(instanceId, stateJson, mode)`	Only the pending occurrence's bytes through its checkpoint
`advance()`	Following parent bytes through the next descriptor or terminal
`update(instanceId, patchJson)`	Projected state bytes for an updatable occurrence

A descriptor means call resume; no descriptor with done: false means call advance; done: true means complete. Boundary-only resume lets the host flush the checkpoint immediately. advance renders following parent or tail bytes, so no sibling boundary workaround is needed.

mode is "final" (the default) or "updatable". A committed updatable occurrence accepts update(instanceId, patch), including between its resume and advance, and returns a Buffer. Optional boundary keys preserve JSON identity: string keys are JavaScript strings and finite numeric keys are JavaScript numbers. A key is required when one component-owned declaration is reached from multiple static callsites in one entry traversal. Boundaries are discovered through entries, reusable components, runtime branches, and selected routes. A boundary-bearing subtree under <for> fails with boundary-in-repeat; one boundary may wrap the whole <for>. The step with done: true already contains terminal and document-tail bytes.

Benchmark

The runtime benchmark in examples/integration/node-addon-bench measures protocol construction, buffered rendering, and streaming callbacks across the real V8/N-API boundary:

cargo xtask bench node-addon

It supports the repository-wide --save-baseline NAME and --baseline NAME workflow documented in BENCHMARKS.md.

Documentation

See the WebUI repository for full usage guides and examples.

microsoft-webui-node 3.0.2

microsoft-webui-node

Overview

Host-driven streaming

Benchmark

Documentation

License