@ethora/chat-component-rn 26.5.10 → 26.5.12

package/CHANGELOG.md

@@ -3,12 +3,53 @@
 All notable changes to `@ethora/chat-component-rn` are listed here.
 Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); this project doesn't follow strict semver yet — version corresponds to the `package.json` field.
 
+## [26.5.11]
+
+Single-room and host-app hardening on top of 26.5.10: unread state no longer overloads `lastViewedTimestamp`, room JIDs are normalized before XMPP join paths, iOS keyboard spacing is normalized across devices, tracked default credentials are removed from source, and tenant-specific docs/testbed defaults are scrubbed. Verified with targeted Jest regression suites plus `npm run build`.
+
+### Changed
+
+#### Unread / single-room lifecycle
+
+- **Unread state split into persisted vs ephemeral visibility.** The store now tracks room visibility separately (`visibleRoomJID`) instead of overloading `lastViewedTimestamp = 0` as an "active room" sentinel. This removes the main source of tab-mounted single-room unread regressions and makes cold-start / blur / background semantics consistent.
+- **Canonical private-store flush path.** Blur, unmount, background, and logout paths now converge on the same unread timestamp flush flow instead of mixing local state updates with special-case stanza writes.
+- **Delimiter logic no longer depends on sentinel `0`.** "New messages" UI now derives from real timestamps / visibility instead of a magic unread value, which keeps divider behavior stable in mounted-tab hosts.
+
+#### Single-room roomJID normalization
+
+- **Bare room ids are normalized to full MUC JIDs** before single-room join/info/member/archive calls. This aligns the join path with the existing history path and prevents reconnect/join failures when a host passes only the room local-part.
+
+#### iOS keyboard layout
+
+- **Keyboard spacing normalized across iOS devices.** Chat input safe-area compensation is now centralized so devices with and without a home indicator keep the same visual dock behavior when the keyboard opens.
+- **`SafeAreaProvider` wrapped by the RN testbed shell.** The shared wrapper now guarantees `useSafeAreaInsets()` has a provider in the local app path.
+
+#### Credentials / docs hygiene
+
+- **Tracked default credentials removed.** `AppLoginChatsRn` now ships with blank setup defaults; the JWT seed helper reads from an ignored local JSON file instead of secrets in tracked source.
+- **Tenant-specific docs and QA notes replaced with generic runbooks.** Example profile names, QA hostnames, and customer-specific notes were scrubbed from README / scripts / docs in favor of reusable environment-agnostic instructions.
+
+### Fixed
+
+- **Tab-mounted single-room unread regressions.** Focus/blur/background behavior now works without importing internal store paths from consumer apps.
+- **Cold-start unread marker clobbering.** Persisted last-viewed state is no longer vulnerable to being overwritten by the old active-room sentinel flow.
+- **Single-room reconnect/join mismatch for bare room ids.** XMPP room operations now operate on normalized MUC JIDs consistently.
+
+### Internal
+
+- **Repo-side pre-commit typecheck hook is versioned and wired.** `.githooks/pre-commit` runs `tsc --noEmit --moduleResolution bundler --module esnext -p tsconfig.json`, and `scripts/install-git-hooks.js` sets `git config core.hooksPath .githooks` from the `prepare` script. Use `ETHORA_SKIP_TYPECHECK=1` or `git commit --no-verify` only when intentionally bypassing it.
+
 ## [26.5.10]
 
-Lifecycle hardening on top of 26.5.9, driven by live on-device testing: a full reconnect-after-loss overhaul (a live test surfaced — and this release fixes — a reconnect storm), cache no longer wiped on re-entry, automatic AppState-driven unread visibility plus a new `isVisible` prop for tab hosts, `initBeforeLoad` auto-retry, and the "New messages" divider polish. Full regression sweep — typecheck clean, 583 jest tests green.
+Lifecycle hardening on top of 26.5.9, driven by live on-device testing: a full reconnect-after-loss overhaul (a live test surfaced — and this release fixes — a reconnect storm), cache no longer wiped on re-entry, automatic AppState-driven unread visibility plus a new `isVisible` prop for tab hosts, `initBeforeLoad` auto-retry, and the "New messages" divider polish. Full regression sweep — typecheck clean, 584 jest tests green.
 
 ### Fixed
 
+#### Packaging / TypeScript (regression from 26.5.5)
+
+- **#8 — consumers' tsc no longer compiles our raw source.** `exports['.'].react-native` pointed at `./src/main.ts`, so React Native consumers' TypeScript (which resolves with `customConditions: ["react-native"]`) walked our entire `src/` tree and hit 51 errors about our internal devDeps (`@types/ltx`, `@types/uuid`, `@types/xmpp__client`, JSX namespace) — blocking pre-commit hooks on consumer side. The condition is now a nested entry that exposes the **compiled** artifacts: `react-native.types → ./lib/typescript/main.d.ts`, `react-native.default → ./lib/module/main.js`. No `src/*.ts` is reachable through any `exports` chain. (Verified by parsing the resolution graph and confirming zero `./src/` references in `exports`.)
+- **Pre-commit typecheck hook (repo-side).** Added `.githooks/pre-commit` that runs `tsc --noEmit` with the project's `--moduleResolution bundler --module esnext` flags before every commit; a `scripts/install-git-hooks.js` wires `core.hooksPath` from the `prepare` script on `npm install`. Zero runtime deps. Bypass with `ETHORA_SKIP_TYPECHECK=1` or `git commit --no-verify` if you really need to. Catches future packaging-style regressions before they ship.
+
 #### Connectivity / reconnect (the big one)
 
 - **Never permanently gives up.** `scheduleReconnect` used to hard-stop at `maxReconnectAttempts` (5) — ~62s, after which only a NetInfo/foreground event could revive the client. It now retries indefinitely while mounted, with the exponential backoff **clamped to `maxReconnectDelay` (30s)**.
@@ -35,8 +76,31 @@ Lifecycle hardening on top of 26.5.9, driven by live on-device testing: a full r
 - **White text.** The label sits on a dark pill but rendered in the (often blue) primary color — unreadable. It's now white.
 - **Removed when you leave the chat** (tab switch / navigation / app background) and **spliced out rather than tombstoned**, so it correctly re-appears for the next batch of unread — previously it was a one-shot (the tombstone blocked every future divider).
 
+#### Voice messages (new — opt-in, matches the web UX)
+
+- **Tap-to-record voice messages from the input bar.** Behind a new opt-in `config.enableAudio: true` (default off — set `true` to enable). The right-side action button swaps between **mic** (when input is empty) and **send** (when there's text or attachments) — same single-button pattern as the web app. Tap the mic → recording overlay with a live timer + cancel + stop&send. Recording uses `expo-av`'s `Audio.Recording` (HIGH_QUALITY preset: AAC in an M4A container on both iOS and Android), and on stop ships through the same `sendMedia` pipeline with `mimetype: "audio/m4a"` and `filename: "voice-<timestamp>.m4a"`. Receivers route it through `MediaMessage`'s audio branch directly.
+- **Incoming audio always plays** — independent of `enableAudio`. The 26.5.10 `isLikelyAudio` heuristic still catches octet-stream voicemails coming from older web senders.
+- **iOS apps need `NSMicrophoneUsageDescription`** in `Info.plist`. The bundled `expo-av` plugin block in `app.json` adds it on `expo prebuild`; standalone apps should configure it the same way.
+
+#### Customer-reported bugs (this round)
+
+- **#19 — `useUnread()` always 0 in tab-mounted hosts.** `ChatRoom`'s visibility effect had `client` in its dep array, so any `client` identity change (reconnect, provider re-render) re-fired setup → `dispatch(setVisibleRoom(activeRoomJID))` ~one tick after the host cleared visibility via the `isVisible` prop on `<Chat>`, clobbering it. Effect now splits setup (deps without `client`) from cleanup (reads client through a ref). `<Chat isVisible={...} />` now works as documented.
+- **#15 — `disableChatHeaderBurgerMenuIcon` clipped the chat avatar/name.** When the burger was hidden the header still reserved an empty `leftContainer` at `width: 15%`, eating space and clipping the title. The placeholder is no longer rendered — `CenterContainer` expands to fill, the chat-name row now sits flush with the left edge as intended.
+- **#16 — new `disableChatInfo.disableMemberTap` flag.** `disableMemberProfileActions` only hides the *action block inside* the member-profile popup; the popup itself still opened on tap. The new flag blocks the tap entirely, so the popup never opens. Both flags can be combined for full lock-down.
+- **#9 (video) — video preview tap unresponsive.** `VideoMessage` wrapped a `VideoView` in a `TouchableOpacity` with `pointerEvents="none"` on the inner view — on some `expo-video` versions / iOS the native VideoView still intercepted gestures, so tapping the poster did nothing. Switched to a capture-overlay pattern: VideoView at the bottom, transparent `Pressable` absolute-filled on top owns the tap → `setActiveModal(FILE_PREVIEW)` reliably fires. (The .bin voicemail case is a web-app issue — see migration note below.)
+- **#23 — phantom "ethora.com" room stub.** `rooms.api` synthesized JIDs as `<name>@conference.xmpp.chat.ethora.com` when the REST item carried no JID and the consumer hadn't configured `xmppSettings.host` — surfacing a fake "ethora" room on third-party servers. Removed the hardcoded vendor host; the fallback now derives the host from `config.baseUrl` (`api.foo.com` → `xmpp.foo.com`), and if that's still ambiguous the room is skipped with a `warn` log rather than fabricated.
+
+**Migration notes for consumers**
+
+- *#9 voicemail .bin*: the testbed sees voicemails from the web app arrive with `mimetype: application/octet-stream` and no audio file extension, so the audio-extension sniff in `MediaMessage.tsx` doesn't match and the file falls through to `FileDownload` (unplayable). Fix on the **web sender side**: when uploading a voice message, set `mimetype: audio/mp3` (or `audio/m4a` / whatever the actual codec is) and ensure the filename ends in a recognised audio extension (`.mp3` / `.m4a` / `.wav` / `.aac` / `.ogg` / `.flac`). The RN side then plays it correctly without further changes.
+- *#16 migration*: if you previously set `disableMemberProfileActions: true` expecting it to also suppress the tap, set `disableChatInfo.disableMemberTap: true` additionally.
+
 #### Misc
 
+- **Modal header layout fixed.** `HeaderContainer` had `padding-top: 62px` (status-bar offset) clamped under `min-height/max-height: 24px`, so content overflowed the visible header band — the back arrow visibly hugged the bottom of the white header strip instead of being vertically centered. Dropped the height clamps and switched to symmetric vertical padding (`12px` + `56px` top inset). Fixes every modal that uses `ModalHeaderComponent` (chat-profile, user-profile, settings, file-preview, …).
+- **New `disableChatInfo.disableIconEdit` flag.** Hides the press-to-pick / remove affordances on the chat icon in the chat-info modal regardless of the user's role, so consumers can make a branded / read-only room icon. The icon itself still renders.
+- **Profile-vs-chat-info flag split (semantic fix).** `disableProfilesInteractions` is now correctly scoped to **user-profile** popups only — wired in `Message.tsx` for the in-bubble avatar tap (where it was missing) and removed from `ChatHeader`'s chat-title press (where it had the wrong semantic — that surface opens the *chat-info* modal). The header tap is now gated by the already-existing-but-previously-unwired `disableChatInfo.disableChatHeaderMenu`, so a consumer can disable user profiles without losing chat info — and vice versa. Migration note for anyone relying on the old behaviour: if you set `disableProfilesInteractions: true` to suppress the header tap, also set `disableChatInfo.disableChatHeaderMenu: true`.
+- **`useLogout()` now returns an awaitable `() => Promise<void>`.** Previously the hook fired-and-forgot `logoutService.performLogout()`, so a host that navigated immediately after `logout()` could race the persistence middleware's 200 ms debounce and rehydrate stale state on the next mount ("old chats reappear"). The returned promise resolves after XMPP disconnect + persisted slices wiped + REST/AsyncStorage cleared; it never rejects. **Type-level change** (`() => void` → `() => Promise<void>`) — non-awaiting callers continue to work, but you can now `await logout()` before navigating.
 - **Benign unhandled-rejection red box gone.** The dev rejection tracker now reports only *genuinely* unhandled rejections (`allRejections: false`), and `createTimeoutPromise` self-observes its timeout so a settled `Promise.race` no longer leaks a `reject(undefined)`.
 - **Input bar spacing.** The send button's horizontal margin is removed so its gap from the input matches the attach button's.
 

package/README.md

@@ -16,6 +16,7 @@ React Native chat UI + chat core for iOS and Android, powered by the Ethora plat
 - [Authentication modes](#authentication-modes)
 - [Pinning a single room](#pinning-a-single-room)
 - [Unread tracking in tab-based hosts](#unread-tracking-in-tab-based-hosts)
+- [Logging out](#logging-out)
 - [Customization flags worth knowing](#customization-flags-worth-knowing)
 - [Quality & test coverage](#quality--test-coverage)
 - [Local development](#local-development)
@@ -248,12 +249,40 @@ function TabBar() {
 
 Full details (including the cold-start fix and the scroll-to-bottom unread chip) live in [`docs/unread-tracking.md`](docs/unread-tracking.md).
 
+## Logging out
+
+`useLogout()` returns an **awaitable** `() => Promise<void>` that resolves only after the SDK has fully torn down: XMPP disconnect, redux reset, persisted slices wiped, AsyncStorage stray keys removed, REST cache cleared.
+
+```tsx
+import { useLogout } from '@ethora/chat-component-rn';
+
+function SignOutButton() {
+  const logout = useLogout();
+  return (
+    <Button
+      title="Sign out"
+      onPress={async () => {
+        await logout();                      // ← awaits the full teardown
+        navigation.replace('SignIn');        // disk is provably clean here
+      }}
+    />
+  );
+}
+```
+
+Why awaitable: the persistence layer debounces writes by 200 ms, and the chat slice removes its persisted user fire-and-forget. If the host navigated / re-mounted `<Chat>` immediately after a non-awaited call, the next bootstrap could occasionally rehydrate stale state ("old chats reappear"). Awaiting the returned promise eliminates that race. The function never rejects — any internal failure is logged via `console.warn`, so a non-awaited call still won't crash the host. For non-React contexts you can call `logoutService.performLogout()` directly (same Promise).
+
 ## Customization flags worth knowing
 
 | Flag | What it does |
 | --- | --- |
+| `disableProfilesInteractions` | Disables entry to the **user-profile popup** — the in-bubble avatar tap on other users' messages. The avatar is still rendered, just non-interactive. (Does **not** affect the chat-title press → use `disableChatInfo.disableChatHeaderMenu` for that.) |
+| `disableChatInfo.disableChatHeaderMenu` | Disables the **chat-info modal entry point** in the header (tapping the chat title / icon). Use this when you want the header purely informational. The chat-info modal itself has further granular flags (`disableDescription`, `disableType`, `disableMembers`, `hideMembers`, `disableIconEdit`). |
+| `disableChatInfo.disableIconEdit` | Makes the chat icon read-only in the chat-info modal — hides the press-to-pick picker AND the remove affordance regardless of the user's role. The icon still renders. |
 | `disableChatHeaderBurgerMenuIcon` | Hides the burger icon in the chat header (the icon that opens the room-list dropdown). `chatHeaderBurgerMenu` controls only the dropdown — set this when you want neither rendered. |
-| `disableMemberProfileActions` | Hides the whole "Message / Copy User Id" action block in the chat-info member modal. Use when no per-user actions are appropriate (e.g. patient-facing apps). |
+| `enableAudio` | Opt-in voice messages. **Off by default.** When `true`, an idle input (no text, no attachments) shows a mic icon in the send-button slot — tap → start recording → stop & send. iOS apps need `NSMicrophoneUsageDescription` in Info.plist (add via `expo-av`'s plugin block in `app.json`). Receiving voice messages from other clients (incl. legacy web `.bin` voicemails) is **independent of this flag** — incoming audio plays regardless. |
+| `disableMemberProfileActions` | Hides the whole "Message / Copy User Id" action block **inside** the chat-info member-profile popup. The popup itself still opens — to block the tap entirely, use `disableChatInfo.disableMemberTap`. |
+| `disableChatInfo.disableMemberTap` | Disables the tap on a member row in the chat-info list — the user-profile popup never opens. Set when no per-member interaction is appropriate (e.g. patient-facing apps). |
 | `hideMemberSendMessageAction` | Hides only the "Message" button, keeps everything else. |
 | `hideMemberCopyIdAction` | Hides only the "Copy User Id" button, keeps everything else. |
 | `disableConnectionErrorOverlay` | Replaces the full-screen "Connection error" overlay with a small, non-blocking `ConnectionBanner`. Set this when a transient reconnect shouldn't take over the whole screen. |