@ethora/chat-component 26.9.6 → 26.10.1

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

@@ -45,6 +45,32 @@ export interface VideoCallsConfig {
     showScreenShare?: boolean;
     /** Custom icons for the call control bar / ring screen. See VideoCallIcons. */
     icons?: VideoCallIcons;
+    /**
+     * End-to-end encrypt the call media (LiveKit insertable streams). The media
+     * key is exchanged over OMEMO - the same channel the chat uses - so the SFU
+     * and the server never see it, which makes the call private even from the
+     * operator. The trust model is OMEMO's (blind-trust-before-verification on
+     * device fingerprints).
+     *
+     * Requires the chat's own encryption to be on (`config.e2ee.enabled`) and a
+     * room the backend marked `e2ee`. A call that cannot set E2EE up - an
+     * unsupported browser, an insecure (non-HTTPS) context, or a peer with no
+     * published OMEMO device - falls back to a normal (transport-encrypted)
+     * call rather than failing.
+     */
+    e2ee?: {
+        enabled: boolean;
+        /**
+         * Supplies the Web Worker LiveKit needs for insertable-stream E2EE. The
+         * library stays bundler-agnostic, so the host app creates it, typically:
+         *   () => new Worker(
+         *     new URL('livekit-client/e2ee-worker', import.meta.url),
+         *     { type: 'module' }
+         *   )
+         * Without a factory, call E2EE stays off.
+         */
+        workerFactory?: () => Worker;
+    };
 }
 export interface FBConfig {
     apiKey: string;
@@ -155,8 +181,8 @@ export interface IConfig {
     /** Composer attachment limits. Applies to the built-in SendInput. */
     attachments?: {
         /**
-         * How many files one message may carry. Defaults to 5 and is hard-capped
-         * at 10 by the stanza payload (MAX_ATTACHMENTS_PER_MESSAGE).
+         * How many files one message may carry. Defaults to 10, which is also the
+         * hard cap set by the stanza payload (MAX_ATTACHMENTS_PER_MESSAGE).
          */
         maxFiles?: number;
         /** Per-file ceiling in MB. Omit to skip the client-side size check. */
@@ -174,6 +200,13 @@ export interface IConfig {
          * thumbnails, worth overriding if your users open large documents.
          */
         workerSrc?: string;
+        /**
+         * URL of a pdf.js ES module build to load at runtime instead of the copy
+         * bundled with the component. Pair it with `workerSrc`. For hosts that
+         * ship the component as one self-contained script and do not want 1.7 MB
+         * of pdf.js in it.
+         */
+        libUrl?: string;
         /** Documents above this are not auto-rendered. Default 25. */
         maxFileSizeMb?: number;
     };
@@ -495,9 +528,17 @@ export interface IConfig {
      */
     disableUserCount?: boolean;
     /**
-     * Hide the "Search messages" button in the chat header (and so the search
-     * panel). Search is also hidden when `appId` is not set, since the archive
-     * it queries is scoped by app.
+     * Opt in to message search: the "Search messages" button in the chat header
+     * and profile panel, the Ctrl/Cmd+F shortcut inside the chat, and message
+     * matches under the chat-list search box. Off by default. Needs `appId`
+     * (the archive it queries is scoped by app) and a backend that serves
+     * `GET /v2/apps/{appId}/messages/search`.
+     */
+    enableMessageSearch?: boolean;
+    /**
+     * @deprecated Search is off unless `enableMessageSearch` is set. Kept so
+     * hosts that already pass `disableMessageSearch: true` stay off; it wins
+     * over `enableMessageSearch`.
      */
     disableMessageSearch?: boolean;
     /**
@@ -614,6 +655,44 @@ export interface IConfig {
         hideSearch?: boolean;
     };
     useStoreConsoleEnabled?: boolean;
+    /**
+     * Route for looking up one unknown sender. `'auto'` (default) tries
+     * `GET /v1/apps/users/<xmppUsername>` and, when the backend does not accept
+     * the user token there (400/401, or a missing route), remembers that for 10
+     * minutes and uses `GET /v2/chats/users?xmppUsername=` instead, probing v1
+     * again after that. `'v1'` / `'v2'` pin one route with no fallback.
+     */
+    userLookupRoute?: 'auto' | 'v1' | 'v2';
+    /**
+     * Who may push `ethora-event` headlines (`urn:ethora:events:1`,
+     * user-profile-updated / chat-meta-updated). Default (unset or empty): any
+     * bare JID without a resource on the account's own XMPP domain, which is
+     * how the server sends them (from its admin account); room occupants,
+     * other users and other domains are never trusted. Set it to pin the exact
+     * sender(s), as full bare JIDs (`admin@xmpp.example.com`) or local parts
+     * (`admin`).
+     */
+    trustedEventSenders?: string[];
+    /**
+     * Background history preload after connect. Default `{ mode: 'staged',
+     * topRooms: 8, concurrency: 3 }`.
+     * - `'staged'`: the `topRooms` most recently active rooms are preloaded
+     *   (a one-message preview pass for rooms the API gave no `lastMessage`
+     *   for, then a full page), `concurrency` at a time; every other room
+     *   loads when the user opens it.
+     * - `'all'`: preload every room (the pre-staged behaviour; for accounts
+     *   with few rooms).
+     * - `'off'`: no background preload, rooms load when opened.
+     * A room the user opens jumps the queue; a reconnect only re-queues rooms
+     * that are not already preloaded.
+     * Falls back to the older `historyQoS.preloadTopKRooms` /
+     * `stagedPreloadConcurrency` when the matching field is not set.
+     */
+    historyPreload?: {
+        mode?: 'staged' | 'all' | 'off';
+        topRooms?: number;
+        concurrency?: number;
+    };
     historyQoS?: {
         maxInFlightHistory?: number;
         softPauseAfterSendMs?: number;
@@ -629,6 +708,20 @@ export interface IConfig {
         stagedPreloadFirstPassSize?: number;
         stagedPreloadSecondPassSize?: number;
         stagedPreloadConcurrency?: number;
+        /**
+         * Messages the MUC service replays on every room join, sent as
+         * `<history maxstanzas="N"/>`. Default 0: history comes from MAM only, so
+         * joining many rooms no longer pulls up to the server default (20) per
+         * room. Raise it only if a host relies on the join replay (a room without
+         * MAM archiving).
+         */
+        joinHistoryStanzas?: number;
+        /**
+         * Rooms joined in parallel by the background join sweep that runs after
+         * the room list is shown (active room first, then most recent activity).
+         * Default 5.
+         */
+        joinConcurrency?: number;
     };
     inAppNotifications?: {
         enabled?: boolean;

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

@@ -11,6 +11,8 @@ export interface NewMessageLabelProps {
 export interface DecoratedMessage {
     message: IMessage;
     showDateLabel: boolean;
+    /** False when the next row is the same sender's message (a run continues). */
+    isLastInGroup?: boolean;
 }
 export interface ScrollControllerApi {
     scrollToBottom: () => void;

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

@@ -55,6 +55,7 @@ export interface IMessage {
     mainMessage?: string;
     reply?: IReply[];
     reaction?: Record<string, ReactionMessage>;
+    receivedBy?: Record<string, number>;
     fileName?: string;
     translations?: TranslationObject;
     langSource?: Iso639_1Codes;
@@ -71,6 +72,8 @@ export interface IMessage {
     xmppFrom?: string;
     quickReplies?: unknown;
     mentions?: IMentionSpan[];
+    caption?: string;
+    captionMentions?: IMentionSpan[];
     callLog?: {
         callId: string;
         direction: 'outgoing' | 'incoming';
@@ -95,6 +98,12 @@ export interface MessageProps {
     message: IMessage;
     isUser: boolean;
     isReply: boolean;
+    /**
+     * False when the next message comes from the same sender (a run). The last
+     * message of a run carries the bubble tail and the larger gap below it.
+     * Omitted means last.
+     */
+    isLastInGroup?: boolean;
 }
 export interface MediaMessageType {
 }

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

@@ -4,4 +4,23 @@ export interface ModalFile {
     fileName: string;
     fileURL: string;
     mimetype: string;
+    /** Optional low-resolution copy, used for viewer thumbnails. */
+    previewURL?: string;
+    /** Optional message timestamp (ISO) shown in the viewer header. */
+    date?: string;
+    /** Optional sender shown in the viewer header. */
+    sender?: {
+        id?: string;
+        username?: string;
+        name?: string;
+        firstName?: string;
+        lastName?: string;
+        photo?: string;
+    };
+    /**
+     * Optional sibling files (e.g. a whole album) the viewer can page through
+     * when the room's loaded messages do not already contain this file.
+     * Single-file callers leave it out.
+     */
+    siblings?: ModalFile[];
 }

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

@@ -62,7 +62,18 @@ export interface IRoom {
     composingList?: string[];
     lastViewedTimestamp?: number;
     unreadBaselineTimestamp?: number;
+    lastDisplayedByUser?: Record<string, string>;
     unreadMessages?: number;
+    /**
+     * Unread count the server reported for this room in `GET /v1/chats/my`
+     * (`unreadCount`) and when it was read. Only present on backends that send
+     * it. The unread middleware uses it as a floor while the local message
+     * list is too short to count from (history not loaded yet): it lets the
+     * room list show a badge without a MAM round-trip per room. Ignored once
+     * the user has read past the API's last message, and cleared on open.
+     */
+    apiUnreadCount?: number;
+    apiUnreadSeededAt?: number;
     noMessages?: boolean;
     role?: string;
     messageStats?: {
@@ -70,6 +81,8 @@ export interface IRoom {
         firstMessageTimestamp?: number;
     };
     historyComplete?: boolean;
+    /** Persisted-cache stamp: the saved transcript includes its reactions. */
+    reactionsCached?: boolean;
     historyPreloadState?: 'idle' | 'loading' | 'partial' | 'done' | 'error';
     unreadCapped?: boolean;
     /**
@@ -99,6 +112,19 @@ export interface ApiRoomLastMessage {
     isOwn?: boolean;
     senderFirstName?: string;
     senderLastName?: string;
+    /**
+     * Media fields, present when the last message is a file. Any subset may be
+     * sent: a thin payload can carry just `mimetype` and `fileName`.
+     */
+    isMediafile?: string | boolean;
+    mimetype?: string;
+    fileName?: string;
+    originalName?: string;
+    location?: string;
+    locationPreview?: string;
+    duration?: string | number;
+    attachments?: unknown;
+    clientEncrypted?: string | boolean;
 }
 export interface ApiRoom {
     name: string;
@@ -109,6 +135,8 @@ export interface ApiRoom {
     description?: string;
     picture?: string;
     members?: RoomMember[];
+    /** True total; `members` is capped at 30 for big public rooms. */
+    usersCnt?: number;
     createdBy?: string;
     appId?: any;
     _id?: string;
@@ -118,6 +146,8 @@ export interface ApiRoom {
     __v?: string;
     /** See IRoom.muted - only present when the backend supports per-chat mute. */
     muted?: boolean;
+    /** See IRoom.apiUnreadCount - only present when the backend sends it. */
+    unreadCount?: number;
     /** See ApiRoomLastMessage - only present when the backend supports it. */
     lastMessage?: ApiRoomLastMessage;
 }

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

@@ -1,6 +1,6 @@
 import { Client } from '@xmpp/client';
 import { Iso639_1Codes } from './language.model';
-import { default as XmppClient } from '../../networking/xmppClient';
+import { default as XmppClient, HistoryWindowPage } from '../../networking/xmppClient';
 import { IMessage } from './message.model';
 export interface XmppState {
     client: XmppClient | null;
@@ -27,6 +27,20 @@ export interface xmppSettingsInterface {
         stagedPreloadFirstPassSize?: number;
         stagedPreloadSecondPassSize?: number;
         stagedPreloadConcurrency?: number;
+        /**
+         * Messages the MUC service replays on every room join, sent as
+         * `<history maxstanzas="N"/>`. Default 0: history comes from MAM only, so
+         * joining many rooms no longer pulls up to the server default (20) per
+         * room. Raise it only if a host relies on the join replay (a room without
+         * MAM archiving).
+         */
+        joinHistoryStanzas?: number;
+        /**
+         * Rooms joined in parallel by the background join sweep that runs after
+         * the room list is shown (active room first, then most recent activity).
+         * Default 5.
+         */
+        joinConcurrency?: number;
     };
 }
 export interface MediaUploadData {
@@ -65,6 +79,12 @@ export interface XmppClientInterface {
         skipIfPreloaded?: boolean;
         source?: 'active' | 'send_ack' | 'background' | 'default';
     }): Promise<IMessage[] | undefined>;
+    getHistoryWindow(chatJID: string, max: number, cursor: {
+        before?: number;
+        after?: number;
+        start?: string;
+        end?: string;
+    }): Promise<HistoryWindowPage>;
     promoteRoomHistory(roomJID: string): void;
     setActiveRoomJid(roomJID: string | null): void;
     isActiveRoomGateOpen(): boolean;
@@ -84,6 +104,9 @@ export interface XmppClientInterface {
     sendMessage(roomJID: string, firstName: string, lastName: string, photo: string, walletAddress: string, userMessage: string, notDisplayedValue?: string, isReply?: boolean, showInChannel?: boolean, mainMessage?: string, customId?: string): void;
     deleteMessageStanza(room: string, msgId: string): void;
     editMessageStanza(room: string, msgId: string, text: string): void;
+    sendReceivedReceiptStanza(messageId: string, roomJid: string): void;
+    sendDisplayedMarkerStanza(messageId: string, roomJid: string): void;
+    sendHistoryReceivedReceiptStanza(roomJid: string, messageId: string): void;
     sendTypingRequestStanza(chatId: string, fullName: string, start: boolean): void;
     getChatsPrivateStoreRequestStanza(): Promise<any>;
     actionSetTimestampToPrivateStoreStanza(chatId: string, timestamp: number, chats?: string[]): Promise<void>;

package/dist/utils/messageNotificationContent.d.ts

@@ -0,0 +1,34 @@
+import { IMessage } from '../types/models/message.model';
+import { IRoom, RoomMember } from '../types/models/room.model';
+export declare const MAX_NOTIFICATION_BODY_LENGTH = 120;
+export interface NotificationContent {
+    title: string;
+    body: string;
+    /** One per room, so a burst in the same room collapses into one entry. */
+    tag: string;
+    roomJID: string;
+    messageId: string;
+}
+export interface NotificationContentInput {
+    message: IMessage;
+    roomJID: string;
+    room?: IRoom | null;
+    usersSet?: Record<string, RoomMember>;
+    currentXmppUsername?: string;
+    activeRoomJID?: string | null;
+    tabVisible: boolean;
+    locale?: string | null;
+    strings?: Record<string, string> | null;
+    /** Names the caller already has (toast args); never trusted blindly. */
+    senderNameHint?: string;
+    roomNameHint?: string;
+}
+export declare const resolveNotificationSenderName: (message: IMessage, usersSet?: Record<string, RoomMember>, room?: IRoom | null, hint?: string) => string;
+export declare const resolveNotificationRoomName: (roomJID: string, room?: IRoom | null, hint?: string) => string;
+export declare const getNotificationTag: (roomJID: string) => string;
+/**
+ * Returns what to show, or null when this message must not raise an alert:
+ * own messages, system/receipt/typing stanzas (nothing to say), muted rooms,
+ * and the open room while the tab is visible.
+ */
+export declare const buildNotificationContent: (input: NotificationContentInput) => NotificationContent | null;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const ETHORA_CHAT_COMPONENT_VERSION = "26.9.6";
+export declare const ETHORA_CHAT_COMPONENT_VERSION = "26.10.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethora/chat-component",
-  "version": "26.9.6",
+  "version": "26.10.1",
   "type": "module",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
@@ -97,6 +97,7 @@
     "eslint-plugin-prettier": "^5.5.0",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.20",
+    "globals": "^11.12.0",
     "jsdom": "^24.1.0",
     "prettier": "3.6.0",
     "react": "^18.3.1",

package/public/firebase-messaging-sw.js

@@ -151,8 +151,25 @@ async function checkAssetAvailability(url) {
   }
 }
 
+// `<appId>_<userId>` (24-hex ids, or an appId and a uuid) is a machine id,
+// never something to put in a notification title.
+const OPAQUE_ID_RE =
+  /^(?:[0-9a-f]{24}(?:_[0-9a-f]{24})?|[a-z0-9]+_(?:[0-9a-f]{24}|[0-9a-f-]{36})(?:_[0-9a-z-]+)*)$/i;
+
+function isOpaqueId(value) {
+  const text = String(value || '').trim();
+  return !!text && OPAQUE_ID_RE.test(text.split('@')[0]);
+}
+
 function pickTitle(raw = {}, data = {}, notification = {}) {
-  return notification.title || raw.title || data.title || 'New Message';
+  const title = notification.title || raw.title || data.title || '';
+  return title && !isOpaqueId(title) ? title : 'New Message';
+}
+
+// One notification per chat: a newer message in the same room replaces it.
+function roomTag(data = {}) {
+  const jid = String(data.jid || '').split('@')[0];
+  return jid ? `ethora-room-${jid}` : '';
 }
 
 function pickBody(raw = {}, data = {}, notification = {}) {
@@ -449,8 +466,8 @@ async function handlePush(raw = {}, source = 'push') {
     icon,
     badge,
     image,
-    tag: isCall ? `call:${callId || dedupKey}` : dedupKey,
-    renotify: isCall,
+    tag: isCall ? `call:${callId || dedupKey}` : roomTag(data) || dedupKey,
+    renotify: isCall || !!roomTag(data),
     requireInteraction: isCall,
     // Spread the ORIGINAL payload first so the click handler's isCallPush()
     // sees the full call fields (callId/callToken/kind/room); our routing