npm.io
17.1.3 • Published yesterday

@oh-my-pi/pi-wire

Licence
MIT
Version
17.1.3
Deps
0
Vulns
0
Weekly
0
Stars
17.3K

@oh-my-pi/pi-wire

Shared TypeScript wire contracts for omp collab live sessions.

The package contains only JSON-safe protocol shapes and constants. It has no runtime dependencies and is consumed by both the host CLI (@oh-my-pi/pi-coding-agent) and browser guest (@oh-my-pi/collab-web).

Exports

import type { GuestFrame, HostFrame, SessionEntry } from "@oh-my-pi/pi-wire";
import { COLLAB_PROTO, DEFAULT_RELAY_URL, ENVELOPE_HEADER_LENGTH } from "@oh-my-pi/pi-wire";

Key groups:

  • message and transcript entry shapes rendered by collab guests,
  • live agent event and task-subagent bus payload shapes,
  • GuestFrame, HostFrame, and WireFrame unions for AES-GCM sealed payloads,
  • relay control TEXT messages,
  • link/envelope constants shared by host, guest, and local relay code.

Protocol boundary

pi-wire does not encode, decode, validate, encrypt, or route frames. It defines the shared contract used at those boundaries:

  1. callers build a GuestFrame or HostFrame,
  2. transport code serializes it as JSON inside an encrypted payload,
  3. relay code routes opaque envelopes using the plaintext peer-id prefix,
  4. receivers switch on frame.t and tolerate unknown future fields.

Keep protocol changes backward-aware: bump COLLAB_PROTO only when old hosts and guests must reject each other.

Keywords