@realtimexsco/live-chat 1.3.4 → 1.4.1

package/dist/index.d.mts

@@ -4,6 +4,9 @@ import * as zustand_middleware from 'zustand/middleware';
 import * as zustand from 'zustand';
 import { ManagerOptions, SocketOptions, Socket } from 'socket.io-client';
 import { Renderable } from 'react-hot-toast';
+import { DayPicker, DayButton } from 'react-day-picker';
+import * as class_variance_authority_types from 'class-variance-authority/types';
+import { VariantProps } from 'class-variance-authority';
 
 interface IChannel {
     id: string;
@@ -31,6 +34,7 @@ interface IMessage {
     content: string;
     sender: string;
     senderId?: string;
+    senderImage?: string;
     receiver?: string;
     timestamp: string;
     isOwnMessage: boolean;
@@ -1222,6 +1226,56 @@ interface ActiveChannelMessagesProps {
 
 declare const ActiveChannelMessagesView: (props: ActiveChannelMessagesProps) => React.JSX.Element;
 
+/** Presets matching Slack's "Jump to…" menu. */
+type JumpToPreset = "today" | "yesterday" | "lastWeek" | "lastMonth" | "beginning" | "specific";
+type PendingJump = {
+    kind: "beginning";
+} | {
+    kind: "date";
+    at: number;
+};
+declare function startOfLocalDay(date: Date): number;
+/** `yyyy-mm-dd` for `<input type="date" min/max>`. */
+declare function toDateInputValue(date: Date): string;
+/**
+ * Clamp a picked day into [minDay, maxDay] (inclusive local midnights).
+ * Returns null if the range is invalid.
+ */
+declare function clampJumpDate(picked: Date, minDay: number, maxDay: number): Date | null;
+/** First selectable day = later of conversation created vs oldest known message. */
+declare function resolveJumpDateBounds(createdAt: string | undefined, oldestMessageTimestamp: string | undefined, now?: Date): {
+    minDay: number;
+    maxDay: number;
+};
+declare function resolveJumpPreset(preset: Exclude<JumpToPreset, "beginning" | "specific">, now?: Date): number;
+/**
+ * Decide whether to keep loading older messages, or which message id to scroll to.
+ * Messages must be sorted ascending by timestamp.
+ */
+declare function resolveJumpStep(messages: Array<{
+    id: string;
+    _id?: string;
+    timestamp: string;
+}>, pending: PendingJump, hasMore: boolean): {
+    action: "loadOlder";
+} | {
+    action: "scroll";
+    messageId: string;
+} | {
+    action: "done";
+};
+/** Smoothly scroll a message into the upper-middle of the list container. */
+declare function smoothScrollToMessage(container: HTMLElement, messageEl: HTMLElement): void;
+
+type ChatDateJumpMenuProps = {
+    label: string;
+    /** Inclusive local-day bounds for the specific-date picker (ms at local midnight). */
+    minDay: number;
+    maxDay: number;
+    onJump: (preset: JumpToPreset, specificDate?: Date) => void;
+};
+declare function ChatDateJumpMenu({ label, minDay, maxDay, onJump }: ChatDateJumpMenuProps): React.JSX.Element;
+
 interface ChannelMessageBoxProps {
     activeChannel: IChannel | null;
     conversationId: string | null;
@@ -1425,6 +1479,7 @@ interface MessageItemProps {
     conversationInfo?: any;
     isHighlighted?: boolean;
     senderName?: string;
+    senderId?: string;
     senderImage?: string;
     showSenderName?: boolean;
     showSenderLabel?: boolean;
@@ -1480,4 +1535,103 @@ declare function ChatAlertsProvider({ children, value, }: {
 }): React.JSX.Element;
 declare function useChatAlerts(): ChatAlertsContextValue;
 
-export { type ActiveChannelMessagesSlotProps, type AdminsDrawerSlotProps, type AttachmentsDrawerSlotProps, type AvatarSlotProps, CHAT_API_KEYS, CHAT_GET_API_KEYS, Channel, type ChannelDetailsDrawerSlotProps, ChannelHeaderView as ChannelHeader, type ChannelHeaderSlotProps, ChannelListView as ChannelList, ChannelListItem, type ChannelListItemSlotProps, type ChannelListSlotProps, type ChannelMessageBoxSlotProps, Chat, type ChatActionModalSlotProps, ChatAlertsProvider, type ChatApiKey, ChatAvatar, type ChatCallContext, type ChatClassNames, type ChatColorMode, type ChatComponents, type ChatCustomizationConfig, ChatCustomizationProvider, type ChatDateTimePreferences, type ChatFeatures, type ChatGetApiKey, ChatLayout, type ChatLayoutConfig, type ChatLayoutSlotProps, ChatLocaleProvider, ChatMain, type ChatPanelAlertsSlotProps, type ChatQueryParams, type ChatQueryParamsByApi, ChatThemeProvider, ChatViewport, type ChatViewportHeight, DefaultChannelListItem, DefaultChatAvatar, DefaultChatLayout, ForwardModalView as ForwardModal, type ForwardModalSlotProps, HeaderCallActions, type HeaderCallActionsSlotProps, type HeaderLeftSideSlotProps, type HeaderRightSideSlotProps, type HeaderSearchOverlaySlotProps, type IAttachment, type IChannel, type IDMDelete, type IDMEditMessage, type IDMForward, type IDMMessage, type IDMPin, type IDMReaction, type IDMRead, type IDMStar, type IDMTyping, type IDMUnstar, type IMessage, type ISocketConfig, LoggedUserDetails, type LoggedUserDetailsSlotProps, type MembersDrawerSlotProps, type MessageAttachmentsSlotProps, ChannelMessageBoxView as MessageInput, MessageItemView as MessageItem, type MessageItemSlotProps, ActiveChannelMessagesView as MessageList, type MessageReactionsSlotProps, type MessageReplySnippetSlotProps, type MessageStatusSlotProps, type MessageToolbarSlotProps, type PermissionDrawerSlotProps, type PhoneCallButtonSlotProps, type PinnedMessagesDrawerSlotProps, type StarredMessagesDrawerSlotProps, type UIConfig, type VideoCallButtonSlotProps, capitalizeFirst, ChatMain as default, defaultChatClassNames, defaultChatComponents, defaultChatFeatures, defaultChatLayoutConfig, downloadFile, getChatBaseUrl, getChatQueryParamApis, getChatQueryParams, getChatQueryParamsByApi, getChatSocketUrl, getFirstAndLastNameOneCharacter, getResponsiveWidth, getSocketConfig, isEmpty, mergeChatCustomization, mergeChatLayoutConfig, packageDefaultComponents, resolveApiUrl, resolveChatApiKey, resolveSocketUrl, setChatAccessToken, setChatBaseURL, setChatClientId, setChatQueryParamApis, setChatQueryParams, setChatQueryParamsByApi, setChatSocketUrl, showNotification, socketService, uniqueList, useChatAlerts, useChatContext, useChatController, useChatCustomization, useChatCustomizationOptional, useChatFeatures, useChatFeaturesOptional, useChatLocale, useStore as useChatStore, useChatTheme };
+declare const buttonVariants: (props?: ({
+    variant?: "link" | "default" | "destructive" | "outline" | "secondary" | "ghost" | null | undefined;
+    size?: "xs" | "sm" | "lg" | "default" | "icon" | "icon-xs" | "icon-sm" | "icon-lg" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string;
+declare function Button({ className, variant, size, asChild, ...props }: React.ComponentProps<"button"> & VariantProps<typeof buttonVariants> & {
+    asChild?: boolean;
+}): React.JSX.Element;
+
+declare function Calendar({ className, classNames, showOutsideDays, captionLayout, buttonVariant, formatters, components, ...props }: React.ComponentProps<typeof DayPicker> & {
+    buttonVariant?: React.ComponentProps<typeof Button>["variant"];
+}): React.JSX.Element;
+declare function CalendarDayButton({ className, day, modifiers, ...props }: React.ComponentProps<typeof DayButton>): React.JSX.Element;
+
+interface PushConfig {
+    /** Firebase credentials present on the backend deployment. */
+    configured: boolean;
+    /** Super-admin ceiling AND client admin toggle, resolved. */
+    enabled: boolean;
+    firebaseConfig: Record<string, string> | null;
+    vapidKey: string | null;
+}
+interface PushPreference {
+    enabled: boolean;
+    allowedByWorkspace: boolean;
+    deviceCount: number;
+}
+declare const apiGetPushConfig: () => Promise<PushConfig>;
+declare const apiRegisterPushToken: (token: string, deviceLabel?: string) => Promise<any>;
+declare const apiRemovePushToken: (token: string) => Promise<any>;
+declare const apiGetPushPreference: () => Promise<PushPreference>;
+declare const apiUpdatePushPreference: (enabled: boolean) => Promise<any>;
+declare const isPushSupported: () => boolean;
+declare const getStoredPushToken: () => string | null;
+/**
+ * Full device opt-in: browser permission prompt → FCM token → backend
+ * registration. Returns the registered token.
+ */
+declare const enablePushOnThisDevice: () => Promise<string>;
+/** Device opt-out: invalidates the FCM token and removes it server-side. */
+declare const disablePushOnThisDevice: () => Promise<void>;
+/**
+ * Foreground messages (tab focused) — FCM does not display these itself.
+ * Returns an unsubscribe function. Typical use: show the in-app toast.
+ */
+declare const onForegroundPush: (callback: (payload: {
+    title?: string;
+    body?: string;
+    data?: Record<string, string>;
+}) => void) => Promise<() => void>;
+
+interface PushNotificationsState {
+    /** Browser supports service workers + the Push API. */
+    supported: boolean;
+    /** Super-admin ceiling AND client admin toggle allow push. */
+    allowedByWorkspace: boolean;
+    /** Firebase credentials are configured on the backend. */
+    configured: boolean;
+    /** Current browser notification permission. */
+    permission: NotificationPermission | "unsupported";
+    /** The user's account-level preference (mute switch). */
+    userEnabled: boolean;
+    /** This browser has a registered push token. */
+    deviceEnabled: boolean;
+    loading: boolean;
+    error: string | null;
+}
+interface UsePushNotifications extends PushNotificationsState {
+    /** Prompt for permission and register this device. */
+    enable: () => Promise<boolean>;
+    /** Unregister this device. */
+    disable: () => Promise<void>;
+    /** Account-level mute switch across all of the user's devices. */
+    setUserEnabled: (enabled: boolean) => Promise<void>;
+    refresh: () => Promise<void>;
+}
+/**
+ * Per-user push notification opt-in for the embedded chat.
+ *
+ * Renders no UI itself — pair with PushNotificationToggle or your own
+ * control. Requires setChatBaseURL/setChatClientId/setChatAccessToken to be
+ * configured (same as the rest of the chat).
+ */
+declare const usePushNotifications: () => UsePushNotifications;
+
+interface PushNotificationToggleProps {
+    className?: string;
+    label?: string;
+    description?: string;
+}
+/**
+ * Drop-in per-user push notification switch. Renders nothing while push is
+ * unsupported by the browser, disabled by the workspace admins, or not yet
+ * configured on the backend — users only ever see a switch they can use.
+ *
+ * On: prompts for browser permission and registers this device.
+ * Off: unregisters this device.
+ */
+declare const PushNotificationToggle: ({ className, label, description, }: PushNotificationToggleProps) => React.JSX.Element | null;
+
+export { type ActiveChannelMessagesSlotProps, type AdminsDrawerSlotProps, type AttachmentsDrawerSlotProps, type AvatarSlotProps, CHAT_API_KEYS, CHAT_GET_API_KEYS, Calendar, CalendarDayButton, Channel, type ChannelDetailsDrawerSlotProps, ChannelHeaderView as ChannelHeader, type ChannelHeaderSlotProps, ChannelListView as ChannelList, ChannelListItem, type ChannelListItemSlotProps, type ChannelListSlotProps, type ChannelMessageBoxSlotProps, Chat, type ChatActionModalSlotProps, ChatAlertsProvider, type ChatApiKey, ChatAvatar, type ChatCallContext, type ChatClassNames, type ChatColorMode, type ChatComponents, type ChatCustomizationConfig, ChatCustomizationProvider, ChatDateJumpMenu, type ChatDateTimePreferences, type ChatFeatures, type ChatGetApiKey, ChatLayout, type ChatLayoutConfig, type ChatLayoutSlotProps, ChatLocaleProvider, ChatMain, type ChatPanelAlertsSlotProps, type ChatQueryParams, type ChatQueryParamsByApi, ChatThemeProvider, ChatViewport, type ChatViewportHeight, DefaultChannelListItem, DefaultChatAvatar, DefaultChatLayout, ForwardModalView as ForwardModal, type ForwardModalSlotProps, HeaderCallActions, type HeaderCallActionsSlotProps, type HeaderLeftSideSlotProps, type HeaderRightSideSlotProps, type HeaderSearchOverlaySlotProps, type IAttachment, type IChannel, type IDMDelete, type IDMEditMessage, type IDMForward, type IDMMessage, type IDMPin, type IDMReaction, type IDMRead, type IDMStar, type IDMTyping, type IDMUnstar, type IMessage, type ISocketConfig, type JumpToPreset, LoggedUserDetails, type LoggedUserDetailsSlotProps, type MembersDrawerSlotProps, type MessageAttachmentsSlotProps, ChannelMessageBoxView as MessageInput, MessageItemView as MessageItem, type MessageItemSlotProps, ActiveChannelMessagesView as MessageList, type MessageReactionsSlotProps, type MessageReplySnippetSlotProps, type MessageStatusSlotProps, type MessageToolbarSlotProps, type PendingJump, type PermissionDrawerSlotProps, type PhoneCallButtonSlotProps, type PinnedMessagesDrawerSlotProps, type PushConfig, PushNotificationToggle, type PushNotificationToggleProps, type PushNotificationsState, type PushPreference, type StarredMessagesDrawerSlotProps, type UIConfig, type UsePushNotifications, type VideoCallButtonSlotProps, apiGetPushConfig, apiGetPushPreference, apiRegisterPushToken, apiRemovePushToken, apiUpdatePushPreference, capitalizeFirst, clampJumpDate, ChatMain as default, defaultChatClassNames, defaultChatComponents, defaultChatFeatures, defaultChatLayoutConfig, disablePushOnThisDevice, downloadFile, enablePushOnThisDevice, getChatBaseUrl, getChatQueryParamApis, getChatQueryParams, getChatQueryParamsByApi, getChatSocketUrl, getFirstAndLastNameOneCharacter, getResponsiveWidth, getSocketConfig, getStoredPushToken, isEmpty, isPushSupported, mergeChatCustomization, mergeChatLayoutConfig, onForegroundPush, packageDefaultComponents, resolveApiUrl, resolveChatApiKey, resolveJumpDateBounds, resolveJumpPreset, resolveJumpStep, resolveSocketUrl, setChatAccessToken, setChatBaseURL, setChatClientId, setChatQueryParamApis, setChatQueryParams, setChatQueryParamsByApi, setChatSocketUrl, showNotification, smoothScrollToMessage, socketService, startOfLocalDay, toDateInputValue, uniqueList, useChatAlerts, useChatContext, useChatController, useChatCustomization, useChatCustomizationOptional, useChatFeatures, useChatFeaturesOptional, useChatLocale, useStore as useChatStore, useChatTheme, usePushNotifications };

package/dist/index.d.ts

@@ -4,6 +4,9 @@ import * as zustand_middleware from 'zustand/middleware';
 import * as zustand from 'zustand';
 import { ManagerOptions, SocketOptions, Socket } from 'socket.io-client';
 import { Renderable } from 'react-hot-toast';
+import { DayPicker, DayButton } from 'react-day-picker';
+import * as class_variance_authority_types from 'class-variance-authority/types';
+import { VariantProps } from 'class-variance-authority';
 
 interface IChannel {
     id: string;
@@ -31,6 +34,7 @@ interface IMessage {
     content: string;
     sender: string;
     senderId?: string;
+    senderImage?: string;
     receiver?: string;
     timestamp: string;
     isOwnMessage: boolean;
@@ -1222,6 +1226,56 @@ interface ActiveChannelMessagesProps {
 
 declare const ActiveChannelMessagesView: (props: ActiveChannelMessagesProps) => React.JSX.Element;
 
+/** Presets matching Slack's "Jump to…" menu. */
+type JumpToPreset = "today" | "yesterday" | "lastWeek" | "lastMonth" | "beginning" | "specific";
+type PendingJump = {
+    kind: "beginning";
+} | {
+    kind: "date";
+    at: number;
+};
+declare function startOfLocalDay(date: Date): number;
+/** `yyyy-mm-dd` for `<input type="date" min/max>`. */
+declare function toDateInputValue(date: Date): string;
+/**
+ * Clamp a picked day into [minDay, maxDay] (inclusive local midnights).
+ * Returns null if the range is invalid.
+ */
+declare function clampJumpDate(picked: Date, minDay: number, maxDay: number): Date | null;
+/** First selectable day = later of conversation created vs oldest known message. */
+declare function resolveJumpDateBounds(createdAt: string | undefined, oldestMessageTimestamp: string | undefined, now?: Date): {
+    minDay: number;
+    maxDay: number;
+};
+declare function resolveJumpPreset(preset: Exclude<JumpToPreset, "beginning" | "specific">, now?: Date): number;
+/**
+ * Decide whether to keep loading older messages, or which message id to scroll to.
+ * Messages must be sorted ascending by timestamp.
+ */
+declare function resolveJumpStep(messages: Array<{
+    id: string;
+    _id?: string;
+    timestamp: string;
+}>, pending: PendingJump, hasMore: boolean): {
+    action: "loadOlder";
+} | {
+    action: "scroll";
+    messageId: string;
+} | {
+    action: "done";
+};
+/** Smoothly scroll a message into the upper-middle of the list container. */
+declare function smoothScrollToMessage(container: HTMLElement, messageEl: HTMLElement): void;
+
+type ChatDateJumpMenuProps = {
+    label: string;
+    /** Inclusive local-day bounds for the specific-date picker (ms at local midnight). */
+    minDay: number;
+    maxDay: number;
+    onJump: (preset: JumpToPreset, specificDate?: Date) => void;
+};
+declare function ChatDateJumpMenu({ label, minDay, maxDay, onJump }: ChatDateJumpMenuProps): React.JSX.Element;
+
 interface ChannelMessageBoxProps {
     activeChannel: IChannel | null;
     conversationId: string | null;
@@ -1425,6 +1479,7 @@ interface MessageItemProps {
     conversationInfo?: any;
     isHighlighted?: boolean;
     senderName?: string;
+    senderId?: string;
     senderImage?: string;
     showSenderName?: boolean;
     showSenderLabel?: boolean;
@@ -1480,4 +1535,103 @@ declare function ChatAlertsProvider({ children, value, }: {
 }): React.JSX.Element;
 declare function useChatAlerts(): ChatAlertsContextValue;
 
-export { type ActiveChannelMessagesSlotProps, type AdminsDrawerSlotProps, type AttachmentsDrawerSlotProps, type AvatarSlotProps, CHAT_API_KEYS, CHAT_GET_API_KEYS, Channel, type ChannelDetailsDrawerSlotProps, ChannelHeaderView as ChannelHeader, type ChannelHeaderSlotProps, ChannelListView as ChannelList, ChannelListItem, type ChannelListItemSlotProps, type ChannelListSlotProps, type ChannelMessageBoxSlotProps, Chat, type ChatActionModalSlotProps, ChatAlertsProvider, type ChatApiKey, ChatAvatar, type ChatCallContext, type ChatClassNames, type ChatColorMode, type ChatComponents, type ChatCustomizationConfig, ChatCustomizationProvider, type ChatDateTimePreferences, type ChatFeatures, type ChatGetApiKey, ChatLayout, type ChatLayoutConfig, type ChatLayoutSlotProps, ChatLocaleProvider, ChatMain, type ChatPanelAlertsSlotProps, type ChatQueryParams, type ChatQueryParamsByApi, ChatThemeProvider, ChatViewport, type ChatViewportHeight, DefaultChannelListItem, DefaultChatAvatar, DefaultChatLayout, ForwardModalView as ForwardModal, type ForwardModalSlotProps, HeaderCallActions, type HeaderCallActionsSlotProps, type HeaderLeftSideSlotProps, type HeaderRightSideSlotProps, type HeaderSearchOverlaySlotProps, type IAttachment, type IChannel, type IDMDelete, type IDMEditMessage, type IDMForward, type IDMMessage, type IDMPin, type IDMReaction, type IDMRead, type IDMStar, type IDMTyping, type IDMUnstar, type IMessage, type ISocketConfig, LoggedUserDetails, type LoggedUserDetailsSlotProps, type MembersDrawerSlotProps, type MessageAttachmentsSlotProps, ChannelMessageBoxView as MessageInput, MessageItemView as MessageItem, type MessageItemSlotProps, ActiveChannelMessagesView as MessageList, type MessageReactionsSlotProps, type MessageReplySnippetSlotProps, type MessageStatusSlotProps, type MessageToolbarSlotProps, type PermissionDrawerSlotProps, type PhoneCallButtonSlotProps, type PinnedMessagesDrawerSlotProps, type StarredMessagesDrawerSlotProps, type UIConfig, type VideoCallButtonSlotProps, capitalizeFirst, ChatMain as default, defaultChatClassNames, defaultChatComponents, defaultChatFeatures, defaultChatLayoutConfig, downloadFile, getChatBaseUrl, getChatQueryParamApis, getChatQueryParams, getChatQueryParamsByApi, getChatSocketUrl, getFirstAndLastNameOneCharacter, getResponsiveWidth, getSocketConfig, isEmpty, mergeChatCustomization, mergeChatLayoutConfig, packageDefaultComponents, resolveApiUrl, resolveChatApiKey, resolveSocketUrl, setChatAccessToken, setChatBaseURL, setChatClientId, setChatQueryParamApis, setChatQueryParams, setChatQueryParamsByApi, setChatSocketUrl, showNotification, socketService, uniqueList, useChatAlerts, useChatContext, useChatController, useChatCustomization, useChatCustomizationOptional, useChatFeatures, useChatFeaturesOptional, useChatLocale, useStore as useChatStore, useChatTheme };
+declare const buttonVariants: (props?: ({
+    variant?: "link" | "default" | "destructive" | "outline" | "secondary" | "ghost" | null | undefined;
+    size?: "xs" | "sm" | "lg" | "default" | "icon" | "icon-xs" | "icon-sm" | "icon-lg" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string;
+declare function Button({ className, variant, size, asChild, ...props }: React.ComponentProps<"button"> & VariantProps<typeof buttonVariants> & {
+    asChild?: boolean;
+}): React.JSX.Element;
+
+declare function Calendar({ className, classNames, showOutsideDays, captionLayout, buttonVariant, formatters, components, ...props }: React.ComponentProps<typeof DayPicker> & {
+    buttonVariant?: React.ComponentProps<typeof Button>["variant"];
+}): React.JSX.Element;
+declare function CalendarDayButton({ className, day, modifiers, ...props }: React.ComponentProps<typeof DayButton>): React.JSX.Element;
+
+interface PushConfig {
+    /** Firebase credentials present on the backend deployment. */
+    configured: boolean;
+    /** Super-admin ceiling AND client admin toggle, resolved. */
+    enabled: boolean;
+    firebaseConfig: Record<string, string> | null;
+    vapidKey: string | null;
+}
+interface PushPreference {
+    enabled: boolean;
+    allowedByWorkspace: boolean;
+    deviceCount: number;
+}
+declare const apiGetPushConfig: () => Promise<PushConfig>;
+declare const apiRegisterPushToken: (token: string, deviceLabel?: string) => Promise<any>;
+declare const apiRemovePushToken: (token: string) => Promise<any>;
+declare const apiGetPushPreference: () => Promise<PushPreference>;
+declare const apiUpdatePushPreference: (enabled: boolean) => Promise<any>;
+declare const isPushSupported: () => boolean;
+declare const getStoredPushToken: () => string | null;
+/**
+ * Full device opt-in: browser permission prompt → FCM token → backend
+ * registration. Returns the registered token.
+ */
+declare const enablePushOnThisDevice: () => Promise<string>;
+/** Device opt-out: invalidates the FCM token and removes it server-side. */
+declare const disablePushOnThisDevice: () => Promise<void>;
+/**
+ * Foreground messages (tab focused) — FCM does not display these itself.
+ * Returns an unsubscribe function. Typical use: show the in-app toast.
+ */
+declare const onForegroundPush: (callback: (payload: {
+    title?: string;
+    body?: string;
+    data?: Record<string, string>;
+}) => void) => Promise<() => void>;
+
+interface PushNotificationsState {
+    /** Browser supports service workers + the Push API. */
+    supported: boolean;
+    /** Super-admin ceiling AND client admin toggle allow push. */
+    allowedByWorkspace: boolean;
+    /** Firebase credentials are configured on the backend. */
+    configured: boolean;
+    /** Current browser notification permission. */
+    permission: NotificationPermission | "unsupported";
+    /** The user's account-level preference (mute switch). */
+    userEnabled: boolean;
+    /** This browser has a registered push token. */
+    deviceEnabled: boolean;
+    loading: boolean;
+    error: string | null;
+}
+interface UsePushNotifications extends PushNotificationsState {
+    /** Prompt for permission and register this device. */
+    enable: () => Promise<boolean>;
+    /** Unregister this device. */
+    disable: () => Promise<void>;
+    /** Account-level mute switch across all of the user's devices. */
+    setUserEnabled: (enabled: boolean) => Promise<void>;
+    refresh: () => Promise<void>;
+}
+/**
+ * Per-user push notification opt-in for the embedded chat.
+ *
+ * Renders no UI itself — pair with PushNotificationToggle or your own
+ * control. Requires setChatBaseURL/setChatClientId/setChatAccessToken to be
+ * configured (same as the rest of the chat).
+ */
+declare const usePushNotifications: () => UsePushNotifications;
+
+interface PushNotificationToggleProps {
+    className?: string;
+    label?: string;
+    description?: string;
+}
+/**
+ * Drop-in per-user push notification switch. Renders nothing while push is
+ * unsupported by the browser, disabled by the workspace admins, or not yet
+ * configured on the backend — users only ever see a switch they can use.
+ *
+ * On: prompts for browser permission and registers this device.
+ * Off: unregisters this device.
+ */
+declare const PushNotificationToggle: ({ className, label, description, }: PushNotificationToggleProps) => React.JSX.Element | null;
+
+export { type ActiveChannelMessagesSlotProps, type AdminsDrawerSlotProps, type AttachmentsDrawerSlotProps, type AvatarSlotProps, CHAT_API_KEYS, CHAT_GET_API_KEYS, Calendar, CalendarDayButton, Channel, type ChannelDetailsDrawerSlotProps, ChannelHeaderView as ChannelHeader, type ChannelHeaderSlotProps, ChannelListView as ChannelList, ChannelListItem, type ChannelListItemSlotProps, type ChannelListSlotProps, type ChannelMessageBoxSlotProps, Chat, type ChatActionModalSlotProps, ChatAlertsProvider, type ChatApiKey, ChatAvatar, type ChatCallContext, type ChatClassNames, type ChatColorMode, type ChatComponents, type ChatCustomizationConfig, ChatCustomizationProvider, ChatDateJumpMenu, type ChatDateTimePreferences, type ChatFeatures, type ChatGetApiKey, ChatLayout, type ChatLayoutConfig, type ChatLayoutSlotProps, ChatLocaleProvider, ChatMain, type ChatPanelAlertsSlotProps, type ChatQueryParams, type ChatQueryParamsByApi, ChatThemeProvider, ChatViewport, type ChatViewportHeight, DefaultChannelListItem, DefaultChatAvatar, DefaultChatLayout, ForwardModalView as ForwardModal, type ForwardModalSlotProps, HeaderCallActions, type HeaderCallActionsSlotProps, type HeaderLeftSideSlotProps, type HeaderRightSideSlotProps, type HeaderSearchOverlaySlotProps, type IAttachment, type IChannel, type IDMDelete, type IDMEditMessage, type IDMForward, type IDMMessage, type IDMPin, type IDMReaction, type IDMRead, type IDMStar, type IDMTyping, type IDMUnstar, type IMessage, type ISocketConfig, type JumpToPreset, LoggedUserDetails, type LoggedUserDetailsSlotProps, type MembersDrawerSlotProps, type MessageAttachmentsSlotProps, ChannelMessageBoxView as MessageInput, MessageItemView as MessageItem, type MessageItemSlotProps, ActiveChannelMessagesView as MessageList, type MessageReactionsSlotProps, type MessageReplySnippetSlotProps, type MessageStatusSlotProps, type MessageToolbarSlotProps, type PendingJump, type PermissionDrawerSlotProps, type PhoneCallButtonSlotProps, type PinnedMessagesDrawerSlotProps, type PushConfig, PushNotificationToggle, type PushNotificationToggleProps, type PushNotificationsState, type PushPreference, type StarredMessagesDrawerSlotProps, type UIConfig, type UsePushNotifications, type VideoCallButtonSlotProps, apiGetPushConfig, apiGetPushPreference, apiRegisterPushToken, apiRemovePushToken, apiUpdatePushPreference, capitalizeFirst, clampJumpDate, ChatMain as default, defaultChatClassNames, defaultChatComponents, defaultChatFeatures, defaultChatLayoutConfig, disablePushOnThisDevice, downloadFile, enablePushOnThisDevice, getChatBaseUrl, getChatQueryParamApis, getChatQueryParams, getChatQueryParamsByApi, getChatSocketUrl, getFirstAndLastNameOneCharacter, getResponsiveWidth, getSocketConfig, getStoredPushToken, isEmpty, isPushSupported, mergeChatCustomization, mergeChatLayoutConfig, onForegroundPush, packageDefaultComponents, resolveApiUrl, resolveChatApiKey, resolveJumpDateBounds, resolveJumpPreset, resolveJumpStep, resolveSocketUrl, setChatAccessToken, setChatBaseURL, setChatClientId, setChatQueryParamApis, setChatQueryParams, setChatQueryParamsByApi, setChatSocketUrl, showNotification, smoothScrollToMessage, socketService, startOfLocalDay, toDateInputValue, uniqueList, useChatAlerts, useChatContext, useChatController, useChatCustomization, useChatCustomizationOptional, useChatFeatures, useChatFeaturesOptional, useChatLocale, useStore as useChatStore, useChatTheme, usePushNotifications };