Aperture

live-session

The framework-agnostic client for Aperture live sessions.

npm install @aperture-browser/live-session effect
  • The aperture-session.v1 protocol, decoded with Effect Schema.
  • LiveSessionConnection.make, a scoped Effect that connects over WebRTC and falls back to WebSocket raster frames. Its baseUrl option targets an instance on another origin.
  • Helpers that map DOM keyboard and pointer events to browser input messages, and the viewport math for scaling between the page and the remote browser.

Failures are LiveSessionErrors with a message.

For a ready-made UI, or a React hook over this client, see session-react. Requires effect 4.

Edit on GitHub

api-client

Effect services for the Aperture REST API.

Development

Run the complete stack from source, work on the TypeScript workspace, and cut releases.