@liveblocks/core 2.16.0-toolbars5 → 2.17.0-channels1

package/dist/index.d.mts

@@ -5,18 +5,72 @@
 declare function detectDupes(pkgName: string, pkgVersion: string | false, // false if not built yet
 pkgFormat: string | false): void;
 
-type CustomAuthenticationResult = {
+/**
+ * This helper type is effectively a no-op, but will force TypeScript to
+ * "evaluate" any named helper types in its definition. This can sometimes make
+ * API signatures clearer in IDEs.
+ *
+ * For example, in:
+ *
+ *   type Payload<T> = { data: T };
+ *
+ *   let r1: Payload<string>;
+ *   let r2: Resolve<Payload<string>>;
+ *
+ * The inferred type of `r1` is going to be `Payload<string>` which shows up in
+ * editor hints, and it may be unclear what's inside if you don't know the
+ * definition of `Payload`.
+ *
+ * The inferred type of `r2` is going to be `{ data: string }`, which may be
+ * more helpful.
+ *
+ * This trick comes from:
+ * https://effectivetypescript.com/2022/02/25/gentips-4-display/
+ */
+type Resolve<T> = T extends (...args: unknown[]) => unknown ? T : {
+    [K in keyof T]: T[K];
+};
+
+/**
+ * Relaxes a discriminated union type definition, by explicitly adding
+ * properties defined in any other member as 'never'.
+ *
+ * This makes accessing the members much more relaxed in TypeScript.
+ *
+ * For example:
+ *   type MyUnion = Relax<
+ *     | { foo: string }
+ *     | { foo: number; bar: string; }
+ *     | { qux: boolean }
+ *   >;
+ *
+ *   // With Relax, accessing is much easier:
+ *   union.foo;       // string | number | undefined
+ *   union.bar;       // string | undefined
+ *   union.qux;       // boolean
+ *   union.whatever;  // Error: Property 'whatever' does not exist on type 'MyUnion'
+ *
+ *   // Without Relax, these would all be type errors:
+ *   union.foo; // Error: Property 'foo' does not exist on type 'MyUnion'
+ *   union.bar; // Error: Property 'bar' does not exist on type 'MyUnion'
+ *   union.qux; // Error: Property 'qux' does not exist on type 'MyUnion'
+ */
+type Relax<T> = DistributiveRelax<T, T extends any ? keyof T : never>;
+type DistributiveRelax<T, Ks extends string | number | symbol> = T extends any ? Resolve<{
+    [K in keyof T]: T[K];
+} & {
+    [K in Exclude<Ks, keyof T>]?: never;
+}> : never;
+
+type CustomAuthenticationResult = Relax<{
     token: string;
-    error?: never;
 } | {
-    token?: never;
     error: "forbidden";
     reason: string;
 } | {
-    token?: never;
     error: string;
     reason: string;
-};
+}>;
 
 /**
  * Represents an indefinitely deep arbitrary JSON data structure. There are
@@ -919,22 +973,18 @@ type CommentData = {
     editedAt?: Date;
     reactions: CommentReaction[];
     attachments: CommentAttachment[];
-} & ({
+} & Relax<{
     body: CommentBody;
-    deletedAt?: never;
 } | {
-    body?: never;
     deletedAt: Date;
-});
+}>;
 type CommentDataPlain = Omit<DateToString<CommentData>, "reactions" | "body"> & {
     reactions: DateToString<CommentReaction>[];
-} & ({
+} & Relax<{
     body: CommentBody;
-    deletedAt?: never;
 } | {
-    body?: never;
     deletedAt: string;
-});
+}>;
 type CommentBodyBlockElement = CommentBodyParagraph;
 type CommentBodyInlineElement = CommentBodyText | CommentBodyMention | CommentBodyLink;
 type CommentBodyElement = CommentBodyBlockElement | CommentBodyInlineElement;
@@ -1131,11 +1181,13 @@ type FetchYDocClientMsg = {
     readonly type: ClientMsgCode.FETCH_YDOC;
     readonly vector: string;
     readonly guid?: string;
+    readonly v2?: boolean;
 };
 type UpdateYDocClientMsg = {
     readonly type: ClientMsgCode.UPDATE_YDOC;
     readonly update: string;
     readonly guid?: string;
+    readonly v2?: boolean;
 };
 
 type IdTuple<T> = [id: string, value: T];
@@ -1338,6 +1390,7 @@ type YDocUpdateServerMsg = {
     readonly isSync: boolean;
     readonly stateVector: string | null;
     readonly guid?: string;
+    readonly v2?: boolean;
 };
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
@@ -1469,32 +1522,6 @@ declare namespace DevToolsTreeNode {
   export type { DevToolsTreeNode_CustomEventTreeNode as CustomEventTreeNode, DevToolsTreeNode_JsonTreeNode as JsonTreeNode, DevToolsTreeNode_LiveTreeNode as LiveTreeNode, DevToolsTreeNode_LsonTreeNode as LsonTreeNode, DevToolsTreeNode_TreeNode as TreeNode, DevToolsTreeNode_UserTreeNode as UserTreeNode };
 }
 
-/**
- * This helper type is effectively a no-op, but will force TypeScript to
- * "evaluate" any named helper types in its definition. This can sometimes make
- * API signatures clearer in IDEs.
- *
- * For example, in:
- *
- *   type Payload<T> = { data: T };
- *
- *   let r1: Payload<string>;
- *   let r2: Resolve<Payload<string>>;
- *
- * The inferred type of `r1` is going to be `Payload<string>` which shows up in
- * editor hints, and it may be unclear what's inside if you don't know the
- * definition of `Payload`.
- *
- * The inferred type of `r2` is going to be `{ data: string }`, which may be
- * more helpful.
- *
- * This trick comes from:
- * https://effectivetypescript.com/2022/02/25/gentips-4-display/
- */
-type Resolve<T> = T extends (...args: unknown[]) => unknown ? T : {
-    [K in keyof T]: T[K];
-};
-
 /**
  * Represents a user connected in a room. Treated as immutable.
  */
@@ -1527,7 +1554,7 @@ type User<P extends JsonObject = DP, U extends BaseUserMeta = DU> = {
     readonly canComment: boolean;
 };
 
-type InternalOthersEvent<P extends JsonObject, U extends BaseUserMeta> = {
+type InternalOthersEvent<P extends JsonObject, U extends BaseUserMeta> = Relax<{
     type: "leave";
     user: User<P, U>;
 } | {
@@ -1539,8 +1566,7 @@ type InternalOthersEvent<P extends JsonObject, U extends BaseUserMeta> = {
     updates: Partial<P>;
 } | {
     type: "reset";
-    user?: never;
-};
+}>;
 type OthersEvent<P extends JsonObject = DP, U extends BaseUserMeta = DU> = Resolve<InternalOthersEvent<P, U> & {
     others: readonly User<P, U>[];
 }>;
@@ -1909,11 +1935,11 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      *
      * @param {string} data the doc update to send to the server, base64 encoded uint8array
      */
-    updateYDoc(data: string, guid?: string): void;
+    updateYDoc(data: string, guid?: string, isV2?: boolean): void;
     /**
      * Sends a request for the current document from liveblocks server
      */
-    fetchYDoc(stateVector: string, guid?: string): void;
+    fetchYDoc(stateVector: string, guid?: string, isV2?: boolean): void;
     /**
      * Broadcasts an event to other users in the room. Event broadcasted to the room can be listened with {@link Room.subscribe}("event").
      * @param {any} event the event to broadcast. Should be serializable to JSON
@@ -2348,6 +2374,55 @@ type OptionalTupleUnless<C, T extends any[]> = Record<string, never> extends C ?
     C
 ] extends [never] ? OptionalTuple<T> : T;
 
+/**
+ * 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 channel notification setting is a set of notification kinds.
+ * One setting can have multiple kinds (+ augmentation)
+ */
+type ChannelNotificationSetting = {
+    [K in NotificationKind]: boolean;
+};
+/**
+ * Channels notification settings are a set of channel notification setting.
+ * One channel for one setting.
+ */
+type ChannelsNotificationSettings = {
+    [C in NotificationChannel]: ChannelNotificationSetting;
+};
+/**
+ * It creates a deep partial specific for `ChannelsNotificationSettings`
+ * 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 channels notification settings
+ * with augmentation preserved gracefully
+ */
+type PartialChannelsNotificationSettings = DeepPartialWithAugmentation<ChannelsNotificationSettings>;
+/**
+ *
+ * Utility to check if a channel notification setting
+ * is enabled for every notification kinds.
+ */
+declare function isChannelNotificationSettingEnabled(setting: ChannelNotificationSetting): boolean;
+
 interface RoomHttpApi<M extends BaseMetadata> {
     getThreads(options: {
         roomId: string;
@@ -2552,6 +2627,8 @@ interface NotificationHttpApi<M extends BaseMetadata> {
     markInboxNotificationAsRead(inboxNotificationId: string): Promise<void>;
     deleteAllInboxNotifications(): Promise<void>;
     deleteInboxNotification(inboxNotificationId: string): Promise<void>;
+    getChannelsNotificationSettings(): Promise<ChannelsNotificationSettings>;
+    updateChannelsNotificationSettings(settings: PartialChannelsNotificationSettings): Promise<ChannelsNotificationSettings>;
 }
 interface LiveblocksHttpApi<M extends BaseMetadata> extends RoomHttpApi<M>, NotificationHttpApi<M> {
     getUserThreads_experimental(options?: {
@@ -2840,6 +2917,27 @@ type NotificationsApi<M extends BaseMetadata> = {
      * await client.deleteInboxNotification("in_xxx");
      */
     deleteInboxNotification(inboxNotificationId: string): Promise<void>;
+    /**
+     * Gets channels notifications settings for a user for a project.
+     *
+     * @example
+     * const channelsNotificationSettings = await client.getChannelsNotificationSettings();
+     */
+    getChannelsNotificationSettings(options?: {
+        signal?: AbortSignal;
+    }): Promise<ChannelsNotificationSettings>;
+    /**
+     * Update channels notifications for a user for a project.
+     *
+     * @example
+     * await client.updateChannelsNotificationSettings({
+     *  email: {
+     *    thread: true,
+     *    textMention: false,
+     *  }
+     * })
+     */
+    updateChannelsNotificationSettings(settings: PartialChannelsNotificationSettings): Promise<ChannelsNotificationSettings>;
 };
 /**
  * @private Widest-possible Client type, matching _any_ Client instance. Note
@@ -2977,13 +3075,11 @@ type ClientOptions<U extends BaseUserMeta = DU> = {
      * the server yet.
      */
     preventUnsavedChanges?: boolean;
-} & ({
+} & Relax<{
     publicApiKey: string;
-    authEndpoint?: never;
 } | {
-    publicApiKey?: never;
     authEndpoint: AuthEndpoint;
-});
+}>;
 /**
  * Create a client that will be responsible to communicate with liveblocks servers.
  *
@@ -3429,6 +3525,18 @@ type DistributiveOmit<T, K extends PropertyKey> = T extends any ? Omit<T, K> : n
  * Throw an error, but as an expression instead of a statement.
  */
 declare function raise(msg: string): never;
+/**
+ * Drop-in replacement for Object.entries() that retains better types.
+ */
+declare function entries<O extends {
+    [key: string]: unknown;
+}, K extends keyof O>(obj: O): [K, O[K]][];
+/**
+ * Drop-in replacement for Object.keys() that retains better types.
+ */
+declare function keys<O extends {
+    [key: string]: unknown;
+}, K extends keyof O>(obj: O): K[];
 /**
  * Creates a new object by mapping a function over all values. Keys remain the
  * same. Think Array.prototype.map(), but for values in an object.
@@ -3751,4 +3859,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 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, CrdtType, type CreateListOp, 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, 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, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LostConnectionEvent, type Lson, type LsonObject, MutableSignal, type NoInfr, type NodeMap, NotificationsApiError, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalPromise, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, 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 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, WebsocketCloseCodes, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToThreadData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createThreadId, deprecate, deprecateIf, detectDupes, errorIf, freeze, generateCommentUrl, getMentionedIdsFromCommentBody, html, htmlSafe, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, raise, resolveUsersInCommentBody, shallow, stringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, unstringify, url, urljoin, wait, withTimeout };
+export { type AckOp, type ActivityData, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type BaseActivitiesData, type BaseAuthResult, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type ChannelNotificationSetting, type ChannelsNotificationSettings, 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, CrdtType, type CreateListOp, 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, 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, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LostConnectionEvent, type Lson, type LsonObject, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationKind, NotificationsApiError, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalPromise, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialChannelsNotificationSettings, 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 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, WebsocketCloseCodes, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToThreadData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createThreadId, deprecate, deprecateIf, detectDupes, entries, errorIf, freeze, generateCommentUrl, getMentionedIdsFromCommentBody, html, htmlSafe, isChannelNotificationSettingEnabled, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, raise, resolveUsersInCommentBody, shallow, stringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, unstringify, url, urljoin, wait, withTimeout };

package/dist/index.d.ts

@@ -5,18 +5,72 @@
 declare function detectDupes(pkgName: string, pkgVersion: string | false, // false if not built yet
 pkgFormat: string | false): void;
 
-type CustomAuthenticationResult = {
+/**
+ * This helper type is effectively a no-op, but will force TypeScript to
+ * "evaluate" any named helper types in its definition. This can sometimes make
+ * API signatures clearer in IDEs.
+ *
+ * For example, in:
+ *
+ *   type Payload<T> = { data: T };
+ *
+ *   let r1: Payload<string>;
+ *   let r2: Resolve<Payload<string>>;
+ *
+ * The inferred type of `r1` is going to be `Payload<string>` which shows up in
+ * editor hints, and it may be unclear what's inside if you don't know the
+ * definition of `Payload`.
+ *
+ * The inferred type of `r2` is going to be `{ data: string }`, which may be
+ * more helpful.
+ *
+ * This trick comes from:
+ * https://effectivetypescript.com/2022/02/25/gentips-4-display/
+ */
+type Resolve<T> = T extends (...args: unknown[]) => unknown ? T : {
+    [K in keyof T]: T[K];
+};
+
+/**
+ * Relaxes a discriminated union type definition, by explicitly adding
+ * properties defined in any other member as 'never'.
+ *
+ * This makes accessing the members much more relaxed in TypeScript.
+ *
+ * For example:
+ *   type MyUnion = Relax<
+ *     | { foo: string }
+ *     | { foo: number; bar: string; }
+ *     | { qux: boolean }
+ *   >;
+ *
+ *   // With Relax, accessing is much easier:
+ *   union.foo;       // string | number | undefined
+ *   union.bar;       // string | undefined
+ *   union.qux;       // boolean
+ *   union.whatever;  // Error: Property 'whatever' does not exist on type 'MyUnion'
+ *
+ *   // Without Relax, these would all be type errors:
+ *   union.foo; // Error: Property 'foo' does not exist on type 'MyUnion'
+ *   union.bar; // Error: Property 'bar' does not exist on type 'MyUnion'
+ *   union.qux; // Error: Property 'qux' does not exist on type 'MyUnion'
+ */
+type Relax<T> = DistributiveRelax<T, T extends any ? keyof T : never>;
+type DistributiveRelax<T, Ks extends string | number | symbol> = T extends any ? Resolve<{
+    [K in keyof T]: T[K];
+} & {
+    [K in Exclude<Ks, keyof T>]?: never;
+}> : never;
+
+type CustomAuthenticationResult = Relax<{
     token: string;
-    error?: never;
 } | {
-    token?: never;
     error: "forbidden";
     reason: string;
 } | {
-    token?: never;
     error: string;
     reason: string;
-};
+}>;
 
 /**
  * Represents an indefinitely deep arbitrary JSON data structure. There are
@@ -919,22 +973,18 @@ type CommentData = {
     editedAt?: Date;
     reactions: CommentReaction[];
     attachments: CommentAttachment[];
-} & ({
+} & Relax<{
     body: CommentBody;
-    deletedAt?: never;
 } | {
-    body?: never;
     deletedAt: Date;
-});
+}>;
 type CommentDataPlain = Omit<DateToString<CommentData>, "reactions" | "body"> & {
     reactions: DateToString<CommentReaction>[];
-} & ({
+} & Relax<{
     body: CommentBody;
-    deletedAt?: never;
 } | {
-    body?: never;
     deletedAt: string;
-});
+}>;
 type CommentBodyBlockElement = CommentBodyParagraph;
 type CommentBodyInlineElement = CommentBodyText | CommentBodyMention | CommentBodyLink;
 type CommentBodyElement = CommentBodyBlockElement | CommentBodyInlineElement;
@@ -1131,11 +1181,13 @@ type FetchYDocClientMsg = {
     readonly type: ClientMsgCode.FETCH_YDOC;
     readonly vector: string;
     readonly guid?: string;
+    readonly v2?: boolean;
 };
 type UpdateYDocClientMsg = {
     readonly type: ClientMsgCode.UPDATE_YDOC;
     readonly update: string;
     readonly guid?: string;
+    readonly v2?: boolean;
 };
 
 type IdTuple<T> = [id: string, value: T];
@@ -1338,6 +1390,7 @@ type YDocUpdateServerMsg = {
     readonly isSync: boolean;
     readonly stateVector: string | null;
     readonly guid?: string;
+    readonly v2?: boolean;
 };
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
@@ -1469,32 +1522,6 @@ declare namespace DevToolsTreeNode {
   export type { DevToolsTreeNode_CustomEventTreeNode as CustomEventTreeNode, DevToolsTreeNode_JsonTreeNode as JsonTreeNode, DevToolsTreeNode_LiveTreeNode as LiveTreeNode, DevToolsTreeNode_LsonTreeNode as LsonTreeNode, DevToolsTreeNode_TreeNode as TreeNode, DevToolsTreeNode_UserTreeNode as UserTreeNode };
 }
 
-/**
- * This helper type is effectively a no-op, but will force TypeScript to
- * "evaluate" any named helper types in its definition. This can sometimes make
- * API signatures clearer in IDEs.
- *
- * For example, in:
- *
- *   type Payload<T> = { data: T };
- *
- *   let r1: Payload<string>;
- *   let r2: Resolve<Payload<string>>;
- *
- * The inferred type of `r1` is going to be `Payload<string>` which shows up in
- * editor hints, and it may be unclear what's inside if you don't know the
- * definition of `Payload`.
- *
- * The inferred type of `r2` is going to be `{ data: string }`, which may be
- * more helpful.
- *
- * This trick comes from:
- * https://effectivetypescript.com/2022/02/25/gentips-4-display/
- */
-type Resolve<T> = T extends (...args: unknown[]) => unknown ? T : {
-    [K in keyof T]: T[K];
-};
-
 /**
  * Represents a user connected in a room. Treated as immutable.
  */
@@ -1527,7 +1554,7 @@ type User<P extends JsonObject = DP, U extends BaseUserMeta = DU> = {
     readonly canComment: boolean;
 };
 
-type InternalOthersEvent<P extends JsonObject, U extends BaseUserMeta> = {
+type InternalOthersEvent<P extends JsonObject, U extends BaseUserMeta> = Relax<{
     type: "leave";
     user: User<P, U>;
 } | {
@@ -1539,8 +1566,7 @@ type InternalOthersEvent<P extends JsonObject, U extends BaseUserMeta> = {
     updates: Partial<P>;
 } | {
     type: "reset";
-    user?: never;
-};
+}>;
 type OthersEvent<P extends JsonObject = DP, U extends BaseUserMeta = DU> = Resolve<InternalOthersEvent<P, U> & {
     others: readonly User<P, U>[];
 }>;
@@ -1909,11 +1935,11 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      *
      * @param {string} data the doc update to send to the server, base64 encoded uint8array
      */
-    updateYDoc(data: string, guid?: string): void;
+    updateYDoc(data: string, guid?: string, isV2?: boolean): void;
     /**
      * Sends a request for the current document from liveblocks server
      */
-    fetchYDoc(stateVector: string, guid?: string): void;
+    fetchYDoc(stateVector: string, guid?: string, isV2?: boolean): void;
     /**
      * Broadcasts an event to other users in the room. Event broadcasted to the room can be listened with {@link Room.subscribe}("event").
      * @param {any} event the event to broadcast. Should be serializable to JSON
@@ -2348,6 +2374,55 @@ type OptionalTupleUnless<C, T extends any[]> = Record<string, never> extends C ?
     C
 ] extends [never] ? OptionalTuple<T> : T;
 
+/**
+ * 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 channel notification setting is a set of notification kinds.
+ * One setting can have multiple kinds (+ augmentation)
+ */
+type ChannelNotificationSetting = {
+    [K in NotificationKind]: boolean;
+};
+/**
+ * Channels notification settings are a set of channel notification setting.
+ * One channel for one setting.
+ */
+type ChannelsNotificationSettings = {
+    [C in NotificationChannel]: ChannelNotificationSetting;
+};
+/**
+ * It creates a deep partial specific for `ChannelsNotificationSettings`
+ * 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 channels notification settings
+ * with augmentation preserved gracefully
+ */
+type PartialChannelsNotificationSettings = DeepPartialWithAugmentation<ChannelsNotificationSettings>;
+/**
+ *
+ * Utility to check if a channel notification setting
+ * is enabled for every notification kinds.
+ */
+declare function isChannelNotificationSettingEnabled(setting: ChannelNotificationSetting): boolean;
+
 interface RoomHttpApi<M extends BaseMetadata> {
     getThreads(options: {
         roomId: string;
@@ -2552,6 +2627,8 @@ interface NotificationHttpApi<M extends BaseMetadata> {
     markInboxNotificationAsRead(inboxNotificationId: string): Promise<void>;
     deleteAllInboxNotifications(): Promise<void>;
     deleteInboxNotification(inboxNotificationId: string): Promise<void>;
+    getChannelsNotificationSettings(): Promise<ChannelsNotificationSettings>;
+    updateChannelsNotificationSettings(settings: PartialChannelsNotificationSettings): Promise<ChannelsNotificationSettings>;
 }
 interface LiveblocksHttpApi<M extends BaseMetadata> extends RoomHttpApi<M>, NotificationHttpApi<M> {
     getUserThreads_experimental(options?: {
@@ -2840,6 +2917,27 @@ type NotificationsApi<M extends BaseMetadata> = {
      * await client.deleteInboxNotification("in_xxx");
      */
     deleteInboxNotification(inboxNotificationId: string): Promise<void>;
+    /**
+     * Gets channels notifications settings for a user for a project.
+     *
+     * @example
+     * const channelsNotificationSettings = await client.getChannelsNotificationSettings();
+     */
+    getChannelsNotificationSettings(options?: {
+        signal?: AbortSignal;
+    }): Promise<ChannelsNotificationSettings>;
+    /**
+     * Update channels notifications for a user for a project.
+     *
+     * @example
+     * await client.updateChannelsNotificationSettings({
+     *  email: {
+     *    thread: true,
+     *    textMention: false,
+     *  }
+     * })
+     */
+    updateChannelsNotificationSettings(settings: PartialChannelsNotificationSettings): Promise<ChannelsNotificationSettings>;
 };
 /**
  * @private Widest-possible Client type, matching _any_ Client instance. Note
@@ -2977,13 +3075,11 @@ type ClientOptions<U extends BaseUserMeta = DU> = {
      * the server yet.
      */
     preventUnsavedChanges?: boolean;
-} & ({
+} & Relax<{
     publicApiKey: string;
-    authEndpoint?: never;
 } | {
-    publicApiKey?: never;
     authEndpoint: AuthEndpoint;
-});
+}>;
 /**
  * Create a client that will be responsible to communicate with liveblocks servers.
  *
@@ -3429,6 +3525,18 @@ type DistributiveOmit<T, K extends PropertyKey> = T extends any ? Omit<T, K> : n
  * Throw an error, but as an expression instead of a statement.
  */
 declare function raise(msg: string): never;
+/**
+ * Drop-in replacement for Object.entries() that retains better types.
+ */
+declare function entries<O extends {
+    [key: string]: unknown;
+}, K extends keyof O>(obj: O): [K, O[K]][];
+/**
+ * Drop-in replacement for Object.keys() that retains better types.
+ */
+declare function keys<O extends {
+    [key: string]: unknown;
+}, K extends keyof O>(obj: O): K[];
 /**
  * Creates a new object by mapping a function over all values. Keys remain the
  * same. Think Array.prototype.map(), but for values in an object.
@@ -3751,4 +3859,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 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, CrdtType, type CreateListOp, 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, 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, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LostConnectionEvent, type Lson, type LsonObject, MutableSignal, type NoInfr, type NodeMap, NotificationsApiError, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalPromise, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, 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 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, WebsocketCloseCodes, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToThreadData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createThreadId, deprecate, deprecateIf, detectDupes, errorIf, freeze, generateCommentUrl, getMentionedIdsFromCommentBody, html, htmlSafe, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, raise, resolveUsersInCommentBody, shallow, stringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, unstringify, url, urljoin, wait, withTimeout };
+export { type AckOp, type ActivityData, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type BaseActivitiesData, type BaseAuthResult, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type ChannelNotificationSetting, type ChannelsNotificationSettings, 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, CrdtType, type CreateListOp, 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, 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, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LostConnectionEvent, type Lson, type LsonObject, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationKind, NotificationsApiError, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalPromise, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialChannelsNotificationSettings, 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 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, WebsocketCloseCodes, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToThreadData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createThreadId, deprecate, deprecateIf, detectDupes, entries, errorIf, freeze, generateCommentUrl, getMentionedIdsFromCommentBody, html, htmlSafe, isChannelNotificationSettingEnabled, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, raise, resolveUsersInCommentBody, shallow, stringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, unstringify, url, urljoin, wait, withTimeout };