@liveblocks/core 1.1.0 → 1.1.1-dual1

package/dist/index.d.ts

@@ -669,31 +669,6 @@ declare type Delegates<T extends BaseAuthResult> = {
     createSocket: (token: T) => IWebSocketInstance;
 };
 
-declare type AppOnlyAuthToken = {
-    appId: string;
-    roomId?: never;
-    scopes: string[];
-};
-declare type RoomAuthToken = {
-    appId: string;
-    roomId: string;
-    scopes: string[];
-    actor: number;
-    maxConnectionsPerRoom?: number;
-    info?: Json;
-    groupIds?: string[];
-} & ({
-    id: string;
-    anonymousId?: never;
-} | {
-    id?: never;
-    anonymousId: string;
-});
-declare type AuthToken = AppOnlyAuthToken | RoomAuthToken;
-declare function isAppOnlyAuthToken(data: JsonObject): data is AppOnlyAuthToken;
-declare function isRoomAuthToken(data: JsonObject): data is RoomAuthToken;
-declare function isAuthToken(data: JsonObject): data is AuthToken;
-
 declare type ReadonlyArrayWithLegacyMethods<T> = readonly T[] & {
     /**
      * @deprecated Prefer the normal .length property on arrays.
@@ -711,11 +686,11 @@ declare function asArrayWithLegacyMethods<T>(arr: readonly T[]): ReadonlyArrayWi
  */
 declare type User<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
     /**
-     * The connection id of the user. It is unique and increment at every new connection.
+     * The connection ID of the User. It is unique and increment at every new connection.
      */
     readonly connectionId: number;
     /**
-     * The id of the user that has been set in the authentication endpoint.
+     * The ID of the User that has been set in the authentication endpoint.
      * Useful to get additional information about the connected user.
      */
     readonly id: TUserMeta["id"];
@@ -724,7 +699,7 @@ declare type User<TPresence extends JsonObject, TUserMeta extends BaseUserMeta>
      */
     readonly info: TUserMeta["info"];
     /**
-     * The user presence.
+     * The user’s presence data.
      */
     readonly presence: TPresence;
     /**
@@ -1077,6 +1052,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
+     */
+    updateYDoc(data: string): void;
+    /**
+     * Sends a request for the current document from liveblocks server
+     */
+    fetchYDoc(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
@@ -1134,6 +1120,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          */
         readonly storageDidLoad: Observable<void>;
         readonly storageStatus: Observable<StorageStatus>;
+        readonly ydoc: Observable<string>;
     };
     /**
      * Batches modifications made during the given function.
@@ -1456,12 +1443,14 @@ declare enum ClientMsgCode {
     UPDATE_PRESENCE = 100,
     BROADCAST_EVENT = 103,
     FETCH_STORAGE = 200,
-    UPDATE_STORAGE = 201
+    UPDATE_STORAGE = 201,
+    FETCH_YDOC = 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;
+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;
@@ -1499,6 +1488,14 @@ declare type UpdateStorageClientMsg = {
 declare type FetchStorageClientMsg = {
     readonly type: ClientMsgCode.FETCH_STORAGE;
 };
+declare type FetchYDocClientMsg = {
+    readonly type: ClientMsgCode.FETCH_YDOC;
+    readonly vector: string;
+};
+declare type UpdateYDocClientMsg = {
+    readonly type: ClientMsgCode.UPDATE_YDOC;
+    readonly update: string;
+};
 
 declare type IdTuple<T> = [id: string, value: T];
 declare enum CrdtType {
@@ -1548,12 +1545,13 @@ declare enum ServerMsgCode {
     ROOM_STATE = 104,
     INITIAL_STORAGE_STATE = 200,
     UPDATE_STORAGE = 201,
-    REJECT_STORAGE_OP = 299
+    REJECT_STORAGE_OP = 299,
+    UPDATE_YDOC = 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;
+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.
@@ -1636,6 +1634,14 @@ declare type UserLeftServerMsg = {
     readonly type: ServerMsgCode.USER_LEFT;
     readonly actor: number;
 };
+/**
+ * Sent by the WebSocket server when the ydoc is updated or when requested based on stateVector passed.
+ * Contains a base64 encoded update
+ */
+declare type YDocUpdate = {
+    readonly type: ServerMsgCode.UPDATE_YDOC;
+    readonly update: string;
+};
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
  * a User broadcasted an Event to everyone in the Room.
@@ -1884,4 +1890,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, 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, 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, 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, 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, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, toPlainLson, tryParseJson, withTimeout };