Core (@cachepuppy/core)

Websocket client, protocol helpers, transports, topic and cache APIs, and typed client events.

The @cachepuppy/core package is what you import in browsers, servers, and tools. It gives you:

createClient / CachePuppyClient — connect over Phoenix websockets (or a mock transport for tests), subscribe to topics, publish events, and observe presence.
Topic shared state — setTopicState, getTopicState, getTopicStateWithMeta, configureTopicWebhook, clearTopicState, plus onStateUpdated for state_updated broadcasts.
Workflow realtime subscriptions — subscribeWorkflow(workflowId, handler) for all workflow topic events and onWorkflowStatus(workflowId, handler) for typed status updates.
Per-connection session state — setSessionState / getSessionState on the fixed session channel.
Distributed cache — setData, getData, deleteData over the same session channel (same semantics as the HTTP cache API).
Admin HTTP — createAdminClient / CachePuppyAdminClient for server-side JSON calls (covered under Admin HTTP).
Protocol surface — createEnvelope, isEnvelope, nextId, and PhoenixTransport.

Add the package to your project the way your team ships it (private registry, tarball, git dependency, or vendored build). The package name is @cachepuppy/core.

Lifecycle

Connect, reconnect, disconnect, and destroy.

Topics

Subscribe, publish, presence helpers.

Topic state

Shared maps, webhooks, clear topic.

Session

Private per-socket JSON state.

Cache

setData, getData, deleteData over websocket.

Transports

Phoenix vs mock.

Events

Typed client.on event map.