@liveblocks/core 2.11.1 → 2.12.0-rc1

package/dist/index.mjs

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "2.11.1";
+var PKG_VERSION = "2.12.0-rc1";
 var PKG_FORMAT = "esm";
 
 // src/dupe-detection.ts
@@ -2444,6 +2444,84 @@ function createNotificationsApi({
   };
 }
 
+// src/lib/freeze.ts
+var freeze = process.env.NODE_ENV === "production" ? (
+  /* istanbul ignore next */
+  (x) => x
+) : Object.freeze;
+
+// src/refs/ImmutableRef.ts
+function merge(target, patch) {
+  let updated = false;
+  const newValue = { ...target };
+  Object.keys(patch).forEach((k) => {
+    const key = k;
+    const val = patch[key];
+    if (newValue[key] !== val) {
+      if (val === void 0) {
+        delete newValue[key];
+      } else {
+        newValue[key] = val;
+      }
+      updated = true;
+    }
+  });
+  return updated ? newValue : target;
+}
+var ImmutableRef = class {
+  constructor() {
+    this._ev = makeEventSource();
+  }
+  get didInvalidate() {
+    return this._ev.observable;
+  }
+  invalidate() {
+    if (this._cache !== null) {
+      this._cache = null;
+      this._ev.notify();
+    }
+  }
+  get current() {
+    return this._cache ?? (this._cache = this._toImmutable());
+  }
+};
+
+// src/refs/ValueRef.ts
+var ValueRef = class extends ImmutableRef {
+  constructor(initialValue) {
+    super();
+    this._value = freeze(initialValue);
+  }
+  /** @internal */
+  _toImmutable() {
+    return this._value;
+  }
+  set(newValue) {
+    if (this._value !== newValue) {
+      this._value = freeze(newValue);
+      this.invalidate();
+    }
+  }
+};
+var DerivedRef = class extends ImmutableRef {
+  constructor(...args) {
+    super();
+    const transformFn = args.pop();
+    const otherRefs = args;
+    this._refs = otherRefs;
+    this._refs.forEach((ref) => {
+      ref.didInvalidate.subscribe(() => this.invalidate());
+    });
+    this._transform = transformFn;
+  }
+  /** @internal */
+  _toImmutable() {
+    return this._transform(
+      ...this._refs.map((ref) => ref.current)
+    );
+  }
+};
+
 // src/lib/position.ts
 var MIN_CODE = 32;
 var MAX_CODE = 126;
@@ -3878,12 +3956,6 @@ function HACK_addIntentAndDeletedIdToOperation(ops, deletedId) {
   });
 }
 
-// src/lib/freeze.ts
-var freeze = process.env.NODE_ENV === "production" ? (
-  /* istanbul ignore next */
-  (x) => x
-) : Object.freeze;
-
 // src/crdts/LiveMap.ts
 var LiveMap = class _LiveMap extends AbstractCrdt {
   constructor(entries2) {
@@ -5172,42 +5244,6 @@ var ClientMsgCode = /* @__PURE__ */ ((ClientMsgCode2) => {
   return ClientMsgCode2;
 })(ClientMsgCode || {});
 
-// src/refs/ImmutableRef.ts
-function merge(target, patch) {
-  let updated = false;
-  const newValue = { ...target };
-  Object.keys(patch).forEach((k) => {
-    const key = k;
-    const val = patch[key];
-    if (newValue[key] !== val) {
-      if (val === void 0) {
-        delete newValue[key];
-      } else {
-        newValue[key] = val;
-      }
-      updated = true;
-    }
-  });
-  return updated ? newValue : target;
-}
-var ImmutableRef = class {
-  constructor() {
-    this._ev = makeEventSource();
-  }
-  get didInvalidate() {
-    return this._ev.observable;
-  }
-  invalidate() {
-    if (this._cache !== void 0) {
-      this._cache = void 0;
-      this._ev.notify();
-    }
-  }
-  get current() {
-    return this._cache ?? (this._cache = this._toImmutable());
-  }
-};
-
 // src/refs/OthersRef.ts
 function makeUser(conn, presence) {
   const { connectionId, id, info } = conn;
@@ -5359,40 +5395,6 @@ var PatchableRef = class extends ImmutableRef {
   }
 };
 
-// src/refs/ValueRef.ts
-var ValueRef = class extends ImmutableRef {
-  constructor(initialValue) {
-    super();
-    this._value = freeze(initialValue);
-  }
-  /** @internal */
-  _toImmutable() {
-    return this._value;
-  }
-  set(newValue) {
-    this._value = freeze(newValue);
-    this.invalidate();
-  }
-};
-var DerivedRef = class extends ImmutableRef {
-  constructor(...args) {
-    super();
-    const transformFn = args.pop();
-    const otherRefs = args;
-    this._refs = otherRefs;
-    this._refs.forEach((ref) => {
-      ref.didInvalidate.subscribe(() => this.invalidate());
-    });
-    this._transform = transformFn;
-  }
-  /** @internal */
-  _toImmutable() {
-    return this._transform(
-      ...this._refs.map((ref) => ref.current)
-    );
-  }
-};
-
 // src/room.ts
 var MAX_SOCKET_MESSAGE_SIZE = 1024 * 1024 - 1024;
 function makeIdFactory(connectionId) {
@@ -5500,9 +5502,9 @@ function createRoom(options, config) {
     others: new OthersRef(),
     initialStorage,
     idFactory: null,
-    // Y.js
-    provider: void 0,
-    onProviderUpdate: makeEventSource(),
+    // The Yjs provider associated to this room
+    yjsProvider: void 0,
+    yjsProviderDidChange: makeEventSource(),
     // Storage
     clock: 0,
     opClock: 0,
@@ -6516,6 +6518,7 @@ ${Array.from(traces).join("\n\n")}`
       _addToRealUndoStack(historyOps, batchUpdates);
     }
   }
+  const syncSourceForStorage = config.createSyncSource();
   function getStorageStatus() {
     if (context.root === void 0) {
       return _getStorage$ === null ? "not-loaded" : "loading";
@@ -6530,6 +6533,9 @@ ${Array.from(traces).join("\n\n")}`
       _lastStorageStatus = storageStatus;
       eventHub.storageStatus.notify(storageStatus);
     }
+    syncSourceForStorage.setSyncStatus(
+      storageStatus === "synchronizing" ? "synchronizing" : "synchronized"
+    );
   }
   function isPresenceReady() {
     return self.current !== null;
@@ -6919,6 +6925,12 @@ ${Array.from(traces).join("\n\n")}`
   async function markInboxNotificationAsRead(inboxNotificationId) {
     await batchedMarkInboxNotificationsAsRead.get(inboxNotificationId);
   }
+  const syncSourceForYjs = config.createSyncSource();
+  function yjsStatusDidChange(status) {
+    return syncSourceForYjs.setSyncStatus(
+      status === "synchronizing" ? "synchronizing" : "synchronized"
+    );
+  }
   return Object.defineProperty(
     {
       [kInternal]: {
@@ -6934,14 +6946,16 @@ ${Array.from(traces).join("\n\n")}`
           return context.nodes.size;
         },
         // prettier-ignore
-        getProvider() {
-          return context.provider;
+        getYjsProvider() {
+          return context.yjsProvider;
         },
-        setProvider(provider) {
-          context.provider = provider;
-          context.onProviderUpdate.notify();
+        setYjsProvider(newProvider) {
+          context.yjsProvider?.off("status", yjsStatusDidChange);
+          context.yjsProvider = newProvider;
+          newProvider?.on("status", yjsStatusDidChange);
+          context.yjsProviderDidChange.notify();
         },
-        onProviderUpdate: context.onProviderUpdate.observable,
+        yjsProviderDidChange: context.yjsProviderDidChange.observable,
         // send metadata when using a text editor
         reportTextEditor,
         // create a text mention when using a text editor
@@ -6973,6 +6987,9 @@ ${Array.from(traces).join("\n\n")}`
       reconnect: () => managedSocket.reconnect(),
       disconnect: () => managedSocket.disconnect(),
       destroy: () => {
+        syncSourceForStorage.destroy();
+        context.yjsProvider?.off("status", yjsStatusDidChange);
+        syncSourceForYjs.destroy();
         uninstallBgTabSpy();
         managedSocket.destroy();
       },
@@ -7237,7 +7254,8 @@ function createClient(options) {
         unstable_batchedUpdates: options2?.unstable_batchedUpdates,
         baseUrl,
         unstable_fallbackToHTTP: !!clientOptions.unstable_fallbackToHTTP,
-        unstable_streamData: !!clientOptions.unstable_streamData
+        unstable_streamData: !!clientOptions.unstable_streamData,
+        createSyncSource
       }
     );
     const newRoomDetails = {
@@ -7322,6 +7340,46 @@ function createClient(options) {
   function invalidateResolvedMentionSuggestions() {
     mentionSuggestionsCache.clear();
   }
+  const syncStatusSources = [];
+  const syncStatusRef = new ValueRef("synchronized");
+  function getSyncStatus() {
+    const status = syncStatusRef.current;
+    return status === "synchronizing" ? status : "synchronized";
+  }
+  function recompute() {
+    syncStatusRef.set(
+      syncStatusSources.some((src) => src.current === "synchronizing") ? "synchronizing" : syncStatusSources.some((src) => src.current === "has-local-changes") ? "has-local-changes" : "synchronized"
+    );
+  }
+  function createSyncSource() {
+    const source = new ValueRef("synchronized");
+    syncStatusSources.push(source);
+    const unsub = source.didInvalidate.subscribe(() => recompute());
+    function setSyncStatus(status) {
+      source.set(status);
+    }
+    function destroy() {
+      unsub();
+      const index = syncStatusSources.findIndex((item) => item === source);
+      if (index > -1) {
+        const [ref] = syncStatusSources.splice(index, 1);
+        const wasStillPending = ref.current !== "synchronized";
+        if (wasStillPending) {
+          recompute();
+        }
+      }
+    }
+    return { setSyncStatus, destroy };
+  }
+  {
+    const maybePreventClose = (e) => {
+      if (clientOptions.preventUnsavedChanges && syncStatusRef.current !== "synchronized") {
+        e.preventDefault();
+      }
+    };
+    const win = typeof window !== "undefined" ? window : void 0;
+    win?.addEventListener("beforeunload", maybePreventClose);
+  }
   const client = Object.defineProperty(
     {
       enterRoom,
@@ -7334,6 +7392,10 @@ function createClient(options) {
         invalidateRoomsInfo: invalidateResolvedRoomsInfo,
         invalidateMentionSuggestions: invalidateResolvedMentionSuggestions
       },
+      getSyncStatus,
+      events: {
+        syncStatus: syncStatusRef.didInvalidate
+      },
       // Internal
       [kInternal]: {
         currentUserIdStore,
@@ -7348,7 +7410,8 @@ function createClient(options) {
         getUserThreads_experimental: notificationsAPI.getUserThreads_experimental,
         getUserThreadsSince_experimental: notificationsAPI.getUserThreadsSince_experimental,
         // Type-level helper only, it's effectively only an identity-function at runtime
-        as: () => client
+        as: () => client,
+        createSyncSource
       }
     },
     kInternal,