@liveblocks/client 0.16.0 → 0.16.1

package/lib/esm/index.js

@@ -915,6 +915,20 @@ class LiveMap extends AbstractCrdt {
   }
 }
 
+function parseJson(rawMessage) {
+  try {
+    return JSON.parse(rawMessage);
+  } catch (e) {
+    return void 0;
+  }
+}
+function isJsonArray(data) {
+  return Array.isArray(data);
+}
+function isJsonObject(data) {
+  return data !== null && typeof data === "object" && !isJsonArray(data);
+}
+
 var __defProp$2 = Object.defineProperty;
 var __defProps$2 = Object.defineProperties;
 var __getOwnPropDescs$2 = Object.getOwnPropertyDescriptors;
@@ -942,6 +956,9 @@ function remove(array, item) {
     }
   }
 }
+function compact(items) {
+  return items.filter((item) => item != null);
+}
 function creationOpToLiveStructure(op) {
   switch (op.type) {
     case OpType.CreateRegister:
@@ -1151,15 +1168,12 @@ function findNonSerializableValue(value, path = "") {
   return false;
 }
 function isTokenValid(token) {
-  if (token === null) {
-    return false;
-  }
   const tokenParts = token.split(".");
   if (tokenParts.length !== 3) {
     return false;
   }
-  const data = JSON.parse(atob(tokenParts[1]));
-  if (typeof data.exp !== "number") {
+  const data = parseJson(atob(tokenParts[1]));
+  if (data === void 0 || !isJsonObject(data) || typeof data.exp !== "number") {
     return false;
   }
   const now = Date.now();
@@ -1621,19 +1635,20 @@ function makeOthers(userMap) {
 function makeStateMachine(state, context, mockedEffects) {
   const effects = mockedEffects || {
     authenticate(auth, createWebSocket) {
-      if (isTokenValid(state.token)) {
-        const parsedToken = parseToken(state.token);
-        const socket = createWebSocket(state.token);
+      const token = state.token;
+      if (token && isTokenValid(token)) {
+        const parsedToken = parseToken(token);
+        const socket = createWebSocket(token);
         authenticationSuccess(parsedToken, socket);
       } else {
-        return auth(context.room).then(({ token }) => {
+        return auth(context.roomId).then(({ token: token2 }) => {
           if (state.connection.state !== "authenticating") {
             return;
           }
-          const parsedToken = parseToken(token);
-          const socket = createWebSocket(token);
+          const parsedToken = parseToken(token2);
+          const socket = createWebSocket(token2);
           authenticationSuccess(parsedToken, socket);
-          state.token = token;
+          state.token = token2;
         }).catch((er) => authenticationFailure(er));
       }
     },
@@ -1733,7 +1748,7 @@ function makeStateMachine(state, context, mockedEffects) {
       generateId,
       generateOpId,
       dispatch: storageDispatch,
-      roomId: context.room
+      roomId: context.roomId
     });
   }
   function addItem(id, item) {
@@ -2061,59 +2076,72 @@ See v0.13 release notes for more information.
     }
     return { type: "enter", user: state.users[message.actor] };
   }
+  function parseServerMessage(data) {
+    if (!isJsonObject(data)) {
+      return null;
+    }
+    return data;
+  }
+  function parseServerMessages(text) {
+    const data = parseJson(text);
+    if (data === void 0) {
+      return null;
+    } else if (isJsonArray(data)) {
+      return compact(data.map((item) => parseServerMessage(item)));
+    } else {
+      return compact([parseServerMessage(data)]);
+    }
+  }
   function onMessage(event) {
     if (event.data === "pong") {
       clearTimeout(state.timeoutHandles.pongTimeout);
       return;
     }
-    const message = JSON.parse(event.data);
-    let subMessages = [];
-    if (Array.isArray(message)) {
-      subMessages = message;
-    } else {
-      subMessages.push(message);
+    const messages = parseServerMessages(event.data);
+    if (messages === null || messages.length === 0) {
+      return;
     }
     const updates = {
       storageUpdates: /* @__PURE__ */ new Map(),
       others: []
     };
-    for (const subMessage of subMessages) {
-      switch (subMessage.type) {
+    for (const message of messages) {
+      switch (message.type) {
         case ServerMessageType.UserJoined: {
           updates.others.push(onUserJoinedMessage(message));
           break;
         }
         case ServerMessageType.UpdatePresence: {
-          const othersPresenceUpdate = onUpdatePresenceMessage(subMessage);
+          const othersPresenceUpdate = onUpdatePresenceMessage(message);
           if (othersPresenceUpdate) {
             updates.others.push(othersPresenceUpdate);
           }
           break;
         }
         case ServerMessageType.Event: {
-          onEvent(subMessage);
+          onEvent(message);
           break;
         }
         case ServerMessageType.UserLeft: {
-          const event2 = onUserLeftMessage(subMessage);
+          const event2 = onUserLeftMessage(message);
           if (event2) {
             updates.others.push(event2);
           }
           break;
         }
         case ServerMessageType.RoomState: {
-          updates.others.push(onRoomStateMessage(subMessage));
+          updates.others.push(onRoomStateMessage(message));
           break;
         }
         case ServerMessageType.InitialStorageState: {
           const offlineOps = new Map(state.offlineOperations);
-          createOrUpdateRootFromMessage(subMessage);
+          createOrUpdateRootFromMessage(message);
           applyAndSendOfflineOps(offlineOps);
           _getInitialStateResolver == null ? void 0 : _getInitialStateResolver();
           break;
         }
         case ServerMessageType.UpdateStorage: {
-          const applyResult = apply(subMessage.ops, false);
+          const applyResult = apply(message.ops, false);
           applyResult.updates.storageUpdates.forEach((value, key) => {
             updates.storageUpdates.set(key, mergeStorageUpdates(updates.storageUpdates.get(key), value));
           });
@@ -2531,7 +2559,7 @@ function createRoom(options, context) {
   const state = defaultState(options.defaultPresence, options.defaultStorageRoot);
   const machine = makeStateMachine(state, context);
   const room = {
-    id: context.room,
+    id: context.roomId,
     getConnectionState: machine.selectors.getConnectionState,
     getSelf: machine.selectors.getSelf,
     subscribe: machine.subscribe,
@@ -2572,11 +2600,15 @@ function parseToken(token) {
   if (tokenParts.length !== 3) {
     throw new Error(`Authentication error. Liveblocks could not parse the response of your authentication endpoint`);
   }
-  const data = JSON.parse(atob(tokenParts[1]));
-  if (typeof data.actor !== "number") {
-    throw new Error(`Authentication error. Liveblocks could not parse the response of your authentication endpoint`);
+  const data = parseJson(atob(tokenParts[1]));
+  if (data !== void 0 && isJsonObject(data) && typeof data.actor === "number" && (data.id === void 0 || typeof data.id === "string")) {
+    return {
+      actor: data.actor,
+      id: data.id,
+      info: data.info
+    };
   }
-  return data;
+  throw new Error(`Authentication error. Liveblocks could not parse the response of your authentication endpoint`);
 }
 function prepareCreateWebSocket(liveblocksServer, WebSocketPolyfill) {
   if (typeof window === "undefined" && WebSocketPolyfill == null) {
@@ -2654,7 +2686,7 @@ function createClient(options) {
       defaultPresence: options2.defaultPresence,
       defaultStorageRoot: options2.defaultStorageRoot
     }, {
-      room: roomId,
+      roomId,
       throttleDelay,
       WebSocketPolyfill: clientOptions.WebSocketPolyfill,
       fetchPolyfill: clientOptions.fetchPolyfill,

package/lib/esm/index.mjs

@@ -915,6 +915,20 @@ class LiveMap extends AbstractCrdt {
   }
 }
 
+function parseJson(rawMessage) {
+  try {
+    return JSON.parse(rawMessage);
+  } catch (e) {
+    return void 0;
+  }
+}
+function isJsonArray(data) {
+  return Array.isArray(data);
+}
+function isJsonObject(data) {
+  return data !== null && typeof data === "object" && !isJsonArray(data);
+}
+
 var __defProp$2 = Object.defineProperty;
 var __defProps$2 = Object.defineProperties;
 var __getOwnPropDescs$2 = Object.getOwnPropertyDescriptors;
@@ -942,6 +956,9 @@ function remove(array, item) {
     }
   }
 }
+function compact(items) {
+  return items.filter((item) => item != null);
+}
 function creationOpToLiveStructure(op) {
   switch (op.type) {
     case OpType.CreateRegister:
@@ -1151,15 +1168,12 @@ function findNonSerializableValue(value, path = "") {
   return false;
 }
 function isTokenValid(token) {
-  if (token === null) {
-    return false;
-  }
   const tokenParts = token.split(".");
   if (tokenParts.length !== 3) {
     return false;
   }
-  const data = JSON.parse(atob(tokenParts[1]));
-  if (typeof data.exp !== "number") {
+  const data = parseJson(atob(tokenParts[1]));
+  if (data === void 0 || !isJsonObject(data) || typeof data.exp !== "number") {
     return false;
   }
   const now = Date.now();
@@ -1621,19 +1635,20 @@ function makeOthers(userMap) {
 function makeStateMachine(state, context, mockedEffects) {
   const effects = mockedEffects || {
     authenticate(auth, createWebSocket) {
-      if (isTokenValid(state.token)) {
-        const parsedToken = parseToken(state.token);
-        const socket = createWebSocket(state.token);
+      const token = state.token;
+      if (token && isTokenValid(token)) {
+        const parsedToken = parseToken(token);
+        const socket = createWebSocket(token);
         authenticationSuccess(parsedToken, socket);
       } else {
-        return auth(context.room).then(({ token }) => {
+        return auth(context.roomId).then(({ token: token2 }) => {
           if (state.connection.state !== "authenticating") {
             return;
           }
-          const parsedToken = parseToken(token);
-          const socket = createWebSocket(token);
+          const parsedToken = parseToken(token2);
+          const socket = createWebSocket(token2);
           authenticationSuccess(parsedToken, socket);
-          state.token = token;
+          state.token = token2;
         }).catch((er) => authenticationFailure(er));
       }
     },
@@ -1733,7 +1748,7 @@ function makeStateMachine(state, context, mockedEffects) {
       generateId,
       generateOpId,
       dispatch: storageDispatch,
-      roomId: context.room
+      roomId: context.roomId
     });
   }
   function addItem(id, item) {
@@ -2061,59 +2076,72 @@ See v0.13 release notes for more information.
     }
     return { type: "enter", user: state.users[message.actor] };
   }
+  function parseServerMessage(data) {
+    if (!isJsonObject(data)) {
+      return null;
+    }
+    return data;
+  }
+  function parseServerMessages(text) {
+    const data = parseJson(text);
+    if (data === void 0) {
+      return null;
+    } else if (isJsonArray(data)) {
+      return compact(data.map((item) => parseServerMessage(item)));
+    } else {
+      return compact([parseServerMessage(data)]);
+    }
+  }
   function onMessage(event) {
     if (event.data === "pong") {
       clearTimeout(state.timeoutHandles.pongTimeout);
       return;
     }
-    const message = JSON.parse(event.data);
-    let subMessages = [];
-    if (Array.isArray(message)) {
-      subMessages = message;
-    } else {
-      subMessages.push(message);
+    const messages = parseServerMessages(event.data);
+    if (messages === null || messages.length === 0) {
+      return;
     }
     const updates = {
       storageUpdates: /* @__PURE__ */ new Map(),
       others: []
     };
-    for (const subMessage of subMessages) {
-      switch (subMessage.type) {
+    for (const message of messages) {
+      switch (message.type) {
         case ServerMessageType.UserJoined: {
           updates.others.push(onUserJoinedMessage(message));
           break;
         }
         case ServerMessageType.UpdatePresence: {
-          const othersPresenceUpdate = onUpdatePresenceMessage(subMessage);
+          const othersPresenceUpdate = onUpdatePresenceMessage(message);
           if (othersPresenceUpdate) {
             updates.others.push(othersPresenceUpdate);
           }
           break;
         }
         case ServerMessageType.Event: {
-          onEvent(subMessage);
+          onEvent(message);
           break;
         }
         case ServerMessageType.UserLeft: {
-          const event2 = onUserLeftMessage(subMessage);
+          const event2 = onUserLeftMessage(message);
           if (event2) {
             updates.others.push(event2);
           }
           break;
         }
         case ServerMessageType.RoomState: {
-          updates.others.push(onRoomStateMessage(subMessage));
+          updates.others.push(onRoomStateMessage(message));
           break;
         }
         case ServerMessageType.InitialStorageState: {
           const offlineOps = new Map(state.offlineOperations);
-          createOrUpdateRootFromMessage(subMessage);
+          createOrUpdateRootFromMessage(message);
           applyAndSendOfflineOps(offlineOps);
           _getInitialStateResolver == null ? void 0 : _getInitialStateResolver();
           break;
         }
         case ServerMessageType.UpdateStorage: {
-          const applyResult = apply(subMessage.ops, false);
+          const applyResult = apply(message.ops, false);
           applyResult.updates.storageUpdates.forEach((value, key) => {
             updates.storageUpdates.set(key, mergeStorageUpdates(updates.storageUpdates.get(key), value));
           });
@@ -2531,7 +2559,7 @@ function createRoom(options, context) {
   const state = defaultState(options.defaultPresence, options.defaultStorageRoot);
   const machine = makeStateMachine(state, context);
   const room = {
-    id: context.room,
+    id: context.roomId,
     getConnectionState: machine.selectors.getConnectionState,
     getSelf: machine.selectors.getSelf,
     subscribe: machine.subscribe,
@@ -2572,11 +2600,15 @@ function parseToken(token) {
   if (tokenParts.length !== 3) {
     throw new Error(`Authentication error. Liveblocks could not parse the response of your authentication endpoint`);
   }
-  const data = JSON.parse(atob(tokenParts[1]));
-  if (typeof data.actor !== "number") {
-    throw new Error(`Authentication error. Liveblocks could not parse the response of your authentication endpoint`);
+  const data = parseJson(atob(tokenParts[1]));
+  if (data !== void 0 && isJsonObject(data) && typeof data.actor === "number" && (data.id === void 0 || typeof data.id === "string")) {
+    return {
+      actor: data.actor,
+      id: data.id,
+      info: data.info
+    };
   }
-  return data;
+  throw new Error(`Authentication error. Liveblocks could not parse the response of your authentication endpoint`);
 }
 function prepareCreateWebSocket(liveblocksServer, WebSocketPolyfill) {
   if (typeof window === "undefined" && WebSocketPolyfill == null) {
@@ -2654,7 +2686,7 @@ function createClient(options) {
       defaultPresence: options2.defaultPresence,
       defaultStorageRoot: options2.defaultStorageRoot
     }, {
-      room: roomId,
+      roomId,
       throttleDelay,
       WebSocketPolyfill: clientOptions.WebSocketPolyfill,
       fetchPolyfill: clientOptions.fetchPolyfill,

package/lib/index.d.ts

@@ -201,6 +201,10 @@ declare type UpdateDelta = {
 } | {
     type: "delete";
 };
+/**
+ * A LiveMap notification that is sent in-client to any subscribers whenever
+ * one or more of the values inside the LiveMap instance have changed.
+ */
 declare type LiveMapUpdates<TKey extends string, TValue extends Lson> = {
     type: "LiveMap";
     node: LiveMap<TKey, TValue>;
@@ -213,6 +217,10 @@ declare type LiveObjectUpdateDelta<O extends {
 }> = {
     [K in keyof O]?: UpdateDelta | undefined;
 };
+/**
+ * A LiveObject notification that is sent in-client to any subscribers whenever
+ * one or more of the entries inside the LiveObject instance have changed.
+ */
 declare type LiveObjectUpdates<TData extends LsonObject> = {
     type: "LiveObject";
     node: LiveObject<TData>;
@@ -235,6 +243,10 @@ declare type LiveListUpdateDelta = {
     item: any;
     type: "set";
 };
+/**
+ * A LiveList notification that is sent in-client to any subscribers whenever
+ * one or more of the items inside the LiveList instance have changed.
+ */
 declare type LiveListUpdates<TItem extends Lson> = {
     type: "LiveList";
     node: LiveList<TItem>;
@@ -248,6 +260,11 @@ declare type BroadcastOptions = {
      */
     shouldQueueEventIfNotReady: boolean;
 };
+/**
+ * The payload of notifications sent (in-client) when LiveStructures change.
+ * Messages of this kind are not originating from the network, but are 100%
+ * in-client.
+ */
 declare type StorageUpdate = LiveMapUpdates<string, Lson> | LiveObjectUpdates<LsonObject> | LiveListUpdates<Lson>;
 declare type Client = {
     /**

package/lib/index.js

@@ -1535,6 +1535,20 @@ var LiveMap = function (_AbstractCrdt) {
   return LiveMap;
 }(AbstractCrdt);
 
+function parseJson(rawMessage) {
+  try {
+    return JSON.parse(rawMessage);
+  } catch (e) {
+    return undefined;
+  }
+}
+function isJsonArray(data) {
+  return Array.isArray(data);
+}
+function isJsonObject(data) {
+  return data !== null && typeof data === "object" && !isJsonArray(data);
+}
+
 function remove(array, item) {
   for (var i = 0; i < array.length; i++) {
     if (array[i] === item) {
@@ -1543,6 +1557,11 @@ function remove(array, item) {
     }
   }
 }
+function compact(items) {
+  return items.filter(function (item) {
+    return item != null;
+  });
+}
 function creationOpToLiveStructure(op) {
   switch (op.type) {
     case OpType.CreateRegister:
@@ -1804,19 +1823,15 @@ function findNonSerializableValue(value, path) {
   return false;
 }
 function isTokenValid(token) {
-  if (token === null) {
-    return false;
-  }
-
   var tokenParts = token.split(".");
 
   if (tokenParts.length !== 3) {
     return false;
   }
 
-  var data = JSON.parse(atob(tokenParts[1]));
+  var data = parseJson(atob(tokenParts[1]));
 
-  if (typeof data.exp !== "number") {
+  if (data === undefined || !isJsonObject(data) || typeof data.exp !== "number") {
     return false;
   }
 
@@ -2461,12 +2476,14 @@ function makeOthers(userMap) {
 function makeStateMachine(state, context, mockedEffects) {
   var effects = mockedEffects || {
     authenticate: function authenticate(auth, createWebSocket) {
-      if (isTokenValid(state.token)) {
-        var parsedToken = parseToken(state.token);
-        var socket = createWebSocket(state.token);
+      var token = state.token;
+
+      if (token && isTokenValid(token)) {
+        var parsedToken = parseToken(token);
+        var socket = createWebSocket(token);
         authenticationSuccess(parsedToken, socket);
       } else {
-        return auth(context.room).then(function (_ref2) {
+        return auth(context.roomId).then(function (_ref2) {
           var token = _ref2.token;
 
           if (state.connection.state !== "authenticating") {
@@ -2604,7 +2621,7 @@ function makeStateMachine(state, context, mockedEffects) {
       generateId: generateId,
       generateOpId: generateOpId,
       dispatch: storageDispatch,
-      roomId: context.room
+      roomId: context.roomId
     });
   }
 
@@ -3066,19 +3083,38 @@ function makeStateMachine(state, context, mockedEffects) {
     };
   }
 
+  function parseServerMessage(data) {
+    if (!isJsonObject(data)) {
+      return null;
+    }
+
+    return data;
+  }
+
+  function parseServerMessages(text) {
+    var data = parseJson(text);
+
+    if (data === undefined) {
+      return null;
+    } else if (isJsonArray(data)) {
+      return compact(data.map(function (item) {
+        return parseServerMessage(item);
+      }));
+    } else {
+      return compact([parseServerMessage(data)]);
+    }
+  }
+
   function onMessage(event) {
     if (event.data === "pong") {
       clearTimeout(state.timeoutHandles.pongTimeout);
       return;
     }
 
-    var message = JSON.parse(event.data);
-    var subMessages = [];
+    var messages = parseServerMessages(event.data);
 
-    if (Array.isArray(message)) {
-      subMessages = message;
-    } else {
-      subMessages.push(message);
+    if (messages === null || messages.length === 0) {
+      return;
     }
 
     var updates = {
@@ -3086,10 +3122,10 @@ function makeStateMachine(state, context, mockedEffects) {
       others: []
     };
 
-    for (var _iterator9 = _createForOfIteratorHelperLoose(subMessages), _step9; !(_step9 = _iterator9()).done;) {
-      var subMessage = _step9.value;
+    for (var _iterator9 = _createForOfIteratorHelperLoose(messages), _step9; !(_step9 = _iterator9()).done;) {
+      var message = _step9.value;
 
-      switch (subMessage.type) {
+      switch (message.type) {
         case ServerMessageType.UserJoined:
           {
             updates.others.push(onUserJoinedMessage(message));
@@ -3098,7 +3134,7 @@ function makeStateMachine(state, context, mockedEffects) {
 
         case ServerMessageType.UpdatePresence:
           {
-            var othersPresenceUpdate = onUpdatePresenceMessage(subMessage);
+            var othersPresenceUpdate = onUpdatePresenceMessage(message);
 
             if (othersPresenceUpdate) {
               updates.others.push(othersPresenceUpdate);
@@ -3109,13 +3145,13 @@ function makeStateMachine(state, context, mockedEffects) {
 
         case ServerMessageType.Event:
           {
-            onEvent(subMessage);
+            onEvent(message);
             break;
           }
 
         case ServerMessageType.UserLeft:
           {
-            var _event = onUserLeftMessage(subMessage);
+            var _event = onUserLeftMessage(message);
 
             if (_event) {
               updates.others.push(_event);
@@ -3126,14 +3162,14 @@ function makeStateMachine(state, context, mockedEffects) {
 
         case ServerMessageType.RoomState:
           {
-            updates.others.push(onRoomStateMessage(subMessage));
+            updates.others.push(onRoomStateMessage(message));
             break;
           }
 
         case ServerMessageType.InitialStorageState:
           {
             var offlineOps = new Map(state.offlineOperations);
-            createOrUpdateRootFromMessage(subMessage);
+            createOrUpdateRootFromMessage(message);
             applyAndSendOfflineOps(offlineOps);
             _getInitialStateResolver == null ? void 0 : _getInitialStateResolver();
             break;
@@ -3141,7 +3177,7 @@ function makeStateMachine(state, context, mockedEffects) {
 
         case ServerMessageType.UpdateStorage:
           {
-            var applyResult = apply(subMessage.ops, false);
+            var applyResult = apply(message.ops, false);
             applyResult.updates.storageUpdates.forEach(function (value, key) {
               updates.storageUpdates.set(key, mergeStorageUpdates(updates.storageUpdates.get(key), value));
             });
@@ -3701,7 +3737,7 @@ function createRoom(options, context) {
   var state = defaultState(options.defaultPresence, options.defaultStorageRoot);
   var machine = makeStateMachine(state, context);
   var room = {
-    id: context.room,
+    id: context.roomId,
     getConnectionState: machine.selectors.getConnectionState,
     getSelf: machine.selectors.getSelf,
     subscribe: machine.subscribe,
@@ -3753,13 +3789,17 @@ function parseToken(token) {
     throw new Error("Authentication error. Liveblocks could not parse the response of your authentication endpoint");
   }
 
-  var data = JSON.parse(atob(tokenParts[1]));
+  var data = parseJson(atob(tokenParts[1]));
 
-  if (typeof data.actor !== "number") {
-    throw new Error("Authentication error. Liveblocks could not parse the response of your authentication endpoint");
+  if (data !== undefined && isJsonObject(data) && typeof data.actor === "number" && (data.id === undefined || typeof data.id === "string")) {
+    return {
+      actor: data.actor,
+      id: data.id,
+      info: data.info
+    };
   }
 
-  return data;
+  throw new Error("Authentication error. Liveblocks could not parse the response of your authentication endpoint");
 }
 
 function prepareCreateWebSocket(liveblocksServer, WebSocketPolyfill) {
@@ -3865,7 +3905,7 @@ function createClient(options) {
       defaultPresence: options.defaultPresence,
       defaultStorageRoot: options.defaultStorageRoot
     }, {
-      room: roomId,
+      roomId: roomId,
       throttleDelay: throttleDelay,
       WebSocketPolyfill: clientOptions.WebSocketPolyfill,
       fetchPolyfill: clientOptions.fetchPolyfill,

package/lib/internal.d.ts

@@ -17,6 +17,9 @@ declare type JsonObject = {
 
 declare type Presence = Record<string, unknown>;
 
+/**
+ * Messages that can be sent from the server to the client.
+ */
 declare type ServerMessage = UpdatePresenceMessage | UserJoinMessage | UserLeftMessage | EventMessage | RoomStateMessage | InitialDocumentStateMessage | UpdateStorageMessage;
 declare enum ServerMessageType {
     UpdatePresence = 100,
@@ -27,45 +30,116 @@ declare enum ServerMessageType {
     InitialStorageState = 200,
     UpdateStorage = 201
 }
+/**
+ * Sent by the WebSocket server to a single client in response to the client
+ * joining the Room, to provide the initial state of the Room. The payload
+ * includes a list of all other Users that already are in the Room.
+ */
 declare type RoomStateMessage = {
     type: ServerMessageType.RoomState;
     users: {
         [actor: number]: {
             id?: string;
-            info?: any;
+            info?: Json;
         };
     };
 };
+/**
+ * Sent by the WebSocket server and broadcasted to all clients to announce that
+ * a User updated their presence. For example, when a user moves their cursor.
+ *
+ * In most cases, the data payload will only include the fields from the
+ * Presence that have been changed since the last announcement. However, after
+ * a new user joins a room, a "full presence" will be announced so the newly
+ * connected user will get each other's user full presence at least once. In
+ * those cases, the `targetActor` field indicates the newly connected client,
+ * so all other existing clients can ignore this broadcasted message.
+ */
 declare type UpdatePresenceMessage = {
     type: ServerMessageType.UpdatePresence;
+    /**
+     * The User whose Presence has changed.
+     */
     actor: 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: Presence;
+    /**
+     * 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.
+     */
     targetActor?: number;
 };
+/**
+ * Sent by the WebSocket server and broadcasted to all clients to announce that
+ * a new User has joined the Room.
+ */
 declare type UserJoinMessage = {
     type: ServerMessageType.UserJoined;
     actor: number;
+    /**
+     * The id of the User that has been set in the authentication endpoint.
+     * Useful to get additional information about the connected user.
+     */
     id?: string;
-    info?: string;
+    /**
+     * Additional user information that has been set in the authentication
+     * endpoint.
+     */
+    info?: Json;
 };
+/**
+ * Sent by the WebSocket server and broadcasted to all clients to announce that
+ * a new User has left the Room.
+ */
 declare type UserLeftMessage = {
     type: ServerMessageType.UserLeft;
     actor: number;
 };
+/**
+ * Sent by the WebSocket server and broadcasted to all clients to announce that
+ * a User broadcasted an Event to everyone in the Room.
+ */
 declare type EventMessage = {
     type: ServerMessageType.Event;
+    /**
+     * The User who broadcasted the Event.
+     */
     actor: number;
+    /**
+     * The arbitrary payload of the Event. This can be any JSON value. Clients
+     * will have to manually verify/decode this event.
+     */
     event: Json;
 };
 declare type SerializedCrdtWithId = [id: string, crdt: SerializedCrdt];
+/**
+ * Sent by the WebSocket server to a single client in response to the client
+ * joining the Room, to provide the initial Storage state of the Room. The
+ * payload includes the entire Storage document.
+ */
 declare type InitialDocumentStateMessage = {
     type: ServerMessageType.InitialStorageState;
     items: SerializedCrdtWithId[];
 };
+/**
+ * Sent by the WebSocket server and broadcasted to all clients to announce that
+ * a change occurred in the Storage document.
+ *
+ * The payload of this message contains a list of Ops (aka incremental
+ * mutations to make to the initially loaded document).
+ */
 declare type UpdateStorageMessage = {
     type: ServerMessageType.UpdateStorage;
     ops: Op[];
 };
+/**
+ * Messages that can be sent from the client to the server.
+ */
 declare type ClientMessage = ClientEventMessage | UpdatePresenceClientMessage | UpdateStorageClientMessage | FetchStorageClientMessage;
 declare enum ClientMessageType {
     UpdatePresence = 100,
@@ -129,6 +203,10 @@ declare enum OpType {
     CreateMap = 7,
     CreateRegister = 8
 }
+/**
+ * These operations are the payload for {@link UpdateStorageMessage} messages
+ * only.
+ */
 declare type Op = CreateObjectOp | UpdateObjectOp | DeleteCrdtOp | CreateListOp | SetParentKeyOp | DeleteObjectKeyOp | CreateMapOp | CreateRegisterOp;
 declare type CreateOp = CreateObjectOp | CreateRegisterOp | CreateMapOp | CreateListOp;
 declare type UpdateObjectOp = {
@@ -169,7 +247,7 @@ declare type CreateRegisterOp = {
     type: OpType.CreateRegister;
     parentId: string;
     parentKey: string;
-    data: any;
+    data: Json;
 };
 declare type DeleteCrdtOp = {
     opId?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/client",
-  "version": "0.16.0",
+  "version": "0.16.1",
   "description": "A client that lets you interact with Liveblocks servers.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",