@ethora/chat-component-rn 26.10.9 → 26.10.11

package/src/services/languageSettings.ts

@@ -19,6 +19,7 @@ import { setLangSource, setUiLocale, updateUser } from '../roomStore/chatSetting
 import { savePreferences } from '../helpers/preferencesStorage';
 import { updateMe } from '../networking/api-requests/user.api';
 import { LANGUAGE_OPTIONS } from '../helpers/constants/LANGUAGE_OPTIONS';
+import { BUILTIN_STRINGS, toBaseLanguage } from '../i18n/strings';
 import type { IConfig } from '../types/types';
 
 export interface LanguageChoice {
@@ -66,23 +67,57 @@ export const languageLabel = (id: string): string => {
   return AUTONYMS[id.split('-')[0]!.toLowerCase()] || id;
 };
 
-const toChoices = (ids: string[] | undefined): LanguageChoice[] | undefined => {
+const canonicalList = (ids: string[] | undefined): string[] => {
   const list = (ids || []).map(canonicalLocale).filter((id): id is string => !!id);
-  return list.length ? list.map((id) => ({ id, name: languageLabel(id) })) : undefined;
+  return Array.from(new Set(list));
+};
+
+const asChoices = (ids: string[]): LanguageChoice[] =>
+  ids.map((id) => ({ id, name: languageLabel(id) }));
+
+const toChoices = (ids: string[] | undefined): LanguageChoice[] | undefined => {
+  const list = canonicalList(ids);
+  return list.length ? asChoices(list) : undefined;
 };
 
+const BUILTIN_CHOICES = (): LanguageChoice[] =>
+  LANGUAGE_OPTIONS.map((o) => ({ id: o.id, name: o.name }));
+
 export const languagesEnabled = (config?: IConfig | null): boolean =>
   config?.settings?.languages?.enabled === true;
 
+/**
+ * What the install's translation server can translate into
+ * (`config.translates.languages`, get-config's `translateLanguages`).
+ * `undefined` when the host did not pass it; `[]` means no translation
+ * server, which is an answer, not a reason to fall back.
+ */
+export const installTranslateLanguages = (
+  config?: IConfig | null
+): string[] | undefined => {
+  const raw = config?.translates?.languages;
+  return Array.isArray(raw) ? canonicalList(raw) : undefined;
+};
+
 /** What the interface can be shown in. */
-export const appLanguageChoices = (config?: IConfig | null): LanguageChoice[] =>
-  toChoices(config?.settings?.languages?.appLanguages) ??
-  LANGUAGE_OPTIONS.map((o) => ({ id: o.id, name: o.name }));
+export const appLanguageChoices = (config?: IConfig | null): LanguageChoice[] => {
+  const own = toChoices(config?.settings?.languages?.appLanguages);
+  if (own) {return own;}
+  // Narrowed to languages with a caption table: anything else would render
+  // the interface in English, which reads as a broken choice.
+  const captioned = (installTranslateLanguages(config) || []).filter(
+    (id) => !!BUILTIN_STRINGS[toBaseLanguage(id)]
+  );
+  return captioned.length ? asChoices(captioned) : BUILTIN_CHOICES();
+};
 
 /** What messages can be translated into. */
-export const chatLanguageChoices = (config?: IConfig | null): LanguageChoice[] =>
-  toChoices(config?.settings?.languages?.chatLanguages) ??
-  LANGUAGE_OPTIONS.map((o) => ({ id: o.id, name: o.name }));
+export const chatLanguageChoices = (config?: IConfig | null): LanguageChoice[] => {
+  const own = toChoices(config?.settings?.languages?.chatLanguages);
+  if (own) {return own;}
+  const install = installTranslateLanguages(config);
+  return install ? asChoices(install) : BUILTIN_CHOICES();
+};
 
 async function writeToProfile(field: 'appLanguage' | 'chatLanguage', value: string) {
   try {

package/src/services/pushRegistration.ts

@@ -51,12 +51,14 @@ interface Session {
   projectName: string;
   gatewayUrl: string;
   pushDisabled: boolean;
+  language: string;
 }
 
 interface ServerRegistration extends RegisteredPushToken {
   appId: string;
   xmppUsername: string;
   gateway: boolean;
+  language: string;
 }
 
 const HOOK_RETRY_MS = 30_000;
@@ -78,6 +80,17 @@ const readSession = (): Session => {
     xmppUsername: String(user?.xmppUsername || ''),
     projectName: String(config?.projectName || '').trim(),
     gatewayUrl: String(config?.pushNotifications?.apiUrl || '').trim(),
+    // The language the backend writes this device's pushes in: the host's
+    // config first, then what the user picked in the chat. A change
+    // re-registers the token (see sameRegistration), so hosts never call
+    // registerPushToken again for it.
+    language: String(
+      config?.translates?.readerLocale ||
+        config?.i18n?.locale ||
+        slice?.langSource ||
+        slice?.uiLocale ||
+        ''
+    ).trim(),
     // Off by config (host) or by the user's Settings toggle.
     pushDisabled:
       config?.pushNotifications?.enabled === false ||
@@ -104,7 +117,18 @@ const sameRegistration = (
   (current.pushKey || '') === (token.pushKey || '') &&
   current.gateway === isGateway(session) &&
   current.appId === session.appId &&
-  current.xmppUsername === session.xmppUsername;
+  current.xmppUsername === session.xmppUsername &&
+  // The gateway takes no language.
+  (current.gateway || current.language === session.language);
+
+// Same device, same account, only the language moved: a plain re-POST
+// updates the subscription, no release first.
+const onlyLanguageChanged = (
+  token: RegisteredPushToken,
+  current: ServerRegistration,
+  session: Session
+): boolean =>
+  sameRegistration(token, current, { ...session, language: current.language });
 
 const slotsNeedingRegistration = (session: Session): Slot[] =>
   SLOTS.filter((slot) => {
@@ -157,6 +181,7 @@ const registerOne = async (
       tokenType: token.tokenType,
       authToken: session.authToken,
       pushKey: token.pushKey,
+      language: session.language || undefined,
     });
   }
   registered.set(slotOf(token.tokenType), {
@@ -164,12 +189,14 @@ const registerOne = async (
     appId: session.appId,
     xmppUsername: session.xmppUsername,
     gateway: isGateway(session),
+    language: session.language,
   });
   pushLog(
     'rn',
     `push: ${token.tokenType} token registered` +
       (isGateway(session) ? ' (gateway)' : ` for app ${session.appId}`) +
-      (token.pushKey && !isGateway(session) ? ' with a device key (encrypted pushes)' : '')
+      (token.pushKey && !isGateway(session) ? ' with a device key (encrypted pushes)' : '') +
+      (session.language && !isGateway(session) ? `, language ${session.language}` : '')
   );
 };
 
@@ -188,7 +215,11 @@ const registerNow = (): Promise<void> => {
     for (const slot of slotsNeedingRegistration(session)) {
       const token = held.get(slot)!;
       const previous = registered.get(slot);
-      if (previous && previous.xmppUsername === session.xmppUsername) {
+      if (
+        previous &&
+        previous.xmppUsername === session.xmppUsername &&
+        !onlyLanguageChanged(token, previous, session)
+      ) {
         registered.delete(slot);
         await releaseOnServer(previous, session.authToken).catch((error) =>
           pushLog('warn', 'push: releasing the replaced token failed', error)

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

@@ -16,4 +16,20 @@ export interface ModalFile {
   siblings?: ModalFile[];
   /** Position of this file in `siblings`. */
   index?: number;
+  /** The message the file came from, for the viewer's Reply and Delete. */
+  source?: ModalFileSource;
+  /** Poster frame of a video, for grids that show it before it plays. */
+  previewURL?: string;
+}
+
+export interface ModalFileSource {
+  messageId: string;
+  roomJid: string;
+  /** Sent by the signed-in user: the viewer offers Delete. */
+  own?: boolean;
+  /** The thread the viewer's Reply opens; absent where replies are off. */
+  replyTo?: { id: string; chatJID: string };
+  senderName?: string;
+  /** When it was sent, ms since epoch. */
+  timestamp?: number;
 }

package/src/types/types.ts

@@ -864,6 +864,17 @@ export interface IConfig {
      * the enable/disable-translates toggle.
      */
     showLanguageList?: boolean;
+    /**
+     * The languages the install can translate into: pass the
+     * `translateLanguages` field of `GET /v1/apps/get-config` as-is
+     * (e.g. ["en-CA", "fr-CA", "es-US"]). It drives every chat-language
+     * list (the globe picker, the profile's Language tab, Settings), and
+     * the interface-language list narrowed to the languages the component
+     * has captions for. An empty array means the install has no
+     * translation server: the language lists and the globe picker are
+     * hidden. Omitted, the built-in list (en-CA, es-US, fr-CA) is offered.
+     */
+    languages?: string[];
     /**
      * Host-provided translation function. When set, the manual Translate
      * action calls this, wire it to your own service, instead of reading
@@ -917,6 +928,14 @@ export interface IConfig {
     }) => void | Promise<void>;
     /** @deprecated Never called; see `onClick`. */
     onNotificationPress?: (data: any) => void;
+    /**
+     * Keep the app icon badge in step with the unread total while the app
+     * is in the foreground (0 once everything is read). The backend sets
+     * the badge only with a push, so without this an opened app keeps the
+     * last push's count. Needs expo-notifications. Default true; set false
+     * when the host manages the badge itself.
+     */
+    syncAppBadge?: boolean;
     getPushTokens?: () => Promise<
       PushTokenRegistration[] | PushTokenRegistration | null | undefined
     >;
@@ -937,7 +956,8 @@ export interface IConfig {
      * `PUT /v1/users`, one field per request; the profile's values are
      * applied when a session starts. Translation itself is the server's,
      * per the reader's chat language - so `translates.enabled` is what
-     * shows the result. Options default to the built-in list (en-CA, es-US,
+     * shows the result. Options default to `translates.languages` (the
+     * install's get-config list), else the built-in list (en-CA, es-US,
      * fr-CA); pass BCP-47 tags to offer others.
      */
     languages?: {
@@ -995,14 +1015,52 @@ export interface IConfig {
 
   // ----- audio / video calls -----
   /**
-   * LiveKit-backed 1:1 audio and video calls. Off unless `enabled` is
-   * explicitly `true`. Requires the native peer dependencies
+   * Audio and video calls: 1:1 chats over our own WebRTC peer to peer (the
+   * server decides per call, with a LiveKit fallback), members-only group
+   * chats over LiveKit. Off unless `enabled` is explicitly `true`. Requires
+   * the native peer dependencies
    * `@livekit/react-native` and `@livekit/react-native-webrtc`, plus
    * microphone/camera permissions and the background audio modes listed
    * in the README. Expo Go cannot run these, the host app needs a dev
    * build or a prebuilt binary.
    */
   videoCalls?: VideoCallsConfig;
+
+  // ----- scheduled calls -----
+  /**
+   * Scheduled calls and their deep links. The schedule action, the invite
+   * cards and the join flow follow `videoCalls.enabled`; this only tells the
+   * SDK which links open the app. See README, "Scheduled calls and deep links".
+   */
+  scheduledCalls?: ScheduledCallsConfig;
+}
+
+export interface ScheduledCallsConfig {
+  /**
+   * Scheduling and the Join button. On whenever `videoCalls.enabled` is on;
+   * `false` hides the Schedule a call action and the Join buttons (an invite
+   * already in a room stays readable).
+   */
+  enabled?: boolean;
+  /**
+   * Called when a scheduled call opened from a link or a reminder could not
+   * be opened (the pre-join screen shows the matching message either way).
+   */
+  onOpenError?: (error: {
+    slug: string;
+    reason: 'not-found' | 'not-a-member' | 'cancelled' | 'network';
+  }) => void;
+  /**
+   * Hosts whose `https://<host>/call/<slug>` links open this app, in
+   * addition to the hosted web app (`app.chat.ethora.com`). Use the web
+   * domain of your Ethora app when it has its own.
+   */
+  hosts?: string[];
+  /**
+   * The app's own URL schemes, without `://`. `<scheme>://call/<slug>` opens
+   * a scheduled call. Unset: any custom scheme is accepted.
+   */
+  schemes?: string[];
 }
 
 /**
@@ -1026,7 +1084,15 @@ export interface VideoCallIcons {
 export interface VideoCallsConfig {
   enabled: boolean;
   livekitUrl: string;
-  allowedRoomTypes?: Array<'private'>;
+  /**
+   * Room types that can start and receive calls. Defaults to
+   * `['private', 'group']`: 1:1 chats plus members-only group chats (group
+   * calls always run over LiveKit and need a backend that accepts them; on an
+   * older backend the call fails with an error). Pass `['private']` to keep
+   * calls 1:1 only. The 1:1 transport (own WebRTC peer to peer, or LiveKit) is
+   * chosen by the server per call, not by this config.
+   */
+  allowedRoomTypes?: Array<'private' | 'group'>;
   /**
    * Show the audio-only call button next to the video-call button. Off by
    * default: it's a separate opt-in feature. An audio call uses the same
@@ -1162,6 +1228,22 @@ export interface ModalFile {
   siblings?: ModalFile[];
   /** Position of this file in `siblings`. */
   index?: number;
+  /** The message the file came from, for the viewer's Reply and Delete. */
+  source?: ModalFileSource;
+  /** Poster frame of a video, for grids that show it before it plays. */
+  previewURL?: string;
+}
+
+export interface ModalFileSource {
+  messageId: string;
+  roomJid: string;
+  /** Sent by the signed-in user: the viewer offers Delete. */
+  own?: boolean;
+  /** The thread the viewer's Reply opens; absent where replies are off. */
+  replyTo?: { id: string; chatJID: string };
+  senderName?: string;
+  /** When it was sent, ms since epoch. */
+  timestamp?: number;
 }
 
 // Re-export so middleware/hooks that historically import from `types`

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.10.9';
+export const ETHORA_CHAT_COMPONENT_VERSION = '26.10.11';