@rapidmx/web-client 0.15.1 → 0.16.0

package/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.tsx

@@ -0,0 +1,238 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import React, { FormEvent, useEffect, useRef, useState } from "react";
+import { ApiRequestError } from "@rapidmx/react-shared/util/api.js";
+import { eraseLeftoverMailbox } from "@rapidmx/react-shared/admin/leftoverMailboxApi.js";
+import { DataSubjectErasureStatus, getErasureRequest } from "@rapidmx/react-shared/mail/erasureRequestApi.js";
+import Alert from "@rapidmx/react-shared/components/feedback/Alert.js";
+import Button from "@rapidmx/react-shared/components/buttons/Button.js";
+import Modal from "@rapidmx/react-shared/components/overlays/Modal.js";
+import { notify } from "../../../notifications/store.js";
+
+const INPUT_CLASS =
+    "w-full text-sm py-2.5 px-3 border border-border rounded-sm bg-surface text-text focus:outline-none focus:border-primary";
+const DANGER_BUTTON_CLASS = "!w-auto !bg-none !bg-danger !border-danger hover:!bg-danger";
+
+/** How often the request is asked how far the erasure has got. */
+export const ERASE_POLL_INTERVAL_MS = 2000;
+
+export interface EraseLeftoverDataDialogProps {
+    /** The deleted mailbox's address. */
+    address: string;
+    /** What is left, when the caller knows it (the list of deleted mailboxes does): named in the confirmation. */
+    counts?: { folders: number; messages: number };
+    /** An erasure already filed for the address (approved or running): the dialog then watches it instead of asking first. */
+    resume?: { uid: string; status: DataSubjectErasureStatus };
+    /** The button shown once the data is erased (`onDone` runs when it is pressed - the dialog closes itself first). Default "Done". */
+    doneLabel?: string;
+    onDone?: () => void;
+    /** Called once when the data is erased - whether or not the dialog is still open by then. */
+    onErased?: (address: string) => void;
+    onClose: () => void;
+    /** How often to ask how far the erasure has got. */
+    pollIntervalMs?: number;
+}
+
+type Phase = "confirm" | "filing" | "watching" | "done" | "refused";
+
+/** Where an erasure is, in words. */
+function progressLabel(status: DataSubjectErasureStatus | undefined): string {
+    return status === "in_progress" ? "Erasing the data…" : "Waiting for the erasure to start…";
+}
+
+/**
+ * Erases the data a deleted mailbox left behind - permanently - after the administrator types its address to confirm, then shows
+ * how far it has got: the erasure runs on the server in the background, so this asks about it every few seconds until it has
+ * finished or been refused. Mount it (with the address as its `key`) only while it is wanted; it holds its own state.
+ *
+ * The request that files the erasure can't be interrupted (closing is ignored while it is under way); once it is filed, closing
+ * only stops watching - the erasure carries on, and the deleted-mailbox list shows it.
+ */
+export default function EraseLeftoverDataDialog({
+    address,
+    counts,
+    resume,
+    doneLabel = "Done",
+    onDone,
+    onErased,
+    onClose,
+    pollIntervalMs = ERASE_POLL_INTERVAL_MS,
+}: EraseLeftoverDataDialogProps) {
+    const [phase, setPhase] = useState<Phase>(resume ? "watching" : "confirm");
+    const [typed, setTyped] = useState("");
+    const [requestUid, setRequestUid] = useState<string | undefined>(resume?.uid);
+    const [status, setStatus] = useState<DataSubjectErasureStatus | undefined>(resume?.status);
+    const [error, setError] = useState<string | null>(null);
+    // A check on the erasure failed (offline, a dropped connection): it is tried again, and the admin is told meanwhile.
+    const [checkFailed, setCheckFailed] = useState(false);
+    const onErasedRef = useRef(onErased);
+    onErasedRef.current = onErased;
+
+    const confirmed = typed.trim().toLowerCase() === address.trim().toLowerCase();
+
+    async function handleErase(e: FormEvent) {
+        e.preventDefault();
+        if (!confirmed) {
+            return;
+        }
+        setError(null);
+        setPhase("filing");
+        try {
+            const request = await eraseLeftoverMailbox(address);
+            setRequestUid(request.uid);
+            setStatus(request.status);
+            setPhase("watching");
+        } catch (err) {
+            // The server's own words: a legal hold names its matter, a mailbox that exists again says so.
+            setError(err instanceof ApiRequestError ? err.message : "Could not start the erasure.");
+            setPhase("confirm");
+        }
+    }
+
+    // Watches the request until it has finished or been refused.
+    useEffect(() => {
+        if (phase !== "watching" || !requestUid) {
+            return;
+        }
+        let cancelled = false;
+        let timer: ReturnType<typeof setTimeout> | undefined;
+        const check = async () => {
+            try {
+                const request = await getErasureRequest(requestUid);
+                if (cancelled) {
+                    return;
+                }
+                setCheckFailed(false);
+                setStatus(request.status);
+                if (request.status === "completed") {
+                    setPhase("done");
+                    notify({ kind: "success", title: "Leftover data erased", message: `Everything left over from ${address} was erased.` });
+                    onErasedRef.current?.(address);
+                    return;
+                }
+                if (request.status === "denied") {
+                    setError(request.reason || "The erasure was refused.");
+                    setPhase("refused");
+                    return;
+                }
+            } catch {
+                if (cancelled) {
+                    return;
+                }
+                setCheckFailed(true);
+            }
+            timer = setTimeout(() => void check(), pollIntervalMs);
+        };
+        void check();
+        return () => {
+            cancelled = true;
+            clearTimeout(timer);
+        };
+    }, [phase, requestUid, address, pollIntervalMs]);
+
+    // Closing is ignored while the request that files the erasure is under way, so its answer can't land on a dialog that was dismissed.
+    function dismiss() {
+        if (phase !== "filing") {
+            onClose();
+        }
+    }
+
+    function handleDone() {
+        onClose();
+        onDone?.();
+    }
+
+    const summary = counts
+        ? `It still has ${counts.folders} ${counts.folders === 1 ? "folder" : "folders"} and ${counts.messages} ${counts.messages === 1 ? "message" : "messages"}, and everything else stored with them.`
+        : "It still has its folders and everything stored in them.";
+
+    return (
+        <Modal open onClose={dismiss} title="Erase leftover data">
+            {(phase === "confirm" || phase === "filing") && (
+                <form onSubmit={handleErase}>
+                    <p className="text-sm mb-3">
+                        <strong className="break-all">{address}</strong> was deleted, but its data was kept. {summary}
+                    </p>
+                    <p className="text-sm mb-3">
+                        Erasing permanently deletes all of it - the mail, drafts and attachments, contacts, calendar events, tasks,
+                        notes, labels, filter rules and signatures, encryption keys, share links and access lists - and frees the
+                        address for a new mailbox.
+                    </p>
+                    <p className="text-sm font-semibold text-danger mb-4">This is irreversible and cannot be undone.</p>
+                    <label className="flex flex-col gap-1.5 text-sm mb-4">
+                        <span className="font-semibold">
+                            Type <span className="break-all">{address}</span> to confirm
+                        </span>
+                        <input
+                            aria-label="Type the address to confirm"
+                            className={INPUT_CLASS}
+                            value={typed}
+                            disabled={phase === "filing"}
+                            autoComplete="off"
+                            spellCheck={false}
+                            onChange={(e) => setTyped(e.target.value)}
+                        />
+                    </label>
+                    {error && <Alert>{error}</Alert>}
+                    <div className="flex gap-3 justify-end">
+                        <Button type="button" variant="secondary" className="!w-auto" disabled={phase === "filing"} onClick={dismiss}>
+                            Cancel
+                        </Button>
+                        <Button type="submit" className={DANGER_BUTTON_CLASS} loading={phase === "filing"} disabled={phase === "filing" || !confirmed}>
+                            Erase data
+                        </Button>
+                    </div>
+                </form>
+            )}
+
+            {phase === "watching" && (
+                <div>
+                    <p className="text-sm mb-3">
+                        Erasing the data left over from <strong className="break-all">{address}</strong>.
+                    </p>
+                    <p role="status" className="flex items-center gap-2 text-sm font-semibold mb-3">
+                        <span className="w-4 h-4 rounded-full border-2 border-current/30 border-t-current animate-spin" aria-hidden="true" />
+                        {progressLabel(status)}
+                    </p>
+                    {checkFailed && (
+                        <p className="text-sm text-danger mb-3">Could not check how far the erasure has got. Trying again&hellip;</p>
+                    )}
+                    <p className="text-sm text-text-muted mb-4">
+                        You can close this window: the erasure carries on in the background, and the Mailboxes page shows how it is going.
+                    </p>
+                    <div className="flex justify-end">
+                        <Button type="button" variant="secondary" className="!w-auto" onClick={onClose}>
+                            Stop watching
+                        </Button>
+                    </div>
+                </div>
+            )}
+
+            {phase === "done" && (
+                <div>
+                    <p role="status" className="text-sm mb-4">
+                        Everything left over from <strong className="break-all">{address}</strong> was erased. The address is free to use again.
+                    </p>
+                    <div className="flex justify-end">
+                        <Button type="button" className="!w-auto" onClick={handleDone}>
+                            {doneLabel}
+                        </Button>
+                    </div>
+                </div>
+            )}
+
+            {phase === "refused" && (
+                <div>
+                    <Alert>{error}</Alert>
+                    <div className="flex justify-end">
+                        <Button type="button" variant="secondary" className="!w-auto" onClick={onClose}>
+                            OK
+                        </Button>
+                    </div>
+                </div>
+            )}
+        </Modal>
+    );
+}

package/apps/shared/components/admin/mailboxes/EscrowScopeCard.tsx

@@ -1,152 +1,152 @@
-///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2026 Jean-Philippe Steinmetz
-// SPDX-License-Identifier: MPL-2.0
-///////////////////////////////////////////////////////////////////////////////
-import React, { FormEvent, useEffect, useState } from "react";
-import { ApiRequestError } from "@rapidmx/react-shared/util/api.js";
-import { EscrowScope, listEscrowScopes } from "@rapidmx/react-shared/admin/escrowScopesApi.js";
-import { Mailbox, updateMailbox } from "@rapidmx/react-shared/mail/mailApi.js";
-import Alert from "@rapidmx/react-shared/components/feedback/Alert.js";
-import Button from "@rapidmx/react-shared/components/buttons/Button.js";
-import Modal from "@rapidmx/react-shared/components/overlays/Modal.js";
-
-const SELECT_CLASS =
-    "text-sm py-2 px-3 border border-border rounded-sm bg-surface text-text focus:outline-none focus:border-primary";
-
-/** Enough for any realistic deployment's scopes in one list. */
-const SCOPE_LIST_LIMIT = 200;
-
-export interface EscrowScopeCardProps {
-    mailbox: Mailbox;
-    /** Called with the saved mailbox, same push-up pattern as `ResourceSettingsCard`. */
-    onUpdate: (mailbox: Mailbox) => void;
-}
-
-/**
- * Assigns a mailbox to an escrow scope (or none), which decides whose holders can recover its encrypted mail. Only
- * shown in the admin console, whose trusted-role gate the server enforces again for `escrowScopeId`.
- */
-export default function EscrowScopeCard({ mailbox, onUpdate }: EscrowScopeCardProps) {
-    const [scopes, setScopes] = useState<EscrowScope[] | null>(null);
-    const [loadError, setLoadError] = useState<string | null>(null);
-    const [escrowScopeId, setEscrowScopeId] = useState(mailbox.escrowScopeId ?? "");
-    const [saving, setSaving] = useState(false);
-    const [saveError, setSaveError] = useState<string | null>(null);
-    const [saved, setSaved] = useState(false);
-    const [confirming, setConfirming] = useState(false);
-
-    useEffect(() => {
-        listEscrowScopes({ limit: SCOPE_LIST_LIMIT })
-            .then(setScopes)
-            .catch((err) => setLoadError(err instanceof ApiRequestError ? err.message : "Could not load escrow scopes."));
-    }, []);
-
-    // Changing the scope changes who can recover this mailbox's encrypted mail, so it's confirmed first.
-    function handleSubmit(e: FormEvent) {
-        e.preventDefault();
-        setConfirming(true);
-    }
-
-    async function save() {
-        setConfirming(false);
-        setSaveError(null);
-        setSaved(false);
-        setSaving(true);
-        try {
-            const updated = await updateMailbox({ uid: mailbox.uid, version: mailbox.version, escrowScopeId: escrowScopeId || null });
-            onUpdate(updated);
-            setSaved(true);
-        } catch (err) {
-            setSaveError(err instanceof ApiRequestError ? err.message : "Could not save the escrow scope.");
-        } finally {
-            setSaving(false);
-        }
-    }
-
-    const current = mailbox.escrowScopeId ?? "";
-    const unknownCurrent = !!current && !!scopes && !scopes.some((scope) => scope.uid === current);
-
-    return (
-        <div className="bg-surface border border-border rounded-md p-6">
-            <h2 className="text-base font-bold uppercase tracking-wide mb-1">Escrow scope</h2>
-            <p className="text-sm text-text-muted mb-4">
-                The holders of this scope can jointly recover this mailbox&rsquo;s encrypted mail, for example for legal
-                discovery. With no scope, nobody can.
-            </p>
-
-            {loadError && <Alert>{loadError}</Alert>}
-            {saveError && <Alert>{saveError}</Alert>}
-            {saved && !saveError && <div className="mb-4 text-sm text-success font-medium">Saved.</div>}
-
-            {scopes && (
-                <form onSubmit={handleSubmit} className="flex items-end gap-3 flex-wrap">
-                    <label className="flex flex-col gap-1.5 text-sm">
-                        <span className="font-semibold">Scope</span>
-                        <select
-                            aria-label="Escrow scope"
-                            className={SELECT_CLASS}
-                            value={escrowScopeId}
-                            onChange={(e) => {
-                                setEscrowScopeId(e.target.value);
-                                setSaved(false);
-                            }}
-                        >
-                            <option value="">No escrow</option>
-                            {unknownCurrent && <option value={current}>Unknown scope ({current})</option>}
-                            {scopes.map((scope) => (
-                                <option key={scope.uid} value={scope.uid}>
-                                    {scope.name}
-                                </option>
-                            ))}
-                        </select>
-                    </label>
-                    <Button type="submit" className="!w-auto" loading={saving} disabled={saving || escrowScopeId === current}>
-                        Save escrow scope
-                    </Button>
-                </form>
-            )}
-
-            <Modal open={confirming} onClose={() => setConfirming(false)} title="Change escrow scope">
-                <p className="text-sm mb-3">
-                    This changes who can jointly recover <strong className="break-all">{mailbox.primarySmtpAddress}</strong>
-                    &rsquo;s encrypted mail.
-                </p>
-                <dl className="grid grid-cols-[auto_1fr] gap-x-4 gap-y-1 text-sm mb-4">
-                    <dt className="text-text-muted">From</dt>
-                    <dd className="break-all">
-                        <ScopeSummary uid={current} scopes={scopes ?? []} />
-                    </dd>
-                    <dt className="text-text-muted">To</dt>
-                    <dd className="break-all">
-                        <ScopeSummary uid={escrowScopeId} scopes={scopes ?? []} />
-                    </dd>
-                </dl>
-                <div className="flex gap-3 justify-end">
-                    <Button type="button" variant="secondary" className="!w-auto" onClick={() => setConfirming(false)}>
-                        Cancel
-                    </Button>
-                    <Button type="button" className="!w-auto" onClick={() => void save()}>
-                        Confirm and save
-                    </Button>
-                </div>
-            </Modal>
-        </div>
-    );
-}
-
-/** A scope's name, holders and required approvals - or what having no (or an unlisted) scope means. */
-function ScopeSummary({ uid, scopes }: { uid: string; scopes: EscrowScope[] }) {
-    if (!uid) {
-        return <span>No escrow - nobody can recover this mailbox&rsquo;s encrypted mail</span>;
-    }
-    const scope = scopes.find((candidate) => candidate.uid === uid);
-    if (!scope) {
-        return <span>Unknown scope ({uid})</span>;
-    }
-    return (
-        <span>
-            <strong>{scope.name}</strong> - holders {scope.holderUserUids.join(", ")}; {scope.requiredHolders} of{" "}
-            {scope.holderUserUids.length} must approve
-        </span>
-    );
-}
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import React, { FormEvent, useEffect, useState } from "react";
+import { ApiRequestError } from "@rapidmx/react-shared/util/api.js";
+import { EscrowScope, listEscrowScopes } from "@rapidmx/react-shared/admin/escrowScopesApi.js";
+import { Mailbox, updateMailbox } from "@rapidmx/react-shared/mail/mailApi.js";
+import Alert from "@rapidmx/react-shared/components/feedback/Alert.js";
+import Button from "@rapidmx/react-shared/components/buttons/Button.js";
+import Modal from "@rapidmx/react-shared/components/overlays/Modal.js";
+
+const SELECT_CLASS =
+    "text-sm py-2 px-3 border border-border rounded-sm bg-surface text-text focus:outline-none focus:border-primary";
+
+/** Enough for any realistic deployment's scopes in one list. */
+const SCOPE_LIST_LIMIT = 200;
+
+export interface EscrowScopeCardProps {
+    mailbox: Mailbox;
+    /** Called with the saved mailbox, same push-up pattern as `ResourceSettingsCard`. */
+    onUpdate: (mailbox: Mailbox) => void;
+}
+
+/**
+ * Assigns a mailbox to an escrow scope (or none), which decides whose holders can recover its encrypted mail. Only
+ * shown in the admin console, whose trusted-role gate the server enforces again for `escrowScopeId`.
+ */
+export default function EscrowScopeCard({ mailbox, onUpdate }: EscrowScopeCardProps) {
+    const [scopes, setScopes] = useState<EscrowScope[] | null>(null);
+    const [loadError, setLoadError] = useState<string | null>(null);
+    const [escrowScopeId, setEscrowScopeId] = useState(mailbox.escrowScopeId ?? "");
+    const [saving, setSaving] = useState(false);
+    const [saveError, setSaveError] = useState<string | null>(null);
+    const [saved, setSaved] = useState(false);
+    const [confirming, setConfirming] = useState(false);
+
+    useEffect(() => {
+        listEscrowScopes({ limit: SCOPE_LIST_LIMIT })
+            .then(setScopes)
+            .catch((err) => setLoadError(err instanceof ApiRequestError ? err.message : "Could not load escrow scopes."));
+    }, []);
+
+    // Changing the scope changes who can recover this mailbox's encrypted mail, so it's confirmed first.
+    function handleSubmit(e: FormEvent) {
+        e.preventDefault();
+        setConfirming(true);
+    }
+
+    async function save() {
+        setConfirming(false);
+        setSaveError(null);
+        setSaved(false);
+        setSaving(true);
+        try {
+            const updated = await updateMailbox({ uid: mailbox.uid, version: mailbox.version, escrowScopeId: escrowScopeId || null });
+            onUpdate(updated);
+            setSaved(true);
+        } catch (err) {
+            setSaveError(err instanceof ApiRequestError ? err.message : "Could not save the escrow scope.");
+        } finally {
+            setSaving(false);
+        }
+    }
+
+    const current = mailbox.escrowScopeId ?? "";
+    const unknownCurrent = !!current && !!scopes && !scopes.some((scope) => scope.uid === current);
+
+    return (
+        <div className="bg-surface border border-border rounded-md p-6">
+            <h2 className="text-base font-bold uppercase tracking-wide mb-1">Escrow scope</h2>
+            <p className="text-sm text-text-muted mb-4">
+                The holders of this scope can jointly recover this mailbox&rsquo;s encrypted mail, for example for legal
+                discovery. With no scope, nobody can.
+            </p>
+
+            {loadError && <Alert>{loadError}</Alert>}
+            {saveError && <Alert>{saveError}</Alert>}
+            {saved && !saveError && <div className="mb-4 text-sm text-success font-medium">Saved.</div>}
+
+            {scopes && (
+                <form onSubmit={handleSubmit} className="flex items-end gap-3 flex-wrap">
+                    <label className="flex flex-col gap-1.5 text-sm">
+                        <span className="font-semibold">Scope</span>
+                        <select
+                            aria-label="Escrow scope"
+                            className={SELECT_CLASS}
+                            value={escrowScopeId}
+                            onChange={(e) => {
+                                setEscrowScopeId(e.target.value);
+                                setSaved(false);
+                            }}
+                        >
+                            <option value="">No escrow</option>
+                            {unknownCurrent && <option value={current}>Unknown scope ({current})</option>}
+                            {scopes.map((scope) => (
+                                <option key={scope.uid} value={scope.uid}>
+                                    {scope.name}
+                                </option>
+                            ))}
+                        </select>
+                    </label>
+                    <Button type="submit" className="!w-auto" loading={saving} disabled={saving || escrowScopeId === current}>
+                        Save escrow scope
+                    </Button>
+                </form>
+            )}
+
+            <Modal open={confirming} onClose={() => setConfirming(false)} title="Change escrow scope">
+                <p className="text-sm mb-3">
+                    This changes who can jointly recover <strong className="break-all">{mailbox.primarySmtpAddress}</strong>
+                    &rsquo;s encrypted mail.
+                </p>
+                <dl className="grid grid-cols-[auto_1fr] gap-x-4 gap-y-1 text-sm mb-4">
+                    <dt className="text-text-muted">From</dt>
+                    <dd className="break-all">
+                        <ScopeSummary uid={current} scopes={scopes ?? []} />
+                    </dd>
+                    <dt className="text-text-muted">To</dt>
+                    <dd className="break-all">
+                        <ScopeSummary uid={escrowScopeId} scopes={scopes ?? []} />
+                    </dd>
+                </dl>
+                <div className="flex gap-3 justify-end">
+                    <Button type="button" variant="secondary" className="!w-auto" onClick={() => setConfirming(false)}>
+                        Cancel
+                    </Button>
+                    <Button type="button" className="!w-auto" onClick={() => void save()}>
+                        Confirm and save
+                    </Button>
+                </div>
+            </Modal>
+        </div>
+    );
+}
+
+/** A scope's name, holders and required approvals - or what having no (or an unlisted) scope means. */
+function ScopeSummary({ uid, scopes }: { uid: string; scopes: EscrowScope[] }) {
+    if (!uid) {
+        return <span>No escrow - nobody can recover this mailbox&rsquo;s encrypted mail</span>;
+    }
+    const scope = scopes.find((candidate) => candidate.uid === uid);
+    if (!scope) {
+        return <span>Unknown scope ({uid})</span>;
+    }
+    return (
+        <span>
+            <strong>{scope.name}</strong> - holders {scope.holderUserUids.join(", ")}; {scope.requiredHolders} of{" "}
+            {scope.holderUserUids.length} must approve
+        </span>
+    );
+}