@liveblocks/core 1.4.8-test1 → 1.5.0-test2

package/dist/index.d.mts

@@ -240,6 +240,7 @@ declare class LiveObject<O extends LsonObject> extends AbstractCrdt {
      */
     update(patch: Partial<O>): void;
     toImmutable(): ToImmutable<O>;
+    clone(): LiveObject<O>;
 }
 
 /**
@@ -333,6 +334,7 @@ declare class LiveMap<TKey extends string, TValue extends Lson> extends Abstract
      */
     forEach(callback: (value: TValue, key: TKey, map: LiveMap<TKey, TValue>) => void): void;
     toImmutable(): ReadonlyMap<TKey, ToImmutable<TValue>>;
+    clone(): LiveMap<TKey, TValue>;
 }
 
 declare type StorageCallback = (updates: StorageUpdate[]) => void;
@@ -352,24 +354,29 @@ declare abstract class AbstractCrdt {
      * Return an immutable snapshot of this Live node and its children.
      */
     toImmutable(): Immutable;
+    /**
+     * Returns a deep clone of the current LiveStructure, suitable for insertion
+     * in the tree elsewhere.
+     */
+    abstract clone(): Lson;
 }
 
 declare type LiveListUpdateDelta = {
+    type: "insert";
     index: number;
     item: Lson;
-    type: "insert";
 } | {
-    index: number;
     type: "delete";
+    index: number;
 } | {
+    type: "move";
     index: number;
     previousIndex: number;
     item: Lson;
-    type: "move";
 } | {
+    type: "set";
     index: number;
     item: Lson;
-    type: "set";
 };
 /**
  * A LiveList notification that is sent in-client to any subscribers whenever
@@ -480,6 +487,7 @@ declare class LiveList<TItem extends Lson> extends AbstractCrdt {
     some(predicate: (value: TItem, index: number) => unknown): boolean;
     [Symbol.iterator](): IterableIterator<TItem>;
     toImmutable(): readonly ToImmutable<TItem>[];
+    clone(): LiveList<TItem>;
 }
 
 /**
@@ -488,6 +496,7 @@ declare class LiveList<TItem extends Lson> extends AbstractCrdt {
 declare class LiveRegister<TValue extends Json> extends AbstractCrdt {
     constructor(data: TValue);
     get data(): TValue;
+    clone(): TValue;
 }
 
 declare type LiveStructure = LiveObject<LsonObject> | LiveList<Lson> | LiveMap<string, Lson>;
@@ -723,7 +732,7 @@ declare type ThreadData<TThreadMetadata extends BaseMetadata = never> = {
 };
 
 declare type Options = {
-    serverEndpoint: string;
+    baseUrl: string;
 };
 declare type PartialNullable<T> = {
     [P in keyof T]?: T[P] | null | undefined;
@@ -765,7 +774,7 @@ declare type CommentsApi<TThreadMetadata extends BaseMetadata> = {
         emoji: string;
     }): Promise<CommentData>;
 };
-declare function createCommentsApi<TThreadMetadata extends BaseMetadata>(roomId: string, getAuthValue: () => Promise<AuthValue>, { serverEndpoint }: Options): CommentsApi<TThreadMetadata>;
+declare function createCommentsApi<TThreadMetadata extends BaseMetadata>(roomId: string, getAuthValue: () => Promise<AuthValue>, config: Options): CommentsApi<TThreadMetadata>;
 
 declare type Callback<T> = (event: T) => void;
 declare type UnsubscribeCallback = () => void;
@@ -944,6 +953,7 @@ declare type BaseAuthResult = NonNullable<Json>;
 declare type Delegates<T extends BaseAuthResult> = {
     authenticate: () => Promise<T>;
     createSocket: (authValue: T) => IWebSocketInstance;
+    canZombie: () => boolean;
 };
 
 declare enum ClientMsgCode {
@@ -1312,7 +1322,7 @@ declare type User<TPresence extends JsonObject, TUserMeta extends BaseUserMeta>
  * @deprecated Use `readonly User<TPresence, TUserMeta>[]` instead of `Others<TPresence, TUserMeta>`.
  */
 declare type Others<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = readonly User<TPresence, TUserMeta>[];
-declare type OthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
+declare type InternalOthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
     type: "leave";
     user: User<TPresence, TUserMeta>;
 } | {
@@ -1325,7 +1335,24 @@ declare type OthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUse
 } | {
     type: "reset";
 };
+declare type OthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = Resolve<InternalOthersEvent<TPresence, TUserMeta> & {
+    others: readonly User<TPresence, TUserMeta>[];
+}>;
 
+declare type LegacyOthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
+    type: "leave";
+    user: User<TPresence, TUserMeta>;
+} | {
+    type: "enter";
+    user: User<TPresence, TUserMeta>;
+} | {
+    type: "update";
+    user: User<TPresence, TUserMeta>;
+    updates: Partial<TPresence>;
+} | {
+    type: "reset";
+};
+declare type LegacyOthersEventCallback<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = (others: readonly User<TPresence, TUserMeta>[], event: LegacyOthersEvent<TPresence, TUserMeta>) => void;
 declare type RoomEventMessage<TPresence extends JsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = {
     /**
      * The connection ID of the client that sent the event.
@@ -1458,7 +1485,7 @@ declare type SubscribeFn<TPresence extends JsonObject, _TStorage extends LsonObj
      * });
      *
      */
-    (type: "others", listener: (others: readonly User<TPresence, TUserMeta>[], event: OthersEvent<TPresence, TUserMeta>) => void): () => void;
+    (type: "others", listener: LegacyOthersEventCallback<TPresence, TUserMeta>): () => void;
     /**
      * Subscribe to events broadcasted by {@link Room.broadcastEvent}
      *
@@ -1715,10 +1742,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
         readonly customEvent: Observable<RoomEventMessage<TPresence, TUserMeta, TRoomEvent>>;
         readonly self: Observable<User<TPresence, TUserMeta>>;
         readonly myPresence: Observable<TPresence>;
-        readonly others: Observable<{
-            others: readonly User<TPresence, TUserMeta>[];
-            event: OthersEvent<TPresence, TUserMeta>;
-        }>;
+        readonly others: Observable<OthersEvent<TPresence, TUserMeta>>;
         readonly error: Observable<Error>;
         readonly storage: Observable<StorageUpdate[]>;
         readonly history: Observable<HistoryEvent>;
@@ -1755,6 +1779,24 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      * - `synchronized`: Storage is in sync with Liveblocks servers.
      */
     getStorageStatus(): StorageStatus;
+    /**
+     * Start an attempt to connect the room (aka "enter" it). Calling
+     * `.connect()` only has an effect if the room is still in its idle initial
+     * state, or the room was explicitly disconnected, or reconnection attempts
+     * were stopped (for example, because the user isn't authorized to enter the
+     * room). Will be a no-op otherwise.
+     */
+    connect(): void;
+    /**
+     * Disconnect the room's connection to the Liveblocks server, if any. Puts
+     * the room back into an idle state. It will not do anything until either
+     * `.connect()` or `.reconnect()` is called.
+     *
+     * Only use this API if you wish to connect the room again at a later time.
+     * If you want to disconnect the room because you no longer need it, call
+     * `.destroy()` instead.
+     */
+    disconnect(): void;
     /**
      * Reconnect the room to the Liveblocks server by re-establishing a fresh
      * connection. If the room is not connected yet, initiate it.
@@ -1777,11 +1819,14 @@ declare type RoomInitializers<TPresence extends JsonObject, TStorage extends Lso
      */
     initialStorage?: TStorage | ((roomId: string) => TStorage);
     /**
-     * Whether or not the room connects to Liveblock servers. Default is true.
+     * Whether or not the room automatically connects to Liveblock servers.
+     * Default is true.
      *
      * Usually set to false when the client is used from the server to not call
      * the authentication endpoint or connect via WebSocket.
      */
+    autoConnect?: boolean;
+    /** @deprecated Renamed to `autoConnect` */
     shouldInitiallyConnect?: boolean;
 }>;
 
@@ -1804,16 +1849,43 @@ declare type Client = {
      */
     getRoom<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never>(roomId: string): Room<TPresence, TStorage, TUserMeta, TRoomEvent> | null;
     /**
+     * Enter a room.
+     * @param roomId The id of the room
+     * @param options Optional. You can provide initializers for the Presence or Storage when entering the Room.
+     * @returns The room and a leave function. Call the returned leave() function when you no longer need the room.
+     */
+    enterRoom<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never>(roomId: string, options: EnterOptions<TPresence, TStorage>): {
+        room: Room<TPresence, TStorage, TUserMeta, TRoomEvent>;
+        leave: () => void;
+    };
+    /**
+     * @deprecated - Prefer using {@link Client.enterRoom} instead.
+     *
      * Enters a room and returns it.
      * @param roomId The id of the room
      * @param options Optional. You can provide initializers for the Presence or Storage when entering the Room.
      */
     enter<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never>(roomId: string, options: EnterOptions<TPresence, TStorage>): Room<TPresence, TStorage, TUserMeta, TRoomEvent>;
     /**
-     * Leaves a room.
+     * @deprecated - Prefer using {@link Client.enterRoom} and calling the returned leave function instead, which is safer.
+     *
+     * Forcefully leaves a room.
+     *
+     * Only call this if you know for sure there are no other "instances" of this
+     * room used elsewhere in your application. Force-leaving can trigger
+     * unexpected conditions in other parts of your application that may not
+     * expect this.
+     *
      * @param roomId The id of the room
      */
     leave(roomId: string): void;
+    /**
+     * Purges all cached auth tokens and reconnects all rooms that are still
+     * connected, if any.
+     *
+     * Call this whenever you log out a user in your application.
+     */
+    logout(): void;
 };
 declare type AuthEndpoint = string | ((room: string) => Promise<CustomAuthenticationResult>);
 /**
@@ -1823,6 +1895,7 @@ declare type AuthEndpoint = string | ((room: string) => Promise<CustomAuthentica
 declare type ClientOptions = {
     throttle?: number;
     lostConnectionTimeout?: number;
+    backgroundKeepAliveTimeout?: number;
     polyfills?: Polyfills;
     unstable_fallbackToHTTP?: boolean;
     /**
@@ -1882,6 +1955,7 @@ declare type ParentToChildNodeMap = Map<string, // Parent's node ID
 IdTuple<SerializedChild>[]>;
 
 declare function isLiveNode(value: unknown): value is LiveNode;
+declare function cloneLson<L extends Lson | undefined>(value: L): L;
 
 declare function lsonToJson(value: Lson): Json;
 declare function patchLiveObjectKey<O extends LsonObject, K extends keyof O, V extends Json>(liveObject: LiveObject<O>, key: K, prev?: V, next?: V): void;
@@ -2366,4 +2440,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, AsyncCache, AsyncState, AsyncStateError, AsyncStateInitial, AsyncStateLoading, AsyncStateResolved, AsyncStateSuccess, BaseAuthResult, BaseMetadata, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CommentBody, CommentBodyElement, CommentBodyLink, CommentBodyMention, CommentBodyParagraph, CommentBodyText, CommentData, CommentReaction, CommentsApi, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, CustomAuthenticationResult, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, EventSource, 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, RoomEventMessage, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ThreadData, ToImmutable, ToJson, UnsubscribeCallback, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, YDocUpdateServerMsg, asPos, assert, assertNever, b64decode, fancyConsole as console, createAsyncCache, createClient, createCommentsApi, deprecate, deprecateIf, detectDupes, errorIf, freeze, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, shallow, stringify, throwUsageError, toPlainLson, tryParseJson, withTimeout };
+export { AckOp, AsyncCache, AsyncState, AsyncStateError, AsyncStateInitial, AsyncStateLoading, AsyncStateResolved, AsyncStateSuccess, BaseAuthResult, BaseMetadata, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CommentBody, CommentBodyElement, CommentBodyLink, CommentBodyMention, CommentBodyParagraph, CommentBodyText, CommentData, CommentReaction, CommentsApi, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, CustomAuthenticationResult, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, EnterOptions, EventSource, 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, OthersEvent, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomEventMessage, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ThreadData, ToImmutable, ToJson, UnsubscribeCallback, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, YDocUpdateServerMsg, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, createAsyncCache, createClient, createCommentsApi, deprecate, deprecateIf, detectDupes, errorIf, freeze, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, shallow, stringify, throwUsageError, toPlainLson, tryParseJson, withTimeout };

package/dist/index.d.ts

@@ -240,6 +240,7 @@ declare class LiveObject<O extends LsonObject> extends AbstractCrdt {
      */
     update(patch: Partial<O>): void;
     toImmutable(): ToImmutable<O>;
+    clone(): LiveObject<O>;
 }
 
 /**
@@ -333,6 +334,7 @@ declare class LiveMap<TKey extends string, TValue extends Lson> extends Abstract
      */
     forEach(callback: (value: TValue, key: TKey, map: LiveMap<TKey, TValue>) => void): void;
     toImmutable(): ReadonlyMap<TKey, ToImmutable<TValue>>;
+    clone(): LiveMap<TKey, TValue>;
 }
 
 declare type StorageCallback = (updates: StorageUpdate[]) => void;
@@ -352,24 +354,29 @@ declare abstract class AbstractCrdt {
      * Return an immutable snapshot of this Live node and its children.
      */
     toImmutable(): Immutable;
+    /**
+     * Returns a deep clone of the current LiveStructure, suitable for insertion
+     * in the tree elsewhere.
+     */
+    abstract clone(): Lson;
 }
 
 declare type LiveListUpdateDelta = {
+    type: "insert";
     index: number;
     item: Lson;
-    type: "insert";
 } | {
-    index: number;
     type: "delete";
+    index: number;
 } | {
+    type: "move";
     index: number;
     previousIndex: number;
     item: Lson;
-    type: "move";
 } | {
+    type: "set";
     index: number;
     item: Lson;
-    type: "set";
 };
 /**
  * A LiveList notification that is sent in-client to any subscribers whenever
@@ -480,6 +487,7 @@ declare class LiveList<TItem extends Lson> extends AbstractCrdt {
     some(predicate: (value: TItem, index: number) => unknown): boolean;
     [Symbol.iterator](): IterableIterator<TItem>;
     toImmutable(): readonly ToImmutable<TItem>[];
+    clone(): LiveList<TItem>;
 }
 
 /**
@@ -488,6 +496,7 @@ declare class LiveList<TItem extends Lson> extends AbstractCrdt {
 declare class LiveRegister<TValue extends Json> extends AbstractCrdt {
     constructor(data: TValue);
     get data(): TValue;
+    clone(): TValue;
 }
 
 declare type LiveStructure = LiveObject<LsonObject> | LiveList<Lson> | LiveMap<string, Lson>;
@@ -723,7 +732,7 @@ declare type ThreadData<TThreadMetadata extends BaseMetadata = never> = {
 };
 
 declare type Options = {
-    serverEndpoint: string;
+    baseUrl: string;
 };
 declare type PartialNullable<T> = {
     [P in keyof T]?: T[P] | null | undefined;
@@ -765,7 +774,7 @@ declare type CommentsApi<TThreadMetadata extends BaseMetadata> = {
         emoji: string;
     }): Promise<CommentData>;
 };
-declare function createCommentsApi<TThreadMetadata extends BaseMetadata>(roomId: string, getAuthValue: () => Promise<AuthValue>, { serverEndpoint }: Options): CommentsApi<TThreadMetadata>;
+declare function createCommentsApi<TThreadMetadata extends BaseMetadata>(roomId: string, getAuthValue: () => Promise<AuthValue>, config: Options): CommentsApi<TThreadMetadata>;
 
 declare type Callback<T> = (event: T) => void;
 declare type UnsubscribeCallback = () => void;
@@ -944,6 +953,7 @@ declare type BaseAuthResult = NonNullable<Json>;
 declare type Delegates<T extends BaseAuthResult> = {
     authenticate: () => Promise<T>;
     createSocket: (authValue: T) => IWebSocketInstance;
+    canZombie: () => boolean;
 };
 
 declare enum ClientMsgCode {
@@ -1312,7 +1322,7 @@ declare type User<TPresence extends JsonObject, TUserMeta extends BaseUserMeta>
  * @deprecated Use `readonly User<TPresence, TUserMeta>[]` instead of `Others<TPresence, TUserMeta>`.
  */
 declare type Others<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = readonly User<TPresence, TUserMeta>[];
-declare type OthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
+declare type InternalOthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
     type: "leave";
     user: User<TPresence, TUserMeta>;
 } | {
@@ -1325,7 +1335,24 @@ declare type OthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUse
 } | {
     type: "reset";
 };
+declare type OthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = Resolve<InternalOthersEvent<TPresence, TUserMeta> & {
+    others: readonly User<TPresence, TUserMeta>[];
+}>;
 
+declare type LegacyOthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
+    type: "leave";
+    user: User<TPresence, TUserMeta>;
+} | {
+    type: "enter";
+    user: User<TPresence, TUserMeta>;
+} | {
+    type: "update";
+    user: User<TPresence, TUserMeta>;
+    updates: Partial<TPresence>;
+} | {
+    type: "reset";
+};
+declare type LegacyOthersEventCallback<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = (others: readonly User<TPresence, TUserMeta>[], event: LegacyOthersEvent<TPresence, TUserMeta>) => void;
 declare type RoomEventMessage<TPresence extends JsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = {
     /**
      * The connection ID of the client that sent the event.
@@ -1458,7 +1485,7 @@ declare type SubscribeFn<TPresence extends JsonObject, _TStorage extends LsonObj
      * });
      *
      */
-    (type: "others", listener: (others: readonly User<TPresence, TUserMeta>[], event: OthersEvent<TPresence, TUserMeta>) => void): () => void;
+    (type: "others", listener: LegacyOthersEventCallback<TPresence, TUserMeta>): () => void;
     /**
      * Subscribe to events broadcasted by {@link Room.broadcastEvent}
      *
@@ -1715,10 +1742,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
         readonly customEvent: Observable<RoomEventMessage<TPresence, TUserMeta, TRoomEvent>>;
         readonly self: Observable<User<TPresence, TUserMeta>>;
         readonly myPresence: Observable<TPresence>;
-        readonly others: Observable<{
-            others: readonly User<TPresence, TUserMeta>[];
-            event: OthersEvent<TPresence, TUserMeta>;
-        }>;
+        readonly others: Observable<OthersEvent<TPresence, TUserMeta>>;
         readonly error: Observable<Error>;
         readonly storage: Observable<StorageUpdate[]>;
         readonly history: Observable<HistoryEvent>;
@@ -1755,6 +1779,24 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      * - `synchronized`: Storage is in sync with Liveblocks servers.
      */
     getStorageStatus(): StorageStatus;
+    /**
+     * Start an attempt to connect the room (aka "enter" it). Calling
+     * `.connect()` only has an effect if the room is still in its idle initial
+     * state, or the room was explicitly disconnected, or reconnection attempts
+     * were stopped (for example, because the user isn't authorized to enter the
+     * room). Will be a no-op otherwise.
+     */
+    connect(): void;
+    /**
+     * Disconnect the room's connection to the Liveblocks server, if any. Puts
+     * the room back into an idle state. It will not do anything until either
+     * `.connect()` or `.reconnect()` is called.
+     *
+     * Only use this API if you wish to connect the room again at a later time.
+     * If you want to disconnect the room because you no longer need it, call
+     * `.destroy()` instead.
+     */
+    disconnect(): void;
     /**
      * Reconnect the room to the Liveblocks server by re-establishing a fresh
      * connection. If the room is not connected yet, initiate it.
@@ -1777,11 +1819,14 @@ declare type RoomInitializers<TPresence extends JsonObject, TStorage extends Lso
      */
     initialStorage?: TStorage | ((roomId: string) => TStorage);
     /**
-     * Whether or not the room connects to Liveblock servers. Default is true.
+     * Whether or not the room automatically connects to Liveblock servers.
+     * Default is true.
      *
      * Usually set to false when the client is used from the server to not call
      * the authentication endpoint or connect via WebSocket.
      */
+    autoConnect?: boolean;
+    /** @deprecated Renamed to `autoConnect` */
     shouldInitiallyConnect?: boolean;
 }>;
 
@@ -1804,16 +1849,43 @@ declare type Client = {
      */
     getRoom<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never>(roomId: string): Room<TPresence, TStorage, TUserMeta, TRoomEvent> | null;
     /**
+     * Enter a room.
+     * @param roomId The id of the room
+     * @param options Optional. You can provide initializers for the Presence or Storage when entering the Room.
+     * @returns The room and a leave function. Call the returned leave() function when you no longer need the room.
+     */
+    enterRoom<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never>(roomId: string, options: EnterOptions<TPresence, TStorage>): {
+        room: Room<TPresence, TStorage, TUserMeta, TRoomEvent>;
+        leave: () => void;
+    };
+    /**
+     * @deprecated - Prefer using {@link Client.enterRoom} instead.
+     *
      * Enters a room and returns it.
      * @param roomId The id of the room
      * @param options Optional. You can provide initializers for the Presence or Storage when entering the Room.
      */
     enter<TPresence extends JsonObject, TStorage extends LsonObject = LsonObject, TUserMeta extends BaseUserMeta = BaseUserMeta, TRoomEvent extends Json = never>(roomId: string, options: EnterOptions<TPresence, TStorage>): Room<TPresence, TStorage, TUserMeta, TRoomEvent>;
     /**
-     * Leaves a room.
+     * @deprecated - Prefer using {@link Client.enterRoom} and calling the returned leave function instead, which is safer.
+     *
+     * Forcefully leaves a room.
+     *
+     * Only call this if you know for sure there are no other "instances" of this
+     * room used elsewhere in your application. Force-leaving can trigger
+     * unexpected conditions in other parts of your application that may not
+     * expect this.
+     *
      * @param roomId The id of the room
      */
     leave(roomId: string): void;
+    /**
+     * Purges all cached auth tokens and reconnects all rooms that are still
+     * connected, if any.
+     *
+     * Call this whenever you log out a user in your application.
+     */
+    logout(): void;
 };
 declare type AuthEndpoint = string | ((room: string) => Promise<CustomAuthenticationResult>);
 /**
@@ -1823,6 +1895,7 @@ declare type AuthEndpoint = string | ((room: string) => Promise<CustomAuthentica
 declare type ClientOptions = {
     throttle?: number;
     lostConnectionTimeout?: number;
+    backgroundKeepAliveTimeout?: number;
     polyfills?: Polyfills;
     unstable_fallbackToHTTP?: boolean;
     /**
@@ -1882,6 +1955,7 @@ declare type ParentToChildNodeMap = Map<string, // Parent's node ID
 IdTuple<SerializedChild>[]>;
 
 declare function isLiveNode(value: unknown): value is LiveNode;
+declare function cloneLson<L extends Lson | undefined>(value: L): L;
 
 declare function lsonToJson(value: Lson): Json;
 declare function patchLiveObjectKey<O extends LsonObject, K extends keyof O, V extends Json>(liveObject: LiveObject<O>, key: K, prev?: V, next?: V): void;
@@ -2366,4 +2440,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, AsyncCache, AsyncState, AsyncStateError, AsyncStateInitial, AsyncStateLoading, AsyncStateResolved, AsyncStateSuccess, BaseAuthResult, BaseMetadata, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CommentBody, CommentBodyElement, CommentBodyLink, CommentBodyMention, CommentBodyParagraph, CommentBodyText, CommentData, CommentReaction, CommentsApi, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, CustomAuthenticationResult, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, EventSource, 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, RoomEventMessage, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ThreadData, ToImmutable, ToJson, UnsubscribeCallback, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, YDocUpdateServerMsg, asPos, assert, assertNever, b64decode, fancyConsole as console, createAsyncCache, createClient, createCommentsApi, deprecate, deprecateIf, detectDupes, errorIf, freeze, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, shallow, stringify, throwUsageError, toPlainLson, tryParseJson, withTimeout };
+export { AckOp, AsyncCache, AsyncState, AsyncStateError, AsyncStateInitial, AsyncStateLoading, AsyncStateResolved, AsyncStateSuccess, BaseAuthResult, BaseMetadata, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CommentBody, CommentBodyElement, CommentBodyLink, CommentBodyMention, CommentBodyParagraph, CommentBodyText, CommentData, CommentReaction, CommentsApi, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, CustomAuthenticationResult, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, EnterOptions, EventSource, 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, OthersEvent, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomEventMessage, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ThreadData, ToImmutable, ToJson, UnsubscribeCallback, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, YDocUpdateServerMsg, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, createAsyncCache, createClient, createCommentsApi, deprecate, deprecateIf, detectDupes, errorIf, freeze, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, shallow, stringify, throwUsageError, toPlainLson, tryParseJson, withTimeout };