@ethora/chat-component 25.12.2 → 26.1.2

package/dist/networking/api-requests/push.api.d.ts

@@ -0,0 +1,18 @@
+/**
+ * push.api.ts
+ * API methods for registering / unregistering a push notification subscription
+ * with the Ethora backend so the server can target this browser for push events.
+ */
+/**
+ * Register a push notification/FCM registration token with the backend.
+ * Sends a POST to /push/subscription/{userId} with the registration token.
+ *
+ * @param registrationToken – The FCM token obtained via Firebase Messaging.
+ */
+export declare function registerPushToken(registrationToken: string): Promise<any>;
+/**
+ * Unregister a push endpoint from the backend (e.g. on logout).
+ *
+ * @param registrationToken – The token to unregister.
+ */
+export declare function unregisterPushToken(registrationToken: string): Promise<any>;

package/dist/networking/stanzaHandlers.d.ts

@@ -1,7 +1,7 @@
 import { Element } from 'ltx';
 import { IMessage } from '../types/types';
 import { default as XmppClient } from './xmppClient';
-declare const onRealtimeMessage: (stanza: Element) => Promise<IMessage>;
+declare const onRealtimeMessage: (stanza: Element, xmppClient?: XmppClient) => Promise<IMessage>;
 declare const onReactionMessage: (stanza: Element) => Promise<void>;
 declare const onDeleteMessage: (stanza: Element) => Promise<void>;
 declare const onEditMessage: (stanza: Element) => Promise<void>;
@@ -27,4 +27,6 @@ export type XMPPErrorInfo = {
     message: string;
 };
 export declare const handleErrorMessageStanza: (stanza: Element) => XMPPErrorInfo | null;
-export { onRealtimeMessage, onMessageHistory, onPresenceInRoom, onReactionHistory, onGetLastMessageArchive, handleComposing, onGetChatRooms, onNewRoomCreated, onGetMembers, onGetRoomInfo, onDeleteMessage, onEditMessage, onReactionMessage, onChatInvite, onRoomKicked, onMessageError, };
+declare const onUserUpdate: (stanza: Element) => Promise<void>;
+declare const onChatUpdate: (stanza: Element) => Promise<void>;
+export { onRealtimeMessage, onMessageHistory, onPresenceInRoom, onReactionHistory, onGetLastMessageArchive, handleComposing, onGetChatRooms, onNewRoomCreated, onGetMembers, onGetRoomInfo, onDeleteMessage, onEditMessage, onReactionMessage, onChatInvite, onRoomKicked, onMessageError, onUserUpdate, onChatUpdate, };

package/dist/networking/xmpp/allRoomPresences.xmpp.d.ts

@@ -1,2 +1,12 @@
 import { Client } from '@xmpp/client';
-export declare function allRoomPresences(client: Client): Promise<void>;
+export interface AllRoomPresenceSummary {
+    total: number;
+    success: number;
+    failed: number;
+    failedRooms: string[];
+    failures?: Array<{
+        roomJid: string;
+        reason: string;
+    }>;
+}
+export declare function allRoomPresences(client: Client): Promise<AllRoomPresenceSummary>;

package/dist/networking/xmpp/presenceInRoom.xmpp.d.ts

@@ -1,3 +1,3 @@
 import { Client } from '@xmpp/client';
 import { Element } from '@xmpp/xml';
-export declare const presenceInRoom: (client: Client, roomJID: string, delay?: number) => Promise<Element>;
+export declare const presenceInRoom: (client: Client, roomJID: string, delay?: number, timeoutMs?: number) => Promise<Element>;

package/dist/networking/xmpp/sendTextMessage.xmpp.d.ts

@@ -1,2 +1,2 @@
 import { Client } from '@xmpp/client';
-export declare const sendTextMessage: (client: Client, roomJID: string, firstName: string, lastName: string, photo: string, walletAddress: string, userMessage: string, notDisplayedValue?: string, isReply?: boolean, showInChannel?: boolean, mainMessage?: string, devServer?: string, customId?: string) => void;
+export declare const sendTextMessage: (client: Client, roomJID: string, firstName: string, lastName: string, photo: string, walletAddress: string, userMessage: string, notDisplayedValue?: string, isReply?: boolean, showInChannel?: boolean, mainMessage?: string, devServer?: string, customId?: string) => boolean;

package/dist/networking/xmpp/sendTextMessageWithTranslateTag.xmpp.d.ts

@@ -12,4 +12,4 @@ export declare const sendTextMessageWithTranslateTag: (client: Client, stanzaMes
     showInChannel?: boolean;
     mainMessage?: string;
     devServer?: string;
-}, source: Iso639_1Codes, customId?: string) => void;
+}, source: Iso639_1Codes, customId?: string) => boolean;

package/dist/networking/xmpp/subscribeToRoomMessages.xmpp.d.ts

@@ -0,0 +1,9 @@
+import { Client } from '@xmpp/client';
+export type SubscribeResult = {
+    ok: true;
+} | {
+    ok: false;
+    reason?: 'forbidden' | 'error' | 'timeout';
+    message?: string;
+};
+export declare function subscribeToRoomMessages(client: Client, roomJID: string, userNick?: string): Promise<SubscribeResult>;

package/dist/networking/xmppClient.d.ts

@@ -1,5 +1,6 @@
 import { Client } from '@xmpp/client';
 import { Iso639_1Codes, XmppClientInterface, xmppSettingsInterface, IMessage } from '../types/types';
+import { AllRoomPresenceSummary } from './xmpp/allRoomPresences.xmpp';
 export declare class XmppClient implements XmppClientInterface {
     client: Client;
     devServer: string | undefined;
@@ -18,8 +19,14 @@ export declare class XmppClient implements XmppClientInterface {
     presencesReady: boolean;
     private connectionSteps;
     private messageQueue;
+    private pendingSendById;
     private inFlightIds;
     private processingQueue;
+    private currentlyProcessingQueueId;
+    private isRecoveringRoomPresence;
+    private recoveryRoomJid;
+    private joinedRooms;
+    private roomPresenceInFlight;
     checkOnline(): boolean;
     pingInterval: any;
     pingTimeout: any;
@@ -45,7 +52,7 @@ export declare class XmppClient implements XmppClientInterface {
     private markActivity;
     sendAllPresencesAndMarkReady(): Promise<void>;
     reconnect(): Promise<void>;
-    allRoomPresencesStanza(): Promise<void>;
+    allRoomPresencesStanza(): Promise<AllRoomPresenceSummary>;
     ensureConnected(timeout?: number): Promise<void>;
     close(): Promise<void>;
     wrapWithConnectionCheck<T>(operation: () => Promise<T>): Promise<T>;
@@ -64,14 +71,16 @@ export declare class XmppClient implements XmppClientInterface {
     createRoomStanza(title: string, description: string): Promise<string>;
     inviteRoomRequestStanza(to: string, roomJid: string): Promise<void>;
     leaveTheRoomStanza: (roomJID: string) => void;
-    presenceInRoomStanza: (roomJID: string, settleDelay?: number) => Promise<void>;
+    private ensureRoomPresence;
+    presenceInRoomStanza: (roomJID: string, settleDelay?: number, timeoutMs?: number, waitForJoin?: boolean) => Promise<boolean>;
+    prioritizeRoomPresence: (roomJID: string) => Promise<boolean>;
     getHistoryStanza: (chatJID: string, max: number, before?: number, otherStanzaId?: string) => Promise<IMessage[]>;
     getLastMessageArchiveStanza(roomJID: string): void;
     setRoomImageStanza: (roomJid: string, roomThumbnail: string, type: string, roomBackground?: string) => void;
     getRoomInfoStanza: (roomJID: string) => void;
     getRoomMembersStanza: (roomJID: string) => void;
     setVCardStanza(xmppUsername: string): void;
-    sendMessageWithPingCheck(sendFn: () => Promise<void>): Promise<boolean>;
+    sendMessageWithPingCheck(sendFn: () => Promise<boolean>): Promise<boolean>;
     sendMessage: (roomJID: string, firstName: string, lastName: string, photo: string, walletAddress: string, userMessage: string, notDisplayedValue?: string, isReply?: boolean, showInChannel?: boolean, mainMessage?: string, customId?: string) => Promise<boolean>;
     sendTextMessageWithTranslateTagStanza: (roomJID: string, firstName: string, lastName: string, photo: string, walletAddress: string, userMessage: string, notDisplayedValue?: string, isReply?: boolean, showInChannel?: boolean, mainMessage?: string, langSource?: Iso639_1Codes, customId?: string) => Promise<boolean>;
     deleteMessageStanza(room: string, msgId: string): void;
@@ -82,6 +91,7 @@ export declare class XmppClient implements XmppClientInterface {
     actionSetTimestampToPrivateStoreStanza(chatId: string, timestamp: number, chats?: string[]): Promise<void>;
     createPrivateRoomStanza(title: string, description: string, to: string): Promise<string>;
     sendMediaMessageStanza(roomJID: string, data: any, id: string): void;
+    recoverRoomPresenceOnly(roomJID: string): Promise<boolean>;
     sendPingStanza(): void;
     handlePong(): void;
     handlePingTimeout(): void;

package/dist/roomStore/chatSettingsSlice.d.ts

@@ -3,6 +3,7 @@ import { DeleteModal, IConfig, Iso639_1Codes, IUser, ModalFile, ModalType, User
 interface ChatState {
     user: User;
     config?: IConfig;
+    appId?: string;
     activeModal?: ModalType;
     deleteModal?: DeleteModal;
     selectedUser?: IUser;

package/dist/roomStore/index.d.ts

@@ -0,0 +1,28 @@
+import { Reducer, AnyAction } from '@reduxjs/toolkit';
+import { roomHeapSliceState } from './roomHeapSlice';
+import { IRoom } from '../types/types';
+declare const rootReducer: Reducer<{
+    chatSettingStore: any;
+    rooms: any;
+    roomHeapSlice: roomHeapSliceState & import('redux-persist/es/persistReducer').PersistPartial;
+}, import('redux').UnknownAction, Partial<{
+    chatSettingStore: any;
+    rooms: any;
+    roomHeapSlice: roomHeapSliceState & import('redux-persist/es/persistReducer').PersistPartial;
+}>>;
+export type RootState = ReturnType<typeof rootReducer>;
+export declare const getActiveRoom: (state: RootState) => IRoom | null;
+export declare const store: import('@reduxjs/toolkit').EnhancedStore<{
+    chatSettingStore: any;
+    rooms: any;
+    roomHeapSlice: roomHeapSliceState & import('redux-persist/es/persistReducer').PersistPartial;
+}, AnyAction, import('@reduxjs/toolkit').Tuple<[import('redux').StoreEnhancer<{
+    dispatch: import('redux-thunk').ThunkDispatch<{
+        chatSettingStore: any;
+        rooms: any;
+        roomHeapSlice: roomHeapSliceState & import('redux-persist/es/persistReducer').PersistPartial;
+    }, undefined, import('redux').UnknownAction>;
+}>, import('redux').StoreEnhancer]>>;
+export type AppDispatch = typeof store.dispatch;
+export declare const persistor: import('redux-persist').Persistor;
+export {};

package/dist/roomStore/roomHeapSlice.d.ts

@@ -1,6 +1,6 @@
 import { PayloadAction } from '@reduxjs/toolkit';
 import { IMessage } from '../types/types';
-interface roomHeapSliceState {
+export interface roomHeapSliceState {
     messageHeap: IMessage[];
 }
 export declare const roomHeapSlice: import('@reduxjs/toolkit').Slice<roomHeapSliceState, {

package/dist/roomStore/roomsSlice.d.ts

@@ -12,6 +12,8 @@ interface RoomMessagesState {
     reportRoom: {
         isOpen: boolean;
     };
+    subscribedRooms: string[];
+    pushSubscriptionStatus: Record<string, 'pending' | 'subscribed' | 'error' | 'blocked'>;
     loadingText?: string;
 }
 export declare const addRoomViaApi: import('@reduxjs/toolkit').AsyncThunk<void, {
@@ -100,6 +102,11 @@ export declare const roomsStore: import('@reduxjs/toolkit').Slice<RoomMessagesSt
     setOpenReportModal: (state: import('immer').WritableDraft<RoomMessagesState>, action: PayloadAction<{
         isOpen: boolean;
     }>) => void;
+    setPushSubscriptionStatus: (state: import('immer').WritableDraft<RoomMessagesState>, action: PayloadAction<{
+        jid: string;
+        status: "pending" | "subscribed" | "error" | "blocked";
+    }>) => void;
+    clearPushSubscriptions: (state: import('immer').WritableDraft<RoomMessagesState>) => void;
 }, "roomMessages", "roomMessages", import('@reduxjs/toolkit').SliceSelectors<RoomMessagesState>>;
 export declare const getLastMessageTimestamp: (state: RoomMessagesState, jid: string) => string | null;
 export declare const addRoom: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<{
@@ -149,6 +156,9 @@ export declare const addRoom: import('@reduxjs/toolkit').ActionCreatorWithOption
     isOpen: boolean;
 }, "roomMessages/setOpenReportModal">, insertUsers: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<{
     newUsers: RoomMember[];
-}, "roomMessages/insertUsers">;
+}, "roomMessages/insertUsers">, setPushSubscriptionStatus: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<{
+    jid: string;
+    status: "pending" | "subscribed" | "error" | "blocked";
+}, "roomMessages/setPushSubscriptionStatus">, clearPushSubscriptions: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<"roomMessages/clearPushSubscriptions">;
 declare const _default: import('redux').Reducer<RoomMessagesState>;
 export default _default;

package/dist/types/models/config.model.d.ts

@@ -1,9 +1,10 @@
 import { User } from './user.model';
 import { xmppSettingsInterface } from './xmpp.model';
 import { PartialRoomWithMandatoryKeys, ConfigRoom } from './room.model';
-import { MessageBubble, MessageProps } from './message.model';
+import { MessageBubble, MessageProps, IMessage } from './message.model';
 import { Iso639_1Codes } from './language.model';
 import { default as React } from 'react';
+import { MessageNotificationToastProps } from '../../components/MessageNotification/MessageNotificationToast';
 export interface FBConfig {
     apiKey: string;
     authDomain: string;
@@ -13,6 +14,7 @@ export interface FBConfig {
     appId: string;
 }
 export interface IConfig {
+    appId?: string;
     disableHeader?: boolean;
     disableMedia?: boolean;
     colors?: {
@@ -158,4 +160,36 @@ export interface IConfig {
         hideSearch?: boolean;
     };
     useStoreConsoleEnabled?: boolean;
+    inAppNotifications?: {
+        enabled?: boolean;
+        showInContext?: boolean;
+        position?: {
+            horizontal?: 'left' | 'right' | 'center';
+            vertical?: 'top' | 'bottom';
+            offset?: {
+                top?: number | string;
+                bottom?: number | string;
+                left?: number | string;
+                right?: number | string;
+            };
+        };
+        maxNotifications?: number;
+        duration?: number;
+        onClick?: (params: {
+            roomJID: string;
+            messageId: string;
+            message: IMessage;
+            roomName: string;
+            senderName: string;
+        }) => void | Promise<void>;
+        customComponent?: React.ComponentType<MessageNotificationToastProps>;
+    };
+    pushNotifications?: {
+        enabled?: boolean;
+        vapidPublicKey?: string;
+        firebaseConfig?: FBConfig;
+        serviceWorkerPath?: string;
+        serviceWorkerScope?: string;
+        softAsk?: boolean;
+    };
 }

package/dist/types/models/room.model.d.ts

@@ -1,9 +1,12 @@
 import { IMessage, LastMessage } from './message.model';
 export interface RoomMember {
+    _id: string;
     firstName: string;
     lastName: string;
     xmppUsername: string;
-    _id: string;
+    profileImage?: string;
+    description?: string;
+    email?: string;
     ban_status?: string;
     jid?: string;
     name?: string;

package/dist/types/models/xmpp.model.d.ts

@@ -40,7 +40,9 @@ export interface XmppClientInterface {
     createRoomStanza(title: string, description: string, to?: string): Promise<string | object>;
     inviteRoomRequestStanza(to: string, roomJid: string): Promise<void>;
     leaveTheRoomStanza(roomJID: string): void;
-    presenceInRoomStanza(roomJID: string): void;
+    presenceInRoomStanza(roomJID: string, settleDelay?: number, timeoutMs?: number, waitForJoin?: boolean): Promise<boolean>;
+    prioritizeRoomPresence(roomJID: string): Promise<boolean>;
+    recoverRoomPresenceOnly(roomJID: string): Promise<boolean>;
     getHistoryStanza(chatJID: string, max: number, before?: number, otherStanzaId?: string): Promise<IMessage[]>;
     getLastMessageArchiveStanza(roomJID: string): void;
     setRoomImageStanza(roomJid: string, roomThumbnail: string, type: string, roomBackground?: string): void;

package/dist/utils/firebasePushNotifications.d.ts

@@ -0,0 +1,34 @@
+import { MessagePayload } from 'firebase/messaging';
+/**
+ * requestNotificationPermission()
+ * Requests permission from the user to display notifications.
+ * @returns boolean indicating if permission was granted.
+ */
+export declare function requestNotificationPermission(): Promise<boolean>;
+interface FcmRegistrationOptions {
+    vapidPublicKey?: string;
+    serviceWorkerPath?: string;
+    serviceWorkerScope?: string;
+    firebaseConfig?: any;
+    debug?: boolean;
+}
+/**
+ * getFCMToken()
+ * Obtains the FCM registration token for the current device/browser.
+ * @param options - VAPID key and service worker settings.
+ * @returns The FCM token or null if failed.
+ */
+export declare function getFCMToken(options?: FcmRegistrationOptions): Promise<string | null>;
+/**
+ * initPushNotifications()
+ * Orchestrates the full push initialization flow.
+ * @returns The FCM token if successful, or null.
+ */
+export declare function initPushNotifications(options?: FcmRegistrationOptions): Promise<string | null>;
+/**
+ * listenForForegroundMessages()
+ * Subscribes to FCM messages while the app is in the foreground.
+ * Returns an unsubscribe function.
+ */
+export declare function listenForForegroundMessages(handler: (payload: MessagePayload) => void, firebaseConfig?: any): () => void;
+export {};

package/dist/utils/formatError.d.ts

@@ -0,0 +1 @@
+export declare const formatError: (error: unknown, fallback?: string) => string;

package/dist/utils/messageNotificationManager.d.ts

@@ -0,0 +1,16 @@
+import { IMessage } from '../types/models/message.model';
+export interface MessageNotificationCallback {
+    (message: IMessage, roomName: string, senderName: string, roomJID: string): void;
+}
+declare class MessageNotificationManager {
+    private callbacks;
+    private pending;
+    private maxPending;
+    private pendingTtlMs;
+    addCallback(callback: MessageNotificationCallback): () => void;
+    getCallbackCount(): number;
+    private flushPending;
+    showNotification(message: IMessage, roomName: string, senderName: string, roomJID: string): void;
+}
+export declare const messageNotificationManager: MessageNotificationManager;
+export {};

package/dist/utils/notificationPolicy.d.ts

@@ -0,0 +1,45 @@
+import { IConfig, IRoom } from '../types/types';
+export interface PushPayloadLike {
+    messageId?: string;
+    notification?: {
+        title?: string;
+        body?: string;
+        image?: string;
+    };
+    data?: Record<string, any>;
+}
+export declare const isSystemPayload: (payload: PushPayloadLike) => boolean;
+export declare const isActiveRoom: (activeRoomJid?: string, roomJid?: string) => boolean;
+export declare const isCurrentUserMessage: (messageUserId?: string, currentXmppUsername?: string) => boolean;
+export declare const buildNotificationUrl: (payload: PushPayloadLike, origin: string) => string;
+export interface XmppToastDecisionInput {
+    config?: IConfig;
+    tabVisible: boolean;
+    activeRoom: boolean;
+    currentUserMessage: boolean;
+    isSystem: boolean;
+    isHistory?: boolean;
+    isCatchup?: boolean;
+    xmppOnline?: boolean;
+}
+export interface DecisionResult {
+    show: boolean;
+    reason: string;
+}
+export declare const shouldShowXmppToast: ({ config, tabVisible, activeRoom, currentUserMessage, isSystem, isHistory, isCatchup, }: XmppToastDecisionInput) => DecisionResult;
+export interface ForegroundPushToastInput {
+    config?: IConfig;
+    tabVisible: boolean;
+    alreadyInStore: boolean;
+    deduped: boolean;
+    isSystem: boolean;
+    isHistory?: boolean;
+    isCatchup?: boolean;
+}
+export declare const shouldShowForegroundPushToast: ({ config, tabVisible, alreadyInStore, deduped, isSystem, isHistory, isCatchup, }: ForegroundPushToastInput) => DecisionResult;
+export interface ForegroundOsPushInput {
+    config?: IConfig;
+    tabVisible: boolean;
+}
+export declare const shouldShowForegroundOsPush: ({ config, tabVisible, }: ForegroundOsPushInput) => DecisionResult;
+export declare const hasMessageInRooms: (roomsMap: Record<string, IRoom>, messageId?: string) => boolean;

package/dist/utils/notificationUtils.d.ts

@@ -0,0 +1,22 @@
+import { PushPayloadLike } from './notificationPolicy';
+/**
+ * showBrowserNotification()
+ * Triggers a native browser notification.
+ * @param title - The notification title.
+ * @param options - Standard NotificationOptions plus Ethora-specific data.
+ * @param serviceWorkerScope - Optional SW scope for better integration.
+ */
+export declare function showBrowserNotification(title: string, options: NotificationOptions & {
+    data?: any;
+}, serviceWorkerScope?: string, onClick?: (event: Event) => void): Promise<void>;
+/**
+ * Helper to extract common data from a message/payload for browser notifications.
+ */
+export declare function getBrowserNotificationData(payload: PushPayloadLike, origin: string): {
+    title: any;
+    body: any;
+    url: string;
+    icon: string;
+    badge: string;
+    tag: string;
+};

package/dist/utils/pushSubscriptionService.d.ts

@@ -0,0 +1,12 @@
+import { default as XmppClient } from '../networking/xmppClient';
+import { SubscribeResult } from '../networking/xmpp/subscribeToRoomMessages.xmpp';
+declare class PushSubscriptionService {
+    private failedRooms;
+    private retryCooldownMs;
+    private inFlightRooms;
+    private inFlightBatch;
+    private resolveClient;
+    subscribeToRoom(roomJID: string, client?: XmppClient | null): Promise<SubscribeResult>;
+}
+export declare const pushSubscriptionService: PushSubscriptionService;
+export {};

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const ETHORA_CHAT_COMPONENT_VERSION = "25.12.2";
+export declare const ETHORA_CHAT_COMPONENT_VERSION = "26.01.01";

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "@ethora/chat-component",
-  "version": "25.12.2",
+  "version": "26.01.02",
   "type": "module",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "public/firebase-messaging-sw.js",
+    "scripts/init-push.js"
   ],
+  "bin": {
+    "ethora-chat": "./scripts/init-push.js"
+  },
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
@@ -19,8 +24,6 @@
     "@emoji-mart/data": "^1.2.1",
     "@emoji-mart/react": "^1.1.1",
     "@reduxjs/toolkit": "^2.8.2",
-    "@types/react": "^19.1.8",
-    "@types/react-dom": "^19.1.6",
     "@types/styled-components": "^5.1.34",
     "@xmpp/client": "^0.13.6",
     "axios": "^1.10.0",