@liveblocks/client 0.17.0-test1 → 0.17.1

package/internal.d.ts

@@ -1,50 +1,119 @@
 import {
-  d as JsonObject,
+  e as JsonObject,
   J as Json,
-  h as Op,
-  I as IdTuple,
-  i as SerializedCrdt,
-  f as Lson,
-  g as LsonObject,
+  B as BaseUserMeta,
+  g as Lson,
+  h as LsonObject,
   c as LiveObject,
   S as StorageUpdate,
 } from "./shared.js";
 export {
-  G as CrdtType,
-  j as CreateChildOp,
-  k as CreateListOp,
-  l as CreateMapOp,
-  m as CreateObjectOp,
-  n as CreateOp,
-  o as CreateRegisterOp,
-  p as CreateRootObjectOp,
-  D as DeleteCrdtOp,
-  q as DeleteObjectKeyOp,
-  I as IdTuple,
-  r as LiveNode,
-  N as NodeMap,
-  h as Op,
-  K as OpCode,
-  s as ParentToChildNodeMap,
-  t as Resolve,
-  u as RoomInitializers,
-  v as SerializedChild,
-  i as SerializedCrdt,
-  w as SerializedList,
-  x as SerializedMap,
-  y as SerializedObject,
-  z as SerializedRegister,
-  A as SerializedRootObject,
-  E as SetParentKeyOp,
-  F as UpdateObjectOp,
+  i as LiveNode,
+  j as Resolve,
+  k as RoomInitializers,
   W as WebsocketCloseCodes,
-  V as isChildCrdt,
-  M as isJsonArray,
-  Q as isJsonObject,
-  T as isJsonScalar,
-  X as isRootCrdt,
+  l as isJsonArray,
+  m as isJsonObject,
+  n as isJsonScalar,
 } from "./shared.js";
 
+declare enum OpCode {
+  INIT = 0,
+  SET_PARENT_KEY = 1,
+  CREATE_LIST = 2,
+  UPDATE_OBJECT = 3,
+  CREATE_OBJECT = 4,
+  DELETE_CRDT = 5,
+  DELETE_OBJECT_KEY = 6,
+  CREATE_MAP = 7,
+  CREATE_REGISTER = 8,
+}
+/**
+ * These operations are the payload for {@link UpdateStorageServerMsg} messages
+ * only.
+ */
+declare type Op =
+  | CreateOp
+  | UpdateObjectOp
+  | DeleteCrdtOp
+  | SetParentKeyOp
+  | DeleteObjectKeyOp;
+declare type CreateOp = CreateRootObjectOp | CreateChildOp;
+declare type CreateChildOp =
+  | CreateObjectOp
+  | CreateRegisterOp
+  | CreateMapOp
+  | CreateListOp;
+declare type UpdateObjectOp = {
+  opId?: string;
+  id: string;
+  type: OpCode.UPDATE_OBJECT;
+  data: Partial<JsonObject>;
+};
+declare type CreateObjectOp = {
+  opId?: string;
+  id: string;
+  intent?: "set";
+  deletedId?: string;
+  type: OpCode.CREATE_OBJECT;
+  parentId: string;
+  parentKey: string;
+  data: JsonObject;
+};
+declare type CreateRootObjectOp = {
+  opId?: string;
+  id: string;
+  type: OpCode.CREATE_OBJECT;
+  data: JsonObject;
+  parentId?: never;
+  parentKey?: never;
+};
+declare type CreateListOp = {
+  opId?: string;
+  id: string;
+  intent?: "set";
+  deletedId?: string;
+  type: OpCode.CREATE_LIST;
+  parentId: string;
+  parentKey: string;
+};
+declare type CreateMapOp = {
+  opId?: string;
+  id: string;
+  intent?: "set";
+  deletedId?: string;
+  type: OpCode.CREATE_MAP;
+  parentId: string;
+  parentKey: string;
+};
+declare type CreateRegisterOp = {
+  opId?: string;
+  id: string;
+  intent?: "set";
+  deletedId?: string;
+  type: OpCode.CREATE_REGISTER;
+  parentId: string;
+  parentKey: string;
+  data: Json;
+};
+declare type DeleteCrdtOp = {
+  opId?: string;
+  id: string;
+  type: OpCode.DELETE_CRDT;
+};
+declare type SetParentKeyOp = {
+  opId?: string;
+  id: string;
+  type: OpCode.SET_PARENT_KEY;
+  parentKey: string;
+};
+declare type DeleteObjectKeyOp = {
+  opId?: string;
+  id: string;
+  type: OpCode.DELETE_OBJECT_KEY;
+  key: string;
+};
+
 declare enum ClientMsgCode {
   UPDATE_PRESENCE = 100,
   BROADCAST_EVENT = 103,
@@ -54,14 +123,14 @@ declare enum ClientMsgCode {
 /**
  * Messages that can be sent from the client to the server.
  */
-declare type ClientMsg<TPresence extends JsonObject> =
-  | BroadcastEventClientMsg
+declare type ClientMsg<TPresence extends JsonObject, TRoomEvent extends Json> =
+  | BroadcastEventClientMsg<TRoomEvent>
   | UpdatePresenceClientMsg<TPresence>
   | UpdateStorageClientMsg
   | FetchStorageClientMsg;
-declare type BroadcastEventClientMsg = {
+declare type BroadcastEventClientMsg<TRoomEvent extends Json> = {
   type: ClientMsgCode.BROADCAST_EVENT;
-  event: Json;
+  event: TRoomEvent;
 };
 declare type UpdatePresenceClientMsg<TPresence extends JsonObject> = {
   type: ClientMsgCode.UPDATE_PRESENCE;
@@ -76,6 +145,66 @@ declare type FetchStorageClientMsg = {
   type: ClientMsgCode.FETCH_STORAGE;
 };
 
+declare type IdTuple<T> = [id: string, value: T];
+declare enum CrdtType {
+  OBJECT = 0,
+  LIST = 1,
+  MAP = 2,
+  REGISTER = 3,
+}
+declare type SerializedCrdt = SerializedRootObject | SerializedChild;
+declare type SerializedChild =
+  | SerializedObject
+  | SerializedList
+  | SerializedMap
+  | SerializedRegister;
+declare type SerializedRootObject = {
+  type: CrdtType.OBJECT;
+  data: JsonObject;
+  parentId?: never;
+  parentKey?: never;
+};
+declare type SerializedObject = {
+  type: CrdtType.OBJECT;
+  parentId: string;
+  parentKey: string;
+  data: JsonObject;
+};
+declare type SerializedList = {
+  type: CrdtType.LIST;
+  parentId: string;
+  parentKey: string;
+};
+declare type SerializedMap = {
+  type: CrdtType.MAP;
+  parentId: string;
+  parentKey: string;
+};
+declare type SerializedRegister = {
+  type: CrdtType.REGISTER;
+  parentId: string;
+  parentKey: string;
+  data: Json;
+};
+declare function isRootCrdt(crdt: SerializedCrdt): crdt is SerializedRootObject;
+declare function isChildCrdt(crdt: SerializedCrdt): crdt is SerializedChild;
+
+/**
+ * Lookup table for nodes (= SerializedCrdt values) by their IDs.
+ */
+declare type NodeMap = Map<
+  string, // Node ID
+  SerializedCrdt
+>;
+/**
+ * Reverse lookup table for all child nodes (= list of SerializedCrdt values)
+ * by their parent node's IDs.
+ */
+declare type ParentToChildNodeMap = Map<
+  string, // Parent's node ID
+  IdTuple<SerializedChild>[]
+>;
+
 declare enum ServerMsgCode {
   UPDATE_PRESENCE = 100,
   USER_JOINED = 101,
@@ -88,12 +217,16 @@ declare enum ServerMsgCode {
 /**
  * Messages that can be sent from the server to the client.
  */
-declare type ServerMsg<TPresence extends JsonObject> =
+declare type ServerMsg<
+  TPresence extends JsonObject,
+  TUserMeta extends BaseUserMeta,
+  TRoomEvent extends Json
+> =
   | UpdatePresenceServerMsg<TPresence>
-  | UserJoinServerMsg
+  | UserJoinServerMsg<TUserMeta>
   | UserLeftServerMsg
-  | BroadcastedEventServerMsg
-  | RoomStateServerMsg
+  | BroadcastedEventServerMsg<TRoomEvent>
+  | RoomStateServerMsg<TUserMeta>
   | InitialDocumentStateServerMsg
   | UpdateStorageServerMsg;
 /**
@@ -130,19 +263,19 @@ declare type UpdatePresenceServerMsg<TPresence extends JsonObject> = {
  * Sent by the WebSocket server and broadcasted to all clients to announce that
  * a new User has joined the Room.
  */
-declare type UserJoinServerMsg = {
+declare type UserJoinServerMsg<TUserMeta extends BaseUserMeta> = {
   type: ServerMsgCode.USER_JOINED;
   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;
+  id: TUserMeta["id"];
   /**
    * Additional user information that has been set in the authentication
    * endpoint.
    */
-  info?: Json;
+  info: TUserMeta["info"];
 };
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
@@ -156,7 +289,7 @@ declare type UserLeftServerMsg = {
  * 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 BroadcastedEventServerMsg = {
+declare type BroadcastedEventServerMsg<TRoomEvent extends Json> = {
   type: ServerMsgCode.BROADCASTED_EVENT;
   /**
    * The User who broadcasted the Event.
@@ -166,20 +299,17 @@ declare type BroadcastedEventServerMsg = {
    * The arbitrary payload of the Event. This can be any JSON value. Clients
    * will have to manually verify/decode this event.
    */
-  event: Json;
+  event: TRoomEvent;
 };
 /**
  * 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 RoomStateServerMsg = {
+declare type RoomStateServerMsg<TUserMeta extends BaseUserMeta> = {
   type: ServerMsgCode.ROOM_STATE;
   users: {
-    [actor: number]: {
-      id?: string;
-      info?: Json;
-    };
+    [actor: number]: TUserMeta;
   };
 };
 /**
@@ -263,15 +393,10 @@ declare type RoomAuthToken = {
   info?: Json;
 };
 declare type AuthToken = AppOnlyAuthToken | RoomAuthToken;
-interface JwtMetadata extends JsonObject {
-  iat: number;
-  exp: number;
-}
 declare function isScope(value: unknown): value is Scope;
 declare function isAppOnlyAuthToken(data: JsonObject): data is AppOnlyAuthToken;
 declare function isRoomAuthToken(data: JsonObject): data is RoomAuthToken;
 declare function isAuthToken(data: JsonObject): data is AuthToken;
-declare function parseAuthToken(token: string): AuthToken & JwtMetadata;
 
 /**
  * Tools to help with the controlled deprecation of public APIs.
@@ -342,13 +467,37 @@ export {
   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,
@@ -363,13 +512,14 @@ export {
   errorIf,
   isAppOnlyAuthToken,
   isAuthToken,
+  isChildCrdt,
   isPlainObject,
   isRoomAuthToken,
+  isRootCrdt,
   isScope,
   lsonToJson,
   makePosition,
   nn,
-  parseAuthToken,
   patchImmutableObject,
   patchLiveObjectKey,
   throwUsageError,

package/internal.js

@@ -310,7 +310,6 @@ Object.defineProperty(exports, "ClientMsgCode", {
   (exports.isScope = Json.isScope),
   (exports.makePosition = Json.makePosition),
   (exports.nn = Json.nn),
-  (exports.parseAuthToken = Json.parseAuthToken),
   (exports.throwUsageError = Json.throwUsageError),
   (exports.tryParseJson = Json.tryParseJson),
   (exports.lsonToJson = lsonToJson),

package/internal.mjs

@@ -1,38 +1,37 @@
 import {
   L as LiveObject,
-  o as LiveList,
-  q as LiveMap,
-  s as LiveRegister,
-  a as isPlainObject,
-  u as findNonSerializableValue,
-  e as isLiveList,
-  v as isLiveObject,
+  q as LiveList,
+  s as LiveMap,
+  u as LiveRegister,
+  b as isPlainObject,
+  v as findNonSerializableValue,
+  f as isLiveList,
+  w as isLiveObject,
 } from "./shared.mjs";
 export {
   C as ClientMsgCode,
   I as CrdtType,
-  d as OpCode,
+  e as OpCode,
   S as ServerMsgCode,
   W as WebsocketCloseCodes,
-  w as assertNever,
+  x as assertNever,
   M as b64decode,
   G as comparePosition,
   D as deprecate,
   E as deprecateIf,
-  l as errorIf,
-  x as isAppOnlyAuthToken,
-  y as isAuthToken,
+  o as errorIf,
+  y as isAppOnlyAuthToken,
+  z as isAuthToken,
   K as isChildCrdt,
-  f as isJsonArray,
-  k as isJsonObject,
+  h as isJsonArray,
+  l as isJsonObject,
   J as isJsonScalar,
-  a as isPlainObject,
-  z as isRoomAuthToken,
-  j as isRootCrdt,
-  A as isScope,
+  b as isPlainObject,
+  A as isRoomAuthToken,
+  k as isRootCrdt,
+  B as isScope,
   H as makePosition,
   n as nn,
-  B as parseAuthToken,
   F as throwUsageError,
   t as tryParseJson,
 } from "./shared.mjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/client",
-  "version": "0.17.0-test1",
+  "version": "0.17.1",
   "description": "A client that lets you interact with Liveblocks servers.",
   "main": "./index.js",
   "module": "./index.mjs",