@liveblocks/core

@liveblocks/core

Shared code and foundational internals for all other Liveblocks packages. None of the APIs exposed by this package are considered stable or public. Please do not import anything directly from this package.

Run e2e tests locally

• At the packages/liveblocks-core root level, add a file .env
• In this file, add the environment variable: LIVEBLOCKS_PUBLIC_KEY="pk_YOUR_PUBLIC_API_KEY"
• Run npm run test:e2e

Changelog

v1.10.0

This release introduces Notifications (and unread indicators) for Comments.

create-liveblocks-app

• Add createLiveblocksContext and Notifications to --init.
• Move resolver options from createRoomContext to createClient and add resolveRoomsInfo to the list of resolvers.

@liveblocks/client

• Add options to createClient: resolveUsers, resolveMentionSuggestions (both were previously defined on createRoomContext from @liveblocks/react), and the new resolveRoomsInfo.

@liveblocks/react

• Add new LiveblocksContext accessible with createLiveblocksContext, similarly to createRoomContext. This context is meant to live at the root since it handles things outside of rooms, like notifications. It contains LiveblocksProvider, useUser, useRoomInfo, useInboxNotifications, useUnreadInboxNotificationsCount, useMarkInboxNotificationAsRead, and useMarkAllInboxNotificationsAsRead.
• Add new hooks to createRoomContext: useMarkThreadAsRead, useThreadSubscription, useRoomInfo, useRoomNotificationSettings, and useUpdateRoomNotificationSettings.
• Make some hooks usable interchangeably between createLiveblocksContext and createRoomContext: useUser, and useRoomInfo.

@liveblocks/react-comments

• Add new default components: InboxNotification and InboxNotificationList.
• Add unread indicators to the default Thread component.
• Support "@" in mentions. (e.g. @[e-mail] is now a valid mention and will trigger resolveMentionSuggestions with "[e-mail]")

@liveblocks/node

• Add the Notifications REST APIs as fully typed methods. (includes getInboxNotification, getRoomNotificationSettings, updateRoomNotificationSettings, and deleteRoomNotificationSettings methods)
• Add notification webhook event: NotificationEvent.