@liveblocks/yjs - npm Package Versions

v2.1.0

@liveblocks/client

• Various internal refactorings

@liveblocks/react

• Add new hook useStorageStatus, which returns the current storage status of the room, and will re-render your component whenever it changes. This can used to build "Saving..." UIs.
• Add useDeleteThread hook to delete a thread and its associated comments.
• Fix: add missing JSDoc comments
• Fix: improve some error messages and stack traces to contain more info
• Refactorings to Suspense internals

@liveblocks/react-ui

• Fix improper useSyncExternalStore import which would break on React versions lower than 18.

v2.0.5

@liveblocks/react

• Improved DX: useDeleteThread will now throw a client-side error if someone else than the thread owner tries to delete the thread. This will help you catch and handle this case more easily.

v2.0.4

All packages

• Improve TS error messages and error locations if custom UserMeta or ActivitiesData types do not match their requirements

@liveblocks/client

• Add missing type export for CommentReaction
• Don’t attempt to write missing initialStorage keys if the current user has no write access to storage. This will no longer throw, but issue a warning message in the console.

@liveblocks/react

• Add useDeleteThread hook to delete a thread and its associated comments.

v2.0.3

@liveblocks/client

• In client.enterRoom(), the options initialPresence and initialStorage are now only mandatory if your custom type requires them to be.

@liveblocks/react

• In <RoomProvider>, the props initialPresence and initialStorage are now only mandatory if your custom type requires them to be.
• Nesting <LiveblocksProvider>s will now throw to prevent incorrect usage.

@liveblocks/react-ui

• Prevent the composer from splitting text being composed.
• Handle parentheses around and within auto links.
• Count whitespace as empty to prevent posting empty comments.
• Prevent clearing the composer if it's not handled. (via onComposerSubmit)

@liveblocks/yjs

• Add missing type exports

v2.0.2

@liveblocks/node

• Add deleteThread method to the client to delete a room's thread.
• Add the threadDeleted webhook event to notify when a thread is deleted.
• Fix type signatures of client.identifyUser() and client.prepareSession() to require userInfo if it's mandatory according to your global UserMeta type definition.

v2.0.0

This major release marks the maturity of Liveblocks. It contains new products (@liveblocks/react-lexical) and clarifications (e.g. @liveblocks/react-comments is now called @liveblocks/react-ui).

Also, we bring major DX improvements by allowing you to specify your types globally now. These types will be typed once and shared across all Liveblocks APIs, which includes your Node backend.

// ❌ Before
export const {
  suspense: {
    RoomProvider,
    useRoom,
    // etc
  },
} = createRoomContext<Presence, Storage>(client);

// ✅ After
declare global {
  interface Liveblocks {
    Presence: Presence;
    Storage: Storage;
  }
}

In @liveblocks/react, you can now import hooks directly:

// ❌ Before: get hooks exported from your Liveblocks config
import { RoomProvider, useRoom, ... } from "./liveblocks.config";

// ✅ After: import hooks directly
import { RoomProvider, useRoom, ... } from "@liveblocks/react";
import { RoomProvider, useRoom, ... } from "@liveblocks/react/suspense";

// ❌ Before
const client = createClient(/* options */);

// ✅ After
<LiveblocksProvider /* options */>
  <App />
</LiveblocksProvider>

For full upgrade instructions and codemods, see the 2.0 upgrade guide.

create-liveblocks-app

• Update config generation for Liveblocks 2.0.
• Add --upgrade flag to automatically update all Liveblocks package to their latest version.

@liveblocks/client

• DX improvements: type once, globally, benefit everywhere

@liveblocks/react

• DX improvement: import hooks directly
• DX improvement: <ClientSideSuspense> no longer needs a function as its children
• New provider: LiveblocksProvider (replaces the need for createClient)
• New hook: useClient
• Tweak useMutation error message to be less confusing.
• Allow thread and activity metadata types to contain undefined values.

@liveblocks/react-ui

• Rename from @liveblocks/react-comments.
• Rename <CommentsConfig /> to <LiveblocksUIConfig />.
• Improve InboxNotification props types.

@liveblocks/react-lexical

• Initial release.

@liveblocks/node-lexical

• Initial release.

@liveblocks/yjs

• LiveblocksProvider is no longer a default export, it’s now import { LiveblocksYjsProvider } from "@liveblocks/yjs".

@liveblocks/node

• DX improvements: all Node client methods will pick up the same global types you’re using in your frontend
• Rename RoomInfo to RoomData.
• The webhook event NotificationEvent’s type can represent multiple kinds of notifications. ("thread", "textMention", and custom ones (e.g. "$myNotification"))

@liveblocks/codemod

• Initial release.