Changelog

  • Week 16

    Week 16
    WEEK16

    v3.18.3

    • Third-party libraries like yjs, @tiptap/*, and @blocknote/* are now declared as peer dependencies instead of bundled dependencies across all packages that use them.

    v3.18.2

    • New experimental room.history.disable(fn) API that allows running storage mutations without them appearing on the undo/redo stacks. Intended for background/async writes (e.g. writing back AI generation results) that should not be undoable.
    • Fix ToJson type losing specific value types for Record<string, T> fields in Storage

    v3.18.1

    • Mentions suggestions now appear in more cases after typing @:
      • After punctuation like !, ., (, etc. (e.g. Hello!@, cc: the other team (@)
      • After emojis (e.g. Hello đź‘‹@)

    Infrastructure

    • Moved the public monorepo from NPM to pnpm.
    • Started the transparent internal migration of old rooms still on the v1 realtime data storage engine to the new v2 engine, learn more about the benefits.

    Examples

    Website

    Contributors

    Contributors include:marcbouchenoirectnicholasnvieofoucherot

    4 authors

  • Week 15

    Week 15
    WEEK15

    v3.18.0

    For full upgrade instructions, see the 3.18 upgrade guide.

    • Breaking: useStorage now returns plain objects for LiveMap values instead of Map instances. Legacy APIs have been removed: .toImmutable(), .toObject(), .toArray().

    • New .toJSON() on all Live structures, returning a cached JSON-compatible snapshot. JSON.stringify(root) now just works.

    • New LiveObject.from(obj) to create a LiveObject from plain JSON, recursively converting nested objects/arrays to Live structures.

    • New .reconcile(obj) to efficiently reconcile a LiveObject tree to match a JSON snapshot, only mutating what changed.

    • initialStorage accepts LiveObject.from() result directly.

    • New mutateFlow() API for reading and mutating React Flow data from a Node.js backend. Install via npm i @liveblocks/react-flow, import from @liveblocks/react-flow/node.

    • Add standalone Avatar component to complement AvatarStack for more fine-grained customization.

    • Add variant prop to AvatarStack to support outlined avatars.

    • Fix: Initial storage seeding no longer creates an undo frame.

    • Fix: Presence updates are now batched with storage updates.

    Liveblocks dev server (v1.4.0)

    • Add support for client.mutateStorage() (from @liveblocks/node)

    Website

    Documentation

    • Mention missing updatedAt field in updateFeedMessage reference.

    Contributors

    Contributors include:nviectnicholasstevenfabremarcbouchenoire

    4 authors

  • Week 14

    Week 14
    WEEK14

    v3.17.0

    • Introduce the package. Install with npm install @liveblocks/react-flow. Provides hooks and components that add collaboration to any React Flow diagram using Liveblocks Storage:

      • Use the useLiveblocksFlow hook to make React Flow synced and collaborative.
      • Use the Cursors component to show other users' cursors inside React Flow.

    • Allow customizing cursors in the Cursors component by passing a components={{ Cursor: MyCursor }} prop.

    v3.16.0

    • Introduce the package. Install with npm install @liveblocks/chat-sdk-adapter. Provides a chat-sdk-compatible backend adapter backed by Liveblocks Comments: webhooks, posting and editing messages, reactions, paginated fetches, thread and channel helpers, and optional resolveUsers / resolveGroupsInfo hooks.

    • Add Feeds hooks: useFeeds, useFeedMessages, useCreateFeed, useDeleteFeed, useUpdateFeedMetadata, useCreateFeedMessage, useDeleteFeedMessage, and useUpdateFeedMessage.

    • Add REST client methods for Feeds: getFeeds, getFeed, createFeed, updateFeed, deleteFeed, getFeedMessages, createFeedMessage, updateFeedMessage, and deleteFeedMessage.

    • Add Feeds REST API support on the sync and async clients (get_feeds, get_feed, create_feed, update_feed, delete_feed, get_feed_messages, create_feed_message, update_feed_message, delete_feed_message) with matching request/response models.

    • Add Feeds: room-scoped feeds with metadata and messages and APIs to list, create, update, and delete feeds and messages (fetchFeeds, fetchFeedMessages, addFeed, updateFeed, deleteFeed, addFeedMessage, updateFeedMessage, deleteFeedMessage).

    • Add body prop to Comment to allow overriding only the default rich-text comment body while still keeping attachments, reactions, and additionalContent as is, unlike when using the children prop.

    • Fix AvatarStack negative margin breaking alignment.

    Liveblocks dev server (v1.3.0)

    • Add feeds support (feeds:write permission)
    • Add verbose logging toggle
    • Fix permission validation to accept all valid permission combinations
    • Support passing extra arguments to --cmd dynamically

    Website

    Documentation

    Examples

    Contributors

    Contributors include:nviectnicholasmarcbouchenoiresugardariusnimeshnayajujrowny

    6 authors

  • Week 13

    Week 13
    WEEK13

    3.15.5

    • Improve clipboard handling when text nodes containing comments were copied or pasted.

    • Fix request body for certain endpoints, like update_room_id, initialize_storage_document incorrectly set as optional.

    Liveblocks dev server (v1.2.0)

    New dev server features:

    • Live socket inspector view
    • Maintenance mode toggle (to reject new WebSocket connections)

    Documentation

    Showcase

    Contributors

    Contributors include:nvienimeshnayajuctnicholas

    3 authors

  • Week 12

    Week 12
    WEEK12

    v3.15.4

    • Add Liveblocks.getAttachment() method to get an attachment's metadata and a presigned download URL.

    • Add get_attachment() method to get an attachment's metadata and a presigned download URL.

    v3.15.3

    • Introduce the Python package. Install with pip install liveblocks. Provides sync and async clients for the full Liveblocks API (rooms, storage, threads, comments, etc.) for backend use.

    • Add showSubscription prop to Thread to control whether to show the thread’s subscription status.

    Liveblocks dev server (v1.1.0)

    New dev server features:

    • ID token authentication support
    • Read-only rooms support
    • Room permissions and room metadata
    • Room filtering support
    • Room Node.js methods and REST APIs are now fully supported

    See dev server documentation for the updated feature matrix.

    Dashboard

    • We added support for setting description on projects for better documentation and organization
    • Fixed a bug preventing inviting new members correctly
    • Internal refactoring of dashboard components to improve performance and efficiency

    Infrastructure

    • Mangement API: We added support for setting description on projects for better documentation and organization.

    Documentation

    Website

    Contributors

    Contributors include:nviesugardariusnimeshnayajupierrelevaillantmarcbouchenoirectnicholas

    6 authors

  • Week 11

    Week 11
    WEEK11

    v3.15.2

    • Deprecate the engine option on enterRoom(). This flag no longer has any effect.

    • Deprecate the engine prop on RoomProvider. This flag no longer has any effect.

    • Deprecate the engine option on createRoom(). This flag no longer has any effect.

    • Stop sending the engine field in the room creation request body.

    v3.15.1

    • Add gap prop to AvatarStack to control the --lb-avatar-stack-gap CSS variable.
    • Add padding prop to CommentPin to control the --lb-comment-pin-padding CSS variable.
    • Fix size props on AvatarStack and CommentPin not working as expected when passing numbers.
    • Fix autoFocus prop on FloatingComposer.
    • Improve avatars’ ordering and max logic in AvatarStack.
    • Support children prop on CommentPin.

    Documentation

    • Mention how token caching is never recommended.

    Examples

    • Improve canvas comments example to prevent a conflict after moving a comment pin twice in rapid succession.

    Contributors

    Contributors include:nviemarcbouchenoirectnicholas

    3 authors

  • Week 10

    Week 10
    WEEK10

    v3.15.0

    • Add various new ways to customize Thread and Comment:

      • Comments in Thread can now be overridden or customized via the components prop.
      • New parts of Comment (content, avatar, author, and date) can now be overridden or customized via the children, additionalContent, avatar, author, and date props.

    • Fix commentDropdownItems prop on Thread not working as expected in some cases.

    • Each createRoomContext() invocation now creates its own isolated context to allow nesting independent room contexts and their RoomProvider components.

    • Support newer BlockNote versions and bump the minimum required version to v0.43.0. (Thanks @nperez0111 for the contribution!)

    • Improve how inline components passed to components={{ ... }} props are handled by keeping them stable instead of re-mounting them on every render.

    • Move @radix-ui/* dependencies to the radix-ui mono package.

    Examples

    • New example: AG Grid Comments.
    • Update old examples to use new presence and commenting components.

    Documentation

    Contributors

    Contributors include:nperez0111marcbouchenoirectnicholas

    3 authors

  • Week 9

    Week 9
    WEEK9

    v3.14.1

    • Fix paginated hooks (useThreads, useInboxNotifications, and useAiChats) stopping pagination after the first fetchMore() call when auto-paginating in a useEffect.

    Zen Router

    Website

    Examples

    • Next.js Starter Kit was updated to support new features.
      • Organization switcher powered by tenants/organizations, with separate inboxes in each.
      • New universal header built with useIsInsideRoom.
      • New share menu with private/org/public permissions.
      • Filters for private/org/public documents on dashboard.
      • New Document shape with new permissions added.
      • Better UX in various places and tidied project structure.
    • Fix text size in Next.js Starter Kit on mobile devices. Thank you @chrrrs!

    Showcase

    Contributors

    Contributors include:flowflorentchrrrsnviectnicholas

    4 authors

  • Week 8

    Week 8
    WEEK8

    Open source

    This week we've open-sourced the Liveblocks sync engine and dev server.

    v3.14 🥧

    This release adds support for opting-in to the new storage engine on a per-room basis. The new storage engine can support larger documents, is more performant, is considered more stable, and will eventually become our default engine for all new rooms in the future. As of this release, the default storage engine still remains engine version 1.

    To give it a try, simply pass engine: 2 when entering a new room. After a room is created, you cannot change the engine it was created with anymore.

    // Vanilla JSclient.enterRoom("my-new-room", { engine: 2 });

    or:

    // In React<RoomProvider id="my-new-room" engine={2}>  ...</RoomProvider>

    • Support for selecting the preferred engine when entering new rooms: client.enterRoom("my-new-room", { engine: 2 })

    • Internal protocol optimizations to support larger storage documents

    • Add new config option createClient({ baseUrl: "https://..." }) to allow connecting to the Liveblocks dev server

    • Improve LiveList performance when processing large batches of operations

    • Improve LiveList.push() efficiency to prevent unbounded position string growth over time

    • Fix crash when clearing documents with a large number of keys

    • Remove the largeMessageStrategy client option. The WebSocket message limit has been increased from 1 MB to 32 MB, making this setting obsolete.

    • Support for selecting the preferred engine when entering new rooms: <RoomProvider id="my-new-room" engine={2}>...</RoomProvider>

    • Add new config option <LiveblocksProvider baseUrl="https://..." /> to allow connecting to the Liveblocks dev server

    • Exclude marking a thread or inbox notification as read from blocking navigation when preventUnsavedChanges is enabled.

    • Portaled elements now respect the portalContainer option from @liveblocks/react-ui’s LiveblocksUiConfig instead of always using document.body.

    • Support for selecting the preferred engine when entering new rooms: enterRoom("my-new-room", { engine: 2 })

    • Add new .setPresence() method to set ephemeral presence for a user in a room via the REST API, without requiring a WebSocket connection

    • Deprecated tenantId parameter in client methods, use organizationId instead.

    Website

    Documentation

    Dashboard

    • The Management API is now available in private beta for Enterprise customers.
    • We added Multi-Factor Authentication (MFA) support. Users can now enable MFA in their account pesonal settings for enhanced security.
    • New toggle to opt-in to use v2 Storage engine for all new rooms created going forward.

    Showcase

    Examples

    • Add dev server guide to all fully-supported example READMEs.

    Contributors

    Contributors include:nviemarcbouchenoireflowflorentjrownyctnicholassugardariuspierrelevaillantnimeshnayaju

    8 authors

  • Week 7

    Week 7
    WEEK7

    v3.13.5

    • Replace y-tiptap with y-prosemirror to prevent plugin key conflict, which was causing change source to be incorrectly set in BlockNote.

    Documentation

    • Add .md to the end of any docs page to view a markdown representation of it.
    • This .md is mentioned as an alternate link on each docs page.
    • Fetching any docs page with a priority text/markdown header will return markdown.

    Showcase

    Contributors

    Contributors include:ctnicholasnimeshnayaju

    2 authors

Next