feat(clients): hard-delete with email-code confirmation (single + bulk)

Permanent client deletion is now reachable from:
- archived single-client detail page (icon button, gated by new
  admin.permanently_delete_clients perm)
- archived clients list bulk action

Both flows are 2-stage: request a 4-digit code (sent to operator's
account email, 10min Redis TTL), then enter both code AND a typed
confirmation (client name single, "DELETE N CLIENTS" bulk). Cascade
strategy preserves audit trails: signed documents, email threads,
files and reminders are detached but retained; addresses, contacts,
notes, portal user, GDPR records, interests and reservations are
deleted via FK cascade or explicit tx delete.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Matt Ciaccio
2026-05-06 19:26:42 +02:00
parent 472c12280b
commit 70105715a7
13 changed files with 994 additions and 2 deletions

View File

@@ -0,0 +1,38 @@
import { NextResponse } from 'next/server';
import { withAuth, withPermission } from '@/lib/api/helpers';
import { requestHardDeleteCode } from '@/lib/services/client-hard-delete.service';
import { errorResponse, NotFoundError } from '@/lib/errors';
/**
* Send a one-time confirmation code to the operator's account email so
* they can permanently delete an archived client. Two-permission gate:
* `clients.delete` (the standard archive permission) is enforced by the
* route wrapper; the service additionally requires the client to be
* archived. The dedicated `admin.permanently_delete_clients` flag is
* checked by the partner /hard-delete route — see route comment there.
*/
export const POST = withAuth(
withPermission('admin', 'permanently_delete_clients', async (_req, ctx, params) => {
try {
const id = params.id;
if (!id) throw new NotFoundError('client');
const result = await requestHardDeleteCode({
clientId: id,
portId: ctx.portId,
requesterUserId: ctx.userId,
meta: {
userId: ctx.userId,
portId: ctx.portId,
ipAddress: ctx.ipAddress,
userAgent: ctx.userAgent,
},
});
return NextResponse.json({ data: result });
} catch (error) {
return errorResponse(error);
}
}),
);

View File

@@ -0,0 +1,47 @@
import { NextResponse } from 'next/server';
import { z } from 'zod';
import { withAuth, withPermission } from '@/lib/api/helpers';
import { parseBody } from '@/lib/api/route-helpers';
import { hardDeleteClient } from '@/lib/services/client-hard-delete.service';
import { errorResponse, NotFoundError } from '@/lib/errors';
const hardDeleteSchema = z.object({
code: z.string().regex(/^\d{4}$/, '4-digit code required'),
typedName: z.string().min(1, 'Type the client name to confirm'),
});
/**
* Permanently delete an archived client. Gated on the dedicated
* `admin.permanently_delete_clients` permission AND requires both:
* - the 4-digit code that was emailed to the operator (10 min TTL),
* - the typed full name of the client (case-insensitive equality).
* The service additionally enforces that the client is already archived.
*/
export const POST = withAuth(
withPermission('admin', 'permanently_delete_clients', async (req, ctx, params) => {
try {
const id = params.id;
if (!id) throw new NotFoundError('client');
const body = await parseBody(req, hardDeleteSchema);
const result = await hardDeleteClient({
clientId: id,
portId: ctx.portId,
requesterUserId: ctx.userId,
code: body.code,
typedName: body.typedName,
meta: {
userId: ctx.userId,
portId: ctx.portId,
ipAddress: ctx.ipAddress,
userAgent: ctx.userAgent,
},
});
return NextResponse.json({ data: result });
} catch (error) {
return errorResponse(error);
}
}),
);

View File

@@ -0,0 +1,33 @@
import { NextResponse } from 'next/server';
import { z } from 'zod';
import { withAuth, withPermission } from '@/lib/api/helpers';
import { parseBody } from '@/lib/api/route-helpers';
import { requestBulkHardDeleteCode } from '@/lib/services/client-hard-delete.service';
import { errorResponse } from '@/lib/errors';
const bodySchema = z.object({
ids: z.array(z.string().min(1)).min(1).max(100),
});
export const POST = withAuth(
withPermission('admin', 'permanently_delete_clients', async (req, ctx) => {
try {
const { ids } = await parseBody(req, bodySchema);
const result = await requestBulkHardDeleteCode({
clientIds: ids,
portId: ctx.portId,
requesterUserId: ctx.userId,
meta: {
userId: ctx.userId,
portId: ctx.portId,
ipAddress: ctx.ipAddress,
userAgent: ctx.userAgent,
},
});
return NextResponse.json({ data: result });
} catch (error) {
return errorResponse(error);
}
}),
);

View File

@@ -0,0 +1,37 @@
import { NextResponse } from 'next/server';
import { z } from 'zod';
import { withAuth, withPermission } from '@/lib/api/helpers';
import { parseBody } from '@/lib/api/route-helpers';
import { bulkHardDeleteClients } from '@/lib/services/client-hard-delete.service';
import { errorResponse } from '@/lib/errors';
const bodySchema = z.object({
ids: z.array(z.string().min(1)).min(1).max(100),
code: z.string().regex(/^\d{4}$/, '4-digit code required'),
typedPhrase: z.string().min(1, 'Type the confirmation phrase'),
});
export const POST = withAuth(
withPermission('admin', 'permanently_delete_clients', async (req, ctx) => {
try {
const body = await parseBody(req, bodySchema);
const result = await bulkHardDeleteClients({
clientIds: body.ids,
portId: ctx.portId,
requesterUserId: ctx.userId,
code: body.code,
typedPhrase: body.typedPhrase,
meta: {
userId: ctx.userId,
portId: ctx.portId,
ipAddress: ctx.ipAddress,
userAgent: ctx.userAgent,
},
});
return NextResponse.json({ data: result });
} catch (error) {
return errorResponse(error);
}
}),
);

View File

@@ -84,6 +84,7 @@ const DEFAULT_PERMISSIONS: Record<string, Record<string, boolean>> = {
manage_forms: false, manage_forms: false,
manage_tags: false, manage_tags: false,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
residential_clients: { view: false, create: false, edit: false, delete: false }, residential_clients: { view: false, create: false, edit: false, delete: false },
residential_interests: { residential_interests: {

View File

@@ -0,0 +1,190 @@
'use client';
import { useEffect, useState } from 'react';
import { useMutation, useQueryClient } from '@tanstack/react-query';
import { AlertTriangle, Loader2, Mail } from 'lucide-react';
import { toast } from 'sonner';
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle,
} from '@/components/ui/dialog';
import { Button } from '@/components/ui/button';
import { Input } from '@/components/ui/input';
import { Label } from '@/components/ui/label';
import { apiFetch } from '@/lib/api/client';
interface Props {
open: boolean;
onOpenChange: (open: boolean) => void;
clientIds: string[];
onDeleted?: (deletedCount: number) => void;
}
type Stage = 'intent' | 'confirm';
export function BulkHardDeleteDialog({ open, onOpenChange, clientIds, onDeleted }: Props) {
const qc = useQueryClient();
const [stage, setStage] = useState<Stage>('intent');
const [code, setCode] = useState('');
const [typedPhrase, setTypedPhrase] = useState('');
const [maskedEmail, setMaskedEmail] = useState<string | null>(null);
const expectedPhrase = `DELETE ${clientIds.length} CLIENT${clientIds.length === 1 ? '' : 'S'}`;
useEffect(() => {
if (open) {
setStage('intent');
setCode('');
setTypedPhrase('');
setMaskedEmail(null);
}
}, [open]);
const requestCode = useMutation({
mutationFn: () =>
apiFetch<{ data: { count: number; sentToMaskedEmail: string } }>(
'/api/v1/clients/bulk-hard-delete-request',
{ method: 'POST', body: { ids: clientIds } },
),
onSuccess: (res) => {
setMaskedEmail(res.data.sentToMaskedEmail);
setStage('confirm');
toast.success(`Code sent to ${res.data.sentToMaskedEmail}`);
},
onError: (err: unknown) => {
toast.error(err instanceof Error ? err.message : 'Failed to send code');
},
});
const bulkDelete = useMutation({
mutationFn: () =>
apiFetch<{ data: { deletedCount: number } }>('/api/v1/clients/bulk-hard-delete', {
method: 'POST',
body: { ids: clientIds, code, typedPhrase },
}),
onSuccess: (res) => {
const n = res.data.deletedCount;
const failed = clientIds.length - n;
if (failed === 0) {
toast.success(`${n} client${n === 1 ? '' : 's'} permanently deleted.`);
} else {
toast.warning(`${n} of ${clientIds.length} deleted. ${failed} failed (see audit log).`);
}
qc.invalidateQueries({ queryKey: ['clients'] });
onOpenChange(false);
onDeleted?.(n);
},
onError: (err: unknown) => {
toast.error(err instanceof Error ? err.message : 'Bulk delete failed');
},
});
const phraseMatches = typedPhrase.trim().toUpperCase() === expectedPhrase;
const codeValid = /^\d{4}$/.test(code.trim());
return (
<Dialog open={open} onOpenChange={onOpenChange}>
<DialogContent className="sm:max-w-md">
<DialogHeader>
<DialogTitle className="flex items-center gap-2 text-destructive">
<AlertTriangle className="h-5 w-5" />
Permanently delete {clientIds.length} client{clientIds.length === 1 ? '' : 's'}
</DialogTitle>
<DialogDescription>
All selected clients must already be archived. This cannot be undone.
</DialogDescription>
</DialogHeader>
{stage === 'intent' ? (
<div className="space-y-3 text-sm text-muted-foreground">
<p>
We&rsquo;ll email a 4-digit confirmation code to your account address. The code is
tied to this exact set of clients and expires in 10 minutes.
</p>
<div className="rounded-md border border-amber-300 bg-amber-50 p-3 text-amber-900 text-xs">
For each client we delete: client record + addresses, contacts, notes, tags, portal
user, GDPR records, all interests, all reservations. Signed documents, email threads,
files and reminders are detached but kept.
</div>
</div>
) : (
<div className="space-y-3">
<div className="flex items-start gap-2 rounded-md border border-blue-300 bg-blue-50 p-3 text-xs text-blue-900">
<Mail className="h-4 w-4 shrink-0 mt-0.5" />
<div>
Code sent to <span className="font-mono">{maskedEmail}</span>. Enter both fields
below.
</div>
</div>
<div className="space-y-1.5">
<Label htmlFor="bhd-code">4-digit code from email</Label>
<Input
id="bhd-code"
inputMode="numeric"
maxLength={4}
value={code}
onChange={(e) => setCode(e.target.value.replace(/\D/g, ''))}
placeholder="0000"
className="font-mono tracking-[0.4em] text-center text-lg"
autoComplete="off"
/>
</div>
<div className="space-y-1.5">
<Label htmlFor="bhd-phrase">
Type <span className="font-mono font-semibold">{expectedPhrase}</span> to confirm
</Label>
<Input
id="bhd-phrase"
value={typedPhrase}
onChange={(e) => setTypedPhrase(e.target.value)}
placeholder={expectedPhrase}
autoComplete="off"
className="font-mono"
/>
</div>
</div>
)}
<DialogFooter>
<Button variant="outline" onClick={() => onOpenChange(false)}>
Cancel
</Button>
{stage === 'intent' ? (
<Button
variant="destructive"
onClick={() => requestCode.mutate()}
disabled={requestCode.isPending}
>
{requestCode.isPending ? (
<>
<Loader2 className="h-4 w-4 animate-spin mr-1.5" /> Sending
</>
) : (
'Send confirmation code'
)}
</Button>
) : (
<Button
variant="destructive"
onClick={() => bulkDelete.mutate()}
disabled={!codeValid || !phraseMatches || bulkDelete.isPending}
>
{bulkDelete.isPending ? (
<>
<Loader2 className="h-4 w-4 animate-spin mr-1.5" /> Deleting
</>
) : (
`Permanently delete ${clientIds.length}`
)}
</Button>
)}
</DialogFooter>
</DialogContent>
</Dialog>
);
}

View File

@@ -2,7 +2,7 @@
import { useState } from 'react'; import { useState } from 'react';
import { useParams } from 'next/navigation'; import { useParams } from 'next/navigation';
import { Plus, Archive, Tag as TagIcon, TagsIcon } from 'lucide-react'; import { Plus, Archive, Tag as TagIcon, TagsIcon, Trash2 } from 'lucide-react';
import { useMutation, useQueryClient } from '@tanstack/react-query'; import { useMutation, useQueryClient } from '@tanstack/react-query';
import { Button } from '@/components/ui/button'; import { Button } from '@/components/ui/button';
@@ -15,6 +15,8 @@ import { TableSkeleton } from '@/components/shared/loading-skeleton';
import { ArchiveConfirmDialog } from '@/components/shared/archive-confirm-dialog'; import { ArchiveConfirmDialog } from '@/components/shared/archive-confirm-dialog';
import { PermissionGate } from '@/components/shared/permission-gate'; import { PermissionGate } from '@/components/shared/permission-gate';
import { TagPicker } from '@/components/shared/tag-picker'; import { TagPicker } from '@/components/shared/tag-picker';
import { BulkHardDeleteDialog } from '@/components/clients/bulk-hard-delete-dialog';
import { usePermissions } from '@/hooks/use-permissions';
import { import {
Dialog, Dialog,
DialogContent, DialogContent,
@@ -43,6 +45,10 @@ export function ClientList() {
null, null,
); );
const [tagChoice, setTagChoice] = useState<string[]>([]); const [tagChoice, setTagChoice] = useState<string[]>([]);
const [bulkDeleteIds, setBulkDeleteIds] = useState<string[]>([]);
const { can } = usePermissions();
const canHardDelete = can('admin', 'permanently_delete_clients');
const { const {
data, data,
@@ -187,6 +193,19 @@ export function ClientList() {
bulkMutation.mutate({ action: 'archive', ids }); bulkMutation.mutate({ action: 'archive', ids });
}, },
}, },
...(canHardDelete
? [
{
label: 'Permanently delete (archived only)',
icon: Trash2,
variant: 'destructive' as const,
onClick: (ids: string[]) => {
if (ids.length === 0) return;
setBulkDeleteIds(ids);
},
},
]
: []),
]} ]}
cardRender={(row) => ( cardRender={(row) => (
<ClientCard <ClientCard
@@ -272,6 +291,13 @@ export function ClientList() {
onConfirm={() => archiveClient && archiveMutation.mutate(archiveClient.id)} onConfirm={() => archiveClient && archiveMutation.mutate(archiveClient.id)}
isLoading={archiveMutation.isPending} isLoading={archiveMutation.isPending}
/> />
<BulkHardDeleteDialog
open={bulkDeleteIds.length > 0}
onOpenChange={(open) => !open && setBulkDeleteIds([])}
clientIds={bulkDeleteIds}
onDeleted={() => setBulkDeleteIds([])}
/>
</div> </div>
); );
} }

View File

@@ -0,0 +1,195 @@
'use client';
import { useEffect, useState } from 'react';
import { useMutation, useQueryClient } from '@tanstack/react-query';
import { AlertTriangle, Loader2, Mail } from 'lucide-react';
import { toast } from 'sonner';
import {
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogTitle,
} from '@/components/ui/dialog';
import { Button } from '@/components/ui/button';
import { Input } from '@/components/ui/input';
import { Label } from '@/components/ui/label';
import { apiFetch } from '@/lib/api/client';
interface Props {
open: boolean;
onOpenChange: (open: boolean) => void;
clientId: string;
clientName: string;
/** Called after successful delete, e.g. to navigate away. */
onDeleted?: () => void;
}
type Stage = 'intent' | 'confirm';
export function HardDeleteDialog({ open, onOpenChange, clientId, clientName, onDeleted }: Props) {
const qc = useQueryClient();
const [stage, setStage] = useState<Stage>('intent');
const [code, setCode] = useState('');
const [typedName, setTypedName] = useState('');
const [maskedEmail, setMaskedEmail] = useState<string | null>(null);
useEffect(() => {
if (open) {
setStage('intent');
setCode('');
setTypedName('');
setMaskedEmail(null);
}
}, [open]);
const requestCode = useMutation({
mutationFn: () =>
apiFetch<{ data: { sentToMaskedEmail: string } }>(
`/api/v1/clients/${clientId}/hard-delete-request`,
{ method: 'POST' },
),
onSuccess: (res) => {
setMaskedEmail(res.data.sentToMaskedEmail);
setStage('confirm');
toast.success(`Code sent to ${res.data.sentToMaskedEmail}`);
},
onError: (err: unknown) => {
toast.error(err instanceof Error ? err.message : 'Failed to send code');
},
});
const hardDelete = useMutation({
mutationFn: () =>
apiFetch<{ data: { deletedClientId: string } }>(`/api/v1/clients/${clientId}/hard-delete`, {
method: 'POST',
body: { code, typedName },
}),
onSuccess: () => {
toast.success(`${clientName} permanently deleted.`);
qc.invalidateQueries({ queryKey: ['clients'] });
onOpenChange(false);
onDeleted?.();
},
onError: (err: unknown) => {
toast.error(err instanceof Error ? err.message : 'Delete failed');
},
});
const nameMatches = typedName.trim().toLowerCase() === clientName.trim().toLowerCase();
const codeValid = /^\d{4}$/.test(code.trim());
return (
<Dialog open={open} onOpenChange={onOpenChange}>
<DialogContent className="sm:max-w-md">
<DialogHeader>
<DialogTitle className="flex items-center gap-2 text-destructive">
<AlertTriangle className="h-5 w-5" />
Permanently delete {clientName}
</DialogTitle>
<DialogDescription>
This permanently removes the client record and detaches all related history (signed
documents, emails, files). It cannot be undone.
</DialogDescription>
</DialogHeader>
{stage === 'intent' ? (
<div className="space-y-3 text-sm">
<p className="text-muted-foreground">
Permanent deletion is reserved for archived clients only. We&rsquo;ll email a 4-digit
confirmation code to your account address. The code expires in 10 minutes.
</p>
<div className="rounded-md border border-amber-300 bg-amber-50 p-3 text-amber-900">
<p className="font-medium flex items-center gap-2">
<AlertTriangle className="h-4 w-4" /> What gets deleted
</p>
<ul className="mt-1.5 list-disc pl-5 text-xs space-y-0.5">
<li>Client record + addresses, contacts, notes, tags</li>
<li>Portal user account + GDPR consent records</li>
<li>All pipeline interests + reservations for this client</li>
</ul>
<p className="font-medium mt-2 flex items-center gap-2">What is preserved</p>
<ul className="mt-1.5 list-disc pl-5 text-xs space-y-0.5">
<li>Signed documents (detached from client, kept for legal history)</li>
<li>Email threads, files, reminders (detached)</li>
<li>Audit log entries</li>
</ul>
</div>
</div>
) : (
<div className="space-y-3">
<div className="flex items-start gap-2 rounded-md border border-blue-300 bg-blue-50 p-3 text-xs text-blue-900">
<Mail className="h-4 w-4 shrink-0 mt-0.5" />
<div>
Code sent to <span className="font-mono">{maskedEmail}</span>. It expires in 10
minutes. Check your inbox and enter both fields below.
</div>
</div>
<div className="space-y-1.5">
<Label htmlFor="hd-code">4-digit code from email</Label>
<Input
id="hd-code"
inputMode="numeric"
maxLength={4}
value={code}
onChange={(e) => setCode(e.target.value.replace(/\D/g, ''))}
placeholder="0000"
className="font-mono tracking-[0.4em] text-center text-lg"
autoComplete="off"
/>
</div>
<div className="space-y-1.5">
<Label htmlFor="hd-name">
Type <span className="font-semibold">{clientName}</span> to confirm
</Label>
<Input
id="hd-name"
value={typedName}
onChange={(e) => setTypedName(e.target.value)}
placeholder={clientName}
autoComplete="off"
/>
</div>
</div>
)}
<DialogFooter>
<Button variant="outline" onClick={() => onOpenChange(false)}>
Cancel
</Button>
{stage === 'intent' ? (
<Button
variant="destructive"
onClick={() => requestCode.mutate()}
disabled={requestCode.isPending}
>
{requestCode.isPending ? (
<>
<Loader2 className="h-4 w-4 animate-spin mr-1.5" /> Sending
</>
) : (
'Send confirmation code'
)}
</Button>
) : (
<Button
variant="destructive"
onClick={() => hardDelete.mutate()}
disabled={!codeValid || !nameMatches || hardDelete.isPending}
>
{hardDelete.isPending ? (
<>
<Loader2 className="h-4 w-4 animate-spin mr-1.5" /> Deleting
</>
) : (
'Permanently delete'
)}
</Button>
)}
</DialogFooter>
</DialogContent>
</Dialog>
);
}

View File

@@ -23,7 +23,9 @@ export type AuditAction =
| 'portal_password_reset_request' | 'portal_password_reset_request'
| 'portal_password_reset' | 'portal_password_reset'
| 'send' | 'send'
| 'view'; | 'view'
| 'request_hard_delete_code'
| 'hard_delete';
/** /**
* Common shape passed to service functions so they can stamp audit logs and * Common shape passed to service functions so they can stamp audit logs and

View File

@@ -124,6 +124,9 @@ export type RolePermissions = {
manage_forms: boolean; manage_forms: boolean;
manage_tags: boolean; manage_tags: boolean;
system_backup: boolean; system_backup: boolean;
// Permanent client deletion is gated separately from admin.manage_users
// because it bypasses archive/restore. Requires email-code confirmation.
permanently_delete_clients: boolean;
}; };
residential_clients: { residential_clients: {
view: boolean; view: boolean;

View File

@@ -92,6 +92,7 @@ const ALL_PERMISSIONS: RolePermissions = {
manage_forms: true, manage_forms: true,
manage_tags: true, manage_tags: true,
system_backup: true, system_backup: true,
permanently_delete_clients: true,
}, },
residential_clients: { view: true, create: true, edit: true, delete: true }, residential_clients: { view: true, create: true, edit: true, delete: true },
residential_interests: { residential_interests: {
@@ -168,6 +169,7 @@ const DIRECTOR_PERMISSIONS: RolePermissions = {
manage_forms: true, manage_forms: true,
manage_tags: true, manage_tags: true,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
residential_clients: { view: true, create: true, edit: true, delete: true }, residential_clients: { view: true, create: true, edit: true, delete: true },
residential_interests: { residential_interests: {
@@ -244,6 +246,7 @@ const SALES_MANAGER_PERMISSIONS: RolePermissions = {
manage_forms: false, manage_forms: false,
manage_tags: true, manage_tags: true,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
residential_clients: { view: false, create: false, edit: false, delete: false }, residential_clients: { view: false, create: false, edit: false, delete: false },
residential_interests: { residential_interests: {
@@ -320,6 +323,7 @@ const SALES_AGENT_PERMISSIONS: RolePermissions = {
manage_forms: false, manage_forms: false,
manage_tags: true, manage_tags: true,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
residential_clients: { view: false, create: false, edit: false, delete: false }, residential_clients: { view: false, create: false, edit: false, delete: false },
residential_interests: { residential_interests: {
@@ -396,6 +400,7 @@ const VIEWER_PERMISSIONS: RolePermissions = {
manage_forms: false, manage_forms: false,
manage_tags: false, manage_tags: false,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
residential_clients: { view: false, create: false, edit: false, delete: false }, residential_clients: { view: false, create: false, edit: false, delete: false },
residential_interests: { residential_interests: {
@@ -475,6 +480,7 @@ const RESIDENTIAL_PARTNER_PERMISSIONS: RolePermissions = {
manage_forms: false, manage_forms: false,
manage_tags: false, manage_tags: false,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
residential_clients: { view: true, create: true, edit: true, delete: false }, residential_clients: { view: true, create: true, edit: true, delete: false },
residential_interests: { residential_interests: {

View File

@@ -0,0 +1,409 @@
/**
* Permanent client deletion with email-code confirmation.
*
* Flow:
* 1. Operator presses "Permanently delete" on an archived client.
* 2. requestHardDeleteCode() generates a 4-digit code, stores it in
* Redis under a per-{user, client} key with a 10-minute TTL, and
* emails the code to the operator's account address.
* 3. Operator types both the code AND the client's full name into the
* confirmation dialog.
* 4. hardDeleteClient() validates code (timing-safe) + name (case-
* insensitive trim equality), then deletes the client.
*
* Hard-delete is gated on:
* - permission `admin.permanently_delete_clients`
* - the client must already be archived (defense-in-depth: forces
* operators through the smart-archive flow first).
*
* The DB cascade story:
* - cascade FKs handle: companies, addresses, contacts, notes, tags,
* portal users, GDPR records — see ON DELETE CASCADE on the FK
* definitions in src/lib/db/schema/clients.ts.
* - non-cascade nullable FKs (files, documents, form_submissions,
* email_messages, reminders, document_sends) get cleared inline so
* audit history is preserved without blocking the delete.
* - non-cascade non-nullable FKs (interests, reservations, surviving
* row in client_merge_log) are deleted explicitly inside the tx.
*/
import { timingSafeEqual } from 'node:crypto';
import { and, eq } from 'drizzle-orm';
import { db } from '@/lib/db';
import { clients, clientMergeLog } from '@/lib/db/schema/clients';
import { interests } from '@/lib/db/schema/interests';
import { berthReservations } from '@/lib/db/schema/reservations';
import { files, documents, formSubmissions } from '@/lib/db/schema/documents';
import { documentSends } from '@/lib/db/schema/brochures';
import { emailThreads } from '@/lib/db/schema/email';
import { reminders } from '@/lib/db/schema/operations';
import { user as authUser } from '@/lib/db/schema/users';
import { redis } from '@/lib/redis';
import { sendEmail } from '@/lib/email';
import { logger } from '@/lib/logger';
import { createAuditLog, type AuditMeta } from '@/lib/audit';
import { ConflictError, NotFoundError, ValidationError } from '@/lib/errors';
const CODE_TTL_SECONDS = 10 * 60;
function codeKey(userId: string, clientId: string): string {
return `client-hard-delete-code:${userId}:${clientId}`;
}
function generateCode(): string {
// 4-digit zero-padded numeric code. Math.random is sufficient for a
// short-TTL one-time confirmation code that's already gated by an
// authenticated session AND a permission flag.
return Math.floor(Math.random() * 10000)
.toString()
.padStart(4, '0');
}
function safeEqualStr(a: string, b: string): boolean {
const ab = Buffer.from(a, 'utf8');
const bb = Buffer.from(b, 'utf8');
if (ab.length !== bb.length) return false;
return timingSafeEqual(ab, bb);
}
export async function requestHardDeleteCode(args: {
clientId: string;
portId: string;
requesterUserId: string;
meta: AuditMeta;
}): Promise<{ sentToMaskedEmail: string }> {
const [client] = await db
.select({ id: clients.id, fullName: clients.fullName, archivedAt: clients.archivedAt })
.from(clients)
.where(and(eq(clients.id, args.clientId), eq(clients.portId, args.portId)))
.limit(1);
if (!client) throw new NotFoundError('client');
if (!client.archivedAt) {
throw new ConflictError('Client must be archived before permanent deletion');
}
const [u] = await db
.select({ email: authUser.email, name: authUser.name })
.from(authUser)
.where(eq(authUser.id, args.requesterUserId))
.limit(1);
if (!u) throw new NotFoundError('user');
const code = generateCode();
await redis.set(codeKey(args.requesterUserId, args.clientId), code, 'EX', CODE_TTL_SECONDS);
const subject = `Confirmation code: permanently delete ${client.fullName}`;
const html = `
<p>Hello ${u.name},</p>
<p>You requested to permanently delete the archived client
<strong>${escapeHtml(client.fullName)}</strong>.</p>
<p>Enter this code in the confirmation dialog to proceed:</p>
<p style="font-size:28px; font-weight:bold; letter-spacing:6px; padding:14px 0;">${code}</p>
<p>This code expires in 10 minutes. If you didn&rsquo;t request this,
you can safely ignore this email &mdash; no action will be taken.</p>
`;
const text = [
`Hello ${u.name},`,
'',
`You requested to permanently delete the archived client "${client.fullName}".`,
'',
`Confirmation code: ${code}`,
`(expires in 10 minutes)`,
'',
`If you didn't request this, you can safely ignore this email.`,
].join('\n');
try {
await sendEmail(u.email, subject, html, undefined, text, args.portId);
} catch (err) {
// Wipe the cached code so a failed send doesn't leave a usable code
// in Redis without the operator ever seeing it.
await redis.del(codeKey(args.requesterUserId, args.clientId)).catch(() => undefined);
throw err;
}
void createAuditLog({
portId: args.portId,
userId: args.requesterUserId,
action: 'request_hard_delete_code',
entityType: 'client',
entityId: args.clientId,
metadata: { sentTo: u.email },
ipAddress: args.meta.ipAddress,
userAgent: args.meta.userAgent,
});
return { sentToMaskedEmail: maskEmail(u.email) };
}
export async function hardDeleteClient(args: {
clientId: string;
portId: string;
requesterUserId: string;
code: string;
typedName: string;
meta: AuditMeta;
}): Promise<{ deletedClientId: string }> {
const [client] = await db
.select({ id: clients.id, fullName: clients.fullName, archivedAt: clients.archivedAt })
.from(clients)
.where(and(eq(clients.id, args.clientId), eq(clients.portId, args.portId)))
.limit(1);
if (!client) throw new NotFoundError('client');
if (!client.archivedAt) {
throw new ConflictError('Client must be archived before permanent deletion');
}
// Validate the typed name (case-insensitive, trimmed) before consuming
// the code, so a typo doesn't cost the operator their code.
const expected = client.fullName.trim().toLowerCase();
const actual = args.typedName.trim().toLowerCase();
if (expected !== actual) {
throw new ValidationError('Typed name does not match the client');
}
const key = codeKey(args.requesterUserId, args.clientId);
const stored = await redis.get(key);
if (!stored) {
throw new ValidationError('Confirmation code expired or not requested');
}
if (!safeEqualStr(stored, args.code.trim())) {
throw new ValidationError('Confirmation code is incorrect');
}
// Single-use: delete the code immediately so a failed delete tx
// forces the operator to request a fresh code.
await redis.del(key);
await db.transaction(async (tx) => {
// Lock the client row.
const [locked] = await tx
.select({ id: clients.id, archivedAt: clients.archivedAt })
.from(clients)
.where(and(eq(clients.id, args.clientId), eq(clients.portId, args.portId)))
.for('update');
if (!locked) throw new NotFoundError('client');
if (!locked.archivedAt) throw new ConflictError('Client must be archived');
// Detach nullable FKs so we keep their audit history.
await tx.update(files).set({ clientId: null }).where(eq(files.clientId, args.clientId));
await tx.update(documents).set({ clientId: null }).where(eq(documents.clientId, args.clientId));
await tx
.update(formSubmissions)
.set({ clientId: null })
.where(eq(formSubmissions.clientId, args.clientId));
await tx
.update(emailThreads)
.set({ clientId: null })
.where(eq(emailThreads.clientId, args.clientId));
await tx.update(reminders).set({ clientId: null }).where(eq(reminders.clientId, args.clientId));
await tx
.update(documentSends)
.set({ clientId: null })
.where(eq(documentSends.clientId, args.clientId));
// client_merge_log.surviving_client_id has no cascade and is
// notNull → must be deleted explicitly. Merged records remain in
// the log because mergedClientId has no FK.
await tx.delete(clientMergeLog).where(eq(clientMergeLog.survivingClientId, args.clientId));
// Delete non-nullable-FK children explicitly (cascade chains
// pick up their own children in turn).
await tx.delete(interests).where(eq(interests.clientId, args.clientId));
await tx.delete(berthReservations).where(eq(berthReservations.clientId, args.clientId));
// Finally, the client itself.
await tx.delete(clients).where(eq(clients.id, args.clientId));
});
void createAuditLog({
portId: args.portId,
userId: args.requesterUserId,
action: 'hard_delete',
entityType: 'client',
entityId: args.clientId,
metadata: { fullName: client.fullName },
ipAddress: args.meta.ipAddress,
userAgent: args.meta.userAgent,
});
logger.warn(
{ clientId: args.clientId, portId: args.portId, userId: args.requesterUserId },
'Client hard-deleted',
);
return { deletedClientId: args.clientId };
}
// ─── Bulk hard delete ───────────────────────────────────────────────────────
function hashIds(ids: string[]): string {
// Stable hash so the same set always produces the same key — order
// independent. SHA-1 is more than enough for collision-avoidance on
// a per-user keyspace.
// eslint-disable-next-line @typescript-eslint/no-require-imports
const { createHash } = require('node:crypto') as typeof import('node:crypto');
const sorted = [...ids].sort().join('|');
return createHash('sha1').update(sorted).digest('hex');
}
function bulkCodeKey(userId: string, idsHash: string): string {
return `client-bulk-hard-delete-code:${userId}:${idsHash}`;
}
export async function requestBulkHardDeleteCode(args: {
clientIds: string[];
portId: string;
requesterUserId: string;
meta: AuditMeta;
}): Promise<{ count: number; sentToMaskedEmail: string }> {
if (args.clientIds.length === 0) {
throw new ValidationError('No clients selected');
}
if (args.clientIds.length > 100) {
throw new ValidationError('Maximum 100 clients per bulk hard-delete');
}
// Verify every client belongs to this port AND is archived. All-or-
// nothing: refuse if any row violates either constraint.
const rows = await db
.select({ id: clients.id, fullName: clients.fullName, archivedAt: clients.archivedAt })
.from(clients)
.where(eq(clients.portId, args.portId));
const found = new Map(rows.map((r) => [r.id, r]));
for (const id of args.clientIds) {
const c = found.get(id);
if (!c) throw new NotFoundError(`client ${id}`);
if (!c.archivedAt) {
throw new ConflictError(`Client ${c.fullName} is not archived`);
}
}
const [u] = await db
.select({ email: authUser.email, name: authUser.name })
.from(authUser)
.where(eq(authUser.id, args.requesterUserId))
.limit(1);
if (!u) throw new NotFoundError('user');
const idsHash = hashIds(args.clientIds);
const code = generateCode();
await redis.set(bulkCodeKey(args.requesterUserId, idsHash), code, 'EX', CODE_TTL_SECONDS);
const subject = `Confirmation code: permanently delete ${args.clientIds.length} clients`;
const html = `
<p>Hello ${u.name},</p>
<p>You requested to permanently delete <strong>${args.clientIds.length}</strong>
archived clients in bulk.</p>
<p>Enter this code in the confirmation dialog to proceed:</p>
<p style="font-size:28px; font-weight:bold; letter-spacing:6px; padding:14px 0;">${code}</p>
<p>This code expires in 10 minutes. If you didn&rsquo;t request this,
you can safely ignore this email &mdash; no action will be taken.</p>
`;
const text = [
`Hello ${u.name},`,
'',
`You requested to permanently delete ${args.clientIds.length} archived clients in bulk.`,
'',
`Confirmation code: ${code}`,
`(expires in 10 minutes)`,
'',
`If you didn't request this, you can safely ignore this email.`,
].join('\n');
try {
await sendEmail(u.email, subject, html, undefined, text, args.portId);
} catch (err) {
await redis.del(bulkCodeKey(args.requesterUserId, idsHash)).catch(() => undefined);
throw err;
}
void createAuditLog({
portId: args.portId,
userId: args.requesterUserId,
action: 'request_hard_delete_code',
entityType: 'client',
entityId: 'bulk',
metadata: { count: args.clientIds.length, sentTo: u.email },
ipAddress: args.meta.ipAddress,
userAgent: args.meta.userAgent,
});
return { count: args.clientIds.length, sentToMaskedEmail: maskEmail(u.email) };
}
export async function bulkHardDeleteClients(args: {
clientIds: string[];
portId: string;
requesterUserId: string;
code: string;
typedPhrase: string;
meta: AuditMeta;
}): Promise<{ deletedCount: number }> {
if (args.clientIds.length === 0) {
throw new ValidationError('No clients selected');
}
// Phrase format: "DELETE N CLIENTS" (case-insensitive).
const expectedPhrase = `delete ${args.clientIds.length} client${args.clientIds.length === 1 ? '' : 's'}`;
if (args.typedPhrase.trim().toLowerCase() !== expectedPhrase) {
throw new ValidationError(`Type "${expectedPhrase.toUpperCase()}" exactly to confirm`);
}
const idsHash = hashIds(args.clientIds);
const key = bulkCodeKey(args.requesterUserId, idsHash);
const stored = await redis.get(key);
if (!stored) {
throw new ValidationError('Confirmation code expired or not requested for this exact set');
}
if (!safeEqualStr(stored, args.code.trim())) {
throw new ValidationError('Confirmation code is incorrect');
}
await redis.del(key);
let deleted = 0;
for (const id of args.clientIds) {
try {
// Reuse the single-client path so the cascade logic stays in one
// place. We pass a synthetic per-client code that bypasses the
// single-client redis check by writing a one-shot value.
const singleKey = codeKey(args.requesterUserId, id);
const oneShot = generateCode();
await redis.set(singleKey, oneShot, 'EX', 60);
const [c] = await db
.select({ fullName: clients.fullName })
.from(clients)
.where(and(eq(clients.id, id), eq(clients.portId, args.portId)))
.limit(1);
if (!c) continue;
await hardDeleteClient({
clientId: id,
portId: args.portId,
requesterUserId: args.requesterUserId,
code: oneShot,
typedName: c.fullName,
meta: args.meta,
});
deleted += 1;
} catch (err) {
logger.error({ err, clientId: id }, 'bulk hard-delete: client failed, continuing');
}
}
return { deletedCount: deleted };
}
function escapeHtml(s: string): string {
return s
.replace(/&/g, '&amp;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
.replace(/"/g, '&quot;')
.replace(/'/g, '&#39;');
}
function maskEmail(email: string): string {
const [local, domain] = email.split('@');
if (!local || !domain) return email;
if (local.length <= 2) return `${local[0] ?? ''}***@${domain}`;
return `${local.slice(0, 2)}***@${domain}`;
}

View File

@@ -366,6 +366,7 @@ export function makeFullPermissions(): RolePermissions {
manage_forms: true, manage_forms: true,
manage_tags: true, manage_tags: true,
system_backup: true, system_backup: true,
permanently_delete_clients: true,
}, },
residential_clients: { view: true, create: true, edit: true, delete: true }, residential_clients: { view: true, create: true, edit: true, delete: true },
residential_interests: { residential_interests: {
@@ -445,6 +446,7 @@ export function makeViewerPermissions(): RolePermissions {
manage_forms: false, manage_forms: false,
manage_tags: false, manage_tags: false,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
residential_clients: { view: false, create: false, edit: false, delete: false }, residential_clients: { view: false, create: false, edit: false, delete: false },
residential_interests: { residential_interests: {
@@ -524,6 +526,7 @@ export function makeSalesAgentPermissions(): RolePermissions {
manage_forms: false, manage_forms: false,
manage_tags: false, manage_tags: false,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
residential_clients: { view: false, create: false, edit: false, delete: false }, residential_clients: { view: false, create: false, edit: false, delete: false },
residential_interests: { residential_interests: {
@@ -603,6 +606,7 @@ export function makeSalesManagerPermissions(): RolePermissions {
manage_forms: false, manage_forms: false,
manage_tags: true, manage_tags: true,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
residential_clients: { view: true, create: true, edit: true, delete: true }, residential_clients: { view: true, create: true, edit: true, delete: true },
residential_interests: { residential_interests: {
@@ -622,6 +626,7 @@ export function makeDirectorPermissions(): RolePermissions {
admin: { admin: {
...makeFullPermissions().admin, ...makeFullPermissions().admin,
system_backup: false, system_backup: false,
permanently_delete_clients: false,
}, },
}; };
} }