Changelog

@liveblocks/node

• Add the Comments write REST APIs as fully typed methods. (includes createThread, editThreadMetadata, createComment, editComment, deleteComment, addCommentReaction, and removeCommentReaction methods)
• Fix the return type of getActiveUsers to match the data returned from the endpoint.

@liveblocks/react

• Add query option to useThreads to filter threads based on their metadata.

@liveblocks/react-comments

• Add support for exit animations to ComposerSuggestions.

@liveblocks/react

• Improve Comments revalidation when losing network or staying in the background.
• Improve error handling of Comments mutations. (e.g. thread creation, comment creation, etc.)

@liveblocks/client

• Export the CommentBody utilities added to @liveblocks/node in v1.8.0.
• Harmonize exports with @liveblocks/node. (added IUserInfo and PlainLsonObject)

@liveblocks/node

• Harmonize exports with @liveblocks/client. (added CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyMention, CommentBodyParagraph, CommentBodyText, JsonArray, JsonScalar, Lson, LsonObject, and User)

• Fix a bug in toPlainLson helper
• Fix a bug where pausing history more than once could lead to history loss

This release adds all the REST APIs as fully typed methods, and utilities to transform comments, to @liveblocks/node.

@liveblocks/node

• Add all the REST APIs as fully typed methods to Liveblocks client. See docs.
• Add utilities to work with the CommentBody format from Comments:
  • getMentionedIdsFromCommentBody(body) - Get a list of all mentioned IDs from a CommentBody. See docs.
  • stringifyCommentBody(body, options) - Convert a CommentBody to a string, either as plain text, HTML, or Markdown. It supports resolving mention IDs similarly to @liveblocks/react and overriding each element to control the formatting. See docs.

@liveblocks/react-comments

• Fix Composer focus issues.
• Improve relative date formatting for some locales. (e.g. the `"fr"`` locale formatted “1h ago” as “-1 h” instead of “il y a 1 h”)
• Improve default monospace font for inline code blocks.

Liveblocks Comments is now available for everyone as a public beta, learn more about this in the announcement.

@liveblocks/client

• Improve some internal logging.

@liveblocks/react

• Improve Comments-specific error logging.

@liveblocks/react-comments

• Improve default relative date formatting. (e.g. “2 hours ago” → “2h ago”)

create-liveblocks-app

• Add ThreadMetadata type to --init command.

@liveblocks/yjs

• Add support for subdocs.

@liveblocks/react

• Fix return type of resolveUsers.

• Fixes a bug in the bounds check of the backgroundKeepAliveTimeout option.

Support multiple RoomProviders, or mixing and matching our React package in the same app with a Redux and/or Zustand instance.

At the client level, there is a new API for entering/leaving rooms, which we’re now recommending over the old APIs. (The old APIs remain working exactly how they are today, however.)

// Old APIs we'll no longer be recommending (but that will remain working)const room = client.enter("my-room", options);client.getRoom("my-room");client.leave("my-room");

// New API we'll be recommending insteadconst { room, leave } = client.enterRoom("my-room", options);leave();

@liveblocks/client

• New client config option: backgroundKeepAliveTimeout (a numeric value in milliseconds). See docs.
• New APIs:
  • Client.enterRoom(roomId, options) – enters the room and return both the room and an "unsubscribe function" to leave that room again. This newer API supports entering/leaving the same room multiple times, making it possible to connect to the same room from different parts of your application. See docs.
  • Client.logout() – Call this on the Liveblocks client when you log out a user in your application. It will purge all auth tokens and force-leave any rooms, if any are still connected. See docs.
  • LiveList.clone() – see docs.
  • LiveMap.clone() – see docs.
  • LiveObject.clone() – see docs.
• Deprecated APIs:
  • client.enter(roomId, options)
  • client.leave(roomId)
• Renamed enter option: shouldInitiallyConnect → autoConnect. Its meaning or working did not change.
• Fixes a potential Cannot set parent: node already has a parent error when initializing storage with Live datastructures that are already tied to a Storage tree.

@liveblocks/react

• Support using multiple RoomProvider components in your component tree for the same room ID.
• Renamed RoomProvider prop: shouldInitiallyConnect → autoConnect. Its meaning or working did not change.
• New hook:
  • useOthersListener({ type, user, others }), see docs

@liveblocks/redux

• Breaking: The leaveRoom() function no longer accepts a roomId. It will always leave the currently joined room.

@liveblocks/zustand

• The enterRoom() function will now return a leave callback function.
• Breaking: The leaveRoom() function no longer accepts a roomId. It will always leave the currently joined room.