Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(documents): added document renaming (#314)

Corentin Thomassete9a205c0a338
diff --git a/apps/papra-client/src/index.tsx b/apps/papra-client/src/index.tsx
index efa1c3e3..2cd93bc3 100644
--- a/apps/papra-client/src/index.tsx
+++ b/apps/papra-client/src/index.tsx
@@ -9,6 +9,7 @@ import { render, Suspense } from 'solid-js/web';
import { CommandPaletteProvider } from './modules/command-palette/command-palette.provider';
import { ConfigProvider } from './modules/config/config.provider';
import { DemoIndicator } from './modules/demo/demo.provider';
+import { RenameDocumentDialogProvider } from './modules/documents/components/rename-document-button.component';
import { I18nProvider } from './modules/i18n/i18n.provider';
import { ConfirmModalProvider } from './modules/shared/confirm';
import { queryClient } from './modules/shared/query/query-client';
@@ -44,9 +45,11 @@ render(
>
<CommandPaletteProvider>
<ConfigProvider>
- <div class="min-h-screen font-sans text-sm font-400">
- {props.children}
- </div>
+ <RenameDocumentDialogProvider>
+ <div class="min-h-screen font-sans text-sm font-400">
+ {props.children}
+ </div>
+ </RenameDocumentDialogProvider>
<DemoIndicator />
</ConfigProvider>
diff --git a/apps/papra-client/src/locales/en.yml b/apps/papra-client/src/locales/en.yml
index c91fd2ae..85487125 100644
--- a/apps/papra-client/src/locales/en.yml
+++ b/apps/papra-client/src/locales/en.yml
@@ -210,6 +210,15 @@ documents.info.created-at: Created At
documents.info.updated-at: Updated At
documents.info.never: Never
+documents.rename.title: Rename document
+documents.rename.form.name.label: Name
+documents.rename.form.name.placeholder: 'Example: Invoice 2024'
+documents.rename.form.name.required: Please enter a name for the document
+documents.rename.form.name.max-length: The name must be less than 255 characters
+documents.rename.form.submit: Rename document
+documents.rename.success: Document renamed successfully
+documents.rename.cancel: Cancel
+
import-documents.title.error: '{{ count }} documents failed'
import-documents.title.success: '{{ count }} documents imported'
import-documents.title.pending: '{{ count }} / {{ total }} documents imported'
diff --git a/apps/papra-client/src/locales/fr.yml b/apps/papra-client/src/locales/fr.yml
index 6a545b13..e94bb066 100644
--- a/apps/papra-client/src/locales/fr.yml
+++ b/apps/papra-client/src/locales/fr.yml
@@ -210,6 +210,15 @@ documents.info.created-at: Créé le
documents.info.updated-at: Mis à jour le
documents.info.never: Jamais
+documents.rename.title: Renommer le document
+documents.rename.form.name.label: Nom
+documents.rename.form.name.placeholder: 'Exemple: Facture 2024'
+documents.rename.form.name.required: Veuillez entrer un nom pour le document
+documents.rename.form.name.max-length: Le nom doit contenir moins de 255 caractères
+documents.rename.form.submit: Renommer
+documents.rename.success: Document renommé avec succès
+documents.rename.cancel: Annuler
+
import-documents.title.error: '{{ count }} documents ont échoué'
import-documents.title.success: '{{ count }} documents ont été importés'
import-documents.title.pending: '{{ count }} / {{ total }} documents importés'
diff --git a/apps/papra-client/src/modules/documents/components/document-management-dropdown.component.tsx b/apps/papra-client/src/modules/documents/components/document-management-dropdown.component.tsx
index 1e3f0c2c..6d7e279d 100644
--- a/apps/papra-client/src/modules/documents/components/document-management-dropdown.component.tsx
+++ b/apps/papra-client/src/modules/documents/components/document-management-dropdown.component.tsx
@@ -5,9 +5,11 @@ import { A } from '@solidjs/router';
import { Button } from '@/modules/ui/components/button';
import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger } from '@/modules/ui/components/dropdown-menu';
import { useDeleteDocument } from '../documents.composables';
+import { useRenameDocumentDialog } from './rename-document-button.component';
export const DocumentManagementDropdown: Component<{ document: Document }> = (props) => {
const { deleteDocument } = useDeleteDocument();
+ const { openRenameDialog } = useRenameDocumentDialog();
const deleteDoc = () => deleteDocument({
documentId: props.document.id,
@@ -16,6 +18,7 @@ export const DocumentManagementDropdown: Component<{ document: Document }> = (pr
});
return (
+
<DropdownMenu>
<DropdownMenuTrigger
as={(props: DropdownMenuSubTriggerProps) => (
@@ -34,6 +37,18 @@ export const DocumentManagementDropdown: Component<{ document: Document }> = (pr
<span>Document details</span>
</DropdownMenuItem>
+ <DropdownMenuItem
+ class="cursor-pointer"
+ onClick={() => openRenameDialog({
+ documentId: props.document.id,
+ organizationId: props.document.organizationId,
+ documentName: props.document.name,
+ })}
+ >
+ <div class="i-tabler-pencil size-4 mr-2"></div>
+ <span>Rename document</span>
+ </DropdownMenuItem>
+
<DropdownMenuItem
class="cursor-pointer text-red"
onClick={() => deleteDoc()}
@@ -43,5 +58,6 @@ export const DocumentManagementDropdown: Component<{ document: Document }> = (pr
</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
+
);
};
diff --git a/apps/papra-client/src/modules/documents/components/rename-document-button.component.tsx b/apps/papra-client/src/modules/documents/components/rename-document-button.component.tsx
new file mode 100644
index 00000000..79f4d2b3
--- /dev/null
+++ b/apps/papra-client/src/modules/documents/components/rename-document-button.component.tsx
@@ -0,0 +1,136 @@
+import type { Component, ParentComponent } from 'solid-js';
+import { setValue } from '@modular-forms/solid';
+import { useMutation } from '@tanstack/solid-query';
+import { createContext, createEffect, createSignal, useContext } from 'solid-js';
+import * as v from 'valibot';
+import { useI18n } from '@/modules/i18n/i18n.provider';
+import { createForm } from '@/modules/shared/form/form';
+import { Button } from '@/modules/ui/components/button';
+import { Dialog, DialogContent, DialogHeader, DialogTitle } from '@/modules/ui/components/dialog';
+import { createToast } from '@/modules/ui/components/sonner';
+import { TextField, TextFieldLabel, TextFieldRoot } from '@/modules/ui/components/textfield';
+import { getDocumentNameExtension, getDocumentNameWithoutExtension } from '../document.models';
+import { invalidateOrganizationDocumentsQuery } from '../documents.composables';
+import { updateDocument } from '../documents.services';
+
+export const RenameDocumentDialog: Component<{
+ documentId: string;
+ organizationId: string;
+ documentName: string;
+ isOpen: boolean;
+ setIsOpen: (isOpen: boolean) => void;
+}> = (props) => {
+ const { t } = useI18n();
+
+ const renameDocumentMutation = useMutation(() => ({
+ mutationFn: ({ name }: { name: string }) => updateDocument({ documentId: props.documentId, organizationId: props.organizationId, name }),
+ onSuccess: async () => {
+ createToast({
+ message: t('documents.rename.success'),
+ type: 'success',
+ });
+
+ props.setIsOpen(false);
+
+ await invalidateOrganizationDocumentsQuery({ organizationId: props.organizationId });
+ },
+
+ }));
+
+ const { Form, Field, form } = createForm({
+ schema: v.object({
+ name: v.pipe(
+ v.string(),
+ v.trim(),
+ v.maxLength(255, t('documents.rename.form.name.max-length')),
+ v.minLength(1, t('documents.rename.form.name.required')),
+ ),
+ }),
+ initialValues: {
+ name: getDocumentNameWithoutExtension({ name: props.documentName }),
+ },
+ onSubmit: async ({ name }) => {
+ const extension = getDocumentNameExtension({ name: props.documentName });
+ const newName = extension ? `${name}.${extension}` : name;
+
+ await renameDocumentMutation.mutateAsync({ name: newName });
+ },
+ });
+
+ createEffect(() => {
+ setValue(form, 'name', getDocumentNameWithoutExtension({ name: props.documentName }));
+ });
+
+ return (
+ <Dialog onOpenChange={props.setIsOpen} open={props.isOpen}>
+ <DialogContent>
+ <DialogHeader>
+ <DialogTitle>{t('documents.rename.title')}</DialogTitle>
+ </DialogHeader>
+
+ <Form>
+ <Field name="name">
+ {(field, inputProps) => (
+ <TextFieldRoot>
+ <TextFieldLabel class="sr-only" for="name">{t('documents.rename.form.name.label')}</TextFieldLabel>
+ <TextField {...inputProps} value={field.value} id="name" placeholder={t('documents.rename.form.name.placeholder')} />
+ {field.error && <div class="text-red-500 text-sm">{field.error}</div>}
+ </TextFieldRoot>
+ )}
+ </Field>
+
+ <div class="flex justify-end mt-4 gap-2">
+ <Button type="button" variant="secondary" onClick={() => props.setIsOpen(false)}>
+ {t('documents.rename.cancel')}
+ </Button>
+ <Button type="submit">{t('documents.rename.form.submit')}</Button>
+ </div>
+ </Form>
+ </DialogContent>
+ </Dialog>
+ );
+};
+
+const context = createContext<{
+ openRenameDialog: (args: { documentId: string; organizationId: string; documentName: string }) => void;
+}>();
+
+export function useRenameDocumentDialog() {
+ const renameDialogContext = useContext(context);
+
+ if (!renameDialogContext) {
+ throw new Error('useRenameDocumentDialog must be used within a RenameDocumentDialogProvider');
+ }
+
+ return renameDialogContext;
+}
+
+export const RenameDocumentDialogProvider: ParentComponent = (props) => {
+ const [getIsRenameDialogOpen, setIsRenameDialogOpen] = createSignal(false);
+ const [getDocumentId, setDocumentId] = createSignal<string | undefined>(undefined);
+ const [getOrganizationId, setOrganizationId] = createSignal<string | undefined>(undefined);
+ const [getDocumentName, setDocumentName] = createSignal<string | undefined>(undefined);
+
+ return (
+ <context.Provider
+ value={{
+ openRenameDialog: ({ documentId, organizationId, documentName }) => {
+ setIsRenameDialogOpen(true);
+ setDocumentId(documentId);
+ setOrganizationId(organizationId);
+ setDocumentName(documentName);
+ },
+ }}
+ >
+ <RenameDocumentDialog
+ documentId={getDocumentId() ?? ''}
+ organizationId={getOrganizationId() ?? ''}
+ documentName={getDocumentName() ?? ''}
+ isOpen={getIsRenameDialogOpen()}
+ setIsOpen={setIsRenameDialogOpen}
+ />
+
+ {props.children}
+ </context.Provider>
+ );
+};
diff --git a/apps/papra-client/src/modules/documents/documents.services.ts b/apps/papra-client/src/modules/documents/documents.services.ts
index 620871a2..89ab2c66 100644
--- a/apps/papra-client/src/modules/documents/documents.services.ts
+++ b/apps/papra-client/src/modules/documents/documents.services.ts
@@ -194,15 +194,17 @@ export async function updateDocument({
documentId,
organizationId,
content,
+ name,
}: {
documentId: string;
organizationId: string;
- content: string;
+ content?: string;
+ name?: string;
}) {
const { document } = await apiClient<{ document: AsDto<Document> }>({
method: 'PATCH',
path: `/api/organizations/${organizationId}/documents/${documentId}`,
- body: { content },
+ body: { content, name },
});
return {
diff --git a/apps/papra-client/src/modules/documents/pages/document.page.tsx b/apps/papra-client/src/modules/documents/pages/document.page.tsx
index 96a4f9cc..4159893b 100644
--- a/apps/papra-client/src/modules/documents/pages/document.page.tsx
+++ b/apps/papra-client/src/modules/documents/pages/document.page.tsx
@@ -19,6 +19,7 @@ import { Tabs, TabsContent, TabsIndicator, TabsList, TabsTrigger } from '@/modul
import { TextArea } from '@/modules/ui/components/textarea';
import { TextFieldRoot } from '@/modules/ui/components/textfield';
import { DocumentPreview } from '../components/document-preview.component';
+import { useRenameDocumentDialog } from '../components/rename-document-button.component';
import { getDaysBeforePermanentDeletion } from '../document.models';
import { useDeleteDocument, useRestoreDocument } from '../documents.composables';
import { fetchDocument, fetchDocumentFile, updateDocument } from '../documents.services';
@@ -57,6 +58,7 @@ export const DocumentPage: Component = () => {
const { restore, getIsRestoring } = useRestoreDocument();
const navigate = useNavigate();
const { config } = useConfig();
+ const { openRenameDialog } = useRenameDocumentDialog();
const queries = createQueries(() => ({
queries: [
@@ -137,7 +139,21 @@ export const DocumentPage: Component = () => {
{getDocument => (
<div class="flex gap-4 md:pr-6">
<div class="flex-1">
- <h1 class="text-xl font-semibold">{getDocument().name}</h1>
+ <Button
+ variant="ghost"
+ class="flex items-center gap-2 group bg-transparent! px-0"
+ onClick={() => openRenameDialog({
+ documentId: getDocument().id,
+ organizationId: params.organizationId,
+ documentName: getDocument().name,
+ })}
+ >
+ <h1 class="text-xl font-semibold">
+ {getDocument().name}
+ </h1>
+
+ <div class="i-tabler-pencil size-4 text-muted-foreground group-hover:text-foreground transition-colors"></div>
+ </Button>
<p class="text-sm text-muted-foreground mb-6">{getDocument().id}</p>
<div class="flex gap-2 mb-2">
@@ -243,7 +259,21 @@ export const DocumentPage: Component = () => {
},
{
label: t('documents.info.name'),
- value: getDocument().name,
+ value: (
+ <Button
+ variant="ghost"
+ class="flex items-center gap-2 group bg-transparent! p-0 h-auto"
+ onClick={() => openRenameDialog({
+ documentId: getDocument().id,
+ organizationId: params.organizationId,
+ documentName: getDocument().name,
+ })}
+ >
+ {getDocument().name}
+
+ <div class="i-tabler-pencil size-4 text-muted-foreground group-hover:text-foreground transition-colors"></div>
+ </Button>
+ ),
icon: 'i-tabler-file-text',
},
{
diff --git a/apps/papra-client/src/modules/i18n/locales.types.ts b/apps/papra-client/src/modules/i18n/locales.types.ts
index a575c024..e0c31f1e 100644
--- a/apps/papra-client/src/modules/i18n/locales.types.ts
+++ b/apps/papra-client/src/modules/i18n/locales.types.ts
@@ -187,6 +187,14 @@ export type LocaleKeys =
| 'documents.info.created-at'
| 'documents.info.updated-at'
| 'documents.info.never'
+ | 'documents.rename.title'
+ | 'documents.rename.form.name.label'
+ | 'documents.rename.form.name.placeholder'
+ | 'documents.rename.form.name.required'
+ | 'documents.rename.form.name.max-length'
+ | 'documents.rename.form.submit'
+ | 'documents.rename.success'
+ | 'documents.rename.cancel'
| 'import-documents.title.error'
| 'import-documents.title.success'
| 'import-documents.title.pending'
diff --git a/apps/papra-server/src/modules/documents/documents.routes.ts b/apps/papra-server/src/modules/documents/documents.routes.ts
index 3ceed21d..0354f511 100644
--- a/apps/papra-server/src/modules/documents/documents.routes.ts
+++ b/apps/papra-server/src/modules/documents/documents.routes.ts
@@ -457,7 +457,7 @@ function setupUpdateDocumentRoute({ app, db }: RouteDefinitionContext) {
documentId: documentIdSchema,
})),
validateJsonBody(z.object({
- name: z.string().min(1).optional(),
+ name: z.string().min(1).max(255).optional(),
content: z.string().min(1).optional(),
}).refine(data => data.name !== undefined || data.content !== undefined, {
message: 'At least one of \'name\' or \'content\' must be provided',