@liveblocks/core 3.13.0-vincent2 → 3.13.0-vincent3

package/dist/index.d.cts

@@ -2523,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;
@@ -2544,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;
@@ -2560,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;
@@ -2747,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

@@ -2523,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;
@@ -2544,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;
@@ -2560,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;
@@ -2747,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-vincent2";
+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,
@@ -9540,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,