@liveblocks/client 0.15.11 → 0.16.0

package/lib/internal.d.ts

@@ -1,3 +1,20 @@
+/**
+ * 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;
+};
+
 declare type Presence = Record<string, unknown>;
 
 declare type ServerMessage = UpdatePresenceMessage | UserJoinMessage | UserLeftMessage | EventMessage | RoomStateMessage | InitialDocumentStateMessage | UpdateStorageMessage;
@@ -38,7 +55,7 @@ declare type UserLeftMessage = {
 declare type EventMessage = {
     type: ServerMessageType.Event;
     actor: number;
-    event: any;
+    event: Json;
 };
 declare type SerializedCrdtWithId = [id: string, crdt: SerializedCrdt];
 declare type InitialDocumentStateMessage = {
@@ -58,7 +75,7 @@ declare enum ClientMessageType {
 }
 declare type ClientEventMessage = {
     type: ClientMessageType.ClientEvent;
-    event: any;
+    event: Json;
 };
 declare type UpdatePresenceClientMessage = {
     type: ClientMessageType.UpdatePresence;
@@ -82,9 +99,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 +115,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 {
@@ -115,27 +130,26 @@ declare enum OpType {
     CreateRegister = 8
 }
 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 +157,7 @@ declare type CreateListOp = {
 declare type CreateMapOp = {
     opId?: string;
     id: string;
+    intent?: "set";
     type: OpType.CreateMap;
     parentId: string;
     parentKey: string;
@@ -150,6 +165,7 @@ declare type CreateMapOp = {
 declare type CreateRegisterOp = {
     opId?: string;
     id: string;
+    intent?: "set";
     type: OpType.CreateRegister;
     parentId: string;
     parentKey: string;
@@ -190,4 +206,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,7 +1,7 @@
 {
   "name": "@liveblocks/client",
-  "version": "0.15.11",
-  "description": "",
+  "version": "0.16.0",
+  "description": "A client that lets you interact with Liveblocks servers.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "files": [