@rapidmx/web-client 0.15.1 → 0.16.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.
- package/README.md +373 -373
- package/apps/admin/branding/index.tsx +39 -39
- package/apps/admin/data-requests/index.tsx +482 -480
- package/apps/admin/domains/[uid].tsx +164 -164
- package/apps/admin/escrow-scopes/[uid].tsx +348 -348
- package/apps/admin/index.tsx +127 -124
- package/apps/admin/mailboxes/[uid].tsx +269 -224
- package/apps/admin/mailboxes/new/index.tsx +28 -28
- package/apps/admin/plugins/index.tsx +15 -15
- package/apps/admin/retention-policy/index.tsx +39 -39
- package/apps/admin/signing-certificates/index.tsx +343 -343
- package/apps/escrow/audit-log/index.tsx +196 -196
- package/apps/escrow/matters/[uid].tsx +621 -621
- package/apps/shared/auth/adminAccess.ts +99 -99
- package/apps/shared/components/admin/layout/AdminShell.tsx +378 -378
- package/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.tsx +238 -0
- package/apps/shared/components/admin/mailboxes/EscrowScopeCard.tsx +152 -152
- package/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.tsx +194 -0
- package/apps/shared/components/admin/settings/BrandingForm.tsx +423 -423
- package/apps/shared/components/admin/settings/EncryptionPolicyForm.tsx +119 -119
- package/apps/shared/components/admin/settings/MailboxCreateForm.tsx +50 -3
- package/apps/shared/components/admin/settings/MailboxPolicyForm.tsx +198 -198
- package/apps/shared/components/admin/settings/PluginsManager.tsx +1545 -1545
- package/apps/shared/components/admin/settings/RetentionPolicyForm.tsx +182 -182
- package/apps/shared/components/admin/setup/EscrowSetupStep.tsx +288 -288
- package/apps/shared/components/admin/setup/SetupWizard.tsx +444 -444
- package/apps/shared/components/admin/usePagedList.tsx +129 -129
- package/apps/shared/components/calendar/EventEditor.tsx +5 -10
- package/apps/shared/components/calendar/EventFormParts.tsx +16 -47
- package/apps/shared/components/calendar/EventModal.tsx +206 -206
- package/apps/shared/components/calendar/GuestInput.tsx +100 -0
- package/apps/shared/components/calendar/MonthView.tsx +185 -185
- package/apps/shared/components/calendar/RecurrenceEditor.tsx +227 -227
- package/apps/shared/components/calendar/RequestChangeForm.tsx +23 -54
- package/apps/shared/components/calendar/SplitDayView.tsx +144 -144
- package/apps/shared/components/calendar/TimeGridView.tsx +246 -246
- package/apps/shared/components/calendar/allDay.ts +124 -124
- package/apps/shared/components/calendar/eventForm.ts +2 -2
- package/apps/shared/components/calendar/eventFormat.ts +49 -22
- package/apps/shared/components/calendar/layout/CalendarShell.tsx +201 -200
- package/apps/shared/components/contacts/ContactForm.tsx +383 -383
- package/apps/shared/components/contacts/ContactsSidebar.tsx +1 -1
- package/apps/shared/components/contacts/ContactsToolbar.tsx +103 -98
- package/apps/shared/components/contacts/layout/ContactsShell.tsx +217 -216
- package/apps/shared/components/escrow/layout/EscrowShell.tsx +155 -155
- package/apps/shared/components/layout/AppShell.tsx +480 -480
- package/apps/shared/components/layout/FloatingActionButton.tsx +31 -0
- package/apps/shared/components/layout/KeyEnrollmentGate.tsx +398 -398
- package/apps/shared/components/layout/MailboxProvisioning.tsx +168 -168
- package/apps/shared/components/layout/ResponsiveToolbar.tsx +315 -315
- package/apps/shared/components/layout/ThemeSwitch.tsx +84 -84
- package/apps/shared/components/layout/UserMenu.tsx +439 -424
- package/apps/shared/components/mail/ConversationList.tsx +323 -323
- package/apps/shared/components/mail/ConversationThreadPane.tsx +612 -491
- package/apps/shared/components/mail/MailSelectionBar.tsx +236 -227
- package/apps/shared/components/mail/MessageDetailPane.tsx +1559 -1559
- package/apps/shared/components/mail/compose/ComposeContext.tsx +312 -312
- package/apps/shared/components/mail/compose/ComposeToolbar.tsx +422 -422
- package/apps/shared/components/mail/compose/ComposeWindow.tsx +1681 -1677
- package/apps/shared/components/mail/compose/RecipientInput.tsx +54 -11
- package/apps/shared/components/mail/compose/RichTextEditor.tsx +147 -147
- package/apps/shared/components/mail/compose/composeFlushRegistry.ts +60 -60
- package/apps/shared/components/mail/compose/quotedBody.ts +161 -161
- package/apps/shared/components/mail/layout/FolderBadgeChip.tsx +21 -0
- package/apps/shared/components/mail/layout/MailShell.tsx +137 -113
- package/apps/shared/components/mail/layout/SidebarSection.tsx +66 -0
- package/apps/shared/components/mail/reading/PendingMessageCard.tsx +68 -0
- package/apps/shared/components/mail/verificationSeals.ts +125 -125
- package/apps/shared/components/rules/RuleBuilder.tsx +311 -311
- package/apps/shared/components/settings/SigningCertificateCard.tsx +344 -344
- package/apps/shared/components/settings/layout/SettingsShell.tsx +255 -254
- package/apps/shared/components/tasks/TasksSidebar.tsx +1 -1
- package/apps/shared/components/tasks/layout/TasksShell.tsx +218 -217
- package/apps/shared/keyboard/GlobalShortcuts.tsx +51 -51
- package/apps/shared/keyboard/ShortcutProvider.tsx +62 -62
- package/apps/shared/keyboard/ShortcutsDialog.tsx +84 -84
- package/apps/shared/keyboard/dispatch.ts +124 -124
- package/apps/shared/keyboard/format.ts +89 -89
- package/apps/shared/keyboard/keymap.ts +114 -114
- package/apps/shared/keyboard/registry.ts +65 -65
- package/apps/shared/keyboard/targets.ts +79 -79
- package/apps/shared/mail/folderCounts.ts +17 -0
- package/apps/shared/mail/folderTree.ts +143 -143
- package/apps/shared/mail/listAllPages.ts +39 -39
- package/apps/shared/mail/newMailNotifications.ts +171 -171
- package/apps/shared/mail/outbox/outgoingReplies.ts +192 -0
- package/apps/shared/mail/outbox/sendJob.ts +19 -1
- package/apps/shared/mail/outbox/sendOutcomes.ts +13 -4
- package/apps/shared/mail/primaryMailbox.ts +71 -0
- package/apps/shared/mail/useCollapsedSections.ts +146 -0
- package/apps/shared/mail/useMailConnection.ts +205 -203
- package/apps/shared/mail/useMailLiveUpdates.ts +277 -277
- package/apps/shared/mail/useMarkMessageRead.ts +47 -47
- package/apps/shared/mail/useNewMailNotifications.ts +178 -178
- package/apps/shared/navigation/AppRouter.tsx +300 -300
- package/apps/shared/navigation/routerContext.tsx +83 -83
- package/apps/shared/notifications/store.ts +560 -560
- package/apps/shared/search/LocalIndexLifecycle.tsx +114 -114
- package/apps/shared/search/crossMailboxSearch.ts +169 -0
- package/apps/shared/search/localIndexBuilder.ts +481 -481
- package/apps/shared/signing/enrollmentStorage.ts +33 -33
- package/apps/shared/signing/enrollmentTracker.ts +385 -385
- package/apps/shared/signing/enrollmentView.ts +251 -251
- package/apps/shared/signing/useNow.ts +19 -19
- package/apps/shared/signing/useSigningEnrollmentWatcher.ts +90 -90
- package/apps/shared/styles/app.css +396 -386
- package/apps/www/calendar/index.tsx +578 -571
- package/apps/www/contacts/[uid].tsx +109 -109
- package/apps/www/contacts/index.tsx +6 -0
- package/apps/www/index.tsx +2847 -2479
- package/apps/www/messages/[uid].tsx +135 -135
- package/apps/www/settings/auto-reply/index.tsx +133 -133
- package/apps/www/settings/encryption/index.tsx +1287 -1287
- package/apps/www/settings/filters/[uid].tsx +176 -176
- package/apps/www/settings/filters/index.tsx +102 -102
- package/apps/www/settings/filters/new/index.tsx +140 -140
- package/apps/www/settings/labels/index.tsx +204 -204
- package/apps/www/settings/privacy/index.tsx +492 -492
- package/apps/www/settings/profile/index.tsx +248 -248
- package/apps/www/settings/read-receipts/index.tsx +147 -147
- package/apps/www/settings/sharing/index.tsx +256 -256
- package/apps/www/settings/signatures/[uid].tsx +172 -172
- package/apps/www/settings/signatures/index.tsx +88 -88
- package/apps/www/settings/signatures/new/index.tsx +135 -135
- package/apps/www/tasks/index.tsx +649 -649
- package/dist/apps/admin/data-requests/index.js +1 -1
- package/dist/apps/admin/index.js +2 -1
- package/dist/apps/admin/mailboxes/[uid].js +12 -2
- package/dist/apps/shared/components/admin/layout/AdminShell.js +2 -2
- package/dist/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.d.ts +35 -0
- package/dist/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.js +115 -0
- package/dist/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.d.ts +16 -0
- package/dist/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.js +92 -0
- package/dist/apps/shared/components/admin/settings/BrandingForm.js +3 -3
- package/dist/apps/shared/components/admin/settings/MailboxCreateForm.js +25 -3
- package/dist/apps/shared/components/calendar/EventEditor.js +5 -10
- package/dist/apps/shared/components/calendar/EventFormParts.d.ts +3 -2
- package/dist/apps/shared/components/calendar/EventFormParts.js +5 -16
- package/dist/apps/shared/components/calendar/GuestInput.d.ts +45 -0
- package/dist/apps/shared/components/calendar/GuestInput.js +30 -0
- package/dist/apps/shared/components/calendar/RequestChangeForm.js +11 -22
- package/dist/apps/shared/components/calendar/eventForm.d.ts +2 -2
- package/dist/apps/shared/components/calendar/eventFormat.d.ts +21 -8
- package/dist/apps/shared/components/calendar/eventFormat.js +50 -23
- package/dist/apps/shared/components/calendar/layout/CalendarShell.js +3 -2
- package/dist/apps/shared/components/contacts/ContactsSidebar.js +1 -1
- package/dist/apps/shared/components/contacts/ContactsToolbar.d.ts +3 -1
- package/dist/apps/shared/components/contacts/ContactsToolbar.js +4 -2
- package/dist/apps/shared/components/contacts/layout/ContactsShell.js +4 -3
- package/dist/apps/shared/components/layout/FloatingActionButton.d.ts +13 -0
- package/dist/apps/shared/components/layout/FloatingActionButton.js +9 -0
- package/dist/apps/shared/components/layout/UserMenu.d.ts +4 -1
- package/dist/apps/shared/components/layout/UserMenu.js +6 -5
- package/dist/apps/shared/components/mail/ConversationThreadPane.js +127 -22
- package/dist/apps/shared/components/mail/MailSelectionBar.d.ts +6 -1
- package/dist/apps/shared/components/mail/MailSelectionBar.js +3 -3
- package/dist/apps/shared/components/mail/compose/ComposeWindow.js +8 -4
- package/dist/apps/shared/components/mail/compose/RecipientInput.d.ts +21 -1
- package/dist/apps/shared/components/mail/compose/RecipientInput.js +18 -10
- package/dist/apps/shared/components/mail/layout/FolderBadgeChip.d.ts +6 -0
- package/dist/apps/shared/components/mail/layout/FolderBadgeChip.js +9 -0
- package/dist/apps/shared/components/mail/layout/MailShell.d.ts +5 -0
- package/dist/apps/shared/components/mail/layout/MailShell.js +64 -45
- package/dist/apps/shared/components/mail/layout/SidebarSection.d.ts +23 -0
- package/dist/apps/shared/components/mail/layout/SidebarSection.js +16 -0
- package/dist/apps/shared/components/mail/reading/PendingMessageCard.d.ts +14 -0
- package/dist/apps/shared/components/mail/reading/PendingMessageCard.js +16 -0
- package/dist/apps/shared/components/settings/layout/SettingsShell.js +6 -5
- package/dist/apps/shared/components/tasks/TasksSidebar.js +1 -1
- package/dist/apps/shared/components/tasks/layout/TasksShell.js +4 -3
- package/dist/apps/shared/mail/folderCounts.d.ts +10 -0
- package/dist/apps/shared/mail/folderCounts.js +12 -0
- package/dist/apps/shared/mail/outbox/outgoingReplies.d.ts +80 -0
- package/dist/apps/shared/mail/outbox/outgoingReplies.js +131 -0
- package/dist/apps/shared/mail/outbox/sendJob.d.ts +5 -1
- package/dist/apps/shared/mail/outbox/sendJob.js +14 -1
- package/dist/apps/shared/mail/outbox/sendOutcomes.js +13 -4
- package/dist/apps/shared/mail/primaryMailbox.d.ts +29 -0
- package/dist/apps/shared/mail/primaryMailbox.js +61 -0
- package/dist/apps/shared/mail/useCollapsedSections.d.ts +32 -0
- package/dist/apps/shared/mail/useCollapsedSections.js +110 -0
- package/dist/apps/shared/mail/useMailConnection.js +3 -1
- package/dist/apps/shared/search/crossMailboxSearch.d.ts +72 -0
- package/dist/apps/shared/search/crossMailboxSearch.js +136 -0
- package/dist/apps/shared/styles/app.css +396 -386
- package/dist/apps/www/calendar/index.js +3 -2
- package/dist/apps/www/contacts/index.js +3 -1
- package/dist/apps/www/index.js +426 -189
- package/package.json +2 -2
|
@@ -9,6 +9,7 @@ import { loadOriginalMessage } from "../../components/mail/compose/quotedBody.js
|
|
|
9
9
|
import { notifyApiError } from "../../notifications/apiErrors.js";
|
|
10
10
|
import { dismiss, notify } from "../../notifications/store.js";
|
|
11
11
|
import { beginPendingSend, finishPendingSend, setPendingStage } from "./pendingSends.js";
|
|
12
|
+
import { failOutgoing, forgetOutgoing, markOutgoingSending, markOutgoingSent } from "./outgoingReplies.js";
|
|
12
13
|
import { openComposeFromOutside } from "./composeBridge.js";
|
|
13
14
|
import { describeMessage, forgetRetainedRequest, notifySent, openDraftFromRequest, retainedRequest } from "./sendJob.js";
|
|
14
15
|
|
|
@@ -45,6 +46,8 @@ function escapeHtml(text: string): string {
|
|
|
45
46
|
async function openFailedDraft(event: SendEvent): Promise<void> {
|
|
46
47
|
try {
|
|
47
48
|
const moved = await moveBackToDrafts(event.uid, event.mailboxUid ?? "");
|
|
49
|
+
// Back in Drafts it is no longer a message on its way in its conversation.
|
|
50
|
+
forgetOutgoing(event.uid);
|
|
48
51
|
const request = retainedRequest(event.uid);
|
|
49
52
|
if (request) {
|
|
50
53
|
openDraftFromRequest({ ...request, draft: moved });
|
|
@@ -90,6 +93,7 @@ async function retryFailed(event: SendEvent): Promise<void> {
|
|
|
90
93
|
return;
|
|
91
94
|
}
|
|
92
95
|
dismiss(failedId(event.uid));
|
|
96
|
+
markOutgoingSending(event.uid);
|
|
93
97
|
try {
|
|
94
98
|
setPendingStage(event.uid, "queuing");
|
|
95
99
|
const result = await queueMessageSend(event.uid);
|
|
@@ -108,6 +112,8 @@ export function handleSendEvent(event: SendEvent): void {
|
|
|
108
112
|
if (event.action === "send-succeeded") {
|
|
109
113
|
dismiss(retryId(event.uid));
|
|
110
114
|
dismiss(failedId(event.uid));
|
|
115
|
+
// The conversation on screen swaps the message it drew for the Sent Items copy (a message this tab did not send has nothing drawn).
|
|
116
|
+
markOutgoingSent(event.uid);
|
|
111
117
|
// The server reports every message it relays, scheduled ones from long ago included: only a message this tab queued in the background is
|
|
112
118
|
// worth a confirmation (several are one pop-up counting up). Anything else - a send-later message going out, another tab's send - is quiet.
|
|
113
119
|
if (retainedRequest(event.uid)) {
|
|
@@ -132,15 +138,18 @@ export function handleSendEvent(event: SendEvent): void {
|
|
|
132
138
|
return;
|
|
133
139
|
}
|
|
134
140
|
dismiss(retryId(event.uid));
|
|
141
|
+
const actions = [
|
|
142
|
+
{ label: "Retry", onClick: () => void retryFailed(event) },
|
|
143
|
+
{ label: "Open draft", onClick: () => void openFailedDraft(event) },
|
|
144
|
+
];
|
|
135
145
|
notify({
|
|
136
146
|
id: failedId(event.uid),
|
|
137
147
|
kind: "error",
|
|
138
148
|
title: "This message wasn't sent",
|
|
139
149
|
message: `${what}: ${failure.message}`,
|
|
140
150
|
details: failure.lines,
|
|
141
|
-
actions
|
|
142
|
-
{ label: "Retry", onClick: () => void retryFailed(event) },
|
|
143
|
-
{ label: "Open draft", onClick: () => void openFailedDraft(event) },
|
|
144
|
-
],
|
|
151
|
+
actions,
|
|
145
152
|
});
|
|
153
|
+
// The conversation on screen shows the same failure under the message, with the same ways out.
|
|
154
|
+
failOutgoing(event.uid, failure.message, actions);
|
|
146
155
|
}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
/**
|
|
6
|
+
* Which of the caller's mailboxes is "theirs", and the order every list of them is shown in - the one definition the mail, calendar,
|
|
7
|
+
* contacts, tasks and settings shells, the compose window's From picker and the account menu all use, so a shared mailbox that happens
|
|
8
|
+
* to sort first (or that the server lists first) is never the one an app opens on or a picker defaults to.
|
|
9
|
+
*
|
|
10
|
+
* An **own** mailbox is one whose `ownerUserUid` is the signed-in user.
|
|
11
|
+
*
|
|
12
|
+
* A **shared** mailbox is any other one the caller merely has access to: an ownerless (shared/organization) mailbox, or a delegate grant on
|
|
13
|
+
* somebody else's (`isSharedWithMe()`).
|
|
14
|
+
*
|
|
15
|
+
* The **primary** mailbox is the caller's own mailbox - the earliest created, when they own several - else the first mailbox that isn't
|
|
16
|
+
* shared, else the first one there is.
|
|
17
|
+
*
|
|
18
|
+
* `orderMailboxes()` puts the primary mailbox first, then the caller's other mailboxes, then the shared ones, each group alphabetical.
|
|
19
|
+
*/
|
|
20
|
+
import { isSharedWithMe, type Mailbox } from "@rapidmx/react-shared/mail/mailApi.js";
|
|
21
|
+
|
|
22
|
+
/** Whether `mailbox` is the signed-in user's own. */
|
|
23
|
+
export function isOwnMailbox(mailbox: Mailbox, userUid: string | undefined): boolean {
|
|
24
|
+
return !!userUid && mailbox.ownerUserUid === userUid;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/** Whether `mailbox` is one the caller only has access to (an ownerless one, or somebody else's shared with them). */
|
|
28
|
+
export function isSharedMailbox(mailbox: Mailbox, userUid: string | undefined): boolean {
|
|
29
|
+
if (isOwnMailbox(mailbox, userUid)) {
|
|
30
|
+
return false;
|
|
31
|
+
}
|
|
32
|
+
// The server says how the caller reaches a mailbox (`accessRole`); an older one doesn't, and then a mailbox that isn't the known
|
|
33
|
+
// caller's own is somebody else's.
|
|
34
|
+
return mailbox.accessRole ? isSharedWithMe(mailbox) : !!userUid || isSharedWithMe(mailbox);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
function createdAt(mailbox: Mailbox): number {
|
|
38
|
+
const time = Date.parse(mailbox.dateCreated);
|
|
39
|
+
return Number.isNaN(time) ? Infinity : time;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/** The caller's own mailboxes, earliest created first (the given order among ones created together). */
|
|
43
|
+
export function ownMailboxes(mailboxes: readonly Mailbox[], userUid: string | undefined): Mailbox[] {
|
|
44
|
+
return mailboxes.filter((mailbox) => isOwnMailbox(mailbox, userUid)).sort((a, b) => createdAt(a) - createdAt(b));
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/** The mailbox to open and to default pickers to: see the rules at the top of this file. `undefined` only for no mailboxes at all. */
|
|
48
|
+
export function primaryMailbox(mailboxes: readonly Mailbox[], userUid: string | undefined): Mailbox | undefined {
|
|
49
|
+
return ownMailboxes(mailboxes, userUid)[0] ?? mailboxes.find((mailbox) => !isSharedMailbox(mailbox, userUid)) ?? mailboxes[0];
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/** `primaryMailbox()`'s uid. */
|
|
53
|
+
export function primaryMailboxUid(mailboxes: readonly Mailbox[], userUid: string | undefined): string | undefined {
|
|
54
|
+
return primaryMailbox(mailboxes, userUid)?.uid;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/** `mailboxes` in display order: the primary mailbox, then the caller's other mailboxes, then the shared ones - each group by name. Never
|
|
58
|
+
* changes the list it is given. */
|
|
59
|
+
export function orderMailboxes(mailboxes: readonly Mailbox[], userUid: string | undefined): Mailbox[] {
|
|
60
|
+
const primary = primaryMailbox(mailboxes, userUid);
|
|
61
|
+
const rank = (mailbox: Mailbox) => (mailbox === primary ? 0 : isSharedMailbox(mailbox, userUid) ? 2 : 1);
|
|
62
|
+
// Tolerates a mailbox that says nothing of its name or address (an older server's, or a test fixture's).
|
|
63
|
+
const name = (mailbox: Mailbox) => mailbox.displayName ?? "";
|
|
64
|
+
const address = (mailbox: Mailbox) => mailbox.primarySmtpAddress ?? "";
|
|
65
|
+
return [...mailboxes].sort(
|
|
66
|
+
(a, b) =>
|
|
67
|
+
rank(a) - rank(b) ||
|
|
68
|
+
name(a).localeCompare(name(b), undefined, { sensitivity: "base" }) ||
|
|
69
|
+
address(a).localeCompare(address(b)),
|
|
70
|
+
);
|
|
71
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
/**
|
|
6
|
+
* Which of the Mail sidebar's sections - "All mailboxes" and one per mailbox - are open, and the reader's own choices about it.
|
|
7
|
+
*
|
|
8
|
+
* A section the reader has never touched follows the **default rule**: "All mailboxes" and the signed-in user's primary mailbox
|
|
9
|
+
* (`primaryMailboxUid()`) are open, every other mailbox is collapsed - so a mailbox that is newly shared with them arrives closed.
|
|
10
|
+
* Once they toggle a section the choice is remembered for that section, replacing the default, whatever the default later says.
|
|
11
|
+
*
|
|
12
|
+
* **Every** section can be collapsed, the one holding the open folder and the primary mailbox included, and a collapsed one stays collapsed
|
|
13
|
+
* across reloads even while its own folder is the selected one: the toggle always toggles and always remembers.
|
|
14
|
+
*
|
|
15
|
+
* The one exception is *navigation*: when the section holding the open folder (`activeId`) **changes** - the reader picks a folder in
|
|
16
|
+
* another section, or a search result or a link lands in one - that section is shown open, so the folder just highlighted is not hidden
|
|
17
|
+
* from them. That is an in-memory override of this page view, never written as the reader's choice: it does not apply to the first
|
|
18
|
+
* section the page resolves (a reload lands on whatever was chosen), and it ends when they navigate to yet another section. Toggling
|
|
19
|
+
* the section it opened forgets the override and remembers the reader's new choice (the opposite of what was showing).
|
|
20
|
+
*
|
|
21
|
+
* The choices are kept per signed-in user, per device, in `localStorage` (`rapidmx:mail-sidebar-collapsed:<userUid>`), the way
|
|
22
|
+
* `listPreferences.ts` keeps the list arrangement: `{ "<section id>": <collapsed> }`. Every read tolerates a missing, corrupt or
|
|
23
|
+
* blocked store (and keeps only the booleans of a partly-valid one), every write swallows its failure - a blocked store only means the
|
|
24
|
+
* choices do not survive a reload.
|
|
25
|
+
*/
|
|
26
|
+
import { useCallback, useMemo, useRef, useState } from "react";
|
|
27
|
+
|
|
28
|
+
const STORAGE_KEY_PREFIX = "rapidmx:mail-sidebar-collapsed:";
|
|
29
|
+
|
|
30
|
+
/** The id of the "All mailboxes" section; every mailbox's section is its uid. */
|
|
31
|
+
export const ALL_MAILBOXES_SECTION = "all";
|
|
32
|
+
|
|
33
|
+
/** What the reader chose per section: `true` collapsed, `false` open. A section that is not there follows the default rule. */
|
|
34
|
+
export type SectionChoices = Record<string, boolean>;
|
|
35
|
+
|
|
36
|
+
/** The `localStorage` key one user's choices are kept under. */
|
|
37
|
+
export function collapsedSectionsKey(userUid: string): string {
|
|
38
|
+
return `${STORAGE_KEY_PREFIX}${userUid}`;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/** Reads a user's stored choices - none for an unknown user, a missing entry, unparsable JSON, something that is not an object, or a store that throws. */
|
|
42
|
+
export function readSectionChoices(userUid: string | undefined): SectionChoices {
|
|
43
|
+
if (!userUid) {
|
|
44
|
+
return {};
|
|
45
|
+
}
|
|
46
|
+
let stored: unknown;
|
|
47
|
+
try {
|
|
48
|
+
const raw = localStorage.getItem(collapsedSectionsKey(userUid));
|
|
49
|
+
stored = raw === null ? null : JSON.parse(raw);
|
|
50
|
+
} catch {
|
|
51
|
+
return {};
|
|
52
|
+
}
|
|
53
|
+
if (!stored || typeof stored !== "object" || Array.isArray(stored)) {
|
|
54
|
+
return {};
|
|
55
|
+
}
|
|
56
|
+
// Only what is a real choice: a value that is not a boolean falls back to the default for its own section, not for all of them.
|
|
57
|
+
return Object.fromEntries(Object.entries(stored).filter((entry): entry is [string, boolean] => typeof entry[1] === "boolean"));
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/** Stores a user's choices. Best-effort - see this module's own doc comment. */
|
|
61
|
+
export function writeSectionChoices(userUid: string | undefined, choices: SectionChoices): void {
|
|
62
|
+
if (!userUid) {
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
try {
|
|
66
|
+
localStorage.setItem(collapsedSectionsKey(userUid), JSON.stringify(choices));
|
|
67
|
+
} catch {
|
|
68
|
+
// Best-effort - see this module's own doc comment.
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/** Whether a section is open by the reader's choice, or by the default rule where they have made none (a navigation's override not considered). */
|
|
73
|
+
export function sectionChosenOpen(id: string, choices: SectionChoices, primaryUid: string | undefined): boolean {
|
|
74
|
+
const collapsed = choices[id];
|
|
75
|
+
return collapsed === undefined ? id === ALL_MAILBOXES_SECTION || id === primaryUid : !collapsed;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export interface SidebarSectionsOptions {
|
|
79
|
+
/** The signed-in user, whose choices these are; `undefined` keeps them for this page view only. */
|
|
80
|
+
userUid: string | undefined;
|
|
81
|
+
/** The user's primary mailbox, which - with "All mailboxes" - is open until they choose otherwise. */
|
|
82
|
+
primaryUid: string | undefined;
|
|
83
|
+
/**
|
|
84
|
+
* The section holding the folder that is open: `ALL_MAILBOXES_SECTION` for an aggregate view, else that mailbox's uid; `undefined`
|
|
85
|
+
* while that is not known yet (the address not read, the mailboxes not loaded). Moving from one section to another opens the new one
|
|
86
|
+
* (see this module's doc comment); the first section that becomes known does not.
|
|
87
|
+
*/
|
|
88
|
+
activeId: string | undefined;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export interface SidebarSections {
|
|
92
|
+
/** Whether the section shows its folders. */
|
|
93
|
+
isExpanded: (id: string) => boolean;
|
|
94
|
+
/** Opens a collapsed section, collapses an open one, and remembers it as the reader's choice. */
|
|
95
|
+
toggle: (id: string) => void;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
/** See this module's doc comment. */
|
|
99
|
+
export function useSidebarSections({ userUid, primaryUid, activeId }: SidebarSectionsOptions): SidebarSections {
|
|
100
|
+
const [loaded, setLoaded] = useState(() => ({ userUid, choices: readSectionChoices(userUid) }));
|
|
101
|
+
let current = loaded;
|
|
102
|
+
if (loaded.userUid !== userUid) {
|
|
103
|
+
// Another user signed in on this page: theirs are not the last one's choices.
|
|
104
|
+
current = { userUid, choices: readSectionChoices(userUid) };
|
|
105
|
+
setLoaded(current);
|
|
106
|
+
}
|
|
107
|
+
// The section the last navigation opened, if any: derived while rendering from the change of `activeId` (no effect, so the section is
|
|
108
|
+
// already open in the render that highlights its folder). A first `activeId` (from undefined) is not a navigation.
|
|
109
|
+
const [nav, setNav] = useState<{ activeId: string | undefined; opened: string | undefined }>({ activeId, opened: undefined });
|
|
110
|
+
let currentNav = nav;
|
|
111
|
+
if (nav.activeId !== activeId) {
|
|
112
|
+
currentNav = { activeId, opened: nav.activeId === undefined ? undefined : activeId };
|
|
113
|
+
setNav(currentNav);
|
|
114
|
+
}
|
|
115
|
+
// Kept in step with what was last rendered, and moved on by a toggle at once, so two toggles before a re-render both count.
|
|
116
|
+
const choicesRef = useRef(current.choices);
|
|
117
|
+
choicesRef.current = current.choices;
|
|
118
|
+
const openedRef = useRef(currentNav.opened);
|
|
119
|
+
openedRef.current = currentNav.opened;
|
|
120
|
+
|
|
121
|
+
const toggle = useCallback(
|
|
122
|
+
(id: string) => {
|
|
123
|
+
const expanded = openedRef.current === id || sectionChosenOpen(id, choicesRef.current, primaryUid);
|
|
124
|
+
const next = { ...choicesRef.current, [id]: expanded };
|
|
125
|
+
choicesRef.current = next;
|
|
126
|
+
setLoaded({ userUid, choices: next });
|
|
127
|
+
writeSectionChoices(userUid, next);
|
|
128
|
+
if (openedRef.current === id) {
|
|
129
|
+
// The reader's own choice replaces the override that had opened it.
|
|
130
|
+
openedRef.current = undefined;
|
|
131
|
+
setNav({ activeId, opened: undefined });
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
[activeId, primaryUid, userUid],
|
|
135
|
+
);
|
|
136
|
+
|
|
137
|
+
const choices = current.choices;
|
|
138
|
+
const opened = currentNav.opened;
|
|
139
|
+
return useMemo(
|
|
140
|
+
() => ({
|
|
141
|
+
isExpanded: (id: string) => id === opened || sectionChosenOpen(id, choices, primaryUid),
|
|
142
|
+
toggle,
|
|
143
|
+
}),
|
|
144
|
+
[opened, choices, primaryUid, toggle],
|
|
145
|
+
);
|
|
146
|
+
}
|