Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(api): add typed organization tags endpoint (#1559)

Corentin Thomasset980a744488e5
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 cc585e38..1757f0dc 100644
--- a/apps/papra-server/src/modules/api/api.contracts.registry.ts
+++ b/apps/papra-server/src/modules/api/api.contracts.registry.ts
@@ -1,5 +1,6 @@
import { healthCheckContract, pingContract } from '../app/health-check/health-check.api.contracts';
import { getCurrentUserContract, updateCurrentUserContract } from '../users/users.api.contracts';
+import { getOrganizationTagsContract } from '../tags/tags.api.contracts';
export type { ApiContract } from './api.contracts';
@@ -8,4 +9,5 @@ export const apiContracts = {
healthCheckContract,
getCurrentUserContract,
updateCurrentUserContract,
+ getOrganizationTagsContract,
};
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 a9634fa6..e3568934 100644
--- a/apps/papra-server/src/modules/app/server.api.routes.ts
+++ b/apps/papra-server/src/modules/app/server.api.routes.ts
@@ -2,6 +2,7 @@ import type { ApiDependencies, RouteDefinitionContext } from './server.types';
import { buildApiRequestHandler } from '../api/api.request-handler';
import { buildUserApiRoutes } from '../users/users.api.routes';
+import { buildTagsApiRoutes } from '../tags/tags.api.routes';
import { buildHealthCheckApiRoutes } from './health-check/health-check.api.routes';
import {
buildGetApiKey,
@@ -10,7 +11,11 @@ import {
} from '../api/api.authentication';
function buildApiRoutes(deps: ApiDependencies) {
- return [...buildHealthCheckApiRoutes(deps), ...buildUserApiRoutes(deps)];
+ return [
+ ...buildHealthCheckApiRoutes(deps),
+ ...buildUserApiRoutes(deps),
+ ...buildTagsApiRoutes(deps),
+ ];
}
export function registerApiRoutes({ app, ...deps }: RouteDefinitionContext) {
diff --git a/apps/papra-server/src/modules/tags/tags.api.contracts.ts b/apps/papra-server/src/modules/tags/tags.api.contracts.ts
new file mode 100644
index 00000000..49193258
--- /dev/null
+++ b/apps/papra-server/src/modules/tags/tags.api.contracts.ts
@@ -0,0 +1,39 @@
+import * as v from 'valibot';
+import { defineApiContract } from '../api/api.contracts';
+import { isoDateStringSchema } from '../api/api.schemas';
+import { organizationIdSchema } from '../organizations/organization.schemas';
+
+export const getOrganizationTagsContract = defineApiContract({
+ operationId: 'getOrganizationTags',
+ path: '/api/organizations/:organizationId/tags',
+ method: 'GET',
+ request: {
+ params: v.strictObject({
+ organizationId: organizationIdSchema,
+ }),
+ },
+ responses: {
+ 200: {
+ description: 'Returns organization tags with their non-deleted document counts.',
+ content: {
+ 'application/json': {
+ schema: v.object({
+ tags: v.array(
+ v.object({
+ id: v.string(),
+ createdAt: isoDateStringSchema,
+ updatedAt: isoDateStringSchema,
+ organizationId: v.string(),
+ name: v.string(),
+ normalizedName: v.nullable(v.string()),
+ color: v.string(),
+ description: v.nullable(v.string()),
+ documentsCount: v.number(),
+ }),
+ ),
+ }),
+ },
+ },
+ },
+ },
+});
diff --git a/apps/papra-server/src/modules/tags/tags.api.routes.ts b/apps/papra-server/src/modules/tags/tags.api.routes.ts
new file mode 100644
index 00000000..84c04c07
--- /dev/null
+++ b/apps/papra-server/src/modules/tags/tags.api.routes.ts
@@ -0,0 +1,37 @@
+import type { ApiDependencies } from '../app/server.types';
+import { defineApiRoute } from '../api/api.routes';
+import { createOrganizationsRepository } from '../organizations/organizations.repository';
+import { ensureUserIsInOrganization } from '../organizations/organizations.usecases';
+import { getOrganizationTagsContract } from './tags.api.contracts';
+import { createTagsRepository } from './tags.repository';
+
+export function buildTagsApiRoutes(deps: ApiDependencies) {
+ return [setupGetOrganizationTagsRoute(deps)];
+}
+
+function setupGetOrganizationTagsRoute({ resolveAuthenticationContext, db }: ApiDependencies) {
+ return defineApiRoute({
+ contract: getOrganizationTagsContract,
+ resolveContext: resolveAuthenticationContext({ apiKeyPermissions: ['tags:read'] }),
+ handler: async ({ context: { userId }, params: { organizationId } }) => {
+ const tagsRepository = createTagsRepository({ db });
+ const organizationsRepository = createOrganizationsRepository({ db });
+
+ await ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });
+
+ const { tags } = await tagsRepository.getOrganizationTags({ organizationId });
+
+ return {
+ status: 200,
+ contentType: 'application/json',
+ body: {
+ tags: tags.map((tag) => ({
+ ...tag,
+ createdAt: tag.createdAt.toISOString(),
+ updatedAt: tag.updatedAt.toISOString(),
+ })),
+ },
+ };
+ },
+ });
+}
diff --git a/apps/papra-server/src/modules/tags/tags.routes.ts b/apps/papra-server/src/modules/tags/tags.routes.ts
index d4ef9bcd..f40599be 100644
--- a/apps/papra-server/src/modules/tags/tags.routes.ts
+++ b/apps/papra-server/src/modules/tags/tags.routes.ts
@@ -19,7 +19,6 @@ import { addTagToDocument, createTag } from './tags.usecases';
export function registerTagsRoutes(context: RouteDefinitionContext) {
setupCreateNewTagRoute(context);
- setupGetOrganizationTagsRoute(context);
setupUpdateTagRoute(context);
setupDeleteTagRoute(context);
setupAddTagToDocumentRoute(context);
@@ -69,34 +68,6 @@ function setupCreateNewTagRoute({ app, db, config }: RouteDefinitionContext) {
);
}
-function setupGetOrganizationTagsRoute({ app, db }: RouteDefinitionContext) {
- app.get(
- '/api/organizations/:organizationId/tags',
- requireAuthentication({ apiKeyPermissions: ['tags:read'] }),
- validateParams(
- v.strictObject({
- organizationId: organizationIdSchema,
- }),
- ),
- async (context) => {
- const { userId } = getUser({ context });
-
- const { organizationId } = context.req.valid('param');
-
- const tagsRepository = createTagsRepository({ db });
- const organizationsRepository = createOrganizationsRepository({ db });
-
- await ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });
-
- const { tags } = await tagsRepository.getOrganizationTags({ organizationId });
-
- return context.json({
- tags,
- });
- },
- );
-}
-
function setupUpdateTagRoute({ app, db }: RouteDefinitionContext) {
app.put(
'/api/organizations/:organizationId/tags/:tagId',