@rapidmx/web-client 0.6.0 → 0.8.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 (79) hide show
  1. package/apps/shared/components/admin/settings/BrandingForm.tsx +398 -385
  2. package/apps/shared/components/admin/settings/EncryptionPolicyForm.tsx +119 -112
  3. package/apps/shared/components/admin/settings/MailboxPolicyForm.tsx +198 -152
  4. package/apps/shared/components/admin/settings/PluginsManager.tsx +1288 -1235
  5. package/apps/shared/components/admin/settings/RetentionPolicyForm.tsx +9 -1
  6. package/apps/shared/components/admin/setup/EscrowSetupStep.tsx +288 -290
  7. package/apps/shared/components/admin/setup/SetupWizard.tsx +443 -416
  8. package/apps/shared/components/layout/AppShell.tsx +288 -288
  9. package/apps/shared/components/mail/ConversationList.tsx +225 -33
  10. package/apps/shared/components/mail/ConversationThreadPane.tsx +434 -216
  11. package/apps/shared/components/mail/MailListToolbar.tsx +265 -0
  12. package/apps/shared/components/mail/MailSelectionBar.tsx +222 -0
  13. package/apps/shared/components/mail/MenuButton.tsx +384 -0
  14. package/apps/shared/components/mail/MessageDetailPane.tsx +280 -215
  15. package/apps/shared/components/mail/MoveToFolderDialog.tsx +263 -0
  16. package/apps/shared/components/mail/compose/ComposeContext.tsx +29 -2
  17. package/apps/shared/components/mail/compose/ComposeWindow.tsx +1700 -1652
  18. package/apps/shared/components/mail/compose/RecipientInput.tsx +356 -0
  19. package/apps/shared/components/mail/compose/RichTextEditor.tsx +38 -3
  20. package/apps/shared/components/mail/compose/quotedBody.ts +100 -0
  21. package/apps/shared/components/mail/compose/recipients.ts +104 -0
  22. package/apps/shared/components/mail/labelMenu.tsx +278 -0
  23. package/apps/shared/components/mail/layout/MailShell.tsx +445 -420
  24. package/apps/shared/components/mail/listPreferences.ts +228 -0
  25. package/apps/shared/components/settings/layout/SettingsShell.tsx +0 -1
  26. package/apps/shared/styles/app.css +28 -5
  27. package/apps/www/index.tsx +1854 -1314
  28. package/apps/www/messages/[uid].tsx +5 -4
  29. package/dist/apps/shared/components/admin/settings/BrandingForm.d.ts +7 -3
  30. package/dist/apps/shared/components/admin/settings/BrandingForm.js +6 -5
  31. package/dist/apps/shared/components/admin/settings/EncryptionPolicyForm.d.ts +4 -1
  32. package/dist/apps/shared/components/admin/settings/EncryptionPolicyForm.js +2 -2
  33. package/dist/apps/shared/components/admin/settings/MailboxPolicyForm.d.ts +9 -2
  34. package/dist/apps/shared/components/admin/settings/MailboxPolicyForm.js +20 -4
  35. package/dist/apps/shared/components/admin/settings/PluginsManager.d.ts +8 -1
  36. package/dist/apps/shared/components/admin/settings/PluginsManager.js +33 -14
  37. package/dist/apps/shared/components/admin/settings/RetentionPolicyForm.d.ts +4 -1
  38. package/dist/apps/shared/components/admin/settings/RetentionPolicyForm.js +2 -2
  39. package/dist/apps/shared/components/admin/setup/EscrowSetupStep.js +1 -1
  40. package/dist/apps/shared/components/admin/setup/SetupWizard.js +14 -10
  41. package/dist/apps/shared/components/mail/ConversationList.d.ts +42 -6
  42. package/dist/apps/shared/components/mail/ConversationList.js +84 -10
  43. package/dist/apps/shared/components/mail/ConversationThreadPane.d.ts +52 -13
  44. package/dist/apps/shared/components/mail/ConversationThreadPane.js +217 -60
  45. package/dist/apps/shared/components/mail/MailListToolbar.d.ts +55 -0
  46. package/dist/apps/shared/components/mail/MailListToolbar.js +149 -0
  47. package/dist/apps/shared/components/mail/MailSelectionBar.d.ts +59 -0
  48. package/dist/apps/shared/components/mail/MailSelectionBar.js +48 -0
  49. package/dist/apps/shared/components/mail/MenuButton.d.ts +71 -0
  50. package/dist/apps/shared/components/mail/MenuButton.js +211 -0
  51. package/dist/apps/shared/components/mail/MessageDetailPane.d.ts +27 -19
  52. package/dist/apps/shared/components/mail/MessageDetailPane.js +126 -129
  53. package/dist/apps/shared/components/mail/MoveToFolderDialog.d.ts +57 -0
  54. package/dist/apps/shared/components/mail/MoveToFolderDialog.js +138 -0
  55. package/dist/apps/shared/components/mail/compose/ComposeContext.d.ts +16 -1
  56. package/dist/apps/shared/components/mail/compose/ComposeContext.js +3 -1
  57. package/dist/apps/shared/components/mail/compose/ComposeWindow.js +52 -20
  58. package/dist/apps/shared/components/mail/compose/RecipientInput.d.ts +36 -0
  59. package/dist/apps/shared/components/mail/compose/RecipientInput.js +203 -0
  60. package/dist/apps/shared/components/mail/compose/RichTextEditor.d.ts +10 -1
  61. package/dist/apps/shared/components/mail/compose/RichTextEditor.js +21 -3
  62. package/dist/apps/shared/components/mail/compose/quotedBody.d.ts +37 -0
  63. package/dist/apps/shared/components/mail/compose/quotedBody.js +85 -0
  64. package/dist/apps/shared/components/mail/compose/recipients.d.ts +24 -0
  65. package/dist/apps/shared/components/mail/compose/recipients.js +87 -0
  66. package/dist/apps/shared/components/mail/labelMenu.d.ts +97 -0
  67. package/dist/apps/shared/components/mail/labelMenu.js +134 -0
  68. package/dist/apps/shared/components/mail/layout/MailShell.d.ts +8 -0
  69. package/dist/apps/shared/components/mail/layout/MailShell.js +15 -3
  70. package/dist/apps/shared/components/mail/listPreferences.d.ts +101 -0
  71. package/dist/apps/shared/components/mail/listPreferences.js +186 -0
  72. package/dist/apps/shared/components/settings/layout/SettingsShell.js +0 -1
  73. package/dist/apps/shared/styles/app.css +28 -5
  74. package/dist/apps/www/index.js +506 -112
  75. package/dist/apps/www/messages/[uid].js +2 -3
  76. package/package.json +2 -2
  77. package/apps/www/settings/focused-inbox/index.tsx +0 -150
  78. package/dist/apps/www/settings/focused-inbox/index.d.ts +0 -4
  79. package/dist/apps/www/settings/focused-inbox/index.js +0 -71
@@ -1,416 +1,443 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
- import React, { FormEvent, useEffect, useRef, useState } from "react";
6
- import { ApiRequestError } from "@rapidmx/react-shared/util/api.js";
7
- import { getRetentionPolicy } from "@rapidmx/react-shared/admin/retentionPolicyApi.js";
8
- import { getMailboxPolicy } from "@rapidmx/react-shared/admin/mailboxPolicyApi.js";
9
- import { createDomain, Domain, listDomains } from "@rapidmx/react-shared/admin/domainsApi.js";
10
- import { completeSetup, getSetupStatus, saveSetupStep, SetupStatus } from "@rapidmx/react-shared/admin/setupApi.js";
11
- import { getBranding } from "@rapidmx/react-shared/branding/brandingApi.js";
12
- import { EncryptionPolicy, getEncryptionPolicy } from "@rapidmx/react-shared/crypto/keyvaultApi.js";
13
- import { listMailboxes, Mailbox } from "@rapidmx/react-shared/mail/mailApi.js";
14
- import Alert from "@rapidmx/react-shared/components/feedback/Alert.js";
15
- import Button from "@rapidmx/react-shared/components/buttons/Button.js";
16
- import FormField from "@rapidmx/react-shared/components/forms/FormField.js";
17
- import Modal from "@rapidmx/react-shared/components/overlays/Modal.js";
18
- import BrandingForm from "../settings/BrandingForm.js";
19
- import DomainDnsSetup from "../settings/DomainDnsSetup.js";
20
- import EncryptionPolicyForm, { isEncryptionEnabled } from "../settings/EncryptionPolicyForm.js";
21
- import LoadedSettingsForm from "../settings/LoadedSettingsForm.js";
22
- import MailboxCreateForm from "../settings/MailboxCreateForm.js";
23
- import MailboxPolicyForm from "../settings/MailboxPolicyForm.js";
24
- import PluginsManager from "../settings/PluginsManager.js";
25
- import RetentionPolicyForm from "../settings/RetentionPolicyForm.js";
26
- import EscrowSetupStep from "./EscrowSetupStep.js";
27
-
28
- const INPUT_CLASS =
29
- "w-full text-sm py-2.5 px-3 border border-border rounded-sm bg-surface text-text focus:outline-none focus:border-primary";
30
-
31
- export const SETUP_STEPS = [
32
- { id: "plugins", title: "Plugins", intro: "Choose which protocols and features this server runs. The recommended plugins are already installed." },
33
- { id: "domain", title: "Domain", intro: "Add the domain this server receives mail for, then publish the DNS records below." },
34
- { id: "settings", title: "Server settings", intro: "Set the rules for encryption, how long mail is kept, and new mailboxes." },
35
- { id: "escrow", title: "Escrow", intro: "Decide whether encrypted mail can be recovered by a trusted group of holders." },
36
- { id: "branding", title: "Branding", intro: "Make the sign-in page and apps look like your organization." },
37
- { id: "mailboxes", title: "Mailboxes", intro: "Create the first mailboxes, starting with your own." },
38
- ] as const;
39
-
40
- export type SetupStepId = (typeof SETUP_STEPS)[number]["id"];
41
-
42
- function isStepId(value: string | undefined): value is SetupStepId {
43
- return SETUP_STEPS.some((step) => step.id === value);
44
- }
45
-
46
- function errorMessage(err: unknown, fallback: string): string {
47
- return err instanceof ApiRequestError ? err.message : fallback;
48
- }
49
-
50
- export interface SetupWizardProps {
51
- userUid: string;
52
- }
53
-
54
- /**
55
- * The first-run setup wizard. Each step saves as the administrator works through it; the wizard itself only records
56
- * which step they're on (so leaving and coming back resumes there) and, at the end, that setup is finished. Every step
57
- * except the domain can be passed over and configured later from the admin console.
58
- */
59
- export default function SetupWizard({ userUid }: SetupWizardProps) {
60
- const [step, setStep] = useState<SetupStepId | null>(null);
61
- const [status, setStatus] = useState<SetupStatus | undefined>();
62
- const [domains, setDomains] = useState<Domain[]>([]);
63
- const [domainsError, setDomainsError] = useState<string | null>(null);
64
- const [encryption, setEncryption] = useState<EncryptionPolicy | null>(null);
65
- const [finishing, setFinishing] = useState(false);
66
- const [error, setError] = useState<string | null>(null);
67
- /** Which of the settings step's forms have edits that haven't been saved. */
68
- const [unsaved, setUnsaved] = useState<Record<string, boolean>>({});
69
- /** The step the administrator asked to go to while the settings step had unsaved edits. */
70
- const [leavingTo, setLeavingTo] = useState<SetupStepId | null>(null);
71
- const [progressFailed, setProgressFailed] = useState(false);
72
- /** Step saves run one at a time, and only the latest step still waiting is saved. */
73
- const progress = useRef<{ running: Promise<void> | null; next: SetupStepId | null }>({ running: null, next: null });
74
-
75
- function loadDomains(): Promise<void> {
76
- return listDomains({ limit: 25 })
77
- .then((list) => {
78
- setDomains(list);
79
- setDomainsError(null);
80
- })
81
- .catch((err) => setDomainsError(errorMessage(err, "Could not load your domains.")));
82
- }
83
-
84
- useEffect(() => {
85
- void Promise.all([getSetupStatus().catch(() => undefined), loadDomains()]).then(([loaded]) => {
86
- setStatus(loaded);
87
- setStep(isStepId(loaded?.currentStep) ? loaded.currentStep : "plugins");
88
- });
89
- }, []);
90
-
91
- useEffect(() => {
92
- if (step === "escrow" || step === "settings") {
93
- getEncryptionPolicy()
94
- .then(setEncryption)
95
- .catch(() => setEncryption(null));
96
- }
97
- }, [step]);
98
-
99
- if (step === null) {
100
- return <p className="text-sm text-text-muted">Loading&hellip;</p>;
101
- }
102
-
103
- const index = SETUP_STEPS.findIndex((s) => s.id === step);
104
- const current = SETUP_STEPS[index];
105
- const last = index === SETUP_STEPS.length - 1;
106
-
107
- /** Records the step the administrator is on. Progress is a convenience for resuming, so a failure is only noted. */
108
- function saveProgress(next: SetupStepId) {
109
- const queue = progress.current;
110
- queue.next = next;
111
- if (queue.running) {
112
- return;
113
- }
114
- queue.running = (async () => {
115
- while (queue.next) {
116
- const target: SetupStepId = queue.next;
117
- queue.next = null;
118
- try {
119
- await saveSetupStep(target);
120
- setProgressFailed(false);
121
- } catch (err) {
122
- console.warn("Could not save setup progress", err);
123
- setProgressFailed(true);
124
- }
125
- }
126
- queue.running = null;
127
- })();
128
- }
129
-
130
- function goTo(next: SetupStepId) {
131
- setError(null);
132
- setLeavingTo(null);
133
- setUnsaved({});
134
- setStep(next);
135
- saveProgress(next);
136
- window.scrollTo?.(0, 0);
137
- }
138
-
139
- /** Goes to `next`, first asking whether to discard any unsaved server settings. */
140
- function requestGoTo(next: SetupStepId) {
141
- // Going to the step already shown would clear the unsaved-edit tracking while the forms keep their edits.
142
- if (next === step) {
143
- return;
144
- }
145
- if (step === "settings" && Object.values(unsaved).some(Boolean)) {
146
- setLeavingTo(next);
147
- return;
148
- }
149
- goTo(next);
150
- }
151
-
152
- const trackUnsaved = (form: string) => (dirty: boolean) => setUnsaved((prev) => ({ ...prev, [form]: dirty }));
153
-
154
- async function finish() {
155
- setFinishing(true);
156
- setError(null);
157
- try {
158
- // Let a step still being recorded land first, so it can't arrive after setup is marked finished.
159
- await progress.current.running;
160
- await completeSetup();
161
- window.location.href = "/admin";
162
- } catch (err) {
163
- setError(errorMessage(err, "Could not finish setup."));
164
- setFinishing(false);
165
- }
166
- }
167
-
168
- const noDomain: boolean = domains.length === 0;
169
- const blocked = (step === "domain" || last) && noDomain;
170
-
171
- return (
172
- <div className="flex flex-col gap-6">
173
- <div className="flex items-start justify-between gap-4">
174
- <div>
175
- <h1 className="text-xl font-bold uppercase tracking-wide mb-1">Set up your server</h1>
176
- <p className="text-sm text-text-muted">You can change any of these settings later from the admin console.</p>
177
- </div>
178
- {status && !status.required && (
179
- <a href="/admin" className="text-sm text-primary-dark underline whitespace-nowrap">
180
- Exit setup
181
- </a>
182
- )}
183
- </div>
184
-
185
- {domainsError && (
186
- <Alert>
187
- <span className="flex flex-wrap items-center gap-2">
188
- {domainsError}
189
- <Button type="button" variant="secondary" className="!w-auto !py-1 !px-2 !text-xs" onClick={() => void loadDomains()}>
190
- Retry
191
- </Button>
192
- </span>
193
- </Alert>
194
- )}
195
-
196
- <ol aria-label="Setup steps" className="flex flex-wrap gap-2">
197
- {SETUP_STEPS.map((s, i) => (
198
- <li key={s.id}>
199
- <button
200
- type="button"
201
- aria-current={s.id === step ? "step" : undefined}
202
- // Steps after the domain need somewhere to put mail first.
203
- disabled={i > 1 && noDomain}
204
- onClick={() => requestGoTo(s.id)}
205
- className={[
206
- "text-sm py-1.5 px-3 rounded-pill border disabled:opacity-50",
207
- s.id === step
208
- ? "bg-primary/10 border-primary text-primary-dark font-semibold"
209
- : i < index
210
- ? "border-border text-text"
211
- : "border-border text-text-muted",
212
- ].join(" ")}
213
- >
214
- {i + 1}. {s.title}
215
- {i < index && <span className="sr-only"> (done)</span>}
216
- </button>
217
- </li>
218
- ))}
219
- </ol>
220
-
221
- <section aria-labelledby="setup-step-title" className="flex flex-col gap-5">
222
- <div>
223
- <h2 id="setup-step-title" className="text-lg font-bold">
224
- Step {index + 1} of {SETUP_STEPS.length}: {current.title}
225
- </h2>
226
- <p className="text-sm text-text-muted">{current.intro}</p>
227
- </div>
228
-
229
- {step === "plugins" && <PluginsManager />}
230
- {step === "domain" && <DomainStep domains={domains} onCreated={(domain) => setDomains((prev) => [...prev, domain])} />}
231
- {step === "settings" && (
232
- <div className="flex flex-col gap-10">
233
- <LoadedSettingsForm load={getEncryptionPolicy} loadErrorMessage="Could not load the encryption policy.">
234
- {(policy, onChange) => (
235
- <EncryptionPolicyForm
236
- policy={policy}
237
- onDirtyChange={trackUnsaved("encryption")}
238
- onChange={(updated) => {
239
- onChange(updated);
240
- setEncryption(updated);
241
- }}
242
- />
243
- )}
244
- </LoadedSettingsForm>
245
- <LoadedSettingsForm load={getRetentionPolicy} loadErrorMessage="Could not load the retention policy.">
246
- {(policy, onChange) => <RetentionPolicyForm policy={policy} onChange={onChange} onDirtyChange={trackUnsaved("retention")} />}
247
- </LoadedSettingsForm>
248
- <LoadedSettingsForm load={getMailboxPolicy} loadErrorMessage="Could not load the mailbox policy.">
249
- {(policy, onChange) => <MailboxPolicyForm policy={policy} onChange={onChange} onDirtyChange={trackUnsaved("mailbox")} />}
250
- </LoadedSettingsForm>
251
- </div>
252
- )}
253
- {step === "escrow" &&
254
- (encryption && !isEncryptionEnabled(encryption) ? (
255
- <p role="status" className="text-sm py-2 px-3 rounded-sm bg-surface-alt text-text">
256
- End-to-end encryption is turned off, so escrow isn&rsquo;t needed. You can set it up later if you
257
- turn encryption on.
258
- </p>
259
- ) : (
260
- <EscrowSetupStep adminUid={userUid} />
261
- ))}
262
- {step === "branding" && (
263
- <LoadedSettingsForm load={getBranding} loadErrorMessage="Could not load branding.">
264
- {(branding, onChange) => <BrandingForm branding={branding} onChange={onChange} />}
265
- </LoadedSettingsForm>
266
- )}
267
- {step === "mailboxes" && <MailboxesStep userUid={userUid} domain={domains.find((d) => d.verified)?.name ?? domains[0]?.name} />}
268
- </section>
269
-
270
- {error && <Alert>{error}</Alert>}
271
-
272
- <div className="flex items-center gap-3 border-t border-border pt-5">
273
- {index > 0 && (
274
- <Button type="button" variant="secondary" className="!w-auto" onClick={() => requestGoTo(SETUP_STEPS[index - 1].id)}>
275
- Back
276
- </Button>
277
- )}
278
- <div className="flex-1" />
279
- {progressFailed && <span className="text-xs text-text-muted">Your place in setup couldn&rsquo;t be saved.</span>}
280
- {blocked && <span className="text-sm text-text-muted">{last ? "Add a domain before finishing setup." : "Add a domain to continue."}</span>}
281
- {last ? (
282
- <Button type="button" className="!w-auto" loading={finishing} disabled={finishing || blocked} onClick={() => void finish()}>
283
- Finish setup
284
- </Button>
285
- ) : (
286
- <Button type="button" className="!w-auto" disabled={blocked} onClick={() => requestGoTo(SETUP_STEPS[index + 1].id)}>
287
- Continue
288
- </Button>
289
- )}
290
- </div>
291
-
292
- {leavingTo && (
293
- <Modal open onClose={() => setLeavingTo(null)} title="Discard unsaved changes?">
294
- <p className="text-sm mb-4">Some server settings on this step have changes that haven&rsquo;t been saved.</p>
295
- <div className="flex gap-2 justify-end">
296
- <Button type="button" variant="secondary" className="!w-auto" onClick={() => setLeavingTo(null)}>
297
- Keep editing
298
- </Button>
299
- <Button type="button" className="!w-auto" onClick={() => goTo(leavingTo)}>
300
- Discard changes
301
- </Button>
302
- </div>
303
- </Modal>
304
- )}
305
- </div>
306
- );
307
- }
308
-
309
- function DomainStep({ domains, onCreated }: { domains: Domain[]; onCreated: (domain: Domain) => void }) {
310
- const [name, setName] = useState("");
311
- const [error, setError] = useState<string | null>(null);
312
- const [saving, setSaving] = useState(false);
313
-
314
- async function handleSubmit(e: FormEvent) {
315
- e.preventDefault();
316
- setError(null);
317
- if (!name.trim()) {
318
- setError("A domain name is required.");
319
- return;
320
- }
321
- setSaving(true);
322
- try {
323
- onCreated(await createDomain({ name: name.trim() }));
324
- setName("");
325
- } catch (err) {
326
- setError(errorMessage(err, "Could not add the domain."));
327
- } finally {
328
- setSaving(false);
329
- }
330
- }
331
-
332
- return (
333
- <div className="flex flex-col gap-5 max-w-3xl">
334
- {domains.map((domain) => (
335
- <div key={domain.uid} className="flex flex-col gap-3">
336
- <h3 className="text-base font-bold">{domain.name}</h3>
337
- <DomainDnsSetup uid={domain.uid} />
338
- </div>
339
- ))}
340
- {error && <Alert>{error}</Alert>}
341
- <form onSubmit={handleSubmit} className="bg-surface border border-border rounded-md p-6">
342
- <FormField label={domains.length === 0 ? "Domain name" : "Add another domain"} htmlFor="setupDomainName">
343
- <input
344
- id="setupDomainName"
345
- type="text"
346
- className={INPUT_CLASS}
347
- value={name}
348
- onChange={(e) => setName(e.target.value)}
349
- placeholder="example.com"
350
- />
351
- </FormField>
352
- <Button type="submit" loading={saving} disabled={saving} className="!w-auto">
353
- Add domain
354
- </Button>
355
- </form>
356
- </div>
357
- );
358
- }
359
-
360
- function MailboxesStep({ userUid, domain }: { userUid: string; domain?: string }) {
361
- const [mailboxes, setMailboxes] = useState<Mailbox[]>([]);
362
- const [loaded, setLoaded] = useState(false);
363
- const [error, setError] = useState<string | null>(null);
364
- const [formKey, setFormKey] = useState(0);
365
-
366
- useEffect(() => {
367
- listMailboxes({ limit: 100 })
368
- .then((list) =>
369
- // Keep any mailbox created here while the list was loading.
370
- setMailboxes((prev) => [...list, ...prev.filter((mine) => !list.some((mailbox) => mailbox.uid === mine.uid))]),
371
- )
372
- .catch((err) =>
373
- setError(
374
- `${errorMessage(err, "Could not load the existing mailboxes.")} Check the Mailboxes page before creating your own, so you don't create it twice.`,
375
- ),
376
- )
377
- .finally(() => setLoaded(true));
378
- }, []);
379
-
380
- const hasOwn = mailboxes.some((mailbox) => mailbox.ownerUserUid === userUid);
381
-
382
- return (
383
- <div className="flex flex-col gap-5 max-w-xl">
384
- {error && <Alert>{error}</Alert>}
385
- {mailboxes.length > 0 && (
386
- <div>
387
- <h3 className="text-sm font-bold uppercase tracking-wide mb-2">Mailboxes created</h3>
388
- <ul className="text-sm flex flex-col gap-1">
389
- {mailboxes.map((mailbox) => (
390
- <li key={mailbox.uid}>
391
- {mailbox.displayName} &lt;{mailbox.primarySmtpAddress}&gt;
392
- {mailbox.ownerUserUid === userUid && <span className="text-text-muted"> (yours)</span>}
393
- </li>
394
- ))}
395
- </ul>
396
- </div>
397
- )}
398
- {!loaded ? (
399
- <p className="text-sm text-text-muted">Loading&hellip;</p>
400
- ) : (
401
- <>
402
- <h3 className="text-base font-bold">{hasOwn ? "Add another mailbox" : "Your mailbox"}</h3>
403
- <MailboxCreateForm
404
- key={formKey}
405
- submitLabel="Create mailbox"
406
- defaults={hasOwn ? { domain } : { localPart: "admin", domain, displayName: "Administrator", ownerUserUid: userUid }}
407
- onCreated={(mailbox) => {
408
- setMailboxes((prev) => [...prev, mailbox]);
409
- setFormKey((k) => k + 1);
410
- }}
411
- />
412
- </>
413
- )}
414
- </div>
415
- );
416
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+ import React, { FormEvent, useEffect, useRef, useState } from "react";
6
+ import { HiCheck } from "react-icons/hi2";
7
+ import { ApiRequestError } from "@rapidmx/react-shared/util/api.js";
8
+ import { getRetentionPolicy } from "@rapidmx/react-shared/admin/retentionPolicyApi.js";
9
+ import { getMailboxPolicy } from "@rapidmx/react-shared/admin/mailboxPolicyApi.js";
10
+ import { createDomain, Domain, listDomains } from "@rapidmx/react-shared/admin/domainsApi.js";
11
+ import { completeSetup, getSetupStatus, saveSetupStep, SetupStatus } from "@rapidmx/react-shared/admin/setupApi.js";
12
+ import { getBranding } from "@rapidmx/react-shared/branding/brandingApi.js";
13
+ import { EncryptionPolicy, getEncryptionPolicy } from "@rapidmx/react-shared/crypto/keyvaultApi.js";
14
+ import { listMailboxes, Mailbox } from "@rapidmx/react-shared/mail/mailApi.js";
15
+ import Alert from "@rapidmx/react-shared/components/feedback/Alert.js";
16
+ import Button from "@rapidmx/react-shared/components/buttons/Button.js";
17
+ import FormField from "@rapidmx/react-shared/components/forms/FormField.js";
18
+ import Modal from "@rapidmx/react-shared/components/overlays/Modal.js";
19
+ import BrandingForm from "../settings/BrandingForm.js";
20
+ import DomainDnsSetup from "../settings/DomainDnsSetup.js";
21
+ import EncryptionPolicyForm, { isEncryptionEnabled } from "../settings/EncryptionPolicyForm.js";
22
+ import LoadedSettingsForm from "../settings/LoadedSettingsForm.js";
23
+ import MailboxCreateForm from "../settings/MailboxCreateForm.js";
24
+ import MailboxPolicyForm from "../settings/MailboxPolicyForm.js";
25
+ import PluginsManager from "../settings/PluginsManager.js";
26
+ import RetentionPolicyForm from "../settings/RetentionPolicyForm.js";
27
+ import EscrowSetupStep from "./EscrowSetupStep.js";
28
+
29
+ const INPUT_CLASS =
30
+ "w-full text-sm py-2.5 px-3 border border-border rounded-sm bg-surface text-text focus:outline-none focus:border-primary";
31
+
32
+ /** The bordered panel the wizard's forms sit in. */
33
+ const CARD_CLASS = "bg-surface border border-border rounded-md p-6";
34
+
35
+ export const SETUP_STEPS = [
36
+ { id: "plugins", title: "Plugins", intro: "Choose which protocols and features this server runs. The recommended plugins are already installed." },
37
+ { id: "domain", title: "Domain", intro: "Add the domain this server receives mail for, then publish the DNS records below." },
38
+ { id: "settings", title: "Server settings", intro: "Set the rules for encryption, how long mail is kept, and new mailboxes." },
39
+ { id: "escrow", title: "Escrow", intro: "Decide whether encrypted mail can be recovered by a trusted group of holders." },
40
+ { id: "branding", title: "Branding", intro: "Make the sign-in page and apps look like your organization." },
41
+ { id: "mailboxes", title: "Mailboxes", intro: "Create the first mailboxes, starting with your own." },
42
+ ] as const;
43
+
44
+ export type SetupStepId = (typeof SETUP_STEPS)[number]["id"];
45
+
46
+ function isStepId(value: string | undefined): value is SetupStepId {
47
+ return SETUP_STEPS.some((step) => step.id === value);
48
+ }
49
+
50
+ function errorMessage(err: unknown, fallback: string): string {
51
+ return err instanceof ApiRequestError ? err.message : fallback;
52
+ }
53
+
54
+ export interface SetupWizardProps {
55
+ userUid: string;
56
+ }
57
+
58
+ /**
59
+ * The first-run setup wizard. Each step saves as the administrator works through it; the wizard itself only records
60
+ * which step they're on (so leaving and coming back resumes there) and, at the end, that setup is finished. Every step
61
+ * except the domain can be passed over and configured later from the admin console.
62
+ */
63
+ export default function SetupWizard({ userUid }: SetupWizardProps) {
64
+ const [step, setStep] = useState<SetupStepId | null>(null);
65
+ const [status, setStatus] = useState<SetupStatus | undefined>();
66
+ const [domains, setDomains] = useState<Domain[]>([]);
67
+ const [domainsError, setDomainsError] = useState<string | null>(null);
68
+ const [encryption, setEncryption] = useState<EncryptionPolicy | null>(null);
69
+ const [finishing, setFinishing] = useState(false);
70
+ const [error, setError] = useState<string | null>(null);
71
+ /** Which of the settings step's forms have edits that haven't been saved. */
72
+ const [unsaved, setUnsaved] = useState<Record<string, boolean>>({});
73
+ /** The step the administrator asked to go to while the settings step had unsaved edits. */
74
+ const [leavingTo, setLeavingTo] = useState<SetupStepId | null>(null);
75
+ const [progressFailed, setProgressFailed] = useState(false);
76
+ /** Step saves run one at a time, and only the latest step still waiting is saved. */
77
+ const progress = useRef<{ running: Promise<void> | null; next: SetupStepId | null }>({ running: null, next: null });
78
+
79
+ function loadDomains(): Promise<void> {
80
+ return listDomains({ limit: 25 })
81
+ .then((list) => {
82
+ setDomains(list);
83
+ setDomainsError(null);
84
+ })
85
+ .catch((err) => setDomainsError(errorMessage(err, "Could not load your domains.")));
86
+ }
87
+
88
+ useEffect(() => {
89
+ void Promise.all([getSetupStatus().catch(() => undefined), loadDomains()]).then(([loaded]) => {
90
+ setStatus(loaded);
91
+ setStep(isStepId(loaded?.currentStep) ? loaded.currentStep : "plugins");
92
+ });
93
+ }, []);
94
+
95
+ useEffect(() => {
96
+ if (step === "escrow" || step === "settings") {
97
+ getEncryptionPolicy()
98
+ .then(setEncryption)
99
+ .catch(() => setEncryption(null));
100
+ }
101
+ }, [step]);
102
+
103
+ if (step === null) {
104
+ return <p className="text-sm text-text-muted">Loading&hellip;</p>;
105
+ }
106
+
107
+ const index = SETUP_STEPS.findIndex((s) => s.id === step);
108
+ const current = SETUP_STEPS[index];
109
+ const last = index === SETUP_STEPS.length - 1;
110
+
111
+ /** Records the step the administrator is on. Progress is a convenience for resuming, so a failure is only noted. */
112
+ function saveProgress(next: SetupStepId) {
113
+ const queue = progress.current;
114
+ queue.next = next;
115
+ if (queue.running) {
116
+ return;
117
+ }
118
+ queue.running = (async () => {
119
+ while (queue.next) {
120
+ const target: SetupStepId = queue.next;
121
+ queue.next = null;
122
+ try {
123
+ await saveSetupStep(target);
124
+ setProgressFailed(false);
125
+ } catch (err) {
126
+ console.warn("Could not save setup progress", err);
127
+ setProgressFailed(true);
128
+ }
129
+ }
130
+ queue.running = null;
131
+ })();
132
+ }
133
+
134
+ function goTo(next: SetupStepId) {
135
+ setError(null);
136
+ setLeavingTo(null);
137
+ setUnsaved({});
138
+ setStep(next);
139
+ saveProgress(next);
140
+ window.scrollTo?.(0, 0);
141
+ }
142
+
143
+ /** Goes to `next`, first asking whether to discard any unsaved server settings. */
144
+ function requestGoTo(next: SetupStepId) {
145
+ // Going to the step already shown would clear the unsaved-edit tracking while the forms keep their edits.
146
+ if (next === step) {
147
+ return;
148
+ }
149
+ if (step === "settings" && Object.values(unsaved).some(Boolean)) {
150
+ setLeavingTo(next);
151
+ return;
152
+ }
153
+ goTo(next);
154
+ }
155
+
156
+ const trackUnsaved = (form: string) => (dirty: boolean) => setUnsaved((prev) => ({ ...prev, [form]: dirty }));
157
+
158
+ async function finish() {
159
+ setFinishing(true);
160
+ setError(null);
161
+ try {
162
+ // Let a step still being recorded land first, so it can't arrive after setup is marked finished.
163
+ await progress.current.running;
164
+ await completeSetup();
165
+ window.location.href = "/admin";
166
+ } catch (err) {
167
+ setError(errorMessage(err, "Could not finish setup."));
168
+ setFinishing(false);
169
+ }
170
+ }
171
+
172
+ const noDomain: boolean = domains.length === 0;
173
+ const blocked = (step === "domain" || last) && noDomain;
174
+
175
+ return (
176
+ <div className="flex flex-col gap-6">
177
+ <div className="flex items-start justify-between gap-4">
178
+ <div>
179
+ <h1 className="text-xl font-bold uppercase tracking-wide mb-1">Set up your server</h1>
180
+ <p className="text-sm text-text-muted">You can change any of these settings later from the admin console.</p>
181
+ </div>
182
+ {status && !status.required && (
183
+ <a href="/admin" className="text-sm text-primary-dark font-medium hover:underline whitespace-nowrap">
184
+ Exit setup
185
+ </a>
186
+ )}
187
+ </div>
188
+
189
+ {domainsError && (
190
+ <Alert>
191
+ <span className="flex flex-wrap items-center gap-2">
192
+ {domainsError}
193
+ <Button type="button" variant="text" onClick={() => void loadDomains()}>
194
+ Retry
195
+ </Button>
196
+ </span>
197
+ </Alert>
198
+ )}
199
+
200
+ <ol aria-label="Setup steps" className="flex flex-wrap gap-2">
201
+ {SETUP_STEPS.map((s, i) => (
202
+ <li key={s.id}>
203
+ <button
204
+ type="button"
205
+ aria-current={s.id === step ? "step" : undefined}
206
+ // Steps after the domain need somewhere to put mail first.
207
+ disabled={i > 1 && noDomain}
208
+ onClick={() => requestGoTo(s.id)}
209
+ className={[
210
+ "inline-flex items-center gap-1.5 text-sm py-1.5 px-3 rounded-pill border transition-colors",
211
+ "disabled:opacity-50 disabled:cursor-not-allowed",
212
+ s.id === step
213
+ ? "bg-primary/10 border-primary text-primary-dark font-semibold"
214
+ : i < index
215
+ ? "bg-surface border-border text-text hover:not-disabled:border-primary"
216
+ : "bg-surface border-border text-text-muted hover:not-disabled:border-primary hover:not-disabled:text-text",
217
+ ].join(" ")}
218
+ >
219
+ {i < index && <HiCheck aria-hidden="true" className="w-4 h-4 text-success" />}
220
+ {i + 1}. {s.title}
221
+ {i < index && <span className="sr-only"> (done)</span>}
222
+ </button>
223
+ </li>
224
+ ))}
225
+ </ol>
226
+
227
+ <section aria-labelledby="setup-step-title" className="flex flex-col gap-5">
228
+ <div className="flex flex-col gap-1">
229
+ <h2 id="setup-step-title" className="flex flex-col gap-0.5">
230
+ <span className="text-xs font-bold uppercase tracking-wide text-text-muted">
231
+ Step {index + 1} of {SETUP_STEPS.length}
232
+ <span className="sr-only">:</span>
233
+ </span>{" "}
234
+ <span className="text-lg font-bold uppercase tracking-wide">{current.title}</span>
235
+ </h2>
236
+ <p className="text-sm text-text-muted max-w-3xl">{current.intro}</p>
237
+ </div>
238
+
239
+ {step === "plugins" && (
240
+ <div>
241
+ <PluginsManager embedded />
242
+ </div>
243
+ )}
244
+ {step === "domain" && <DomainStep domains={domains} onCreated={(domain) => setDomains((prev) => [...prev, domain])} />}
245
+ {step === "settings" && (
246
+ <div className="flex flex-col gap-6 max-w-3xl">
247
+ <div className={CARD_CLASS}>
248
+ <LoadedSettingsForm load={getEncryptionPolicy} loadErrorMessage="Could not load the encryption policy.">
249
+ {(policy, onChange) => (
250
+ <EncryptionPolicyForm
251
+ embedded
252
+ policy={policy}
253
+ onDirtyChange={trackUnsaved("encryption")}
254
+ onChange={(updated) => {
255
+ onChange(updated);
256
+ setEncryption(updated);
257
+ }}
258
+ />
259
+ )}
260
+ </LoadedSettingsForm>
261
+ </div>
262
+ <div className={CARD_CLASS}>
263
+ <LoadedSettingsForm load={getRetentionPolicy} loadErrorMessage="Could not load the retention policy.">
264
+ {(policy, onChange) => (
265
+ <RetentionPolicyForm embedded policy={policy} onChange={onChange} onDirtyChange={trackUnsaved("retention")} />
266
+ )}
267
+ </LoadedSettingsForm>
268
+ </div>
269
+ <div className={CARD_CLASS}>
270
+ <LoadedSettingsForm load={getMailboxPolicy} loadErrorMessage="Could not load the mailbox policy.">
271
+ {(policy, onChange) => (
272
+ <MailboxPolicyForm embedded policy={policy} onChange={onChange} onDirtyChange={trackUnsaved("mailbox")} />
273
+ )}
274
+ </LoadedSettingsForm>
275
+ </div>
276
+ </div>
277
+ )}
278
+ {step === "escrow" &&
279
+ (encryption && !isEncryptionEnabled(encryption) ? (
280
+ <p role="status" className="text-sm py-2 px-3 rounded-sm bg-surface-alt text-text max-w-3xl">
281
+ End-to-end encryption is turned off, so escrow isn&rsquo;t needed. You can set it up later if you
282
+ turn encryption on.
283
+ </p>
284
+ ) : (
285
+ <EscrowSetupStep adminUid={userUid} />
286
+ ))}
287
+ {step === "branding" && (
288
+ <div className={`${CARD_CLASS} max-w-3xl`}>
289
+ <LoadedSettingsForm load={getBranding} loadErrorMessage="Could not load branding.">
290
+ {(branding, onChange) => <BrandingForm embedded branding={branding} onChange={onChange} />}
291
+ </LoadedSettingsForm>
292
+ </div>
293
+ )}
294
+ {step === "mailboxes" && <MailboxesStep userUid={userUid} domain={domains.find((d) => d.verified)?.name ?? domains[0]?.name} />}
295
+ </section>
296
+
297
+ {error && <Alert>{error}</Alert>}
298
+
299
+ <div className="flex items-center gap-3 border-t border-border pt-5">
300
+ {index > 0 && (
301
+ <Button type="button" variant="secondary" className="!w-auto" onClick={() => requestGoTo(SETUP_STEPS[index - 1].id)}>
302
+ Back
303
+ </Button>
304
+ )}
305
+ <div className="flex-1" />
306
+ {progressFailed && <span className="text-xs text-text-muted">Your place in setup couldn&rsquo;t be saved.</span>}
307
+ {blocked && <span className="text-sm text-text-muted">{last ? "Add a domain before finishing setup." : "Add a domain to continue."}</span>}
308
+ {last ? (
309
+ <Button type="button" className="!w-auto" loading={finishing} disabled={finishing || blocked} onClick={() => void finish()}>
310
+ Finish setup
311
+ </Button>
312
+ ) : (
313
+ <Button type="button" className="!w-auto" disabled={blocked} onClick={() => requestGoTo(SETUP_STEPS[index + 1].id)}>
314
+ Continue
315
+ </Button>
316
+ )}
317
+ </div>
318
+
319
+ {leavingTo && (
320
+ <Modal open onClose={() => setLeavingTo(null)} title="Discard unsaved changes?">
321
+ <p className="text-sm mb-4">Some server settings on this step have changes that haven&rsquo;t been saved.</p>
322
+ <div className="flex gap-2 justify-end">
323
+ <Button type="button" variant="secondary" className="!w-auto" onClick={() => setLeavingTo(null)}>
324
+ Keep editing
325
+ </Button>
326
+ <Button type="button" className="!w-auto" onClick={() => goTo(leavingTo)}>
327
+ Discard changes
328
+ </Button>
329
+ </div>
330
+ </Modal>
331
+ )}
332
+ </div>
333
+ );
334
+ }
335
+
336
+ function DomainStep({ domains, onCreated }: { domains: Domain[]; onCreated: (domain: Domain) => void }) {
337
+ const [name, setName] = useState("");
338
+ const [error, setError] = useState<string | null>(null);
339
+ const [saving, setSaving] = useState(false);
340
+
341
+ async function handleSubmit(e: FormEvent) {
342
+ e.preventDefault();
343
+ setError(null);
344
+ if (!name.trim()) {
345
+ setError("A domain name is required.");
346
+ return;
347
+ }
348
+ setSaving(true);
349
+ try {
350
+ onCreated(await createDomain({ name: name.trim() }));
351
+ setName("");
352
+ } catch (err) {
353
+ setError(errorMessage(err, "Could not add the domain."));
354
+ } finally {
355
+ setSaving(false);
356
+ }
357
+ }
358
+
359
+ return (
360
+ <div className="flex flex-col gap-5 max-w-3xl">
361
+ {domains.map((domain) => (
362
+ <div key={domain.uid} className="flex flex-col gap-3">
363
+ <h3 className="text-base font-bold">{domain.name}</h3>
364
+ <DomainDnsSetup uid={domain.uid} />
365
+ </div>
366
+ ))}
367
+ {error && <Alert>{error}</Alert>}
368
+ <form onSubmit={handleSubmit} className={CARD_CLASS}>
369
+ <FormField label={domains.length === 0 ? "Domain name" : "Add another domain"} htmlFor="setupDomainName">
370
+ <input
371
+ id="setupDomainName"
372
+ type="text"
373
+ className={INPUT_CLASS}
374
+ value={name}
375
+ onChange={(e) => setName(e.target.value)}
376
+ placeholder="example.com"
377
+ />
378
+ </FormField>
379
+ <Button type="submit" loading={saving} disabled={saving} className="!w-auto">
380
+ Add domain
381
+ </Button>
382
+ </form>
383
+ </div>
384
+ );
385
+ }
386
+
387
+ function MailboxesStep({ userUid, domain }: { userUid: string; domain?: string }) {
388
+ const [mailboxes, setMailboxes] = useState<Mailbox[]>([]);
389
+ const [loaded, setLoaded] = useState(false);
390
+ const [error, setError] = useState<string | null>(null);
391
+ const [formKey, setFormKey] = useState(0);
392
+
393
+ useEffect(() => {
394
+ listMailboxes({ limit: 100 })
395
+ .then((list) =>
396
+ // Keep any mailbox created here while the list was loading.
397
+ setMailboxes((prev) => [...list, ...prev.filter((mine) => !list.some((mailbox) => mailbox.uid === mine.uid))]),
398
+ )
399
+ .catch((err) =>
400
+ setError(
401
+ `${errorMessage(err, "Could not load the existing mailboxes.")} Check the Mailboxes page before creating your own, so you don't create it twice.`,
402
+ ),
403
+ )
404
+ .finally(() => setLoaded(true));
405
+ }, []);
406
+
407
+ const hasOwn = mailboxes.some((mailbox) => mailbox.ownerUserUid === userUid);
408
+
409
+ return (
410
+ <div className="flex flex-col gap-5 max-w-xl">
411
+ {error && <Alert>{error}</Alert>}
412
+ {mailboxes.length > 0 && (
413
+ <div>
414
+ <h3 className="text-sm font-bold uppercase tracking-wide mb-2">Mailboxes created</h3>
415
+ <ul className="text-sm flex flex-col gap-1">
416
+ {mailboxes.map((mailbox) => (
417
+ <li key={mailbox.uid}>
418
+ {mailbox.displayName} &lt;{mailbox.primarySmtpAddress}&gt;
419
+ {mailbox.ownerUserUid === userUid && <span className="text-text-muted"> (yours)</span>}
420
+ </li>
421
+ ))}
422
+ </ul>
423
+ </div>
424
+ )}
425
+ {!loaded ? (
426
+ <p className="text-sm text-text-muted">Loading&hellip;</p>
427
+ ) : (
428
+ <>
429
+ <h3 className="text-base font-bold">{hasOwn ? "Add another mailbox" : "Your mailbox"}</h3>
430
+ <MailboxCreateForm
431
+ key={formKey}
432
+ submitLabel="Create mailbox"
433
+ defaults={hasOwn ? { domain } : { localPart: "admin", domain, displayName: "Administrator", ownerUserUid: userUid }}
434
+ onCreated={(mailbox) => {
435
+ setMailboxes((prev) => [...prev, mailbox]);
436
+ setFormKey((k) => k + 1);
437
+ }}
438
+ />
439
+ </>
440
+ )}
441
+ </div>
442
+ );
443
+ }