The minimalistic document archiving platform.
refactor(organizations): migrate route validation from zod to valibot (#1041)
Corentin Thomasset123b7c1784cf
diff --git a/apps/papra-server/src/modules/organizations/organization.schemas.ts b/apps/papra-server/src/modules/organizations/organization.schemas.tsindex 197a5bcd..a27e551e 100644--- a/apps/papra-server/src/modules/organizations/organization.schemas.ts+++ b/apps/papra-server/src/modules/organizations/organization.schemas.ts@@ -1,6 +1,10 @@+import * as v from 'valibot';import { createRegexSchema } from '../shared/schemas/string.schemas';-import { ORGANIZATION_ID_REGEX, ORGANIZATION_INVITATION_ID_REGEX, ORGANIZATION_MEMBER_ID_REGEX } from './organizations.constants';+import { ORGANIZATION_ID_REGEX, ORGANIZATION_INVITATION_ID_REGEX, ORGANIZATION_MEMBER_ID_REGEX, ORGANIZATION_ROLES } from './organizations.constants';export const organizationIdSchema = createRegexSchema(ORGANIZATION_ID_REGEX);export const memberIdSchema = createRegexSchema(ORGANIZATION_MEMBER_ID_REGEX);export const invitationIdSchema = createRegexSchema(ORGANIZATION_INVITATION_ID_REGEX);++export const organizationNameSchema = v.pipe(v.string(), v.trim(), v.minLength(3), v.maxLength(50));+export const assignableOrganizationRoleSchema = v.picklist([ORGANIZATION_ROLES.ADMIN, ORGANIZATION_ROLES.MEMBER]);diff --git a/apps/papra-server/src/modules/organizations/organizations.routes.ts b/apps/papra-server/src/modules/organizations/organizations.routes.tsindex 32f22aae..cc3f4f73 100644--- a/apps/papra-server/src/modules/organizations/organizations.routes.ts+++ b/apps/papra-server/src/modules/organizations/organizations.routes.ts@@ -1,13 +1,13 @@import type { RouteDefinitionContext } from '../app/server.types';-import { z } from 'zod';+import * as v from 'valibot';import { createForbiddenError } from '../app/auth/auth.errors';import { requireAuthentication } from '../app/auth/auth.middleware';import { getUser } from '../app/auth/auth.models';import { createPlansRepository } from '../plans/plans.repository';-import { legacyValidateJsonBody, legacyValidateParams } from '../shared/validation/validation.legacy';+import { validateJsonBody, validateParams } from '../shared/validation/validation';import { createSubscriptionsRepository } from '../subscriptions/subscriptions.repository';import { createUsersRepository } from '../users/users.repository';-import { memberIdSchema, organizationIdSchema } from './organization.schemas.legacy';+import { assignableOrganizationRoleSchema, memberIdSchema, organizationIdSchema, organizationNameSchema } from './organization.schemas';import { ORGANIZATION_ROLES } from './organizations.constants';import { createOrganizationsRepository } from './organizations.repository';import { checkIfUserCanCreateNewOrganization, createOrganization, ensureUserIsInOrganization, inviteMemberToOrganization, removeMemberFromOrganization, restoreOrganization, softDeleteOrganization, updateOrganizationMemberRole } from './organizations.usecases';@@ -68,8 +68,8 @@ function setupCreateOrganizationRoute({ app, db, config }: RouteDefinitionContexapp.post('/api/organizations',requireAuthentication({ apiKeyPermissions: ['organizations:create'] }),- legacyValidateJsonBody(z.object({- name: z.string().min(3).max(50),+ validateJsonBody(v.strictObject({+ name: organizationNameSchema,})),async (context) => {const { userId } = getUser({ context });@@ -93,7 +93,7 @@ function setupGetOrganizationRoute({ app, db }: RouteDefinitionContext) {app.get('/api/organizations/:organizationId',requireAuthentication({ apiKeyPermissions: ['organizations:read'] }),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),async (context) => {@@ -115,12 +115,12 @@ function setupUpdateOrganizationRoute({ app, db }: RouteDefinitionContext) {app.put('/api/organizations/:organizationId',requireAuthentication({ apiKeyPermissions: ['organizations:update'] }),- legacyValidateJsonBody(z.object({- name: z.string().min(3).max(50),- })),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),+ validateJsonBody(v.strictObject({+ name: organizationNameSchema,+ })),async (context) => {const { userId } = getUser({ context });const { name } = context.req.valid('json');@@ -143,7 +143,7 @@ function setupSoftDeleteOrganizationRoute({ app, db, config }: RouteDefinitionCoapp.delete('/api/organizations/:organizationId',requireAuthentication({ apiKeyPermissions: ['organizations:delete'] }),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),async (context) => {@@ -166,7 +166,7 @@ function setupGetOrganizationMembersRoute({ app, db }: RouteDefinitionContext) {app.get('/api/organizations/:organizationId/members',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),async (context) => {@@ -188,7 +188,7 @@ function setupRemoveOrganizationMemberRoute({ app, db }: RouteDefinitionContext)app.delete('/api/organizations/:organizationId/members/:memberId',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,memberId: memberIdSchema,})),@@ -211,12 +211,12 @@ function setupUpdateOrganizationMemberRoute({ app, db }: RouteDefinitionContext)app.patch('/api/organizations/:organizationId/members/:memberId',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,memberId: memberIdSchema,})),- legacyValidateJsonBody(z.object({- role: z.enum([ORGANIZATION_ROLES.ADMIN, ORGANIZATION_ROLES.MEMBER]),+ validateJsonBody(v.strictObject({+ role: assignableOrganizationRoleSchema,})),async (context) => {const { userId } = getUser({ context });@@ -238,7 +238,7 @@ function setupGetMembershipRoute({ app, db }: RouteDefinitionContext) {app.get('/api/organizations/:organizationId/members/me',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),async (context) => {@@ -262,13 +262,13 @@ function setupInviteOrganizationMemberRoute({ app, db, config, emailsServices }:app.post('/api/organizations/:organizationId/members/invitations',requireAuthentication(),- legacyValidateJsonBody(z.object({- email: z.string().email().toLowerCase(),- role: z.enum([ORGANIZATION_ROLES.ADMIN, ORGANIZATION_ROLES.MEMBER]),- })),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),+ validateJsonBody(v.strictObject({+ email: v.pipe(v.string(), v.email(), v.toLowerCase()),+ role: assignableOrganizationRoleSchema,+ })),async (context) => {const { userId } = getUser({ context });const { organizationId } = context.req.valid('param');@@ -303,7 +303,7 @@ function setupGetOrganizationInvitationsRoute({ app, db }: RouteDefinitionContexapp.get('/api/organizations/:organizationId/members/invitations',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),async (context) => {@@ -329,7 +329,7 @@ function setupRestoreOrganizationRoute({ app, db }: RouteDefinitionContext) {app.post('/api/organizations/:organizationId/restore',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),async (context) => {