@liveblocks/client 0.17.11 → 0.18.0-beta2

package/index.mjs

@@ -5,3 +5,4 @@ export const LiveList = mod.LiveList;
 export const LiveMap = mod.LiveMap;
 export const LiveObject = mod.LiveObject;
 export const createClient = mod.createClient;
+export const shallow = mod.shallow;

package/internal.d.ts

@@ -1,5 +1,5 @@
-import { e as JsonObject, J as Json, B as BaseUserMeta, g as Lson, h as LsonObject, c as LiveObject, S as StorageUpdate } from './index-0007883d.js';
-export { i as LiveNode, j as Resolve, k as RoomInitializers, W as WebsocketCloseCodes, l as isJsonArray, m as isJsonObject, n as isJsonScalar } from './index-0007883d.js';
+import { i as JsonObject, J as Json, B as BaseUserMeta, k as Lson, l as LsonObject, c as LiveObject, S as StorageUpdate } from './index-60aa9677.js';
+export { n as LiveNode, o as Resolve, p as RoomInitializers, q as ToImmutable, T as ToJson, W as WebsocketCloseCodes, m as asArrayWithLegacyMethods, r as isJsonArray, s as isJsonObject, t as isJsonScalar } from './index-60aa9677.js';
 
 declare enum OpCode {
     INIT = 0,
@@ -219,18 +219,40 @@ declare type UpdatePresenceServerMsg<TPresence extends JsonObject> = {
      * The User whose Presence has changed.
      */
     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".
+     */
+    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.
      */
     data: TPresence;
+} | {
+    type: ServerMsgCode.UPDATE_PRESENCE;
+    /**
+     * The User whose Presence has changed.
+     */
+    actor: number;
     /**
-     * If this message was sent in response to a newly joined user, this field
-     * indicates which client this message is for. Other existing clients may
-     * ignore this message if this message isn't targeted for them.
+     * Not set for partial presence updates.
      */
-    targetActor?: number;
+    targetActor?: undefined;
+    /**
+     * A partial Presence patch to apply to the User. It will only contain the
+     * fields that have changed since the last broadcast.
+     */
+    data: Partial<TPresence>;
 };
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
@@ -397,11 +419,16 @@ declare function errorIf(condition: unknown, message: string): void;
 
 declare function lsonToJson(value: Lson): Json;
 declare function patchLiveObjectKey<O extends LsonObject, K extends keyof O, V extends Lson>(liveObject: LiveObject<O>, key: K, prev?: V, next?: V): void;
-declare function patchImmutableObject<S extends JsonObject>(state: S, updates: StorageUpdate[]): S;
+declare function legacy_patchImmutableObject<S extends JsonObject>(state: S, updates: StorageUpdate[]): S;
 
 declare function makePosition(before?: string, after?: string): string;
 declare function comparePosition(posA: string, posB: string): number;
 
+/**
+ * Freezes the given argument, but only in development builds. In production
+ * builds, this is a no-op for performance reasons.
+ */
+declare const freeze: typeof Object.freeze;
 declare function isPlainObject(blob: unknown): blob is {
     [key: string]: unknown;
 };
@@ -415,4 +442,4 @@ declare function tryParseJson(rawMessage: string): Json | undefined;
  */
 declare function b64decode(b64value: string): string;
 
-export { AppOnlyAuthToken, AuthToken, BroadcastEventClientMsg, BroadcastedEventServerMsg, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, FetchStorageClientMsg, IdTuple, InitialDocumentStateServerMsg, NodeMap, Op, OpCode, ParentToChildNodeMap, RoomAuthToken, RoomStateServerMsg, Scope, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UserJoinServerMsg, UserLeftServerMsg, assertNever, b64decode, comparePosition, deprecate, deprecateIf, errorIf, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isPlainObject, isRoomAuthToken, isRootCrdt, isScope, lsonToJson, makePosition, nn, patchImmutableObject, patchLiveObjectKey, throwUsageError, tryParseJson };
+export { AppOnlyAuthToken, AuthToken, BroadcastEventClientMsg, BroadcastedEventServerMsg, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, FetchStorageClientMsg, IdTuple, InitialDocumentStateServerMsg, NodeMap, Op, OpCode, ParentToChildNodeMap, RoomAuthToken, RoomStateServerMsg, Scope, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UserJoinServerMsg, UserLeftServerMsg, assertNever, b64decode, comparePosition, deprecate, deprecateIf, errorIf, freeze, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isPlainObject, isRoomAuthToken, isRootCrdt, isScope, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, throwUsageError, tryParseJson };