@ellipsis-dev/sdk
TypeScript SDK for the Ellipsis agents platform. Three subpath exports, all dependency-free at runtime:
@ellipsis-dev/sdk— generated/v1REST types +EllipsisClient, a thin typed client over an injectedfetchJson.@ellipsis-dev/sdk/stream— the session stream WebSocket client (streamSession): heartbeat liveness, reconnect-with-backoff, and lossless resume via theafter_seqrecord cursor. Transport is an injectedopenSocket, so the same machinery runs in a browser, a terminal, or a server.@ellipsis-dev/sdk/store—SessionTranscriptStore(subscribe/getSnapshot, shaped for React'suseSyncExternalStorebut framework-free) plus the pure shaping helpers that turn raw session records into renderable transcript items and chat turns.
Types are generated, never hand-written
schema/frames.schema.json— JSON Schema of the WebSocket frames, produced from the server's frame models.schema/openapi.v1.json— the OpenAPI document for the SDK's REST surface.
pnpm gen derives src/generated/ from those documents
(json-schema-to-typescript + openapi-typescript). CI regenerates and
diffs, and the server's own test suite pins the committed schema documents to
its models, so types cannot drift from the deployed API in either direction.
test/fixtures/golden_stream.json is a frame sequence recorded from the real
server stream loop (ids and timestamps normalized); the store's tests replay
it, so client behavior is validated against real emissions, not hand-written
examples.
Stream
The stream (frame taxonomy, delivery classes, resume/close-code contract) is
documented at https://www.ellipsis.dev/docs. Clients ignore unknown frame
types and unknown source/record_type/kind values.
Shared chat work sections
Web and CLI renderers can use splitLedger(groupRecordsToChatTurns(records))
and entryBody(entry, { live, now, liveText, liveSummary, harness }) from @ellipsis-dev/sdk/store.
now is epoch milliseconds, and harness is harnessName(session). The returned items are the collapsed view:
one isWorkFold(item) section for progress, thinking and tools, with final
replies, turn outcome and closing notices kept visible.
members.get(item.key) contains
that section's rows; nested tool folds use the same map and isToolFold.
Renderers own expansion state and can recursively display the members.
The work key stays stable as records stream in and after replay. The live
label advances from Preparing environment to Starting Claude Code (the
harness's name, or Starting agent without one) to Working
as the platform and native turn events arrive. While the agent works, the heading
from store.getSnapshot().liveSummary replaces Working when available.
Pass the summary only to the entry being answered (loading: true, add a loading
indicator in the renderer). The returned seconds uses platform turn start
and completion timestamps, even before the first content item arrives. It is
null before a turn starts; omit the clock then. entry.progress.phase identifies
each message's activity independently of the latest message or session status.
The settled label is Worked for 4m 43s. Only the work header is loading; partial
text stays inside it. Codex message phases identify final answers; for records
without phases, the final message of a settled turn stays outside the fold.
No DOM, React, or terminal dependencies are required.