@liveblocks/react 1.4.5 → 1.4.6-test1

package/dist/index.d.mts

@@ -28,6 +28,9 @@ declare type Props = {
  */
 declare function ClientSideSuspense(props: Props): ReactElement;
 
+declare type PartialNullable<T> = {
+    [P in keyof T]?: T[P] | null | undefined;
+};
 declare type CreateThreadOptions<TMetadata extends BaseMetadata> = [
     TMetadata
 ] extends [never] ? {
@@ -42,7 +45,7 @@ declare type EditThreadMetadataOptions<TMetadata extends BaseMetadata> = [
     threadId: string;
 } : {
     threadId: string;
-    metadata: Partial<TMetadata>;
+    metadata: Resolve<PartialNullable<TMetadata>>;
 };
 declare type CreateCommentOptions = {
     threadId: string;
@@ -79,11 +82,25 @@ declare type ThreadsStateSuccess<TThreadMetadata extends BaseMetadata> = {
 };
 declare type ThreadsState<TThreadMetadata extends BaseMetadata> = ThreadsStateLoading | ThreadsStateError | ThreadsStateSuccess<TThreadMetadata>;
 
-declare type ResolveUserOptions = {
-    userId: string;
+declare type PromiseOrNot<T> = T | Promise<T>;
+declare type ResolveUsersArgs = {
+    /**
+     * The ID of the current room.
+     */
+    roomId: string;
+    /**
+     * The ID of the users to resolve.
+     */
+    userIds: string;
 };
-declare type ResolveMentionSuggestionsOptions = {
+declare type ResolveMentionSuggestionsArgs = {
+    /**
+     * The ID of the current room.
+     */
     roomId: string;
+    /**
+     * The text to search for.
+     */
     text: string;
 };
 declare type UserStateLoading = {
@@ -439,6 +456,7 @@ declare type RoomContextBundleShared<TPresence extends JsonObject, TStorage exte
      * @beta
      *
      * Returns a function that edits a thread's metadata.
+     * To delete an existing metadata property, set its value to `null`.
      *
      * @example
      * const editThreadMetadata = useEditThreadMetadata();
@@ -742,15 +760,15 @@ declare type Options<TUserMeta extends BaseUserMeta> = {
     /**
      * @beta
      *
-     * An asynchronous function that returns user info from a user ID.
+     * A function that returns user info from user IDs.
      */
-    resolveUser?: (options: ResolveUserOptions) => Promise<TUserMeta["info"] | undefined>;
+    resolveUsers?: (args: ResolveUsersArgs) => PromiseOrNot<TUserMeta["info"] | undefined>;
     /**
      * @beta
      *
-     * An asynchronous function that returns a list of user IDs matching a string.
+     * A function that returns a list of user IDs matching a string.
      */
-    resolveMentionSuggestions?: (options: ResolveMentionSuggestionsOptions) => Promise<string[]>;
+    resolveMentionSuggestions?: (args: ResolveMentionSuggestionsArgs) => PromiseOrNot<string[]>;
 };
 /**
  * @private
@@ -800,7 +818,9 @@ declare function useRoomContextBundle(): {
     }) => _liveblocks_core.ThreadData<BaseMetadata>;
     useEditThreadMetadata: () => (options: {
         threadId: string;
-        metadata: Partial<BaseMetadata>;
+        metadata: {
+            [x: string]: string | number | boolean | null | undefined;
+        };
     }) => void;
     useCreateComment: () => (options: CreateCommentOptions) => CommentData;
     useEditComment: () => (options: EditCommentOptions) => void;
@@ -1154,7 +1174,9 @@ declare function useRoomContextBundle(): {
         }) => _liveblocks_core.ThreadData<BaseMetadata>;
         useEditThreadMetadata: () => (options: {
             threadId: string;
-            metadata: Partial<BaseMetadata>;
+            metadata: {
+                [x: string]: string | number | boolean | null | undefined;
+            };
         }) => void;
         useCreateComment: () => (options: CreateCommentOptions) => CommentData;
         useEditComment: () => (options: EditCommentOptions) => void;
@@ -1471,4 +1493,4 @@ declare function useRoomContextBundle(): {
 };
 declare function createRoomContext<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never, TThreadMetadata extends BaseMetadata = never>(client: Client, options?: Options<TUserMeta>): RoomContextBundle<TPresence, TStorage, TUserMeta, TRoomEvent, TThreadMetadata>;
 
-export { ClientSideSuspense, MutationContext, ResolveMentionSuggestionsOptions, ResolveUserOptions, createRoomContext, useRoomContextBundle };
+export { ClientSideSuspense, MutationContext, ResolveMentionSuggestionsArgs, ResolveUsersArgs, createRoomContext, useRoomContextBundle };

package/dist/index.d.ts

@@ -28,6 +28,9 @@ declare type Props = {
  */
 declare function ClientSideSuspense(props: Props): ReactElement;
 
+declare type PartialNullable<T> = {
+    [P in keyof T]?: T[P] | null | undefined;
+};
 declare type CreateThreadOptions<TMetadata extends BaseMetadata> = [
     TMetadata
 ] extends [never] ? {
@@ -42,7 +45,7 @@ declare type EditThreadMetadataOptions<TMetadata extends BaseMetadata> = [
     threadId: string;
 } : {
     threadId: string;
-    metadata: Partial<TMetadata>;
+    metadata: Resolve<PartialNullable<TMetadata>>;
 };
 declare type CreateCommentOptions = {
     threadId: string;
@@ -79,11 +82,25 @@ declare type ThreadsStateSuccess<TThreadMetadata extends BaseMetadata> = {
 };
 declare type ThreadsState<TThreadMetadata extends BaseMetadata> = ThreadsStateLoading | ThreadsStateError | ThreadsStateSuccess<TThreadMetadata>;
 
-declare type ResolveUserOptions = {
-    userId: string;
+declare type PromiseOrNot<T> = T | Promise<T>;
+declare type ResolveUsersArgs = {
+    /**
+     * The ID of the current room.
+     */
+    roomId: string;
+    /**
+     * The ID of the users to resolve.
+     */
+    userIds: string;
 };
-declare type ResolveMentionSuggestionsOptions = {
+declare type ResolveMentionSuggestionsArgs = {
+    /**
+     * The ID of the current room.
+     */
     roomId: string;
+    /**
+     * The text to search for.
+     */
     text: string;
 };
 declare type UserStateLoading = {
@@ -439,6 +456,7 @@ declare type RoomContextBundleShared<TPresence extends JsonObject, TStorage exte
      * @beta
      *
      * Returns a function that edits a thread's metadata.
+     * To delete an existing metadata property, set its value to `null`.
      *
      * @example
      * const editThreadMetadata = useEditThreadMetadata();
@@ -742,15 +760,15 @@ declare type Options<TUserMeta extends BaseUserMeta> = {
     /**
      * @beta
      *
-     * An asynchronous function that returns user info from a user ID.
+     * A function that returns user info from user IDs.
      */
-    resolveUser?: (options: ResolveUserOptions) => Promise<TUserMeta["info"] | undefined>;
+    resolveUsers?: (args: ResolveUsersArgs) => PromiseOrNot<TUserMeta["info"] | undefined>;
     /**
      * @beta
      *
-     * An asynchronous function that returns a list of user IDs matching a string.
+     * A function that returns a list of user IDs matching a string.
      */
-    resolveMentionSuggestions?: (options: ResolveMentionSuggestionsOptions) => Promise<string[]>;
+    resolveMentionSuggestions?: (args: ResolveMentionSuggestionsArgs) => PromiseOrNot<string[]>;
 };
 /**
  * @private
@@ -800,7 +818,9 @@ declare function useRoomContextBundle(): {
     }) => _liveblocks_core.ThreadData<BaseMetadata>;
     useEditThreadMetadata: () => (options: {
         threadId: string;
-        metadata: Partial<BaseMetadata>;
+        metadata: {
+            [x: string]: string | number | boolean | null | undefined;
+        };
     }) => void;
     useCreateComment: () => (options: CreateCommentOptions) => CommentData;
     useEditComment: () => (options: EditCommentOptions) => void;
@@ -1154,7 +1174,9 @@ declare function useRoomContextBundle(): {
         }) => _liveblocks_core.ThreadData<BaseMetadata>;
         useEditThreadMetadata: () => (options: {
             threadId: string;
-            metadata: Partial<BaseMetadata>;
+            metadata: {
+                [x: string]: string | number | boolean | null | undefined;
+            };
         }) => void;
         useCreateComment: () => (options: CreateCommentOptions) => CommentData;
         useEditComment: () => (options: EditCommentOptions) => void;
@@ -1471,4 +1493,4 @@ declare function useRoomContextBundle(): {
 };
 declare function createRoomContext<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never, TThreadMetadata extends BaseMetadata = never>(client: Client, options?: Options<TUserMeta>): RoomContextBundle<TPresence, TStorage, TUserMeta, TRoomEvent, TThreadMetadata>;
 
-export { ClientSideSuspense, MutationContext, ResolveMentionSuggestionsOptions, ResolveUserOptions, createRoomContext, useRoomContextBundle };
+export { ClientSideSuspense, MutationContext, ResolveMentionSuggestionsArgs, ResolveUsersArgs, createRoomContext, useRoomContextBundle };

package/dist/index.js

@@ -5,7 +5,7 @@ var _core = require('@liveblocks/core');
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/react";
-var PKG_VERSION = "1.4.5";
+var PKG_VERSION = "1.4.6-test1";
 var PKG_FORMAT = "cjs";
 
 // src/ClientSideSuspense.tsx
@@ -28,6 +28,7 @@ var _client = require('@liveblocks/client');
 
 
 
+
 var _withselectorjs = require('use-sync-external-store/shim/with-selector.js');
 
 // src/comments/CommentsRoom.ts
@@ -626,18 +627,6 @@ function useDebounce(value, delay = DEFAULT_DELAY) {
   return debouncedValue;
 }
 
-// src/lib/stable-stringify.ts
-function stableStringify(object, ...args) {
-  const sortedObject = Object.keys(object).sort().reduce(
-    (sortedObject2, key) => {
-      sortedObject2[key] = object[key];
-      return sortedObject2;
-    },
-    {}
-  );
-  return JSON.stringify(sortedObject, ...args);
-}
-
 // src/lib/use-async-cache.ts
 
 
@@ -662,35 +651,50 @@ function useAsyncCache(cache, key, options) {
     if (key === null || !cache) {
       return null;
     }
-    const cacheItem2 = cache.create(key, _optionalChain([frozenOptions, 'optionalAccess', _2 => _2.overrideFunction]));
+    const cacheItem2 = cache.create(key);
     void cacheItem2.get();
     return cacheItem2;
-  }, [cache, frozenOptions, key]);
+  }, [cache, key]);
   const subscribe = _react.useCallback.call(void 0, 
-    (callback) => _nullishCoalesce(_optionalChain([cacheItem, 'optionalAccess', _3 => _3.subscribe, 'call', _4 => _4(callback)]), () => ( noop)),
+    (callback) => _nullishCoalesce(_optionalChain([cacheItem, 'optionalAccess', _2 => _2.subscribe, 'call', _3 => _3(callback)]), () => ( noop)),
     [cacheItem]
   );
   const getState = _react.useCallback.call(void 0, 
-    () => _nullishCoalesce(_optionalChain([cacheItem, 'optionalAccess', _5 => _5.getState, 'call', _6 => _6()]), () => ( INITIAL_ASYNC_STATE)),
+    () => _nullishCoalesce(_optionalChain([cacheItem, 'optionalAccess', _4 => _4.getState, 'call', _5 => _5()]), () => ( INITIAL_ASYNC_STATE)),
     [cacheItem]
   );
-  const revalidate = _react.useCallback.call(void 0, () => _optionalChain([cacheItem, 'optionalAccess', _7 => _7.revalidate, 'call', _8 => _8()]), [cacheItem]);
+  const revalidate = _react.useCallback.call(void 0, () => _optionalChain([cacheItem, 'optionalAccess', _6 => _6.revalidate, 'call', _7 => _7()]), [cacheItem]);
   const state = _indexjs.useSyncExternalStore.call(void 0, subscribe, getState, getState);
   const previousData = _react.useRef.call(void 0, );
   let data = state.data;
   _react.useEffect.call(void 0, () => {
     previousData.current = { key, data: state.data };
-  }, [key, state]);
-  if (_optionalChain([frozenOptions, 'optionalAccess', _9 => _9.suspense]) && state.isLoading && cacheItem) {
-    throw new Promise((resolve) => {
-      cacheItem.subscribeOnce(() => resolve());
-    });
+  }, [key, state.data]);
+  if (!cacheItem) {
+    return {
+      isLoading: false,
+      data: void 0,
+      error: void 0,
+      getState,
+      revalidate
+    };
   }
-  if (state.isLoading && _optionalChain([frozenOptions, 'optionalAccess', _10 => _10.keepPreviousDataWhileLoading]) && typeof state.data === "undefined" && _optionalChain([previousData, 'access', _11 => _11.current, 'optionalAccess', _12 => _12.key]) !== key && typeof _optionalChain([previousData, 'access', _13 => _13.current, 'optionalAccess', _14 => _14.data]) !== "undefined") {
-    data = previousData.current.data;
+  if (_optionalChain([frozenOptions, 'optionalAccess', _8 => _8.suspense])) {
+    const error = getState().error;
+    if (error) {
+      throw error;
+    } else if (getState().isLoading) {
+      throw new Promise((resolve) => {
+        cacheItem.subscribeOnce((state2) => {
+          if (!state2.isLoading) {
+            resolve();
+          }
+        });
+      });
+    }
   }
-  if (_optionalChain([frozenOptions, 'optionalAccess', _15 => _15.suspense]) && state.error) {
-    throw state.error;
+  if (state.isLoading && _optionalChain([frozenOptions, 'optionalAccess', _9 => _9.keepPreviousDataWhileLoading]) && typeof state.data === "undefined" && _optionalChain([previousData, 'access', _10 => _10.current, 'optionalAccess', _11 => _11.key]) !== key && typeof _optionalChain([previousData, 'access', _12 => _12.current, 'optionalAccess', _13 => _13.data]) !== "undefined") {
+    data = previousData.current.data;
   }
   return {
     isLoading: state.isLoading,
@@ -740,6 +744,9 @@ function alwaysEmptyList() {
 function alwaysNull() {
   return null;
 }
+function alwaysConnecting() {
+  return "connecting";
+}
 function makeMutationContext(room) {
   const errmsg = "This mutation cannot be used until connected to the Liveblocks room";
   return {
@@ -767,13 +774,13 @@ function makeMutationContext(room) {
     setMyPresence: room.updatePresence
   };
 }
-var hasWarnedIfNoResolveUser = false;
-function warnIfNoResolveUser(usersCache) {
-  if (!hasWarnedIfNoResolveUser && !usersCache && process.env.NODE_ENV !== "production") {
+var hasWarnedIfNoResolveUsers = false;
+function warnIfNoResolveUsers(usersCache) {
+  if (!hasWarnedIfNoResolveUsers && !usersCache && process.env.NODE_ENV !== "production") {
     console.warn(
-      "Set the resolveUser option in createRoomContext to specify user info."
+      "Set the resolveUsers option in createRoomContext to specify user info."
     );
-    hasWarnedIfNoResolveUser = true;
+    hasWarnedIfNoResolveUsers = true;
   }
 }
 var hasWarnedAboutCommentsBeta = false;
@@ -878,7 +885,8 @@ function createRoomContext(client, options) {
     const room = useRoom();
     const subscribe = room.events.status.subscribe;
     const getSnapshot = room.getStatus;
-    return useSyncExternalStore3(subscribe, getSnapshot, getSnapshot);
+    const getServerSnapshot = alwaysConnecting;
+    return useSyncExternalStore3(subscribe, getSnapshot, getServerSnapshot);
   }
   function useMyPresence() {
     const room = useRoom();
@@ -1070,7 +1078,7 @@ function createRoomContext(client, options) {
       function onRootChange() {
         const newValue = root.get(key);
         if (newValue !== curr) {
-          _optionalChain([unsubCurr, 'optionalCall', _16 => _16()]);
+          _optionalChain([unsubCurr, 'optionalCall', _14 => _14()]);
           curr = newValue;
           subscribeToCurr();
           rerender();
@@ -1081,7 +1089,7 @@ function createRoomContext(client, options) {
       const unsubscribeRoot = room.subscribe(root, onRootChange);
       return () => {
         unsubscribeRoot();
-        _optionalChain([unsubCurr, 'optionalCall', _17 => _17()]);
+        _optionalChain([unsubCurr, 'optionalCall', _15 => _15()]);
       };
     }, [rootOrNull, room, key, rerender]);
     if (rootOrNull === null) {
@@ -1143,6 +1151,7 @@ function createRoomContext(client, options) {
     }
     ensureNotServerSide();
     throw new Promise((res) => {
+      room.events.self.subscribeOnce(() => res());
       room.events.status.subscribeOnce(() => res());
     });
   }
@@ -1298,19 +1307,21 @@ function createRoomContext(client, options) {
       [room]
     );
   }
-  const { resolveUser, resolveMentionSuggestions } = _nullishCoalesce(options, () => ( {}));
-  const usersCache = resolveUser ? _core.createAsyncCache.call(void 0, (stringifiedOptions) => {
-    return resolveUser(
+  const { resolveUsers, resolveMentionSuggestions } = _nullishCoalesce(options, () => ( {}));
+  const usersCache = resolveUsers ? _core.createAsyncCache.call(void 0, async (stringifiedOptions) => {
+    const users = await resolveUsers(
       JSON.parse(stringifiedOptions)
     );
+    return _optionalChain([users, 'optionalAccess', _16 => _16[0]]);
   }) : void 0;
   function useUser(userId) {
+    const room = useRoom();
     const resolverKey = React2.useMemo(
-      () => stableStringify({ userId }),
-      [userId]
+      () => _core.stringify.call(void 0, { userIds: [userId], roomId: room.id }),
+      [userId, room.id]
     );
     const state = useAsyncCache(usersCache, resolverKey);
-    React2.useEffect(() => warnIfNoResolveUser(usersCache), []);
+    React2.useEffect(() => warnIfNoResolveUsers(usersCache), []);
     if (state.isLoading) {
       return {
         isLoading: true
@@ -1324,14 +1335,15 @@ function createRoomContext(client, options) {
     }
   }
   function useUserSuspense(userId) {
+    const room = useRoom();
     const resolverKey = React2.useMemo(
-      () => stableStringify({ userId }),
-      [userId]
+      () => _core.stringify.call(void 0, { userIds: [userId], roomId: room.id }),
+      [userId, room.id]
     );
     const state = useAsyncCache(usersCache, resolverKey, {
       suspense: true
     });
-    React2.useEffect(() => warnIfNoResolveUser(usersCache), []);
+    React2.useEffect(() => warnIfNoResolveUsers(usersCache), []);
     return {
       user: state.data,
       isLoading: false
@@ -1348,7 +1360,7 @@ function createRoomContext(client, options) {
     const room = useRoom();
     const debouncedSearch = useDebounce(search, 500);
     const resolverKey = React2.useMemo(
-      () => debouncedSearch !== void 0 ? stableStringify({ text: debouncedSearch, roomId: room.id }) : null,
+      () => debouncedSearch !== void 0 ? _core.stringify.call(void 0, { text: debouncedSearch, roomId: room.id }) : null,
       [debouncedSearch, room.id]
     );
     const { data } = useAsyncCache(mentionSuggestionsCache, resolverKey, {