@liveblocks/core 3.11.1 → 3.12.1-enums1

package/dist/index.d.cts

@@ -331,16 +331,28 @@ type ContextualPromptContext = {
     afterSelection: string;
 };
 
-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
+type OpCode = (typeof OpCode)[keyof typeof OpCode];
+declare const OpCode: Readonly<{
+    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 namespace OpCode {
+    type INIT = typeof OpCode.INIT;
+    type SET_PARENT_KEY = typeof OpCode.SET_PARENT_KEY;
+    type CREATE_LIST = typeof OpCode.CREATE_LIST;
+    type UPDATE_OBJECT = typeof OpCode.UPDATE_OBJECT;
+    type CREATE_OBJECT = typeof OpCode.CREATE_OBJECT;
+    type DELETE_CRDT = typeof OpCode.DELETE_CRDT;
+    type DELETE_OBJECT_KEY = typeof OpCode.DELETE_OBJECT_KEY;
+    type CREATE_MAP = typeof OpCode.CREATE_MAP;
+    type CREATE_REGISTER = typeof OpCode.CREATE_REGISTER;
 }
 /**
  * These operations are the payload for {@link UpdateStorageServerMsg} messages
@@ -434,13 +446,22 @@ type DeleteObjectKeyOp = {
     readonly key: string;
 };
 
-declare enum ClientMsgCode {
-    UPDATE_PRESENCE = 100,
-    BROADCAST_EVENT = 103,
-    FETCH_STORAGE = 200,
-    UPDATE_STORAGE = 201,
-    FETCH_YDOC = 300,
-    UPDATE_YDOC = 301
+type ClientMsgCode = (typeof ClientMsgCode)[keyof typeof ClientMsgCode];
+declare const ClientMsgCode: Readonly<{
+    UPDATE_PRESENCE: 100;
+    BROADCAST_EVENT: 103;
+    FETCH_STORAGE: 200;
+    UPDATE_STORAGE: 201;
+    FETCH_YDOC: 300;
+    UPDATE_YDOC: 301;
+}>;
+declare namespace ClientMsgCode {
+    type UPDATE_PRESENCE = typeof ClientMsgCode.UPDATE_PRESENCE;
+    type BROADCAST_EVENT = typeof ClientMsgCode.BROADCAST_EVENT;
+    type FETCH_STORAGE = typeof ClientMsgCode.FETCH_STORAGE;
+    type UPDATE_STORAGE = typeof ClientMsgCode.UPDATE_STORAGE;
+    type FETCH_YDOC = typeof ClientMsgCode.FETCH_YDOC;
+    type UPDATE_YDOC = typeof ClientMsgCode.UPDATE_YDOC;
 }
 /**
  * Messages that can be sent from the client to the server.
@@ -573,11 +594,18 @@ type PlainLsonList = {
 type PlainLson = PlainLsonObject | PlainLsonMap | PlainLsonList | Json;
 
 type IdTuple<T> = [id: string, value: T];
-declare enum CrdtType {
-    OBJECT = 0,
-    LIST = 1,
-    MAP = 2,
-    REGISTER = 3
+type CrdtType = (typeof CrdtType)[keyof typeof CrdtType];
+declare const CrdtType: Readonly<{
+    OBJECT: 0;
+    LIST: 1;
+    MAP: 2;
+    REGISTER: 3;
+}>;
+declare namespace CrdtType {
+    type OBJECT = typeof CrdtType.OBJECT;
+    type LIST = typeof CrdtType.LIST;
+    type MAP = typeof CrdtType.MAP;
+    type REGISTER = typeof CrdtType.REGISTER;
 }
 type SerializedCrdt = SerializedRootObject | SerializedChild;
 type SerializedChild = SerializedObject | SerializedList | SerializedMap | SerializedRegister;
@@ -1516,6 +1544,7 @@ declare enum TextEditorType {
     TipTap = "tiptap",
     BlockNote = "blocknote"
 }
+type BadgeLocation = "top-right" | "bottom-right" | "bottom-left" | "top-left";
 
 type OptionalKeys<T> = {
     [K in keyof T]-?: undefined extends T[K] ? K : never;
@@ -2318,6 +2347,11 @@ type ClientOptions<U extends BaseUserMeta = DU> = {
      * the server yet.
      */
     preventUnsavedChanges?: boolean;
+    /**
+     * The location where the brand badge should be displayed when using a free plan.
+     * Default is "bottom-right".
+     */
+    badgeLocation?: BadgeLocation;
 } & Relax<{
     publicApiKey: string;
 } | {
@@ -2462,25 +2496,46 @@ type Delegates<T extends BaseAuthResult> = {
     canZombie: () => boolean;
 };
 
-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_YDOC = 300,
-    THREAD_CREATED = 400,
-    THREAD_DELETED = 407,
-    THREAD_METADATA_UPDATED = 401,
-    THREAD_UPDATED = 408,
-    COMMENT_CREATED = 402,
-    COMMENT_EDITED = 403,
-    COMMENT_DELETED = 404,
-    COMMENT_REACTION_ADDED = 405,
-    COMMENT_REACTION_REMOVED = 406,
-    REJECT_STORAGE_OP = 299
+type ServerMsgCode = (typeof ServerMsgCode)[keyof typeof ServerMsgCode];
+declare const ServerMsgCode: Readonly<{
+    UPDATE_PRESENCE: 100;
+    USER_JOINED: 101;
+    USER_LEFT: 102;
+    BROADCASTED_EVENT: 103;
+    ROOM_STATE: 104;
+    INITIAL_STORAGE_STATE: 200;
+    UPDATE_STORAGE: 201;
+    UPDATE_YDOC: 300;
+    THREAD_CREATED: 400;
+    THREAD_DELETED: 407;
+    THREAD_METADATA_UPDATED: 401;
+    THREAD_UPDATED: 408;
+    COMMENT_CREATED: 402;
+    COMMENT_EDITED: 403;
+    COMMENT_DELETED: 404;
+    COMMENT_REACTION_ADDED: 405;
+    COMMENT_REACTION_REMOVED: 406;
+    REJECT_STORAGE_OP: 299;
+}>;
+declare namespace ServerMsgCode {
+    type UPDATE_PRESENCE = typeof ServerMsgCode.UPDATE_PRESENCE;
+    type USER_JOINED = typeof ServerMsgCode.USER_JOINED;
+    type USER_LEFT = typeof ServerMsgCode.USER_LEFT;
+    type BROADCASTED_EVENT = typeof ServerMsgCode.BROADCASTED_EVENT;
+    type ROOM_STATE = typeof ServerMsgCode.ROOM_STATE;
+    type INITIAL_STORAGE_STATE = typeof ServerMsgCode.INITIAL_STORAGE_STATE;
+    type UPDATE_STORAGE = typeof ServerMsgCode.UPDATE_STORAGE;
+    type UPDATE_YDOC = typeof ServerMsgCode.UPDATE_YDOC;
+    type THREAD_CREATED = typeof ServerMsgCode.THREAD_CREATED;
+    type THREAD_DELETED = typeof ServerMsgCode.THREAD_DELETED;
+    type THREAD_METADATA_UPDATED = typeof ServerMsgCode.THREAD_METADATA_UPDATED;
+    type THREAD_UPDATED = typeof ServerMsgCode.THREAD_UPDATED;
+    type COMMENT_CREATED = typeof ServerMsgCode.COMMENT_CREATED;
+    type COMMENT_EDITED = typeof ServerMsgCode.COMMENT_EDITED;
+    type COMMENT_DELETED = typeof ServerMsgCode.COMMENT_DELETED;
+    type COMMENT_REACTION_ADDED = typeof ServerMsgCode.COMMENT_REACTION_ADDED;
+    type COMMENT_REACTION_REMOVED = typeof ServerMsgCode.COMMENT_REACTION_REMOVED;
+    type REJECT_STORAGE_OP = typeof ServerMsgCode.REJECT_STORAGE_OP;
 }
 /**
  * Messages that can be sent from the server to the client.
@@ -2669,6 +2724,10 @@ type RoomStateServerMsg<U extends BaseUserMeta> = {
             scopes: string[];
         };
     };
+    /**
+     * Metadata sent from the server to the client.
+     */
+    readonly meta: JsonObject;
 };
 /**
  * Sent by the WebSocket server to a single client in response to the client
@@ -3554,6 +3613,7 @@ type DynamicSessionInfo = {
     readonly actor: number;
     readonly nonce: string;
     readonly scopes: string[];
+    readonly meta: JsonObject;
 };
 type Polyfills = {
     atob?: (data: string) => string;

package/dist/index.d.ts

@@ -331,16 +331,28 @@ type ContextualPromptContext = {
     afterSelection: string;
 };
 
-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
+type OpCode = (typeof OpCode)[keyof typeof OpCode];
+declare const OpCode: Readonly<{
+    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 namespace OpCode {
+    type INIT = typeof OpCode.INIT;
+    type SET_PARENT_KEY = typeof OpCode.SET_PARENT_KEY;
+    type CREATE_LIST = typeof OpCode.CREATE_LIST;
+    type UPDATE_OBJECT = typeof OpCode.UPDATE_OBJECT;
+    type CREATE_OBJECT = typeof OpCode.CREATE_OBJECT;
+    type DELETE_CRDT = typeof OpCode.DELETE_CRDT;
+    type DELETE_OBJECT_KEY = typeof OpCode.DELETE_OBJECT_KEY;
+    type CREATE_MAP = typeof OpCode.CREATE_MAP;
+    type CREATE_REGISTER = typeof OpCode.CREATE_REGISTER;
 }
 /**
  * These operations are the payload for {@link UpdateStorageServerMsg} messages
@@ -434,13 +446,22 @@ type DeleteObjectKeyOp = {
     readonly key: string;
 };
 
-declare enum ClientMsgCode {
-    UPDATE_PRESENCE = 100,
-    BROADCAST_EVENT = 103,
-    FETCH_STORAGE = 200,
-    UPDATE_STORAGE = 201,
-    FETCH_YDOC = 300,
-    UPDATE_YDOC = 301
+type ClientMsgCode = (typeof ClientMsgCode)[keyof typeof ClientMsgCode];
+declare const ClientMsgCode: Readonly<{
+    UPDATE_PRESENCE: 100;
+    BROADCAST_EVENT: 103;
+    FETCH_STORAGE: 200;
+    UPDATE_STORAGE: 201;
+    FETCH_YDOC: 300;
+    UPDATE_YDOC: 301;
+}>;
+declare namespace ClientMsgCode {
+    type UPDATE_PRESENCE = typeof ClientMsgCode.UPDATE_PRESENCE;
+    type BROADCAST_EVENT = typeof ClientMsgCode.BROADCAST_EVENT;
+    type FETCH_STORAGE = typeof ClientMsgCode.FETCH_STORAGE;
+    type UPDATE_STORAGE = typeof ClientMsgCode.UPDATE_STORAGE;
+    type FETCH_YDOC = typeof ClientMsgCode.FETCH_YDOC;
+    type UPDATE_YDOC = typeof ClientMsgCode.UPDATE_YDOC;
 }
 /**
  * Messages that can be sent from the client to the server.
@@ -573,11 +594,18 @@ type PlainLsonList = {
 type PlainLson = PlainLsonObject | PlainLsonMap | PlainLsonList | Json;
 
 type IdTuple<T> = [id: string, value: T];
-declare enum CrdtType {
-    OBJECT = 0,
-    LIST = 1,
-    MAP = 2,
-    REGISTER = 3
+type CrdtType = (typeof CrdtType)[keyof typeof CrdtType];
+declare const CrdtType: Readonly<{
+    OBJECT: 0;
+    LIST: 1;
+    MAP: 2;
+    REGISTER: 3;
+}>;
+declare namespace CrdtType {
+    type OBJECT = typeof CrdtType.OBJECT;
+    type LIST = typeof CrdtType.LIST;
+    type MAP = typeof CrdtType.MAP;
+    type REGISTER = typeof CrdtType.REGISTER;
 }
 type SerializedCrdt = SerializedRootObject | SerializedChild;
 type SerializedChild = SerializedObject | SerializedList | SerializedMap | SerializedRegister;
@@ -1516,6 +1544,7 @@ declare enum TextEditorType {
     TipTap = "tiptap",
     BlockNote = "blocknote"
 }
+type BadgeLocation = "top-right" | "bottom-right" | "bottom-left" | "top-left";
 
 type OptionalKeys<T> = {
     [K in keyof T]-?: undefined extends T[K] ? K : never;
@@ -2318,6 +2347,11 @@ type ClientOptions<U extends BaseUserMeta = DU> = {
      * the server yet.
      */
     preventUnsavedChanges?: boolean;
+    /**
+     * The location where the brand badge should be displayed when using a free plan.
+     * Default is "bottom-right".
+     */
+    badgeLocation?: BadgeLocation;
 } & Relax<{
     publicApiKey: string;
 } | {
@@ -2462,25 +2496,46 @@ type Delegates<T extends BaseAuthResult> = {
     canZombie: () => boolean;
 };
 
-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_YDOC = 300,
-    THREAD_CREATED = 400,
-    THREAD_DELETED = 407,
-    THREAD_METADATA_UPDATED = 401,
-    THREAD_UPDATED = 408,
-    COMMENT_CREATED = 402,
-    COMMENT_EDITED = 403,
-    COMMENT_DELETED = 404,
-    COMMENT_REACTION_ADDED = 405,
-    COMMENT_REACTION_REMOVED = 406,
-    REJECT_STORAGE_OP = 299
+type ServerMsgCode = (typeof ServerMsgCode)[keyof typeof ServerMsgCode];
+declare const ServerMsgCode: Readonly<{
+    UPDATE_PRESENCE: 100;
+    USER_JOINED: 101;
+    USER_LEFT: 102;
+    BROADCASTED_EVENT: 103;
+    ROOM_STATE: 104;
+    INITIAL_STORAGE_STATE: 200;
+    UPDATE_STORAGE: 201;
+    UPDATE_YDOC: 300;
+    THREAD_CREATED: 400;
+    THREAD_DELETED: 407;
+    THREAD_METADATA_UPDATED: 401;
+    THREAD_UPDATED: 408;
+    COMMENT_CREATED: 402;
+    COMMENT_EDITED: 403;
+    COMMENT_DELETED: 404;
+    COMMENT_REACTION_ADDED: 405;
+    COMMENT_REACTION_REMOVED: 406;
+    REJECT_STORAGE_OP: 299;
+}>;
+declare namespace ServerMsgCode {
+    type UPDATE_PRESENCE = typeof ServerMsgCode.UPDATE_PRESENCE;
+    type USER_JOINED = typeof ServerMsgCode.USER_JOINED;
+    type USER_LEFT = typeof ServerMsgCode.USER_LEFT;
+    type BROADCASTED_EVENT = typeof ServerMsgCode.BROADCASTED_EVENT;
+    type ROOM_STATE = typeof ServerMsgCode.ROOM_STATE;
+    type INITIAL_STORAGE_STATE = typeof ServerMsgCode.INITIAL_STORAGE_STATE;
+    type UPDATE_STORAGE = typeof ServerMsgCode.UPDATE_STORAGE;
+    type UPDATE_YDOC = typeof ServerMsgCode.UPDATE_YDOC;
+    type THREAD_CREATED = typeof ServerMsgCode.THREAD_CREATED;
+    type THREAD_DELETED = typeof ServerMsgCode.THREAD_DELETED;
+    type THREAD_METADATA_UPDATED = typeof ServerMsgCode.THREAD_METADATA_UPDATED;
+    type THREAD_UPDATED = typeof ServerMsgCode.THREAD_UPDATED;
+    type COMMENT_CREATED = typeof ServerMsgCode.COMMENT_CREATED;
+    type COMMENT_EDITED = typeof ServerMsgCode.COMMENT_EDITED;
+    type COMMENT_DELETED = typeof ServerMsgCode.COMMENT_DELETED;
+    type COMMENT_REACTION_ADDED = typeof ServerMsgCode.COMMENT_REACTION_ADDED;
+    type COMMENT_REACTION_REMOVED = typeof ServerMsgCode.COMMENT_REACTION_REMOVED;
+    type REJECT_STORAGE_OP = typeof ServerMsgCode.REJECT_STORAGE_OP;
 }
 /**
  * Messages that can be sent from the server to the client.
@@ -2669,6 +2724,10 @@ type RoomStateServerMsg<U extends BaseUserMeta> = {
             scopes: string[];
         };
     };
+    /**
+     * Metadata sent from the server to the client.
+     */
+    readonly meta: JsonObject;
 };
 /**
  * Sent by the WebSocket server to a single client in response to the client
@@ -3554,6 +3613,7 @@ type DynamicSessionInfo = {
     readonly actor: number;
     readonly nonce: string;
     readonly scopes: string[];
+    readonly meta: JsonObject;
 };
 type Polyfills = {
     atob?: (data: string) => string;