@ethora/chat-component-rn 26.8.7 → 26.8.9

package/src/services/languageSettings.ts

@@ -0,0 +1,143 @@
+// The user's two languages, as the backend keeps them on the profile:
+//
+//   appLanguage  - the interface: the chat's captions (`uiLocale`).
+//   chatLanguage - what incoming messages are translated into, and the
+//                  language declared on the user's own messages (`langSource`).
+//
+// Both are per account, not per device: a choice made here is written to the
+// profile with `PUT /v1/users` - one field per request, as the web app does,
+// so writing one never rewrites the other - and the profile's values are
+// applied when a session starts. The last choice is also kept on the device,
+// so the interface comes up in the right language before the profile loads.
+//
+// Translation itself happens on the server, per the reader's chatLanguage:
+// that is why the choice has to reach the profile for a translation to ever
+// arrive on a message.
+
+import { store } from '../roomStore';
+import { setLangSource, setUiLocale, updateUser } from '../roomStore/chatSettingsSlice';
+import { savePreferences } from '../helpers/preferencesStorage';
+import { updateMe } from '../networking/api-requests/user.api';
+import { LANGUAGE_OPTIONS } from '../helpers/constants/LANGUAGE_OPTIONS';
+import type { IConfig } from '../types/types';
+
+export interface LanguageChoice {
+  /** BCP-47 tag, e.g. "fr-CA". */
+  id: string;
+  /** The language's own name for itself. */
+  name: string;
+}
+
+const AUTONYMS: Record<string, string> = {
+  en: 'English',
+  es: 'Español',
+  fr: 'Français',
+  pt: 'Português',
+  ht: 'Kreyòl ayisyen',
+  zh: '中文',
+  de: 'Deutsch',
+  it: 'Italiano',
+  uk: 'Українська',
+  ru: 'Русский',
+  pl: 'Polski',
+  tr: 'Türkçe',
+  ar: 'العربية',
+  hi: 'हिन्दी',
+  ja: '日本語',
+  ko: '한국어',
+  nl: 'Nederlands',
+  sv: 'Svenska',
+};
+
+/** "en-ca" -> "en-CA"; anything that is not a language tag -> undefined. */
+export const canonicalLocale = (value: unknown): string | undefined => {
+  const raw = String(value ?? '').trim();
+  const match = /^([A-Za-z]{2,3})(?:[-_]([A-Za-z0-9]{2,8}))?$/.exec(raw);
+  if (!match) {return undefined;}
+  const [, language, region] = match;
+  const base = language!.toLowerCase();
+  if (!region) {return base;}
+  return `${base}-${region.length === 2 ? region.toUpperCase() : region}`;
+};
+
+export const languageLabel = (id: string): string => {
+  const exact = LANGUAGE_OPTIONS.find((o) => o.id.toLowerCase() === id.toLowerCase());
+  if (exact) {return exact.name;}
+  return AUTONYMS[id.split('-')[0]!.toLowerCase()] || id;
+};
+
+const toChoices = (ids: string[] | undefined): LanguageChoice[] | undefined => {
+  const list = (ids || []).map(canonicalLocale).filter((id): id is string => !!id);
+  return list.length ? list.map((id) => ({ id, name: languageLabel(id) })) : undefined;
+};
+
+export const languagesEnabled = (config?: IConfig | null): boolean =>
+  config?.settings?.languages?.enabled === true;
+
+/** 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 }));
+
+/** 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 }));
+
+async function writeToProfile(field: 'appLanguage' | 'chatLanguage', value: string) {
+  try {
+    await updateMe({ [field]: value });
+    // The field alone: replacing the whole user with the backend's profile
+    // would drop what only this side holds (tokens, the XMPP password).
+    store.dispatch(updateUser({ updates: { [field]: value } }));
+    return true;
+  } catch (error) {
+    // The local choice stands: a flaky network degrades to a device-only
+    // setting rather than silently reverting what the user just picked.
+    console.warn(`[languages] could not save ${field}`, error);
+    return false;
+  }
+}
+
+/** The interface language. Applied at once; written to the profile behind. */
+export async function setAppLanguage(id: string): Promise<boolean> {
+  const locale = canonicalLocale(id);
+  if (!locale) {return false;}
+  store.dispatch(setUiLocale(locale));
+  void savePreferences({ uiLocale: locale });
+  if (!languagesEnabled(store.getState().chatSettingStore.config)) {return true;}
+  return writeToProfile('appLanguage', locale);
+}
+
+/** The language messages are translated into. */
+export async function setChatLanguage(id: string): Promise<boolean> {
+  const locale = canonicalLocale(id);
+  if (!locale) {return false;}
+  store.dispatch(setLangSource(locale as any));
+  void savePreferences({ chatLanguage: locale });
+  if (!languagesEnabled(store.getState().chatSettingStore.config)) {return true;}
+  return writeToProfile('chatLanguage', locale);
+}
+
+/**
+ * The profile's languages, applied when a session starts. The profile is the
+ * account's truth; what the device remembered only bridged the gap until
+ * now. A profile that has never chosen leaves the device's value alone.
+ */
+export function applyProfileLanguages(
+  user: { appLanguage?: string | null; chatLanguage?: string | null } | null | undefined,
+  config?: IConfig | null
+): void {
+  if (!user || !languagesEnabled(config)) {return;}
+  const app = canonicalLocale(user.appLanguage);
+  if (app && app !== store.getState().chatSettingStore.uiLocale) {
+    store.dispatch(setUiLocale(app));
+    void savePreferences({ uiLocale: app });
+  }
+  // Unset means "follow the app language" - the backend's own rule.
+  const chat = canonicalLocale(user.chatLanguage) || app;
+  if (chat && chat !== store.getState().chatSettingStore.langSource) {
+    store.dispatch(setLangSource(chat as any));
+    void savePreferences({ chatLanguage: chat });
+  }
+}

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

@@ -54,6 +54,10 @@ export interface User {
   isAssetsOpen?: boolean;
   isAgreeWithTerms?: boolean;
   isSuperAdmin?: boolean;
+  /** Interface language on the profile (BCP-47). */
+  appLanguage?: string | null;
+  /** Language messages are translated into (BCP-47); unset = follow appLanguage. */
+  chatLanguage?: string | null;
 }
 
 export interface ConfigUser {

package/src/types/types.ts

@@ -652,6 +652,8 @@ export interface IConfig {
   };
   disableProfilesInteractions?: boolean;
   disableUserCount?: boolean;
+  /** No Report / Leave behind a room-list row swiped to the left. */
+  disableRoomSwipeActions?: boolean;
   disableSentLogic?: boolean;
   disableTypingIndicator?: boolean;
   // Hide the full-screen "Connection error" overlay (the dark modal with
@@ -811,6 +813,27 @@ export interface IConfig {
     hideAppearance?: boolean;
     /** Hide the push-notifications toggle. */
     hidePushToggle?: boolean;
+    /**
+     * A "Language" card with two pickers, off by default: the interface
+     * language (the backend's `user.appLanguage`) and the language messages
+     * are translated into (`user.chatLanguage`). A choice is applied at
+     * once, kept on the device, and written to the profile with
+     * `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,
+     * fr-CA); pass BCP-47 tags to offer others.
+     */
+    languages?: {
+      enabled: boolean;
+      appLanguages?: string[];
+      chatLanguages?: string[];
+    };
+    /**
+     * A "Change password" screen, off by default: the current password and
+     * the new one, sent to `PUT /v2/users/me/password`.
+     */
+    changePassword?: boolean;
   };
 
   // ----- event hooks -----

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