@liveblocks/client 0.15.11 → 0.16.2

package/{lib/internal.d.ts → internal.d.ts}

@@ -1,5 +1,25 @@
+/**
+ * Represents an indefinitely deep arbitrary JSON data structure. There are
+ * four types that make up the Json family:
+ *
+ * - Json         any legal JSON value
+ * - JsonScalar   any legal JSON leaf value (no lists or objects)
+ * - JsonArray    a JSON value whose outer type is an array
+ * - JsonObject   a JSON value whose outer type is an object
+ *
+ */
+declare type Json = JsonScalar | JsonArray | JsonObject;
+declare type JsonScalar = string | number | boolean | null;
+declare type JsonArray = Json[];
+declare type JsonObject = {
+    [key: string]: Json | undefined;
+};
+
 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,
@@ -10,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;
-    event: any;
+    /**
+     * 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,
@@ -58,7 +149,7 @@ declare enum ClientMessageType {
 }
 declare type ClientEventMessage = {
     type: ClientMessageType.ClientEvent;
-    event: any;
+    event: Json;
 };
 declare type UpdatePresenceClientMessage = {
     type: ClientMessageType.UpdatePresence;
@@ -82,9 +173,7 @@ declare type SerializedObject = {
     type: CrdtType.Object;
     parentId?: string;
     parentKey?: string;
-    data: {
-        [key: string]: any;
-    };
+    data: JsonObject;
 };
 declare type SerializedList = {
     type: CrdtType.List;
@@ -100,7 +189,7 @@ declare type SerializedRegister = {
     type: CrdtType.Register;
     parentId: string;
     parentKey: string;
-    data: any;
+    data: Json;
 };
 declare type SerializedCrdt = SerializedObject | SerializedList | SerializedMap | SerializedRegister;
 declare enum OpType {
@@ -114,28 +203,31 @@ 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 = {
     opId?: string;
     id: string;
     type: OpType.UpdateObject;
-    data: {
-        [key: string]: any;
-    };
+    data: Partial<JsonObject>;
 };
 declare type CreateObjectOp = {
     opId?: string;
     id: string;
+    intent?: "set";
     type: OpType.CreateObject;
     parentId?: string;
     parentKey?: string;
-    data: {
-        [key: string]: any;
-    };
+    data: JsonObject;
 };
 declare type CreateListOp = {
     opId?: string;
     id: string;
+    intent?: "set";
     type: OpType.CreateList;
     parentId: string;
     parentKey: string;
@@ -143,6 +235,7 @@ declare type CreateListOp = {
 declare type CreateMapOp = {
     opId?: string;
     id: string;
+    intent?: "set";
     type: OpType.CreateMap;
     parentId: string;
     parentKey: string;
@@ -150,10 +243,11 @@ declare type CreateMapOp = {
 declare type CreateRegisterOp = {
     opId?: string;
     id: string;
+    intent?: "set";
     type: OpType.CreateRegister;
     parentId: string;
     parentKey: string;
-    data: any;
+    data: Json;
 };
 declare type DeleteCrdtOp = {
     opId?: string;
@@ -190,4 +284,4 @@ declare function posCodes(str: string): number[];
 declare function pos(codes: number[]): string;
 declare function compare(posA: string, posB: string): number;
 
-export { ClientEventMessage, ClientMessage, ClientMessageType, CrdtType, CreateListOp, CreateMapOp, CreateObjectOp, CreateRegisterOp, DeleteCrdtOp, DeleteObjectKeyOp, EventMessage, FetchStorageClientMessage, InitialDocumentStateMessage, Op, OpType, RoomStateMessage, SerializedCrdt, SerializedCrdtWithId, SerializedList, SerializedMap, SerializedObject, SerializedRegister, ServerMessage, ServerMessageType, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMessage, UpdatePresenceMessage, UpdateStorageClientMessage, UpdateStorageMessage, UserJoinMessage, UserLeftMessage, WebsocketCloseCodes, compare, makePosition, max, min, pos, posCodes };
+export { ClientEventMessage, ClientMessage, ClientMessageType, CrdtType, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, DeleteCrdtOp, DeleteObjectKeyOp, EventMessage, FetchStorageClientMessage, InitialDocumentStateMessage, Op, OpType, RoomStateMessage, SerializedCrdt, SerializedCrdtWithId, SerializedList, SerializedMap, SerializedObject, SerializedRegister, ServerMessage, ServerMessageType, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMessage, UpdatePresenceMessage, UpdateStorageClientMessage, UpdateStorageMessage, UserJoinMessage, UserLeftMessage, WebsocketCloseCodes, compare, makePosition, max, min, pos, posCodes };

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@liveblocks/client",
-  "version": "0.15.11",
-  "description": "",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "version": "0.16.2",
+  "description": "A client that lets you interact with Liveblocks servers.",
+  "main": "./index.js",
+  "types": "./index.d.ts",
   "files": [
-    "lib/**"
+    "**"
   ],
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./lib/index.d.ts",
-      "module": "./lib/esm/index.js",
-      "import": "./lib/esm/index.mjs",
-      "default": "./lib/index.js"
+      "types": "./index.d.ts",
+      "module": "./esm/index.js",
+      "import": "./esm/index.mjs",
+      "default": "./index.js"
     },
     "./internal": {
-      "types": "./lib/internal.d.ts",
-      "module": "./lib/esm/internal.js",
-      "import": "./lib/esm/internal.mjs",
-      "default": "./lib/internal.js"
+      "types": "./internal.d.ts",
+      "module": "./esm/internal.js",
+      "import": "./esm/internal.mjs",
+      "default": "./internal.js"
     }
   },
   "keywords": [
@@ -32,7 +32,7 @@
     "url": "https://github.com/liveblocks/liveblocks/issues"
   },
   "scripts": {
-    "build": "rollup -c",
+    "build": "rollup -c && cp ./package.json ./README.md ./lib",
     "test": "jest --watch",
     "test-ci": "jest"
   },