@liveblocks/client 0.18.0-beta0 → 0.18.0-beta3

package/{index-4e7d8cac.d.ts → index-29762efc.d.ts}

@@ -5,6 +5,18 @@ declare type Observable<T> = {
     subscribeOnce(callback: Callback<T>): UnsubscribeCallback;
 };
 
+declare type ReadonlyArrayWithLegacyMethods<T> = readonly T[] & {
+    /**
+     * @deprecated Prefer the normal .length property on arrays.
+     */
+    readonly count: number;
+    /**
+     * @deprecated Calling .toArray() is no longer needed
+     */
+    readonly toArray: () => readonly T[];
+};
+declare function asArrayWithLegacyMethods<T>(arr: readonly T[]): ReadonlyArrayWithLegacyMethods<T>;
+
 /**
  * The LiveMap class is similar to a JavaScript Map that is synchronized on all clients.
  * Keys should be a string, and values should be serializable to JSON.
@@ -452,16 +464,6 @@ declare type Client = {
      */
     leave(roomId: string): void;
 };
-declare type ReadonlyArrayWithLegacyMethods<T> = readonly T[] & {
-    /**
-     * @deprecated Prefer the normal .length property on arrays.
-     */
-    readonly count: number;
-    /**
-     * @deprecated Calling .toArray() is no longer needed
-     */
-    readonly toArray: () => readonly T[];
-};
 /**
  * Represents all the other users connected in the room. Treated as immutable.
  */
@@ -640,7 +642,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      */
     isSelfAware(): boolean;
     getConnectionState(): ConnectionState;
-    subscribe: {
+    readonly subscribe: {
         /**
          * Subscribe to the current user presence updates.
          *
@@ -744,7 +746,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
     /**
      * Room's history contains functions that let you undo and redo operation made on by the current client on the presence and storage.
      */
-    history: History;
+    readonly history: History;
     /**
      * Gets the current user.
      * Returns null if not it is not yet connected to the room.
@@ -759,14 +761,14 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      * @example
      * const presence = room.getPresence();
      */
-    getPresence: () => TPresence;
+    getPresence(): TPresence;
     /**
      * Gets all the other users in the room.
      *
      * @example
      * const others = room.getOthers();
      */
-    getOthers: () => Others<TPresence, TUserMeta>;
+    getOthers(): Others<TPresence, TUserMeta>;
     /**
      * Updates the presence of the current user. Only pass the properties you want to update. No need to send the full presence.
      * @param patch A partial object that contains the properties you want to update.
@@ -779,12 +781,12 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      * const presence = room.getPresence();
      * // presence is equivalent to { x: 0, y: 0 }
      */
-    updatePresence: (patch: Partial<TPresence>, options?: {
+    updatePresence(patch: Partial<TPresence>, options?: {
         /**
          * Whether or not the presence should have an impact on the undo/redo history.
          */
         addToHistory: boolean;
-    }) => void;
+    }): void;
     /**
      * Broadcasts an event to other users in the room. Event broadcasted to the room can be listened with {@link Room.subscribe}("event").
      * @param {any} event the event to broadcast. Should be serializable to JSON
@@ -800,7 +802,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      *   }
      * });
      */
-    broadcastEvent: (event: TRoomEvent, options?: BroadcastOptions) => void;
+    broadcastEvent(event: TRoomEvent, options?: BroadcastOptions): void;
     /**
      * Get the room's storage asynchronously.
      * The storage's root is a {@link LiveObject}.
@@ -808,7 +810,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      * @example
      * const { root } = await room.getStorage();
      */
-    getStorage: () => Promise<{
+    getStorage(): Promise<{
         root: LiveObject<TStorage>;
     }>;
     /**
@@ -819,7 +821,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      * const root = room.getStorageSnapshot();
      */
     getStorageSnapshot(): LiveObject<TStorage> | null;
-    events: {
+    readonly events: {
         customEvent: Observable<{
             connectionId: number;
             event: TRoomEvent;
@@ -852,7 +854,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
      *   room.updatePresence({ cursor: { x: 100, y: 100 }});
      * });
      */
-    batch: (fn: () => void) => void;
+    batch<T>(fn: () => T): T;
 };
 declare enum WebsocketCloseCodes {
     CLOSE_ABNORMAL = 1006,
@@ -865,4 +867,4 @@ declare enum WebsocketCloseCodes {
     CLOSE_WITHOUT_RETRY = 4999
 }
 
-export { BaseUserMeta as B, ClientOptions as C, History as H, Immutable as I, Json as J, LiveList as L, Others as O, Room as R, StorageUpdate as S, ToJson as T, User as U, WebsocketCloseCodes as W, Client as a, LiveMap as b, LiveObject as c, BroadcastOptions as d, ImmutableList as e, ImmutableMap as f, ImmutableObject as g, ImmutableRef as h, JsonObject as i, LiveStructure as j, Lson as k, LsonObject as l, LiveNode as m, Resolve as n, RoomInitializers as o, ToImmutable as p, isJsonArray as q, isJsonObject as r, isJsonScalar as s };
+export { BaseUserMeta as B, ClientOptions as C, History as H, Immutable as I, Json as J, LiveList as L, Others as O, Room as R, StorageUpdate as S, ToJson as T, User as U, WebsocketCloseCodes as W, Client as a, LiveMap as b, LiveObject as c, BroadcastOptions as d, ImmutableList as e, ImmutableMap as f, ImmutableObject as g, ImmutableRef as h, JsonObject as i, LiveStructure as j, Lson as k, LsonObject as l, asArrayWithLegacyMethods as m, LiveNode as n, Resolve as o, RoomInitializers as p, ToImmutable as q, isJsonArray as r, isJsonObject as s, isJsonScalar as t };

package/index.d.ts

@@ -1,5 +1,5 @@
-import { C as ClientOptions, a as Client } from './index-4e7d8cac.js';
-export { B as BaseUserMeta, d as BroadcastOptions, a as Client, H as History, I as Immutable, e as ImmutableList, f as ImmutableMap, g as ImmutableObject, h as ImmutableRef, J as Json, i as JsonObject, L as LiveList, b as LiveMap, c as LiveObject, j as LiveStructure, k as Lson, l as LsonObject, O as Others, R as Room, S as StorageUpdate, U as User } from './index-4e7d8cac.js';
+import { C as ClientOptions, a as Client } from './index-29762efc.js';
+export { B as BaseUserMeta, d as BroadcastOptions, a as Client, H as History, I as Immutable, e as ImmutableList, f as ImmutableMap, g as ImmutableObject, h as ImmutableRef, J as Json, i as JsonObject, L as LiveList, b as LiveMap, c as LiveObject, j as LiveStructure, k as Lson, l as LsonObject, O as Others, R as Room, S as StorageUpdate, U as User } from './index-29762efc.js';
 
 /**
  * Create a client that will be responsible to communicate with liveblocks servers.