@liveblocks/core 2.24.0-deque1 → 2.24.0

package/dist/index.d.ts

@@ -1299,6 +1299,20 @@ type UpdateYDocClientMsg = {
     readonly v2?: boolean;
 };
 
+type RoomThreadsSubscriptionSettings = "all" | "replies_and_mentions" | "none";
+type RoomTextMentionsSubscriptionSettings = "mine" | "none";
+type RoomSubscriptionSettings = {
+    threads: RoomThreadsSubscriptionSettings;
+    textMentions: RoomTextMentionsSubscriptionSettings;
+};
+type UserRoomSubscriptionSettings = {
+    roomId: string;
+} & RoomSubscriptionSettings;
+/**
+ * @deprecated Renamed to `RoomSubscriptionSettings`
+ */
+type RoomNotificationSettings = RoomSubscriptionSettings;
+
 declare enum ServerMsgCode {
     UPDATE_PRESENCE = 100,
     USER_JOINED = 101,
@@ -1537,6 +1551,122 @@ type RejectedStorageOpServerMsg = {
     readonly reason: string;
 };
 
+/**
+ * Pre-defined notification channels support list.
+ */
+type NotificationChannel = "email" | "slack" | "teams" | "webPush";
+/**
+ * `K` represents custom notification kinds
+ * defined in the augmentation `ActivitiesData` (e.g `liveblocks.config.ts`).
+ * It means the type `NotificationKind` will be shaped like:
+ * thread | textMention | $customKind1 | $customKind2 | ...
+ */
+type NotificationKind<K extends keyof DAD = keyof DAD> = "thread" | "textMention" | K;
+/**
+ * A notification channel settings is a set of notification kinds.
+ * One setting can have multiple kinds (+ augmentation)
+ */
+type NotificationChannelSettings = {
+    [K in NotificationKind]: boolean;
+};
+/**
+ * @private
+ *
+ * Base definition of notification settings.
+ * Plain means it's a simple object coming from the remote backend.
+ *
+ * It's the raw settings object where somme channels cannot exists
+ * because there are no notification kinds enabled on the dashboard.
+ * And this object isn't yet proxied by the creator factory `createNotificationSettings`.
+ */
+type NotificationSettingsPlain = {
+    [C in NotificationChannel]?: NotificationChannelSettings;
+};
+/**
+ * @deprecated Renamed to `NotificationSettings`
+ *
+ * Notification settings.
+ * One channel for one set of settings.
+ */
+type UserNotificationSettings = NotificationSettings;
+/**
+ * Notification settings.
+ * One channel for one set of settings.
+ */
+type NotificationSettings = {
+    [C in NotificationChannel]: NotificationChannelSettings | null;
+};
+/**
+ * It creates a deep partial specific for `NotificationSettings`
+ * to offer a nice DX when updating the settings (e.g not being forced to define every keys)
+ * and at the same the some preserver the augmentation for custom kinds (e.g `liveblocks.config.ts`).
+ */
+type DeepPartialWithAugmentation<T> = T extends object ? {
+    [P in keyof T]?: T[P] extends {
+        [K in NotificationKind]: boolean;
+    } ? Partial<T[P]> & {
+        [K in keyof DAD]?: boolean;
+    } : DeepPartialWithAugmentation<T[P]>;
+} : T;
+/**
+ * Partial notification settings with augmentation preserved gracefully.
+ * It means you can update the settings without being forced to define every keys.
+ * Useful when implementing update functions.
+ */
+type PartialNotificationSettings = DeepPartialWithAugmentation<NotificationSettingsPlain>;
+/**
+ * @private
+ *
+ * Creates a `NotificationSettings` object with the given initial plain settings.
+ * It defines a getter for each channel to access the settings and returns `null` with an error log
+ * in case the required channel isn't enabled in the dashboard.
+ *
+ * You can see this function as `Proxy` like around `NotificationSettingsPlain` type.
+ * We can't predict what will be enabled on the dashboard or not, so it's important
+ * provide a good DX to developers by returning `null` completed by an error log
+ * when they try to access a channel that isn't enabled in the dashboard.
+ */
+declare function createNotificationSettings(plain: NotificationSettingsPlain): NotificationSettings;
+/**
+ * @private
+ *
+ * Patch a `NotificationSettings` object by applying notification kind updates
+ * coming from a `PartialNotificationSettings` object.
+ */
+declare function patchNotificationSettings(existing: NotificationSettings, patch: PartialNotificationSettings): NotificationSettings;
+/**
+ *
+ * Utility to check if a notification channel settings
+ * is enabled for every notification kinds.
+ *
+ * Usage:
+ * ```ts
+ * const isEmailChannelEnabled = isNotificationChannelEnabled(settings.email);
+ * ```
+ */
+declare function isNotificationChannelEnabled(settings: NotificationChannelSettings | null): boolean;
+
+type SubscriptionData<K extends keyof DAD = keyof DAD> = {
+    kind: NotificationKind<K>;
+    subjectId: string;
+    createdAt: Date;
+};
+type SubscriptionDataPlain = DateToString<SubscriptionData>;
+type UserSubscriptionData<K extends keyof DAD = keyof DAD> = SubscriptionData<K> & {
+    userId: string;
+};
+type UserSubscriptionDataPlain = DateToString<UserSubscriptionData>;
+type SubscriptionDeleteInfo = {
+    type: "deletedSubscription";
+    kind: NotificationKind;
+    subjectId: string;
+    deletedAt: Date;
+};
+type SubscriptionDeleteInfoPlain = DateToString<SubscriptionDeleteInfo>;
+type SubscriptionKey = `${NotificationKind}:${string}`;
+declare function getSubscriptionKey(subscription: SubscriptionData | SubscriptionDeleteInfo): SubscriptionKey;
+declare function getSubscriptionKey(kind: NotificationKind, subjectId: string): SubscriptionKey;
+
 type HistoryVersion = {
     type: "historyVersion";
     kind: "yjs";
@@ -1621,7 +1751,7 @@ type CommentsOrNotificationsErrorContext = {
     threadId: string;
     metadata: Patchable<BaseMetadata>;
 } | {
-    type: "MARK_THREAD_AS_RESOLVED_ERROR" | "MARK_THREAD_AS_UNRESOLVED_ERROR";
+    type: "MARK_THREAD_AS_RESOLVED_ERROR" | "MARK_THREAD_AS_UNRESOLVED_ERROR" | "SUBSCRIBE_TO_THREAD_ERROR" | "UNSUBSCRIBE_FROM_THREAD_ERROR";
     roomId: string;
     threadId: string;
 } | {
@@ -1653,6 +1783,9 @@ type CommentsOrNotificationsErrorContext = {
 } | {
     type: "UPDATE_NOTIFICATION_SETTINGS_ERROR";
     roomId: string;
+} | {
+    type: "UPDATE_ROOM_SUBSCRIPTION_SETTINGS_ERROR";
+    roomId: string;
 } | {
     type: "UPDATE_USER_NOTIFICATION_SETTINGS_ERROR";
 };
@@ -1725,11 +1858,6 @@ declare enum TextEditorType {
     BlockNote = "blocknote"
 }
 
-type RoomThreadsNotificationSettings = "all" | "replies_and_mentions" | "none";
-type RoomNotificationSettings = {
-    threads: RoomThreadsNotificationSettings;
-};
-
 type LegacyOthersEvent<P extends JsonObject, U extends BaseUserMeta> = {
     type: "leave";
     user: User<P, U>;
@@ -2000,7 +2128,7 @@ type ListTextVersionsSinceOptions = {
     since: Date;
     signal?: AbortSignal;
 };
-type GetNotificationSettingsOptions = {
+type GetSubscriptionSettingsOptions = {
     signal?: AbortSignal;
 };
 /**
@@ -2224,18 +2352,20 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      * const {
      *   threads,
      *   inboxNotifications,
+     *   subscriptions,
      *   requestedAt
      * } = await room.getThreads({ query: { resolved: false }});
      */
     getThreads(options?: GetThreadsOptions<M>): Promise<{
         threads: ThreadData<M>[];
         inboxNotifications: InboxNotificationData[];
+        subscriptions: SubscriptionData[];
         requestedAt: Date;
         nextCursor: string | null;
         permissionHints: Record<string, Permission[]>;
     }>;
     /**
-     * Returns the updated and deleted threads and their associated inbox notifications since the requested date.
+     * Returns the updated and deleted threads and their associated inbox notifications and subscriptions since the requested date.
      *
      * @example
      * const result = await room.getThreads();
@@ -2251,18 +2381,23 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
             updated: InboxNotificationData[];
             deleted: InboxNotificationDeleteInfo[];
         };
+        subscriptions: {
+            updated: SubscriptionData[];
+            deleted: SubscriptionDeleteInfo[];
+        };
         requestedAt: Date;
         permissionHints: Record<string, Permission[]>;
     }>;
     /**
-     * Returns a thread and the associated inbox notification if it exists.
+     * Returns a thread and the associated inbox notification and subscription if it exists.
      *
      * @example
-     * const { thread, inboxNotification } = await room.getThread("th_xxx");
+     * const { thread, inboxNotification, subscription } = await room.getThread("th_xxx");
      */
     getThread(threadId: string): Promise<{
         thread?: ThreadData<M>;
         inboxNotification?: InboxNotificationData;
+        subscription?: SubscriptionData;
     }>;
     /**
      * Creates a thread.
@@ -2314,6 +2449,20 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      * await room.markThreadAsUnresolved("th_xxx");
      */
     markThreadAsUnresolved(threadId: string): Promise<void>;
+    /**
+     * Subscribes the user to a thread.
+     *
+     * @example
+     * await room.subscribeToThread("th_xxx");
+     */
+    subscribeToThread(threadId: string): Promise<SubscriptionData>;
+    /**
+     * Unsubscribes the user from a thread.
+     *
+     * @example
+     * await room.unsubscribeFromThread("th_xxx");
+     */
+    unsubscribeFromThread(threadId: string): Promise<void>;
     /**
      * Creates a comment.
      *
@@ -2410,20 +2559,34 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      */
     getAttachmentUrl(attachmentId: string): Promise<string>;
     /**
-     * Gets the user's notification settings for the current room.
+     * @deprecated Renamed to `getSubscriptionSettings`
+     *
+     * Gets the user's subscription settings for the current room.
+     */
+    getNotificationSettings(options?: GetSubscriptionSettingsOptions): Promise<RoomSubscriptionSettings>;
+    /**
+     * Gets the user's subscription settings for the current room.
      *
      * @example
-     * const settings = await room.getNotificationSettings();
+     * const settings = await room.getSubscriptionSettings();
      */
-    getNotificationSettings(options?: GetNotificationSettingsOptions): Promise<RoomNotificationSettings>;
+    getSubscriptionSettings(options?: GetSubscriptionSettingsOptions): Promise<RoomSubscriptionSettings>;
     /**
-     * Updates the user's notification settings for the current room.
+     * @deprecated Renamed to `getSubscriptionSettings`
+     *
+     * Updates the user's subscription settings for the current room.
+     */
+    updateNotificationSettings(settings: Partial<RoomSubscriptionSettings>): Promise<RoomSubscriptionSettings>;
+    /**
+     * Updates the user's subscription settings for the current room.
      *
      * @example
-     * await room.updateNotificationSettings({ threads: "replies_and_mentions" });
+     * await room.updateSubscriptionSettings({ threads: "replies_and_mentions" });
      */
-    updateNotificationSettings(settings: Partial<RoomNotificationSettings>): Promise<RoomNotificationSettings>;
+    updateSubscriptionSettings(settings: Partial<RoomSubscriptionSettings>): Promise<RoomSubscriptionSettings>;
     /**
+     * @private
+     *
      * Internal use only. Signature might change in the future.
      */
     markInboxNotificationAsRead(notificationId: string): Promise<void>;
@@ -2531,94 +2694,6 @@ type OptionalTupleUnless<C, T extends any[]> = Record<string, never> extends C ?
 ] extends [never] ? OptionalTuple<T> : T;
 type LargeMessageStrategy = "default" | "split" | "experimental-fallback-to-http";
 
-/**
- * Pre-defined notification channels support list.
- */
-type NotificationChannel = "email" | "slack" | "teams" | "webPush";
-/**
- * `K` represents custom notification kinds
- * defined in the augmentation `ActivitiesData` (e.g `liveblocks.config.ts`).
- * It means the type `NotificationKind` will be shaped like:
- * thread | textMention | $customKind1 | $customKind2 | ...
- */
-type NotificationKind<K extends keyof DAD = keyof DAD> = "thread" | "textMention" | K;
-/**
- * A notification channel settings is a set of notification kinds.
- * One setting can have multiple kinds (+ augmentation)
- */
-type NotificationChannelSettings = {
-    [K in NotificationKind]: boolean;
-};
-/**
- * @private
- *
- * Base definition of user notification settings.
- * Plain means it's a simple object coming from the remote backend.
- *
- * It's the raw settings object where somme channels cannot exists
- * because there are no notification kinds enabled on the dashboard.
- * And this object isn't yet proxied by the creator factory `createUserNotificationSettings`.
- */
-type UserNotificationSettingsPlain = {
-    [C in NotificationChannel]?: NotificationChannelSettings;
-};
-/**
- * User notification settings.
- * One channel for one set of settings.
- */
-type UserNotificationSettings = {
-    [C in NotificationChannel]: NotificationChannelSettings | null;
-};
-/**
- * It creates a deep partial specific for `UserNotificationSettings`
- * to offer a nice DX when updating the settings (e.g not being forced to define every keys)
- * and at the same the some preserver the augmentation for custom kinds (e.g `liveblocks.config.ts`).
- */
-type DeepPartialWithAugmentation<T> = T extends object ? {
-    [P in keyof T]?: T[P] extends {
-        [K in NotificationKind]: boolean;
-    } ? Partial<T[P]> & {
-        [K in keyof DAD]?: boolean;
-    } : DeepPartialWithAugmentation<T[P]>;
-} : T;
-/**
- * Partial user notification settings with augmentation preserved gracefully.
- * It means you can update the settings without being forced to define every keys.
- * Useful when implementing update functions.
- */
-type PartialUserNotificationSettings = DeepPartialWithAugmentation<UserNotificationSettingsPlain>;
-/**
- * @private
- *
- * Creates a `UserNotificationSettings` object with the given initial plain settings.
- * It defines a getter for each channel to access the settings and returns `null` with an error log
- * in case the required channel isn't enabled in the dashboard.
- *
- * You can see this function as `Proxy` like around `UserNotificationSettingsPlain` type.
- * We can't predict what will be enabled on the dashboard or not, so it's important
- * provide a good DX to developers by returning `null` completed by an error log
- * when they try to access a channel that isn't enabled in the dashboard.
- */
-declare function createUserNotificationSettings(plain: UserNotificationSettingsPlain): UserNotificationSettings;
-/**
- * @private
- *
- * Patch a `UserNotificationSettings` object by applying notification kind updates
- * coming from a `PartialUserNotificationSettings` object.
- */
-declare function patchUserNotificationSettings(existing: UserNotificationSettings, patch: PartialUserNotificationSettings): UserNotificationSettings;
-/**
- *
- * Utility to check if a notification channel settings
- * is enabled for every notification kinds.
- *
- * Usage:
- * ```ts
- * const isEmailChannelEnabled = isNotificationChannelEnabled(settings.email);
- * ```
- */
-declare function isNotificationChannelEnabled(settings: NotificationChannelSettings | null): boolean;
-
 interface RoomHttpApi<M extends BaseMetadata> {
     getThreads(options: {
         roomId: string;
@@ -2630,6 +2705,7 @@ interface RoomHttpApi<M extends BaseMetadata> {
     }): Promise<{
         threads: ThreadData<M>[];
         inboxNotifications: InboxNotificationData[];
+        subscriptions: SubscriptionData[];
         requestedAt: Date;
         nextCursor: string | null;
         permissionHints: Record<string, Permission[]>;
@@ -2647,6 +2723,10 @@ interface RoomHttpApi<M extends BaseMetadata> {
             updated: InboxNotificationData[];
             deleted: InboxNotificationDeleteInfo[];
         };
+        subscriptions: {
+            updated: SubscriptionData[];
+            deleted: SubscriptionDeleteInfo[];
+        };
         requestedAt: Date;
         permissionHints: Record<string, Permission[]>;
     }>;
@@ -2664,6 +2744,7 @@ interface RoomHttpApi<M extends BaseMetadata> {
     }): Promise<{
         thread?: ThreadData<M>;
         inboxNotification?: InboxNotificationData;
+        subscription?: SubscriptionData;
     }>;
     deleteThread({ roomId, threadId, }: {
         roomId: string;
@@ -2713,18 +2794,26 @@ interface RoomHttpApi<M extends BaseMetadata> {
         roomId: string;
         threadId: string;
     }): Promise<void>;
+    subscribeToThread({ roomId, threadId, }: {
+        roomId: string;
+        threadId: string;
+    }): Promise<SubscriptionData>;
+    unsubscribeFromThread({ roomId, threadId, }: {
+        roomId: string;
+        threadId: string;
+    }): Promise<void>;
     markRoomInboxNotificationAsRead({ roomId, inboxNotificationId, }: {
         roomId: string;
         inboxNotificationId: string;
     }): Promise<string>;
-    getNotificationSettings({ roomId, signal, }: {
+    getSubscriptionSettings({ roomId, signal, }: {
         roomId: string;
         signal?: AbortSignal;
-    }): Promise<RoomNotificationSettings>;
-    updateNotificationSettings({ roomId, settings, }: {
+    }): Promise<RoomSubscriptionSettings>;
+    updateSubscriptionSettings({ roomId, settings, }: {
         roomId: string;
-        settings: Partial<RoomNotificationSettings>;
-    }): Promise<RoomNotificationSettings>;
+        settings: Partial<RoomSubscriptionSettings>;
+    }): Promise<RoomSubscriptionSettings>;
     getAttachmentUrl(options: {
         roomId: string;
         attachmentId: string;
@@ -2811,6 +2900,7 @@ interface NotificationHttpApi<M extends BaseMetadata> {
     }): Promise<{
         inboxNotifications: InboxNotificationData[];
         threads: ThreadData<M>[];
+        subscriptions: SubscriptionData[];
         nextCursor: string | null;
         requestedAt: Date;
     }>;
@@ -2826,6 +2916,10 @@ interface NotificationHttpApi<M extends BaseMetadata> {
             updated: ThreadData<M>[];
             deleted: ThreadDeleteInfo[];
         };
+        subscriptions: {
+            updated: SubscriptionData[];
+            deleted: SubscriptionDeleteInfo[];
+        };
         requestedAt: Date;
     }>;
     getUnreadInboxNotificationsCount(): Promise<number>;
@@ -2833,10 +2927,10 @@ interface NotificationHttpApi<M extends BaseMetadata> {
     markInboxNotificationAsRead(inboxNotificationId: string): Promise<void>;
     deleteAllInboxNotifications(): Promise<void>;
     deleteInboxNotification(inboxNotificationId: string): Promise<void>;
-    getUserNotificationSettings(options?: {
+    getNotificationSettings(options?: {
         signal?: AbortSignal;
-    }): Promise<UserNotificationSettingsPlain>;
-    updateUserNotificationSettings(settings: PartialUserNotificationSettings): Promise<UserNotificationSettingsPlain>;
+    }): Promise<NotificationSettingsPlain>;
+    updateNotificationSettings(settings: PartialNotificationSettings): Promise<NotificationSettingsPlain>;
 }
 interface LiveblocksHttpApi<M extends BaseMetadata> extends RoomHttpApi<M>, NotificationHttpApi<M> {
     getUserThreads_experimental(options?: {
@@ -2848,6 +2942,7 @@ interface LiveblocksHttpApi<M extends BaseMetadata> extends RoomHttpApi<M>, Noti
     }): Promise<{
         threads: ThreadData<M>[];
         inboxNotifications: InboxNotificationData[];
+        subscriptions: SubscriptionData[];
         nextCursor: string | null;
         requestedAt: Date;
         permissionHints: Record<string, Permission[]>;
@@ -2864,6 +2959,10 @@ interface LiveblocksHttpApi<M extends BaseMetadata> extends RoomHttpApi<M>, Noti
             updated: ThreadData<M>[];
             deleted: ThreadDeleteInfo[];
         };
+        subscriptions: {
+            updated: SubscriptionData[];
+            deleted: SubscriptionDeleteInfo[];
+        };
         requestedAt: Date;
         permissionHints: Record<string, Permission[]>;
     }>;
@@ -3035,7 +3134,7 @@ type PrivateClientApi<U extends BaseUserMeta, M extends BaseMetadata> = {
 type NotificationsApi<M extends BaseMetadata> = {
     /**
      * Gets a page (or the initial page) for user inbox notifications and their
-     * associated threads.
+     * associated threads and thread subscriptions.
      *
      * This function should NOT be used for delta updates, only for pagination
      * (including the first page fetch). For delta updates (done during the
@@ -3045,6 +3144,7 @@ type NotificationsApi<M extends BaseMetadata> = {
      * const {
      *   inboxNotifications,
      *   threads,
+     *   subscriptions,
      *   nextCursor,
      * } = await client.getInboxNotifications();
      * const data = await client.getInboxNotifications();  // Fetch initial page (of 20 inbox notifications)
@@ -3055,6 +3155,7 @@ type NotificationsApi<M extends BaseMetadata> = {
     }): Promise<{
         inboxNotifications: InboxNotificationData[];
         threads: ThreadData<M>[];
+        subscriptions: SubscriptionData[];
         nextCursor: string | null;
         requestedAt: Date;
     }>;
@@ -3073,7 +3174,11 @@ type NotificationsApi<M extends BaseMetadata> = {
      *   threads: {
      *     updated,
      *     deleted,
-     *    },
+     *   },
+     *   subscriptions: {
+     *     updated,
+     *     deleted,
+     *   },
      *   requestedAt,
      * } = await client.getInboxNotificationsSince({ since: result.requestedAt }});
      */
@@ -3089,6 +3194,10 @@ type NotificationsApi<M extends BaseMetadata> = {
             updated: ThreadData<M>[];
             deleted: ThreadDeleteInfo[];
         };
+        subscriptions: {
+            updated: SubscriptionData[];
+            deleted: SubscriptionDeleteInfo[];
+        };
         requestedAt: Date;
     }>;
     /**
@@ -3134,7 +3243,7 @@ type NotificationsApi<M extends BaseMetadata> = {
      */
     getNotificationSettings(options?: {
         signal?: AbortSignal;
-    }): Promise<UserNotificationSettings>;
+    }): Promise<NotificationSettings>;
     /**
      * Update notifications settings for a user for a project.
      *
@@ -3147,7 +3256,7 @@ type NotificationsApi<M extends BaseMetadata> = {
      *  }
      * })
      */
-    updateNotificationSettings(settings: PartialUserNotificationSettings): Promise<UserNotificationSettings>;
+    updateNotificationSettings(settings: PartialNotificationSettings): Promise<NotificationSettings>;
 };
 /**
  * @private Widest-possible Client type, matching _any_ Client instance. Note
@@ -3460,6 +3569,20 @@ declare function convertToCommentUserReaction(data: CommentUserReactionPlain): C
  * @returns The rich inbox notification data object that can be used by the client.
  */
 declare function convertToInboxNotificationData(data: InboxNotificationDataPlain): InboxNotificationData;
+/**
+ * Converts a plain subscription data object (usually returned by the API) to a subscription data object that can be used by the client.
+ * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
+ * @param data The plain subscription data object (usually returned by the API)
+ * @returns The rich subscription data object that can be used by the client.
+ */
+declare function convertToSubscriptionData(data: SubscriptionDataPlain): SubscriptionData;
+/**
+ * Converts a plain user subscription data object (usually returned by the API) to a user subscription data object that can be used by the client.
+ * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
+ * @param data The plain user subscription data object (usually returned by the API)
+ * @returns The rich user subscription data object that can be used by the client.
+ */
+declare function convertToUserSubscriptionData(data: UserSubscriptionDataPlain): UserSubscriptionData;
 
 /**
  * Lookup table for nodes (= SerializedCrdt values) by their IDs.
@@ -3745,6 +3868,11 @@ type Poller = {
      * the next poll at the regular interval.
      */
     pollNowIfStale(): void;
+    /**
+     * Marks the poller as stale. This can be used to force the next call
+     * to `.pollNowIfStale()` to poll immediately.
+     */
+    markAsStale(): void;
 };
 /**
  * Makes a poller that will call `await callback()` at the desired interval (in
@@ -3918,6 +4046,15 @@ declare function asPos(str: string): Pos;
  * Testing goes one level deep.
  */
 declare function shallow(a: unknown, b: unknown): boolean;
+/**
+ * Two-level deep shallow check.
+ * Useful for checking equality of { isLoading: false, myData: [ ... ] } like
+ * data structures, where you want to do a shallow comparison on the "data"
+ * key.
+ *
+ * NOTE: Works on objects only, not on arrays!
+ */
+declare function shallow2(a: unknown, b: unknown): boolean;
 
 /**
  * A datastructure to keep elements in ascending order, as defined by the "less
@@ -4118,4 +4255,4 @@ declare const CommentsApiError: typeof HttpError;
 /** @deprecated Use HttpError instead. */
 declare const NotificationsApiError: typeof HttpError;
 
-export { type AckOp, type ActivityData, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type CommentAttachment, 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 CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, CommentsApiError, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type CustomAuthenticationResult, type DAD, type DE, type DM, type DP, type DRI, type DS, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type History, type HistoryVersion, HttpError, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, type ManagedPool, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, NotificationsApiError, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialUnless, type PartialUserNotificationSettings, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type RejectedStorageOpServerMsg, type Relax, type Resolve, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomNotificationSettings, type RoomStateServerMsg, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserNotificationSettings, type UserNotificationSettingsPlain, WebsocketCloseCodes, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToThreadData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createThreadId, createUserNotificationSettings, deprecate, deprecateIf, detectDupes, entries, errorIf, freeze, generateCommentUrl, getMentionedIdsFromCommentBody, html, htmlSafe, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchUserNotificationSettings, raise, resolveUsersInCommentBody, shallow, stableStringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, url, urljoin, wait, withTimeout };
+export { type AckOp, type ActivityData, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type CommentAttachment, 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 CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, CommentsApiError, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type CustomAuthenticationResult, type DAD, type DE, type DM, type DP, type DRI, type DS, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type History, type HistoryVersion, HttpError, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, type ManagedPool, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, NotificationsApiError, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type RejectedStorageOpServerMsg, type Relax, type Resolve, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomNotificationSettings, type RoomStateServerMsg, type RoomSubscriptionSettings, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserNotificationSettings, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, deprecate, deprecateIf, detectDupes, entries, errorIf, freeze, generateCommentUrl, getMentionedIdsFromCommentBody, getSubscriptionKey, html, htmlSafe, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchNotificationSettings, raise, resolveUsersInCommentBody, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, url, urljoin, wait, withTimeout };