@liveblocks/core 1.10.0-beta2 → 1.10.0-beta4

package/dist/index.d.mts

@@ -179,12 +179,15 @@ interface IWebSocket {
 /**
  * The following ranges will be respected by the client:
  *
+ *   10xx: client will reauthorize (just like 41xx)
  *   40xx: client will disconnect
  *   41xx: client will reauthorize
  *   42xx: client will retry without reauthorizing (currently not used)
  *
  */
 declare enum WebsocketCloseCodes {
+    /** Normal close of connection, the connection fulfilled its purpose. */
+    CLOSE_NORMAL = 1000,
     /** Unexpected error happened with the network/infra level. In spirit akin to HTTP 503 */
     CLOSE_ABNORMAL = 1006,
     /** Unexpected error happened. In spirit akin to HTTP 500 */
@@ -203,6 +206,8 @@ declare enum WebsocketCloseCodes {
     MAX_NUMBER_OF_MESSAGES_PER_DAY_PER_APP = 4004,
     /** Room is full, disconnect */
     MAX_NUMBER_OF_CONCURRENT_CONNECTIONS_PER_ROOM = 4005,
+    /** The server kicked the connection from the room. */
+    KICKED = 4100,
     /** The auth token is expired, reauthorize to get a fresh one. In spirit akin to HTTP 401 */
     TOKEN_EXPIRED = 4109,
     /** Disconnect immediately */
@@ -237,6 +242,9 @@ declare type LostConnectionEvent = "lost" | "restored" | "failed";
  * any value (except null).
  */
 declare type BaseAuthResult = NonNullable<Json>;
+declare class LiveblocksError extends Error {
+    code: number;
+}
 declare type Delegates<T extends BaseAuthResult> = {
     authenticate: () => Promise<T>;
     createSocket: (authValue: T) => IWebSocketInstance;
@@ -1271,6 +1279,13 @@ declare type InboxNotificationThreadData = {
 declare type InboxNotificationData = InboxNotificationThreadData;
 declare type InboxNotificationDataPlain = DateToString<InboxNotificationData>;
 
+declare type InboxNotificationDeleteInfo = {
+    type: "deletedInboxNotification";
+    id: string;
+    roomId: string;
+    deletedAt: Date;
+};
+
 /**
  * Represents a user connected in a room. Treated as immutable.
  */
@@ -1325,6 +1340,7 @@ declare type InternalOthersEvent<TPresence extends JsonObject, TUserMeta extends
     updates: Partial<TPresence>;
 } | {
     type: "reset";
+    user?: never;
 };
 declare type OthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = Resolve<InternalOthersEvent<TPresence, TUserMeta> & {
     others: readonly User<TPresence, TUserMeta>[];
@@ -1351,11 +1367,21 @@ declare type ThreadData<TThreadMetadata extends BaseMetadata = never> = {
     comments: CommentData[];
     metadata: [TThreadMetadata] extends [never] ? Record<string, never> : TThreadMetadata;
 };
+interface ThreadDataWithDeleteInfo<TThreadMetadata extends BaseMetadata = never> extends ThreadData<TThreadMetadata> {
+    deletedAt?: Date;
+}
 declare type ThreadDataPlain<TThreadMetadata extends BaseMetadata = never> = Omit<DateToString<ThreadData<TThreadMetadata>>, "comments" | "metadata"> & {
     comments: CommentDataPlain[];
     metadata: [TThreadMetadata] extends [never] ? Record<string, never> : TThreadMetadata;
 };
 
+declare type ThreadDeleteInfo = {
+    type: "deletedThread";
+    id: string;
+    roomId: string;
+    deletedAt: Date;
+};
+
 declare type LegacyOthersEvent<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
     type: "leave";
     user: User<TPresence, TUserMeta>;
@@ -1523,7 +1549,7 @@ declare type SubscribeFn<TPresence extends JsonObject, _TStorage extends LsonObj
      * @returns Unsubscribe function.
      *
      */
-    (type: "error", listener: ErrorCallback): () => void;
+    (type: "error", listener: Callback<LiveblocksError>): () => void;
     /**
      * @deprecated This API will be removed in a future version of Liveblocks.
      * Prefer using the newer `.subscribe('status')` API.
@@ -1636,81 +1662,60 @@ declare type GetThreadsOptions<TThreadMetadata extends BaseMetadata> = {
     query?: {
         metadata?: Partial<TThreadMetadata>;
     };
+    since?: Date;
 };
-declare type CommentsApi<TThreadMetadata extends BaseMetadata = never> = {
-    /**
-     * @private
-     */
-    getThreads(options?: GetThreadsOptions<TThreadMetadata>): Promise<{
+declare type CommentsApi = {
+    getThreads<TThreadMetadata extends BaseMetadata = never>(options?: GetThreadsOptions<TThreadMetadata>): Promise<{
         threads: ThreadData<TThreadMetadata>[];
         inboxNotifications: InboxNotificationData[];
+        deletedThreads: ThreadDeleteInfo[];
+        deletedInboxNotifications: InboxNotificationDeleteInfo[];
+        meta: {
+            requestedAt: Date;
+        };
     }>;
-    /**
-     * @private
-     */
-    getThread(options: {
+    getThread<TThreadMetadata extends BaseMetadata = never>(options: {
         threadId: string;
     }): Promise<{
         thread: ThreadData<TThreadMetadata>;
         inboxNotification?: InboxNotificationData;
     } | undefined>;
-    /**
-     * @private
-     */
-    createThread(options: {
+    createThread<TThreadMetadata extends BaseMetadata = never>(options: {
         threadId: string;
         commentId: string;
         metadata: TThreadMetadata | undefined;
         body: CommentBody;
     }): Promise<ThreadData<TThreadMetadata>>;
-    /**
-     * @private
-     */
-    editThreadMetadata(options: {
+    editThreadMetadata<TThreadMetadata extends BaseMetadata = never>(options: {
         metadata: PartialNullable<TThreadMetadata>;
         threadId: string;
     }): Promise<TThreadMetadata>;
-    /**
-     * @private
-     */
     createComment(options: {
         threadId: string;
         commentId: string;
         body: CommentBody;
     }): Promise<CommentData>;
-    /**
-     * @private
-     */
     editComment(options: {
         threadId: string;
         commentId: string;
         body: CommentBody;
     }): Promise<CommentData>;
-    /**
-     * @private
-     */
     deleteComment(options: {
         threadId: string;
         commentId: string;
     }): Promise<void>;
-    /**
-     * @private
-     */
     addReaction(options: {
         threadId: string;
         commentId: string;
         emoji: string;
     }): Promise<CommentUserReaction>;
-    /**
-     * @private
-     */
     removeReaction(options: {
         threadId: string;
         commentId: string;
         emoji: string;
     }): Promise<void>;
 };
-declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = CommentsApi<any> & {
+declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUserMeta extends BaseUserMeta, TRoomEvent extends Json> = {
     /**
      * @private
      *
@@ -1843,7 +1848,7 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
         readonly self: Observable<User<TPresence, TUserMeta>>;
         readonly myPresence: Observable<TPresence>;
         readonly others: Observable<OthersEvent<TPresence, TUserMeta>>;
-        readonly error: Observable<Error>;
+        readonly error: Observable<LiveblocksError>;
         readonly storage: Observable<StorageUpdate[]>;
         readonly history: Observable<HistoryEvent>;
         /**
@@ -1856,14 +1861,6 @@ declare type Room<TPresence extends JsonObject, TStorage extends LsonObject, TUs
         readonly ydoc: Observable<YDocUpdateServerMsg | UpdateYDocClientMsg>;
         readonly comments: Observable<CommentsEventServerMsg>;
     };
-    /**
-     * @private
-     */
-    getRoomNotificationSettings(): Promise<RoomNotificationSettings>;
-    /**
-     * @private
-     */
-    updateRoomNotificationSettings(settings: Partial<RoomNotificationSettings>): Promise<RoomNotificationSettings>;
     /**
      * Batches modifications made during the given function.
      * All the modifications are sent to other clients in a single message.
@@ -1929,6 +1926,12 @@ declare type PrivateRoomApi = {
         explicitClose(event: IWebSocketCloseEvent): void;
         rawSend(data: string): void;
     };
+    comments: CommentsApi;
+    notifications: {
+        getRoomNotificationSettings(): Promise<RoomNotificationSettings>;
+        updateRoomNotificationSettings(settings: Partial<RoomNotificationSettings>): Promise<RoomNotificationSettings>;
+        markInboxNotificationAsRead(notificationId: string): Promise<void>;
+    };
 };
 declare type HistoryOp<TPresence extends JsonObject> = Op | {
     readonly type: "presence";
@@ -1994,6 +1997,11 @@ declare type Store<T> = {
     subscribe: (callback: (state: T) => void) => () => void;
 };
 
+declare type GetInboxNotificationsOptions = {
+    limit?: number;
+    since?: Date;
+};
+
 declare type OptimisticUpdate<TThreadMetadata extends BaseMetadata> = CreateThreadOptimisticUpdate<TThreadMetadata> | EditThreadMetadataOptimisticUpdate<TThreadMetadata> | CreateCommentOptimisticUpdate | EditCommentOptimisticUpdate | DeleteCommentOptimisticUpdate | AddReactionOptimisticUpdate | RemoveReactionOptimisticUpdate | MarkInboxNotificationAsReadOptimisticUpdate | MarkAllInboxNotificationsAsReadOptimisticUpdate | UpdateNotificationSettingsOptimisticUpdate;
 declare type CreateThreadOptimisticUpdate<TThreadMetadata extends BaseMetadata> = {
     type: "create-thread";
@@ -2005,20 +2013,17 @@ declare type EditThreadMetadataOptimisticUpdate<TThreadMetadata extends BaseMeta
     id: string;
     threadId: string;
     metadata: Resolve<PartialNullable<TThreadMetadata>>;
+    updatedAt: Date;
 };
 declare type CreateCommentOptimisticUpdate = {
     type: "create-comment";
     id: string;
     comment: CommentData;
-    inboxNotificationId?: string;
 };
 declare type EditCommentOptimisticUpdate = {
     type: "edit-comment";
     id: string;
-    threadId: string;
-    editedAt: Date;
-    commentId: string;
-    body: CommentBody;
+    comment: CommentData;
 };
 declare type DeleteCommentOptimisticUpdate = {
     type: "delete-comment";
@@ -2032,9 +2037,7 @@ declare type AddReactionOptimisticUpdate = {
     id: string;
     threadId: string;
     commentId: string;
-    emoji: string;
-    createdAt: Date;
-    userId: string;
+    reaction: CommentUserReaction;
 };
 declare type RemoveReactionOptimisticUpdate = {
     type: "remove-reaction";
@@ -2043,6 +2046,7 @@ declare type RemoveReactionOptimisticUpdate = {
     commentId: string;
     emoji: string;
     userId: string;
+    removedAt: Date;
 };
 declare type MarkInboxNotificationAsReadOptimisticUpdate = {
     type: "mark-inbox-notification-as-read";
@@ -2072,7 +2076,7 @@ declare type CacheState<TThreadMetadata extends BaseMetadata> = {
     /**
      * Threads by ID.
      */
-    threads: Record<string, ThreadData<TThreadMetadata>>;
+    threads: Record<string, ThreadDataWithDeleteInfo<TThreadMetadata>>;
     /**
      * Keep track of loading and error status of all the queries made by the client.
      */
@@ -2094,11 +2098,16 @@ declare type CacheState<TThreadMetadata extends BaseMetadata> = {
 interface CacheStore<TThreadMetadata extends BaseMetadata> extends Store<CacheState<TThreadMetadata>> {
     deleteThread(threadId: string): void;
     updateThreadAndNotification(thread: ThreadData<TThreadMetadata>, inboxNotification?: InboxNotificationData): void;
-    updateThreadsAndNotifications(threads: ThreadData<TThreadMetadata>[], inboxNotifications: InboxNotificationData[], queryKey?: string): void;
+    updateThreadsAndNotifications(threads: ThreadData<TThreadMetadata>[], inboxNotifications: InboxNotificationData[], deletedThreads: ThreadDeleteInfo[], deletedInboxNotifications: InboxNotificationDeleteInfo[], queryKey?: string): void;
+    updateRoomInboxNotificationSettings(roomId: string, settings: RoomNotificationSettings, queryKey: string): void;
     pushOptimisticUpdate(optimisticUpdate: OptimisticUpdate<TThreadMetadata>): void;
     setQueryState(queryKey: string, queryState: QueryState): void;
 }
 declare function applyOptimisticUpdates<TThreadMetadata extends BaseMetadata>(state: CacheState<TThreadMetadata>): Pick<CacheState<TThreadMetadata>, "threads" | "inboxNotifications" | "notificationSettings">;
+declare function upsertComment<TThreadMetadata extends BaseMetadata>(thread: ThreadDataWithDeleteInfo<TThreadMetadata>, comment: CommentData): ThreadDataWithDeleteInfo<TThreadMetadata>;
+declare function deleteComment<TThreadMetadata extends BaseMetadata>(thread: ThreadDataWithDeleteInfo<TThreadMetadata>, commentId: string, deletedAt: Date): ThreadDataWithDeleteInfo<TThreadMetadata>;
+declare function addReaction<TThreadMetadata extends BaseMetadata>(thread: ThreadDataWithDeleteInfo<TThreadMetadata>, commentId: string, reaction: CommentUserReaction): ThreadDataWithDeleteInfo<TThreadMetadata>;
+declare function removeReaction<TThreadMetadata extends BaseMetadata>(thread: ThreadDataWithDeleteInfo<TThreadMetadata>, commentId: string, emoji: string, userId: string, removedAt: Date): ThreadDataWithDeleteInfo<TThreadMetadata>;
 
 declare type OptionalPromise<T> = T | Promise<T>;
 
@@ -2107,6 +2116,10 @@ declare type RoomInfo = {
      * The name of the room.
      */
     name?: string;
+    /**
+     * The URL of the room.
+     */
+    url?: string;
 };
 
 declare type ResolveMentionSuggestionsArgs = {
@@ -2150,34 +2163,29 @@ declare type EnterOptions<TPresence extends JsonObject, TStorage extends LsonObj
  * will probably happen if you do.
  */
 declare type PrivateClientApi<TUserMeta extends BaseUserMeta> = {
+    notifications: NotificationsApi;
     currentUserIdStore: Store<string | null>;
     resolveMentionSuggestions: ClientOptions["resolveMentionSuggestions"];
     cacheStore: CacheStore<BaseMetadata>;
     usersStore: BatchStore<TUserMeta["info"] | undefined, [string]>;
     roomsInfoStore: BatchStore<RoomInfo | undefined, [string]>;
+    getRoomIds: () => string[];
 };
-declare type InboxNotificationsApi<TThreadMetadata extends BaseMetadata = never> = {
-    /**
-     * @private
-     */
-    getInboxNotifications(): Promise<{
+declare type NotificationsApi<TThreadMetadata extends BaseMetadata = never> = {
+    getInboxNotifications(options?: GetInboxNotificationsOptions): Promise<{
         inboxNotifications: InboxNotificationData[];
         threads: ThreadData<TThreadMetadata>[];
+        deletedThreads: ThreadDeleteInfo[];
+        deletedInboxNotifications: InboxNotificationDeleteInfo[];
+        meta: {
+            requestedAt: Date;
+        };
     }>;
-    /**
-     * @private
-     */
     getUnreadInboxNotificationsCount(): Promise<number>;
-    /**
-     * @private
-     */
     markAllInboxNotificationsAsRead(): Promise<void>;
-    /**
-     * @private
-     */
     markInboxNotificationAsRead(inboxNotificationId: string): Promise<void>;
 };
-declare type Client<TUserMeta extends BaseUserMeta = BaseUserMeta> = InboxNotificationsApi & {
+declare type Client<TUserMeta extends BaseUserMeta = BaseUserMeta> = {
     /**
      * Gets a room. Returns null if {@link Client.enter} has not been called previously.
      *
@@ -2770,4 +2778,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { type AckOp, type BaseAuthResult, type BaseMetadata, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type CacheState, type CacheStore, type Client, type ClientMsg, ClientMsgCode, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, CommentsApiError, type CommentsEventServerMsg, CrdtType, type CreateListOp, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type CustomAuthenticationResult, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type History, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IdTuple, type Immutable, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationThreadData, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type LegacyConnectionStatus, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, type LostConnectionEvent, type Lson, type LsonObject, type NodeMap, NotificationsApiError, type Op, OpCode, type OptionalPromise, type Others, type OthersEvent, type ParentToChildNodeMap, type PartialNullable, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type RejectedStorageOpServerMsg, type Resolve, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomInfo, type RoomInitializers, type RoomNotificationSettings, type RoomStateServerMsg, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, type Status, type StorageStatus, type StorageUpdate, type Store, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type ThreadData, type ThreadDataPlain, type ToImmutable, type ToJson, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type User, type UserJoinServerMsg, type UserLeftServerMsg, WebsocketCloseCodes, type YDocUpdateServerMsg, ackOp, applyOptimisticUpdates, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToThreadData, createClient, deprecate, deprecateIf, detectDupes, errorIf, freeze, getMentionedIdsFromCommentBody, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, kInternal, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, raise, shallow, stringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, withTimeout };
+export { type AckOp, type BaseAuthResult, type BaseMetadata, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type CacheState, type CacheStore, type Client, type ClientMsg, ClientMsgCode, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, CommentsApiError, type CommentsEventServerMsg, CrdtType, type CreateListOp, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type CustomAuthenticationResult, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type History, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IdTuple, type Immutable, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationThreadData, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type LegacyConnectionStatus, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LostConnectionEvent, type Lson, type LsonObject, type NodeMap, NotificationsApiError, type Op, OpCode, type OptionalPromise, type Others, type OthersEvent, type ParentToChildNodeMap, type PartialNullable, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type RejectedStorageOpServerMsg, type Resolve, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomInfo, type RoomInitializers, type RoomNotificationSettings, type RoomStateServerMsg, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, type Status, type StorageStatus, type StorageUpdate, type Store, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type ThreadData, type ThreadDataPlain, type ThreadDeleteInfo, type ToImmutable, type ToJson, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type User, type UserJoinServerMsg, type UserLeftServerMsg, WebsocketCloseCodes, type YDocUpdateServerMsg, ackOp, addReaction, applyOptimisticUpdates, asPos, assert, assertNever, b64decode, cloneLson, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToThreadData, createClient, deleteComment, deprecate, deprecateIf, detectDupes, errorIf, freeze, getMentionedIdsFromCommentBody, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, kInternal, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, nn, patchLiveObjectKey, raise, removeReaction, shallow, stringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, upsertComment, withTimeout };