Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(documents): merged the similar search and listing api endpoints (#899)

Corentin Thomassetd1eae05dd3ca
diff --git a/.changeset/upset-ears-invite.md b/.changeset/upset-ears-invite.md
new file mode 100644
index 00000000..a0082815
--- /dev/null
+++ b/.changeset/upset-ears-invite.md
@@ -0,0 +1,33 @@
+---
+"@papra/app": patch
+---
+
+Api breaking change: removed the `/api/organizations/:organizationId/documents/search` endpoint in favor of the existing `/api/organizations/:organizationId/documents` with an optional `searchQuery` query parameter.
+The new `/api/organizations/:organizationId/documents` endpoint now behave as the old `/search` endpoint, with all documents being returned when `searchQuery` is empty. Note that the response field `totalCount` of the old `/search` endpoint has been renamed to `documentsCount` in the new endpoint.
+
+Before:
+
+```
+GET /api/organizations/:organizationId/documents/search?searchQuery=invoice&pageIndex=1&pageSize=20
+Response: {
+ documents: Document[];
+ totalCount: number;
+}
+
+GET /api/organizations/:organizationId/documents?pageIndex=1&pageSize=20
+Response: {
+ documents: Document[];
+ documentsCount: number;
+}
+```
+
+After:
+
+```
+GET /api/organizations/:organizationId/documents?searchQuery=invoice&pageIndex=1&pageSize=20
+Response: {
+ documents: Document[];
+ documentsCount: number;
+}
+```
+
diff --git a/apps/papra-client/src/modules/command-palette/command-palette.provider.tsx b/apps/papra-client/src/modules/command-palette/command-palette.provider.tsx
index 866a3019..32bffabc 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
@@ -3,7 +3,7 @@ import { safely } from '@corentinth/chisels';
import { useNavigate, useParams } from '@solidjs/router';
import { createContext, createEffect, createSignal, For, on, onCleanup, onMount, Show, useContext } from 'solid-js';
import { getDocumentIcon, makeDocumentSearchPermalink } from '../documents/document.models';
-import { searchDocuments } from '../documents/documents.services';
+import { fetchOrganizationDocuments } from '../documents/documents.services';
import { useI18n } from '../i18n/i18n.provider';
import { cn } from '../shared/style/cn';
import { toArrayIf } from '../shared/utils/array';
@@ -56,10 +56,10 @@ export const CommandPaletteProvider: ParentComponent = (props) => {
const { setColorMode } = useThemeStore();
const searchDocs = debounce(async ({ searchQuery }: { searchQuery: string }) => {
- const [result] = await safely(searchDocuments({ searchQuery, organizationId: params.organizationId, pageIndex: 0, pageSize: 5 }));
+ const [result] = await safely(fetchOrganizationDocuments({ searchQuery, organizationId: params.organizationId, pageIndex: 0, pageSize: 5 }));
setMatchingDocuments(result?.documents ?? []);
- setMatchingDocumentsTotalCount(result?.totalCount ?? 0);
+ setMatchingDocumentsTotalCount(result?.documentsCount ?? 0);
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.ts
index e402e1b2..c1baa437 100644
--- a/apps/papra-client/src/modules/demo/demo-api-mock.ts
+++ b/apps/papra-client/src/modules/demo/demo-api-mock.ts
@@ -90,43 +90,6 @@ const inMemoryApiMock: Record<string, { handler: any }> = {
}),
}),
- ...defineHandler({
- path: '/api/organizations/:organizationId/documents',
- method: 'GET',
- handler: async ({ params: { organizationId }, query }) => {
- const organization = await organizationStorage.getItem(organizationId);
- assert(organization, { status: 403 });
-
- const documents = await findMany(documentStorage, document => document.organizationId === organizationId && !document.deletedAt);
-
- const filteredDocuments = await Promise.all(
- documents.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,
- };
- }),
- );
-
- const {
- pageIndex = 0,
- pageSize = 10,
- } = query ?? {};
-
- return {
- documents: filteredDocuments
- .toSorted((a, b) => new Date(b.createdAt).getTime() - new Date(a.createdAt).getTime())
- .slice(pageIndex * pageSize, (pageIndex + 1) * pageSize),
- documentsCount: filteredDocuments.length,
- };
- },
- }),
-
...defineHandler({
path: '/api/organizations/:organizationId/documents',
method: 'POST',
@@ -190,7 +153,7 @@ const inMemoryApiMock: Record<string, { handler: any }> = {
}),
...defineHandler({
- path: '/api/organizations/:organizationId/documents/search',
+ path: '/api/organizations/:organizationId/documents',
method: 'GET',
handler: async ({ params: { organizationId }, query }) => {
const {
@@ -227,7 +190,7 @@ const inMemoryApiMock: Record<string, { handler: any }> = {
return {
documents: paginatedDocuments,
- totalCount: filteredDocuments.length,
+ documentsCount: filteredDocuments.length,
};
},
}),
diff --git a/apps/papra-client/src/modules/documents/documents.services.ts b/apps/papra-client/src/modules/documents/documents.services.ts
index 733f1e7b..95b62f7f 100644
--- a/apps/papra-client/src/modules/documents/documents.services.ts
+++ b/apps/papra-client/src/modules/documents/documents.services.ts
@@ -25,31 +25,32 @@ export async function fetchOrganizationDocuments({
organizationId,
pageIndex,
pageSize,
- filters,
+ searchQuery,
}: {
organizationId: string;
pageIndex: number;
pageSize: number;
- filters?: {
- tags?: string[];
- };
+ searchQuery?: string;
}) {
const {
documents,
documentsCount,
- } = await apiClient<{ documents: AsDto<Document>[]; documentsCount: number }>({
+ } = await apiClient<{
+ documents: AsDto<Document>[];
+ documentsCount: number;
+ }>({
method: 'GET',
path: `/api/organizations/${organizationId}/documents`,
query: {
+ searchQuery,
pageIndex,
pageSize,
- ...filters,
},
});
return {
- documentsCount,
documents: documents.map(coerceDates),
+ documentsCount,
};
}
@@ -139,39 +140,6 @@ export async function fetchDocumentFile({
return blob;
}
-export async function searchDocuments({
- organizationId,
- searchQuery,
- pageIndex,
- pageSize,
-}: {
- organizationId: string;
- searchQuery: string;
- pageIndex: number;
- pageSize: number;
-}) {
- const {
- documents,
- totalCount,
- } = await apiClient<{
- documents: Document[];
- totalCount: number;
- }>({
- method: 'GET',
- path: `/api/organizations/${organizationId}/documents/search`,
- query: {
- searchQuery,
- pageIndex,
- pageSize,
- },
- });
-
- return {
- documents: documents.map(coerceDates),
- totalCount,
- };
-}
-
export async function getOrganizationDocumentsStats({ organizationId }: { organizationId: string }) {
const { organizationStats } = await apiClient<{
organizationStats: {
diff --git a/apps/papra-client/src/modules/documents/pages/documents.page.tsx b/apps/papra-client/src/modules/documents/pages/documents.page.tsx
index e1305bf4..23673921 100644
--- a/apps/papra-client/src/modules/documents/pages/documents.page.tsx
+++ b/apps/papra-client/src/modules/documents/pages/documents.page.tsx
@@ -11,7 +11,7 @@ import { Button } from '@/modules/ui/components/button';
import { TextField, TextFieldRoot } from '@/modules/ui/components/textfield';
import { DocumentUploadArea } from '../components/document-upload-area.component';
import { createdAtColumn, DocumentsPaginatedList, standardActionsColumn, tagsColumn } from '../components/documents-list.component';
-import { searchDocuments } from '../documents.services';
+import { fetchOrganizationDocuments } from '../documents.services';
export const DocumentsPage: Component = () => {
const params = useParams();
@@ -22,7 +22,7 @@ export const DocumentsPage: Component = () => {
const documentsQuery = useQuery(() => ({
queryKey: ['organizations', params.organizationId, 'documents', getPagination(), debouncedSearchQuery()],
- queryFn: () => searchDocuments({
+ queryFn: () => fetchOrganizationDocuments({
organizationId: params.organizationId,
searchQuery: debouncedSearchQuery(),
...getPagination(),
@@ -86,9 +86,9 @@ export const DocumentsPage: Component = () => {
<div class="mb-4 text-sm text-muted-foreground mt-2 ml-2">
<Show
when={debouncedSearchQuery().length > 0}
- fallback={t('documents.list.search.total-count-no-query', { count: documentsQuery.data?.totalCount ?? 0 })}
+ fallback={t('documents.list.search.total-count-no-query', { count: documentsQuery.data?.documentsCount ?? 0 })}
>
- {t('documents.list.search.total-count-with-query', { count: documentsQuery.data?.totalCount ?? 0 })}
+ {t('documents.list.search.total-count-with-query', { count: documentsQuery.data?.documentsCount ?? 0 })}
</Show>
</div>
@@ -100,7 +100,7 @@ export const DocumentsPage: Component = () => {
<DocumentsPaginatedList
documents={documentsQuery.data?.documents ?? []}
- documentsCount={documentsQuery.data?.totalCount ?? 0}
+ documentsCount={documentsQuery.data?.documentsCount ?? 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.ts
index 0d3ca224..51af73f8 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
@@ -10,11 +10,11 @@ export function createDatabaseFts5DocumentSearchServices({ db }: { db: Database
name: DATABASE_FTS5_DOCUMENT_SEARCH_PROVIDER_NAME,
searchDocuments: async ({ searchQuery, organizationId, pageIndex, pageSize }) => {
- const { documents, totalCount } = await documentsSearchRepository.searchOrganizationDocuments({ organizationId, searchQuery, pageIndex, pageSize });
+ const { documents, documentsCount } = await documentsSearchRepository.searchOrganizationDocuments({ organizationId, searchQuery, pageIndex, pageSize });
return {
documents,
- totalCount,
+ documentsCount,
};
},
diff --git a/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.test.ts b/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.test.ts
index f724aab7..cbd123e1 100644
--- a/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.test.ts
+++ b/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.test.ts
@@ -73,7 +73,7 @@ describe('database-fts5 repository', () => {
expect(searchResults2.map(doc => doc.id)).to.eql(['doc_1']);
});
- describe('total count', () => {
+ describe('documents count', () => {
test('the total count of search results is returned for pagination', async () => {
const documents = Array.from({ length: 15 }).map((_, index) => ({
id: `doc_${index + 1}`,
@@ -98,14 +98,14 @@ describe('database-fts5 repository', () => {
documents.map(async document => documentsSearchRepository.indexDocument({ document })),
);
- const { totalCount, documents: searchDocuments } = await documentsSearchRepository.searchOrganizationDocuments({
+ const { documentsCount, documents: searchDocuments } = await documentsSearchRepository.searchOrganizationDocuments({
organizationId: 'org_1',
searchQuery: 'lorem',
pageIndex: 0,
pageSize: 10,
});
- expect(totalCount).to.equal(15);
+ expect(documentsCount).to.equal(15);
expect(searchDocuments).to.have.length(10);
});
@@ -116,14 +116,14 @@ describe('database-fts5 repository', () => {
const documentsSearchRepository = createDocumentSearchRepository({ db });
- const { totalCount, documents: searchDocuments } = await documentsSearchRepository.searchOrganizationDocuments({
+ const { documentsCount, documents: searchDocuments } = await documentsSearchRepository.searchOrganizationDocuments({
organizationId: 'org_1',
searchQuery: 'nonexistent',
pageIndex: 0,
pageSize: 10,
});
- expect(totalCount).to.equal(0);
+ expect(documentsCount).to.equal(0);
expect(searchDocuments).to.have.length(0);
});
@@ -153,14 +153,14 @@ describe('database-fts5 repository', () => {
documents.map(async document => documentsSearchRepository.indexDocument({ document })),
);
- const { totalCount, documents: searchDocuments } = await documentsSearchRepository.searchOrganizationDocuments({
+ const { documentsCount, documents: searchDocuments } = await documentsSearchRepository.searchOrganizationDocuments({
organizationId: 'org_1',
searchQuery: 'lorem',
pageIndex: 0,
pageSize: 10,
});
- expect(totalCount).to.equal(2);
+ expect(documentsCount).to.equal(2);
expect(searchDocuments).to.have.length(2);
});
});
@@ -191,7 +191,7 @@ describe('database-fts5 repository', () => {
documents.map(async document => documentsSearchRepository.indexDocument({ document })),
);
- const { documents: firstPageDocuments, totalCount: firstTotalCount } = await documentsSearchRepository.searchOrganizationDocuments({
+ const { documents: firstPageDocuments, documentsCount: firstTotalCount } = await documentsSearchRepository.searchOrganizationDocuments({
organizationId: 'org_1',
searchQuery: 'lorem',
pageIndex: 0,
@@ -202,7 +202,7 @@ describe('database-fts5 repository', () => {
expect(firstTotalCount).to.equal(25);
expect(firstPageDocuments.map(doc => doc.id)).to.eql(['doc_25', 'doc_24', 'doc_23', 'doc_22', 'doc_21', 'doc_20', 'doc_19', 'doc_18', 'doc_17', 'doc_16']);
- const { documents: secondPageDocuments, totalCount: secondTotalCount } = await documentsSearchRepository.searchOrganizationDocuments({
+ const { documents: secondPageDocuments, documentsCount: secondTotalCount } = await documentsSearchRepository.searchOrganizationDocuments({
organizationId: 'org_1',
searchQuery: 'lorem',
pageIndex: 1,
@@ -245,7 +245,7 @@ describe('database-fts5 repository', () => {
documents.map(async document => documentsSearchRepository.indexDocument({ document })),
);
- const { documents: firstPageDocuments, totalCount } = await documentsSearchRepository.searchOrganizationDocuments({
+ const { documents: firstPageDocuments, documentsCount } = await documentsSearchRepository.searchOrganizationDocuments({
organizationId: 'org_1',
searchQuery: 'lorem',
pageIndex: 0,
@@ -253,7 +253,7 @@ describe('database-fts5 repository', () => {
});
expect(firstPageDocuments).to.have.length(10);
- expect(totalCount).to.equal(20);
+ expect(documentsCount).to.equal(20);
});
});
@@ -289,6 +289,10 @@ describe('database-fts5 repository', () => {
);
const searches = [
+ {
+ searchQuery: '',
+ expectedDocumentsIds: ['doc_1', 'doc_2', 'doc_3', 'doc_4', 'doc_5'],
+ },
{
searchQuery: 'invoice',
expectedDocumentsIds: ['doc_1', 'doc_2', 'doc_3'],
@@ -478,7 +482,7 @@ describe('database-fts5 repository', () => {
documents.map(async document => documentsSearchRepository.indexDocument({ document })),
);
- const { documents: searchResults, totalCount } = await documentsSearchRepository.searchOrganizationDocuments({
+ const { documents: searchResults, documentsCount } = await documentsSearchRepository.searchOrganizationDocuments({
organizationId: 'org_1',
searchQuery: 'lorem',
pageIndex: 0,
@@ -486,7 +490,7 @@ describe('database-fts5 repository', () => {
});
expect(searchResults).to.have.length(2);
- expect(totalCount).to.equal(2);
+ expect(documentsCount).to.equal(2);
expect(
searchResults.map(doc => ({
id: doc.id,
diff --git a/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.ts b/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.ts
index c1e363c4..992c84a6 100644
--- a/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.ts
+++ b/apps/papra-server/src/modules/documents/document-search/database-fts5/database-fts5.repository.ts
@@ -53,10 +53,10 @@ async function searchOrganizationDocuments({ organizationId, searchQuery, pageIn
.orderBy(desc(paginatedIdsSubquery.createdAt)),
]);
- const totalCount = totalCountResult[0]?.count ?? 0;
+ const documentsCount = totalCountResult[0]?.count ?? 0;
if (documentsWithTags.length === 0) {
- return { documents: [], totalCount };
+ return { documents: [], documentsCount };
}
const documentsMap = documentsWithTags.reduce(
@@ -76,7 +76,7 @@ async function searchOrganizationDocuments({ organizationId, searchQuery, pageIn
const documents = Object.values(documentsMap);
- return { documents, totalCount };
+ return { documents, documentsCount };
}
async function indexDocument({ document, db }: { document: DocumentSearchableData; db: Database }) {
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.ts
index 20560382..491ce5d2 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<{ documents: Omit<Document, 'content'>[]; totalCount: number }>;
+ }) => Promise<{ documents: Omit<Document, 'content'>[]; documentsCount: 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.ts
index 26e6ad89..0834a3d0 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 { documents, totalCount } = await documentSearchServices.searchDocuments({
+ const { documents, documentsCount } = await documentSearchServices.searchDocuments({
searchQuery,
organizationId,
pageIndex,
@@ -36,6 +36,6 @@ export async function searchOrganizationDocuments({
return {
documents,
- totalCount,
+ documentsCount,
};
}
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.ts
index a1ee6b6b..be0ebbaa 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 { documents: [], totalCount: 0 };
+ return { documents: [], documentsCount: 0 };
},
indexDocument: async (args) => {
methodsArgs.indexDocument.push(args);
diff --git a/apps/papra-server/src/modules/documents/documents.repository.test.ts b/apps/papra-server/src/modules/documents/documents.repository.test.ts
index 01a96e42..622465ed 100644
--- a/apps/papra-server/src/modules/documents/documents.repository.test.ts
+++ b/apps/papra-server/src/modules/documents/documents.repository.test.ts
@@ -1,8 +1,10 @@
+import { desc } from 'drizzle-orm';
import { describe, expect, test } from 'vitest';
import { createInMemoryDatabase } from '../app/database/database.test-utils';
import { ORGANIZATION_ROLES } from '../organizations/organizations.constants';
import { createDocumentAlreadyExistsError } from './documents.errors';
import { createDocumentsRepository } from './documents.repository';
+import { documentsTable } from './documents.table';
describe('documents repository', () => {
describe('crud operations on document collection', () => {
@@ -36,11 +38,7 @@ describe('documents repository', () => {
isDeleted: false,
});
- const { documents } = await documentsRepository.getOrganizationDocuments({
- organizationId: 'organization-1',
- pageIndex: 0,
- pageSize: 10,
- });
+ const documents = await db.select().from(documentsTable).orderBy(desc(documentsTable.createdAt));
expect(documents).to.have.length(1);
expect(documents[0]).to.include({
@@ -59,13 +57,10 @@ describe('documents repository', () => {
organizationId: 'organization-1',
});
- const { documents: documentsAfterDelete } = await documentsRepository.getOrganizationDocuments({
- organizationId: 'organization-1',
- pageIndex: 0,
- pageSize: 10,
- });
+ const documentsAfterDelete = await db.select().from(documentsTable).orderBy(desc(documentsTable.createdAt));
- expect(documentsAfterDelete).to.have.length(0);
+ expect(documentsAfterDelete).to.have.length(1);
+ expect(documentsAfterDelete[0]!.isDeleted).toBe(true);
});
});
diff --git a/apps/papra-server/src/modules/documents/documents.repository.ts b/apps/papra-server/src/modules/documents/documents.repository.ts
index dac80f26..1f531b19 100644
--- a/apps/papra-server/src/modules/documents/documents.repository.ts
+++ b/apps/papra-server/src/modules/documents/documents.repository.ts
@@ -2,7 +2,6 @@ import type { Database } from '../app/database/database.types';
import type { DbInsertableDocument } from './documents.types';
import { injectArguments, safely } from '@corentinth/chisels';
import { and, count, desc, eq, getTableColumns, lt, sql } from 'drizzle-orm';
-import { omit } from 'lodash-es';
import { createIterator } from '../app/database/database.usecases';
import { createOrganizationNotFoundError } from '../organizations/organizations.errors';
import { subDays } from '../shared/date';
@@ -20,11 +19,9 @@ export function createDocumentsRepository({ db }: { db: Database }) {
return injectArguments(
{
saveOrganizationDocument,
- getOrganizationDocuments,
getOrganizationDeletedDocuments,
getDocumentById,
softDeleteDocument,
- getOrganizationDocumentsCount,
getOrganizationDeletedDocumentsCount,
restoreDocument,
hardDeleteDocument,
@@ -82,29 +79,6 @@ async function saveOrganizationDocument({ db, ...documentToInsert }: { db: Datab
return { document };
}
-async function getOrganizationDocumentsCount({ organizationId, db }: { organizationId: string; db: Database }) {
- const [record] = await db
- .select({
- documentsCount: count(documentsTable.id),
- })
- .from(documentsTable)
- .leftJoin(documentsTagsTable, eq(documentsTable.id, documentsTagsTable.documentId))
- .where(
- and(
- eq(documentsTable.organizationId, organizationId),
- eq(documentsTable.isDeleted, false),
- ),
- );
-
- if (isNil(record)) {
- throw createOrganizationNotFoundError();
- }
-
- const { documentsCount } = record;
-
- return { documentsCount };
-}
-
async function getOrganizationDeletedDocumentsCount({ organizationId, db }: { organizationId: string; db: Database }) {
const [record] = await db
.select({
@@ -127,63 +101,6 @@ async function getOrganizationDeletedDocumentsCount({ organizationId, db }: { or
return { documentsCount };
}
-async function getOrganizationDocuments({
- organizationId,
- pageIndex,
- pageSize,
- db,
-}: {
- organizationId: string;
- pageIndex: number;
- pageSize: number;
- db: Database;
-}) {
- const query = db
- .select({
- document: omit(getTableColumns(documentsTable), ['content']),
- tag: getTableColumns(tagsTable),
- })
- .from(documentsTable)
- .leftJoin(documentsTagsTable, eq(documentsTable.id, documentsTagsTable.documentId))
- .leftJoin(tagsTable, eq(tagsTable.id, documentsTagsTable.tagId))
- .where(
- and(
- eq(documentsTable.organizationId, organizationId),
- eq(documentsTable.isDeleted, false),
- ),
- );
-
- const documentsTagsQuery = withPagination(
- query.$dynamic(),
- {
- orderByColumn: desc(documentsTable.createdAt),
- pageIndex,
- pageSize,
- },
- );
-
- const documentsTags = await documentsTagsQuery;
-
- const groupedDocuments = documentsTags.reduce((acc, { document, tag }) => {
- if (!acc[document.id]) {
- acc[document.id] = {
- ...document,
- tags: [],
- };
- }
-
- if (tag) {
- acc[document.id]!.tags.push(tag);
- }
-
- return acc;
- }, {} as Record<string, Omit<typeof documentsTable.$inferSelect, 'content'> & { tags: typeof tagsTable.$inferSelect[] }>);
-
- return {
- documents: Object.values(groupedDocuments),
- };
-}
-
async function getOrganizationDeletedDocuments({ organizationId, pageIndex, pageSize, db }: { organizationId: string; pageIndex: number; pageSize: number; db: Database }) {
const query = db
.select()
diff --git a/apps/papra-server/src/modules/documents/documents.routes.ts b/apps/papra-server/src/modules/documents/documents.routes.ts
index 29c4ac41..891a3723 100644
--- a/apps/papra-server/src/modules/documents/documents.routes.ts
+++ b/apps/papra-server/src/modules/documents/documents.routes.ts
@@ -21,7 +21,6 @@ import { createDocumentCreationUsecase, deleteAllTrashDocuments, deleteTrashDocu
export function registerDocumentsRoutes(context: RouteDefinitionContext) {
setupCreateDocumentRoute(context);
setupGetDocumentsRoute(context);
- setupSearchDocumentsRoute(context);
setupRestoreDocumentRoute(context);
setupGetDeletedDocumentsRoute(context);
setupGetOrganizationDocumentsStatsRoute(context);
@@ -71,46 +70,6 @@ function setupCreateDocumentRoute({ app, ...deps }: RouteDefinitionContext) {
);
}
-function setupGetDocumentsRoute({ app, db }: RouteDefinitionContext) {
- app.get(
- '/api/organizations/:organizationId/documents',
- requireAuthentication({ apiKeyPermissions: ['documents:read'] }),
- validateParams(z.object({
- organizationId: organizationIdSchema,
- })),
- validateQuery(
- z.object({
- pageIndex: z.coerce.number().min(0).int().optional().default(0),
- pageSize: z.coerce.number().min(1).max(100).int().optional().default(100),
- }),
- ),
- async (context) => {
- const { userId } = getUser({ context });
-
- const { organizationId } = context.req.valid('param');
- const { pageIndex, pageSize } = context.req.valid('query');
-
- const documentsRepository = createDocumentsRepository({ db });
- const organizationsRepository = createOrganizationsRepository({ db });
-
- await ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });
-
- const [
- { documents },
- { documentsCount },
- ] = await Promise.all([
- documentsRepository.getOrganizationDocuments({ organizationId, pageIndex, pageSize }),
- documentsRepository.getOrganizationDocumentsCount({ organizationId }),
- ]);
-
- return context.json({
- documents: formatDocumentsForApi({ documents }),
- documentsCount,
- });
- },
- );
-}
-
function setupGetDeletedDocumentsRoute({ app, db }: RouteDefinitionContext) {
app.get(
'/api/organizations/:organizationId/documents/deleted',
@@ -293,16 +252,16 @@ function setupGetDocumentFileRoute({ app, db, documentsStorageService }: RouteDe
);
}
-function setupSearchDocumentsRoute({ app, db, documentSearchServices }: RouteDefinitionContext) {
+function setupGetDocumentsRoute({ app, db, documentSearchServices }: RouteDefinitionContext) {
app.get(
- '/api/organizations/:organizationId/documents/search',
+ '/api/organizations/:organizationId/documents',
requireAuthentication({ apiKeyPermissions: ['documents:read'] }),
validateParams(z.object({
organizationId: organizationIdSchema,
})),
validateQuery(
z.object({
- searchQuery: z.string(),
+ searchQuery: z.string().optional().default(''),
pageIndex: z.coerce.number().min(0).int().optional().default(0),
pageSize: z.coerce.number().min(1).max(100).int().optional().default(100),
}),
@@ -317,7 +276,7 @@ function setupSearchDocumentsRoute({ app, db, documentSearchServices }: RouteDef
await ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });
- const { documents, totalCount } = await searchOrganizationDocuments({
+ const { documents, documentsCount } = await searchOrganizationDocuments({
organizationId,
searchQuery,
pageIndex,
@@ -326,8 +285,8 @@ function setupSearchDocumentsRoute({ app, db, documentSearchServices }: RouteDef
});
return context.json({
- documents,
- totalCount,
+ documents: formatDocumentsForApi({ documents }),
+ documentsCount,
});
},
);