@liveblocks/client 0.16.15 → 0.17.0-test1

package/internal.d.ts

@@ -1,45 +1,101 @@
-import { d as JsonObject, J as Json, g as Resolve, e as Lson, A as AbstractCrdt, f as LsonObject, L as LiveObject, S as StorageUpdate } from './shared';
-export { g as Resolve, h as RoomInitializers, i as isJsonArray, j as isJsonObject, k as isJsonScalar } from './shared';
+import {
+  d as JsonObject,
+  J as Json,
+  h as Op,
+  I as IdTuple,
+  i as SerializedCrdt,
+  f as Lson,
+  g 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,
+  W as WebsocketCloseCodes,
+  V as isChildCrdt,
+  M as isJsonArray,
+  Q as isJsonObject,
+  T as isJsonScalar,
+  X as isRootCrdt,
+} from "./shared.js";
 
-declare type IdTuple<T> = [id: string, value: T];
-/**
- * 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 ClientMsgCode {
+  UPDATE_PRESENCE = 100,
+  BROADCAST_EVENT = 103,
+  FETCH_STORAGE = 200,
+  UPDATE_STORAGE = 201,
+}
 /**
- * Messages that can be sent from the server to the client.
+ * Messages that can be sent from the client to the server.
  */
-declare type ServerMsg<TPresence extends JsonObject> = UpdatePresenceServerMsg<TPresence> | UserJoinServerMsg | UserLeftServerMsg | BroadcastedEventServerMsg | RoomStateServerMsg | InitialDocumentStateServerMsg | UpdateStorageServerMsg;
+declare type ClientMsg<TPresence extends JsonObject> =
+  | BroadcastEventClientMsg
+  | UpdatePresenceClientMsg<TPresence>
+  | UpdateStorageClientMsg
+  | FetchStorageClientMsg;
+declare type BroadcastEventClientMsg = {
+  type: ClientMsgCode.BROADCAST_EVENT;
+  event: Json;
+};
+declare type UpdatePresenceClientMsg<TPresence extends JsonObject> = {
+  type: ClientMsgCode.UPDATE_PRESENCE;
+  data: TPresence;
+  targetActor?: number;
+};
+declare type UpdateStorageClientMsg = {
+  type: ClientMsgCode.UPDATE_STORAGE;
+  ops: Op[];
+};
+declare type FetchStorageClientMsg = {
+  type: ClientMsgCode.FETCH_STORAGE;
+};
+
 declare enum ServerMsgCode {
-    UPDATE_PRESENCE = 100,
-    USER_JOINED = 101,
-    USER_LEFT = 102,
-    BROADCASTED_EVENT = 103,
-    ROOM_STATE = 104,
-    INITIAL_STORAGE_STATE = 200,
-    UPDATE_STORAGE = 201
+  UPDATE_PRESENCE = 100,
+  USER_JOINED = 101,
+  USER_LEFT = 102,
+  BROADCASTED_EVENT = 103,
+  ROOM_STATE = 104,
+  INITIAL_STORAGE_STATE = 200,
+  UPDATE_STORAGE = 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.
+ * Messages that can be sent from the server to the client.
  */
-declare type RoomStateServerMsg = {
-    type: ServerMsgCode.ROOM_STATE;
-    users: {
-        [actor: number]: {
-            id?: string;
-            info?: Json;
-        };
-    };
-};
+declare type ServerMsg<TPresence extends JsonObject> =
+  | UpdatePresenceServerMsg<TPresence>
+  | UserJoinServerMsg
+  | UserLeftServerMsg
+  | BroadcastedEventServerMsg
+  | RoomStateServerMsg
+  | InitialDocumentStateServerMsg
+  | UpdateStorageServerMsg;
 /**
  * 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.
@@ -52,65 +108,79 @@ declare type RoomStateServerMsg = {
  * so all other existing clients can ignore this broadcasted message.
  */
 declare type UpdatePresenceServerMsg<TPresence extends JsonObject> = {
-    type: ServerMsgCode.UPDATE_PRESENCE;
-    /**
-     * 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: TPresence;
-    /**
-     * 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;
+  type: ServerMsgCode.UPDATE_PRESENCE;
+  /**
+   * 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: TPresence;
+  /**
+   * 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 UserJoinServerMsg = {
-    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;
-    /**
-     * Additional user information that has been set in the authentication
-     * endpoint.
-     */
-    info?: Json;
+  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;
+  /**
+   * 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 UserLeftServerMsg = {
-    type: ServerMsgCode.USER_LEFT;
-    actor: number;
+  type: ServerMsgCode.USER_LEFT;
+  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 BroadcastedEventServerMsg = {
-    type: ServerMsgCode.BROADCASTED_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;
+  type: ServerMsgCode.BROADCASTED_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;
+};
+/**
+ * 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 = {
+  type: ServerMsgCode.ROOM_STATE;
+  users: {
+    [actor: number]: {
+      id?: string;
+      info?: Json;
+    };
+  };
 };
 /**
  * Sent by the WebSocket server to a single client in response to the client
@@ -118,8 +188,8 @@ declare type BroadcastedEventServerMsg = {
  * payload includes the entire Storage document.
  */
 declare type InitialDocumentStateServerMsg = {
-    type: ServerMsgCode.INITIAL_STORAGE_STATE;
-    items: IdTuple<SerializedCrdt>[];
+  type: ServerMsgCode.INITIAL_STORAGE_STATE;
+  items: IdTuple<SerializedCrdt>[];
 };
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
@@ -129,162 +199,79 @@ declare type InitialDocumentStateServerMsg = {
  * mutations to make to the initially loaded document).
  */
 declare type UpdateStorageServerMsg = {
-    type: ServerMsgCode.UPDATE_STORAGE;
-    ops: Op[];
+  type: ServerMsgCode.UPDATE_STORAGE;
+  ops: Op[];
 };
+
 /**
- * Messages that can be sent from the client to the server.
+ * Helper function that can be used to implement exhaustive switch statements
+ * with TypeScript. Example usage:
+ *
+ *    type Fruit = "🍎" | "🍌";
+ *
+ *    switch (fruit) {
+ *      case "🍎":
+ *      case "🍌":
+ *        return doSomething();
+ *
+ *      default:
+ *        return assertNever(fruit, "Unknown fruit");
+ *    }
+ *
+ * If now the Fruit union is extended (i.e. add "🍒"), TypeScript will catch
+ * this *statically*, rather than at runtime, and force you to handle the
+ * 🍒 case.
  */
-declare type ClientMsg<TPresence extends JsonObject> = BroadcastEventClientMsg | UpdatePresenceClientMsg<TPresence> | UpdateStorageClientMsg | FetchStorageClientMsg;
-declare enum ClientMsgCode {
-    UPDATE_PRESENCE = 100,
-    BROADCAST_EVENT = 103,
-    FETCH_STORAGE = 200,
-    UPDATE_STORAGE = 201
-}
-declare type BroadcastEventClientMsg = {
-    type: ClientMsgCode.BROADCAST_EVENT;
-    event: Json;
-};
-declare type UpdatePresenceClientMsg<TPresence extends JsonObject> = {
-    type: ClientMsgCode.UPDATE_PRESENCE;
-    data: TPresence;
-    targetActor?: number;
-};
-declare type UpdateStorageClientMsg = {
-    type: ClientMsgCode.UPDATE_STORAGE;
-    ops: Op[];
-};
-declare type FetchStorageClientMsg = {
-    type: ClientMsgCode.FETCH_STORAGE;
-};
-declare enum CrdtType {
-    OBJECT = 0,
-    LIST = 1,
-    MAP = 2,
-    REGISTER = 3
-}
-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 type SerializedCrdt = SerializedRootObject | SerializedChild;
-declare type SerializedChild = SerializedObject | SerializedList | SerializedMap | SerializedRegister;
-declare function isRootCrdt(crdt: SerializedCrdt): crdt is SerializedRootObject;
-declare function isChildCrdt(crdt: SerializedCrdt): crdt is SerializedChild;
-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
-}
+declare function assertNever(_value: never, errmsg: string): never;
 /**
- * These operations are the payload for {@link UpdateStorageServerMsg} messages
- * only.
+ * Asserts that a given value is non-nullable. This is similar to TypeScript's
+ * `!` operator, but will throw an error at runtime (dev-mode only) indicating
+ * an incorrect assumption.
+ *
+ * Instead of:
+ *
+ *     foo!.bar
+ *
+ * Use:
+ *
+ *     nn(foo).bar
+ *
  */
-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";
-    type: OpCode.CREATE_OBJECT;
-    parentId: string;
-    parentKey: string;
-    data: JsonObject;
-};
-declare type CreateRootObjectOp = Resolve<Omit<CreateObjectOp, "parentId" | "parentKey"> & {
-    parentId?: never;
-    parentKey?: never;
-}>;
-declare type CreateListOp = {
-    opId?: string;
-    id: string;
-    intent?: "set";
-    type: OpCode.CREATE_LIST;
-    parentId: string;
-    parentKey: string;
-};
-declare type CreateMapOp = {
-    opId?: string;
-    id: string;
-    intent?: "set";
-    type: OpCode.CREATE_MAP;
-    parentId: string;
-    parentKey: string;
-};
-declare type CreateRegisterOp = {
-    opId?: string;
-    id: string;
-    intent?: "set";
-    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 function nn<T>(value: T, errmsg?: string): NonNullable<T>;
+
+declare const SCOPES: readonly [
+  "websocket:presence",
+  "websocket:storage",
+  "room:read",
+  "room:write",
+  "rooms:read",
+  "rooms:write"
+];
+declare type Scope = typeof SCOPES[number];
+declare type AppOnlyAuthToken = {
+  appId: string;
+  roomId?: never;
+  scopes: string[];
 };
-declare type DeleteObjectKeyOp = {
-    opId?: string;
-    id: string;
-    type: OpCode.DELETE_OBJECT_KEY;
-    key: string;
+declare type RoomAuthToken = {
+  appId: string;
+  roomId: string;
+  scopes: string[];
+  actor: number;
+  maxConnectionsPerRoom?: number;
+  id?: string;
+  info?: Json;
 };
-declare enum WebsocketCloseCodes {
-    CLOSE_ABNORMAL = 1006,
-    INVALID_MESSAGE_FORMAT = 4000,
-    NOT_ALLOWED = 4001,
-    MAX_NUMBER_OF_MESSAGES_PER_SECONDS = 4002,
-    MAX_NUMBER_OF_CONCURRENT_CONNECTIONS = 4003,
-    MAX_NUMBER_OF_MESSAGES_PER_DAY_PER_APP = 4004,
-    MAX_NUMBER_OF_CONCURRENT_CONNECTIONS_PER_ROOM = 4005,
-    CLOSE_WITHOUT_RETRY = 4999
+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.
@@ -301,7 +288,11 @@ declare function deprecate(message: string, key?: string): void;
  * console if the first argument is truthy. Only in dev mode, and
  * only once per message/key. In production, this is a no-op.
  */
-declare function deprecateIf(condition: unknown, message: string, key?: string): void;
+declare function deprecateIf(
+  condition: unknown,
+  message: string,
+  key?: string
+): void;
 /**
  * Throws a deprecation error in the dev console.
  *
@@ -317,33 +308,23 @@ declare function throwUsageError(message: string): void;
  */
 declare function errorIf(condition: unknown, message: string): void;
 
-declare function lsonToJson(value: Lson | AbstractCrdt): Json;
-declare function patchLiveObjectKey<O extends LsonObject>(liveObject: LiveObject<O>, key: keyof O, prev: unknown, next: unknown): void;
-declare function patchImmutableObject<T>(state: T, updates: StorageUpdate[]): T;
+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 makePosition(before?: string, after?: string): string;
 declare function comparePosition(posA: string, posB: string): number;
 
-/**
- * Helper function that can be used to implement exhaustive switch statements
- * with TypeScript. Example usage:
- *
- *    type Fruit = "🍎" | "🍌";
- *
- *    switch (fruit) {
- *      case "🍎":
- *      case "🍌":
- *        return doSomething();
- *
- *      default:
- *        return assertNever(fruit, "Unknown fruit");
- *    }
- *
- * If now the Fruit union is extended (i.e. add "🍒"), TypeScript will catch
- * this *statically*, rather than at runtime, and force you to handle the
- * 🍒 case.
- */
-declare function assertNever(_value: never, errmsg: string): never;
+declare function isPlainObject(blob: unknown): blob is {
+  [key: string]: unknown;
+};
 /**
  * Alternative to JSON.parse() that will not throw in production. If the passed
  * string cannot be parsed, this will return `undefined`.
@@ -354,4 +335,43 @@ declare function tryParseJson(rawMessage: string): Json | undefined;
  */
 declare function b64decode(b64value: string): string;
 
-export { BroadcastEventClientMsg, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, FetchStorageClientMsg, IdTuple, InitialDocumentStateServerMsg, NodeMap, Op, OpCode, ParentToChildNodeMap, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, UpdateObjectOp, UpdatePresenceClientMsg, UpdateStorageClientMsg, UserJoinServerMsg, WebsocketCloseCodes, assertNever, b64decode, comparePosition, deprecate, deprecateIf, errorIf, isChildCrdt, isRootCrdt, lsonToJson, makePosition, patchImmutableObject, patchLiveObjectKey, throwUsageError, tryParseJson };
+export {
+  AppOnlyAuthToken,
+  AuthToken,
+  BroadcastEventClientMsg,
+  BroadcastedEventServerMsg,
+  ClientMsg,
+  ClientMsgCode,
+  FetchStorageClientMsg,
+  InitialDocumentStateServerMsg,
+  RoomAuthToken,
+  RoomStateServerMsg,
+  Scope,
+  ServerMsg,
+  ServerMsgCode,
+  UpdatePresenceClientMsg,
+  UpdatePresenceServerMsg,
+  UpdateStorageClientMsg,
+  UpdateStorageServerMsg,
+  UserJoinServerMsg,
+  UserLeftServerMsg,
+  assertNever,
+  b64decode,
+  comparePosition,
+  deprecate,
+  deprecateIf,
+  errorIf,
+  isAppOnlyAuthToken,
+  isAuthToken,
+  isPlainObject,
+  isRoomAuthToken,
+  isScope,
+  lsonToJson,
+  makePosition,
+  nn,
+  parseAuthToken,
+  patchImmutableObject,
+  patchLiveObjectKey,
+  throwUsageError,
+  tryParseJson,
+};