@liveblocks/node - npm Package Versions

v0.19.0

This release brings Zustand v4 support. This is a breaking change only if you’re using @liveblocks/zustand.

In @liveblocks/zustand:

• Support Zustand v4 (actually v4.1.3 or higher)
• Drop support for Zustand v3 (also v4.1.2 or lower are not supported)
• Fix bug where some usage pattern could cause the Zustand store to stop synching (#491)

To migrate, make the following code changes:

• npm install zustand@latest
• npm install @liveblocks/zustand@latest
• Change these imports, if applicable:

  -import { middleware } from "@liveblocks/zustand";
  +import { liveblocks } from "@liveblocks/zustand";
  

  and

  -import type { LiveblocksState } from "@liveblocks/zustand";
  +import type { WithLiveblocks } from "@liveblocks/zustand";
  

  and rename accordingly.
• Change the pattern:

  create(liveblocks<MyState, ...>(...))
  

  to the Zustand v4 recommended pattern:

  create<WithLiveblocks<MyState, ...>>()(liveblocks(...))
  

  To be clear:
  1. First, move the type annotation away from the liveblocks middleware call, and onto the create call.
  2. Next, wrap your MyState type in a WithLiveblocks<...> wrapper. This will make sure the injected liveblocks property on your Zustand state will be correctly typed.
  3. Finally, make sure to add the extra call () wrapper, needed by Zustand v4 now:

     create<WithLiveblocks<MyState, ...>>()(liveblocks(...))
     //                                  ^^ Not a typo
     

• Remove the second argument to state.liveblocks.enterRoom(): it no longer takes an explicit initial state. Instead, it's automatically be populated from your Zustand state.

In @liveblocks/redux:

• The main export has been renamed:

  -import { enhancer } from "@liveblocks/redux";
  +import { liveblocksEnhancer } from "@liveblocks/redux";
  

• The second argument to state.liveblocks.enterRoom() to send in an explicit initial state is no longer supported. It will use the state in your Redux store, for consistency and ease of use.

v0.18.5

Bug fix:

• Fixes a small bug in a type definition, scopes was removed from BaseUserMeta.

Internal updates:

• Switch the monorepo over to Turborepo.

v0.18.4

All packages now provide an isReadOnly flag on user instances. It is available when getting self or others. isReadOnly is true when storage is read-only, see the room management guide for more information.

const me = room.getSelf();

me.isReadOnly; // boolean

const others = room.getOthers();
for (const other of others) {
  other.isReadOnly; // boolean
}

In @liveblocks/client:

• Add a new option shouldInitiallyConnect to client.enter that let you control whether or not the room connects to Liveblocks servers. Default is true.

  Usually set to false when the client is used from the server to not call the authentication endpoint or connect via WebSocket.

In @liveblocks/react:

• Add a new property shouldInitiallyConnect to RoomProvider that let you control whether or not the room connects to Liveblocks servers. Default is true.

  By default equals to typeof window !== "undefined", meaning the RoomProvider tries to connect to Liveblocks servers only on the client side.

• Internal package restructurings to increase code sharing. You may notice a new dependency show up in your dependency tree: @liveblocks/core. It contains private APIs that aren't intended for direct consumption.

v0.18.3

• In @liveblocks/react:

  Fixes the "zombie-child" problem that can occur with React 17 or lower. If you’re on React 18: great, you can ignore this! If you’re using React 17 or lower with Liveblocks, we’ll now start to enforce that you pass the unstable_batchedUpdates prop to RoomProvider, so this problem can be circumvented. This small addition may save you hours of debugging time!

  // ⚠️  Only if you’re using React 17 or lower
  import { unstable_batchedUpdates } from "react-dom";  // 👈
  
  <RoomProvider
    id="my-room"
    initialPresence={...}
    initialStorage={...}
    unstable_batchedUpdates={unstable_batchedUpdates}  // 👈
  >
    <App />
  </RoomProvider>
  

  To read more, see https://liveblocks.io/docs/guides/troubleshooting#stale-props-zombie-child

• In @liveblocks/zustand:

  • Fix a confusing error message

v0.18.2

• In @liveblocks/react:

  • Make sure that useOther will not rerender if tracked users already left the room, so that child components won't get rerendered before the parent got the chance to unmount them.
  • Disallow useOther without selector

v0.18.1

• In @liveblocks/react:

  • Fix a bug that could cause an error when patching presence during local development. Not an issue in production builds. (#505)

v0.18.0

For information, please read our Upgrade Guide for 0.18.

New React hooks ✨

• In @liveblocks/react:

  • useStorage
  • useMutation
  • useSelf
  • useOthers
  • useOthersMapped
  • useOthersConnectionIds
  • useOther (singular)

• In @liveblocks/client:

  • New .toImmutable() method on LiveObject, LiveList, and LiveMap lets you work with an immutable representation of the storage objects
  • Improved core performance
  • Reduced bundle size
  • Others only become visible in the others array if their presence is known

Breaking changes

• Remove support for directly importing hooks from @liveblocks/client (e.g. import { useMyPresence } from '@liveblocks/react'). If you’re still using these imports, see the Upgrade Guide for 0.17 for instructions.
• Remove ClientProvider and useClient hook
• Remove defaultPresence and defaultStorageRoot arguments. (Just use initialPresence and initialStorage arguments now.)
• Remove second argument to useMap(), useList(), and useObject().
• Remove new LiveMap(null) support. (Just use new LiveMap() or new LiveMap([]).)