@liveblocks/core 1.2.0-internal5 → 1.2.0-internal6

package/dist/index.d.mts

@@ -669,6 +669,222 @@ declare type Delegates<T extends BaseAuthResult> = {
     createSocket: (token: T) => IWebSocketInstance;
 };
 
+declare type IdTuple<T> = [id: string, value: T];
+declare enum CrdtType {
+    OBJECT = 0,
+    LIST = 1,
+    MAP = 2,
+    REGISTER = 3
+}
+declare type SerializedCrdt = SerializedRootObject | SerializedChild;
+declare type SerializedChild = SerializedObject | SerializedList | SerializedMap | SerializedRegister;
+declare type SerializedRootObject = {
+    readonly type: CrdtType.OBJECT;
+    readonly data: JsonObject;
+    readonly parentId?: never;
+    readonly parentKey?: never;
+};
+declare type SerializedObject = {
+    readonly type: CrdtType.OBJECT;
+    readonly parentId: string;
+    readonly parentKey: string;
+    readonly data: JsonObject;
+};
+declare type SerializedList = {
+    readonly type: CrdtType.LIST;
+    readonly parentId: string;
+    readonly parentKey: string;
+};
+declare type SerializedMap = {
+    readonly type: CrdtType.MAP;
+    readonly parentId: string;
+    readonly parentKey: string;
+};
+declare type SerializedRegister = {
+    readonly type: CrdtType.REGISTER;
+    readonly parentId: string;
+    readonly parentKey: string;
+    readonly data: Json;
+};
+declare function isRootCrdt(crdt: SerializedCrdt): crdt is SerializedRootObject;
+declare function isChildCrdt(crdt: SerializedCrdt): crdt is SerializedChild;
+
+declare enum ServerMsgCode {
+    UPDATE_PRESENCE = 100,
+    USER_JOINED = 101,
+    USER_LEFT = 102,
+    BROADCASTED_EVENT = 103,
+    ROOM_STATE = 104,
+    INITIAL_STORAGE_STATE = 200,
+    UPDATE_STORAGE = 201,
+    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 | 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.
+ *
+ * In most cases, the data payload will only include the fields from the
+ * Presence that have been changed since the last announcement. However, after
+ * a new user joins a room, a "full presence" will be announced so the newly
+ * connected user will get each other's user full presence at least once. In
+ * those cases, the `targetActor` field indicates the newly connected client,
+ * so all other existing clients can ignore this broadcasted message.
+ */
+declare type UpdatePresenceServerMsg<TPresence extends JsonObject> = {
+    readonly type: ServerMsgCode.UPDATE_PRESENCE;
+    /**
+     * The User whose Presence has changed.
+     */
+    readonly actor: number;
+    /**
+     * When set, signifies that this is a Full Presence™ update, not a patch.
+     *
+     * The numeric value itself no longer has specific meaning. Historically,
+     * this field was intended so that clients could ignore these broadcasted
+     * full presence messages, but it turned out that getting a full presence
+     * "keyframe" from time to time was useful.
+     *
+     * So nowadays, the presence (pun intended) of this `targetActor` field
+     * is a backward-compatible way of expressing that the `data` contains
+     * all presence fields, and isn't a partial "patch".
+     */
+    readonly targetActor: number;
+    /**
+     * The partial or full Presence of a User. If the `targetActor` field is set,
+     * this will be the full Presence, otherwise it only contain the fields that
+     * have changed since the last broadcast.
+     */
+    readonly data: TPresence;
+} | {
+    readonly type: ServerMsgCode.UPDATE_PRESENCE;
+    /**
+     * The User whose Presence has changed.
+     */
+    readonly actor: number;
+    /**
+     * Not set for partial presence updates.
+     */
+    readonly targetActor?: undefined;
+    /**
+     * A partial Presence patch to apply to the User. It will only contain the
+     * fields that have changed since the last broadcast.
+     */
+    readonly data: Partial<TPresence>;
+};
+/**
+ * Sent by the WebSocket server and broadcasted to all clients to announce that
+ * a new User has joined the Room.
+ */
+declare type UserJoinServerMsg<TUserMeta extends BaseUserMeta> = {
+    readonly type: ServerMsgCode.USER_JOINED;
+    readonly actor: number;
+    /**
+     * 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"];
+    /**
+     * Additional user information that has been set in the authentication
+     * endpoint.
+     */
+    readonly info: TUserMeta["info"];
+    /**
+     * Permissions that the user has in the Room.
+     */
+    readonly scopes: string[];
+};
+/**
+ * Sent by the WebSocket server and broadcasted to all clients to announce that
+ * a new User has left the Room.
+ */
+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;
+    readonly isSync: boolean;
+};
+/**
+ * Sent by the WebSocket server and broadcasted to all clients to announce that
+ * a User broadcasted an Event to everyone in the Room.
+ */
+declare type BroadcastedEventServerMsg<TRoomEvent extends Json> = {
+    readonly type: ServerMsgCode.BROADCASTED_EVENT;
+    /**
+     * The User who broadcasted the Event.
+     */
+    readonly actor: number;
+    /**
+     * The arbitrary payload of the Event. This can be any JSON value. Clients
+     * will have to manually verify/decode this event.
+     */
+    readonly event: TRoomEvent;
+};
+/**
+ * Sent by the WebSocket server to a single client in response to the client
+ * joining the Room, to provide the initial state of the Room. The payload
+ * includes a list of all other Users that already are in the Room.
+ */
+declare type RoomStateServerMsg<TUserMeta extends BaseUserMeta> = {
+    readonly type: ServerMsgCode.ROOM_STATE;
+    /**
+     * Informs the client what their actor ID is going to be.
+     * @since v1.2 (WS API v7)
+     */
+    readonly actor: number;
+    /**
+     * Informs the client what permissions the current User (self) has.
+     * @since v1.2 (WS API v7)
+     */
+    readonly scopes: string[];
+    readonly users: {
+        readonly [actor: number]: TUserMeta & {
+            scopes: string[];
+        };
+    };
+};
+/**
+ * Sent by the WebSocket server to a single client in response to the client
+ * joining the Room, to provide the initial Storage state of the Room. The
+ * payload includes the entire Storage document.
+ */
+declare type InitialDocumentStateServerMsg = {
+    readonly type: ServerMsgCode.INITIAL_STORAGE_STATE;
+    readonly items: IdTuple<SerializedCrdt>[];
+};
+/**
+ * Sent by the WebSocket server and broadcasted to all clients to announce that
+ * a change occurred in the Storage document.
+ *
+ * The payload of this message contains a list of Ops (aka incremental
+ * mutations to make to the initially loaded document).
+ */
+declare type UpdateStorageServerMsg = {
+    readonly type: ServerMsgCode.UPDATE_STORAGE;
+    readonly ops: Op[];
+};
+/**
+ * Sent by the WebSocket server to the client to indicate that certain opIds
+ * have been received but were rejected because they caused mutations that are
+ * incompatible with the Room's schema.
+ */
+declare type RejectedStorageOpServerMsg = {
+    readonly type: ServerMsgCode.REJECT_STORAGE_OP;
+    readonly opIds: string[];
+    readonly reason: string;
+};
+
 declare type ReadonlyArrayWithLegacyMethods<T> = readonly T[] & {
     /**
      * @deprecated Prefer the normal .length property on arrays.
@@ -1120,7 +1336,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          */
         readonly storageDidLoad: Observable<void>;
         readonly storageStatus: Observable<StorageStatus>;
-        readonly ydoc: Observable<string>;
+        readonly ydoc: Observable<YDocUpdate>;
     };
     /**
      * Batches modifications made during the given function.
@@ -1497,221 +1713,6 @@ declare type UpdateYDocClientMsg = {
     readonly update: string;
 };
 
-declare type IdTuple<T> = [id: string, value: T];
-declare enum CrdtType {
-    OBJECT = 0,
-    LIST = 1,
-    MAP = 2,
-    REGISTER = 3
-}
-declare type SerializedCrdt = SerializedRootObject | SerializedChild;
-declare type SerializedChild = SerializedObject | SerializedList | SerializedMap | SerializedRegister;
-declare type SerializedRootObject = {
-    readonly type: CrdtType.OBJECT;
-    readonly data: JsonObject;
-    readonly parentId?: never;
-    readonly parentKey?: never;
-};
-declare type SerializedObject = {
-    readonly type: CrdtType.OBJECT;
-    readonly parentId: string;
-    readonly parentKey: string;
-    readonly data: JsonObject;
-};
-declare type SerializedList = {
-    readonly type: CrdtType.LIST;
-    readonly parentId: string;
-    readonly parentKey: string;
-};
-declare type SerializedMap = {
-    readonly type: CrdtType.MAP;
-    readonly parentId: string;
-    readonly parentKey: string;
-};
-declare type SerializedRegister = {
-    readonly type: CrdtType.REGISTER;
-    readonly parentId: string;
-    readonly parentKey: string;
-    readonly data: Json;
-};
-declare function isRootCrdt(crdt: SerializedCrdt): crdt is SerializedRootObject;
-declare function isChildCrdt(crdt: SerializedCrdt): crdt is SerializedChild;
-
-declare enum ServerMsgCode {
-    UPDATE_PRESENCE = 100,
-    USER_JOINED = 101,
-    USER_LEFT = 102,
-    BROADCASTED_EVENT = 103,
-    ROOM_STATE = 104,
-    INITIAL_STORAGE_STATE = 200,
-    UPDATE_STORAGE = 201,
-    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 | 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.
- *
- * In most cases, the data payload will only include the fields from the
- * Presence that have been changed since the last announcement. However, after
- * a new user joins a room, a "full presence" will be announced so the newly
- * connected user will get each other's user full presence at least once. In
- * those cases, the `targetActor` field indicates the newly connected client,
- * so all other existing clients can ignore this broadcasted message.
- */
-declare type UpdatePresenceServerMsg<TPresence extends JsonObject> = {
-    readonly type: ServerMsgCode.UPDATE_PRESENCE;
-    /**
-     * The User whose Presence has changed.
-     */
-    readonly actor: number;
-    /**
-     * When set, signifies that this is a Full Presence™ update, not a patch.
-     *
-     * The numeric value itself no longer has specific meaning. Historically,
-     * this field was intended so that clients could ignore these broadcasted
-     * full presence messages, but it turned out that getting a full presence
-     * "keyframe" from time to time was useful.
-     *
-     * So nowadays, the presence (pun intended) of this `targetActor` field
-     * is a backward-compatible way of expressing that the `data` contains
-     * all presence fields, and isn't a partial "patch".
-     */
-    readonly targetActor: number;
-    /**
-     * The partial or full Presence of a User. If the `targetActor` field is set,
-     * this will be the full Presence, otherwise it only contain the fields that
-     * have changed since the last broadcast.
-     */
-    readonly data: TPresence;
-} | {
-    readonly type: ServerMsgCode.UPDATE_PRESENCE;
-    /**
-     * The User whose Presence has changed.
-     */
-    readonly actor: number;
-    /**
-     * Not set for partial presence updates.
-     */
-    readonly targetActor?: undefined;
-    /**
-     * A partial Presence patch to apply to the User. It will only contain the
-     * fields that have changed since the last broadcast.
-     */
-    readonly data: Partial<TPresence>;
-};
-/**
- * Sent by the WebSocket server and broadcasted to all clients to announce that
- * a new User has joined the Room.
- */
-declare type UserJoinServerMsg<TUserMeta extends BaseUserMeta> = {
-    readonly type: ServerMsgCode.USER_JOINED;
-    readonly actor: number;
-    /**
-     * 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"];
-    /**
-     * Additional user information that has been set in the authentication
-     * endpoint.
-     */
-    readonly info: TUserMeta["info"];
-    /**
-     * Permissions that the user has in the Room.
-     */
-    readonly scopes: string[];
-};
-/**
- * Sent by the WebSocket server and broadcasted to all clients to announce that
- * a new User has left the Room.
- */
-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.
- */
-declare type BroadcastedEventServerMsg<TRoomEvent extends Json> = {
-    readonly type: ServerMsgCode.BROADCASTED_EVENT;
-    /**
-     * The User who broadcasted the Event.
-     */
-    readonly actor: number;
-    /**
-     * The arbitrary payload of the Event. This can be any JSON value. Clients
-     * will have to manually verify/decode this event.
-     */
-    readonly event: TRoomEvent;
-};
-/**
- * Sent by the WebSocket server to a single client in response to the client
- * joining the Room, to provide the initial state of the Room. The payload
- * includes a list of all other Users that already are in the Room.
- */
-declare type RoomStateServerMsg<TUserMeta extends BaseUserMeta> = {
-    readonly type: ServerMsgCode.ROOM_STATE;
-    /**
-     * Informs the client what their actor ID is going to be.
-     * @since v1.2 (WS API v7)
-     */
-    readonly actor: number;
-    /**
-     * Informs the client what permissions the current User (self) has.
-     * @since v1.2 (WS API v7)
-     */
-    readonly scopes: string[];
-    readonly users: {
-        readonly [actor: number]: TUserMeta & {
-            scopes: string[];
-        };
-    };
-};
-/**
- * Sent by the WebSocket server to a single client in response to the client
- * joining the Room, to provide the initial Storage state of the Room. The
- * payload includes the entire Storage document.
- */
-declare type InitialDocumentStateServerMsg = {
-    readonly type: ServerMsgCode.INITIAL_STORAGE_STATE;
-    readonly items: IdTuple<SerializedCrdt>[];
-};
-/**
- * Sent by the WebSocket server and broadcasted to all clients to announce that
- * a change occurred in the Storage document.
- *
- * The payload of this message contains a list of Ops (aka incremental
- * mutations to make to the initially loaded document).
- */
-declare type UpdateStorageServerMsg = {
-    readonly type: ServerMsgCode.UPDATE_STORAGE;
-    readonly ops: Op[];
-};
-/**
- * Sent by the WebSocket server to the client to indicate that certain opIds
- * have been received but were rejected because they caused mutations that are
- * incompatible with the Room's schema.
- */
-declare type RejectedStorageOpServerMsg = {
-    readonly type: ServerMsgCode.REJECT_STORAGE_OP;
-    readonly opIds: string[];
-    readonly reason: string;
-};
-
 /**
  * Lookup table for nodes (= SerializedCrdt values) by their IDs.
  */