can1357
8fa1f6c250
- Added @oh-my-pi/pi-wire and reworked collab protocol types into shared contracts. - Added wire-compatibility guards in coding-agent host to block unsupported events. - Added standalone collab-web package with guest UI, mock-host tooling, and local relay. - Added secure room-link validation, WebCrypto framing, and safer socket routing.
32 lines
1.3 KiB
Markdown
32 lines
1.3 KiB
Markdown
# @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
|
|
|
|
```ts
|
|
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.
|