Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(api-keys): migrate validation from zod to valibot (#1035)

Corentin Thomasset9ad1c16b458a
diff --git a/apps/papra-server/src/modules/api-keys/api-keys.routes.ts b/apps/papra-server/src/modules/api-keys/api-keys.routes.ts
index 1d5baa74..1b39423a 100644
--- a/apps/papra-server/src/modules/api-keys/api-keys.routes.ts
+++ b/apps/papra-server/src/modules/api-keys/api-keys.routes.ts
@@ -1,15 +1,13 @@
import type { RouteDefinitionContext } from '../app/server.types';
-import type { ApiKeyPermissions } from './api-keys.types';
-import { z } from 'zod';
+import * as v from 'valibot';
import { createUnauthorizedError } from '../app/auth/auth.errors';
import { requireAuthentication } from '../app/auth/auth.middleware';
import { getUser } from '../app/auth/auth.models';
import { isNil } from '../shared/utils';
-import { legacyValidateJsonBody, legacyValidateParams } from '../shared/validation/validation.legacy';
-import { API_KEY_PERMISSIONS_VALUES } from './api-keys.constants';
+import { validateJsonBody, validateParams } from '../shared/validation/validation';
import { createNotApiKeyAuthError } from './api-keys.errors';
import { createApiKeysRepository } from './api-keys.repository';
-import { apiKeyIdSchema } from './api-keys.schemas.legacy';
+import { apiKeyIdSchema, apiKeyPermissionsSchema } from './api-keys.schemas';
import { createApiKey } from './api-keys.usecases';
export function registerApiKeysRoutes(context: RouteDefinitionContext) {
@@ -23,13 +21,13 @@ function setupCreateApiKeyRoute({ app, db }: RouteDefinitionContext) {
app.post(
'/api/api-keys',
requireAuthentication(),
- legacyValidateJsonBody(
- z.object({
- name: z.string(),
- permissions: z.array(z.enum(API_KEY_PERMISSIONS_VALUES as [ApiKeyPermissions, ...ApiKeyPermissions[]])).min(1),
- // organizationIds: z.array(z.string()).default([]),
- // allOrganizations: z.boolean().default(false),
- // expiresAt: z.date().optional(),
+ validateJsonBody(
+ v.strictObject({
+ name: v.string(),
+ permissions: apiKeyPermissionsSchema,
+ // organizationIds: v.optional(v.array(v.string()), []),
+ // allOrganizations: v.optional(v.boolean(), false),
+ // expiresAt: v.optional(v.date()),
}),
),
async (context) => {
@@ -121,7 +119,7 @@ function setupDeleteApiKeyRoute({ app, db }: RouteDefinitionContext) {
app.delete(
'/api/api-keys/:apiKeyId',
requireAuthentication(),
- legacyValidateParams(z.object({
+ validateParams(v.strictObject({
apiKeyId: apiKeyIdSchema,
})),
async (context) => {
diff --git a/apps/papra-server/src/modules/api-keys/api-keys.schemas.legacy.ts b/apps/papra-server/src/modules/api-keys/api-keys.schemas.legacy.ts
deleted file mode 100644
index c8263964..00000000
--- a/apps/papra-server/src/modules/api-keys/api-keys.schemas.legacy.ts
+++ /dev/null
@@ -1,4 +0,0 @@
-import { z } from 'zod';
-import { API_KEY_ID_REGEX } from './api-keys.constants';
-
-export const apiKeyIdSchema = z.string().regex(API_KEY_ID_REGEX);
diff --git a/apps/papra-server/src/modules/api-keys/api-keys.schemas.test.ts b/apps/papra-server/src/modules/api-keys/api-keys.schemas.test.ts
new file mode 100644
index 00000000..f24f2c87
--- /dev/null
+++ b/apps/papra-server/src/modules/api-keys/api-keys.schemas.test.ts
@@ -0,0 +1,35 @@
+import * as v from 'valibot';
+import { describe, expect, test } from 'vitest';
+import { API_KEY_PERMISSIONS_VALUES } from './api-keys.constants';
+import { apiKeyPermissionsSchema } from './api-keys.schemas';
+
+describe('api-keys.schemas', () => {
+ describe('apiKeyPermissionsSchema', () => {
+ test('accepts a single valid permission', () => {
+ expect(v.parse(apiKeyPermissionsSchema, ['documents:read'])).toEqual(['documents:read']);
+ });
+
+ test('accepts multiple valid permissions', () => {
+ const permissions = ['documents:read', 'documents:create', 'organizations:read'];
+ expect(v.parse(apiKeyPermissionsSchema, permissions)).toEqual(permissions);
+ });
+
+ test('accepts all known permissions', () => {
+ expect(v.parse(apiKeyPermissionsSchema, API_KEY_PERMISSIONS_VALUES)).toEqual(API_KEY_PERMISSIONS_VALUES);
+ });
+
+ test('rejects an empty array', () => {
+ expect(() => v.parse(apiKeyPermissionsSchema, [])).toThrow();
+ });
+
+ test('rejects unknown permission values', () => {
+ expect(() => v.parse(apiKeyPermissionsSchema, ['unknown:permission'])).toThrow();
+ expect(() => v.parse(apiKeyPermissionsSchema, ['documents:read', 'invalid'])).toThrow();
+ });
+
+ test('rejects non-array inputs', () => {
+ expect(() => v.parse(apiKeyPermissionsSchema, 'documents:read')).toThrow();
+ expect(() => v.parse(apiKeyPermissionsSchema, null)).toThrow();
+ });
+ });
+});
diff --git a/apps/papra-server/src/modules/api-keys/api-keys.schemas.ts b/apps/papra-server/src/modules/api-keys/api-keys.schemas.ts
new file mode 100644
index 00000000..b5854bd5
--- /dev/null
+++ b/apps/papra-server/src/modules/api-keys/api-keys.schemas.ts
@@ -0,0 +1,10 @@
+import * as v from 'valibot';
+import { createRegexSchema } from '../shared/schemas/string.schemas';
+import { API_KEY_ID_REGEX, API_KEY_PERMISSIONS_VALUES } from './api-keys.constants';
+
+export const apiKeyIdSchema = createRegexSchema(API_KEY_ID_REGEX);
+
+export const apiKeyPermissionsSchema = v.pipe(
+ v.array(v.picklist(API_KEY_PERMISSIONS_VALUES)),
+ v.minLength(1),
+);