@liveblocks/core 3.22.0-rc1 → 3.22.0

package/dist/index.d.cts

@@ -895,7 +895,6 @@ interface ReadonlyUnacknowledgedOps {
  * to live nodes before and after they are inter-connected.
  */
 interface ManagedPool {
-    readonly roomId: string;
     readonly nodes: ReadonlyMap<string, LiveNode>;
     readonly generateId: () => string;
     readonly generateOpId: () => string;
@@ -952,10 +951,9 @@ type CreateManagedPoolOptions = {
 /**
  * @private Private API, never use this API directly.
  */
-declare function createManagedPool(roomId: string, options: CreateManagedPoolOptions): ManagedPool;
+declare function createManagedPool(options: CreateManagedPoolOptions): ManagedPool;
 declare abstract class AbstractCrdt {
     #private;
-    get roomId(): string | null;
     /**
      * @private
      * Returns true if the cached JSON snapshot exists and is reference-equal
@@ -1856,13 +1854,21 @@ interface RoomHttpApi<TM extends BaseMetadata, CM extends BaseMetadata> {
         roomId: string;
         mentionId: string;
     }): Promise<void>;
-    getYjsHistoryVersion({ roomId, versionId, }: {
+    fetchStorageHistoryVersion({ roomId, versionId, }: {
+        roomId: string;
+        versionId: string;
+    }): Promise<Response>;
+    fetchYjsHistoryVersion({ roomId, versionId, }: {
         roomId: string;
         versionId: string;
     }): Promise<Response>;
     createVersionHistorySnapshot({ roomId }: {
         roomId: string;
     }): Promise<void>;
+    deleteHistoryVersion({ roomId, versionId, }: {
+        roomId: string;
+        versionId: string;
+    }): Promise<void>;
     reportTextEditor({ roomId, type, rootKey, }: {
         roomId: string;
         type: TextEditorType;
@@ -4149,8 +4155,12 @@ type PrivateRoomApi = {
         versions: HistoryVersion[];
         requestedAt: Date;
     }>;
-    getYjsHistoryVersion(versionId: string): Promise<Response>;
+    fetchStorageHistoryVersion(versionId: string): Promise<Response>;
+    fetchYjsHistoryVersion(versionId: string): Promise<Response>;
+    liveObjectFromNodeStream(nodes: NodeStream): LiveObject<LsonObject>;
+    reconcileStorageWithNodes(nodes: NodeStream): void;
     createVersionHistorySnapshot(): Promise<void>;
+    deleteHistoryVersion(versionId: string): Promise<void>;
     executeContextualPrompt(options: {
         prompt: string;
         context: ContextualPromptContext;

package/dist/index.d.ts

@@ -895,7 +895,6 @@ interface ReadonlyUnacknowledgedOps {
  * to live nodes before and after they are inter-connected.
  */
 interface ManagedPool {
-    readonly roomId: string;
     readonly nodes: ReadonlyMap<string, LiveNode>;
     readonly generateId: () => string;
     readonly generateOpId: () => string;
@@ -952,10 +951,9 @@ type CreateManagedPoolOptions = {
 /**
  * @private Private API, never use this API directly.
  */
-declare function createManagedPool(roomId: string, options: CreateManagedPoolOptions): ManagedPool;
+declare function createManagedPool(options: CreateManagedPoolOptions): ManagedPool;
 declare abstract class AbstractCrdt {
     #private;
-    get roomId(): string | null;
     /**
      * @private
      * Returns true if the cached JSON snapshot exists and is reference-equal
@@ -1856,13 +1854,21 @@ interface RoomHttpApi<TM extends BaseMetadata, CM extends BaseMetadata> {
         roomId: string;
         mentionId: string;
     }): Promise<void>;
-    getYjsHistoryVersion({ roomId, versionId, }: {
+    fetchStorageHistoryVersion({ roomId, versionId, }: {
+        roomId: string;
+        versionId: string;
+    }): Promise<Response>;
+    fetchYjsHistoryVersion({ roomId, versionId, }: {
         roomId: string;
         versionId: string;
     }): Promise<Response>;
     createVersionHistorySnapshot({ roomId }: {
         roomId: string;
     }): Promise<void>;
+    deleteHistoryVersion({ roomId, versionId, }: {
+        roomId: string;
+        versionId: string;
+    }): Promise<void>;
     reportTextEditor({ roomId, type, rootKey, }: {
         roomId: string;
         type: TextEditorType;
@@ -4149,8 +4155,12 @@ type PrivateRoomApi = {
         versions: HistoryVersion[];
         requestedAt: Date;
     }>;
-    getYjsHistoryVersion(versionId: string): Promise<Response>;
+    fetchStorageHistoryVersion(versionId: string): Promise<Response>;
+    fetchYjsHistoryVersion(versionId: string): Promise<Response>;
+    liveObjectFromNodeStream(nodes: NodeStream): LiveObject<LsonObject>;
+    reconcileStorageWithNodes(nodes: NodeStream): void;
     createVersionHistorySnapshot(): Promise<void>;
+    deleteHistoryVersion(versionId: string): Promise<void>;
     executeContextualPrompt(options: {
         prompt: string;
         context: ContextualPromptContext;

package/dist/index.js

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "3.22.0-rc1";
+var PKG_VERSION = "3.22.0";
 var PKG_FORMAT = "esm";
 
 // src/dupe-detection.ts
@@ -1930,7 +1930,7 @@ function createApiClient({
     if (attachment.size <= ATTACHMENT_PART_SIZE) {
       return autoRetry(
         async () => httpClient.putBlob(
-          url`/v2/c/rooms/${roomId}/attachments/${attachment.id}/upload/${encodeURIComponent(attachment.name)}`,
+          url`/v2/c/rooms/${roomId}/attachments/${attachment.id}/upload/${attachment.name}`,
           await authManager.getAuthValue({
             roomId,
             resource: "comments",
@@ -1949,7 +1949,7 @@ function createApiClient({
       const uploadedParts = [];
       const createMultiPartUpload = await autoRetry(
         async () => httpClient.post(
-          url`/v2/c/rooms/${roomId}/attachments/${attachment.id}/multipart/${encodeURIComponent(attachment.name)}`,
+          url`/v2/c/rooms/${roomId}/attachments/${attachment.id}/multipart/${attachment.name}`,
           await authManager.getAuthValue({
             roomId,
             resource: "comments",
@@ -2132,7 +2132,17 @@ function createApiClient({
       })
     );
   }
-  async function getYjsHistoryVersion(options) {
+  async function fetchStorageHistoryVersion(options) {
+    return httpClient.rawGet(
+      url`/v2/c/rooms/${options.roomId}/versions/${options.versionId}/storage`,
+      await authManager.getAuthValue({
+        roomId: options.roomId,
+        resource: "storage",
+        access: "read"
+      })
+    );
+  }
+  async function fetchYjsHistoryVersion(options) {
     return httpClient.rawGet(
       url`/v2/c/rooms/${options.roomId}/versions/${options.versionId}/yjs`,
       await authManager.getAuthValue({
@@ -2152,6 +2162,16 @@ function createApiClient({
       })
     );
   }
+  async function deleteHistoryVersion(options) {
+    await httpClient.delete(
+      url`/v2/c/rooms/${options.roomId}/versions/${options.versionId}`,
+      await authManager.getAuthValue({
+        roomId: options.roomId,
+        resource: "storage",
+        access: "write"
+      })
+    );
+  }
   async function reportTextEditor(options) {
     await httpClient.rawPost(
       url`/v2/c/rooms/${options.roomId}/text-metadata`,
@@ -2475,8 +2495,10 @@ function createApiClient({
     // Room text editor
     createTextMention,
     deleteTextMention,
-    getYjsHistoryVersion,
+    fetchStorageHistoryVersion,
+    fetchYjsHistoryVersion,
     createVersionHistorySnapshot,
+    deleteHistoryVersion,
     reportTextEditor,
     listHistoryVersions,
     listHistoryVersionsSince,
@@ -6180,7 +6202,7 @@ ${parentKey}`;
 };
 
 // src/crdts/AbstractCrdt.ts
-function createManagedPool(roomId, options) {
+function createManagedPool(options) {
   const {
     getCurrentConnectionId,
     onDispatch,
@@ -6191,7 +6213,6 @@ function createManagedPool(roomId, options) {
   let opClock = 0;
   const nodes = /* @__PURE__ */ new Map();
   return {
-    roomId,
     nodes,
     getNode: (id) => nodes.get(id),
     addNode: (id, node) => void nodes.set(id, node),
@@ -6256,9 +6277,6 @@ var AbstractCrdt = class {
   get _pool() {
     return this.#pool;
   }
-  get roomId() {
-    return this.#pool ? this.#pool.roomId : null;
-  }
   /** @internal */
   get _id() {
     return this.#id;
@@ -8785,6 +8803,16 @@ function isSameNodeOrChildOf(node, parent) {
   }
   return false;
 }
+function liveObjectFromNodeStream(nodes) {
+  const pool = createManagedPool({
+    getCurrentConnectionId: () => {
+      throw new Error(
+        "Cannot mutate a historic storage version: it is a read-only snapshot"
+      );
+    }
+  });
+  return LiveObject._fromItems(nodes, pool);
+}
 function deserialize(node, parentToChildren, pool) {
   if (isObjectStorageNode(node)) {
     return LiveObject._deserialize(node, parentToChildren, pool);
@@ -8909,6 +8937,61 @@ function diffNodeMap(prev, next) {
       ops.push({ type: OpCode.DELETE_CRDT, id });
     }
   });
+  const emitted = /* @__PURE__ */ new Set();
+  function emitCreate(id, crdt) {
+    if (emitted.has(id)) {
+      return;
+    }
+    emitted.add(id);
+    const parentId = crdt.parentId;
+    if (parentId !== void 0 && !prev.has(parentId)) {
+      const parentCrdt = next.get(parentId);
+      if (parentCrdt !== void 0) {
+        emitCreate(parentId, parentCrdt);
+      }
+    }
+    switch (crdt.type) {
+      case CrdtType.REGISTER:
+        ops.push({
+          type: OpCode.CREATE_REGISTER,
+          id,
+          parentId: crdt.parentId,
+          parentKey: crdt.parentKey,
+          data: crdt.data
+        });
+        break;
+      case CrdtType.LIST:
+        ops.push({
+          type: OpCode.CREATE_LIST,
+          id,
+          parentId: crdt.parentId,
+          parentKey: crdt.parentKey
+        });
+        break;
+      case CrdtType.OBJECT:
+        if (crdt.parentId === void 0 || crdt.parentKey === void 0) {
+          throw new Error(
+            "Internal error. Cannot serialize storage root into an operation"
+          );
+        }
+        ops.push({
+          type: OpCode.CREATE_OBJECT,
+          id,
+          parentId: crdt.parentId,
+          parentKey: crdt.parentKey,
+          data: crdt.data
+        });
+        break;
+      case CrdtType.MAP:
+        ops.push({
+          type: OpCode.CREATE_MAP,
+          id,
+          parentId: crdt.parentId,
+          parentKey: crdt.parentKey
+        });
+        break;
+    }
+  }
   next.forEach((crdt, id) => {
     const currentCrdt = prev.get(id);
     if (currentCrdt) {
@@ -8945,47 +9028,7 @@ function diffNodeMap(prev, next) {
         });
       }
     } else {
-      switch (crdt.type) {
-        case CrdtType.REGISTER:
-          ops.push({
-            type: OpCode.CREATE_REGISTER,
-            id,
-            parentId: crdt.parentId,
-            parentKey: crdt.parentKey,
-            data: crdt.data
-          });
-          break;
-        case CrdtType.LIST:
-          ops.push({
-            type: OpCode.CREATE_LIST,
-            id,
-            parentId: crdt.parentId,
-            parentKey: crdt.parentKey
-          });
-          break;
-        case CrdtType.OBJECT:
-          if (crdt.parentId === void 0 || crdt.parentKey === void 0) {
-            throw new Error(
-              "Internal error. Cannot serialize storage root into an operation"
-            );
-          }
-          ops.push({
-            type: OpCode.CREATE_OBJECT,
-            id,
-            parentId: crdt.parentId,
-            parentKey: crdt.parentKey,
-            data: crdt.data
-          });
-          break;
-        case CrdtType.MAP:
-          ops.push({
-            type: OpCode.CREATE_MAP,
-            id,
-            parentId: crdt.parentId,
-            parentKey: crdt.parentKey
-          });
-          break;
-      }
+      emitCreate(id, crdt);
     }
   });
   return ops;
@@ -9973,7 +10016,7 @@ function createRoom(options, config) {
     yjsProvider: void 0,
     yjsProviderDidChange: makeEventSource(),
     // Storage
-    pool: createManagedPool(roomId, {
+    pool: createManagedPool({
       getCurrentConnectionId,
       onDispatch,
       isStorageWritable,
@@ -10136,12 +10179,18 @@ function createRoom(options, config) {
       signal: options2.signal
     });
   }
-  async function getYjsHistoryVersion(versionId) {
-    return httpClient.getYjsHistoryVersion({ roomId, versionId });
+  async function fetchStorageHistoryVersion(versionId) {
+    return httpClient.fetchStorageHistoryVersion({ roomId, versionId });
+  }
+  async function fetchYjsHistoryVersion(versionId) {
+    return httpClient.fetchYjsHistoryVersion({ roomId, versionId });
   }
   async function createVersionHistorySnapshot() {
     return httpClient.createVersionHistorySnapshot({ roomId });
   }
+  async function deleteHistoryVersion(versionId) {
+    return httpClient.deleteHistoryVersion({ roomId, versionId });
+  }
   async function executeContextualPrompt(options2) {
     return httpClient.executeContextualPrompt({
       roomId,
@@ -10191,17 +10240,19 @@ function createRoom(options, config) {
     self,
     (me) => me !== null ? userToTreeNode("Me", me) : null
   );
+  function diffCurrentStorageAgainst(target) {
+    const current = /* @__PURE__ */ new Map();
+    for (const [id, crdt] of context.pool.nodes) {
+      current.set(id, crdt._serialize());
+    }
+    return diffNodeMap(current, target);
+  }
   function createOrUpdateRootFromMessage(nodes) {
     if (nodes.size === 0) {
       throw new Error("Internal error: cannot load storage without items");
     }
     if (context.root !== void 0) {
-      const currentItems = /* @__PURE__ */ new Map();
-      for (const [id, crdt] of context.pool.nodes) {
-        currentItems.set(id, crdt._serialize());
-      }
-      const ops = diffNodeMap(currentItems, nodes);
-      const result = applyRemoteOps(ops);
+      const result = applyRemoteOps(diffCurrentStorageAgainst(nodes));
       notify(result.updates);
     } else {
       context.root = LiveObject._fromItems(
@@ -10226,6 +10277,28 @@ function createRoom(options, config) {
       }
     });
   }
+  function reconcileStorageWithNodes(nodes) {
+    if (context.root === void 0) {
+      throw new Error("Cannot reconcile storage before it is loaded");
+    }
+    const ops = diffCurrentStorageAgainst(
+      new Map(nodes)
+    );
+    if (ops.length === 0) {
+      return;
+    }
+    const result = applyLocalOps(ops);
+    if (result.reverse.length > 0) {
+      addToUndoStack(result.reverse);
+    }
+    context.redoStack.length = 0;
+    for (const op of result.opsToEmit) {
+      context.buffer.storageOperations.push(op);
+    }
+    notify(result.updates);
+    onHistoryChange();
+    flushNowOrSoon();
+  }
   function _addToRealUndoStack(frames) {
     if (context.undoStack.length >= 50) {
       context.undoStack.shift();
@@ -10395,6 +10468,10 @@ function createRoom(options, config) {
         }
         return parentNode._attachChild(op, source);
       }
+      // Unknown op codes can be received when older and newer clients are
+      // both present in a same room. Older clients simply ignore them.
+      default:
+        return { modified: false };
     }
   }
   function updatePresence(patch, options2) {
@@ -11546,9 +11623,16 @@ function createRoom(options, config) {
         // List versions of the document since the specified date
         listHistoryVersionsSince,
         // get a specific version
-        getYjsHistoryVersion,
+        fetchStorageHistoryVersion,
+        fetchYjsHistoryVersion,
+        // reconstruct a storage version's nodes into a read-only LiveObject tree
+        liveObjectFromNodeStream,
+        // restore live storage to match a version's nodes
+        reconcileStorageWithNodes,
         // create a version
         createVersionHistorySnapshot,
+        // delete a version
+        deleteHistoryVersion,
         // execute a contextual prompt
         executeContextualPrompt,
         // Support for the Liveblocks browser extension