Skip to content

api.md

Latest commit

 

History

History
54 lines (43 loc) · 3.25 KB

api.md

File metadata and controls

54 lines (43 loc) · 3.25 KB
Raw

API Reference

The public surface of @myrialabs/ptykit, split across three entry points.

Entry points

Import Exports
@myrialabs/ptykit Barrel: PtyKitManager, createPtyKitServer, wire-protocol types, PTYKIT_VERSION.
@myrialabs/ptykit/core PtyKitManager and the core seams (backend, scrollback, env/shell).
@myrialabs/ptykit/server PtyKitServer, createPtyKitServer, RoomRegistry, transport hook types.
@myrialabs/ptykit/client mountTerminal, mountViewer, PtyKitClient, ClientSession, attachFit, hostSocket, defaultPersistence, WsCore.
@myrialabs/ptykit/xterm Re-exported xterm pieces: Terminal, FitAddon, ClipboardAddon, WebLinksAddon, Unicode11Addon, LigaturesAddon.
@myrialabs/ptykit/xterm.css xterm base stylesheet + chrome defaults (height fill, slim scrollbar). Side-effect import.
@myrialabs/ptykit/svelte PtyTerminal (default + named).

@myrialabs/ptykit (core + server)

  • PtyKitManager — session manager. See server.md.
  • createPtyKitServer(manager, options) — WebSocket server. See server.md.
  • Backend: loadBackend, detectBackendName, PtyBackend, PtyProcessHandle.
  • Scrollback seam: BufferStore, MemoryBufferStore.
  • Env/shell: buildPtyEnv, getCleanSpawnEnv, resolveShell, checkShell.
  • Wire types: RpcMap, ServerEventMap, OutputEvent, Seq, stripReportRequests, …

@myrialabs/ptykit/client

  • mountTerminal(target, options) — ready-to-use xterm terminal wired to a session; returns a { client, session, terminal, fitAddon, dispose } handle. See client.md.
  • mountViewer(target, options) — read-only output terminal (no PTY, no input); returns a { terminal, fitAddon, write, clear, fit, dispose } handle for streaming logs/progress. See client.md.
  • PtyKitClient / ClientSession — see client.md.
  • attachFit(session, term, fitAddon, { debounceMs }) — see client.md.
  • themes / resolveTheme + per-preset objects (darkTheme, lightTheme, solarizedDarkTheme, solarizedLightTheme, draculaTheme, nordTheme, matrixTheme) — built-in theme presets (names: dark, light, solarized-dark, solarized-light, dracula, nord, matrix).
  • showLoadingOverlay(target, text?) — the spinner overlay mountTerminal/mountViewer use; returns a disposer (for custom mounts).
  • defaultPersistence() / SessionPersistence — sessionId persistence.
  • hostSocket(handle) / HostSocketHandle — adapt an app-owned WebSocket into the WebSocketImpl seam so the client rides it instead of opening its own. See client.md.
  • WsCore — the low-level resilient socket (advanced use).

@myrialabs/ptykit/svelte

  • PtyTerminal — <PtyTerminal sessionId url namespace? create? />. See svelte.md.

Behavior coverage

The collaborative room model, authorize enforcement + anti-hijack, serialized reattach (zero data loss, no double output), reconnect/heal, and seq dedup all have dedicated tests under src/.