@liveblocks/core 1.1.0-yjs4 → 1.1.0-yjs5

package/dist/index.d.ts

@@ -1083,11 +1083,11 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      *
      * @param {string} data the doc update to send to the server, base64 encoded uint8array
      */
-    updateDoc(data: string): void;
+    updateYDoc(data: string): void;
     /**
      * Sends a request for the current document from liveblocks server
      */
-    getDoc(stateVector?: string): void;
+    getYDoc(stateVector: string): void;
     /**
      * Broadcasts an event to other users in the room. Event broadcasted to the room can be listened with {@link Room.subscribe}("event").
      * @param {any} event the event to broadcast. Should be serializable to JSON
@@ -1145,7 +1145,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          */
         readonly storageDidLoad: Observable<void>;
         readonly storageStatus: Observable<StorageStatus>;
-        readonly docUpdated: Observable<string[]>;
+        readonly docUpdated: Observable<string>;
     };
     /**
      * Batches modifications made during the given function.
@@ -1469,13 +1469,13 @@ declare enum ClientMsgCode {
     BROADCAST_EVENT = 103,
     FETCH_STORAGE = 200,
     UPDATE_STORAGE = 201,
-    FETCH_DOC = 300,
-    UPDATE_DOC = 301
+    FETCH_YDOC_UPDATE = 300,
+    UPDATE_YDOC = 301
 }
 /**
  * Messages that can be sent from the client to the server.
  */
-declare type ClientMsg<TPresence extends JsonObject, TRoomEvent extends Json> = BroadcastEventClientMsg<TRoomEvent> | UpdatePresenceClientMsg<TPresence> | UpdateStorageClientMsg | FetchStorageClientMsg | FetchDocClientMsg | UpdateDocClientMsg;
+declare type ClientMsg<TPresence extends JsonObject, TRoomEvent extends Json> = BroadcastEventClientMsg<TRoomEvent> | UpdatePresenceClientMsg<TPresence> | UpdateStorageClientMsg | FetchStorageClientMsg | FetchYDocClientMsg | UpdateYDocClientMsg;
 declare type BroadcastEventClientMsg<TRoomEvent extends Json> = {
     type: ClientMsgCode.BROADCAST_EVENT;
     event: TRoomEvent;
@@ -1513,13 +1513,13 @@ declare type UpdateStorageClientMsg = {
 declare type FetchStorageClientMsg = {
     readonly type: ClientMsgCode.FETCH_STORAGE;
 };
-declare type FetchDocClientMsg = {
-    readonly type: ClientMsgCode.FETCH_DOC;
-    readonly vector?: string;
+declare type FetchYDocClientMsg = {
+    readonly type: ClientMsgCode.FETCH_YDOC_UPDATE;
+    readonly vector: string;
 };
-declare type UpdateDocClientMsg = {
-    readonly type: ClientMsgCode.UPDATE_DOC;
-    readonly data: string;
+declare type UpdateYDocClientMsg = {
+    readonly type: ClientMsgCode.UPDATE_YDOC;
+    readonly update: string;
 };
 
 declare type IdTuple<T> = [id: string, value: T];
@@ -1571,13 +1571,12 @@ declare enum ServerMsgCode {
     INITIAL_STORAGE_STATE = 200,
     UPDATE_STORAGE = 201,
     REJECT_STORAGE_OP = 299,
-    FETCH_DOC = 300,
-    DOC_UPDATE = 301
+    YDOC_UPDATE = 300
 }
 /**
  * Messages that can be sent from the server to the client.
  */
-declare type ServerMsg<TPresence extends JsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = UpdatePresenceServerMsg<TPresence> | UserJoinServerMsg<TUserMeta> | UserLeftServerMsg | BroadcastedEventServerMsg<TRoomEvent> | RoomStateServerMsg<TUserMeta> | InitialDocumentStateServerMsg | UpdateStorageServerMsg | RejectedStorageOpServerMsg | FetchDoc;
+declare type ServerMsg<TPresence extends JsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = UpdatePresenceServerMsg<TPresence> | UserJoinServerMsg<TUserMeta> | UserLeftServerMsg | BroadcastedEventServerMsg<TRoomEvent> | RoomStateServerMsg<TUserMeta> | InitialDocumentStateServerMsg | UpdateStorageServerMsg | RejectedStorageOpServerMsg | YDocUpdate;
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
  * a User updated their presence. For example, when a user moves their cursor.
@@ -1660,9 +1659,9 @@ declare type UserLeftServerMsg = {
     readonly type: ServerMsgCode.USER_LEFT;
     readonly actor: number;
 };
-declare type FetchDoc = {
-    readonly type: ServerMsgCode.FETCH_DOC;
-    readonly data: string[];
+declare type YDocUpdate = {
+    readonly type: ServerMsgCode.YDOC_UPDATE;
+    readonly update: string;
 };
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
@@ -1912,4 +1911,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, AppOnlyAuthToken, AuthToken, BaseAuthResult, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchDocClientMsg, FetchStorageClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LegacyConnectionStatus, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, LostConnectionEvent, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomAuthToken, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ToImmutable, ToJson, UpdateDocClientMsg, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, asPos, assert, assertNever, b64decode, createClient, deprecate, deprecateIf, errorIf, freeze, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRoomAuthToken, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, toPlainLson, tryParseJson, withTimeout };
+export { AckOp, AppOnlyAuthToken, AuthToken, BaseAuthResult, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchStorageClientMsg, FetchYDocClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LegacyConnectionStatus, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, LostConnectionEvent, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomAuthToken, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ToImmutable, ToJson, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, asPos, assert, assertNever, b64decode, createClient, deprecate, deprecateIf, errorIf, freeze, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRoomAuthToken, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, toPlainLson, tryParseJson, withTimeout };

package/dist/index.js

@@ -157,7 +157,7 @@ var onMessageFromPanel = eventSource.observable;
 // src/devtools/index.ts
 var VERSION = true ? (
   /* istanbul ignore next */
-  "1.1.0-yjs4"
+  "1.1.0-yjs5"
 ) : "dev";
 var _devtoolsSetupHasRun = false;
 function setupDevTools(getAllRooms) {
@@ -3986,8 +3986,8 @@ var ClientMsgCode = /* @__PURE__ */ ((ClientMsgCode2) => {
   ClientMsgCode2[ClientMsgCode2["BROADCAST_EVENT"] = 103] = "BROADCAST_EVENT";
   ClientMsgCode2[ClientMsgCode2["FETCH_STORAGE"] = 200] = "FETCH_STORAGE";
   ClientMsgCode2[ClientMsgCode2["UPDATE_STORAGE"] = 201] = "UPDATE_STORAGE";
-  ClientMsgCode2[ClientMsgCode2["FETCH_DOC"] = 300] = "FETCH_DOC";
-  ClientMsgCode2[ClientMsgCode2["UPDATE_DOC"] = 301] = "UPDATE_DOC";
+  ClientMsgCode2[ClientMsgCode2["FETCH_YDOC_UPDATE"] = 300] = "FETCH_YDOC_UPDATE";
+  ClientMsgCode2[ClientMsgCode2["UPDATE_YDOC"] = 301] = "UPDATE_YDOC";
   return ClientMsgCode2;
 })(ClientMsgCode || {});
 
@@ -4001,8 +4001,7 @@ var ServerMsgCode = /* @__PURE__ */ ((ServerMsgCode2) => {
   ServerMsgCode2[ServerMsgCode2["INITIAL_STORAGE_STATE"] = 200] = "INITIAL_STORAGE_STATE";
   ServerMsgCode2[ServerMsgCode2["UPDATE_STORAGE"] = 201] = "UPDATE_STORAGE";
   ServerMsgCode2[ServerMsgCode2["REJECT_STORAGE_OP"] = 299] = "REJECT_STORAGE_OP";
-  ServerMsgCode2[ServerMsgCode2["FETCH_DOC"] = 300] = "FETCH_DOC";
-  ServerMsgCode2[ServerMsgCode2["DOC_UPDATE"] = 301] = "DOC_UPDATE";
+  ServerMsgCode2[ServerMsgCode2["YDOC_UPDATE"] = 300] = "YDOC_UPDATE";
   return ServerMsgCode2;
 })(ServerMsgCode || {});
 
@@ -4857,8 +4856,8 @@ function createRoom(options, config) {
             }
             break;
           }
-          case 300 /* FETCH_DOC */: {
-            eventHub.docUpdated.notify(message.data);
+          case 300 /* YDOC_UPDATE */: {
+            eventHub.docUpdated.notify(message.update);
             break;
           }
           case 104 /* ROOM_STATE */: {
@@ -4979,10 +4978,10 @@ ${Array.from(traces).join("\n\n")}`
     }
     return messages;
   }
-  function updateDoc(data) {
+  function updateYDoc(update) {
     context.buffer.messages.push({
-      type: 301 /* UPDATE_DOC */,
-      data
+      type: 301 /* UPDATE_YDOC */,
+      update
     });
     flushNowOrSoon();
   }
@@ -5045,8 +5044,11 @@ ${Array.from(traces).join("\n\n")}`
       };
     });
   }
-  function getDoc(vector = "") {
-    context.buffer.messages.push({ type: 300 /* FETCH_DOC */, vector });
+  function getYDoc(vector) {
+    context.buffer.messages.push({
+      type: 300 /* FETCH_YDOC_UPDATE */,
+      vector
+    });
     flushNowOrSoon();
   }
   function undo() {
@@ -5206,7 +5208,7 @@ ${Array.from(traces).join("\n\n")}`
     destroy: () => managedSocket.destroy(),
     // Presence
     updatePresence,
-    updateDoc,
+    updateYDoc,
     broadcastEvent,
     // Storage
     batch,
@@ -5218,7 +5220,7 @@ ${Array.from(traces).join("\n\n")}`
       pause: pauseHistory,
       resume: resumeHistory
     },
-    getDoc,
+    getYDoc,
     getStorage,
     getStorageSnapshot,
     getStorageStatus,
@@ -5334,7 +5336,7 @@ function makeCreateSocketDelegateForRoom(liveblocksServer, WebSocketPolyfill) {
       // @ts-ignore (__PACKAGE_VERSION__ will be injected by the build script)
       true ? (
         /* istanbul ignore next */
-        "1.1.0-yjs4"
+        "1.1.0-yjs5"
       ) : "dev"}`
     );
   };

package/package.json

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