@droppii-org/chat-mobile 0.2.109 → 0.2.110

package/src/utils/unreadIndicatorState.ts

@@ -0,0 +1,131 @@
+import type {
+  BeginUnreadSessionOptions,
+  UnreadAnchor,
+  UnreadIndicatorState,
+} from '../types/unreadIndicator';
+
+/**
+ * Pure transitions behind `useUnreadIndicatorStore` — kept free of React and
+ * zustand so they can be unit-tested. Every transition after `begin` is
+ * token-scoped: a token that isn't the current session's leaves the state
+ * untouched (same reference).
+ */
+
+// Slack past the lookup timeout before the gate treats itself as open even if
+// `resolve` never ran.
+export const UNREAD_GATE_WATCHDOG_SLACK_MS = 500;
+
+export const INITIAL_UNREAD_INDICATOR_STATE: UnreadIndicatorState = {
+  token: 0,
+  routeKey: undefined,
+  conversationId: undefined,
+  pending: false,
+  pendingSince: 0,
+  anchor: null,
+  pillDismissed: false,
+  awaitingDeeplinkCheck: false,
+  settledBy: null,
+};
+
+const isMine = (s: UnreadIndicatorState, token: number) => token === s.token;
+
+export const beginUnreadSession = (
+  s: UnreadIndicatorState,
+  {
+    routeKey,
+    conversationId,
+    skip,
+    awaitDeeplinkCheck,
+  }: BeginUnreadSessionOptions,
+  now: number
+): UnreadIndicatorState => ({
+  ...INITIAL_UNREAD_INDICATOR_STATE,
+  token: s.token + 1,
+  routeKey,
+  conversationId,
+  pending: !skip,
+  pendingSince: skip ? 0 : now,
+  awaitingDeeplinkCheck: !skip && awaitDeeplinkCheck,
+});
+
+export const resolveUnreadSession = (
+  s: UnreadIndicatorState,
+  token: number,
+  anchor: UnreadAnchor | null
+): UnreadIndicatorState =>
+  !isMine(s, token) || !s.pending
+    ? s
+    : { ...s, pending: false, anchor, settledBy: 'resolve' };
+
+// Doesn't bump the token: a late `resolve` is already ignored because
+// `pending` is false. Only a new `begin` (a new visit) bumps it.
+export const clearUnreadSession = (
+  s: UnreadIndicatorState,
+  token: number
+): UnreadIndicatorState =>
+  !isMine(s, token)
+    ? s
+    : {
+        ...s,
+        pending: false,
+        anchor: null,
+        pillDismissed: true,
+        awaitingDeeplinkCheck: false,
+        settledBy: 'clear',
+      };
+
+export const dismissUnreadPill = (
+  s: UnreadIndicatorState,
+  token: number
+): UnreadIndicatorState =>
+  !isMine(s, token) || s.pillDismissed ? s : { ...s, pillDismissed: true };
+
+export const confirmUnreadDeeplinkCheck = (
+  s: UnreadIndicatorState,
+  token: number,
+  hide: boolean
+): UnreadIndicatorState => {
+  if (!isMine(s, token)) return s;
+  // Not a clear: the user is still on the screen, so it must not trigger
+  // the leave flush that a blur's clear does.
+  if (hide) return { ...clearUnreadSession(s, token), settledBy: 'hide' };
+  return s.awaitingDeeplinkCheck ? { ...s, awaitingDeeplinkCheck: false } : s;
+};
+
+export const rearmUnreadDeeplinkCheck = (
+  s: UnreadIndicatorState,
+  token: number
+): UnreadIndicatorState =>
+  !isMine(s, token) || !s.anchor || s.awaitingDeeplinkCheck
+    ? s
+    : { ...s, awaitingDeeplinkCheck: true };
+
+export const resetUnreadSession = (
+  s: UnreadIndicatorState
+): UnreadIndicatorState => ({
+  ...INITIAL_UNREAD_INDICATOR_STATE,
+  token: s.token + 1,
+});
+
+/** When the watchdog opens a still-pending gate on its own. */
+export const getUnreadGateDeadline = (
+  s: UnreadIndicatorState,
+  timeoutMs: number
+): number => s.pendingSince + timeoutMs + UNREAD_GATE_WATCHDOG_SLACK_MS;
+
+/**
+ * Whether mark-read must wait. Closed only for MY session while its lookup is
+ * still pending and within the watchdog deadline. No session yet (not focused,
+ * or access not confirmed) is fail-closed; a session superseded by another
+ * visit is not this screen's gate.
+ */
+export const isUnreadGateClosed = (
+  s: UnreadIndicatorState,
+  myToken: number | null,
+  now: number,
+  timeoutMs: number
+): boolean => {
+  if (myToken == null) return true;
+  if (!isMine(s, myToken)) return false;
+  return s.pending && now <= getUnreadGateDeadline(s, timeoutMs);
+};