@liveblocks/react 2.11.1 → 2.12.0

package/dist/{chunk-3MM4G6XB.js → chunk-IACZPXTY.js}

@@ -32,6 +32,7 @@ var _withselectorjs = require('use-sync-external-store/shim/with-selector.js');
 var SECONDS = 1e3;
 var MINUTES = 60 * SECONDS;
 var config = {
+  SMOOTH_DELAY: 1 * SECONDS,
   NOTIFICATIONS_POLL_INTERVAL: 1 * MINUTES,
   NOTIFICATIONS_MAX_STALE_TIME: 5 * SECONDS,
   ROOM_THREADS_POLL_INTERVAL: 5 * MINUTES,
@@ -503,6 +504,7 @@ var UmbrellaStore = class {
     // Room notification settings
     this._roomNotificationSettings = /* @__PURE__ */ new Map();
     this._client = client[_core.kInternal].as();
+    this._syncSource = this._client[_core.kInternal].createSyncSource();
     const inboxFetcher = async (cursor) => {
       const result = await this._client.getInboxNotifications({ cursor });
       this.updateThreadsAndNotifications(
@@ -651,12 +653,6 @@ var UmbrellaStore = class {
       versions: Object.values(_nullishCoalesce(this.get().versionsByRoomId[roomId], () => ( {})))
     };
   }
-  /**
-   * @private Only used by the E2E test suite.
-   */
-  _hasOptimisticUpdates() {
-    return this._store.get().optimisticUpdates.length > 0;
-  }
   subscribe(callback) {
     return this._store.subscribe(callback);
   }
@@ -703,10 +699,13 @@ var UmbrellaStore = class {
     });
   }
   updateOptimisticUpdatesCache(mapFn) {
-    this._store.set((state) => ({
-      ...state,
-      optimisticUpdates: mapFn(state.optimisticUpdates)
-    }));
+    this._store.set((state) => {
+      const optimisticUpdates = mapFn(state.optimisticUpdates);
+      this._syncSource.setSyncStatus(
+        optimisticUpdates.length > 0 ? "synchronizing" : "synchronized"
+      );
+      return { ...state, optimisticUpdates };
+    });
   }
   // ---------------------------------------------------------------------------------- }}}
   /** @internal - Only call this method from unit tests. */
@@ -1952,18 +1951,23 @@ function useRoomInfoSuspense_withClient(client, roomId) {
 }
 function createSharedContext(client) {
   const useClient2 = () => client;
+  function useSyncStatus2(options) {
+    return useSyncStatus_withClient(client, options);
+  }
   return {
     classic: {
       useClient: useClient2,
       useUser: (userId) => useUser_withClient(client, userId),
       useRoomInfo: (roomId) => useRoomInfo_withClient(client, roomId),
-      useIsInsideRoom
+      useIsInsideRoom,
+      useSyncStatus: useSyncStatus2
     },
     suspense: {
       useClient: useClient2,
       useUser: (userId) => useUserSuspense_withClient(client, userId),
       useRoomInfo: (roomId) => useRoomInfoSuspense_withClient(client, roomId),
-      useIsInsideRoom
+      useIsInsideRoom,
+      useSyncStatus: useSyncStatus2
     }
   };
 }
@@ -1995,6 +1999,7 @@ function LiveblocksProvider(props) {
     polyfills: useInitial(o.polyfills),
     unstable_fallbackToHTTP: useInitial(o.unstable_fallbackToHTTP),
     unstable_streamData: useInitial(o.unstable_streamData),
+    preventUnsavedChanges: useInitial(o.preventUnsavedChanges),
     authEndpoint: useInitialUnlessFunction(o.authEndpoint),
     resolveMentionSuggestions: useInitialUnlessFunction(
       o.resolveMentionSuggestions
@@ -2118,6 +2123,46 @@ var _useUser = useUser;
 var _useUserSuspense = useUserSuspense;
 var _useUserThreads_experimental = useUserThreads_experimental;
 var _useUserThreadsSuspense_experimental = useUserThreadsSuspense_experimental;
+function useSyncStatus_withClient(client, options) {
+  const smooth = useInitial(_nullishCoalesce(_optionalChain([options, 'optionalAccess', _11 => _11.smooth]), () => ( false)));
+  if (smooth) {
+    return useSyncStatusSmooth_withClient(client);
+  } else {
+    return useSyncStatusImmediate_withClient(client);
+  }
+}
+function useSyncStatusImmediate_withClient(client) {
+  return _indexjs.useSyncExternalStore.call(void 0, 
+    client.events.syncStatus.subscribe,
+    client.getSyncStatus,
+    client.getSyncStatus
+  );
+}
+function useSyncStatusSmooth_withClient(client) {
+  const getter = client.getSyncStatus;
+  const [status, setStatus] = React.default.useState(getter);
+  const oldStatus = useLatest(getter());
+  React.default.useEffect(() => {
+    let timeoutId;
+    const unsub = client.events.syncStatus.subscribe(() => {
+      const newStatus = getter();
+      if (oldStatus.current === "synchronizing" && newStatus === "synchronized") {
+        timeoutId = setTimeout(() => setStatus(newStatus), config.SMOOTH_DELAY);
+      } else {
+        clearTimeout(timeoutId);
+        setStatus(newStatus);
+      }
+    });
+    return () => {
+      clearTimeout(timeoutId);
+      unsub();
+    };
+  }, [client, getter, oldStatus]);
+  return status;
+}
+function useSyncStatus(options) {
+  return useSyncStatus_withClient(useClient(), options);
+}
 
 // src/types/errors.ts
 var CreateThreadError = class extends Error {
@@ -2265,7 +2310,6 @@ function useScrollToCommentOnLoadEffect(shouldScrollOnLoad, state) {
 }
 
 // src/room.tsx
-var SMOOTH_DELAY = 1e3;
 var noop3 = () => {
 };
 var identity2 = (x) => x;
@@ -2333,7 +2377,7 @@ function getCurrentUserId(room) {
 }
 function handleApiError(err) {
   const message = `Request failed with status ${err.status}: ${err.message}`;
-  if (_optionalChain([err, 'access', _11 => _11.details, 'optionalAccess', _12 => _12.error]) === "FORBIDDEN") {
+  if (_optionalChain([err, 'access', _12 => _12.details, 'optionalAccess', _13 => _13.error]) === "FORBIDDEN") {
     const detailedMessage = [message, err.details.suggestion, err.details.docs].filter(Boolean).join("\n");
     _core.console.error(detailedMessage);
   }
@@ -2673,7 +2717,7 @@ function useStatus() {
   return useSyncExternalStore2(subscribe, getSnapshot, getServerSnapshot);
 }
 function useStorageStatus(options) {
-  const smooth = useInitial(_nullishCoalesce(_optionalChain([options, 'optionalAccess', _13 => _13.smooth]), () => ( false)));
+  const smooth = useInitial(_nullishCoalesce(_optionalChain([options, 'optionalAccess', _14 => _14.smooth]), () => ( false)));
   if (smooth) {
     return useStorageStatusSmooth();
   } else {
@@ -2695,7 +2739,7 @@ function useStorageStatusSmooth() {
     let timeoutId;
     const unsub = room.events.storageStatus.subscribe((newStatus) => {
       if (oldStatus.current === "synchronizing" && newStatus === "synchronized") {
-        timeoutId = setTimeout(() => setStatus(newStatus), SMOOTH_DELAY);
+        timeoutId = setTimeout(() => setStatus(newStatus), config.SMOOTH_DELAY);
       } else {
         clearTimeout(timeoutId);
         setStatus(newStatus);
@@ -3013,7 +3057,7 @@ function useCreateThread() {
         thread: newThread,
         roomId: room.id
       });
-      const attachmentIds = _optionalChain([attachments, 'optionalAccess', _14 => _14.map, 'call', _15 => _15((attachment) => attachment.id)]);
+      const attachmentIds = _optionalChain([attachments, 'optionalAccess', _15 => _15.map, 'call', _16 => _16((attachment) => attachment.id)]);
       room.createThread({ threadId, commentId, body, metadata, attachmentIds }).then(
         (thread) => {
           store.createThread(optimisticUpdateId, thread);
@@ -3043,7 +3087,7 @@ function useDeleteThread() {
       const { store, onMutationFailure } = getRoomExtrasForClient(client);
       const userId = getCurrentUserId(room);
       const existing = store.getFullState().threadsDB.get(threadId);
-      if (_optionalChain([existing, 'optionalAccess', _16 => _16.comments, 'optionalAccess', _17 => _17[0], 'optionalAccess', _18 => _18.userId]) !== userId) {
+      if (_optionalChain([existing, 'optionalAccess', _17 => _17.comments, 'optionalAccess', _18 => _18[0], 'optionalAccess', _19 => _19.userId]) !== userId) {
         throw new Error("Only the thread creator can delete the thread");
       }
       const optimisticUpdateId = store.addOptimisticUpdate({
@@ -3131,7 +3175,7 @@ function useCreateComment() {
         type: "create-comment",
         comment
       });
-      const attachmentIds = _optionalChain([attachments, 'optionalAccess', _19 => _19.map, 'call', _20 => _20((attachment) => attachment.id)]);
+      const attachmentIds = _optionalChain([attachments, 'optionalAccess', _20 => _20.map, 'call', _21 => _21((attachment) => attachment.id)]);
       room.createComment({ threadId, commentId, body, attachmentIds }).then(
         (newComment) => {
           store.createComment(newComment, optimisticUpdateId);
@@ -3184,7 +3228,7 @@ function useEditComment() {
           attachments: _nullishCoalesce(attachments, () => ( []))
         }
       });
-      const attachmentIds = _optionalChain([attachments, 'optionalAccess', _21 => _21.map, 'call', _22 => _22((attachment) => attachment.id)]);
+      const attachmentIds = _optionalChain([attachments, 'optionalAccess', _22 => _22.map, 'call', _23 => _23((attachment) => attachment.id)]);
       room.editComment({ threadId, commentId, body, attachmentIds }).then(
         (editedComment) => {
           store.editComment(threadId, optimisticUpdateId, editedComment);
@@ -3687,7 +3731,7 @@ function useThreadsSuspense(options = {
   return result;
 }
 function selectorFor_useAttachmentUrl(state) {
-  if (state === void 0 || _optionalChain([state, 'optionalAccess', _23 => _23.isLoading])) {
+  if (state === void 0 || _optionalChain([state, 'optionalAccess', _24 => _24.isLoading])) {
     return _nullishCoalesce(state, () => ( { isLoading: true }));
   }
   if (state.error) {
@@ -3867,5 +3911,6 @@ var _useUpdateMyPresence = useUpdateMyPresence;
 
 
 
-exports.RoomContext = RoomContext; exports.ClientContext = ClientContext; exports.getUmbrellaStoreForClient = getUmbrellaStoreForClient; exports.useClient = useClient; exports.LiveblocksProvider = LiveblocksProvider; exports.createLiveblocksContext = createLiveblocksContext; exports.useInboxNotifications = useInboxNotifications; exports.useInboxNotificationsSuspense = useInboxNotificationsSuspense; exports.useMarkAllInboxNotificationsAsRead = useMarkAllInboxNotificationsAsRead; exports.useMarkInboxNotificationAsRead = useMarkInboxNotificationAsRead; exports.useDeleteAllInboxNotifications = useDeleteAllInboxNotifications; exports.useDeleteInboxNotification = useDeleteInboxNotification; exports.useUnreadInboxNotificationsCount = useUnreadInboxNotificationsCount; exports.useUnreadInboxNotificationsCountSuspense = useUnreadInboxNotificationsCountSuspense; exports.useRoomInfo = useRoomInfo; exports.useRoomInfoSuspense = useRoomInfoSuspense; exports._useInboxNotificationThread = _useInboxNotificationThread; exports._useUser = _useUser; exports._useUserSuspense = _useUserSuspense; exports._useUserThreads_experimental = _useUserThreads_experimental; exports._useUserThreadsSuspense_experimental = _useUserThreadsSuspense_experimental; exports.CreateThreadError = CreateThreadError; exports.useStatus = useStatus; exports.useStorageStatus = useStorageStatus; exports.useBatch = useBatch; exports.useLostConnectionListener = useLostConnectionListener; exports.useErrorListener = useErrorListener; exports.useHistory = useHistory; exports.useUndo = useUndo; exports.useRedo = useRedo; exports.useCanUndo = useCanUndo; exports.useCanRedo = useCanRedo; exports.useOthersConnectionIds = useOthersConnectionIds; exports.useCommentsErrorListener = useCommentsErrorListener; exports.useCreateComment = useCreateComment; exports.useEditComment = useEditComment; exports.useDeleteComment = useDeleteComment; exports.useRemoveReaction = useRemoveReaction; exports.useMarkThreadAsRead = useMarkThreadAsRead; exports.useMarkThreadAsResolved = useMarkThreadAsResolved; exports.useMarkThreadAsUnresolved = useMarkThreadAsUnresolved; exports.useThreadSubscription = useThreadSubscription; exports.useHistoryVersionData = useHistoryVersionData; exports.useUpdateRoomNotificationSettings = useUpdateRoomNotificationSettings; exports.useOthersConnectionIdsSuspense = useOthersConnectionIdsSuspense; exports.useStorageStatusSuspense = useStorageStatusSuspense; exports.useAttachmentUrl = useAttachmentUrl; exports.useAttachmentUrlSuspense = useAttachmentUrlSuspense; exports.createRoomContext = createRoomContext; exports._RoomProvider = _RoomProvider; exports._useBroadcastEvent = _useBroadcastEvent; exports._useOthersListener = _useOthersListener; exports._useRoom = _useRoom; exports._useIsInsideRoom = _useIsInsideRoom; exports._useAddReaction = _useAddReaction; exports._useMutation = _useMutation; exports._useCreateThread = _useCreateThread; exports._useDeleteThread = _useDeleteThread; exports._useEditThreadMetadata = _useEditThreadMetadata; exports._useEventListener = _useEventListener; exports._useMyPresence = _useMyPresence; exports._useOthersMapped = _useOthersMapped; exports._useOthersMappedSuspense = _useOthersMappedSuspense; exports._useThreads = _useThreads; exports._useThreadsSuspense = _useThreadsSuspense; exports._useRoomNotificationSettings = _useRoomNotificationSettings; exports._useRoomNotificationSettingsSuspense = _useRoomNotificationSettingsSuspense; exports._useHistoryVersions = _useHistoryVersions; exports._useHistoryVersionsSuspense = _useHistoryVersionsSuspense; exports._useOther = _useOther; exports._useOthers = _useOthers; exports._useOtherSuspense = _useOtherSuspense; exports._useOthersSuspense = _useOthersSuspense; exports._useStorage = _useStorage; exports._useStorageSuspense = _useStorageSuspense; exports._useSelf = _useSelf; exports._useSelfSuspense = _useSelfSuspense; exports._useStorageRoot = _useStorageRoot; exports._useUpdateMyPresence = _useUpdateMyPresence;
-//# sourceMappingURL=chunk-3MM4G6XB.js.map
+
+exports.RoomContext = RoomContext; exports.ClientContext = ClientContext; exports.getUmbrellaStoreForClient = getUmbrellaStoreForClient; exports.useClient = useClient; exports.LiveblocksProvider = LiveblocksProvider; exports.createLiveblocksContext = createLiveblocksContext; exports.useInboxNotifications = useInboxNotifications; exports.useInboxNotificationsSuspense = useInboxNotificationsSuspense; exports.useMarkAllInboxNotificationsAsRead = useMarkAllInboxNotificationsAsRead; exports.useMarkInboxNotificationAsRead = useMarkInboxNotificationAsRead; exports.useDeleteAllInboxNotifications = useDeleteAllInboxNotifications; exports.useDeleteInboxNotification = useDeleteInboxNotification; exports.useUnreadInboxNotificationsCount = useUnreadInboxNotificationsCount; exports.useUnreadInboxNotificationsCountSuspense = useUnreadInboxNotificationsCountSuspense; exports.useRoomInfo = useRoomInfo; exports.useRoomInfoSuspense = useRoomInfoSuspense; exports._useInboxNotificationThread = _useInboxNotificationThread; exports._useUser = _useUser; exports._useUserSuspense = _useUserSuspense; exports._useUserThreads_experimental = _useUserThreads_experimental; exports._useUserThreadsSuspense_experimental = _useUserThreadsSuspense_experimental; exports.useSyncStatus = useSyncStatus; exports.CreateThreadError = CreateThreadError; exports.useStatus = useStatus; exports.useStorageStatus = useStorageStatus; exports.useBatch = useBatch; exports.useLostConnectionListener = useLostConnectionListener; exports.useErrorListener = useErrorListener; exports.useHistory = useHistory; exports.useUndo = useUndo; exports.useRedo = useRedo; exports.useCanUndo = useCanUndo; exports.useCanRedo = useCanRedo; exports.useOthersConnectionIds = useOthersConnectionIds; exports.useCommentsErrorListener = useCommentsErrorListener; exports.useCreateComment = useCreateComment; exports.useEditComment = useEditComment; exports.useDeleteComment = useDeleteComment; exports.useRemoveReaction = useRemoveReaction; exports.useMarkThreadAsRead = useMarkThreadAsRead; exports.useMarkThreadAsResolved = useMarkThreadAsResolved; exports.useMarkThreadAsUnresolved = useMarkThreadAsUnresolved; exports.useThreadSubscription = useThreadSubscription; exports.useHistoryVersionData = useHistoryVersionData; exports.useUpdateRoomNotificationSettings = useUpdateRoomNotificationSettings; exports.useOthersConnectionIdsSuspense = useOthersConnectionIdsSuspense; exports.useStorageStatusSuspense = useStorageStatusSuspense; exports.useAttachmentUrl = useAttachmentUrl; exports.useAttachmentUrlSuspense = useAttachmentUrlSuspense; exports.createRoomContext = createRoomContext; exports._RoomProvider = _RoomProvider; exports._useBroadcastEvent = _useBroadcastEvent; exports._useOthersListener = _useOthersListener; exports._useRoom = _useRoom; exports._useIsInsideRoom = _useIsInsideRoom; exports._useAddReaction = _useAddReaction; exports._useMutation = _useMutation; exports._useCreateThread = _useCreateThread; exports._useDeleteThread = _useDeleteThread; exports._useEditThreadMetadata = _useEditThreadMetadata; exports._useEventListener = _useEventListener; exports._useMyPresence = _useMyPresence; exports._useOthersMapped = _useOthersMapped; exports._useOthersMappedSuspense = _useOthersMappedSuspense; exports._useThreads = _useThreads; exports._useThreadsSuspense = _useThreadsSuspense; exports._useRoomNotificationSettings = _useRoomNotificationSettings; exports._useRoomNotificationSettingsSuspense = _useRoomNotificationSettingsSuspense; exports._useHistoryVersions = _useHistoryVersions; exports._useHistoryVersionsSuspense = _useHistoryVersionsSuspense; exports._useOther = _useOther; exports._useOthers = _useOthers; exports._useOtherSuspense = _useOtherSuspense; exports._useOthersSuspense = _useOthersSuspense; exports._useStorage = _useStorage; exports._useStorageSuspense = _useStorageSuspense; exports._useSelf = _useSelf; exports._useSelfSuspense = _useSelfSuspense; exports._useStorageRoot = _useStorageRoot; exports._useUpdateMyPresence = _useUpdateMyPresence;
+//# sourceMappingURL=chunk-IACZPXTY.js.map