The minimalistic document archiving platform.
feat(app): admin pages (#689)
Corentin Thomassetd79579893106
diff --git a/.changeset/late-planets-help.md b/.changeset/late-planets-help.mdnew file mode 100644index 00000000..6baa60fd--- /dev/null+++ b/.changeset/late-planets-help.md@@ -0,0 +1,5 @@+---+"@papra/docker": patch+---++Added a platform administration dashboarddiff --git a/apps/papra-client/src/modules/admin/admin.routes.tsx b/apps/papra-client/src/modules/admin/admin.routes.tsxnew file mode 100644index 00000000..acd3f9eb--- /dev/null+++ b/apps/papra-client/src/modules/admin/admin.routes.tsx@@ -0,0 +1,35 @@+import type { RouteDefinition } from '@solidjs/router';+import { Navigate } from '@solidjs/router';+import { lazy } from 'solid-js';+import { NotFoundPage } from '../shared/pages/not-found.page';++export const adminRoutes: RouteDefinition = {+ path: '/admin/*',+ component: lazy(() => import('./layouts/admin.layout')),+ children: [+ {+ path: '/',+ component: () => <Navigate href="/admin/analytics" />,+ },+ {+ path: '/users',+ component: lazy(() => import('./pages/list-users.page')),+ },+ {+ path: '/analytics',+ component: lazy(() => import('./analytics/pages/analytics.page')),+ },+ {+ path: '/organizations',+ component: () => <div class="p-6 text-muted-foreground">Not implemented yet.</div>,+ },+ {+ path: '/settings',+ component: () => <div class="p-6 text-muted-foreground">Not implemented yet.</div>,+ },+ {+ path: '/*404',+ component: NotFoundPage,+ },+ ],+};diff --git a/apps/papra-client/src/modules/admin/analytics/analytics.services.ts b/apps/papra-client/src/modules/admin/analytics/analytics.services.tsnew file mode 100644index 00000000..3f9f5aea--- /dev/null+++ b/apps/papra-client/src/modules/admin/analytics/analytics.services.ts@@ -0,0 +1,35 @@+import { apiClient } from '@/modules/shared/http/api-client';++export async function getUserCount() {+ const { userCount } = await apiClient<{ userCount: number }>({+ method: 'GET',+ path: '/api/admin/users/count',+ });++ return { userCount };+}++export async function getDocumentStats() {+ const stats = await apiClient<{+ documentsCount: number;+ documentsSize: number;+ deletedDocumentsCount: number;+ deletedDocumentsSize: number;+ totalDocumentsCount: number;+ totalDocumentsSize: number;+ }>({+ method: 'GET',+ path: '/api/admin/documents/stats',+ });++ return stats;+}++export async function getOrganizationCount() {+ const { organizationCount } = await apiClient<{ organizationCount: number }>({+ method: 'GET',+ path: '/api/admin/organizations/count',+ });++ return { organizationCount };+}diff --git a/apps/papra-client/src/modules/admin/analytics/pages/analytics.page.tsx b/apps/papra-client/src/modules/admin/analytics/pages/analytics.page.tsxnew file mode 100644index 00000000..9e3ef2aa--- /dev/null+++ b/apps/papra-client/src/modules/admin/analytics/pages/analytics.page.tsx@@ -0,0 +1,103 @@+import type { Component } from 'solid-js';+import { formatBytes } from '@corentinth/chisels';+import { useQuery } from '@tanstack/solid-query';+import { Suspense } from 'solid-js';+import { getDocumentStats, getOrganizationCount, getUserCount } from '../analytics.services';++const AnalyticsCard: Component<{+ icon: string;+ title: string;+ value: () => number | undefined;+ formatValue?: (value: number) => string;+}> = (props) => {+ const formattedValue = () => {+ const value = props.value();+ if (value === undefined) {+ return '';+ }+ return props.formatValue ? props.formatValue(value) : value.toLocaleString();+ };++ return (+ <div class="bg-card rounded-lg px-6 py-4 border">+ <div class="flex flex-row items-center mb-4 gap-2">+ <div class="flex items-center justify-center size-6 bg-muted rounded">+ <div class={`${props.icon} text-muted-foreground size-4`} />+ </div>+ <h2 class="text-sm font-light">{props.title}</h2>+ </div>++ <Suspense fallback={<div class="h-8 w-16 animate-pulse bg-muted rounded" />}>+ <div class="text-3xl font-light">+ {formattedValue()}+ </div>+ </Suspense>+ </div>+ );+};++export const AdminAnalyticsPage: Component = () => {+ const userCountQuery = useQuery(() => ({+ queryKey: ['admin', 'users', 'count'],+ queryFn: getUserCount,+ }));++ const documentStatsQuery = useQuery(() => ({+ queryKey: ['admin', 'documents', 'stats'],+ queryFn: getDocumentStats,+ }));++ const organizationCountQuery = useQuery(() => ({+ queryKey: ['admin', 'organizations', 'count'],+ queryFn: getOrganizationCount,+ }));++ return (+ <div class="px-6 pt-4">+ <h1 class="text-2xl font-medium mb-1">Dashboard</h1>+ <p class="text-muted-foreground">Insights and analytics about Papra usage.</p>++ <div class="mt-6 grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-4">+ <AnalyticsCard+ icon="i-tabler-users"+ title="User count"+ value={() => userCountQuery.data?.userCount}+ />++ <AnalyticsCard+ icon="i-tabler-building"+ title="Organization count"+ value={() => organizationCountQuery.data?.organizationCount}+ />++ <AnalyticsCard+ icon="i-tabler-file"+ title="Document count"+ value={() => documentStatsQuery.data?.documentsCount}+ />++ <AnalyticsCard+ icon="i-tabler-database"+ title="Documents storage"+ value={() => documentStatsQuery.data?.documentsSize}+ formatValue={bytes => formatBytes({ bytes, base: 1000 })}+ />++ <AnalyticsCard+ icon="i-tabler-file-x"+ title="Deleted documents"+ value={() => documentStatsQuery.data?.deletedDocumentsCount}+ />++ <AnalyticsCard+ icon="i-tabler-database-x"+ title="Deleted storage"+ value={() => documentStatsQuery.data?.deletedDocumentsSize}+ formatValue={bytes => formatBytes({ bytes, base: 1000 })}+ />+ </div>+ </div>+ );+};++export default AdminAnalyticsPage;diff --git a/apps/papra-client/src/modules/admin/layouts/admin.layout.tsx b/apps/papra-client/src/modules/admin/layouts/admin.layout.tsxnew file mode 100644index 00000000..a07c6196--- /dev/null+++ b/apps/papra-client/src/modules/admin/layouts/admin.layout.tsx@@ -0,0 +1,102 @@+import type { ParentComponent } from 'solid-js';+import { A, Navigate } from '@solidjs/router';+import { Show } from 'solid-js';+import { Button } from '@/modules/ui/components/button';+import { Sheet, SheetContent, SheetTrigger } from '@/modules/ui/components/sheet';+import { SideNav } from '@/modules/ui/layouts/sidenav.layout';+import { useCurrentUser } from '@/modules/users/composables/useCurrentUser';++const AdminLayout: ParentComponent = (props) => {+ const getNavigationMenu = () => [+ {+ label: 'Analytics',+ href: '/admin/analytics',+ icon: 'i-tabler-chart-bar',+ },+ {+ label: 'Users',+ href: '/admin/users',+ icon: 'i-tabler-users',+ },+ {+ label: 'Organizations',+ href: '/admin/organizations',+ icon: 'i-tabler-building-community',+ },+ {+ label: 'Settings',+ href: '/admin/settings',+ icon: 'i-tabler-settings',+ },+ ];++ const sidenav = () => (+ <SideNav+ header={() => (+ <A href="/admin" class="flex items-center gap-2 pl-6 h-14 w-260px">+ <div class="i-tabler-layout-dashboard text-primary size-7" />+ <div class="font-medium text-base">+ Papra admin+ </div>+ </A>+ )}+ mainMenu={getNavigationMenu()}+ footer={() => (+ <div class="px-4 text-sm text-muted-foreground text-center">+ Papra ©+ {' '}+ {new Date().getFullYear()}+ </div>+ )}+ />+ );++ return (+ <div class="h-screen bg-card flex flex-row flex-1 min-h-0">+ <div class="w-280px flex-shrink-0 hidden md:block">+ {sidenav()}+ </div>+ <div class="flex-1 flex flex-col min-h-0">+ <header class="h-14 flex items-center px-4 justify-between">+ <Sheet>+ <SheetTrigger>+ <Button variant="ghost" size="icon" class="md:hidden mr-2">+ <div class="i-tabler-menu-2 size-6" />+ </Button>+ </SheetTrigger>+ <SheetContent side="left" class="bg-card p-0!">+ {sidenav()}+ </SheetContent>+ </Sheet>++ <Button+ variant="outline"+ as={A}+ href="/"+ >+ Back to App+ </Button>+ </header>++ <div class="flex-1 min-h-0 flex flex-col md:rounded-tl-lg md:border-l border-t bg-background">+ {props.children}+ </div>+ </div>+ </div>+ );+};++export const GuardedAdminLayout: ParentComponent = (props) => {+ const { hasPermission } = useCurrentUser();++ return (+ <Show+ when={hasPermission('bo:access')}+ fallback={<Navigate href="/" />}+ >+ <AdminLayout {...props} />+ </Show>+ );+};++export default GuardedAdminLayout;diff --git a/apps/papra-client/src/modules/admin/pages/list-users.page.tsx b/apps/papra-client/src/modules/admin/pages/list-users.page.tsxnew file mode 100644index 00000000..1546fd04--- /dev/null+++ b/apps/papra-client/src/modules/admin/pages/list-users.page.tsx@@ -0,0 +1,11 @@+import type { Component } from 'solid-js';++export const AdminListUsersPage: Component = () => {+ return (+ <div class="p-6 text-muted-foreground">+ Not implemented yet.+ </div>+ );+};++export default AdminListUsersPage;diff --git a/apps/papra-client/src/modules/shared/pages/not-found.page.tsx b/apps/papra-client/src/modules/shared/pages/not-found.page.tsxindex 3168813e..1e9c795d 100644--- a/apps/papra-client/src/modules/shared/pages/not-found.page.tsx+++ b/apps/papra-client/src/modules/shared/pages/not-found.page.tsx@@ -1,10 +1,20 @@import type { Component } from 'solid-js';-import { A } from '@solidjs/router';+import { A, useLocation } from '@solidjs/router';import { useI18n } from '@/modules/i18n/i18n.provider';import { Button } from '@/modules/ui/components/button';export const NotFoundPage: Component = () => {const { t } = useI18n();+ const location = useLocation();++ const getRedirectionUrl = () => {+ if (location.pathname.startsWith('/admin/') || location.pathname === '/admin') {+ return '/admin';+ }++ return '/';+ };+return (<div class="h-screen flex flex-col items-center justify-center p-6">@@ -14,7 +24,7 @@ export const NotFoundPage: Component = () => {<p class="text-muted-foreground">{t('not-found.description')}</p>- <Button as={A} href="/" class="mt-4" variant="default">+ <Button as={A} href={getRedirectionUrl()} class="mt-4" variant="default"><div class="i-tabler-arrow-left mr-2" />{t('not-found.back-to-home')}</Button>diff --git a/apps/papra-client/src/modules/ui/layouts/admin.layout.tsx b/apps/papra-client/src/modules/ui/layouts/admin.layout.tsxdeleted file mode 100644index d7ce021c..00000000--- a/apps/papra-client/src/modules/ui/layouts/admin.layout.tsx+++ /dev/null@@ -1,170 +0,0 @@-import type { Component, ParentComponent } from 'solid-js';--import { A, useNavigate } from '@solidjs/router';--import { For, Show, Suspense } from 'solid-js';-import { signOut } from '@/modules/auth/auth.services';-import { cn } from '@/modules/shared/style/cn';-import { useThemeStore } from '@/modules/theme/theme.store';-import { Button } from '@/modules/ui/components/button';-import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger } from '../components/dropdown-menu';-import { Sheet, SheetContent, SheetTrigger } from '../components/sheet';--type MenuItem = {- label: string;- icon: string;- href?: string;- onClick?: () => void;-};--const MenuItemButton: Component<MenuItem> = (props) => {- return (- <>- <Show when={props.onClick}>- <Button class="block" onClick={props.onClick} variant="ghost">- <div class="flex items-center gap-2">- <div class={cn(props.icon, 'size-5 text-muted-foreground')} />- <div>{props.label}</div>- </div>- </Button>- </Show>-- <Show when={!props.onClick}>- <Button class="block" as={A} href={props.href!} variant="ghost" activeClass="bg-accent/50! text-accent-foreground!">- <div class="flex items-center gap-2">- <div class={cn(props.icon, 'size-5 text-muted-foreground')} />- <div>{props.label}</div>- </div>- </Button>- </Show>- </>- );-};--const SideNav: Component = () => {- const navigate = useNavigate();-- const getMainMenuItems = () => [- {- label: 'Users',- icon: 'i-tabler-users',- href: '/admin/users',- },- ];-- const getFooterMenuItems = () => [- {- label: 'Settings',- icon: 'i-tabler-settings',- href: '/settings',- },- {- label: 'Logout',- icon: 'i-tabler-logout',- onClick: async () => {- await signOut();- navigate('/login');- },- },- ];-- return (- <div class="h-full flex flex-col pb-6">- <div class="h-60px flex items-center">- <Button href="/admin" class="text-lg font-bold hover:no-underline gap-1" variant="link" as={A}>- Papra- <span class="font-normal text-base text-muted-foreground">- Admin- </span>- </Button>- </div>-- <nav class="flex flex-col gap-0.5 mt-4 text-muted-foreground">- <For each={getMainMenuItems()}>- {menuItem => <MenuItemButton {...menuItem} />}- </For>- </nav>-- <div class="flex-1" />-- <nav class="flex flex-col gap-0.5 text-muted-foreground">- <For each={getFooterMenuItems()}>- {menuItem => <MenuItemButton {...menuItem} />}- </For>- </nav>- </div>- );-};--const ThemeSwitcher: Component = () => {- const themeStore = useThemeStore();-- return (- <>- <DropdownMenuItem onClick={() => themeStore.setColorMode({ mode: 'light' })} class="flex items-center gap-2 cursor-pointer">- <div class="i-tabler-sun text-lg" />- Light Mode- </DropdownMenuItem>- <DropdownMenuItem onClick={() => themeStore.setColorMode({ mode: 'dark' })} class="flex items-center gap-2 cursor-pointer">- <div class="i-tabler-moon text-lg" />- Dark Mode- </DropdownMenuItem>- <DropdownMenuItem onClick={() => themeStore.setColorMode({ mode: 'system' })} class="flex items-center gap-2 cursor-pointer">- <div class="i-tabler-device-laptop text-lg" />- System Mode- </DropdownMenuItem>- </>- );-};--export const AdminLayout: ParentComponent = (props) => {- const themeStore = useThemeStore();-- return (- <div class="flex flex-row h-screen min-h-0">- <div class="w-64 border-r border-r-border px-2 flex-shrink-0 hidden md:block">- <SideNav />- </div>- <div class="flex-1 min-h-0 flex flex-col">- <div class="h-60px border-b flex items-center justify-between px-6">- <div>- <Sheet>- <SheetTrigger>- <Button variant="ghost" size="icon" class="md:hidden">- <div class="i-tabler-menu-2 size-6" />- </Button>- </SheetTrigger>- <SheetContent side="left">- <SideNav />- </SheetContent>- </Sheet>- </div>-- <div class="flex items-center gap-2">-- <DropdownMenu>- <DropdownMenuTrigger as={Button} class="text-base" variant="outline" aria-label="Theme switcher">- <div classList={{ 'i-tabler-moon': themeStore.getColorMode() === 'dark', 'i-tabler-sun': themeStore.getColorMode() === 'light' }} />- <div class="ml-2 i-tabler-chevron-down text-muted-foreground text-sm" />- </DropdownMenuTrigger>- <DropdownMenuContent class="w-42">- <ThemeSwitcher />- </DropdownMenuContent>- </DropdownMenu>-- <Button as={A} href="/renderings">- <div class="i-tabler-home size-4 mr-1" />- App- </Button>-- </div>- </div>- <div class="flex-1 overflow-auto max-w-screen">- <Suspense>- {props.children}- </Suspense>- </div>- </div>- </div>- );-};diff --git a/apps/papra-client/src/modules/ui/layouts/sidenav.layout.tsx b/apps/papra-client/src/modules/ui/layouts/sidenav.layout.tsxindex 8104998a..291c24b4 100644--- a/apps/papra-client/src/modules/ui/layouts/sidenav.layout.tsx+++ b/apps/papra-client/src/modules/ui/layouts/sidenav.layout.tsx@@ -13,6 +13,7 @@ import { cn } from '@/modules/shared/style/cn';import { UsageWarningCard } from '@/modules/subscriptions/components/usage-warning-card';import { useThemeStore } from '@/modules/theme/theme.store';import { Button } from '@/modules/ui/components/button';+import { useCurrentUser } from '@/modules/users/composables/useCurrentUser';import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuRadioGroup, DropdownMenuRadioItem, DropdownMenuSub, DropdownMenuSubContent, DropdownMenuSubTrigger, DropdownMenuTrigger } from '../components/dropdown-menu';import { Sheet, SheetContent, SheetTrigger } from '../components/sheet';@@ -131,6 +132,7 @@ export const SidenavLayout: ParentComponent<{const navigate = useNavigate();const { getPendingInvitationsCount } = usePendingInvitationsCount();const { t } = useI18n();+ const { hasPermission } = useCurrentUser();const { promptImport, uploadDocuments } = useDocumentUpload();@@ -240,6 +242,12 @@ export const SidenavLayout: ParentComponent<{</DropdownMenuContent></DropdownMenu>+ <Show when={hasPermission('bo:access')}>+ <Button as={A} href="/admin" variant="outline" class="hidden sm:flex" size="icon">+ <div class="i-tabler-settings size-4.5" />+ </Button>+ </Show>+</div></div><div class="flex-1 overflow-auto max-w-screen">diff --git a/apps/papra-client/src/modules/users/composables/useCurrentUser.tsx b/apps/papra-client/src/modules/users/composables/useCurrentUser.tsxindex 20abaebf..cde68e23 100644--- a/apps/papra-client/src/modules/users/composables/useCurrentUser.tsx+++ b/apps/papra-client/src/modules/users/composables/useCurrentUser.tsx@@ -11,6 +11,7 @@ const currentUserContext = createContext<{getLatestOrganizationId: () => string | null;setLatestOrganizationId: (organizationId: string) => void;+ hasPermission: (permission: string) => boolean;}>();export function useCurrentUser() {@@ -42,6 +43,7 @@ export const CurrentUserProvider: ParentComponent = (props) => {getLatestOrganizationId,setLatestOrganizationId,+ hasPermission: (permission: string) => query.data?.user.permissions?.includes(permission) ?? false,}}>{props.children}diff --git a/apps/papra-client/src/modules/users/users.types.ts b/apps/papra-client/src/modules/users/users.types.tsindex 4df73ad5..5d01f53b 100644--- a/apps/papra-client/src/modules/users/users.types.ts+++ b/apps/papra-client/src/modules/users/users.types.ts@@ -3,7 +3,7 @@ export type UserMe = {email: string;planId: string;name: string;- roles: string[];+ permissions: string[];};export type User = {diff --git a/apps/papra-client/src/routes.tsx b/apps/papra-client/src/routes.tsxindex aa906ac8..330384fa 100644--- a/apps/papra-client/src/routes.tsx+++ b/apps/papra-client/src/routes.tsx@@ -2,6 +2,7 @@ import type { RouteDefinition } from '@solidjs/router';import { Navigate, useParams } from '@solidjs/router';import { useQuery } from '@tanstack/solid-query';import { Match, Show, Suspense, Switch } from 'solid-js';+import { adminRoutes } from './modules/admin/admin.routes';import { ApiKeysPage } from './modules/api-keys/pages/api-keys.page';import { CreateApiKeyPage } from './modules/api-keys/pages/create-api-key.page';import { authPagesPaths } from './modules/auth/auth.constants';@@ -197,6 +198,7 @@ export const routes: RouteDefinition[] = [},],},+ adminRoutes,],},{diff --git a/apps/papra-server/package.json b/apps/papra-server/package.jsonindex 652069b8..db05ea9e 100644--- a/apps/papra-server/package.json+++ b/apps/papra-server/package.json@@ -35,6 +35,7 @@"dev:reset": "pnpm clean:all && pnpm migrate:up","script:send-intake-email": "tsx --env-file-if-exists=.env src/scripts/send-intake-email.script.ts | crowlog-pretty","stripe:webhook": "stripe listen --forward-to localhost:1221/api/stripe/webhook",+ "script:make-user-admin": "tsx --env-file-if-exists=.env src/scripts/make-user-admin.script.ts","maintenance:encrypt-all-documents": "tsx --env-file-if-exists=.env src/scripts/encrypt-all-documents.script.ts"},"dependencies": {diff --git a/apps/papra-server/src/modules/admin/admin.routes.ts b/apps/papra-server/src/modules/admin/admin.routes.tsnew file mode 100644index 00000000..d9c4f743--- /dev/null+++ b/apps/papra-server/src/modules/admin/admin.routes.ts@@ -0,0 +1,6 @@+import type { RouteDefinitionContext } from '../app/server.types';+import { registerAnalyticsRoutes } from './analytics/analytics.routes';++export function registerAdminRoutes(context: RouteDefinitionContext) {+ registerAnalyticsRoutes(context);+}diff --git a/apps/papra-server/src/modules/admin/analytics/analytics.routes.ts b/apps/papra-server/src/modules/admin/analytics/analytics.routes.tsnew file mode 100644index 00000000..6ee1a062--- /dev/null+++ b/apps/papra-server/src/modules/admin/analytics/analytics.routes.ts@@ -0,0 +1,69 @@+import type { RouteDefinitionContext } from '../../app/server.types';+import { createRoleMiddleware, requireAuthentication } from '../../app/auth/auth.middleware';+import { createDocumentsRepository } from '../../documents/documents.repository';+import { createOrganizationsRepository } from '../../organizations/organizations.repository';+import { PERMISSIONS } from '../../roles/roles.constants';+import { createUsersRepository } from '../../users/users.repository';++export function registerAnalyticsRoutes(context: RouteDefinitionContext) {+ registerGetUserCountAdminRoute(context);+ registerGetDocumentStatsAdminRoute(context);+ registerGetOrganizationCountAdminRoute(context);+}++function registerGetUserCountAdminRoute({ app, db }: RouteDefinitionContext) {+ const { requirePermissions } = createRoleMiddleware({ db });++ app.get(+ '/api/admin/users/count',+ requireAuthentication(),+ requirePermissions({+ requiredPermissions: [PERMISSIONS.VIEW_ANALYTICS],+ }),+ async (context) => {+ const usersRepository = createUsersRepository({ db });++ const { userCount } = await usersRepository.getUserCount();++ return context.json({ userCount });+ },+ );+}++function registerGetDocumentStatsAdminRoute({ app, db }: RouteDefinitionContext) {+ const { requirePermissions } = createRoleMiddleware({ db });++ app.get(+ '/api/admin/documents/stats',+ requireAuthentication(),+ requirePermissions({+ requiredPermissions: [PERMISSIONS.VIEW_ANALYTICS],+ }),+ async (context) => {+ const documentsRepository = createDocumentsRepository({ db });++ const stats = await documentsRepository.getGlobalDocumentsStats();++ return context.json(stats);+ },+ );+}++function registerGetOrganizationCountAdminRoute({ app, db }: RouteDefinitionContext) {+ const { requirePermissions } = createRoleMiddleware({ db });++ app.get(+ '/api/admin/organizations/count',+ requireAuthentication(),+ requirePermissions({+ requiredPermissions: [PERMISSIONS.VIEW_ANALYTICS],+ }),+ async (context) => {+ const organizationsRepository = createOrganizationsRepository({ db });++ const { organizationCount } = await organizationsRepository.getOrganizationCount();++ return context.json({ organizationCount });+ },+ );+}diff --git a/apps/papra-server/src/modules/admin/analytics/e2e/analytics.e2e.test.ts b/apps/papra-server/src/modules/admin/analytics/e2e/analytics.e2e.test.tsnew file mode 100644index 00000000..947c95af--- /dev/null+++ b/apps/papra-server/src/modules/admin/analytics/e2e/analytics.e2e.test.ts@@ -0,0 +1,74 @@+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';++describe('analytics routes - permission protection', () => {+ describe('get /api/admin/users/count', () => {+ test('when the user has the VIEW_ANALYTICS permission, the request succeeds', async () => {+ const { db } = await createInMemoryDatabase({+ users: [+ { id: 'usr_admin', email: '[email protected]' },+ { id: 'usr_regular', email: '[email protected]' },+ ],+ userRoles: [+ { userId: 'usr_admin', role: 'admin' },+ ],+ });++ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig({ env: 'test' }) }));++ const response = await app.request(+ '/api/admin/users/count',+ { method: 'GET' },+ { loggedInUserId: 'usr_admin' },+ );++ expect(response.status).to.eql(200);+ const body = await response.json();+ expect(body).to.eql({ userCount: 2 });+ });++ test('when the user does not have the VIEW_ANALYTICS permission, a 401 error is returned', async () => {+ const { db } = await createInMemoryDatabase({+ users: [{ id: 'usr_regular', email: '[email protected]' }],+ });++ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig({ env: 'test' }) }));++ const response = await app.request(+ '/api/admin/users/count',+ { method: 'GET' },+ { loggedInUserId: 'usr_regular' },+ );++ expect(response.status).to.eql(401);+ expect(await response.json()).to.eql({+ error: {+ code: 'auth.unauthorized',+ message: 'Unauthorized',+ },+ });+ });++ test('when the user is not authenticated, a 401 error is returned', async () => {+ const { db } = await createInMemoryDatabase();++ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig({ env: 'test' }) }));++ const response = await app.request(+ '/api/admin/users/count',+ { method: 'GET' },+ );++ 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/app/auth/auth.middleware.test.ts b/apps/papra-server/src/modules/app/auth/auth.middleware.test.tsnew file mode 100644index 00000000..3988583d--- /dev/null+++ b/apps/papra-server/src/modules/app/auth/auth.middleware.test.ts@@ -0,0 +1,199 @@+import type { ServerInstanceGenerics } from '../server.types';+import { Hono } from 'hono';+import { describe, expect, test } from 'vitest';+import { PERMISSIONS } from '../../roles/roles.constants';+import { createInMemoryDatabase } from '../database/database.test-utils';+import { registerErrorMiddleware } from '../middlewares/errors.middleware';+import { createRoleMiddleware } from './auth.middleware';++describe('createRoleMiddleware', () => {+ const permissionsByRole = {+ admin: [PERMISSIONS.BO_ACCESS],+ };++ const createTestServer = ({ loggedInUserId}: { loggedInUserId: string | null }) => {+ const app = new Hono<ServerInstanceGenerics>();+ registerErrorMiddleware({ app });++ // Mock the context variables before the middleware+ app.use('*', async (c, next) => {+ c.set('userId', loggedInUserId);+ await next();+ });++ return { app };+ };++ describe('when the user has the required permission', () => {+ test('the request is allowed to proceed', async () => {+ const { db } = await createInMemoryDatabase({+ users: [{ id: 'user-1', email: '[email protected]' }],+ userRoles: [+ { userId: 'user-1', role: 'admin' },+ ],+ });++ const { app } = createTestServer({ loggedInUserId: 'user-1' });++ const { requirePermissions } = createRoleMiddleware({ db, permissionsByRole });++ app.get(+ '/protected',+ requirePermissions({ requiredPermissions: [PERMISSIONS.BO_ACCESS] }),+ async c => c.json({ success: true }),+ );++ const response = await app.request('/protected', { method: 'GET' });++ expect(response.status).to.eql(200);+ expect(await response.json()).to.eql({ success: true });+ });+ });++ describe('when the user does not have the required permission', () => {+ test('a 401 unauthorized error is returned', async () => {+ const { db } = await createInMemoryDatabase({+ users: [{ id: 'user-1', email: '[email protected]' }],+ });++ const { app } = createTestServer({ loggedInUserId: 'user-1' });++ const { requirePermissions } = createRoleMiddleware({ db, permissionsByRole });++ app.get(+ '/protected',+ requirePermissions({ requiredPermissions: [PERMISSIONS.BO_ACCESS] }),+ async c => c.json({ success: true }),+ );++ const response = await app.request('/protected', { method: 'GET' });++ expect(response.status).to.eql(401);+ expect(await response.json()).to.eql({+ error: {+ code: 'auth.unauthorized',+ message: 'Unauthorized',+ },+ });+ });+ });++ describe('when the user is not authenticated', () => {+ test('a 401 unauthorized error is returned', async () => {+ const { db } = await createInMemoryDatabase();++ const { app } = createTestServer({ loggedInUserId: null });++ const { requirePermissions } = createRoleMiddleware({ db, permissionsByRole });++ app.get(+ '/protected',+ requirePermissions({ requiredPermissions: [PERMISSIONS.BO_ACCESS] }),+ async c => c.json({ success: true }),+ );++ const response = await app.request('/protected', { method: 'GET' });++ expect(response.status).to.eql(401);+ expect(await response.json()).to.eql({+ error: {+ code: 'auth.unauthorized',+ message: 'Unauthorized',+ },+ });+ });+ });++ describe('when the user has multiple permissions and one matches', () => {+ test('the request is allowed to proceed', async () => {+ const extendedPermissionsByRole = {+ admin: [PERMISSIONS.BO_ACCESS, PERMISSIONS.USERS_LIST],+ };++ const { db } = await createInMemoryDatabase({+ users: [{ id: 'user-1', email: '[email protected]' }],+ userRoles: [+ { userId: 'user-1', role: 'admin' },+ ],+ });++ const { app } = createTestServer({ loggedInUserId: 'user-1' });++ const { requirePermissions } = createRoleMiddleware({ db, permissionsByRole: extendedPermissionsByRole });++ app.get(+ '/protected',+ requirePermissions({ requiredPermissions: [PERMISSIONS.USERS_LIST] }),+ async c => c.json({ success: true }),+ );++ const response = await app.request('/protected', { method: 'GET' });++ expect(response.status).to.eql(200);+ expect(await response.json()).to.eql({ success: true });+ });+ });++ describe('when multiple permissions are required', () => {+ test('the request is allowed if the user has all required permissions', async () => {+ const extendedPermissionsByRole = {+ admin: [PERMISSIONS.BO_ACCESS, PERMISSIONS.USERS_LIST],+ };++ const { db } = await createInMemoryDatabase({+ users: [{ id: 'user-1', email: '[email protected]' }],+ userRoles: [+ { userId: 'user-1', role: 'admin' },+ ],+ });++ const { app } = createTestServer({ loggedInUserId: 'user-1' });++ const { requirePermissions } = createRoleMiddleware({ db, permissionsByRole: extendedPermissionsByRole });++ app.get(+ '/protected',+ requirePermissions({ requiredPermissions: [PERMISSIONS.BO_ACCESS, PERMISSIONS.USERS_LIST] }),+ async c => c.json({ success: true }),+ );++ const response = await app.request('/protected', { method: 'GET' });++ expect(response.status).to.eql(200);+ expect(await response.json()).to.eql({ success: true });+ });++ test('a 401 error is returned if the user is missing one of the required permissions', async () => {+ const extendedPermissionsByRole = {+ admin: [PERMISSIONS.BO_ACCESS],+ };++ const { db } = await createInMemoryDatabase({+ users: [{ id: 'user-1', email: '[email protected]' }],+ userRoles: [+ { userId: 'user-1', role: 'admin' },+ ],+ });++ const { app } = createTestServer({ loggedInUserId: 'user-1' });++ const { requirePermissions } = createRoleMiddleware({ db, permissionsByRole: extendedPermissionsByRole });++ app.get(+ '/protected',+ requirePermissions({ requiredPermissions: [PERMISSIONS.BO_ACCESS, PERMISSIONS.USERS_LIST] }),+ async c => c.json({ success: true }),+ );++ const response = await app.request('/protected', { method: 'GET' });++ 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/app/auth/auth.middleware.ts b/apps/papra-server/src/modules/app/auth/auth.middleware.tsindex d81e3065..7464e409 100644--- a/apps/papra-server/src/modules/app/auth/auth.middleware.ts+++ b/apps/papra-server/src/modules/app/auth/auth.middleware.ts@@ -1,6 +1,12 @@import type { ApiKeyPermissions } from '../../api-keys/api-keys.types';+import type { Permission, Role } from '../../roles/roles.types';+import type { Database } from '../database/database.types';import type { Context } from '../server.types';import { createMiddleware } from 'hono/factory';+import { PERMISSIONS_BY_ROLE } from '../../roles/roles.constants';+import { getPermissionsForRoles } from '../../roles/roles.methods';+import { createRolesRepository } from '../../roles/roles.repository';+import { isNil } from '../../shared/utils';import { createUnauthorizedError } from './auth.errors';import { isAuthenticationValid } from './auth.models';@@ -20,3 +26,33 @@ export function requireAuthentication({ apiKeyPermissions }: { apiKeyPermissionsawait next();});}++/**+ * Middleware to require specific permissions for the authenticated user.+ */+export function createRoleMiddleware({ db, permissionsByRole = PERMISSIONS_BY_ROLE }: { db: Database; permissionsByRole?: Record<Role, Readonly<Permission[]>> }) {+ const rolesRepository = createRolesRepository({ db });++ return {+ requirePermissions: ({ requiredPermissions }: { requiredPermissions: Permission[] }) =>+ createMiddleware(async (context: Context, next) => {+ const userId = context.get('userId');++ if (isNil(userId)) {+ throw createUnauthorizedError();+ }++ const { roles } = await rolesRepository.getUserRoles({ userId });++ const { permissions } = getPermissionsForRoles({ roles, permissionsByRole });++ const hasAllPermissions = requiredPermissions.every(permission => permissions.includes(permission));++ if (!hasAllPermissions) {+ throw createUnauthorizedError();+ }++ await next();+ }),+ };+}diff --git a/apps/papra-server/src/modules/app/database/database.test-utils.ts b/apps/papra-server/src/modules/app/database/database.test-utils.tsindex 5d81398e..d51a5ccd 100644--- a/apps/papra-server/src/modules/app/database/database.test-utils.ts+++ b/apps/papra-server/src/modules/app/database/database.test-utils.ts@@ -6,6 +6,7 @@ import { apiKeyOrganizationsTable, apiKeysTable } from '../../api-keys/api-keys.import { documentsTable } from '../../documents/documents.table';import { intakeEmailsTable } from '../../intake-emails/intake-emails.tables';import { organizationInvitationsTable, organizationMembersTable, organizationsTable } from '../../organizations/organizations.table';+import { userRolesTable } from '../../roles/roles.table';import { organizationSubscriptionsTable } from '../../subscriptions/subscriptions.tables';import { taggingRuleActionsTable, taggingRuleConditionsTable, taggingRulesTable } from '../../tagging-rules/tagging-rules.tables';import { documentsTagsTable, tagsTable } from '../../tags/tags.table';@@ -49,6 +50,7 @@ const seedTables = {webhookEvents: webhookEventsTable,webhookDeliveries: webhookDeliveriesTable,organizationInvitations: organizationInvitationsTable,+ userRoles: userRolesTable,} as const;type SeedTablesRows = {diff --git a/apps/papra-server/src/modules/app/server.routes.ts b/apps/papra-server/src/modules/app/server.routes.tsindex 7ebe1c84..81d21ce7 100644--- a/apps/papra-server/src/modules/app/server.routes.ts+++ b/apps/papra-server/src/modules/app/server.routes.ts@@ -1,4 +1,5 @@import type { RouteDefinitionContext } from './server.types';+import { registerAdminRoutes } from '../admin/admin.routes';import { registerApiKeysRoutes } from '../api-keys/api-keys.routes';import { registerConfigRoutes } from '../config/config.routes';import { registerDocumentActivityRoutes } from '../documents/document-activity/document-activity.routes';@@ -29,4 +30,5 @@ export function registerRoutes(context: RouteDefinitionContext) {registerWebhooksRoutes(context);registerInvitationsRoutes(context);registerDocumentActivityRoutes(context);+ registerAdminRoutes(context);}diff --git a/apps/papra-server/src/modules/documents/documents.repository.ts b/apps/papra-server/src/modules/documents/documents.repository.tsindex fa888715..c1de5e56 100644--- a/apps/papra-server/src/modules/documents/documents.repository.ts+++ b/apps/papra-server/src/modules/documents/documents.repository.ts@@ -36,6 +36,7 @@ export function createDocumentsRepository({ db }: { db: Database }) {getAllOrganizationDocumentsIterator,getAllOrganizationUndeletedDocumentsIterator,updateDocument,+ getGlobalDocumentsStats,},{ db },);@@ -420,3 +421,38 @@ async function updateDocument({ documentId, organizationId, name, content, db }:return { document };}++async function getGlobalDocumentsStats({ db }: { db: Database }) {+ const [record] = await db+ .select({+ totalDocumentsCount: count(documentsTable.id),+ totalDocumentsSize: sql<number>`COALESCE(SUM(${documentsTable.originalSize}), 0)`.as('totalDocumentsSize'),+ deletedDocumentsCount: sql<number>`COUNT(${documentsTable.id}) FILTER (WHERE ${documentsTable.isDeleted} = true)`.as('deletedDocumentsCount'),+ documentsCount: sql<number>`COUNT(${documentsTable.id}) FILTER (WHERE ${documentsTable.isDeleted} = false)`.as('documentsCount'),+ documentsSize: sql<number>`COALESCE(SUM(${documentsTable.originalSize}) FILTER (WHERE ${documentsTable.isDeleted} = false), 0)`.as('documentsSize'),+ deletedDocumentsSize: sql<number>`COALESCE(SUM(${documentsTable.originalSize}) FILTER (WHERE ${documentsTable.isDeleted} = true), 0)`.as('deletedDocumentsSize'),+ })+ .from(documentsTable);++ if (isNil(record)) {+ return {+ documentsCount: 0,+ documentsSize: 0,+ deletedDocumentsCount: 0,+ deletedDocumentsSize: 0,+ totalDocumentsCount: 0,+ totalDocumentsSize: 0,+ };+ }++ const { documentsCount, documentsSize, deletedDocumentsCount, deletedDocumentsSize, totalDocumentsCount, totalDocumentsSize } = record;++ return {+ documentsCount,+ documentsSize: Number(documentsSize ?? 0),+ deletedDocumentsCount,+ deletedDocumentsSize: Number(deletedDocumentsSize ?? 0),+ totalDocumentsCount,+ totalDocumentsSize: Number(totalDocumentsSize ?? 0),+ };+}diff --git a/apps/papra-server/src/modules/organizations/organizations.repository.test.ts b/apps/papra-server/src/modules/organizations/organizations.repository.test.tsindex c105ea45..6e4019c2 100644--- a/apps/papra-server/src/modules/organizations/organizations.repository.test.ts+++ b/apps/papra-server/src/modules/organizations/organizations.repository.test.ts@@ -206,4 +206,48 @@ describe('organizations repository', () => {expect(organization?.scheduledPurgeAt).to.eql(expectedPurgeDate);});});++ describe('getOrganizationCount', () => {+ test('when no organizations exist in the database, the count is zero', async () => {+ const { db } = await createInMemoryDatabase();+ const { getOrganizationCount } = createOrganizationsRepository({ db });++ const { organizationCount } = await getOrganizationCount();++ expect(organizationCount).to.equal(0);+ });++ test('when multiple organizations exist in the database, the count reflects the total number of organizations', async () => {+ const { db } = await createInMemoryDatabase({+ organizations: [+ { id: 'org_1', name: 'Org 1' },+ { id: 'org_2', name: 'Org 2' },+ { id: 'org_3', name: 'Org 3' },+ ],+ });++ const { getOrganizationCount } = createOrganizationsRepository({ db });++ const { organizationCount } = await getOrganizationCount();++ expect(organizationCount).to.equal(3);+ });++ test('when some organizations are soft-deleted, they are excluded from the count', async () => {+ const { db } = await createInMemoryDatabase({+ users: [{ id: 'user_1', email: '[email protected]' }],+ organizations: [+ { id: 'org_1', name: 'Org 1' },+ { id: 'org_2', name: 'Org 2', deletedAt: new Date('2025-05-15'), deletedBy: 'user_1', scheduledPurgeAt: new Date('2025-06-15') },+ { id: 'org_3', name: 'Org 3' },+ ],+ });++ const { getOrganizationCount } = createOrganizationsRepository({ db });++ const { organizationCount } = await getOrganizationCount();++ expect(organizationCount).to.equal(2);+ });+ });});diff --git a/apps/papra-server/src/modules/organizations/organizations.repository.ts b/apps/papra-server/src/modules/organizations/organizations.repository.tsindex e8499866..f570b041 100644--- a/apps/papra-server/src/modules/organizations/organizations.repository.ts+++ b/apps/papra-server/src/modules/organizations/organizations.repository.ts@@ -49,6 +49,7 @@ export function createOrganizationsRepository({ db }: { db: Database }) {restoreOrganization,getUserDeletedOrganizations,getExpiredSoftDeletedOrganizations,+ getOrganizationCount,},{ db },);@@ -541,3 +542,14 @@ async function getExpiredSoftDeletedOrganizations({ db, now = new Date() }: { dborganizationIds: organizations.map(org => org.id),};}++async function getOrganizationCount({ db }: { db: Database }) {+ const [{ organizationCount = 0 } = {}] = await db+ .select({ organizationCount: count() })+ .from(organizationsTable)+ .where(isNull(organizationsTable.deletedAt));++ return {+ organizationCount,+ };+}diff --git a/apps/papra-server/src/modules/roles/roles.constants.ts b/apps/papra-server/src/modules/roles/roles.constants.tsindex d60cc67b..203d9371 100644--- a/apps/papra-server/src/modules/roles/roles.constants.ts+++ b/apps/papra-server/src/modules/roles/roles.constants.ts@@ -1,3 +1,15 @@-export const ADMIN_ROLE = 'admin';+export const PERMISSIONS = {+ BO_ACCESS: 'bo:access',+ USERS_LIST: 'users:list',+ VIEW_ANALYTICS: 'analytics:view',+} as const;-export const ROLES = [ADMIN_ROLE] as const;+export const PERMISSIONS_BY_ROLE = {+ admin: [+ PERMISSIONS.USERS_LIST,+ PERMISSIONS.BO_ACCESS,+ PERMISSIONS.VIEW_ANALYTICS,+ ],+} as const;++export const ROLES = Object.keys(PERMISSIONS_BY_ROLE) as (keyof typeof PERMISSIONS_BY_ROLE)[];diff --git a/apps/papra-server/src/modules/roles/roles.methods.test.ts b/apps/papra-server/src/modules/roles/roles.methods.test.tsnew file mode 100644index 00000000..15c1cbd3--- /dev/null+++ b/apps/papra-server/src/modules/roles/roles.methods.test.ts@@ -0,0 +1,24 @@+import type { Permission, Role } from './roles.types';+import { describe, expect, test } from 'vitest';+import { getPermissionsForRoles } from './roles.methods';++describe('roles methods', () => {+ describe('getPermissionsForRoles', () => {+ const permissionsByRole = {+ admin: ['users:list', 'users:delete', 'bo:access'],+ moderator: ['users:list', 'bo:access', 'tickets:read'],+ support: ['bo:access', 'tickets:read', 'tickets:write'],+ } as Record<Role, Readonly<Permission[]>>;++ test('given a list of user roles, it returns the deduplicated list of permissions for those roles', () => {+ const roles = ['admin', 'moderator'] as Role[];+ const result = getPermissionsForRoles({ roles, permissionsByRole });++ expect(+ result.permissions,+ ).to.eql(+ ['users:list', 'users:delete', 'bo:access', 'tickets:read'],+ );+ });+ });+});diff --git a/apps/papra-server/src/modules/roles/roles.methods.ts b/apps/papra-server/src/modules/roles/roles.methods.tsnew file mode 100644index 00000000..22a92c6b--- /dev/null+++ b/apps/papra-server/src/modules/roles/roles.methods.ts@@ -0,0 +1,15 @@+import type { Permission, Role } from './roles.types';+import { uniq } from '../shared/utils';+import { PERMISSIONS_BY_ROLE } from './roles.constants';++export function getPermissionsForRoles({+ roles,+ permissionsByRole = PERMISSIONS_BY_ROLE,+}: {+ roles: Role[];+ permissionsByRole?: Record<Role, Readonly<Permission[]>>;+}): { permissions: Permission[] } {+ return {+ permissions: uniq(roles.flatMap(role => permissionsByRole[role] ?? [])),+ };+}diff --git a/apps/papra-server/src/modules/roles/roles.repository.ts b/apps/papra-server/src/modules/roles/roles.repository.tsindex 10cae514..4da32a72 100644--- a/apps/papra-server/src/modules/roles/roles.repository.ts+++ b/apps/papra-server/src/modules/roles/roles.repository.ts@@ -1,6 +1,7 @@import type { Database } from '../app/database/database.types';+import type { Role } from './roles.types';import { injectArguments } from '@corentinth/chisels';-import { eq } from 'drizzle-orm';+import { and, eq } from 'drizzle-orm';import { map } from 'lodash-es';import { userRolesTable } from './roles.table';@@ -10,15 +11,44 @@ export function createRolesRepository({ db }: { db: Database }) {return injectArguments({getUserRoles,+ assignRoleToUser,+ removeRoleFromUser,},{ db },);}async function getUserRoles({ userId, db }: { userId: string; db: Database }) {- const roles = await db.select().from(userRolesTable).where(eq(userRolesTable.userId, userId));+ const roles = await db+ .select()+ .from(userRolesTable)+ .where(+ eq(userRolesTable.userId, userId),+ );return {roles: map(roles, 'role'),};}++async function assignRoleToUser({ userId, role, db }: { userId: string; role: Role; db: Database }) {+ await db+ .insert(userRolesTable)+ .values({+ userId,+ role,+ })+ .onConflictDoNothing()+ .returning();+}++async function removeRoleFromUser({ userId, role, db }: { userId: string; role: Role; db: Database }) {+ await db+ .delete(userRolesTable)+ .where(+ and(+ eq(userRolesTable.userId, userId),+ eq(userRolesTable.role, role),+ ),+ );+}diff --git a/apps/papra-server/src/modules/roles/roles.types.ts b/apps/papra-server/src/modules/roles/roles.types.tsindex 6d69f3a9..444d3bbf 100644--- a/apps/papra-server/src/modules/roles/roles.types.ts+++ b/apps/papra-server/src/modules/roles/roles.types.ts@@ -1,3 +1,4 @@-import type { ROLES } from './roles.constants';+import type { PERMISSIONS, ROLES } from './roles.constants';export type Role = typeof ROLES[number];+export type Permission = typeof PERMISSIONS[keyof typeof PERMISSIONS];diff --git a/apps/papra-server/src/modules/users/users.constants.ts b/apps/papra-server/src/modules/users/users.constants.tsnew file mode 100644index 00000000..429af6e9--- /dev/null+++ b/apps/papra-server/src/modules/users/users.constants.ts@@ -0,0 +1,4 @@+import { createPrefixedIdRegex } from '../shared/random/ids';++export const USER_ID_PREFIX = 'usr';+export const USER_ID_REGEX = createPrefixedIdRegex({ prefix: USER_ID_PREFIX });diff --git a/apps/papra-server/src/modules/users/users.repository.test.ts b/apps/papra-server/src/modules/users/users.repository.test.tsindex b80f093c..8c598a96 100644--- a/apps/papra-server/src/modules/users/users.repository.test.ts+++ b/apps/papra-server/src/modules/users/users.repository.test.ts@@ -20,4 +20,28 @@ describe('users repository', () => {}});});++ describe('getUserCount', () => {+ test('when no users exist in the database, the count is zero', async () => {+ const { db } = await createInMemoryDatabase();+ const { getUserCount } = createUsersRepository({ db });++ const { userCount } = await getUserCount();++ expect(userCount).to.equal(0);+ });++ test('when multiple users exist in the database, the count reflects the total number of users', async () => {+ const { db } = await createInMemoryDatabase();+ const { createUser, getUserCount } = createUsersRepository({ db });++ await createUser({ user: { email: '[email protected]' } });+ await createUser({ user: { email: '[email protected]' } });+ await createUser({ user: { email: '[email protected]' } });++ const { userCount } = await getUserCount();++ expect(userCount).to.equal(3);+ });+ });});diff --git a/apps/papra-server/src/modules/users/users.repository.ts b/apps/papra-server/src/modules/users/users.repository.tsindex 9ade1ec3..b952e9a5 100644--- a/apps/papra-server/src/modules/users/users.repository.ts+++ b/apps/papra-server/src/modules/users/users.repository.ts@@ -1,7 +1,7 @@import type { Database } from '../app/database/database.types';import type { DbInsertableUser } from './users.types';import { injectArguments } from '@corentinth/chisels';-import { eq } from 'drizzle-orm';+import { count, eq } from 'drizzle-orm';import { isUniqueConstraintError } from '../shared/db/constraints.models';import { createUserAlreadyExistsError, createUsersNotFoundError } from './users.errors';import { usersTable } from './users.table';@@ -18,6 +18,7 @@ function createUsersRepository({ db }: { db: Database }) {getUserById,getUserByIdOrThrow,updateUser,+ getUserCount,},{ db },);@@ -72,3 +73,11 @@ async function updateUser({ userId, name, db }: { userId: string; name: string;return { user };}++export async function getUserCount({ db }: { db: Database }) {+ const [{ userCount = 0 } = {}] = await db.select({ userCount: count() }).from(usersTable);++ return {+ userCount,+ };+}diff --git a/apps/papra-server/src/modules/users/users.routes.ts b/apps/papra-server/src/modules/users/users.routes.tsindex 5ef15b86..75f3a230 100644--- a/apps/papra-server/src/modules/users/users.routes.ts+++ b/apps/papra-server/src/modules/users/users.routes.ts@@ -3,6 +3,7 @@ import { pick } from 'lodash-es';import { z } from 'zod';import { requireAuthentication } from '../app/auth/auth.middleware';import { getUser } from '../app/auth/auth.models';+import { getPermissionsForRoles } from '../roles/roles.methods';import { createRolesRepository } from '../roles/roles.repository';import { validateJsonBody } from '../shared/validation/validation';import { createUsersRepository } from './users.repository';@@ -30,9 +31,11 @@ function setupGetCurrentUserRoute({ app, db }: RouteDefinitionContext) {rolesRepository.getUserRoles({ userId }),]);+ const { permissions } = getPermissionsForRoles({ roles });+return context.json({user: {- roles,+ permissions,...pick(user,[diff --git a/apps/papra-server/src/modules/users/users.schemas.ts b/apps/papra-server/src/modules/users/users.schemas.tsnew file mode 100644index 00000000..eac5bb7e--- /dev/null+++ b/apps/papra-server/src/modules/users/users.schemas.ts@@ -0,0 +1,4 @@+import { z } from 'zod';+import { USER_ID_REGEX } from './users.constants';++export const userIdSchema = z.string().regex(USER_ID_REGEX);diff --git a/apps/papra-server/src/scripts/make-user-admin.script.ts b/apps/papra-server/src/scripts/make-user-admin.script.tsnew file mode 100644index 00000000..4ff0c8ee--- /dev/null+++ b/apps/papra-server/src/scripts/make-user-admin.script.ts@@ -0,0 +1,67 @@+import type { UsersRepository } from '../modules/users/users.repository';+import process from 'node:process';+import { z } from 'zod';+import { permissiveEmailAddressSchema } from '../modules/intake-emails/intake-emails.schemas';+import { createRolesRepository } from '../modules/roles/roles.repository';+import { isNil } from '../modules/shared/utils';+import { createUsersRepository } from '../modules/users/users.repository';+import { userIdSchema } from '../modules/users/users.schemas';+import { runScriptWithDb } from './commons/run-script';++const userIdOrEmailSchema = z.union([+ permissiveEmailAddressSchema,+ userIdSchema,+]);++async function getUserByIdOrEmail({ usersRepository, userIdOrEmail }: { usersRepository: UsersRepository; userIdOrEmail: string }) {+ if (userIdOrEmail.includes('@')) {+ return usersRepository.getUserByEmail({ email: userIdOrEmail });+ }++ return usersRepository.getUserById({ userId: userIdOrEmail });+}++function exitWithError(message: string): never {+ console.error(`${message.trim()}\n`);+ process.exit(1);+}++await runScriptWithDb(+ { scriptName: 'make-user-admin' },+ async ({ db, isDryRun }) => {+ const usersRepository = createUsersRepository({ db });+ const rolesRepository = createRolesRepository({ db });++ const userIdOrEmail = process.argv.filter(arg => !arg.startsWith('--')).at(-1);++ if (isNil(userIdOrEmail)) {+ // Should not happen as argv always has at least 2 elements, but hey, typescript+ exitWithError('Please provide a user ID or email as an argument');+ }++ if (!userIdOrEmailSchema.safeParse(userIdOrEmail).success) {+ exitWithError(`Invalid user ID or email: "${userIdOrEmail}"`);+ }++ const { user } = await getUserByIdOrEmail({ usersRepository, userIdOrEmail });++ if (isNil(user)) {+ exitWithError(`User with ID or email "${userIdOrEmail}" not found`);+ }++ const { roles } = await rolesRepository.getUserRoles({ userId: user.id });++ if (roles.includes('admin')) {+ exitWithError(`User ${user.id} - ${user.email} is already an admin`);+ }++ if (isDryRun) {+ console.log(`[Dry Run] User ${user.email} (${user.id}) would be made an admin`);+ return;+ }++ await rolesRepository.assignRoleToUser({ userId: user.id, role: 'admin' });++ console.log(`User ${user.email} (${user.id}) has been made an admin`);+ },+);