Documentation

Changelog

Review the released versions of @useceleris/client and @useceleris/server.

Celeris releases @useceleris/client and @useceleris/server separately, so their versions can be different. Both packages follow semantic versioning. The current versions are client 1.1.0 and server 1.0.0.

@useceleris/server 1.0.0 declares @useceleris/client ^1.0.0 as a peer dependency. Thus, it accepts client 1.1.0. The server package uses the client package for types only.

Client 1.1.0 — 2026-10-07

This release changes only @useceleris/client. There is no server 1.1.0 release.

  • The new option maximumReconnectAttempts sets the number of failed reconnect attempts in one budget before the channel changes to failed. It is an integer from 1 to 100. The default is 10.
  • connectTimeoutMs, reconnectTimeoutMs, and presenceQueryTimeoutMs accept at most 900000 ms (15 minutes). A larger value gives a ConfigurationError.
  • With the new channel.events().onMessage(), one listener receives the messages from all segments of the connection. It gets each message after the segment listeners.
  • Publishes stay in the publish queue during a reconnect. The SDK sends them after the reconnect succeeds. In 1.0.0, they rejected with NotConnected.
  • A publish while the channel is reconnecting goes into the queue. In 1.0.0, it rejected with NotConnected. The publishQueueSize limit and Backpressure still apply.
  • After a reconnect, the SDK sends the subscriptions first, then the queued publishes in the sequence of the calls. When recovery stops in failed, the queued publishes reject with the error that onError reports. When you close the channel, they reject with Cancelled.
  • A presence subscription does not keep a segment. When you cancel the last subscribe() handle of a segment, the SDK unsubscribes, also while you hold subscribePresence(). In 1.0.0, a presence subscription kept the segment joined. A presence subscription gives no messages, so call subscribe() to receive them.

1.0.0 — 2026-10-07

This is the first stable release of @useceleris/client and @useceleris/server. It contains:

  • Channels and segments over one WebSocket, publish/subscribe, and presence.
  • Replay, automatic recovery with jittered retries, fresh credentials for each attempt, and rate-limit resend.
  • Payload helpers for text and JSON, plus a codec adapter for your own format.
  • A server-side credential signer with explicit claims.
  • The reconnectTimeoutMs, publishQueueSize, and deduplicationWindowSize options. These options were not in the beta versions.

Beta versions — 2026-10-02

Client 0.0.0-beta.1 and 0.0.0-beta.2, and server 0.0.0-beta.2, were pre-release versions for tests against the live service. Do not use them. Install the current versions.

We use Google cookies for analytics and for advertising measurement, only if you allow them. Until you choose, Google sets no cookies. Refer to our Cookie Policy.