@liveblocks/core 1.0.7 → 1.0.8

package/dist/index.d.ts

@@ -508,78 +508,54 @@ declare type Observable<T> = {
     subscribeOnce(callback: Callback<T>): UnsubscribeCallback;
 };
 
-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 enum ClientMsgCode {
-    UPDATE_PRESENCE = 100,
-    BROADCAST_EVENT = 103,
-    FETCH_STORAGE = 200,
-    UPDATE_STORAGE = 201
+interface IWebSocketEvent {
+    type: string;
+}
+interface IWebSocketCloseEvent extends IWebSocketEvent {
+    readonly code: number;
+    readonly wasClean: boolean;
+    readonly reason: string;
+}
+interface IWebSocketMessageEvent extends IWebSocketEvent {
+    readonly data: string | Buffer | ArrayBuffer | readonly Buffer[];
+}
+interface IWebSocketInstance {
+    readonly CONNECTING: number;
+    readonly OPEN: number;
+    readonly CLOSING: number;
+    readonly CLOSED: number;
+    readonly readyState: number;
+    addEventListener(type: "close", listener: (this: IWebSocketInstance, ev: IWebSocketCloseEvent) => unknown): void;
+    addEventListener(type: "message", listener: (this: IWebSocketInstance, ev: IWebSocketMessageEvent) => unknown): void;
+    addEventListener(type: "open" | "error", listener: (this: IWebSocketInstance, ev: IWebSocketEvent) => unknown): void;
+    removeEventListener(type: "close", listener: (this: IWebSocketInstance, ev: IWebSocketCloseEvent) => unknown): void;
+    removeEventListener(type: "message", listener: (this: IWebSocketInstance, ev: IWebSocketMessageEvent) => unknown): void;
+    removeEventListener(type: "open" | "error", listener: (this: IWebSocketInstance, ev: IWebSocketEvent) => unknown): void;
+    close(): void;
+    send(data: string): void;
 }
 /**
- * Messages that can be sent from the client to the server.
+ * Either the browser-based WebSocket API or Node.js' WebSocket API (from the
+ * 'ws' package).
+ *
+ * This type defines the minimal WebSocket API that Liveblocks needs from
+ * a WebSocket implementation, and is a minimal subset of the browser-based
+ * WebSocket APIs and Node.js' WebSocket API so that both implementations are
+ * assignable to this type.
  */
-declare type ClientMsg<TPresence extends JsonObject, TRoomEvent extends Json> = BroadcastEventClientMsg<TRoomEvent> | UpdatePresenceClientMsg<TPresence> | UpdateStorageClientMsg | FetchStorageClientMsg;
-declare type BroadcastEventClientMsg<TRoomEvent extends Json> = {
-    type: ClientMsgCode.BROADCAST_EVENT;
-    event: TRoomEvent;
-};
-declare type UpdatePresenceClientMsg<TPresence extends JsonObject> = {
-    readonly type: ClientMsgCode.UPDATE_PRESENCE;
-    /**
-     * Set this to any number to signify 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;
-    readonly data: TPresence;
-} | {
-    readonly type: ClientMsgCode.UPDATE_PRESENCE;
-    /**
-     * Absence of the `targetActor` field signifies that this is a Partial
-     * Presence™ "patch".
-     */
-    readonly targetActor?: undefined;
-    readonly data: Partial<TPresence>;
-};
-declare type UpdateStorageClientMsg = {
-    readonly type: ClientMsgCode.UPDATE_STORAGE;
-    readonly ops: Op[];
-};
-declare type FetchStorageClientMsg = {
-    readonly type: ClientMsgCode.FETCH_STORAGE;
-};
+interface IWebSocket {
+    new (address: string): IWebSocketInstance;
+}
+declare enum WebsocketCloseCodes {
+    CLOSE_ABNORMAL = 1006,
+    INVALID_MESSAGE_FORMAT = 4000,
+    NOT_ALLOWED = 4001,
+    MAX_NUMBER_OF_MESSAGES_PER_SECONDS = 4002,
+    MAX_NUMBER_OF_CONCURRENT_CONNECTIONS = 4003,
+    MAX_NUMBER_OF_MESSAGES_PER_DAY_PER_APP = 4004,
+    MAX_NUMBER_OF_CONCURRENT_CONNECTIONS_PER_ROOM = 4005,
+    CLOSE_WITHOUT_RETRY = 4999
+}
 
 declare type ReadonlyArrayWithLegacyMethods<T> = readonly T[] & {
     /**
@@ -638,48 +614,6 @@ declare type OthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUse
     type: "reset";
 };
 
-declare type JsonTreeNode = {
-    readonly type: "Json";
-    readonly id: string;
-    readonly key: string;
-    readonly payload: Json;
-};
-declare type LiveTreeNode<TName extends `Live${string}` = `Live${string}`> = {
-    readonly type: TName;
-    readonly id: string;
-    readonly key: string;
-    readonly payload: LsonTreeNode[];
-};
-declare type LsonTreeNode = LiveTreeNode | JsonTreeNode;
-declare type UserTreeNode = {
-    readonly type: "User";
-    readonly id: string;
-    readonly key: string;
-    readonly payload: {
-        readonly connectionId: number;
-        readonly id?: string;
-        readonly info?: Json;
-        readonly presence: JsonObject;
-        readonly isReadOnly: boolean;
-    };
-};
-declare type TreeNode = LsonTreeNode | UserTreeNode;
-
-type DevToolsTreeNode_JsonTreeNode = JsonTreeNode;
-type DevToolsTreeNode_LiveTreeNode<TName extends `Live${string}` = `Live${string}`> = LiveTreeNode<TName>;
-type DevToolsTreeNode_LsonTreeNode = LsonTreeNode;
-type DevToolsTreeNode_UserTreeNode = UserTreeNode;
-type DevToolsTreeNode_TreeNode = TreeNode;
-declare namespace DevToolsTreeNode {
-  export {
-    DevToolsTreeNode_JsonTreeNode as JsonTreeNode,
-    DevToolsTreeNode_LiveTreeNode as LiveTreeNode,
-    DevToolsTreeNode_LsonTreeNode as LsonTreeNode,
-    DevToolsTreeNode_UserTreeNode as UserTreeNode,
-    DevToolsTreeNode_TreeNode as TreeNode,
-  };
-}
-
 declare type CustomEvent<TRoomEvent extends Json> = {
     connectionId: number;
     event: TRoomEvent;
@@ -792,6 +726,128 @@ declare type BroadcastOptions = {
      */
     shouldQueueEventIfNotReady: boolean;
 };
+declare type SubscribeFn<TPresence extends JsonObject, _TStorage extends LsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = {
+    /**
+     * Subscribe to the current user presence updates.
+     *
+     * @param listener the callback that is called every time the current user presence is updated with {@link Room.updatePresence}.
+     *
+     * @returns Unsubscribe function.
+     *
+     * @example
+     * room.subscribe("my-presence", (presence) => {
+     *   // Do something
+     * });
+     */
+    (type: "my-presence", listener: Callback<TPresence>): () => void;
+    /**
+     * Subscribe to the other users updates.
+     *
+     * @param listener the callback that is called when a user enters or leaves the room or when a user update its presence.
+     *
+     * @returns Unsubscribe function.
+     *
+     * @example
+     * room.subscribe("others", (others) => {
+     *   // Do something
+     * });
+     *
+     */
+    (type: "others", listener: (others: Others<TPresence, TUserMeta>, event: OthersEvent<TPresence, TUserMeta>) => void): () => void;
+    /**
+     * Subscribe to events broadcasted by {@link Room.broadcastEvent}
+     *
+     * @param listener the callback that is called when a user calls {@link Room.broadcastEvent}
+     *
+     * @returns Unsubscribe function.
+     *
+     * @example
+     * room.subscribe("event", ({ event, connectionId }) => {
+     *   // Do something
+     * });
+     *
+     */
+    (type: "event", listener: Callback<CustomEvent<TRoomEvent>>): () => void;
+    /**
+     * Subscribe to errors thrown in the room.
+     *
+     * @returns Unsubscribe function.
+     *
+     */
+    (type: "error", listener: ErrorCallback): () => void;
+    /**
+     * Subscribe to connection state updates.
+     *
+     * @returns Unsubscribe function.
+     *
+     */
+    (type: "connection", listener: Callback<ConnectionStatus>): () => void;
+    /**
+     * Subscribes to changes made on a Live structure. Returns an unsubscribe function.
+     * In a future version, we will also expose what exactly changed in the Live structure.
+     *
+     * @param callback The callback this called when the Live structure changes.
+     *
+     * @returns Unsubscribe function.
+     *
+     * @example
+     * const liveMap = new LiveMap();  // Could also be LiveList or LiveObject
+     * const unsubscribe = room.subscribe(liveMap, (liveMap) => { });
+     * unsubscribe();
+     */
+    <L extends LiveStructure>(liveStructure: L, callback: (node: L) => void): () => void;
+    /**
+     * Subscribes to changes made on a Live structure and all the nested data
+     * structures. Returns an unsubscribe function. In a future version, we
+     * will also expose what exactly changed in the Live structure.
+     *
+     * @param callback The callback this called when the Live structure, or any
+     * of its nested values, changes.
+     *
+     * @returns Unsubscribe function.
+     *
+     * @example
+     * const liveMap = new LiveMap();  // Could also be LiveList or LiveObject
+     * const unsubscribe = room.subscribe(liveMap, (updates) => { }, { isDeep: true });
+     * unsubscribe();
+     */
+    <L extends LiveStructure>(liveStructure: L, callback: StorageCallback, options: {
+        isDeep: true;
+    }): () => void;
+    /**
+     * Subscribe to the current user's history changes.
+     *
+     * @returns Unsubscribe function.
+     *
+     * @example
+     * room.subscribe("history", ({ canUndo, canRedo }) => {
+     *   // Do something
+     * });
+     */
+    (type: "history", listener: Callback<HistoryEvent>): () => void;
+    /**
+     * Subscribe to storage status changes.
+     *
+     * @returns Unsubscribe function.
+     *
+     * @example
+     * room.subscribe("storage-status", (status) => {
+     *   switch(status) {
+     *      case "not-loaded":
+     *        break;
+     *      case "loading":
+     *        break;
+     *      case "synchronizing":
+     *        break;
+     *      case "synchronized":
+     *        break;
+     *      default:
+     *        break;
+     *   }
+     * });
+     */
+    (type: "storage-status", listener: Callback<StorageStatus>): () => void;
+};
 declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = {
     /**
      * The id of the room.
@@ -803,128 +859,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      */
     isSelfAware(): boolean;
     getConnectionState(): ConnectionStatus;
-    readonly subscribe: {
-        /**
-         * Subscribe to the current user presence updates.
-         *
-         * @param listener the callback that is called every time the current user presence is updated with {@link Room.updatePresence}.
-         *
-         * @returns Unsubscribe function.
-         *
-         * @example
-         * room.subscribe("my-presence", (presence) => {
-         *   // Do something
-         * });
-         */
-        (type: "my-presence", listener: Callback<TPresence>): () => void;
-        /**
-         * Subscribe to the other users updates.
-         *
-         * @param listener the callback that is called when a user enters or leaves the room or when a user update its presence.
-         *
-         * @returns Unsubscribe function.
-         *
-         * @example
-         * room.subscribe("others", (others) => {
-         *   // Do something
-         * });
-         *
-         */
-        (type: "others", listener: (others: Others<TPresence, TUserMeta>, event: OthersEvent<TPresence, TUserMeta>) => void): () => void;
-        /**
-         * Subscribe to events broadcasted by {@link Room.broadcastEvent}
-         *
-         * @param listener the callback that is called when a user calls {@link Room.broadcastEvent}
-         *
-         * @returns Unsubscribe function.
-         *
-         * @example
-         * room.subscribe("event", ({ event, connectionId }) => {
-         *   // Do something
-         * });
-         *
-         */
-        (type: "event", listener: Callback<CustomEvent<TRoomEvent>>): () => void;
-        /**
-         * Subscribe to errors thrown in the room.
-         *
-         * @returns Unsubscribe function.
-         *
-         */
-        (type: "error", listener: ErrorCallback): () => void;
-        /**
-         * Subscribe to connection state updates.
-         *
-         * @returns Unsubscribe function.
-         *
-         */
-        (type: "connection", listener: Callback<ConnectionStatus>): () => void;
-        /**
-         * Subscribes to changes made on a Live structure. Returns an unsubscribe function.
-         * In a future version, we will also expose what exactly changed in the Live structure.
-         *
-         * @param callback The callback this called when the Live structure changes.
-         *
-         * @returns Unsubscribe function.
-         *
-         * @example
-         * const liveMap = new LiveMap();  // Could also be LiveList or LiveObject
-         * const unsubscribe = room.subscribe(liveMap, (liveMap) => { });
-         * unsubscribe();
-         */
-        <L extends LiveStructure>(liveStructure: L, callback: (node: L) => void): () => void;
-        /**
-         * Subscribes to changes made on a Live structure and all the nested data
-         * structures. Returns an unsubscribe function. In a future version, we
-         * will also expose what exactly changed in the Live structure.
-         *
-         * @param callback The callback this called when the Live structure, or any
-         * of its nested values, changes.
-         *
-         * @returns Unsubscribe function.
-         *
-         * @example
-         * const liveMap = new LiveMap();  // Could also be LiveList or LiveObject
-         * const unsubscribe = room.subscribe(liveMap, (updates) => { }, { isDeep: true });
-         * unsubscribe();
-         */
-        <L extends LiveStructure>(liveStructure: L, callback: StorageCallback, options: {
-            isDeep: true;
-        }): () => void;
-        /**
-         * Subscribe to the current user's history changes.
-         *
-         * @returns Unsubscribe function.
-         *
-         * @example
-         * room.subscribe("history", ({ canUndo, canRedo }) => {
-         *   // Do something
-         * });
-         */
-        (type: "history", listener: Callback<HistoryEvent>): () => void;
-        /**
-         * Subscribe to storage status changes.
-         *
-         * @returns Unsubscribe function.
-         *
-         * @example
-         * room.subscribe("storage-status", (status) => {
-         *   switch(status) {
-         *      case "not-loaded":
-         *        break;
-         *      case "loading":
-         *        break;
-         *      case "synchronizing":
-         *        break;
-         *      case "synchronized":
-         *        break;
-         *      default:
-         *        break;
-         *   }
-         * });
-         */
-        (type: "storage-status", listener: Callback<StorageStatus>): () => void;
-    };
+    readonly subscribe: SubscribeFn<TPresence, TStorage, TUserMeta, TRoomEvent>;
     /**
      * Room's history contains functions that let you undo and redo operation made on by the current client on the presence and storage.
      */
@@ -1004,24 +939,25 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      */
     getStorageSnapshot(): LiveObject<TStorage> | null;
     readonly events: {
-        customEvent: Observable<{
+        readonly customEvent: Observable<{
             connectionId: number;
             event: TRoomEvent;
         }>;
-        me: Observable<TPresence>;
-        others: Observable<{
+        readonly me: Observable<TPresence>;
+        readonly others: Observable<{
             others: Others<TPresence, TUserMeta>;
             event: OthersEvent<TPresence, TUserMeta>;
         }>;
-        error: Observable<Error>;
-        connection: Observable<ConnectionStatus>;
-        storage: Observable<StorageUpdate[]>;
-        history: Observable<HistoryEvent>;
+        readonly error: Observable<Error>;
+        readonly connection: Observable<ConnectionStatus>;
+        readonly storage: Observable<StorageUpdate[]>;
+        readonly history: Observable<HistoryEvent>;
         /**
          * Subscribe to the storage loaded event. Will fire at most once during the
          * lifetime of a Room.
          */
-        storageDidLoad: Observable<void>;
+        readonly storageDidLoad: Observable<void>;
+        readonly storageStatus: Observable<StorageStatus>;
     };
     /**
      * Batches modifications made during the given function.
@@ -1054,7 +990,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
 declare type Polyfills = {
     atob?: (data: string) => string;
     fetch?: typeof fetch;
-    WebSocket?: any;
+    WebSocket?: IWebSocket;
 };
 declare type RoomInitializers<TPresence extends JsonObject, TStorage extends LsonObject> = Resolve<{
     /**
@@ -1329,6 +1265,79 @@ declare function asPos(str: string): Pos;
  */
 declare function shallow(a: unknown, b: unknown): boolean;
 
+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 enum ClientMsgCode {
+    UPDATE_PRESENCE = 100,
+    BROADCAST_EVENT = 103,
+    FETCH_STORAGE = 200,
+    UPDATE_STORAGE = 201
+}
+/**
+ * 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 BroadcastEventClientMsg<TRoomEvent extends Json> = {
+    type: ClientMsgCode.BROADCAST_EVENT;
+    event: TRoomEvent;
+};
+declare type UpdatePresenceClientMsg<TPresence extends JsonObject> = {
+    readonly type: ClientMsgCode.UPDATE_PRESENCE;
+    /**
+     * Set this to any number to signify 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;
+    readonly data: TPresence;
+} | {
+    readonly type: ClientMsgCode.UPDATE_PRESENCE;
+    /**
+     * Absence of the `targetActor` field signifies that this is a Partial
+     * Presence™ "patch".
+     */
+    readonly targetActor?: undefined;
+    readonly data: Partial<TPresence>;
+};
+declare type UpdateStorageClientMsg = {
+    readonly type: ClientMsgCode.UPDATE_STORAGE;
+    readonly ops: Op[];
+};
+declare type FetchStorageClientMsg = {
+    readonly type: ClientMsgCode.FETCH_STORAGE;
+};
+
 declare type IdTuple<T> = [id: string, value: T];
 declare enum CrdtType {
     OBJECT = 0,
@@ -1594,15 +1603,46 @@ declare type PlainLsonList = {
 };
 declare type PlainLson = PlainLsonObject | PlainLsonMap | PlainLsonList | Json;
 
-declare enum WebsocketCloseCodes {
-    CLOSE_ABNORMAL = 1006,
-    INVALID_MESSAGE_FORMAT = 4000,
-    NOT_ALLOWED = 4001,
-    MAX_NUMBER_OF_MESSAGES_PER_SECONDS = 4002,
-    MAX_NUMBER_OF_CONCURRENT_CONNECTIONS = 4003,
-    MAX_NUMBER_OF_MESSAGES_PER_DAY_PER_APP = 4004,
-    MAX_NUMBER_OF_CONCURRENT_CONNECTIONS_PER_ROOM = 4005,
-    CLOSE_WITHOUT_RETRY = 4999
+declare type JsonTreeNode = {
+    readonly type: "Json";
+    readonly id: string;
+    readonly key: string;
+    readonly payload: Json;
+};
+declare type LiveTreeNode<TName extends `Live${string}` = `Live${string}`> = {
+    readonly type: TName;
+    readonly id: string;
+    readonly key: string;
+    readonly payload: LsonTreeNode[];
+};
+declare type LsonTreeNode = LiveTreeNode | JsonTreeNode;
+declare type UserTreeNode = {
+    readonly type: "User";
+    readonly id: string;
+    readonly key: string;
+    readonly payload: {
+        readonly connectionId: number;
+        readonly id?: string;
+        readonly info?: Json;
+        readonly presence: JsonObject;
+        readonly isReadOnly: boolean;
+    };
+};
+declare type TreeNode = LsonTreeNode | UserTreeNode;
+
+type DevToolsTreeNode_JsonTreeNode = JsonTreeNode;
+type DevToolsTreeNode_LiveTreeNode<TName extends `Live${string}` = `Live${string}`> = LiveTreeNode<TName>;
+type DevToolsTreeNode_LsonTreeNode = LsonTreeNode;
+type DevToolsTreeNode_UserTreeNode = UserTreeNode;
+type DevToolsTreeNode_TreeNode = TreeNode;
+declare namespace DevToolsTreeNode {
+  export {
+    DevToolsTreeNode_JsonTreeNode as JsonTreeNode,
+    DevToolsTreeNode_LiveTreeNode as LiveTreeNode,
+    DevToolsTreeNode_LsonTreeNode as LsonTreeNode,
+    DevToolsTreeNode_UserTreeNode as UserTreeNode,
+    DevToolsTreeNode_TreeNode as TreeNode,
+  };
 }
 
 /**
@@ -1739,4 +1779,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, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveNode, LiveObject, 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, 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, FetchStorageClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveNode, LiveObject, 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, tryParseJson };

package/dist/index.js

@@ -117,7 +117,7 @@ var onMessageFromPanel = eventSource.observable;
 // src/devtools/index.ts
 var VERSION = true ? (
   /* istanbul ignore next */
-  "1.0.7"
+  "1.0.8"
 ) : "dev";
 var _devtoolsSetupHasRun = false;
 function setupDevTools(getAllRooms) {
@@ -3237,7 +3237,7 @@ var DerivedRef = class extends ImmutableRef {
   }
 };
 
-// src/types/WebsocketCloseCodes.ts
+// src/types/IWebSocket.ts
 var WebsocketCloseCodes = /* @__PURE__ */ ((WebsocketCloseCodes2) => {
   WebsocketCloseCodes2[WebsocketCloseCodes2["CLOSE_ABNORMAL"] = 1006] = "CLOSE_ABNORMAL";
   WebsocketCloseCodes2[WebsocketCloseCodes2["INVALID_MESSAGE_FORMAT"] = 4e3] = "INVALID_MESSAGE_FORMAT";
@@ -3273,8 +3273,10 @@ function userToTreeNode(key, user) {
     payload: user
   };
 }
-function makeStateMachine(config, initialPresence, initialStorage) {
+function createRoom(options, config) {
   var _a;
+  const initialPresence = typeof options.initialPresence === "function" ? options.initialPresence(config.roomId) : options.initialPresence;
+  const initialStorage = typeof options.initialStorage === "function" ? options.initialStorage(config.roomId) : options.initialStorage;
   const context = {
     token: null,
     lastConnectionId: null,
@@ -3385,7 +3387,7 @@ function makeStateMachine(config, initialPresence, initialStorage) {
         authenticationSuccess(prevToken.parsed, socket);
         return void 0;
       } else {
-        return auth(config.roomId).then(({ token }) => {
+        void auth(config.roomId).then(({ token }) => {
           if (context.connection.current.status !== "authenticating") {
             return;
           }
@@ -3398,13 +3400,16 @@ function makeStateMachine(config, initialPresence, initialStorage) {
             er instanceof Error ? er : new Error(String(er))
           )
         );
+        return void 0;
       }
     },
     send(messageOrMessages) {
       if (context.socket === null) {
         throw new Error("Can't send message if socket is null");
       }
-      context.socket.send(JSON.stringify(messageOrMessages));
+      if (context.socket.readyState === context.socket.OPEN) {
+        context.socket.send(JSON.stringify(messageOrMessages));
+      }
     },
     scheduleFlush: (delay) => setTimeout(tryFlushing, delay),
     scheduleReconnect: (delay) => setTimeout(connect, delay),
@@ -3632,7 +3637,7 @@ function makeStateMachine(config, initialPresence, initialStorage) {
     updateConnection({ status: "authenticating" }, batchUpdates);
     effects.authenticate(auth, createWebSocket);
   }
-  function updatePresence(patch, options) {
+  function updatePresence(patch, options2) {
     const oldValues = {};
     if (context.buffer.me === null) {
       context.buffer.me = {
@@ -3650,7 +3655,7 @@ function makeStateMachine(config, initialPresence, initialStorage) {
     }
     context.me.patch(patch);
     if (context.activeBatch) {
-      if (options == null ? void 0 : options.addToHistory) {
+      if (options2 == null ? void 0 : options2.addToHistory) {
         context.activeBatch.reverseOps.unshift({
           type: "presence",
           data: oldValues
@@ -3660,7 +3665,7 @@ function makeStateMachine(config, initialPresence, initialStorage) {
     } else {
       tryFlushing();
       batchUpdates(() => {
-        if (options == null ? void 0 : options.addToHistory) {
+        if (options2 == null ? void 0 : options2.addToHistory) {
           addToUndoStack(
             [{ type: "presence", data: oldValues }],
             doNotBatchUpdates
@@ -3824,6 +3829,9 @@ function makeStateMachine(config, initialPresence, initialStorage) {
       clearTimeout(context.timers.pongTimeout);
       return;
     }
+    if (typeof event.data !== "string") {
+      return;
+    }
     const messages = parseServerMessages(event.data);
     if (messages === null || messages.length === 0) {
       return;
@@ -4116,10 +4124,10 @@ ${Array.from(traces).join("\n\n")}`
     }
     return messages;
   }
-  function broadcastEvent(event, options = {
+  function broadcastEvent(event, options2 = {
     shouldQueueEventIfNotReady: false
   }) {
-    if (context.socket === null && !options.shouldQueueEventIfNotReady) {
+    if (context.socket === null && !options2.shouldQueueEventIfNotReady) {
       return;
     }
     context.buffer.messages.push({
@@ -4150,7 +4158,7 @@ ${Array.from(traces).join("\n\n")}`
     if (root !== void 0) {
       return root;
     } else {
-      startLoadingStorage();
+      void startLoadingStorage();
       return null;
     }
   }
@@ -4256,7 +4264,7 @@ ${Array.from(traces).join("\n\n")}`
       _addToRealUndoStack(historyOps, batchUpdates);
     }
   }
-  function simulateSocketClose() {
+  function simulateCloseWebsocket() {
     if (context.socket) {
       context.socket = null;
     }
@@ -4285,119 +4293,75 @@ ${Array.from(traces).join("\n\n")}`
     context.others,
     (others) => others.map((other, index) => userToTreeNode(`Other ${index}`, other))
   );
+  const events = {
+    customEvent: eventHub.customEvent.observable,
+    others: eventHub.others.observable,
+    me: eventHub.me.observable,
+    error: eventHub.error.observable,
+    connection: eventHub.connection.observable,
+    storage: eventHub.storage.observable,
+    history: eventHub.history.observable,
+    storageDidLoad: eventHub.storageDidLoad.observable,
+    storageStatus: eventHub.storageStatus.observable
+  };
   return {
-    // Internal
-    get state() {
-      return context;
+    /* NOTE: Exposing __internal here only to allow testing implementation details in unit tests */
+    __internal: {
+      get buffer() {
+        return context.buffer;
+      },
+      // prettier-ignore
+      get numRetries() {
+        return context.numRetries;
+      },
+      // prettier-ignore
+      onClose,
+      onMessage,
+      authenticationSuccess,
+      onNavigatorOnline,
+      simulateCloseWebsocket,
+      simulateSendCloseEvent,
+      onVisibilityChange,
+      getUndoStack: () => context.undoStack,
+      getItemsCount: () => context.nodes.size,
+      connect,
+      disconnect,
+      // Support for the Liveblocks browser extension
+      getSelf_forDevTools: () => selfAsTreeNode.current,
+      getOthers_forDevTools: () => others_forDevTools.current
     },
-    onClose,
-    onMessage,
-    authenticationSuccess,
-    heartbeat,
-    onNavigatorOnline,
-    // Internal DevTools
-    simulateSocketClose,
-    simulateSendCloseEvent,
-    onVisibilityChange,
-    getUndoStack: () => context.undoStack,
-    getItemsCount: () => context.nodes.size,
-    // Core
-    connect,
-    disconnect,
+    id: config.roomId,
+    subscribe: makeClassicSubscribeFn(events),
     reconnect,
     // Presence
     updatePresence,
     broadcastEvent,
     // Storage
     batch,
-    undo,
-    redo,
-    canUndo,
-    canRedo,
-    pauseHistory,
-    resumeHistory,
+    history: {
+      undo,
+      redo,
+      canUndo,
+      canRedo,
+      pause: pauseHistory,
+      resume: resumeHistory
+    },
     getStorage,
     getStorageSnapshot,
     getStorageStatus,
-    events: {
-      customEvent: eventHub.customEvent.observable,
-      others: eventHub.others.observable,
-      me: eventHub.me.observable,
-      error: eventHub.error.observable,
-      connection: eventHub.connection.observable,
-      storage: eventHub.storage.observable,
-      history: eventHub.history.observable,
-      storageDidLoad: eventHub.storageDidLoad.observable,
-      storageStatus: eventHub.storageStatus.observable
-    },
+    events,
     // Core
     getConnectionState: () => context.connection.current.status,
     isSelfAware: () => isConnectionSelfAware(context.connection.current),
     getSelf: () => self.current,
     // Presence
     getPresence: () => context.me.current,
-    getOthers: () => context.others.current,
-    // Support for the Liveblocks browser extension
-    getSelf_forDevTools: () => selfAsTreeNode.current,
-    getOthers_forDevTools: () => others_forDevTools.current
+    getOthers: () => context.others.current
   };
 }
-function createRoom(options, config) {
-  const { initialPresence, initialStorage } = options;
-  const machine = makeStateMachine(
-    config,
-    typeof initialPresence === "function" ? initialPresence(config.roomId) : initialPresence,
-    typeof initialStorage === "function" ? initialStorage(config.roomId) : initialStorage
-  );
-  const room = {
-    id: config.roomId,
-    /////////////
-    // Core    //
-    /////////////
-    getConnectionState: machine.getConnectionState,
-    isSelfAware: machine.isSelfAware,
-    getSelf: machine.getSelf,
-    reconnect: machine.reconnect,
-    subscribe: makeClassicSubscribeFn(machine),
-    //////////////
-    // Presence //
-    //////////////
-    getPresence: machine.getPresence,
-    updatePresence: machine.updatePresence,
-    getOthers: machine.getOthers,
-    broadcastEvent: machine.broadcastEvent,
-    //////////////
-    // Storage  //
-    //////////////
-    getStorage: machine.getStorage,
-    getStorageSnapshot: machine.getStorageSnapshot,
-    getStorageStatus: machine.getStorageStatus,
-    events: machine.events,
-    batch: machine.batch,
-    history: {
-      undo: machine.undo,
-      redo: machine.redo,
-      canUndo: machine.canUndo,
-      canRedo: machine.canRedo,
-      pause: machine.pauseHistory,
-      resume: machine.resumeHistory
-    },
-    __internal: {
-      connect: machine.connect,
-      disconnect: machine.disconnect,
-      onNavigatorOnline: machine.onNavigatorOnline,
-      onVisibilityChange: machine.onVisibilityChange,
-      simulateCloseWebsocket: machine.simulateSocketClose,
-      simulateSendCloseEvent: machine.simulateSendCloseEvent,
-      getSelf_forDevTools: machine.getSelf_forDevTools,
-      getOthers_forDevTools: machine.getOthers_forDevTools
-    }
-  };
-  return room;
-}
-function makeClassicSubscribeFn(machine) {
+function makeClassicSubscribeFn(events) {
   function subscribeToLiveStructureDeeply(node, callback) {
-    return machine.events.storage.subscribe((updates) => {
+    return events.storage.subscribe((updates) => {
       const relatedUpdates = updates.filter(
         (update) => isSameNodeOrChildOf(update.node, node)
       );
@@ -4407,7 +4371,7 @@ function makeClassicSubscribeFn(machine) {
     });
   }
   function subscribeToLiveStructureShallowly(node, callback) {
-    return machine.events.storage.subscribe((updates) => {
+    return events.storage.subscribe((updates) => {
       for (const update of updates) {
         if (update.node._id === node._id) {
           callback(update.node);
@@ -4423,33 +4387,31 @@ function makeClassicSubscribeFn(machine) {
       const callback = second;
       switch (first) {
         case "event":
-          return machine.events.customEvent.subscribe(
+          return events.customEvent.subscribe(
             callback
           );
         case "my-presence":
-          return machine.events.me.subscribe(callback);
+          return events.me.subscribe(callback);
         case "others": {
           const cb = callback;
-          return machine.events.others.subscribe(
+          return events.others.subscribe(
             ({ others, event }) => cb(others, event)
           );
         }
         case "error":
-          return machine.events.error.subscribe(callback);
+          return events.error.subscribe(callback);
         case "connection":
-          return machine.events.connection.subscribe(
+          return events.connection.subscribe(
             callback
           );
         case "storage":
-          return machine.events.storage.subscribe(
+          return events.storage.subscribe(
             callback
           );
         case "history":
-          return machine.events.history.subscribe(
-            callback
-          );
+          return events.history.subscribe(callback);
         case "storage-status":
-          return machine.events.storageStatus.subscribe(
+          return events.storageStatus.subscribe(
             callback
           );
         default:
@@ -4459,7 +4421,7 @@ function makeClassicSubscribeFn(machine) {
     if (second === void 0 || typeof first === "function") {
       if (typeof first === "function") {
         const storageCallback = first;
-        return machine.events.storage.subscribe(storageCallback);
+        return events.storage.subscribe(storageCallback);
       } else {
         throw new Error("Please specify a listener callback");
       }
@@ -4474,7 +4436,7 @@ function makeClassicSubscribeFn(machine) {
         return subscribeToLiveStructureShallowly(node, nodeCallback);
       }
     }
-    throw new Error(`"${first}" is not a valid event name`);
+    throw new Error(`"${String(first)}" is not a valid event name`);
   }
   return subscribe;
 }
@@ -4501,7 +4463,7 @@ function prepareCreateWebSocket(liveblocksServer, WebSocketPolyfill) {
       // @ts-ignore (__PACKAGE_VERSION__ will be injected by the build script)
       true ? (
         /* istanbul ignore next */
-        "1.0.7"
+        "1.0.8"
       ) : "dev"}`
     );
   };
@@ -4567,7 +4529,9 @@ function fetchAuthEndpoint(fetch2, endpoint, body) {
       data = yield res.json();
     } catch (er) {
       throw new AuthenticationError(
-        `Expected a JSON response when doing a POST request on "${endpoint}". ${er}`
+        `Expected a JSON response when doing a POST request on "${endpoint}". ${String(
+          er
+        )}`
       );
     }
     if (!isPlainObject(data) || typeof data.token !== "string") {
@@ -4591,6 +4555,10 @@ var AuthenticationError = class extends Error {
 var MIN_THROTTLE = 16;
 var MAX_THROTTLE = 1e3;
 var DEFAULT_THROTTLE = 100;
+function getServerFromClientOptions(clientOptions) {
+  const rawOptions = clientOptions;
+  return typeof rawOptions.liveblocksServer === "string" ? rawOptions.liveblocksServer : "wss://api.liveblocks.io/v6";
+}
 function createClient(options) {
   const clientOptions = options;
   const throttleDelay = getThrottleDelayFromOptions(clientOptions);
@@ -4619,11 +4587,7 @@ function createClient(options) {
         throttleDelay,
         polyfills: clientOptions.polyfills,
         unstable_batchedUpdates: options2 == null ? void 0 : options2.unstable_batchedUpdates,
-        liveblocksServer: (
-          // TODO Patch this using public but marked internal fields?
-          // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          (clientOptions == null ? void 0 : clientOptions.liveblocksServer) || "wss://api.liveblocks.io/v6"
-        ),
+        liveblocksServer: getServerFromClientOptions(clientOptions),
         authentication: prepareAuthentication(clientOptions, roomId)
       }
     );
@@ -4864,7 +4828,9 @@ function patchLiveObjectKey(liveObject, key, prev, next) {
     const nonSerializableValue = findNonSerializableValue(next);
     if (nonSerializableValue) {
       error(
-        `New state path: '${nonSerializableValue.path}' value: '${nonSerializableValue.value}' is not serializable.
+        `New state path: '${nonSerializableValue.path}' value: '${String(
+          nonSerializableValue.value
+        )}' is not serializable.
 Only serializable value can be synced with Liveblocks.`
       );
       return;
@@ -4927,7 +4893,7 @@ function legacy_patchImmutableNode(state, path, update) {
   if (pathItem === void 0) {
     switch (update.type) {
       case "LiveObject": {
-        if (state === null || typeof state !== "object" || Array.isArray(state)) {
+        if (!isJsonObject(state)) {
           throw new Error(
             "Internal: received update on LiveObject but state was not an object"
           );
@@ -4993,7 +4959,7 @@ function legacy_patchImmutableNode(state, path, update) {
         return newState;
       }
       case "LiveMap": {
-        if (state === null || typeof state !== "object" || Array.isArray(state)) {
+        if (!isJsonObject(state)) {
           throw new Error(
             "Internal: received update on LiveMap but state was not an object"
           );
@@ -5021,12 +4987,13 @@ function legacy_patchImmutableNode(state, path, update) {
       update
     );
     return newArray;
-  } else if (state !== null && typeof state === "object") {
+  } else if (isJsonObject(state)) {
     const node = state[pathItem];
     if (node === void 0) {
       return state;
     } else {
-      return __spreadProps(__spreadValues({}, state), {
+      const stateAsObj = state;
+      return __spreadProps(__spreadValues({}, stateAsObj), {
         [pathItem]: legacy_patchImmutableNode(node, path, update)
       });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/core",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Shared code and foundational internals for Liveblocks",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -23,6 +23,7 @@
     "format": "eslint --fix src/; prettier --write src/",
     "lint": "eslint src/",
     "test": "jest --silent --verbose --color=always",
+    "test:types": "tsd",
     "test:watch": "jest --silent --verbose --color=always --watch",
     "test:e2e": "jest --silent --verbose --color=always --config=./jest.config.e2e.js",
     "test:deps": "depcruise src --exclude __tests__ --config",