Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

refactor(api): migrate orgs list route (#1569)

Corentin Thomasset8678751b5468
diff --git a/apps/papra-server/src/modules/api/api.contracts.registry.ts b/apps/papra-server/src/modules/api/api.contracts.registry.ts
index d2e5f7de..08846848 100644
--- a/apps/papra-server/src/modules/api/api.contracts.registry.ts
+++ b/apps/papra-server/src/modules/api/api.contracts.registry.ts
@@ -1,4 +1,5 @@
import { healthCheckContract, pingContract } from '../app/health-check/health-check.api.contracts';
+import { getOrganizationsContract } from '../organizations/organizations.api.contracts';
import { getCurrentUserContract, updateCurrentUserContract } from '../users/users.api.contracts';
import {
addOrganizationDocumentTagContract,
@@ -16,6 +17,7 @@ export const apiContracts = {
healthCheckContract,
getCurrentUserContract,
updateCurrentUserContract,
+ getOrganizationsContract,
getOrganizationTagsContract,
createOrganizationTagContract,
updateOrganizationTagContract,
diff --git a/apps/papra-server/src/modules/app/server.api.routes.test.ts b/apps/papra-server/src/modules/app/server.api.routes.test.ts
index 15858041..38b8df65 100644
--- a/apps/papra-server/src/modules/app/server.api.routes.test.ts
+++ b/apps/papra-server/src/modules/app/server.api.routes.test.ts
@@ -142,26 +142,4 @@ describe('contract API wiring', () => {
error: { message: 'Unauthorized', code: 'auth.unauthorized' },
});
});
-
- test('unmigrated routes receive the session and unread request body', async () => {
- const { app, headers } = await createAuthenticatedServer();
-
- const response = await app.request('/api/organizations', {
- method: 'POST',
- headers: { ...headers, 'Content-Type': 'application/json' },
- body: JSON.stringify({ name: 'Alice Organization' }),
- });
-
- expect(response.status).toEqual(200);
- expect(await response.json()).toMatchObject({
- organization: { name: 'Alice Organization' },
- });
-
- const organizationsResponse = await app.request('/api/organizations', { headers });
-
- expect(organizationsResponse.status).toEqual(200);
- expect(await organizationsResponse.json()).toMatchObject({
- organizations: [{ name: 'Alice Organization' }],
- });
- });
});
diff --git a/apps/papra-server/src/modules/app/server.api.routes.ts b/apps/papra-server/src/modules/app/server.api.routes.ts
index 9046cb2f..4174ce9d 100644
--- a/apps/papra-server/src/modules/app/server.api.routes.ts
+++ b/apps/papra-server/src/modules/app/server.api.routes.ts
@@ -1,6 +1,7 @@
import type { ApiDependencies, RouteDefinitionContext } from './server.types';
import { buildApiRequestHandler } from '../api/api.request-handler';
+import { buildOrganizationsApiRoutes } from '../organizations/organizations.api.routes';
import { buildUserApiRoutes } from '../users/users.api.routes';
import { buildTagsApiRoutes } from '../tags/tags.api.routes';
import { buildHealthCheckApiRoutes } from './health-check/health-check.api.routes';
@@ -14,6 +15,7 @@ function buildApiRoutes(deps: ApiDependencies) {
return [
...buildHealthCheckApiRoutes(deps),
...buildUserApiRoutes(deps),
+ ...buildOrganizationsApiRoutes(deps),
...buildTagsApiRoutes(deps),
];
}
diff --git a/apps/papra-server/src/modules/organizations/organizations.api.contracts.ts b/apps/papra-server/src/modules/organizations/organizations.api.contracts.ts
new file mode 100644
index 00000000..a3eaed4e
--- /dev/null
+++ b/apps/papra-server/src/modules/organizations/organizations.api.contracts.ts
@@ -0,0 +1,32 @@
+import * as v from 'valibot';
+import { defineApiContract } from '../api/api.contracts';
+import { isoDateStringSchema } from '../api/api.schemas';
+
+export const getOrganizationsContract = defineApiContract({
+ operationId: 'getOrganizations',
+ path: '/api/organizations',
+ method: 'GET',
+ responses: {
+ 200: {
+ description: "Returns the current authenticated user's non-deleted organizations.",
+ content: {
+ 'application/json': {
+ schema: v.object({
+ organizations: v.array(
+ v.object({
+ id: v.string(),
+ name: v.string(),
+ createdAt: isoDateStringSchema,
+ updatedAt: isoDateStringSchema,
+ customerId: v.nullable(v.string()),
+ deletedAt: v.nullable(isoDateStringSchema),
+ deletedBy: v.nullable(v.string()),
+ scheduledPurgeAt: v.nullable(isoDateStringSchema),
+ }),
+ ),
+ }),
+ },
+ },
+ },
+ },
+});
diff --git a/apps/papra-server/src/modules/organizations/organizations.api.routes.ts b/apps/papra-server/src/modules/organizations/organizations.api.routes.ts
new file mode 100644
index 00000000..803a3479
--- /dev/null
+++ b/apps/papra-server/src/modules/organizations/organizations.api.routes.ts
@@ -0,0 +1,34 @@
+import type { ApiDependencies } from '../app/server.types';
+import { defineApiRoute } from '../api/api.routes';
+import { getOrganizationsContract } from './organizations.api.contracts';
+import { createOrganizationsRepository } from './organizations.repository';
+
+export function buildOrganizationsApiRoutes(deps: ApiDependencies) {
+ return [setupGetOrganizationsRoute(deps)];
+}
+
+function setupGetOrganizationsRoute({ resolveAuthenticationContext, db }: ApiDependencies) {
+ return defineApiRoute({
+ contract: getOrganizationsContract,
+ resolveContext: resolveAuthenticationContext({ apiKeyPermissions: ['organizations:read'] }),
+ handler: async ({ context: { userId } }) => {
+ const organizationsRepository = createOrganizationsRepository({ db });
+
+ const { organizations } = await organizationsRepository.getUserOrganizations({ userId });
+
+ return {
+ status: 200,
+ contentType: 'application/json',
+ body: {
+ organizations: organizations.map((organization) => ({
+ ...organization,
+ createdAt: organization.createdAt.toISOString(),
+ updatedAt: organization.updatedAt.toISOString(),
+ deletedAt: organization.deletedAt?.toISOString() ?? null,
+ scheduledPurgeAt: organization.scheduledPurgeAt?.toISOString() ?? null,
+ })),
+ },
+ };
+ },
+ });
+}
diff --git a/apps/papra-server/src/modules/organizations/organizations.routes.ts b/apps/papra-server/src/modules/organizations/organizations.routes.ts
index 002098c6..1c2dc3ca 100644
--- a/apps/papra-server/src/modules/organizations/organizations.routes.ts
+++ b/apps/papra-server/src/modules/organizations/organizations.routes.ts
@@ -31,7 +31,6 @@ import {
} from './organizations.usecases';
export function registerOrganizationsRoutes(context: RouteDefinitionContext) {
- setupGetOrganizationsRoute(context);
setupGetDeletedOrganizationsRoute(context);
setupCreateOrganizationRoute(context);
setupGetOrganizationRoute(context);
@@ -46,24 +45,6 @@ export function registerOrganizationsRoutes(context: RouteDefinitionContext) {
setupRestoreOrganizationRoute(context);
}
-function setupGetOrganizationsRoute({ app, db }: RouteDefinitionContext) {
- app.get(
- '/api/organizations',
- requireAuthentication({ apiKeyPermissions: ['organizations:read'] }),
- async (context) => {
- const { userId } = getUser({ context });
-
- const organizationsRepository = createOrganizationsRepository({ db });
-
- const { organizations } = await organizationsRepository.getUserOrganizations({ userId });
-
- return context.json({
- organizations,
- });
- },
- );
-}
-
function setupGetDeletedOrganizationsRoute({ app, db }: RouteDefinitionContext) {
app.get(
'/api/organizations/deleted',