@liveblocks/core 1.0.2-test5 → 1.0.6-test1

package/dist/index.d.ts

@@ -460,28 +460,6 @@ declare type ToJson<T extends Lson | LsonObject> = T extends Json ? T : T extend
     [K in KS]: ToJson<V>;
 } : never;
 
-/**
- * This type is used by clients to define the metadata for a user.
- */
-declare type BaseUserMeta = {
-    /**
-     * The id of the user that has been set in the authentication endpoint.
-     * Useful to get additional information about the connected user.
-     */
-    id?: string;
-    /**
-     * Additional user information that has been set in the authentication endpoint.
-     */
-    info?: Json;
-};
-
-declare type Callback<T> = (event: T) => void;
-declare type UnsubscribeCallback = () => void;
-declare type Observable<T> = {
-    subscribe(callback: Callback<T>): UnsubscribeCallback;
-    subscribeOnce(callback: Callback<T>): UnsubscribeCallback;
-};
-
 /**
  * This helper type is effectively a no-op, but will force TypeScript to
  * "evaluate" any named helper types in its definition. This can sometimes make
@@ -508,6 +486,28 @@ declare type Resolve<T> = T extends (...args: unknown[]) => unknown ? T : {
     [K in keyof T]: T[K];
 };
 
+/**
+ * This type is used by clients to define the metadata for a user.
+ */
+declare type BaseUserMeta = {
+    /**
+     * The id of the user that has been set in the authentication endpoint.
+     * Useful to get additional information about the connected user.
+     */
+    id?: string;
+    /**
+     * Additional user information that has been set in the authentication endpoint.
+     */
+    info?: Json;
+};
+
+declare type Callback<T> = (event: T) => void;
+declare type UnsubscribeCallback = () => void;
+declare type Observable<T> = {
+    subscribe(callback: Callback<T>): UnsubscribeCallback;
+    subscribeOnce(callback: Callback<T>): UnsubscribeCallback;
+};
+
 declare type AppOnlyAuthToken = {
     appId: string;
     roomId?: never;
@@ -685,27 +685,27 @@ declare type CustomEvent<TRoomEvent extends Json> = {
     event: TRoomEvent;
 };
 declare type Connection = {
-    state: "closed";
+    status: "closed";
 } | {
-    state: "authenticating";
+    status: "authenticating";
 } | {
-    state: "connecting";
+    status: "connecting";
     id: number;
     userId?: string;
     userInfo?: Json;
     isReadOnly: boolean;
 } | {
-    state: "open";
+    status: "open";
     id: number;
     userId?: string;
     userInfo?: Json;
     isReadOnly: boolean;
 } | {
-    state: "unavailable";
+    status: "unavailable";
 } | {
-    state: "failed";
+    status: "failed";
 };
-declare type ConnectionState = Connection["state"];
+declare type ConnectionStatus = Connection["status"];
 declare type StorageStatus = "not-loaded" | "loading" | "synchronizing" | "synchronized";
 interface History {
     /**
@@ -802,7 +802,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      * metadata and connection ID (from the auth server).
      */
     isSelfAware(): boolean;
-    getConnectionState(): ConnectionState;
+    getConnectionState(): ConnectionStatus;
     readonly subscribe: {
         /**
          * Subscribe to the current user presence updates.
@@ -858,7 +858,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
          * @returns Unsubscribe function.
          *
          */
-        (type: "connection", listener: Callback<ConnectionState>): () => void;
+        (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.
@@ -1014,7 +1014,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
             event: OthersEvent<TPresence, TUserMeta>;
         }>;
         error: Observable<Error>;
-        connection: Observable<ConnectionState>;
+        connection: Observable<ConnectionStatus>;
         storage: Observable<StorageUpdate[]>;
         history: Observable<HistoryEvent>;
         /**
@@ -1075,6 +1075,17 @@ declare type RoomInitializers<TPresence extends JsonObject, TStorage extends Lso
     shouldInitiallyConnect?: boolean;
 }>;
 
+declare type EnterOptions<TPresence extends JsonObject, TStorage extends LsonObject> = Resolve<RoomInitializers<TPresence, TStorage> & {
+    /**
+     * Only necessary when you’re using Liveblocks with React v17 or lower.
+     *
+     * If so, pass in a reference to `ReactDOM.unstable_batchedUpdates` here.
+     * This will allow Liveblocks to circumvent the so-called "zombie child
+     * problem". To learn more, see
+     * https://liveblocks.io/docs/guides/troubleshooting#stale-props-zombie-child
+     */
+    unstable_batchedUpdates?: (cb: () => void) => void;
+}>;
 declare type Client = {
     /**
      * Gets a room. Returns null if {@link Client.enter} has not been called previously.
@@ -1087,7 +1098,7 @@ declare type Client = {
      * @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: RoomInitializers<TPresence, TStorage>): Room<TPresence, TStorage, TUserMeta, TRoomEvent>;
+    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.
      * @param roomId The id of the room
@@ -1600,7 +1611,7 @@ declare type ClientToPanelMessage =
  | {
     msg: "room::sync::full";
     roomId: string;
-    status: ConnectionState;
+    status: ConnectionStatus;
     storage: readonly LsonTreeNode[] | null;
     me: UserTreeNode | null;
     others: readonly UserTreeNode[];
@@ -1611,7 +1622,7 @@ declare type ClientToPanelMessage =
  | {
     msg: "room::sync::partial";
     roomId: string;
-    status?: ConnectionState;
+    status?: ConnectionStatus;
     storage?: readonly LsonTreeNode[];
     me?: UserTreeNode;
     others?: readonly UserTreeNode[];
@@ -1662,4 +1673,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, AppOnlyAuthToken, AuthToken, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, ConnectionState, 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, assert, assertNever, b64decode, comparePosition, 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, 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, assert, assertNever, b64decode, comparePosition, createClient, deprecate, deprecateIf, errorIf, freeze, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRoomAuthToken, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, tryParseJson };