@liveblocks/core 0.19.3-beta2 → 0.19.3-beta4

package/dist/index.d.ts

@@ -659,6 +659,7 @@ declare type Connection = {
     state: "failed";
 };
 declare type ConnectionState = Connection["state"];
+declare type StorageStatus = "not-loaded" | "loading" | "synchronizing" | "synchronized";
 interface History {
     /**
      * Undoes the last operation executed by the current client.
@@ -736,9 +737,6 @@ declare type HistoryEvent = {
     canUndo: boolean;
     canRedo: boolean;
 };
-declare type PendingHasModificationsEvent = {
-    hasPendingStorageModifications: boolean;
-};
 declare type BroadcastOptions = {
     /**
      * Whether or not event is queued if the connection is currently closed.
@@ -858,16 +856,18 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          */
         (type: "history", listener: Callback<HistoryEvent>): () => void;
         /**
-         * Subscribe to pending storage modifications updates.
+         * Subscribe to storage status changes.
          *
          * @returns Unsubscribe function.
          *
          * @example
-         * room.subscribe("pending-storage-modifications", ({ hasPendingStorageModifications }) => {
-         *   // Do something
+         * room.subscribe("storage-status", (status) => {
+         *   switch(status) {
+         *      case
+         *   }
          * });
          */
-        (type: "pending-storage-modifications", listener: Callback<PendingHasModificationsEvent>): () => void;
+        (type: "storage-status", listener: Callback<StorageStatus>): () => void;
     };
     /**
      * Room's history contains functions that let you undo and redo operation made on by the current client on the presence and storage.
@@ -982,9 +982,9 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      */
     batch<T>(fn: () => T): T;
     /**
-     * Whether or not the room has storage modifications that have not been acknowledged by the server.
+     * Get the storage status.
      */
-    hasPendingStorageModifications(): boolean;
+    getStorageStatus(): StorageStatus;
     /**
      * Close room connection and try to reconnect
      */

package/dist/index.js

@@ -2659,7 +2659,7 @@ var WebsocketCloseCodes = /* @__PURE__ */ ((WebsocketCloseCodes2) => {
 
 // src/room.ts
 function isRoomEventName(value) {
-  return value === "my-presence" || value === "others" || value === "event" || value === "error" || value === "connection" || value === "history";
+  return value === "my-presence" || value === "others" || value === "event" || value === "error" || value === "connection" || value === "history" || value === "pending-storage-modifications";
 }
 var BACKOFF_RETRY_DELAYS = [250, 500, 1e3, 2e3, 4e3, 8e3, 1e4];
 var BACKOFF_RETRY_DELAYS_SLOW = [2e3, 3e4, 6e4, 3e5];
@@ -2726,7 +2726,7 @@ function makeStateMachine(state, config, mockedEffects) {
     storage: makeEventSource(),
     history: makeEventSource(),
     storageDidLoad: makeEventSource(),
-    pendingStorageModifications: makeEventSource()
+    storageStatus: makeEventSource()
   };
   const effects = mockedEffects || {
     authenticate(auth, createWebSocket) {
@@ -2894,7 +2894,6 @@ function makeStateMachine(state, config, mockedEffects) {
         return op;
       }
     });
-    const hasPendingStorageModifs = hasPendingStorageModifications();
     for (const op of ops) {
       if (op.type === "presence") {
         const reverse = {
@@ -2946,11 +2945,7 @@ function makeStateMachine(state, config, mockedEffects) {
         }
       }
     }
-    if (hasPendingStorageModifs && hasPendingStorageModifications() === false) {
-      eventHub.pendingStorageModifications.notify({
-        hasPendingStorageModifications: false
-      });
-    }
+    notifyStorageStatus();
     return {
       ops,
       reverse: output.reverse,
@@ -3046,8 +3041,8 @@ function makeStateMachine(state, config, mockedEffects) {
           );
         case "history":
           return eventHub.history.subscribe(callback);
-        case "pending-storage-modifications":
-          return eventHub.pendingStorageModifications.subscribe(
+        case "storage-status":
+          return eventHub.storageStatus.subscribe(
             callback
           );
         default:
@@ -3308,6 +3303,7 @@ function makeStateMachine(state, config, mockedEffects) {
             if (_getInitialStateResolver !== null) {
               _getInitialStateResolver();
             }
+            notifyStorageStatus();
             eventHub.storageDidLoad.notify();
             break;
           }
@@ -3455,15 +3451,10 @@ function makeStateMachine(state, config, mockedEffects) {
   function tryFlushing() {
     const storageOps = state.buffer.storageOperations;
     if (storageOps.length > 0) {
-      const hasAlreadyPendingModifications = hasPendingStorageModifications();
       storageOps.forEach((op) => {
         state.offlineOperations.set(nn(op.opId), op);
       });
-      if (!hasAlreadyPendingModifications) {
-        eventHub.pendingStorageModifications.notify({
-          hasPendingStorageModifications: true
-        });
-      }
+      notifyStorageStatus();
     }
     if (state.socket === null || state.socket.readyState !== state.socket.OPEN) {
       state.buffer.storageOperations = [];
@@ -3570,6 +3561,7 @@ function makeStateMachine(state, config, mockedEffects) {
       _getInitialStatePromise = new Promise(
         (resolve) => _getInitialStateResolver = resolve
       );
+      notifyStorageStatus();
     }
     return _getInitialStatePromise;
   }
@@ -3690,9 +3682,6 @@ function makeStateMachine(state, config, mockedEffects) {
       _addToRealUndoStack(historyOps, batchUpdates);
     }
   }
-  function hasPendingStorageModifications() {
-    return state.offlineOperations.size > 0;
-  }
   function simulateSocketClose() {
     if (state.socket) {
       state.socket = null;
@@ -3701,6 +3690,23 @@ function makeStateMachine(state, config, mockedEffects) {
   function simulateSendCloseEvent(event) {
     onClose(event);
   }
+  function getStorageStatus() {
+    if (state.root !== void 0) {
+      return state.offlineOperations.size === 0 ? "synchronized" : "synchronizing";
+    }
+    if (_getInitialStatePromise !== null) {
+      return "loading";
+    }
+    return "not-loaded";
+  }
+  let _lastStorageStatus = getStorageStatus();
+  function notifyStorageStatus() {
+    const storageStatus = getStorageStatus();
+    if (_lastStorageStatus !== storageStatus) {
+      _lastStorageStatus = storageStatus;
+      eventHub.storageStatus.notify(storageStatus);
+    }
+  }
   return {
     onClose,
     onMessage,
@@ -3725,9 +3731,9 @@ function makeStateMachine(state, config, mockedEffects) {
     canRedo,
     pauseHistory,
     resumeHistory,
-    hasPendingStorageModifications,
     getStorage,
     getStorageSnapshot,
+    getStorageStatus,
     events: {
       customEvent: eventHub.customEvent.observable,
       others: eventHub.others.observable,
@@ -3737,7 +3743,7 @@ function makeStateMachine(state, config, mockedEffects) {
       storage: eventHub.storage.observable,
       history: eventHub.history.observable,
       storageDidLoad: eventHub.storageDidLoad.observable,
-      pendingStorageModifications: eventHub.pendingStorageModifications
+      storageStatus: eventHub.storageStatus.observable
     },
     getConnectionState,
     isSelfAware: () => isConnectionSelfAware(state.connection.current),
@@ -3810,6 +3816,7 @@ function createRoom(options, config) {
     broadcastEvent: machine.broadcastEvent,
     getStorage: machine.getStorage,
     getStorageSnapshot: machine.getStorageSnapshot,
+    getStorageStatus: machine.getStorageStatus,
     events: machine.events,
     batch: machine.batch,
     history: {
@@ -3820,7 +3827,6 @@ function createRoom(options, config) {
       pause: machine.pauseHistory,
       resume: machine.resumeHistory
     },
-    hasPendingStorageModifications: machine.hasPendingStorageModifications,
     __INTERNAL_DO_NOT_USE: {
       simulateCloseWebsocket: machine.simulateSocketClose,
       simulateSendCloseEvent: machine.simulateSendCloseEvent
@@ -3849,7 +3855,7 @@ function prepareCreateWebSocket(liveblocksServer, WebSocketPolyfill) {
   const ws = WebSocketPolyfill || WebSocket;
   return (token) => {
     return new ws(
-      `${liveblocksServer}/?token=${token}&version=${true ? "0.19.3-beta2" : "dev"}`
+      `${liveblocksServer}/?token=${token}&version=${true ? "0.19.3-beta4" : "dev"}`
     );
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/core",
-  "version": "0.19.3-beta2",
+  "version": "0.19.3-beta4",
   "description": "Shared code and foundational internals for Liveblocks",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",