@rapidmx/web-client 0.20.0 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/README.md +381 -381
  2. package/apps/admin/branding/index.tsx +39 -39
  3. package/apps/admin/data-requests/index.tsx +482 -482
  4. package/apps/admin/domains/[uid].tsx +166 -166
  5. package/apps/admin/escrow-scopes/[uid].tsx +350 -350
  6. package/apps/admin/index.tsx +129 -129
  7. package/apps/admin/mailboxes/[uid].tsx +271 -271
  8. package/apps/admin/mailboxes/new/index.tsx +30 -30
  9. package/apps/admin/plugins/index.tsx +15 -15
  10. package/apps/admin/retention-policy/index.tsx +39 -39
  11. package/apps/admin/signing-certificates/index.tsx +343 -343
  12. package/apps/escrow/audit-log/index.tsx +196 -196
  13. package/apps/escrow/matters/[uid].tsx +621 -621
  14. package/apps/shared/auth/adminAccess.ts +99 -99
  15. package/apps/shared/components/admin/layout/AdminShell.tsx +384 -384
  16. package/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.tsx +238 -238
  17. package/apps/shared/components/admin/mailboxes/EscrowScopeCard.tsx +152 -152
  18. package/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.tsx +194 -194
  19. package/apps/shared/components/admin/settings/BrandingForm.tsx +423 -423
  20. package/apps/shared/components/admin/settings/EncryptionPolicyForm.tsx +119 -119
  21. package/apps/shared/components/admin/settings/MailboxPolicyForm.tsx +198 -198
  22. package/apps/shared/components/admin/settings/PluginsManager.tsx +2093 -2093
  23. package/apps/shared/components/admin/settings/RetentionPolicyForm.tsx +182 -182
  24. package/apps/shared/components/admin/setup/EscrowSetupStep.tsx +288 -288
  25. package/apps/shared/components/admin/setup/SetupWizard.tsx +446 -446
  26. package/apps/shared/components/admin/usePagedList.tsx +129 -129
  27. package/apps/shared/components/calendar/EventModal.tsx +206 -206
  28. package/apps/shared/components/calendar/MonthView.tsx +185 -185
  29. package/apps/shared/components/calendar/RecurrenceEditor.tsx +227 -227
  30. package/apps/shared/components/calendar/SplitDayView.tsx +144 -144
  31. package/apps/shared/components/calendar/TimeGridView.tsx +246 -246
  32. package/apps/shared/components/calendar/allDay.ts +124 -124
  33. package/apps/shared/components/contacts/ContactForm.tsx +383 -383
  34. package/apps/shared/components/contacts/ContactsToolbar.tsx +103 -103
  35. package/apps/shared/components/escrow/layout/EscrowShell.tsx +155 -155
  36. package/apps/shared/components/layout/AppShell.tsx +463 -461
  37. package/apps/shared/components/layout/KeyEnrollmentGate.tsx +398 -398
  38. package/apps/shared/components/layout/MailboxProvisioning.tsx +168 -168
  39. package/apps/shared/components/layout/ResponsiveToolbar.tsx +315 -315
  40. package/apps/shared/components/layout/ThemeSwitch.tsx +84 -84
  41. package/apps/shared/components/layout/UserMenu.tsx +439 -439
  42. package/apps/shared/components/mail/ConversationList.tsx +332 -332
  43. package/apps/shared/components/mail/ConversationThreadPane.tsx +613 -613
  44. package/apps/shared/components/mail/MailSelectionBar.tsx +240 -240
  45. package/apps/shared/components/mail/MenuButton.tsx +404 -404
  46. package/apps/shared/components/mail/MessageDetailPane.tsx +1757 -1757
  47. package/apps/shared/components/mail/compose/ComposeContext.tsx +312 -312
  48. package/apps/shared/components/mail/compose/ComposeToolbar.tsx +422 -422
  49. package/apps/shared/components/mail/compose/ComposeWindow.tsx +1705 -1681
  50. package/apps/shared/components/mail/compose/RichTextEditor.tsx +147 -147
  51. package/apps/shared/components/mail/compose/composeFlushRegistry.ts +60 -60
  52. package/apps/shared/components/mail/compose/quotedBody.ts +161 -161
  53. package/apps/shared/components/mail/reading/MessageMoreMenu.tsx +258 -258
  54. package/apps/shared/components/mail/reading/MessageSourceDialog.tsx +79 -79
  55. package/apps/shared/components/mail/reading/messageExport.ts +59 -59
  56. package/apps/shared/components/mail/reading/printMessage.ts +99 -99
  57. package/apps/shared/components/mail/reading/useMessageActions.ts +443 -443
  58. package/apps/shared/components/mail/verificationSeals.ts +125 -125
  59. package/apps/shared/components/rules/RuleBuilder.tsx +311 -311
  60. package/apps/shared/components/settings/SigningCertificateCard.tsx +344 -344
  61. package/apps/shared/keyboard/GlobalShortcuts.tsx +51 -51
  62. package/apps/shared/keyboard/ShortcutProvider.tsx +62 -62
  63. package/apps/shared/keyboard/ShortcutsDialog.tsx +84 -84
  64. package/apps/shared/keyboard/dispatch.ts +124 -124
  65. package/apps/shared/keyboard/format.ts +89 -89
  66. package/apps/shared/keyboard/keymap.ts +114 -114
  67. package/apps/shared/keyboard/registry.ts +65 -65
  68. package/apps/shared/keyboard/targets.ts +79 -79
  69. package/apps/shared/mail/folderOfType.ts +49 -49
  70. package/apps/shared/mail/folderTree.ts +143 -143
  71. package/apps/shared/mail/listAllPages.ts +39 -39
  72. package/apps/shared/mail/newMailNotifications.ts +171 -171
  73. package/apps/shared/mail/outbox/sendJob.ts +445 -445
  74. package/apps/shared/mail/outbox/sendOutcomes.ts +155 -155
  75. package/apps/shared/mail/reportNotices.ts +66 -66
  76. package/apps/shared/mail/senderBlocking.ts +141 -141
  77. package/apps/shared/mail/useMailConnection.ts +205 -205
  78. package/apps/shared/mail/useMailLiveUpdates.ts +277 -277
  79. package/apps/shared/mail/useMailboxUpdateAccess.ts +60 -60
  80. package/apps/shared/mail/useMarkMessageRead.ts +47 -47
  81. package/apps/shared/mail/useNewMailNotifications.ts +178 -178
  82. package/apps/shared/notifications/store.ts +560 -560
  83. package/apps/shared/search/LocalIndexLifecycle.tsx +114 -114
  84. package/apps/shared/search/localIndexBuilder.ts +481 -481
  85. package/apps/shared/signing/enrollmentStorage.ts +33 -33
  86. package/apps/shared/signing/enrollmentTracker.ts +385 -385
  87. package/apps/shared/signing/enrollmentView.ts +251 -251
  88. package/apps/shared/signing/useNow.ts +19 -19
  89. package/apps/shared/signing/useSigningEnrollmentWatcher.ts +90 -90
  90. package/apps/shared/styles/app.css +396 -396
  91. package/apps/www/calendar/index.tsx +581 -581
  92. package/apps/www/contacts/[uid].tsx +112 -112
  93. package/apps/www/index.tsx +3012 -3012
  94. package/apps/www/messages/[uid].tsx +139 -139
  95. package/apps/www/settings/auto-reply/index.tsx +136 -136
  96. package/apps/www/settings/blocked-senders/index.tsx +303 -303
  97. package/apps/www/settings/encryption/index.tsx +1290 -1290
  98. package/apps/www/settings/filters/[uid].tsx +179 -179
  99. package/apps/www/settings/filters/index.tsx +105 -105
  100. package/apps/www/settings/filters/new/index.tsx +165 -165
  101. package/apps/www/settings/labels/index.tsx +207 -207
  102. package/apps/www/settings/privacy/index.tsx +495 -495
  103. package/apps/www/settings/profile/index.tsx +251 -251
  104. package/apps/www/settings/read-receipts/index.tsx +150 -150
  105. package/apps/www/settings/sharing/index.tsx +259 -259
  106. package/apps/www/settings/signatures/[uid].tsx +175 -175
  107. package/apps/www/settings/signatures/index.tsx +91 -91
  108. package/apps/www/settings/signatures/new/index.tsx +138 -138
  109. package/apps/www/tasks/index.tsx +654 -654
  110. package/dist/apps/shared/components/admin/layout/AdminShell.js +2 -2
  111. package/dist/apps/shared/components/admin/settings/BrandingForm.js +3 -3
  112. package/dist/apps/shared/components/escrow/layout/EscrowShell.js +2 -2
  113. package/dist/apps/shared/components/layout/AppShell.js +4 -2
  114. package/dist/apps/shared/components/mail/compose/ComposeWindow.d.ts +7 -1
  115. package/dist/apps/shared/components/mail/compose/ComposeWindow.js +20 -1
  116. package/dist/apps/shared/components/mail/reading/printMessage.js +11 -11
  117. package/dist/apps/shared/styles/app.css +396 -396
  118. package/package.json +2 -2
@@ -1,60 +1,60 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
- import { useEffect, useState } from "react";
6
- import type { Mailbox } from "@rapidmx/react-shared/mail/mailApi.js";
7
- import { getMyMailboxAccess } from "@rapidmx/react-shared/mail/mailboxAccessApi.js";
8
-
9
- /** What the server said about the caller's update access to a mailbox, remembered per mailbox for the page load. */
10
- const answers = new Map<string, Promise<boolean | undefined>>();
11
-
12
- /** Forgets every remembered answer - for the tests, and anything that changes the caller's access mid-session. */
13
- export function clearMailboxUpdateAccessCache(): void {
14
- answers.clear();
15
- }
16
-
17
- /** Whether the caller may change things in `mailboxUid` (move, mark and flag its messages, add its filters): the server's own ACL check. Never rejects; `undefined` when it could not be asked (which is not cached). */
18
- function fetchUpdateAccess(mailboxUid: string): Promise<boolean | undefined> {
19
- let answer = answers.get(mailboxUid);
20
- if (!answer) {
21
- answer = getMyMailboxAccess(mailboxUid).then(
22
- (access) => access.canUpdate,
23
- () => {
24
- answers.delete(mailboxUid);
25
- return undefined;
26
- },
27
- );
28
- answers.set(mailboxUid, answer);
29
- }
30
- return answer;
31
- }
32
-
33
- /**
34
- * Whether the reader may change the messages of `mailbox`: `false` only for a mailbox shared with them (`accessRole: "delegate"`) that
35
- * the server says they may not update - a view-only share. Everything else is `true` from the first render: the reader's own mailbox
36
- * needs no request, and a mailbox that is unknown (the shell has not listed it), or whose access could not be read, is treated as
37
- * writable - the server still refuses what is not allowed, and hiding a usable action over a failed lookup is worse than offering one
38
- * that then says why it failed.
39
- */
40
- export function useMailboxUpdateAccess(mailbox: Mailbox | undefined): boolean {
41
- const uid = mailbox?.uid;
42
- const delegated = mailbox?.accessRole === "delegate";
43
- const [writable, setWritable] = useState(true);
44
- useEffect(() => {
45
- setWritable(true);
46
- if (!uid || !delegated) {
47
- return;
48
- }
49
- let cancelled = false;
50
- void fetchUpdateAccess(uid).then((canUpdate) => {
51
- if (!cancelled && canUpdate === false) {
52
- setWritable(false);
53
- }
54
- });
55
- return () => {
56
- cancelled = true;
57
- };
58
- }, [uid, delegated]);
59
- return writable;
60
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+ import { useEffect, useState } from "react";
6
+ import type { Mailbox } from "@rapidmx/react-shared/mail/mailApi.js";
7
+ import { getMyMailboxAccess } from "@rapidmx/react-shared/mail/mailboxAccessApi.js";
8
+
9
+ /** What the server said about the caller's update access to a mailbox, remembered per mailbox for the page load. */
10
+ const answers = new Map<string, Promise<boolean | undefined>>();
11
+
12
+ /** Forgets every remembered answer - for the tests, and anything that changes the caller's access mid-session. */
13
+ export function clearMailboxUpdateAccessCache(): void {
14
+ answers.clear();
15
+ }
16
+
17
+ /** Whether the caller may change things in `mailboxUid` (move, mark and flag its messages, add its filters): the server's own ACL check. Never rejects; `undefined` when it could not be asked (which is not cached). */
18
+ function fetchUpdateAccess(mailboxUid: string): Promise<boolean | undefined> {
19
+ let answer = answers.get(mailboxUid);
20
+ if (!answer) {
21
+ answer = getMyMailboxAccess(mailboxUid).then(
22
+ (access) => access.canUpdate,
23
+ () => {
24
+ answers.delete(mailboxUid);
25
+ return undefined;
26
+ },
27
+ );
28
+ answers.set(mailboxUid, answer);
29
+ }
30
+ return answer;
31
+ }
32
+
33
+ /**
34
+ * Whether the reader may change the messages of `mailbox`: `false` only for a mailbox shared with them (`accessRole: "delegate"`) that
35
+ * the server says they may not update - a view-only share. Everything else is `true` from the first render: the reader's own mailbox
36
+ * needs no request, and a mailbox that is unknown (the shell has not listed it), or whose access could not be read, is treated as
37
+ * writable - the server still refuses what is not allowed, and hiding a usable action over a failed lookup is worse than offering one
38
+ * that then says why it failed.
39
+ */
40
+ export function useMailboxUpdateAccess(mailbox: Mailbox | undefined): boolean {
41
+ const uid = mailbox?.uid;
42
+ const delegated = mailbox?.accessRole === "delegate";
43
+ const [writable, setWritable] = useState(true);
44
+ useEffect(() => {
45
+ setWritable(true);
46
+ if (!uid || !delegated) {
47
+ return;
48
+ }
49
+ let cancelled = false;
50
+ void fetchUpdateAccess(uid).then((canUpdate) => {
51
+ if (!cancelled && canUpdate === false) {
52
+ setWritable(false);
53
+ }
54
+ });
55
+ return () => {
56
+ cancelled = true;
57
+ };
58
+ }, [uid, delegated]);
59
+ return writable;
60
+ }
@@ -1,47 +1,47 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
- import { useEffect, useRef } from "react";
6
- import type { Message } from "@rapidmx/react-shared/mail/mailApi.js";
7
- import { useMailShell } from "../components/mail/layout/MailShell.js";
8
- import { setReadState } from "./messageReadState.js";
9
-
10
- /**
11
- * Marks a message read when it is opened in a reading pane, through `setReadState()`: the row and the folder badge change at
12
- * once. `onPatched` is handed each copy of the message as it changes (the optimistic one, then the server's, or the original
13
- * again if the server refused).
14
- *
15
- * Replaces `@rapidmx/react-shared`'s `useMarkMessageRead`, which waits for the server before telling anyone and drops that
16
- * answer if the message changes meanwhile - which the optimistic copy itself does. A message is asked for once each time it is
17
- * opened: one the reader then marks unread stays unread while it is open, and one whose request failed is not retried in a loop
18
- * (its own revert changes it again), only when it is opened again.
19
- */
20
- export function useMarkMessageRead(message: Message | null, onPatched: (updated: Message, previous?: Message) => void): void {
21
- const { trackMessageChange } = useMailShell();
22
- const openUidRef = useRef<string | undefined>(undefined);
23
- const requestedRef = useRef<Set<string>>(new Set());
24
- const latestRef = useRef({ onPatched, trackMessageChange });
25
- latestRef.current = { onPatched, trackMessageChange };
26
-
27
- useEffect(() => {
28
- if (message?.uid !== openUidRef.current) {
29
- // Another message (or none) is open now: whatever was asked about the last one is over.
30
- openUidRef.current = message?.uid;
31
- requestedRef.current.clear();
32
- }
33
- if (!message || requestedRef.current.has(message.uid)) {
34
- return;
35
- }
36
- // Every opening is asked about once - a message that is already read included, so that marking it unread while it is open (the
37
- // keyboard's Ctrl+U) doesn't make this run again and read it straight back.
38
- requestedRef.current.add(message.uid);
39
- if (message.flags.read === true) {
40
- return;
41
- }
42
- void setReadState(message, true, {
43
- patch: (updated, previous) => latestRef.current.onPatched(updated, previous),
44
- track: (previous, next) => latestRef.current.trackMessageChange(previous, next),
45
- });
46
- }, [message]);
47
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+ import { useEffect, useRef } from "react";
6
+ import type { Message } from "@rapidmx/react-shared/mail/mailApi.js";
7
+ import { useMailShell } from "../components/mail/layout/MailShell.js";
8
+ import { setReadState } from "./messageReadState.js";
9
+
10
+ /**
11
+ * Marks a message read when it is opened in a reading pane, through `setReadState()`: the row and the folder badge change at
12
+ * once. `onPatched` is handed each copy of the message as it changes (the optimistic one, then the server's, or the original
13
+ * again if the server refused).
14
+ *
15
+ * Replaces `@rapidmx/react-shared`'s `useMarkMessageRead`, which waits for the server before telling anyone and drops that
16
+ * answer if the message changes meanwhile - which the optimistic copy itself does. A message is asked for once each time it is
17
+ * opened: one the reader then marks unread stays unread while it is open, and one whose request failed is not retried in a loop
18
+ * (its own revert changes it again), only when it is opened again.
19
+ */
20
+ export function useMarkMessageRead(message: Message | null, onPatched: (updated: Message, previous?: Message) => void): void {
21
+ const { trackMessageChange } = useMailShell();
22
+ const openUidRef = useRef<string | undefined>(undefined);
23
+ const requestedRef = useRef<Set<string>>(new Set());
24
+ const latestRef = useRef({ onPatched, trackMessageChange });
25
+ latestRef.current = { onPatched, trackMessageChange };
26
+
27
+ useEffect(() => {
28
+ if (message?.uid !== openUidRef.current) {
29
+ // Another message (or none) is open now: whatever was asked about the last one is over.
30
+ openUidRef.current = message?.uid;
31
+ requestedRef.current.clear();
32
+ }
33
+ if (!message || requestedRef.current.has(message.uid)) {
34
+ return;
35
+ }
36
+ // Every opening is asked about once - a message that is already read included, so that marking it unread while it is open (the
37
+ // keyboard's Ctrl+U) doesn't make this run again and read it straight back.
38
+ requestedRef.current.add(message.uid);
39
+ if (message.flags.read === true) {
40
+ return;
41
+ }
42
+ void setReadState(message, true, {
43
+ patch: (updated, previous) => latestRef.current.onPatched(updated, previous),
44
+ track: (previous, next) => latestRef.current.trackMessageChange(previous, next),
45
+ });
46
+ }, [message]);
47
+ }
@@ -1,178 +1,178 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
- import { useCallback, useEffect, useMemo, useRef, useState } from "react";
6
- import type { Mailbox, Message } from "@rapidmx/react-shared/mail/mailApi.js";
7
- import type { MailboxFolders } from "../components/mail/layout/MailShell.js";
8
- import {
9
- DesktopPermission,
10
- NewMailNotice,
11
- desktopPermission,
12
- getDesktopOfferDismissed,
13
- noticeFor,
14
- noticeSender,
15
- ownAddressesOf,
16
- requestDesktopPermission,
17
- setDesktopOfferDismissed,
18
- shouldAnnounce,
19
- } from "./newMailNotifications.js";
20
- import { getNotificationsEnabled } from "../notifications/preferences.js";
21
- import { getNotificationsSnapshot, notify } from "../notifications/store.js";
22
-
23
- /** How long a new-mail pop-up stays before it goes by itself (while it is neither hovered nor focused, and the tab is in view). */
24
- export const TOAST_DURATION_MS = 8_000;
25
-
26
- /** At most this many desktop notifications in `DESKTOP_BURST_WINDOW_MS`: a flood of mail is a few notifications, not a hundred. */
27
- export const DESKTOP_BURST_LIMIT = 5;
28
- export const DESKTOP_BURST_WINDOW_MS = 30_000;
29
-
30
- /** How many announced message uids are remembered, so an event delivered twice is announced once. */
31
- const ANNOUNCED_LIMIT = 500;
32
-
33
- export interface NewMailNotifications {
34
- /** Whether the next pop-up should also offer to turn on desktop notifications: the browser can, has not been asked,
35
- * and the user has not said "Not now". */
36
- offerDesktop: boolean;
37
- /** The offer's "Turn on desktop notifications": asks the browser. Must be called from a click. */
38
- enableDesktop(): Promise<void>;
39
- /** The offer's "Not now": remembered, so it is not made again. */
40
- declineDesktop(): void;
41
- /** Announces a message that just arrived - if it is worth it (see `shouldAnnounce()`) and pop-ups are on. Stable. */
42
- announce(message: Message): void;
43
- }
44
-
45
- /** Whether the user is not looking at this tab: it is hidden, or another window has the focus. */
46
- function tabIsInBackground(): boolean {
47
- return document.visibilityState === "hidden" || !document.hasFocus();
48
- }
49
-
50
- export interface UseNewMailNotificationsOptions {
51
- mailboxes: Mailbox[];
52
- mailboxFolders: MailboxFolders[];
53
- /** Opens a message from a desktop notification's click. Defaults to a plain navigation. */
54
- open?: (href: string) => void;
55
- }
56
-
57
- function defaultOpen(href: string): void {
58
- window.location.href = href;
59
- }
60
-
61
- /**
62
- * New-mail announcements: an in-app pop-up for each message that arrives (a `mail` notification - see `notifications/store.ts`, which owns the
63
- * stack, its limit of three and the clock), and - while the tab
64
- * is in the background and the user has allowed it - a desktop notification with the same content, one per message however
65
- * many events name it. `announce()` is what `useMailLiveUpdates()`'s `onMessageCreated` calls; nothing else feeds it, so a
66
- * page load, a list refetch and a reconnect never announce anything.
67
- *
68
- * Nothing is ever asked of the browser on load: permission is requested only by `enableDesktop()`, from the offer in the
69
- * first pop-up, or from Settings. What the user answered is remembered in `localStorage` (see `newMailNotifications.ts`).
70
- */
71
- export function useNewMailNotifications({ mailboxes, mailboxFolders, open = defaultOpen }: UseNewMailNotificationsOptions): NewMailNotifications {
72
- const [permission, setPermission] = useState<DesktopPermission>("unsupported");
73
- const [offerDismissed, setOfferDismissed] = useState(true);
74
- const folders = useMemo(() => mailboxFolders.flatMap((entry) => entry.folders), [mailboxFolders]);
75
- const ownAddresses = useMemo(() => ownAddressesOf(mailboxes), [mailboxes]);
76
- const latestRef = useRef({ folders, ownAddresses, open });
77
- latestRef.current = { folders, ownAddresses, open };
78
- const announcedRef = useRef<Set<string>>(new Set());
79
- const desktopShownRef = useRef<number[]>([]);
80
-
81
- // The browser's own state is only read on the client, after hydration, so the server and first client render agree.
82
- useEffect(() => {
83
- setPermission(desktopPermission());
84
- setOfferDismissed(getDesktopOfferDismissed());
85
- }, []);
86
-
87
- const showDesktop = useCallback((notice: NewMailNotice) => {
88
- const now = Date.now();
89
- desktopShownRef.current = desktopShownRef.current.filter((at) => now - at < DESKTOP_BURST_WINDOW_MS);
90
- if (desktopShownRef.current.length >= DESKTOP_BURST_LIMIT) {
91
- return;
92
- }
93
- try {
94
- const notification = new Notification(noticeSender(notice), {
95
- body: [notice.subject, notice.preview].filter(Boolean).join("\n"),
96
- // One per message: a duplicate (another tab of this app, a re-delivered event) replaces instead of stacking.
97
- tag: notice.uid,
98
- });
99
- desktopShownRef.current.push(now);
100
- notification.onclick = () => {
101
- window.focus();
102
- notification.close();
103
- latestRef.current.open(notice.href);
104
- };
105
- } catch {
106
- // Some browsers refuse `new Notification()` outright (a mobile one wanting a service worker): the pop-up is enough.
107
- }
108
- }, []);
109
-
110
- const enableDesktop = useCallback(async () => {
111
- const answer = await requestDesktopPermission();
112
- setPermission(answer);
113
- // Answered either way, so the offer goes: on granted it has done its job, on denied it can't be made again.
114
- setDesktopOfferDismissed(true);
115
- setOfferDismissed(true);
116
- }, []);
117
-
118
- const declineDesktop = useCallback(() => {
119
- setDesktopOfferDismissed(true);
120
- setOfferDismissed(true);
121
- }, []);
122
-
123
- // The offer's current state and answers, for the stable `announce` below.
124
- const offerDesktop = permission === "default" && !offerDismissed;
125
- const offerRef = useRef({ offered: offerDesktop, enable: enableDesktop, decline: declineDesktop });
126
- offerRef.current = { offered: offerDesktop, enable: enableDesktop, decline: declineDesktop };
127
-
128
- const announce = useCallback(
129
- (message: Message) => {
130
- if (!getNotificationsEnabled() || announcedRef.current.has(message.uid)) {
131
- return;
132
- }
133
- const { folders: knownFolders, ownAddresses: own } = latestRef.current;
134
- if (!shouldAnnounce(message, { folders: knownFolders, ownAddresses: own })) {
135
- return;
136
- }
137
- announcedRef.current.add(message.uid);
138
- if (announcedRef.current.size > ANNOUNCED_LIMIT) {
139
- announcedRef.current.delete(announcedRef.current.values().next().value!);
140
- }
141
- const notice = noticeFor(message);
142
- const offer = offerRef.current;
143
- notify({
144
- id: `mail:${notice.uid}`,
145
- kind: "mail",
146
- title: notice.senderName || notice.senderAddress,
147
- subtitle: notice.senderName ? `<${notice.senderAddress}>` : undefined,
148
- message: notice.subject,
149
- preview: notice.preview || undefined,
150
- href: notice.href,
151
- timeoutMs: TOAST_DURATION_MS,
152
- // Actions make a notification sticky; a new-mail pop-up with the offer still goes by itself.
153
- sticky: false,
154
- // The offer is made once at a time: on a pop-up only while none of the pop-ups still showing carries it.
155
- ...(offer.offered && !getNotificationsSnapshot().visible.some((item) => item.kind === "mail" && item.actions.length > 0)
156
- ? {
157
- hint: "Get a desktop notification when mail arrives while this tab is in the background.",
158
- actions: [
159
- { label: "Turn on desktop notifications", onClick: () => void offer.enable() },
160
- { label: "Not now", onClick: offer.decline },
161
- ],
162
- }
163
- : {}),
164
- });
165
- if (desktopPermission() === "granted" && tabIsInBackground()) {
166
- showDesktop(notice);
167
- }
168
- },
169
- [showDesktop],
170
- );
171
-
172
- return {
173
- offerDesktop,
174
- enableDesktop,
175
- declineDesktop,
176
- announce,
177
- };
178
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+ import { useCallback, useEffect, useMemo, useRef, useState } from "react";
6
+ import type { Mailbox, Message } from "@rapidmx/react-shared/mail/mailApi.js";
7
+ import type { MailboxFolders } from "../components/mail/layout/MailShell.js";
8
+ import {
9
+ DesktopPermission,
10
+ NewMailNotice,
11
+ desktopPermission,
12
+ getDesktopOfferDismissed,
13
+ noticeFor,
14
+ noticeSender,
15
+ ownAddressesOf,
16
+ requestDesktopPermission,
17
+ setDesktopOfferDismissed,
18
+ shouldAnnounce,
19
+ } from "./newMailNotifications.js";
20
+ import { getNotificationsEnabled } from "../notifications/preferences.js";
21
+ import { getNotificationsSnapshot, notify } from "../notifications/store.js";
22
+
23
+ /** How long a new-mail pop-up stays before it goes by itself (while it is neither hovered nor focused, and the tab is in view). */
24
+ export const TOAST_DURATION_MS = 8_000;
25
+
26
+ /** At most this many desktop notifications in `DESKTOP_BURST_WINDOW_MS`: a flood of mail is a few notifications, not a hundred. */
27
+ export const DESKTOP_BURST_LIMIT = 5;
28
+ export const DESKTOP_BURST_WINDOW_MS = 30_000;
29
+
30
+ /** How many announced message uids are remembered, so an event delivered twice is announced once. */
31
+ const ANNOUNCED_LIMIT = 500;
32
+
33
+ export interface NewMailNotifications {
34
+ /** Whether the next pop-up should also offer to turn on desktop notifications: the browser can, has not been asked,
35
+ * and the user has not said "Not now". */
36
+ offerDesktop: boolean;
37
+ /** The offer's "Turn on desktop notifications": asks the browser. Must be called from a click. */
38
+ enableDesktop(): Promise<void>;
39
+ /** The offer's "Not now": remembered, so it is not made again. */
40
+ declineDesktop(): void;
41
+ /** Announces a message that just arrived - if it is worth it (see `shouldAnnounce()`) and pop-ups are on. Stable. */
42
+ announce(message: Message): void;
43
+ }
44
+
45
+ /** Whether the user is not looking at this tab: it is hidden, or another window has the focus. */
46
+ function tabIsInBackground(): boolean {
47
+ return document.visibilityState === "hidden" || !document.hasFocus();
48
+ }
49
+
50
+ export interface UseNewMailNotificationsOptions {
51
+ mailboxes: Mailbox[];
52
+ mailboxFolders: MailboxFolders[];
53
+ /** Opens a message from a desktop notification's click. Defaults to a plain navigation. */
54
+ open?: (href: string) => void;
55
+ }
56
+
57
+ function defaultOpen(href: string): void {
58
+ window.location.href = href;
59
+ }
60
+
61
+ /**
62
+ * New-mail announcements: an in-app pop-up for each message that arrives (a `mail` notification - see `notifications/store.ts`, which owns the
63
+ * stack, its limit of three and the clock), and - while the tab
64
+ * is in the background and the user has allowed it - a desktop notification with the same content, one per message however
65
+ * many events name it. `announce()` is what `useMailLiveUpdates()`'s `onMessageCreated` calls; nothing else feeds it, so a
66
+ * page load, a list refetch and a reconnect never announce anything.
67
+ *
68
+ * Nothing is ever asked of the browser on load: permission is requested only by `enableDesktop()`, from the offer in the
69
+ * first pop-up, or from Settings. What the user answered is remembered in `localStorage` (see `newMailNotifications.ts`).
70
+ */
71
+ export function useNewMailNotifications({ mailboxes, mailboxFolders, open = defaultOpen }: UseNewMailNotificationsOptions): NewMailNotifications {
72
+ const [permission, setPermission] = useState<DesktopPermission>("unsupported");
73
+ const [offerDismissed, setOfferDismissed] = useState(true);
74
+ const folders = useMemo(() => mailboxFolders.flatMap((entry) => entry.folders), [mailboxFolders]);
75
+ const ownAddresses = useMemo(() => ownAddressesOf(mailboxes), [mailboxes]);
76
+ const latestRef = useRef({ folders, ownAddresses, open });
77
+ latestRef.current = { folders, ownAddresses, open };
78
+ const announcedRef = useRef<Set<string>>(new Set());
79
+ const desktopShownRef = useRef<number[]>([]);
80
+
81
+ // The browser's own state is only read on the client, after hydration, so the server and first client render agree.
82
+ useEffect(() => {
83
+ setPermission(desktopPermission());
84
+ setOfferDismissed(getDesktopOfferDismissed());
85
+ }, []);
86
+
87
+ const showDesktop = useCallback((notice: NewMailNotice) => {
88
+ const now = Date.now();
89
+ desktopShownRef.current = desktopShownRef.current.filter((at) => now - at < DESKTOP_BURST_WINDOW_MS);
90
+ if (desktopShownRef.current.length >= DESKTOP_BURST_LIMIT) {
91
+ return;
92
+ }
93
+ try {
94
+ const notification = new Notification(noticeSender(notice), {
95
+ body: [notice.subject, notice.preview].filter(Boolean).join("\n"),
96
+ // One per message: a duplicate (another tab of this app, a re-delivered event) replaces instead of stacking.
97
+ tag: notice.uid,
98
+ });
99
+ desktopShownRef.current.push(now);
100
+ notification.onclick = () => {
101
+ window.focus();
102
+ notification.close();
103
+ latestRef.current.open(notice.href);
104
+ };
105
+ } catch {
106
+ // Some browsers refuse `new Notification()` outright (a mobile one wanting a service worker): the pop-up is enough.
107
+ }
108
+ }, []);
109
+
110
+ const enableDesktop = useCallback(async () => {
111
+ const answer = await requestDesktopPermission();
112
+ setPermission(answer);
113
+ // Answered either way, so the offer goes: on granted it has done its job, on denied it can't be made again.
114
+ setDesktopOfferDismissed(true);
115
+ setOfferDismissed(true);
116
+ }, []);
117
+
118
+ const declineDesktop = useCallback(() => {
119
+ setDesktopOfferDismissed(true);
120
+ setOfferDismissed(true);
121
+ }, []);
122
+
123
+ // The offer's current state and answers, for the stable `announce` below.
124
+ const offerDesktop = permission === "default" && !offerDismissed;
125
+ const offerRef = useRef({ offered: offerDesktop, enable: enableDesktop, decline: declineDesktop });
126
+ offerRef.current = { offered: offerDesktop, enable: enableDesktop, decline: declineDesktop };
127
+
128
+ const announce = useCallback(
129
+ (message: Message) => {
130
+ if (!getNotificationsEnabled() || announcedRef.current.has(message.uid)) {
131
+ return;
132
+ }
133
+ const { folders: knownFolders, ownAddresses: own } = latestRef.current;
134
+ if (!shouldAnnounce(message, { folders: knownFolders, ownAddresses: own })) {
135
+ return;
136
+ }
137
+ announcedRef.current.add(message.uid);
138
+ if (announcedRef.current.size > ANNOUNCED_LIMIT) {
139
+ announcedRef.current.delete(announcedRef.current.values().next().value!);
140
+ }
141
+ const notice = noticeFor(message);
142
+ const offer = offerRef.current;
143
+ notify({
144
+ id: `mail:${notice.uid}`,
145
+ kind: "mail",
146
+ title: notice.senderName || notice.senderAddress,
147
+ subtitle: notice.senderName ? `<${notice.senderAddress}>` : undefined,
148
+ message: notice.subject,
149
+ preview: notice.preview || undefined,
150
+ href: notice.href,
151
+ timeoutMs: TOAST_DURATION_MS,
152
+ // Actions make a notification sticky; a new-mail pop-up with the offer still goes by itself.
153
+ sticky: false,
154
+ // The offer is made once at a time: on a pop-up only while none of the pop-ups still showing carries it.
155
+ ...(offer.offered && !getNotificationsSnapshot().visible.some((item) => item.kind === "mail" && item.actions.length > 0)
156
+ ? {
157
+ hint: "Get a desktop notification when mail arrives while this tab is in the background.",
158
+ actions: [
159
+ { label: "Turn on desktop notifications", onClick: () => void offer.enable() },
160
+ { label: "Not now", onClick: offer.decline },
161
+ ],
162
+ }
163
+ : {}),
164
+ });
165
+ if (desktopPermission() === "granted" && tabIsInBackground()) {
166
+ showDesktop(notice);
167
+ }
168
+ },
169
+ [showDesktop],
170
+ );
171
+
172
+ return {
173
+ offerDesktop,
174
+ enableDesktop,
175
+ declineDesktop,
176
+ announce,
177
+ };
178
+ }