@liveblocks/node

@liveblocks/node

A server-side utility that lets you set up a Liveblocks authentication endpoint.

Installation

npm install @liveblocks/node

Documentation

Read the documentation for guides and API references.

Examples

Explore our collaborative examples to help you get started.

All examples are open-source and live in this repository, within /examples.

Releases

See the latest changes or learn more about upcoming releases.

Community

• Discord - To get involved with the Liveblocks community, ask questions and share tips.
• Twitter - To receive updates, announcements, blog posts, and general Liveblocks tips.

License

Licensed under the Apache License 2.0, Copyright © 2021-present Liveblocks.

See LICENSE for more information.

Changelog

v1.1.0

This release improves the client’s internals to ensure a more reliable connection with Liveblocks servers.

@liveblocks/client

• New APIs:
  • room.getStatus(): returns the current status of the WebSocket connection: "initial", "connecting", "connected", "reconnecting", or "disconnected"
  • room.subscribe("status"): subscribe to changes of the connection status.
  • room.subscribe("lost-connection"): high-level API to get informed when Liveblocks’ automatic reconnection process is taking longer than usual, so you can show a toast message on screen. (See this example for an illustration.)
• New behavior:
  • The client will stop retrying to establish a connection in cases where retrying would not help. For example an explicit 403 forbidden response from your backend, or a configuration error.
  • The client will more quickly reconnect even after long periods of sleep.

@liveblocks/react

• New APIs:
  • useStatus() - React hook version of room.getStatus()
  • useLostConnectionListener() - React hook version of room.subscribe("lost-connection") (See this example for an illustration.)

Bugs fixed

• Reconnection would sometimes not work after long periods of sleep. Waking up is now instant.
• React clients using Suspense could sometimes incorrectly bounce back to the Suspense boundary after a successful load. No longer!
• Client could sometimes not load storage after reconnecting. Not anymore!
• Others array will no longer flash during an internal reconnect.
• DevTools now keeps working even when the client goes offline.

Deprecated APIs

These APIs still work, but are replaced by newer APIs. The old APIs will be removed in a future release of Liveblocks.

Old connection status codes are replaced by the new ones:

| ❌ Old statuses | ✅ New statuses | | --------------- | --------------- | | closed | initial | | authenticating | connecting | | connecting | connecting | | open | connected | | unavailable | reconnecting | | failed | disconnected |

Recommended steps to upgrade:

• ❌ room.getConnectionState() → ✅ room.getStatus()
• ❌ room.subscribe('connection') → ✅ room.subscribe('status')
• Old client options:
  • ❌ clientOptions.fetchPolyfill
  • ❌ clientOptions.WebSocketPolyfill → ✅ clientOptions.polyfills: { fetch, WebSocket }