@sysce/stomp 2.0.0 → 4.2.1-nightly.202611100524.gd963224

package/README.md

@@ -1,38 +1,241 @@
-# SystemYA's TOMP implementation (STomp)
+# @sysce/stomp
 
-This repository implements the proxy model found [here](https://github.com/tomphttp/specifications/blob/master/ProxyModel.md).
+A rewrite of the Stomp proxy.
 
-- [Demo](https://tomp.sys32.dev/)
-- [Frontend](https://github.com/sysce/tomp-demo)
+Original implementation of https://github.com/tomphttp/specifications.
 
-## Usage
+Stomp rewrites HTML, CSS and JavaScript inside a service worker and tunnels the
+actual HTTP and WebSocket traffic through a
+[proxy-transports](https://github.com/MercuryWorkshop/proxy-transports)
+transport (for example [epoxy](https://github.com/MercuryWorkshop/EpoxyTransport)
+or [libcurl](https://github.com/MercuryWorkshop/CurlTransport)) that lives in
+the page that owns the proxy. Proxied content is shown in frames.
 
-We provide a command-line interface for compiling the code.
+## Usage
 
-For more features, specify the `--help` option when running the CLI.
+Serve `dist/` (its path is exported from `@sysce/stomp/path` as `stompPath`)
+from a directory of your site, register the service worker from that directory
+(`register()` uses it as the scope and resolves once the worker is activated),
+and hand the registration to a controller together with a transport:
 
-## Wiki
+```js
+import EpoxyTransport from '@mercuryworkshop/epoxy-transport';
+import { StompController } from '@sysce/stomp';
 
-Documentation for components such as the Bootstrapper can be found in [the wiki](https://github.com/sysce/tomp/wiki).
+const registration = await StompController.register('/stomp/');
 
-### Quickstart
+const controller = new StompController({
+	serviceworker: registration,
+	transport: new EpoxyTransport({ wisp: 'wss://example.com/wisp/' }),
+	directory: '/stomp/',
+	codec: 'xor',
+});
 
-1. Clone the repository locally
+await controller.wait();
 
-```sh
-$ git clone https://github.com/sysce/stomp.git
-> Cloning into stomp...
-$ cd stomp
+const frame = controller.createFrame(document.querySelector('iframe'));
+await frame.go('https://example.com');
 ```
 
-2. Install dependencies
+`dist/Controller.js` and `dist/SearchBuilder.js` expose the same API as classic
+scripts through the `StompController` and `SearchBuilder` globals.
+
+Any `ProxyTransport` works. In testing against a `wisp-js` server, epoxy was
+the better choice for HTTP-heavy sites and libcurl for WebSockets; see the
+changelog's known limitations before picking one.
+
+## API
+
+`StompController` (also `window.StompController` from `dist/Controller.js`):
+
+| Member                                                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `StompController.register(directory?, { assets, updateViaCache })`                 | static: registers the service worker served from `directory` (the constructor's default when omitted; `assets.serviceWorker` names the file) with that scope and `updateViaCache: 'none'` (overridable), resolves with the registration once its worker is activated, 30 s at the most; a worker stuck installing never hangs the host                                                                                                                                                                                                                                                                                                                                                                                    |
+| `new StompController(init)`                                                        | `init.serviceworker` (a `ServiceWorker`, or a `ServiceWorkerRegistration` whose active, waiting or installing worker is taken and the handshake made once it is activated), `init.transport` (an instance or a descriptor, next row), optional `codec`, `directory`                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| `init.transport`                                                                   | a `ProxyTransport` instance (served from this page) or a `TransportDescriptor` `{ module, options, host? }`: the controller imports and constructs it in a dedicated Worker (`transportWorker.js` from `directory`), off the page's thread, so a proxied frame's synchronous XHR that needs the network completes; `host: 'page'` imports it in the page instead. The module is an ES module importable in a worker whose default export is a ProxyTransport class (epoxy and libcurl qualify)                                                                                                                                                                                                                            |
+| `init.transport.http3`                                                             | optional, off by default: HTTP/3 over QUIC for origins that offer it (`Alt-Svc`, an HTTPS DNS record with `dns`, or `force`), carried by the transport's wisp UDP streams; `true` or `{ force, dns, timeout, wait, module, pem }`. Needs epoxy (`client.connect_udp`) and a wisp server that relays UDP; until a handshake has worked, requests go over the transport as before, and a failure falls back with no wait. Works in `RemoteController` descriptors too. See docs/http3.md                                                                                                                                                                                                                                    |
+| `transportHost`                                                                    | `worker` or `page`: where the transport runs; `page` for an instance, `host: 'page'`, or after the worker fell back                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| `transporthost` event                                                              | `detail: { host: 'page', error }`: the worker could not start or could not import the module, so the page imported it instead (when that fails too, requests fail at once until `setTransport()`)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| `init.allowInvalidJs`                                                              | a script the rewriter cannot parse runs as it was (default); `false` makes it fail with a `SyntaxError` naming the rewriter error, so a broken rewrite is loud                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `init.membrane`                                                                    | the window membrane, on unless `false`: every window and every object of another window's realm reaches a page through a proxy that checks on each use which site the window shows now, and acts as the browser's cross-origin window when it is another proxied site. `false` turns it off for a site it breaks. The setting reaches every document; the membrane itself is being built, and until it lands both values behave alike                                                                                                                                                                                                                                                                                     |
+| `init.rewriteWorkers`                                                              | how many dedicated Workers (`rewriteWorker.js` from `directory`) the controller starts to rewrite scripts for the service worker, whose own thread rewrites one at a time; default half the cores, one to four, `0` for none. A worker is used once it says it is ready; whenever none is (none started, one failed to load or crashed, this page closed) the service worker rewrites the script itself, the same output                                                                                                                                                                                                                                                                                                  |
+| `init.rewriteTimeout`                                                              | milliseconds the service worker waits for a rewrite worker before it rewrites the script itself and stops using that worker; default 10000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `init.assets`                                                                      | optional names of the served files (`serviceWorker`, `injectDocument`, `injectWorker`, `controllerFrame`, `controllerFrameScript`, `transportWorker`, `rewriteWorker`), default the dist names; a host that vendors the bundle under neutral names tells stomp what it called them, and no requested URL then carries the package name                                                                                                                                                                                                                                                                                                                                                                                    |
+| `init.names`                                                                       | optional global names the rewriter and the inject bundles use, a deployment's own instead of `$s$j` (access API), `$s$L` and `$s$N` (stand-in markers) and the client's, which the controller mints (16 random characters) when unset: `{ access, client, globalProxy, globalName, error }` (`error` is the global the error page reads, default `stompError`; a host whose obfuscator renames it sets this), each an identifier no plain window has; a bad one is a `TypeError` from the constructor. Leave `client` unset: it names the object that holds the real windows, and a fixed name is one every page knows. `DEFAULT_NAMES` exports the defaults                                                              |
+| `init.hooks`                                                                       | optional host code run inside every proxied realm (the page, nested frames, about:blank children, popups, srcdoc frames; workers with `hooks.workers`): `hooks.init.pre` before the inject installs its hooks, `hooks.init.post` after, before the page's first script. Each is `{ source }` or `{ url }` (fetched once at construction; its text is what travels, so a changed file needs a new controller). Raw host code with the realm's real globals, one argument `{ url, origin, isTop, nested, kind, phase, names, frameId, window }`; what it leaves on the window the page can reach. A throw is logged in the realm and reported, never thrown at the page. See `examples/hooks/hide-ads.js`                   |
+| `build`                                                                            | the build this controller bundle came from (version plus commit, or the package version), the same string the module exports as `BUILD`; the worker's is `config.build` and `stale` reports a mismatch                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| `unroute(url)`                                                                     | the real URL a routed one stands for (the inverse of `route()`, this controller's codec), null for anything that is not a route                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| `onHookError(info, frame)`, `hookerror` event, `hookErrors`                        | a hook threw in a realm (`phase` `pre` or `post`, `kind`, the page `url`, `message`, `stack`) or a hook URL could not be fetched (`phase: 'url'`, the hook `url`); the controller serves without that hook                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `init.id`                                                                          | optional, this controller's id, 1 to 32 characters of `[A-Za-z0-9_-]` (a TypeError otherwise), 8 random ones by default. It names the controller's address under `directory` (`/stomp/<id>/`), so two host tabs on one directory run two controllers side by side; the same id passed again replaces the earlier controller. A host that keeps tabs stores one id per tab (sessionStorage) and passes it back, so the tab's history entries, reloads and copied links keep resolving. A routed URL whose controller is gone is redirected to the newest live controller of the same codec; with none, the error page answers with kind `controller`                                                                       |
+| `id`, `directory`                                                                  | `id` is the id in use (given or minted). `directory` is the service worker's scope and the directory `dist/` is served from (`/stomp/`); routed URLs are `${directory}${id}/${kind}/${encoded}`, and the inject bundles and the transport worker are fetched from the directory itself (`config.directory` is the address, `config.scope` the directory). The cookie jar, the HTTP cache and the storage partitions are shared by every controller of a directory: a controller is a tab, not a browser                                                                                                                                                                                                                   |
+| `init.rules`                                                                       | optional `RequestRule[]`: declarative request rules applied in the service worker to the real URL, first match wins: `match` (URLPattern `url`, `method`, `destination`, `site`), `action` `'block'` or `{ requestHeaders, responseHeaders, redirect, status }` (`null` deletes a header); applied after stomp rebuilds Origin, Referer and cookies, so a host rule wins. URLPattern is Chrome-only; a missing constructor or an invalid pattern skips that rule with one console warning                                                                                                                                                                                                                                 |
+| `init.cache`                                                                       | `cache` (default `true`): HTTP cache in the service worker, explicit freshness only, revalidated when stale; a script's rewritten output is kept beside it (keyed by the body, URL, script type, config and build; never for `no-store`, `private`, Authorization or a cookie without `public`; 300 entries) and cleared with it by `clearCache()`; `false` turns both off                                                                                                                                                                                                                                                                                                                                                |
+| `init.onRequest`                                                                   | optional `onRequest(info)`: one report per proxied request: real `url` (a CSS image without the rewriter's `#url(...)` fragment), `method`, `destination` (`fetch` for fetch, XHR and keepalive beacons), `status` (0 with `error` and `kind` on a failure the proxy produced), `ms`, `cached`, `bytes`, for a script `rewriteCache` (`hit`, `miss`, or `skip` when it may not be kept) and `rewriteIn` (`pool` or `service-worker`, when it was rewritten now), and `frame`: the document's own report and head subresources wait up to 1.5 s for the page's client id, so they carry their frame too; also dispatched as a `request` CustomEvent on the controller (`detail` is the report); nothing is sent when unset |
+| `init.onNavigate`                                                                  | optional `onNavigate(info, frame)`: the page reported where it is (`{ url, title, canGoBack, canGoForward }`); also dispatched as a `navigate` CustomEvent on the frame and on the controller (`detail: { info, frame }`)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| `NavigateInfo.icon`                                                                | the page's icon as it declared it (first `link rel="icon"` / `shortcut icon`, else `apple-touch-icon`), resolved against the real URL, or null; reported again when the page swaps it                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| `init.onOpen`                                                                      | optional `onOpen(url, frame)`: called when a page wants a new tab (`window.open`, a link with `target="_blank"` or a name, a modifier or middle click); the page's `window.open` then returns `null`, like a popup blocker; also dispatched as an `open` CustomEvent on the controller (`detail: { url, frame }`). Without it popups open natively as bare proxied tabs                                                                                                                                                                                                                                                                                                                                                   |
+| `init.errorPage`                                                                   | optional: the host's own page for a document the proxy failed to produce (unreachable origin, timeout, routing error, blocked rule, the refusal to proxy its own origin). A same-origin URL; served under the frame's URL with the failure's status, never cached, with `globalThis.stompError = { url, status, error, kind }` in its head; `location.reload()` retries. In isolation mode a path on the proxy host, where the worker runs. See `examples/error.html`                                                                                                                                                                                                                                                     |
+| `wait()`                                                                           | resolves when the service worker has a server for this controller; a build mismatch is healed first (update, wait for activation, rebind) and otherwise resolves on the worker at hand with `stale` set                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| `stale`, `stale` / `rebind` events                                                 | `{ controller, worker }` builds while an older worker is still in charge; the controller rebinds on its own when the new one activates and dispatches `rebind` (`{ build }`)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| `createFrame(iframe?)`                                                             | returns a `Frame`; creates an `<iframe>` when none is given                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| `setTransport(transport)`                                                          | hot-swap the transport: a descriptor on a worker host (the worker imports it; in-flight requests finish on the old one), an instance on a page host, a TypeError otherwise; resolves once the new transport is in place                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| `rebind(worker?)`                                                                  | talk to another service worker (default: the registration's active one) and shake hands again; a build mismatch does this on its own before `wait()` would reject                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| `clearCache()`                                                                     | drop the HTTP cache                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| `setRules(rules)`                                                                  | replace the request rules at run time; `onRequest` reports the index of the rule applied as `info.rule`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| `cookies.get(url)` / `.set(url, setCookie)` / `.list(origin?)` / `.clear(origin?)` | the jar as the host sees it (host-only: pages never reach this port)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| `route(url)`                                                                       | the proxied URL for `url`, if you need it without a `Frame`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| `transport`, `frames`                                                              | current transport and the frames created so far                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+
+`Frame`:
+
+| Member                                    | Description                                                                                                                                                                                                                                                                                                                                                       |
+| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `go(url)`                                 | navigate the frame to `url` through the proxy; resolves when the new document has reported (URL, title, history state in), a second after the frame's `load` event for a document that never reports, 30 s at the most. The first report comes at document start, so wait for the frame's `load` event (listened for before `go()`) before reading the page's DOM |
+| `back()` / `forward()`                    | step the frame's own history; resolves to `false` when there is no entry in that direction (never walks the host page's history)                                                                                                                                                                                                                                  |
+| `canGoBack` / `canGoForward`              | whether the frame's own history has an entry in that direction; `null` when the browser has no Navigation API                                                                                                                                                                                                                                                     |
+| `reload()`                                | reload the proxied page; resolves like `go()`, `false` when there was nothing to reload                                                                                                                                                                                                                                                                           |
+| `url`                                     | the real URL of the page the frame shows, or `null`                                                                                                                                                                                                                                                                                                               |
+| `navigate` event, `title`, `lastNavigate` | the page's own reports (load, pushState, hashchange, title changes); no polling needed                                                                                                                                                                                                                                                                            |
+| `element`                                 | the underlying `<iframe>`                                                                                                                                                                                                                                                                                                                                         |
+
+`SearchBuilder(template)` turns free text into a URL: hosts and URLs pass
+through, everything else is substituted into `template` at `%s`.
+
+`RemoteController` (also `window.StompRemoteController` from
+`dist/Controller.js`) is the host-side controller for origin isolation; it has
+the same shape as `StompController` but runs the real controller in a hidden
+frame on the proxy origin:
+
+| Member                                       | Description                                                                                                                                                                                                             |
+| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `new RemoteController(init)`                 | `init.proxyOrigin`, `init.transport` (`{ module, options, host? }`, hosted in the controller frame's transport worker unless `host: 'page'`), optional `directory`, `codec`, `sandbox`, `pollInterval`                  |
+| `init.allowInvalidJs`                        | as on `StompController`                                                                                                                                                                                                 |
+| `init.membrane`                              | as on `StompController`                                                                                                                                                                                                 |
+| `init.rewriteWorkers`, `init.rewriteTimeout` | as on `StompController`; the controller frame starts the workers                                                                                                                                                        |
+| `init.assets`                                | as on `StompController`; the controller frame is loaded as `<directory><controllerFrame>?script=<controllerFrameScript>` and learns its script name from that query                                                     |
+| `init.names`                                 | as on `StompController`, passed to the controller frame                                                                                                                                                                 |
+| `init.hooks`                                 | as on `StompController`; a `{ url }` is fetched by the controller frame from the proxy origin                                                                                                                           |
+| `build`                                      | the build this controller bundle came from (version plus commit, or the package version), the same string the module exports as `BUILD`; the worker's is `config.build` and `stale` reports a mismatch                  |
+| `unroute(url)`                               | the real URL a routed one stands for (the inverse of `route()`, this controller's codec), null for anything that is not a route                                                                                         |
+| `init.id`                                    | as on `StompController`, minted here (`id`) and handed to the controller frame, so the host knows the address before the frame answers; two host tabs run two controller frames and two controllers on one proxy origin |
+| `init.rules`                                 | as on `StompController`, relayed through the controller frame                                                                                                                                                           |
+| `init.cache`                                 | as on `StompController`                                                                                                                                                                                                 |
+| `init.onRequest`                             | as on `StompController`, relayed through the controller frame                                                                                                                                                           |
+| `init.onNavigate`                            | as on `StompController`; the reports arrive from the proxy origin and are accepted only from this controller's own frames                                                                                               |
+| `NavigateInfo.icon`                          | the page's icon as it declared it (first `link rel="icon"` / `shortcut icon`, else `apple-touch-icon`), resolved against the real URL, or null; reported again when the page swaps it                                   |
+| `init.onOpen`                                | as on `StompController`: the request reaches the host from the proxy origin and is accepted only from this controller's own frames                                                                                      |
+| `wait()`                                     | resolves once the controller frame has registered the service worker and loaded the transport                                                                                                                           |
+| `createFrame(iframe?)`                       | returns a `RemoteFrame`; applies the sandbox attribute                                                                                                                                                                  |
+| `setTransport(descriptor)`                   | hot-swap the transport (loaded inside the controller frame)                                                                                                                                                             |
+| `clearCache()`                               | drop the HTTP cache (inside the controller frame)                                                                                                                                                                       |
+| `setRules(rules)`                            | as on `StompController`                                                                                                                                                                                                 |
+| `cookies.*`                                  | as on `StompController`, relayed through the controller frame                                                                                                                                                           |
+| `route(url)`                                 | the proxied URL for `url` on the proxy origin                                                                                                                                                                           |
+| `frames`, `config`, `element`                | frames created so far, the controller's config, the hidden controller iframe                                                                                                                                            |
+| `stale`, `stale` / `rebind` events           | as on `StompController`, mirrored from the controller frame                                                                                                                                                             |
+
+`RemoteFrame`: `go(url)`, `back()`, `forward()`, `reload()` (the last three
+are relayed through the controller frame, which is same-origin with the
+proxied page), `url`, `title`, `canGoBack` and `canGoForward` (last known,
+refreshed every `pollInterval` ms), `element`.
+
+A transport descriptor is `{ module: '/epoxy/index.mjs', options: [{ wisp }] }`:
+the module URL must be on the proxy origin and its default export is the
+transport class, constructed with `...options`.
+
+## Origin isolation
+
+`StompController` keeps everything on one origin, so a proxied page is
+same-origin with the page that embeds it. Browsers grant same-origin frames
+full access to each other: `parent.document`, `top.location = ...`,
+`frameElement`, cookies and storage of the host. Stomp's hooks hide most of
+that from the page's own (rewritten) JavaScript, but hooks are not a security
+boundary. **Same-origin mode is for development only.**
+
+Origin isolation serves `dist/` and all proxied content from a second origin
+(for example `app.example.com` hosting the UI and `proxy.example.com` serving
+the proxy). The host page creates a `RemoteController`, which embeds
+`dist/controllerFrame.html` from the proxy origin; that frame registers the
+service worker, loads the transport and runs the real `StompController`.
+Proxied pages live in sandboxed, cross-origin iframes (`allow-same-origin`
+so the service worker controls them, no `allow-top-navigation`), so the
+browser itself refuses them any access to the host, and the service worker
+sends `Content-Security-Policy: frame-ancestors <host origin>` so nothing
+else can embed the proxy origin. On top of that the inject bundle makes the
+page believe it is top-level: `top`, `parent`, `frameElement`, `window.name`,
+`outerWidth`/`outerHeight`, `screenX`/`screenY`, `document.referrer` and
+`location.ancestorOrigins` all answer as they would for a real top window,
+and `message` events from outside the proxied world never reach the page.
+
+## Embedding
+
+Install the package from npm. Nightly builds of master are published as
+`@sysce/stomp@nightly` (versions like `4.2.1-nightly.202611100717.g1a2b3c4`:
+the next patch, the UTC time, the commit), each only after CI passed on that
+commit, with npm provenance:
 
 ```sh
-$ npm install
+npm install @sysce/stomp@nightly
 ```
 
-3. Build
+Pin the exact version a host was tested with. `stompPath` from
+`@sysce/stomp/path` is the directory to serve.
+
+[`examples/minimal-host.html`](examples/minimal-host.html) is the smallest
+host application: plain HTML and one module script, with a comment per step.
+The demo server serves it at `/examples/minimal-host.html`
+(`npm run demo`), and `test/suites/host-api.mjs` runs the host API checklist
+against it. The deployment settings sit in one object at the top of the
+script (`directory`, the transport module, the wisp URL, `codec`).
+
+The boot sequence it shows: `StompController.register(directory)` for the
+directory `dist/` is served from (that scope, `updateViaCache: 'none'`,
+resolves once the worker is activated); import the transport module and
+construct it with the wisp URL; create the `StompController` with the
+registration, the transport, the directory, the codec and the callbacks; `await controller.wait()`; then `createFrame()` and
+place its `<iframe>`. From there `frame.go(url)`, `back()`, `forward()` and
+`reload()` drive the frame, and `canGoBack` / `canGoForward` tell the host
+what to enable. `controller.stale` and the `stale` / `rebind` events say
+whether an older service worker is still in charge after a deploy.
+
+The three callbacks are the host's view of the pages: `onNavigate` reports
+URL, title and history state whenever the page changes them (the example
+updates its address input and title from it), `onOpen` receives the URL a
+page wanted in a new tab (the page's `window.open` returns `null`; the
+example opens it in place, a real host opens a tab), and `onRequest` reports
+every proxied request with its real URL, status and the `Frame` it belongs
+to (the example appends one line per request to a log).
+
+The example runs the same-origin `StompController`, which is not a security
+boundary; a deployment that must keep proxied pages away from the host uses
+`RemoteController` on a second origin, see "Origin isolation" above.
+
+Transport: use epoxy for HTTP-heavy sites. Pages that rely on WebSockets are
+the exception (incoming frames stop after the first round trip against
+wisp-js 0.5, see the changelog's known limitations and the transports note
+in `AGENTS.md`); the demo's transport selector switches to libcurl for
+those, which in turn stops answering HTTP after some tens of requests.
+
+Use the epoxy build this repository pins (`deploy/epoxy/`), not the npm
+release: upstream epoxy loses one of two requests started together on a cold
+transport (two frames of one page navigating at once, the first never loads)
+and hangs on a pooled connection the server has already closed for idling.
+The pinned build patches both (`epoxy-concurrency` suite).
+
+## Demo
+
+`npm run demo` serves a complete host application on http://localhost:8080,
+including a wisp server and both transports. It is documented in
+[`demo/README.md`](demo/README.md) and is the quickest way to see the API above
+in use. It is live at https://stomp.fracit.al, deployed from `master` by
+`.github/workflows/deploy.yml`.
+
+## Development
 
 ```sh
-$ npm build
+npm install
+npm run build   # type-check, bundle with esbuild, emit declarations
+npm run dev     # rebuild on change
+npm run demo    # http://localhost:8080 with a wisp server, epoxy and libcurl
+npm run lint
 ```