@liveblocks/core 3.13.0-vincent1 → 3.13.0-vincent3

package/dist/index.d.cts

@@ -342,7 +342,6 @@ declare const OpCode: Readonly<{
     DELETE_OBJECT_KEY: 6;
     CREATE_MAP: 7;
     CREATE_REGISTER: 8;
-    ACK: 9;
 }>;
 declare namespace OpCode {
     type INIT = typeof OpCode.INIT;
@@ -354,7 +353,6 @@ declare namespace OpCode {
     type DELETE_OBJECT_KEY = typeof OpCode.DELETE_OBJECT_KEY;
     type CREATE_MAP = typeof OpCode.CREATE_MAP;
     type CREATE_REGISTER = typeof OpCode.CREATE_REGISTER;
-    type ACK = typeof OpCode.ACK;
 }
 /**
  * These operations are the payload for {@link UpdateStorageServerMsg} messages
@@ -623,11 +621,7 @@ type SerializedRegister = {
 };
 type CompactNode = CompactRootNode | CompactChildNode;
 type CompactChildNode = CompactObjectNode | CompactListNode | CompactMapNode | CompactRegisterNode;
-type CompactRootNode = readonly [
-    id: "root",
-    type: CrdtType.OBJECT,
-    data: JsonObject
-];
+type CompactRootNode = readonly [id: "root", data: JsonObject];
 type CompactObjectNode = readonly [
     id: string,
     type: CrdtType.OBJECT,
@@ -2529,6 +2523,7 @@ declare const ServerMsgCode: Readonly<{
     ROOM_STATE: 104;
     STORAGE_STATE_V7: 200;
     STORAGE_CHUNK: 210;
+    STORAGE_STREAM_END: 211;
     UPDATE_STORAGE: 201;
     UPDATE_YDOC: 300;
     THREAD_CREATED: 400;
@@ -2550,6 +2545,7 @@ declare namespace ServerMsgCode {
     type ROOM_STATE = typeof ServerMsgCode.ROOM_STATE;
     type STORAGE_STATE_V7 = typeof ServerMsgCode.STORAGE_STATE_V7;
     type STORAGE_CHUNK = typeof ServerMsgCode.STORAGE_CHUNK;
+    type STORAGE_STREAM_END = typeof ServerMsgCode.STORAGE_STREAM_END;
     type UPDATE_STORAGE = typeof ServerMsgCode.UPDATE_STORAGE;
     type UPDATE_YDOC = typeof ServerMsgCode.UPDATE_YDOC;
     type THREAD_CREATED = typeof ServerMsgCode.THREAD_CREATED;
@@ -2566,7 +2562,7 @@ declare namespace ServerMsgCode {
 /**
  * Messages that can be sent from the server to the client.
  */
-type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | StorageStateServerMsg_V7 | StorageChunkServerMsg | UpdateStorageServerMsg | YDocUpdateServerMsg | RejectedStorageOpServerMsg | CommentsEventServerMsg;
+type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | StorageStateServerMsg_V7 | StorageChunkServerMsg | StorageEndServerMsg | UpdateStorageServerMsg | YDocUpdateServerMsg | RejectedStorageOpServerMsg | CommentsEventServerMsg;
 type CommentsEventServerMsg = ThreadCreatedEvent | ThreadDeletedEvent | ThreadMetadataUpdatedEvent | ThreadUpdatedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved;
 type ThreadCreatedEvent = {
     type: ServerMsgCode.THREAD_CREATED;
@@ -2753,24 +2749,24 @@ type StorageStateServerMsg_V7 = {
 };
 /**
  * Sent by the WebSocket server to a single client in response to the client
- * sending a FetchStorageClientMsg message, to provide the initial Storage
- * state of the Room.
+ * sending a FetchStorageClientMsg message, to provide one chunk of the initial
+ * Storage state of the Room.
  *
- * The server will respond with 0+ STORAGE_CHUNK messages with
- * done=false, followed by exactly one STORAGE_CHUNK message with
- * done=true.
+ * The server will respond with 1+ STORAGE_CHUNK messages, followed by exactly
+ * one STORAGE_STREAM_END message to mark the end of the transmission.
  *
  * If the room is using the new storage engine that supports streaming, then
- * potentially multiple chunks might get sent.
- *
- * If the room is using the old storage engine, then all nodes will be sent in
- * a single/large chunk (non-streaming).
+ * potentially multiple chunks might get sent. If the room is using the old
+ * storage engine, then all nodes will be sent in a single/large chunk
+ * (non-streaming).
  */
 type StorageChunkServerMsg = {
     readonly type: ServerMsgCode.STORAGE_CHUNK;
-    readonly done: boolean;
     readonly nodes: CompactNode[];
 };
+type StorageEndServerMsg = {
+    readonly type: ServerMsgCode.STORAGE_STREAM_END;
+};
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
  * a change occurred in the Storage document.

package/dist/index.d.ts

@@ -342,7 +342,6 @@ declare const OpCode: Readonly<{
     DELETE_OBJECT_KEY: 6;
     CREATE_MAP: 7;
     CREATE_REGISTER: 8;
-    ACK: 9;
 }>;
 declare namespace OpCode {
     type INIT = typeof OpCode.INIT;
@@ -354,7 +353,6 @@ declare namespace OpCode {
     type DELETE_OBJECT_KEY = typeof OpCode.DELETE_OBJECT_KEY;
     type CREATE_MAP = typeof OpCode.CREATE_MAP;
     type CREATE_REGISTER = typeof OpCode.CREATE_REGISTER;
-    type ACK = typeof OpCode.ACK;
 }
 /**
  * These operations are the payload for {@link UpdateStorageServerMsg} messages
@@ -623,11 +621,7 @@ type SerializedRegister = {
 };
 type CompactNode = CompactRootNode | CompactChildNode;
 type CompactChildNode = CompactObjectNode | CompactListNode | CompactMapNode | CompactRegisterNode;
-type CompactRootNode = readonly [
-    id: "root",
-    type: CrdtType.OBJECT,
-    data: JsonObject
-];
+type CompactRootNode = readonly [id: "root", data: JsonObject];
 type CompactObjectNode = readonly [
     id: string,
     type: CrdtType.OBJECT,
@@ -2529,6 +2523,7 @@ declare const ServerMsgCode: Readonly<{
     ROOM_STATE: 104;
     STORAGE_STATE_V7: 200;
     STORAGE_CHUNK: 210;
+    STORAGE_STREAM_END: 211;
     UPDATE_STORAGE: 201;
     UPDATE_YDOC: 300;
     THREAD_CREATED: 400;
@@ -2550,6 +2545,7 @@ declare namespace ServerMsgCode {
     type ROOM_STATE = typeof ServerMsgCode.ROOM_STATE;
     type STORAGE_STATE_V7 = typeof ServerMsgCode.STORAGE_STATE_V7;
     type STORAGE_CHUNK = typeof ServerMsgCode.STORAGE_CHUNK;
+    type STORAGE_STREAM_END = typeof ServerMsgCode.STORAGE_STREAM_END;
     type UPDATE_STORAGE = typeof ServerMsgCode.UPDATE_STORAGE;
     type UPDATE_YDOC = typeof ServerMsgCode.UPDATE_YDOC;
     type THREAD_CREATED = typeof ServerMsgCode.THREAD_CREATED;
@@ -2566,7 +2562,7 @@ declare namespace ServerMsgCode {
 /**
  * Messages that can be sent from the server to the client.
  */
-type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | StorageStateServerMsg_V7 | StorageChunkServerMsg | UpdateStorageServerMsg | YDocUpdateServerMsg | RejectedStorageOpServerMsg | CommentsEventServerMsg;
+type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | StorageStateServerMsg_V7 | StorageChunkServerMsg | StorageEndServerMsg | UpdateStorageServerMsg | YDocUpdateServerMsg | RejectedStorageOpServerMsg | CommentsEventServerMsg;
 type CommentsEventServerMsg = ThreadCreatedEvent | ThreadDeletedEvent | ThreadMetadataUpdatedEvent | ThreadUpdatedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved;
 type ThreadCreatedEvent = {
     type: ServerMsgCode.THREAD_CREATED;
@@ -2753,24 +2749,24 @@ type StorageStateServerMsg_V7 = {
 };
 /**
  * Sent by the WebSocket server to a single client in response to the client
- * sending a FetchStorageClientMsg message, to provide the initial Storage
- * state of the Room.
+ * sending a FetchStorageClientMsg message, to provide one chunk of the initial
+ * Storage state of the Room.
  *
- * The server will respond with 0+ STORAGE_CHUNK messages with
- * done=false, followed by exactly one STORAGE_CHUNK message with
- * done=true.
+ * The server will respond with 1+ STORAGE_CHUNK messages, followed by exactly
+ * one STORAGE_STREAM_END message to mark the end of the transmission.
  *
  * If the room is using the new storage engine that supports streaming, then
- * potentially multiple chunks might get sent.
- *
- * If the room is using the old storage engine, then all nodes will be sent in
- * a single/large chunk (non-streaming).
+ * potentially multiple chunks might get sent. If the room is using the old
+ * storage engine, then all nodes will be sent in a single/large chunk
+ * (non-streaming).
  */
 type StorageChunkServerMsg = {
     readonly type: ServerMsgCode.STORAGE_CHUNK;
-    readonly done: boolean;
     readonly nodes: CompactNode[];
 };
+type StorageEndServerMsg = {
+    readonly type: ServerMsgCode.STORAGE_STREAM_END;
+};
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
  * a change occurred in the Storage document.

package/dist/index.js

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "3.13.0-vincent1";
+var PKG_VERSION = "3.13.0-vincent3";
 var PKG_FORMAT = "esm";
 
 // src/dupe-detection.ts
@@ -3094,6 +3094,8 @@ var ServerMsgCode = Object.freeze({
   // Only sent in V7
   STORAGE_CHUNK: 210,
   // Used in V8+
+  STORAGE_STREAM_END: 211,
+  // Used in V8+
   UPDATE_STORAGE: 201,
   // For Yjs Docs
   UPDATE_YDOC: 300,
@@ -5925,9 +5927,7 @@ var OpCode = Object.freeze({
   DELETE_CRDT: 5,
   DELETE_OBJECT_KEY: 6,
   CREATE_MAP: 7,
-  CREATE_REGISTER: 8,
-  ACK: 9
-  // Will only appear in v8+
+  CREATE_REGISTER: 8
 });
 function isAckOp(op) {
   return op.type === OpCode.DELETE_CRDT && op.id === "ACK";
@@ -6153,21 +6153,23 @@ function isRootCrdt(id, _) {
 }
 function* compactNodesToNodeStream(nodes) {
   for (const node of nodes) {
+    const id = node[0];
+    if (isRootNode(node)) {
+      yield [id, { type: CrdtType.OBJECT, data: node[1] }];
+      continue;
+    }
     switch (node[1]) {
       case CrdtType.OBJECT:
-        yield isRootNode(node) ? [node[0], { type: CrdtType.OBJECT, data: node[2] }] : (
-          // prettier-ignore
-          [node[0], { type: CrdtType.OBJECT, parentId: node[2], parentKey: node[3], data: node[4] }]
-        );
+        yield [id, { type: CrdtType.OBJECT, parentId: node[2], parentKey: node[3], data: node[4] }];
         break;
       case CrdtType.LIST:
-        yield [node[0], { type: CrdtType.LIST, parentId: node[2], parentKey: node[3] }];
+        yield [id, { type: CrdtType.LIST, parentId: node[2], parentKey: node[3] }];
         break;
       case CrdtType.MAP:
-        yield [node[0], { type: CrdtType.MAP, parentId: node[2], parentKey: node[3] }];
+        yield [id, { type: CrdtType.MAP, parentId: node[2], parentKey: node[3] }];
         break;
       case CrdtType.REGISTER:
-        yield [node[0], { type: CrdtType.REGISTER, parentId: node[2], parentKey: node[3], data: node[4] }];
+        yield [id, { type: CrdtType.REGISTER, parentId: node[2], parentKey: node[3], data: node[4] }];
         break;
     }
   }
@@ -6176,10 +6178,11 @@ function* nodeStreamToCompactNodes(nodes) {
   for (const [id, node] of nodes) {
     switch (node.type) {
       case CrdtType.OBJECT:
-        if (isRootCrdt(id, node))
-          yield [id, CrdtType.OBJECT, node.data];
-        else
+        if (isRootCrdt(id, node)) {
+          yield [id, node.data];
+        } else {
           yield [id, CrdtType.OBJECT, node.parentId, node.parentKey, node.data];
+        }
         break;
       case CrdtType.LIST:
         yield [id, CrdtType.LIST, node.parentId, node.parentKey];
@@ -9539,13 +9542,12 @@ function createRoom(options, config) {
           updates.others.push(onRoomStateMessage(message));
           break;
         }
-        case ServerMsgCode.STORAGE_CHUNK: {
+        case ServerMsgCode.STORAGE_CHUNK:
           partialNodes.append(compactNodesToNodeStream(message.nodes));
-          if (message.done) {
-            processInitialStorage(partialNodes.clear());
-          }
           break;
-        }
+        case ServerMsgCode.STORAGE_STREAM_END:
+          processInitialStorage(partialNodes.clear());
+          break;
         case ServerMsgCode.UPDATE_STORAGE: {
           const applyResult = applyOps(
             message.ops,