@liveblocks/core 1.0.11 → 1.0.12-yjs1

package/dist/index.d.ts

@@ -568,8 +568,23 @@ declare type BaseUserMeta = {
 declare type Callback<T> = (event: T) => void;
 declare type UnsubscribeCallback = () => void;
 declare type Observable<T> = {
+    /**
+     * Register a callback function to be called whenever the event source emits
+     * an event.
+     */
     subscribe(callback: Callback<T>): UnsubscribeCallback;
+    /**
+     * Register a one-time callback function to be called whenever the event
+     * source emits an event. After the event fires, the callback is
+     * auto-unsubscribed.
+     */
     subscribeOnce(callback: Callback<T>): UnsubscribeCallback;
+    /**
+     * Returns a promise that will resolve when an event is emitted by this
+     * event source. Optionally, specify a predicate that has to match. The first
+     * event matching that predicate will then resolve the promise.
+     */
+    waitUntil(predicate?: (event: T) => boolean): Promise<T>;
 };
 
 interface IWebSocketEvent {
@@ -968,6 +983,17 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          */
         addToHistory: boolean;
     }): void;
+    /**
+     *
+     * Sends YJS document updates to liveblocks server
+     *
+     * @param {string} data the doc update to send to the server, base64 encoded uint8array
+     */
+    updateDoc(data: string): void;
+    /**
+     * Sends a request for the current document from liveblocks server
+     */
+    getDoc(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
@@ -1022,6 +1048,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          */
         readonly storageDidLoad: Observable<void>;
         readonly storageStatus: Observable<StorageStatus>;
+        readonly docUpdated: Observable<string[]>;
     };
     /**
      * Batches modifications made during the given function.
@@ -1359,12 +1386,14 @@ declare enum ClientMsgCode {
     UPDATE_PRESENCE = 100,
     BROADCAST_EVENT = 103,
     FETCH_STORAGE = 200,
-    UPDATE_STORAGE = 201
+    UPDATE_STORAGE = 201,
+    FETCH_DOC = 300,
+    UPDATE_DOC = 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;
+declare type ClientMsg<TPresence extends JsonObject, TRoomEvent extends Json> = BroadcastEventClientMsg<TRoomEvent> | UpdatePresenceClientMsg<TPresence> | UpdateStorageClientMsg | FetchStorageClientMsg | FetchDocClientMsg | UpdateDocClientMsg;
 declare type BroadcastEventClientMsg<TRoomEvent extends Json> = {
     type: ClientMsgCode.BROADCAST_EVENT;
     event: TRoomEvent;
@@ -1402,6 +1431,14 @@ declare type UpdateStorageClientMsg = {
 declare type FetchStorageClientMsg = {
     readonly type: ClientMsgCode.FETCH_STORAGE;
 };
+declare type FetchDocClientMsg = {
+    readonly type: ClientMsgCode.FETCH_DOC;
+    readonly vector?: string;
+};
+declare type UpdateDocClientMsg = {
+    readonly type: ClientMsgCode.UPDATE_DOC;
+    readonly data: string;
+};
 
 declare type IdTuple<T> = [id: string, value: T];
 declare enum CrdtType {
@@ -1451,12 +1488,14 @@ declare enum ServerMsgCode {
     ROOM_STATE = 104,
     INITIAL_STORAGE_STATE = 200,
     UPDATE_STORAGE = 201,
-    REJECT_STORAGE_OP = 299
+    REJECT_STORAGE_OP = 299,
+    FETCH_DOC = 300,
+    DOC_UPDATE = 301
 }
 /**
  * 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;
+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;
 /**
  * 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.
@@ -1539,6 +1578,10 @@ declare type UserLeftServerMsg = {
     readonly type: ServerMsgCode.USER_LEFT;
     readonly actor: number;
 };
+declare type FetchDoc = {
+    readonly type: ServerMsgCode.FETCH_DOC;
+    readonly data: string[];
+};
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
  * a User broadcasted an Event to everyone in the Room.
@@ -1787,4 +1830,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, AppOnlyAuthToken, AuthToken, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, ConnectionStatus, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchStorageClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, 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, StorageStatus, StorageUpdate, ToImmutable, ToJson, 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 };
+export { AckOp, AppOnlyAuthToken, AuthToken, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, ConnectionStatus, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchDocClientMsg, FetchStorageClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, 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, 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 };

package/dist/index.js

@@ -54,6 +54,19 @@ var __async = (__this, __arguments, generator) => {
 function makeEventSource() {
   const _onetimeObservers = /* @__PURE__ */ new Set();
   const _observers = /* @__PURE__ */ new Set();
+  let _buffer = null;
+  function pause() {
+    _buffer = [];
+  }
+  function unpause() {
+    if (_buffer === null) {
+      return;
+    }
+    for (const event of _buffer) {
+      notify(event);
+    }
+    _buffer = null;
+  }
   function subscribe(callback) {
     _observers.add(callback);
     return () => _observers.delete(callback);
@@ -62,6 +75,25 @@ function makeEventSource() {
     _onetimeObservers.add(callback);
     return () => _onetimeObservers.delete(callback);
   }
+  function waitUntil(predicate) {
+    return __async(this, null, function* () {
+      let unsub;
+      return new Promise((res) => {
+        unsub = subscribe((event) => {
+          if (predicate === void 0 || predicate(event)) {
+            res(event);
+          }
+        });
+      }).finally(() => unsub == null ? void 0 : unsub());
+    });
+  }
+  function notifyOrBuffer(event) {
+    if (_buffer !== null) {
+      _buffer.push(event);
+    } else {
+      notify(event);
+    }
+  }
   function notify(event) {
     _onetimeObservers.forEach((callback) => callback(event));
     _onetimeObservers.clear();
@@ -71,16 +103,24 @@ function makeEventSource() {
     _onetimeObservers.clear();
     _observers.clear();
   }
+  function count() {
+    return _onetimeObservers.size + _observers.size;
+  }
   return {
     // Private/internal control over event emission
-    notify,
+    notify: notifyOrBuffer,
     subscribe,
     subscribeOnce,
     clear,
+    count,
+    waitUntil,
+    pause,
+    unpause,
     // Publicly exposable subscription API
     observable: {
       subscribe,
-      subscribeOnce
+      subscribeOnce,
+      waitUntil
     }
   };
 }
@@ -117,7 +157,7 @@ var onMessageFromPanel = eventSource.observable;
 // src/devtools/index.ts
 var VERSION = true ? (
   /* istanbul ignore next */
-  "1.0.11"
+  "1.0.12-yjs1"
 ) : "dev";
 var _devtoolsSetupHasRun = false;
 function setupDevTools(getAllRooms) {
@@ -3007,6 +3047,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";
   return ClientMsgCode2;
 })(ClientMsgCode || {});
 
@@ -3020,6 +3062,8 @@ 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";
   return ServerMsgCode2;
 })(ServerMsgCode || {});
 
@@ -3380,7 +3424,8 @@ function createRoom(options, config) {
     storage: makeEventSource(),
     history: makeEventSource(),
     storageDidLoad: makeEventSource(),
-    storageStatus: makeEventSource()
+    storageStatus: makeEventSource(),
+    docUpdated: makeEventSource()
   };
   const effects = config.mockedEffects || {
     authenticateAndConnect(auth, createWebSocket) {
@@ -3900,6 +3945,10 @@ function createRoom(options, config) {
             }
             break;
           }
+          case 300 /* FETCH_DOC */: {
+            eventHub.docUpdated.notify(message.data);
+            break;
+          }
           case 104 /* ROOM_STATE */: {
             updates.others.push(onRoomStateMessage(message));
             break;
@@ -4153,6 +4202,13 @@ ${Array.from(traces).join("\n\n")}`
     }
     return messages;
   }
+  function updateDoc(data) {
+    context.buffer.messages.push({
+      type: 301 /* UPDATE_DOC */,
+      data
+    });
+    tryFlushing();
+  }
   function broadcastEvent(event, options2 = {
     shouldQueueEventIfNotReady: false
   }) {
@@ -4204,6 +4260,10 @@ ${Array.from(traces).join("\n\n")}`
       };
     });
   }
+  function getDoc(vector = "") {
+    context.buffer.messages.push({ type: 300 /* FETCH_DOC */, vector });
+    tryFlushing();
+  }
   function undo() {
     if (context.activeBatch) {
       throw new Error("undo is not allowed during a batch");
@@ -4328,7 +4388,8 @@ ${Array.from(traces).join("\n\n")}`
     storage: eventHub.storage.observable,
     history: eventHub.history.observable,
     storageDidLoad: eventHub.storageDidLoad.observable,
-    storageStatus: eventHub.storageStatus.observable
+    storageStatus: eventHub.storageStatus.observable,
+    docUpdated: eventHub.docUpdated.observable
   };
   function transition(event) {
     switch (event.type) {
@@ -4399,6 +4460,7 @@ ${Array.from(traces).join("\n\n")}`
     reconnect,
     // Presence
     updatePresence,
+    updateDoc,
     broadcastEvent,
     // Storage
     batch,
@@ -4410,6 +4472,7 @@ ${Array.from(traces).join("\n\n")}`
       pause: pauseHistory,
       resume: resumeHistory
     },
+    getDoc,
     getStorage,
     getStorageSnapshot,
     getStorageStatus,
@@ -4524,7 +4587,7 @@ function prepareCreateWebSocket(liveblocksServer, WebSocketPolyfill) {
       // @ts-ignore (__PACKAGE_VERSION__ will be injected by the build script)
       true ? (
         /* istanbul ignore next */
-        "1.0.11"
+        "1.0.12-yjs1"
       ) : "dev"}`
     );
   };

package/package.json

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