Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(admin): add user deletion (#1109)

Corentin Thomassetd9bc129b7c74
diff --git a/.changeset/nine-schools-wait.md b/.changeset/nine-schools-wait.md
new file mode 100644
index 00000000..97b95ee1
--- /dev/null
+++ b/.changeset/nine-schools-wait.md
@@ -0,0 +1,5 @@
+---
+"@papra/app": patch
+---
+
+Added the possibility to delete a user in the admin user details page.
diff --git a/apps/papra-client/src/locales/en.dictionary.ts b/apps/papra-client/src/locales/en.dictionary.ts
index d7b1e170..4592ae31 100644
--- a/apps/papra-client/src/locales/en.dictionary.ts
+++ b/apps/papra-client/src/locales/en.dictionary.ts
@@ -862,6 +862,8 @@ export const translations = {
'api-errors.organization.max_members_count_reached': 'The maximum number of members and pending invitations for this organization has been reached. Please upgrade your plan to add more members.',
'api-errors.organization.has_active_subscription': 'Cannot delete organization with an active subscription. Please cancel your subscription first using the Manage Subscription button above.',
'api-errors.webhooks.ssrf_unsafe_url': 'The provided URL is not allowed. Webhook URLs must not point to private or reserved IP addresses.',
+ 'api-errors.users.still_owns_organizations': 'This user still owns one or more organizations. Delete or transfer those organizations before deleting the user.',
+ 'api-errors.users.cannot_delete_self': 'You cannot delete your own account from the admin panel.',
// Better auth api errors
'api-errors.USER_NOT_FOUND': 'User not found',
'api-errors.FAILED_TO_CREATE_USER': 'Failed to create user',
@@ -1081,6 +1083,15 @@ export const translations = {
'admin.user-detail.organizations.table.id': 'ID',
'admin.user-detail.organizations.table.name': 'Name',
'admin.user-detail.organizations.table.created': 'Created',
+ 'admin.user-detail.delete.title': 'Delete user',
+ 'admin.user-detail.delete.description': 'Permanently delete this user account. This will cascade to their organization memberships, sessions, two-factor settings and other authentication data. Organizations they still own must be deleted or transferred first.',
+ 'admin.user-detail.delete.button': 'Delete user',
+ 'admin.user-detail.delete.self-warning': 'You cannot delete your own account from the admin panel.',
+ 'admin.user-detail.delete.confirm.title': 'Delete user?',
+ 'admin.user-detail.delete.confirm.message': 'This action cannot be undone. Type the user\'s email below to confirm.',
+ 'admin.user-detail.delete.confirm.confirm-button': 'Delete user',
+ 'admin.user-detail.delete.confirm.cancel-button': 'Cancel',
+ 'admin.user-detail.delete.success': 'User deleted successfully.',
// Common / Shared
diff --git a/apps/papra-client/src/modules/admin/users/pages/user-detail.page.tsx b/apps/papra-client/src/modules/admin/users/pages/user-detail.page.tsx
index 4d1ff5f6..9d91f911 100644
--- a/apps/papra-client/src/modules/admin/users/pages/user-detail.page.tsx
+++ b/apps/papra-client/src/modules/admin/users/pages/user-detail.page.tsx
@@ -1,24 +1,64 @@
import type { Component } from 'solid-js';
-import { A, useParams } from '@solidjs/router';
-import { useQuery } from '@tanstack/solid-query';
+import { safely } from '@corentinth/chisels';
+import { A, useNavigate, useParams } from '@solidjs/router';
+import { useQuery, useQueryClient } from '@tanstack/solid-query';
import { For, Show } from 'solid-js';
import { RelativeTime } from '@/modules/i18n/components/RelativeTime';
import { useI18n } from '@/modules/i18n/i18n.provider';
+import { useConfirmModal } from '@/modules/shared/confirm';
+import { useI18nApiErrors } from '@/modules/shared/http/composables/i18n-api-errors';
import { Badge } from '@/modules/ui/components/badge';
import { Button } from '@/modules/ui/components/button';
-import { Card, CardContent, CardDescription, CardHeader, CardTitle } from '@/modules/ui/components/card';
+import { Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle } from '@/modules/ui/components/card';
+import { createToast } from '@/modules/ui/components/sonner';
import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from '@/modules/ui/components/table';
-import { getUserDetail } from '../users.services';
+import { useCurrentUser } from '@/modules/users/composables/useCurrentUser';
+import { deleteUser, getUserDetail } from '../users.services';
export const AdminUserDetailPage: Component = () => {
const { t } = useI18n();
const params = useParams<{ userId: string }>();
+ const navigate = useNavigate();
+ const queryClient = useQueryClient();
+ const { confirm } = useConfirmModal();
+ const { getErrorMessage } = useI18nApiErrors({ t });
+ const { user: currentUser } = useCurrentUser();
const query = useQuery(() => ({
queryKey: ['admin', 'users', params.userId],
queryFn: () => getUserDetail({ userId: params.userId }),
}));
+ const handleDelete = async (targetUser: { id: string; email: string }) => {
+ const confirmed = await confirm({
+ title: t('admin.user-detail.delete.confirm.title'),
+ message: t('admin.user-detail.delete.confirm.message'),
+ confirmButton: {
+ text: t('admin.user-detail.delete.confirm.confirm-button'),
+ variant: 'destructive',
+ },
+ cancelButton: {
+ text: t('admin.user-detail.delete.confirm.cancel-button'),
+ },
+ shouldType: targetUser.email,
+ });
+
+ if (!confirmed) {
+ return;
+ }
+
+ const [, error] = await safely(deleteUser({ userId: targetUser.id }));
+
+ if (error) {
+ createToast({ type: 'error', message: getErrorMessage({ error }) });
+ return;
+ }
+
+ await queryClient.invalidateQueries({ queryKey: ['admin', 'users'] });
+ createToast({ type: 'success', message: t('admin.user-detail.delete.success') });
+ navigate('/admin/users');
+ };
+
return (
<div class="p-6 max-w-screen-lg mx-auto mt-4">
<div class="mb-6">
@@ -157,6 +197,28 @@ export const AdminUserDetailPage: Component = () => {
</Show>
</CardContent>
</Card>
+
+ <Card class="border-destructive">
+ <CardHeader>
+ <CardTitle>{t('admin.user-detail.delete.title')}</CardTitle>
+ <CardDescription>{t('admin.user-detail.delete.description')}</CardDescription>
+ </CardHeader>
+ <CardFooter class="gap-4 flex-col items-start sm:flex-row sm:items-center">
+ <Button
+ variant="destructive"
+ class="flex-shrink-0"
+ disabled={data().user.id === currentUser.id}
+ onClick={() => handleDelete(data().user)}
+ >
+ {t('admin.user-detail.delete.button')}
+ </Button>
+ <Show when={data().user.id === currentUser.id}>
+ <span class="text-xs text-muted-foreground">
+ {t('admin.user-detail.delete.self-warning')}
+ </span>
+ </Show>
+ </CardFooter>
+ </Card>
</div>
)}
</Show>
diff --git a/apps/papra-client/src/modules/admin/users/users.services.ts b/apps/papra-client/src/modules/admin/users/users.services.ts
index 83d38eb9..d3a7359a 100644
--- a/apps/papra-client/src/modules/admin/users/users.services.ts
+++ b/apps/papra-client/src/modules/admin/users/users.services.ts
@@ -31,3 +31,10 @@ export async function getUserDetail({ userId }: { userId: string }) {
return { organizations, roles, user };
}
+
+export async function deleteUser({ userId }: { userId: string }) {
+ await apiClient({
+ method: 'DELETE',
+ path: `/api/admin/users/${userId}`,
+ });
+}
diff --git a/apps/papra-server/src/modules/admin/users/e2e/users.e2e.test.ts b/apps/papra-server/src/modules/admin/users/e2e/users.e2e.test.ts
index 144f36df..8bb98d1a 100644
--- a/apps/papra-server/src/modules/admin/users/e2e/users.e2e.test.ts
+++ b/apps/papra-server/src/modules/admin/users/e2e/users.e2e.test.ts
@@ -1,8 +1,11 @@
+import { eq } from 'drizzle-orm';
import { describe, expect, test } from 'vitest';
import { createInMemoryDatabase } from '../../../app/database/database.test-utils';
import { createServer } from '../../../app/server';
import { createTestServerDependencies } from '../../../app/server.test-utils';
import { overrideConfig } from '../../../config/config.test-utils';
+import { ORGANIZATION_ROLES } from '../../../organizations/organizations.constants';
+import { usersTable } from '../../../users/users.table';
describe('admin users routes - permission protection', () => {
describe('get /api/admin/users', () => {
@@ -233,4 +236,174 @@ describe('admin users routes - permission protection', () => {
});
});
});
+
+ describe('delete /api/admin/users/:userId', () => {
+ test('when the user has the DELETE_USERS permission and the target has no owned organizations, the user is deleted', async () => {
+ const targetUserId = 'usr_123456789012345678901234';
+ const { db } = await createInMemoryDatabase({
+ users: [
+ { id: 'usr_admin', email: '[email protected]', name: 'Admin User' },
+ { id: targetUserId, email: '[email protected]', name: 'Target User' },
+ ],
+ userRoles: [
+ { userId: 'usr_admin', role: 'admin' },
+ ],
+ });
+
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig({ env: 'test' }) }));
+
+ const response = await app.request(
+ `/api/admin/users/${targetUserId}`,
+ { method: 'DELETE' },
+ { loggedInUserId: 'usr_admin' },
+ );
+
+ expect(response.status).to.eql(204);
+
+ const remaining = await db.select().from(usersTable).where(eq(usersTable.id, targetUserId));
+ expect(remaining).to.eql([]);
+ });
+
+ test('when the target user still owns an organization, a 400 error is returned and the user is not deleted', async () => {
+ const targetUserId = 'usr_123456789012345678901234';
+ const { db } = await createInMemoryDatabase({
+ users: [
+ { id: 'usr_admin', email: '[email protected]', name: 'Admin User' },
+ { id: targetUserId, email: '[email protected]', name: 'Target User' },
+ ],
+ userRoles: [
+ { userId: 'usr_admin', role: 'admin' },
+ ],
+ organizations: [
+ { id: 'org_1', name: 'Organization 1' },
+ ],
+ organizationMembers: [
+ { organizationId: 'org_1', userId: targetUserId, role: ORGANIZATION_ROLES.OWNER },
+ ],
+ });
+
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig({ env: 'test' }) }));
+
+ const response = await app.request(
+ `/api/admin/users/${targetUserId}`,
+ { method: 'DELETE' },
+ { loggedInUserId: 'usr_admin' },
+ );
+
+ expect(response.status).to.eql(400);
+ expect(await response.json()).to.eql({
+ error: {
+ code: 'users.still_owns_organizations',
+ message: 'User still owns organizations',
+ },
+ });
+
+ const remaining = await db.select().from(usersTable).where(eq(usersTable.id, targetUserId));
+ expect(remaining).to.have.length(1);
+ });
+
+ test('when the admin tries to delete their own account, a 400 error is returned', async () => {
+ const adminUserId = 'usr_aaaaaaaaaaaaaaaaaaaaaaaa';
+ const { db } = await createInMemoryDatabase({
+ users: [
+ { id: adminUserId, email: '[email protected]', name: 'Admin User' },
+ ],
+ userRoles: [
+ { userId: adminUserId, role: 'admin' },
+ ],
+ });
+
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig({ env: 'test' }) }));
+
+ const response = await app.request(
+ `/api/admin/users/${adminUserId}`,
+ { method: 'DELETE' },
+ { loggedInUserId: adminUserId },
+ );
+
+ expect(response.status).to.eql(400);
+ expect(await response.json()).to.eql({
+ error: {
+ code: 'users.cannot_delete_self',
+ message: 'Cannot delete your own account from the admin panel',
+ },
+ });
+
+ const remaining = await db.select().from(usersTable).where(eq(usersTable.id, adminUserId));
+ expect(remaining).to.have.length(1);
+ });
+
+ test('when the target user does not exist, a 404 error is returned', async () => {
+ const { db } = await createInMemoryDatabase({
+ users: [
+ { id: 'usr_admin', email: '[email protected]', name: 'Admin User' },
+ ],
+ userRoles: [
+ { userId: 'usr_admin', role: 'admin' },
+ ],
+ });
+
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig({ env: 'test' }) }));
+
+ const response = await app.request(
+ '/api/admin/users/usr_999999999999999999999999',
+ { method: 'DELETE' },
+ { loggedInUserId: 'usr_admin' },
+ );
+
+ expect(response.status).to.eql(404);
+ });
+
+ test('when the user does not have the DELETE_USERS permission, a 401 error is returned', async () => {
+ const targetUserId = 'usr_123456789012345678901234';
+ const { db } = await createInMemoryDatabase({
+ users: [
+ { id: 'usr_regular', email: '[email protected]' },
+ { id: targetUserId, email: '[email protected]' },
+ ],
+ });
+
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig({ env: 'test' }) }));
+
+ const response = await app.request(
+ `/api/admin/users/${targetUserId}`,
+ { method: 'DELETE' },
+ { loggedInUserId: 'usr_regular' },
+ );
+
+ expect(response.status).to.eql(401);
+ expect(await response.json()).to.eql({
+ error: {
+ code: 'auth.unauthorized',
+ message: 'Unauthorized',
+ },
+ });
+
+ const remaining = await db.select().from(usersTable).where(eq(usersTable.id, targetUserId));
+ expect(remaining).to.have.length(1);
+ });
+
+ test('when the user is not authenticated, a 401 error is returned', async () => {
+ const { db } = await createInMemoryDatabase({
+ users: [
+ { id: 'usr_target', email: '[email protected]' },
+ ],
+ });
+
+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig({ env: 'test' }) }));
+
+ const response = await app.request(
+ '/api/admin/users/usr_target',
+ { method: 'DELETE' },
+ );
+
+ expect(response.status).to.eql(401);
+ expect(await response.json()).to.eql({
+ error: {
+ code: 'auth.unauthorized',
+ message: 'Unauthorized',
+ },
+ });
+ });
+ });
});
diff --git a/apps/papra-server/src/modules/admin/users/users.routes.ts b/apps/papra-server/src/modules/admin/users/users.routes.ts
index e62fa575..d1a231ca 100644
--- a/apps/papra-server/src/modules/admin/users/users.routes.ts
+++ b/apps/papra-server/src/modules/admin/users/users.routes.ts
@@ -1,17 +1,21 @@
import type { RouteDefinitionContext } from '../../app/server.types';
import * as v from 'valibot';
import { createRoleMiddleware, requireAuthentication } from '../../app/auth/auth.middleware';
+import { getUser } from '../../app/auth/auth.models';
import { createOrganizationsRepository } from '../../organizations/organizations.repository';
import { PERMISSIONS } from '../../roles/roles.constants';
import { createRolesRepository } from '../../roles/roles.repository';
import { createQueryPaginationSchemaKeys } from '../../shared/schemas/pagination.schemas';
import { validateParams, validateQuery } from '../../shared/validation/validation';
+import { createCannotDeleteSelfError } from '../../users/users.errors';
import { createUsersRepository } from '../../users/users.repository';
import { userIdSchema } from '../../users/users.schemas';
+import { deleteUser } from '../../users/users.usecases';
export function registerUserManagementRoutes(context: RouteDefinitionContext) {
registerListUsersRoute(context);
registerGetUserDetailRoute(context);
+ registerDeleteUserRoute(context);
}
function registerListUsersRoute({ app, db }: RouteDefinitionContext) {
@@ -81,3 +85,33 @@ function registerGetUserDetailRoute({ app, db }: RouteDefinitionContext) {
},
);
}
+
+function registerDeleteUserRoute({ app, db }: RouteDefinitionContext) {
+ const { requirePermissions } = createRoleMiddleware({ db });
+
+ app.delete(
+ '/api/admin/users/:userId',
+ requireAuthentication(),
+ requirePermissions({
+ requiredPermissions: [PERMISSIONS.DELETE_USERS],
+ }),
+ validateParams(v.strictObject({
+ userId: userIdSchema,
+ })),
+ async (context) => {
+ const { userId: actingUserId } = getUser({ context });
+ const { userId } = context.req.valid('param');
+
+ if (userId === actingUserId) {
+ throw createCannotDeleteSelfError();
+ }
+
+ const usersRepository = createUsersRepository({ db });
+ const organizationsRepository = createOrganizationsRepository({ db });
+
+ await deleteUser({ userId, usersRepository, organizationsRepository });
+
+ return context.body(null, 204);
+ },
+ );
+}
diff --git a/apps/papra-server/src/modules/roles/roles.constants.ts b/apps/papra-server/src/modules/roles/roles.constants.ts
index 12476d53..85de33cb 100644
--- a/apps/papra-server/src/modules/roles/roles.constants.ts
+++ b/apps/papra-server/src/modules/roles/roles.constants.ts
@@ -5,12 +5,14 @@ export const ROLES = {
export const PERMISSIONS = {
BO_ACCESS: 'bo:access',
VIEW_USERS: 'users:view',
+ DELETE_USERS: 'users:delete',
VIEW_ANALYTICS: 'analytics:view',
} as const;
export const PERMISSIONS_BY_ROLE = {
[ROLES.ADMIN]: [
PERMISSIONS.VIEW_USERS,
+ PERMISSIONS.DELETE_USERS,
PERMISSIONS.BO_ACCESS,
PERMISSIONS.VIEW_ANALYTICS,
],
diff --git a/apps/papra-server/src/modules/users/users.errors.ts b/apps/papra-server/src/modules/users/users.errors.ts
index e7623051..77aac504 100644
--- a/apps/papra-server/src/modules/users/users.errors.ts
+++ b/apps/papra-server/src/modules/users/users.errors.ts
@@ -29,3 +29,9 @@ export const createUserStillOwnsOrganizationsError = createErrorFactory({
code: 'users.still_owns_organizations',
statusCode: 400,
});
+
+export const createCannotDeleteSelfError = createErrorFactory({
+ message: 'Cannot delete your own account from the admin panel',
+ code: 'users.cannot_delete_self',
+ statusCode: 400,
+});