@liveblocks/core 2.19.0 → 2.21.0-emails1

package/dist/index.d.cts

@@ -2495,11 +2495,24 @@ type NotificationChannelSettings = {
     [K in NotificationKind]: boolean;
 };
 /**
- * User notification settings are a set of notification channel setting.
+ * @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;
+    [C in NotificationChannel]: NotificationChannelSettings | null;
 };
 /**
  * It creates a deep partial specific for `UserNotificationSettings`
@@ -2514,16 +2527,42 @@ type DeepPartialWithAugmentation<T> = T extends object ? {
     } : DeepPartialWithAugmentation<T[P]>;
 } : T;
 /**
- * Partial user notification settings
- * with augmentation preserved gracefully
+ * 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<UserNotificationSettings>;
+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): boolean;
+declare function isNotificationChannelEnabled(settings: NotificationChannelSettings | null): boolean;
 
 interface RoomHttpApi<M extends BaseMetadata> {
     getThreads(options: {
@@ -2741,8 +2780,8 @@ interface NotificationHttpApi<M extends BaseMetadata> {
     deleteInboxNotification(inboxNotificationId: string): Promise<void>;
     getUserNotificationSettings(options?: {
         signal?: AbortSignal;
-    }): Promise<UserNotificationSettings>;
-    updateUserNotificationSettings(settings: PartialUserNotificationSettings): Promise<UserNotificationSettings>;
+    }): Promise<UserNotificationSettingsPlain>;
+    updateUserNotificationSettings(settings: PartialUserNotificationSettings): Promise<UserNotificationSettingsPlain>;
 }
 interface LiveblocksHttpApi<M extends BaseMetadata> extends RoomHttpApi<M>, NotificationHttpApi<M> {
     getUserThreads_experimental(options?: {
@@ -3974,4 +4013,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 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, type LargeMessageStrategy, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, 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, 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, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, 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 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, type LargeMessageStrategy, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, 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, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToThreadData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, 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, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchUserNotificationSettings, raise, resolveUsersInCommentBody, shallow, stableStringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, url, urljoin, wait, withTimeout };

package/dist/index.d.ts

@@ -2495,11 +2495,24 @@ type NotificationChannelSettings = {
     [K in NotificationKind]: boolean;
 };
 /**
- * User notification settings are a set of notification channel setting.
+ * @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;
+    [C in NotificationChannel]: NotificationChannelSettings | null;
 };
 /**
  * It creates a deep partial specific for `UserNotificationSettings`
@@ -2514,16 +2527,42 @@ type DeepPartialWithAugmentation<T> = T extends object ? {
     } : DeepPartialWithAugmentation<T[P]>;
 } : T;
 /**
- * Partial user notification settings
- * with augmentation preserved gracefully
+ * 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<UserNotificationSettings>;
+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): boolean;
+declare function isNotificationChannelEnabled(settings: NotificationChannelSettings | null): boolean;
 
 interface RoomHttpApi<M extends BaseMetadata> {
     getThreads(options: {
@@ -2741,8 +2780,8 @@ interface NotificationHttpApi<M extends BaseMetadata> {
     deleteInboxNotification(inboxNotificationId: string): Promise<void>;
     getUserNotificationSettings(options?: {
         signal?: AbortSignal;
-    }): Promise<UserNotificationSettings>;
-    updateUserNotificationSettings(settings: PartialUserNotificationSettings): Promise<UserNotificationSettings>;
+    }): Promise<UserNotificationSettingsPlain>;
+    updateUserNotificationSettings(settings: PartialUserNotificationSettings): Promise<UserNotificationSettingsPlain>;
 }
 interface LiveblocksHttpApi<M extends BaseMetadata> extends RoomHttpApi<M>, NotificationHttpApi<M> {
     getUserThreads_experimental(options?: {
@@ -3974,4 +4013,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 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, type LargeMessageStrategy, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, 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, 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, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, 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 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, type LargeMessageStrategy, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, 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, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToThreadData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, 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, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchUserNotificationSettings, raise, resolveUsersInCommentBody, shallow, stableStringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, url, urljoin, wait, withTimeout };

package/dist/index.js

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "2.19.0";
+var PKG_VERSION = "2.21.0-emails1";
 var PKG_FORMAT = "esm";
 
 // src/dupe-detection.ts
@@ -187,6 +187,12 @@ function keys(obj) {
 function values(obj) {
   return Object.values(obj);
 }
+function create(obj, descriptors) {
+  if (typeof descriptors !== "undefined") {
+    return Object.create(obj, descriptors);
+  }
+  return Object.create(obj);
+}
 function mapValues(obj, mapFn) {
   const result = {};
   for (const pair of Object.entries(obj)) {
@@ -3597,6 +3603,71 @@ function unlinkDevTools(roomId) {
   });
 }
 
+// src/protocol/UserNotificationSettings.ts
+var kPlain = Symbol("user-notification-settings-plain");
+function createUserNotificationSettings(plain) {
+  const channels = [
+    "email",
+    "slack",
+    "teams",
+    "webPush"
+  ];
+  const descriptors = {
+    [kPlain]: {
+      value: plain,
+      enumerable: false
+    }
+  };
+  for (const channel of channels) {
+    descriptors[channel] = {
+      enumerable: true,
+      /**
+       * In the TypeScript standard library definitions, the built-in interface for a property descriptor
+       * does not include a specialized type for the “this” context in the getter or setter functions.
+       * As a result, both the ⁠get and ⁠set methods implicitly have ⁠this: any.
+       * The reason is that property descriptors in JavaScript are used across various objects with
+       * no enforced shape for ⁠this. And so the standard library definitions have to remain as broad as possible
+       * to support any valid JavaScript usage (e.g `Object.defineProperty`).
+       *
+       * So we can safely tells that this getter is typed as `this: UserNotificationSettings` because we're
+       * creating a well known shaped object → `UserNotificationSettings`.
+       */
+      get() {
+        const value = this[kPlain][channel];
+        if (typeof value === "undefined") {
+          error2(
+            `In order to use the '${channel}' channel, please set up your project first. For more information: https://liveblocks.io/docs/errors/enable-a-notification-channel`
+          );
+          return null;
+        }
+        return value;
+      }
+    };
+  }
+  return create(null, descriptors);
+}
+function patchUserNotificationSettings(existing, patch) {
+  const outcoming = createUserNotificationSettings({
+    ...existing[kPlain]
+  });
+  for (const channel of keys(patch)) {
+    const updates = patch[channel];
+    if (updates !== void 0) {
+      const kindUpdates = Object.fromEntries(
+        entries(updates).filter(([, value]) => value !== void 0)
+      );
+      outcoming[kPlain][channel] = {
+        ...outcoming[kPlain][channel],
+        ...kindUpdates
+      };
+    }
+  }
+  return outcoming;
+}
+function isNotificationChannelEnabled(settings) {
+  return settings !== null ? values(settings).every((enabled) => enabled === true) : false;
+}
+
 // src/lib/position.ts
 var MIN_CODE = 32;
 var MAX_CODE = 126;
@@ -8189,6 +8260,16 @@ function createClient(options) {
     const win = typeof window !== "undefined" ? window : void 0;
     win?.addEventListener("beforeunload", maybePreventClose);
   }
+  async function getNotificationSettings(options2) {
+    const plainSettings = await httpClient.getUserNotificationSettings(options2);
+    const settings = createUserNotificationSettings(plainSettings);
+    return settings;
+  }
+  async function updateNotificationSettings(settings) {
+    const plainSettings = await httpClient.updateUserNotificationSettings(settings);
+    const settingsObject = createUserNotificationSettings(plainSettings);
+    return settingsObject;
+  }
   const client = Object.defineProperty(
     {
       enterRoom,
@@ -8202,9 +8283,9 @@ function createClient(options) {
       markInboxNotificationAsRead: httpClient.markInboxNotificationAsRead,
       deleteAllInboxNotifications: httpClient.deleteAllInboxNotifications,
       deleteInboxNotification: httpClient.deleteInboxNotification,
-      // Public channel notification settings API
-      getNotificationSettings: httpClient.getUserNotificationSettings,
-      updateNotificationSettings: httpClient.updateUserNotificationSettings,
+      // Public user notification settings API
+      getNotificationSettings,
+      updateNotificationSettings,
       // Advanced resolvers APIs
       resolvers: {
         invalidateUsers: invalidateResolvedUsers,
@@ -9194,11 +9275,6 @@ var SortedList = class _SortedList {
   }
 };
 
-// src/protocol/UserNotificationSettings.ts
-function isNotificationChannelEnabled(settings) {
-  return values(settings).every((enabled) => enabled === true);
-}
-
 // src/types/Others.ts
 var TextEditorType = /* @__PURE__ */ ((TextEditorType2) => {
   TextEditorType2["Lexical"] = "lexical";
@@ -9251,6 +9327,7 @@ export {
   createCommentId,
   createInboxNotificationId,
   createThreadId,
+  createUserNotificationSettings,
   deprecate,
   deprecateIf,
   detectDupes,
@@ -9286,6 +9363,7 @@ export {
   nn,
   objectToQuery,
   patchLiveObjectKey,
+  patchUserNotificationSettings,
   raise,
   resolveUsersInCommentBody,
   shallow,