@ethora/chat-component-rn 26.9.1 → 26.10.0

package/src/roomStore/safeKey.ts

@@ -0,0 +1,49 @@
+/**
+ * Keys that must never be used as a dynamic property name on a plain object:
+ * assigning through them can reach Object.prototype (prototype pollution).
+ * JIDs, user ids and locale tags never legitimately take these values.
+ */
+const UNSAFE_KEYS = new Set(['__proto__', 'constructor', 'prototype']);
+
+/** True when `key` is a non-empty string that is safe to use as an object key. */
+export const isSafeKey = (key: unknown): key is string =>
+  typeof key === 'string' && key.length > 0 && !UNSAFE_KEYS.has(key);
+
+/** Names that exist on every plain object (or are prototype-chain machinery). */
+const RESERVED_NAMES = new Set([
+  '__proto__',
+  'constructor',
+  'prototype',
+  'hasOwnProperty',
+  'isPrototypeOf',
+  'propertyIsEnumerable',
+  'toString',
+  'toLocaleString',
+  'valueOf',
+  '__defineGetter__',
+  '__defineSetter__',
+  '__lookupGetter__',
+  '__lookupSetter__',
+]);
+
+/** True when `name` is a property name every object already has. */
+export const isReservedName = (name: string): boolean => RESERVED_NAMES.has(name);
+
+/**
+ * True for an `<appId>_<rest>` id that is safe to send and to store: the whole
+ * id and every underscore-separated segment after the first must not be a
+ * reserved object name, and no segment may start with `__` (which also
+ * rejects `<appId>___proto__`, where the split yields an empty segment and a
+ * `__`-prefixed one).
+ */
+export const hasSafeIdSegments = (id: string): boolean => {
+  if (isReservedName(id) || id.includes('__')) return false;
+  const parts = id.split('_');
+  for (let i = 1; i < parts.length; i++) {
+    if (isReservedName(parts[i])) return false;
+  }
+  // Also catch a reserved name glued to the app prefix, e.g. `<appId>_prototype`
+  // is handled above; the remainder as a whole too, for names containing `_`.
+  const rest = id.slice(id.indexOf('_') + 1);
+  return !isReservedName(rest);
+};

package/src/roomStore/usersSetCap.ts

@@ -0,0 +1,37 @@
+import type { RoomMember } from '../types/types';
+import { isSafeKey } from './safeKey';
+
+/**
+ * usersSet is persisted, and lazily resolved senders keep adding to it, so
+ * it needs a ceiling. Object key order is insertion order, so "least
+ * recently inserted" is simply the first keys.
+ */
+export const USERS_SET_CAP = 5000;
+
+/** Drops the oldest-inserted entries until at most `cap` remain. */
+export const capUsersSet = (
+  usersSet: Record<string, RoomMember>,
+  cap: number = USERS_SET_CAP
+): void => {
+  const keys = Object.keys(usersSet);
+  const excess = keys.length - cap;
+  for (let i = 0; i < excess; i++) delete usersSet[keys[i]];
+};
+
+/**
+ * Merges the members of a fresh /chats/my payload into usersSet: fresh
+ * entries win, entries fetched lazily earlier stay. A refreshed key moves to
+ * the newest position so the cap evicts genuinely stale ones first.
+ */
+export const mergeUsersSet = (
+  usersSet: Record<string, RoomMember>,
+  fresh: Record<string, RoomMember>,
+  cap: number = USERS_SET_CAP
+): void => {
+  for (const [key, member] of Object.entries(fresh)) {
+    if (!isSafeKey(key)) continue;
+    if (key in usersSet) delete usersSet[key];
+    usersSet[key] = member;
+  }
+  capUsersSet(usersSet, cap);
+};

package/src/types/models/media.model.ts

@@ -5,4 +5,8 @@ export type MediaFile = {
   // Byte size when the picker can report it (images/videos/documents).
   // Used to enforce the client-side upload cap before hitting the server.
   size?: number;
+  // Voice messages: length in seconds and the recorded waveform
+  // (helpers/audioWaveform `encodeWaveForm`), sent along with the file.
+  duration?: number;
+  waveForm?: string;
 };

package/src/types/models/room.model.ts

@@ -53,6 +53,15 @@ export interface IRoom {
   composingList?: string[];
   lastViewedTimestamp?: number;
   unreadMessages?: number;
+  /**
+   * Unread count the server reported for this room in `GET /v1/chats/my`
+   * (`unreadCount`) and when it was read (epoch ms). Only present on backends
+   * that send it. Used as a floor while the local message list is too short
+   * to count from; ignored once the user has read past the API's last
+   * message, cleared when the room is opened, never persisted.
+   */
+  apiUnreadCount?: number;
+  apiUnreadSeededAt?: number;
   noMessages?: boolean;
   role?: string;
 
@@ -63,8 +72,10 @@ export interface IRoom {
   historyComplete?: boolean;
 }
 
-/** The flattened last-message doc `GET /v1/chats/my` embeds per room.
- * Only present when the backend supports it; every field is optional. */
+/**
+ * The flattened `lastMessage` object `GET /v1/chats/my` embeds per room.
+ * Every field is optional: backends differ in what they send.
+ */
 export interface ApiRoomLastMessage {
   body?: string;
   truncated?: boolean;
@@ -81,6 +92,11 @@ export interface ApiRoomLastMessage {
 export interface ApiRoom {
   name: string;
   type: 'public' | 'group' | 'private';
+  /** True total; `members` is capped at 30 for big public rooms. */
+  usersCnt?: number;
+  /** Unread messages for the caller, on backends that report it. */
+  unreadCount?: number;
+  lastMessage?: ApiRoomLastMessage;
 
   e2ee?: boolean;
   title?: string;
@@ -97,11 +113,8 @@ export interface ApiRoom {
   __v?: string;
   jid?: string;
   participants?: number;
-  usersCnt?: number;
   icon?: string;
   muted?: boolean;
-  /** See ApiRoomLastMessage. */
-  lastMessage?: ApiRoomLastMessage;
 }
 
 export interface PostRoom {

package/src/types/models/xmpp.model.ts

@@ -5,7 +5,11 @@
 // methods) rather than duplicating here.
 
 import { Client } from '@xmpp/client';
-import XmppClient from '../../networking/xmppClient';
+import XmppClient, {
+  HistoryPage,
+  HistoryPageCursor,
+  HistoryWindowPage,
+} from '../../networking/xmppClient';
 import { Iso639_1Codes } from './language.model';
 import { IMessage } from './message.model';
 
@@ -91,6 +95,16 @@ export interface XmppClientInterface {
     otherStanzaId?: string,
     options?: HistoryFetchOptions
   ): Promise<IMessage[]>;
+  getHistoryPage?(
+    chatJID: string,
+    max: number,
+    cursor?: HistoryPageCursor
+  ): Promise<HistoryPage>;
+  getHistoryWindow?(
+    chatJID: string,
+    max: number,
+    cursor: { before?: number; after?: number; start?: string; end?: string }
+  ): Promise<HistoryWindowPage>;
   getLastMessageArchiveStanza(roomJID: string): void;
   setRoomImageStanza(
     roomJid: string,

package/src/types/types.ts

@@ -1,8 +1,7 @@
 import type { ViewStyle, ImageSourcePropType, TextStyle } from 'react-native';
-import type { LastMessage } from './models/message.model';
 import type { ChatThemeOverrides } from '../theme/theme';
 import type { Iso639_1Codes } from './models/language.model';
-import type { IMessage, IReply } from './models/message.model';
+import type { IMessage, IReply, LastMessage } from './models/message.model';
 import type { RoomMember } from './models/room.model';
 import { MODAL_TYPES } from '../helpers/constants/MODAL_TYPES';
 
@@ -16,7 +15,12 @@ export interface IUser extends Partial<User> {
 
 // IMessage and IReply are re-exported from the canonical model below (see end of file).
 
-export type HistoryPreloadState = 'idle' | 'loading' | 'done' | 'error';
+export type HistoryPreloadState =
+  | 'idle'
+  | 'loading'
+  | 'partial'
+  | 'done'
+  | 'error';
 
 export interface IRoom {
   id: string;
@@ -28,8 +32,11 @@ export interface IRoom {
   isLoading: boolean;
   roomBg: string | null;
 
-  /** Seed for the room-list preview/order while no history is loaded —
-   * mapped from the API's `lastMessage` doc (see createRoomFromApi). */
+  /**
+   * Seeded from the API's `lastMessage` (see createRoomFromApi) and kept
+   * current by reactionsMiddleware; a preview for a room that has no loaded
+   * messages yet.
+   */
   lastMessage?: LastMessage;
   lastRoomMessage?: RoomLastMessage;
   icon?: string | null;
@@ -37,6 +44,16 @@ export interface IRoom {
   composingList?: string[];
   lastViewedTimestamp?: number;
   unreadMessages?: number;
+  /**
+   * Unread count the server reported for this room in `GET /v1/chats/my`
+   * (`unreadCount`) and when it was read (epoch ms). 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), ignores
+   * it once the user has read past the API's last message, and it is cleared
+   * when the room is opened. Never persisted: the next /chats/my re-seeds it.
+   */
+  apiUnreadCount?: number;
+  apiUnreadSeededAt?: number;
   noMessages?: boolean;
   muted?: boolean;
   role?: string;
@@ -148,6 +165,20 @@ export interface HistoryQoSConfig {
   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 xmppSettingsInterface {
@@ -550,6 +581,43 @@ export interface IConfig {
   xmppSettings?: xmppSettingsInterface;
   disableLastRead?: boolean;
   historyQoS?: HistoryQoSConfig;
+  /**
+   * Background history preload for the room list.
+   * - `'staged'` (default): 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 (for accounts with few rooms).
+   * - `'off'`: no background preload, rooms load when opened.
+   * A room the user opens jumps the queue. Falls back to the older
+   * `historyQoS.preloadTopKRooms` / `stagedPreloadConcurrency` when the
+   * matching field is not set; the new object wins when set.
+   */
+  historyPreload?: {
+    mode?: 'staged' | 'all' | 'off';
+    /** Rooms (by recent activity) the background sweep covers. Default 8. */
+    topRooms?: number;
+    /** Rooms loaded in parallel by the sweep. Default 3. */
+    concurrency?: number;
+  };
+  /**
+   * 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[];
 
   // ----- room list -----
   disableRooms?: boolean;
@@ -652,6 +720,26 @@ export interface IConfig {
   };
   disableProfilesInteractions?: boolean;
   disableUserCount?: boolean;
+  /**
+   * Opt-in message search (OFF by default). Set to `true` to show the
+   * "Search messages" button in the chat header and the chat profile and the
+   * search screen behind it. Requires `appId`, since the archive it queries
+   * is scoped by app. Without this flag there is no search UI and no search
+   * request.
+   */
+  enableMessageSearch?: boolean;
+  /**
+   * @deprecated Search is off unless `enableMessageSearch` is set. Kept as a
+   * hard off: when `true` message search stays disabled even if
+   * `enableMessageSearch` is set.
+   */
+  disableMessageSearch?: boolean;
+  /**
+   * Hide the "Discover chats" entry of the room list menu (and its stand-alone
+   * button when the host overrides the menu): the directory of the app's
+   * public chats (GET /v1/chats/public).
+   */
+  disablePublicChatsDirectory?: boolean;
   /** No Report / Leave behind a room-list row swiped to the left. */
   disableRoomSwipeActions?: boolean;
   disableSentLogic?: boolean;

package/src/version.ts

@@ -1,3 +1,3 @@
 // Generated by scripts/sync-version.mjs on `npm version`.
 // Edit package.json's version instead of this file.
-export const ETHORA_CHAT_COMPONENT_VERSION = '26.9.1';
+export const ETHORA_CHAT_COMPONENT_VERSION = '26.10.0';