The minimalistic document archiving platform.
refactor(search): flatten documents search api response (#760)
Corentin Thomasset64b2a042d196
diff --git a/.changeset/metal-laws-chew.md b/.changeset/metal-laws-chew.mdindex b7ec45f0..8f4848fb 100644--- a/.changeset/metal-laws-chew.md+++ b/.changeset/metal-laws-chew.md@@ -1,5 +1,30 @@---"@papra/docker": patch---+API Breaking Change:+Document search endpoint now returns complete documents along with total count matching the search query, and no longer nests results under `searchResults`.-Document search endpoint now returns complete documents along with total count matching the search query+Before:+```ts+// GET /api/organizations/:organizationId/documents/search?searchQuery=foobar+{+ searchResults: {+ documents: [+ { id: 'doc_1', name: 'Document 1.pdf' },+ { id: 'doc_2', name: 'Document 2.pdf' },+ ],+ },+}+```++After:+```ts+// GET /api/organizations/:organizationId/documents/search?searchQuery=foobar+{+ documents: [+ { id: 'doc_1', name: 'Document 1.pdf', mimeType: 'application/pdf' /* ...otherProps */ },+ { id: 'doc_2', name: 'Document 2.pdf', mimeType: 'application/pdf' /* ...otherProps */ },+ ],+ totalCount: 42,+}+```diff --git a/apps/docs/src/content/docs/04-resources/03-api-endpoints.mdx b/apps/docs/src/content/docs/04-resources/03-api-endpoints.mdxindex 01e5a17b..b3c2b77b 100644--- a/apps/docs/src/content/docs/04-resources/03-api-endpoints.mdx+++ b/apps/docs/src/content/docs/04-resources/03-api-endpoints.mdx@@ -214,10 +214,8 @@ Search documents in the organization by name or content.- `pageIndex`: (optional, default: 0) The page index to start from.- `pageSize`: (optional, default: 100) The number of documents to return.- Response (JSON)- - `searchResults`: The search results.- - `documents`: The list of matching documents.- - `id`: The document ID.- - `name`: The document name.+ - `documents`: The list of documents matching the search query.+ - `totalCount`: The total number of documents matching the search query.### Get organization documents statisticsdiff --git a/apps/papra-client/src/modules/command-palette/command-palette.provider.tsx b/apps/papra-client/src/modules/command-palette/command-palette.provider.tsxindex 551e6a9c..216aa5b8 100644--- a/apps/papra-client/src/modules/command-palette/command-palette.provider.tsx+++ b/apps/papra-client/src/modules/command-palette/command-palette.provider.tsx@@ -56,7 +56,7 @@ export const CommandPaletteProvider: ParentComponent = (props) => {const searchDocs = debounce(async ({ searchQuery }: { searchQuery: string }) => {const [result] = await safely(searchDocuments({ searchQuery, organizationId: params.organizationId, pageIndex: 0, pageSize: 5 }));- setMatchingDocuments(result?.searchResults.documents ?? []);+ setMatchingDocuments(result?.documents ?? []);setIsLoading(false);}, 300);diff --git a/apps/papra-client/src/modules/demo/demo-api-mock.ts b/apps/papra-client/src/modules/demo/demo-api-mock.tsindex d8d1796e..4c5c522b 100644--- a/apps/papra-client/src/modules/demo/demo-api-mock.ts+++ b/apps/papra-client/src/modules/demo/demo-api-mock.ts@@ -209,13 +209,22 @@ const inMemoryApiMock: Record<string, { handler: any }> = {&& [document?.name, document?.content].filter(Boolean).some(content => content.toLowerCase().includes(searchQuery));const filteredDocuments = documents.filter(matchQuery);+ const pagedDocuments = filteredDocuments.slice(pageIndex * pageSize, (pageIndex + 1) * pageSize);+ const documentsWithTags = await Promise.all(+ pagedDocuments.map(async (document) => {+ const tagDocuments = await findMany(tagDocumentStorage, tagDocument => tagDocument?.documentId === document?.id);+ const allTags = await getValues(tagStorage);+ const tags = allTags.filter(tag => tagDocuments.some(tagDocument => tagDocument?.tagId === tag?.id));+ return {+ ...document,+ tags,+ };+ }),+ );return {- searchResults: {- documents: filteredDocuments- .slice(pageIndex * pageSize, (pageIndex + 1) * pageSize)- .map(({ id, name }) => ({ id, name })),- },+ documents: documentsWithTags,+ totalCount: filteredDocuments.length,};},}),diff --git a/apps/papra-client/src/modules/documents/documents.services.ts b/apps/papra-client/src/modules/documents/documents.services.tsindex bf225f3d..733f1e7b 100644--- a/apps/papra-client/src/modules/documents/documents.services.ts+++ b/apps/papra-client/src/modules/documents/documents.services.ts@@ -151,12 +151,11 @@ export async function searchDocuments({pageSize: number;}) {const {- searchResults,+ documents,+ totalCount,} = await apiClient<{- searchResults: {- documents: Document[];- totalCount: number;- };+ documents: Document[];+ totalCount: number;}>({method: 'GET',path: `/api/organizations/${organizationId}/documents/search`,@@ -168,10 +167,8 @@ export async function searchDocuments({});return {- searchResults: {- documents: searchResults.documents.map(coerceDates),- totalCount: searchResults.totalCount,- },+ documents: documents.map(coerceDates),+ totalCount,};}diff --git a/apps/papra-client/src/modules/documents/pages/documents.page.tsx b/apps/papra-client/src/modules/documents/pages/documents.page.tsxindex fdaf42bd..66c26c9a 100644--- a/apps/papra-client/src/modules/documents/pages/documents.page.tsx+++ b/apps/papra-client/src/modules/documents/pages/documents.page.tsx@@ -42,7 +42,7 @@ export const DocumentsPage: Component = () => {return (<div class="p-6 mt-4 pb-32 max-w-5xl mx-auto"><Suspense>- {documentsQuery.data?.searchResults.documents?.length === 0 && debouncedSearchQuery().length === 0+ {documentsQuery.data?.documents?.length === 0 && debouncedSearchQuery().length === 0? (<><h2 class="text-xl font-bold ">@@ -95,21 +95,21 @@ export const DocumentsPage: Component = () => {<div class="mb-4 text-sm text-muted-foreground mt-2 ml-2"><Showwhen={debouncedSearchQuery().length > 0}- fallback={t('documents.list.search.total-count-no-query', { count: documentsQuery.data?.searchResults.totalCount ?? 0 })}+ fallback={t('documents.list.search.total-count-no-query', { count: documentsQuery.data?.totalCount ?? 0 })}>- {t('documents.list.search.total-count-with-query', { count: documentsQuery.data?.searchResults.totalCount ?? 0 })}+ {t('documents.list.search.total-count-with-query', { count: documentsQuery.data?.totalCount ?? 0 })}</Show></div>- <Show when={debouncedSearchQuery().length > 0 && documentsQuery.data?.searchResults.documents.length === 0}>+ <Show when={debouncedSearchQuery().length > 0 && documentsQuery.data?.documents.length === 0}><p class="text-muted-foreground mt-1 mb-6">{t('documents.list.no-results')}</p></Show><DocumentsPaginatedList- documents={documentsQuery.data?.searchResults.documents ?? []}- documentsCount={documentsQuery.data?.searchResults.totalCount ?? 0}+ documents={documentsQuery.data?.documents ?? []}+ documentsCount={documentsQuery.data?.totalCount ?? 0}getPagination={getPagination}setPagination={setPagination}extraColumns={[diff --git a/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.document-search-provider.ts b/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.document-search-provider.tsindex a4b534de..0d3ca224 100644--- a/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.document-search-provider.ts+++ b/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.document-search-provider.ts@@ -13,10 +13,8 @@ export function createDatabaseFts5DocumentSearchServices({ db }: { db: Databaseconst { documents, totalCount } = await documentsSearchRepository.searchOrganizationDocuments({ organizationId, searchQuery, pageIndex, pageSize });return {- searchResults: {- documents,- totalCount,- },+ documents,+ totalCount,};},diff --git a/apps/papra-server/src/modules/documents/document-search/document-search.types.ts b/apps/papra-server/src/modules/documents/document-search/document-search.types.tsindex a70ea48f..20560382 100644--- a/apps/papra-server/src/modules/documents/document-search/document-search.types.ts+++ b/apps/papra-server/src/modules/documents/document-search/document-search.types.ts@@ -16,7 +16,7 @@ export type DocumentSearchServices = {organizationId: string;pageIndex: number;pageSize: number;- }) => Promise<{ searchResults: { documents: Omit<Document, 'content'>[]; totalCount: number } }>;+ }) => Promise<{ documents: Omit<Document, 'content'>[]; totalCount: number }>;indexDocument: (args: { document: DocumentSearchableData }) => Promise<void>;updateDocument: (args: { documentId: string; document: Partial<Omit<DocumentSearchableData, 'id'>> }) => Promise<void>;diff --git a/apps/papra-server/src/modules/documents/document-search/document-search.usecase.ts b/apps/papra-server/src/modules/documents/document-search/document-search.usecase.tsindex 60a46d4a..26e6ad89 100644--- a/apps/papra-server/src/modules/documents/document-search/document-search.usecase.ts+++ b/apps/papra-server/src/modules/documents/document-search/document-search.usecase.ts@@ -18,7 +18,7 @@ export async function searchOrganizationDocuments({logger?: Logger;}) {const startTime = Date.now();- const { searchResults } = await documentSearchServices.searchDocuments({+ const { documents, totalCount } = await documentSearchServices.searchDocuments({searchQuery,organizationId,pageIndex,@@ -31,10 +31,11 @@ export async function searchOrganizationDocuments({pageIndex,pageSize,durationMs,- pageDocumentCount: searchResults.documents.length,+ pageDocumentCount: documents.length,}, 'Executed document search');return {- searchResults,+ documents,+ totalCount,};}diff --git a/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.test.ts b/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.test.tsindex ee00291d..a1ee6b6b 100644--- a/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.test.ts+++ b/apps/papra-server/src/modules/documents/document-search/events/sync-document-search.handlers.test.ts@@ -18,7 +18,7 @@ function createTestSearchServices() {name: 'test-search-service',searchDocuments: async (args) => {methodsArgs.searchDocuments.push(args);- return { searchResults: { documents: [], totalCount: 0 } };+ return { documents: [], totalCount: 0 };},indexDocument: async (args) => {methodsArgs.indexDocument.push(args);diff --git a/apps/papra-server/src/modules/documents/documents.routes.ts b/apps/papra-server/src/modules/documents/documents.routes.tsindex 01cbd68f..29c4ac41 100644--- a/apps/papra-server/src/modules/documents/documents.routes.ts+++ b/apps/papra-server/src/modules/documents/documents.routes.ts@@ -317,7 +317,7 @@ function setupSearchDocumentsRoute({ app, db, documentSearchServices }: RouteDefawait ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });- const { searchResults } = await searchOrganizationDocuments({+ const { documents, totalCount } = await searchOrganizationDocuments({organizationId,searchQuery,pageIndex,@@ -326,7 +326,8 @@ function setupSearchDocumentsRoute({ app, db, documentSearchServices }: RouteDef});return context.json({- searchResults,+ documents,+ totalCount,});},);