Liveblocks Release Notes

@liveblocks/client, @liveblocks/react, and @liveblocks/node

• Fix edge cases in return types of .toJSON(), useStorage() selectors, and getStorageDocument(roomId, "json"):
  • a LiveObject whose properties are all optional no longer loses its keys when nested inside another Live structure.
  • a value typed as Record<string, T> no longer loses T.
  • an object carrying both a string index signature and named keys no longer loses the named keys.
  • a LiveObject converts to the same type whether you reach it directly or through a parent.

@liveblocks/chat-sdk-adapter

• Allow apiKey and webhookSecret to be resolved per request, and add custom webhookVerifier support for rotated credentials and webhook-forwarding infrastructure such as Vercel Connect.

This release introduces LiveText (beta), a collaborative rich-text data structure for plain text with optional inline formatting.

@liveblocks/client

• Storage updates delivered to deep subscribers now carry a source field, saying whether the change was made by this client ({ origin: "local", via: "edit" | "undo" | "redo" }) or by another one ({ origin: "remote" }), see docs.
• Add LiveText for collaborative text editing with concurrent inserts, deletes, and formatting changes.

@liveblocks/codemirror, @liveblocks/lexical, and @liveblocks/prosemirror

• Introduce packages for integrating CodeMirror, Lexical, and ProseMirror editors with Liveblocks Storage and LiveText.

@liveblocks/react-tiptap

• Fix useIsEditorReady() so it correctly reports when the Tiptap editor is ready. Thanks @danilowoz for the fix.

This release introduces LiveFile: a new data structure to store files such as images and videos in a room's Storage tree.

@liveblocks/client

• Add room.uploadFile() to upload a file and return a LiveFile.
• Add room.getFileUrl() to get access to a LiveFile.

@liveblocks/react

• Add useUploadFile() to upload a file and return a LiveFile.
• Add useFileUrl() to get access to a LiveFile.

@liveblocks/node

• Add uploadFile() to upload a file and return a LiveFile.
• Add getFileUrl() to get access to a LiveFile.
• Add uploadAttachment() to upload comment attachments, combined with attachmentIds params in createThread(), createComment(), and editComment().

Python SDK

• Add methods to upload Storage files for LiveFile, retrieve their download URLs, and handle multipart uploads.
• Add methods to upload comment attachments, including multipart uploads.

@liveblocks/react

This release adds version history support for Storage: a version now snapshots both the room's Storage and Yjs documents (previously Yjs only).

• Creating a version now also snapshots Storage, not just Yjs, see docs.
• useHistoryVersions() lists the room's versions. Each has a vh_xxx id, see docs.
• useHistoryVersionStorageData("vh_xxx") returns that version's Storage as a read-only LiveObject so you can visualize or diff it manually, see docs.
• useRestoreToStorageVersion("vh_xxx") restores the room's Storage to that version, as a single undoable change, see docs.
• useDeleteHistoryVersion() returns deleteHistoryVersion("vh_xxx") to permanently delete a version, see docs.

@liveblocks/node and Python SDK

• Add methods for version history to list room versions, create a version snapshot, and delete a version.