Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

refactor(validation): mutualized resources ids for route validation (#241)

Corentin Thomassetab98c1b255f7
diff --git a/apps/papra-server/src/modules/app/database/database.constants.ts b/apps/papra-server/src/modules/app/database/database.constants.ts
new file mode 100644
index 00000000..69e74788
--- /dev/null
+++ b/apps/papra-server/src/modules/app/database/database.constants.ts
@@ -0,0 +1 @@
+export const ID_RANDOM_PART_LENGTH = 24;
diff --git a/apps/papra-server/src/modules/documents/documents.constants.ts b/apps/papra-server/src/modules/documents/documents.constants.ts
index 7f2c8450..0b027105 100644
--- a/apps/papra-server/src/modules/documents/documents.constants.ts
+++ b/apps/papra-server/src/modules/documents/documents.constants.ts
@@ -1 +1,6 @@
+import { createPrefixedIdRegex } from '../shared/random/ids';
+
+export const DOCUMENT_ID_PREFIX = 'doc';
+export const DOCUMENT_ID_REGEX = createPrefixedIdRegex({ prefix: DOCUMENT_ID_PREFIX });
+
export const ORIGINAL_DOCUMENTS_STORAGE_KEY = 'originals';
diff --git a/apps/papra-server/src/modules/documents/documents.models.ts b/apps/papra-server/src/modules/documents/documents.models.ts
index e62a14ed..7cacc61c 100644
--- a/apps/papra-server/src/modules/documents/documents.models.ts
+++ b/apps/papra-server/src/modules/documents/documents.models.ts
@@ -1,5 +1,5 @@
import { getExtension } from '../shared/files/file-names';
-import { generateId } from '../shared/random';
+import { generateId } from '../shared/random/ids';
import { ORIGINAL_DOCUMENTS_STORAGE_KEY } from './documents.constants';
export function joinStorageKeyParts(...parts: string[]) {
diff --git a/apps/papra-server/src/modules/documents/documents.routes.ts b/apps/papra-server/src/modules/documents/documents.routes.ts
index fd93e636..14e6c7ab 100644
--- a/apps/papra-server/src/modules/documents/documents.routes.ts
+++ b/apps/papra-server/src/modules/documents/documents.routes.ts
@@ -2,7 +2,7 @@ import type { RouteDefinitionContext } from '../app/server.types';
import { bodyLimit } from 'hono/body-limit';
import { z } from 'zod';
import { getUser } from '../app/auth/auth.models';
-import { organizationIdRegex } from '../organizations/organizations.constants';
+import { organizationIdSchema } from '../organizations/organization.schemas';
import { createOrganizationsRepository } from '../organizations/organizations.repository';
import { ensureUserIsInOrganization } from '../organizations/organizations.usecases';
import { createPlansRepository } from '../plans/plans.repository';
@@ -14,6 +14,7 @@ import { createTagsRepository } from '../tags/tags.repository';
import { createDocumentIsNotDeletedError } from './documents.errors';
import { isDocumentSizeLimitEnabled } from './documents.models';
import { createDocumentsRepository } from './documents.repository';
+import { documentIdSchema } from './documents.schemas';
import { createDocument, deleteAllTrashDocuments, deleteTrashDocument, ensureDocumentExists, getDocumentOrThrow } from './documents.usecases';
import { createDocumentStorageService } from './storage/documents.storage.services';
@@ -59,7 +60,7 @@ function setupCreateDocumentRoute({ app, config, db, trackingServices }: RouteDe
file: z.instanceof(File),
})),
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -114,7 +115,7 @@ function setupGetDocumentsRoute({ app, db }: RouteDefinitionContext) {
app.get(
'/api/organizations/:organizationId/documents',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
validateQuery(
z.object({
@@ -157,7 +158,7 @@ function setupGetDeletedDocumentsRoute({ app, db }: RouteDefinitionContext) {
app.get(
'/api/organizations/:organizationId/documents/deleted',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
validateQuery(
z.object({
@@ -196,8 +197,8 @@ function setupGetDocumentRoute({ app, db }: RouteDefinitionContext) {
app.get(
'/api/organizations/:organizationId/documents/:documentId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- documentId: z.string(),
+ organizationId: organizationIdSchema,
+ documentId: documentIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -222,8 +223,8 @@ function setupDeleteDocumentRoute({ app, db }: RouteDefinitionContext) {
app.delete(
'/api/organizations/:organizationId/documents/:documentId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- documentId: z.string(),
+ organizationId: organizationIdSchema,
+ documentId: documentIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -249,8 +250,8 @@ function setupRestoreDocumentRoute({ app, db }: RouteDefinitionContext) {
app.post(
'/api/organizations/:organizationId/documents/:documentId/restore',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- documentId: z.string(),
+ organizationId: organizationIdSchema,
+ documentId: documentIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -279,8 +280,8 @@ function setupGetDocumentFileRoute({ app, config, db }: RouteDefinitionContext)
app.get(
'/api/organizations/:organizationId/documents/:documentId/file',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- documentId: z.string(),
+ organizationId: organizationIdSchema,
+ documentId: documentIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -315,7 +316,7 @@ function setupSearchDocumentsRoute({ app, db }: RouteDefinitionContext) {
app.get(
'/api/organizations/:organizationId/documents/search',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
validateQuery(
z.object({
@@ -348,7 +349,7 @@ function setupGetOrganizationDocumentsStatsRoute({ app, db }: RouteDefinitionCon
app.get(
'/api/organizations/:organizationId/documents/statistics',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -376,8 +377,8 @@ function setupDeleteTrashDocumentRoute({ app, config, db }: RouteDefinitionConte
app.delete(
'/api/organizations/:organizationId/documents/trash/:documentId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- documentId: z.string(),
+ organizationId: organizationIdSchema,
+ documentId: documentIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -403,7 +404,7 @@ function setupDeleteAllTrashDocumentsRoute({ app, config, db }: RouteDefinitionC
app.delete(
'/api/organizations/:organizationId/documents/trash',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
diff --git a/apps/papra-server/src/modules/documents/documents.schemas.ts b/apps/papra-server/src/modules/documents/documents.schemas.ts
new file mode 100644
index 00000000..231ed6b8
--- /dev/null
+++ b/apps/papra-server/src/modules/documents/documents.schemas.ts
@@ -0,0 +1,4 @@
+import { z } from 'zod';
+import { DOCUMENT_ID_REGEX } from './documents.constants';
+
+export const documentIdSchema = z.string().regex(DOCUMENT_ID_REGEX);
diff --git a/apps/papra-server/src/modules/ingestion-folders/ingestion-folder.models.ts b/apps/papra-server/src/modules/ingestion-folders/ingestion-folder.models.ts
index 6cd17745..b7e2cddf 100644
--- a/apps/papra-server/src/modules/ingestion-folders/ingestion-folder.models.ts
+++ b/apps/papra-server/src/modules/ingestion-folders/ingestion-folder.models.ts
@@ -1,5 +1,5 @@
import { isAbsolute, join, parse, sep as pathSeparator, relative } from 'node:path';
-import { organizationIdRegex } from '../organizations/organizations.constants';
+import { ORGANIZATION_ID_REGEX } from '../organizations/organizations.constants';
export function normalizeFilePathToIngestionFolder({
filePath,
@@ -16,7 +16,7 @@ export function normalizeFilePathToIngestionFolder({
export function getOrganizationIdFromFilePath({ relativeFilePath }: { relativeFilePath: string }) {
const [maybeOrganizationId] = relativeFilePath.split(pathSeparator);
- if (!maybeOrganizationId || !organizationIdRegex.test(maybeOrganizationId)) {
+ if (!maybeOrganizationId || !ORGANIZATION_ID_REGEX.test(maybeOrganizationId)) {
return { organizationId: undefined };
}
diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.constants.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.constants.ts
index 382b5475..463dacec 100644
--- a/apps/papra-server/src/modules/intake-emails/intake-emails.constants.ts
+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.constants.ts
@@ -1,2 +1,7 @@
+import { createPrefixedIdRegex } from '../shared/random/ids';
+
+export const INTAKE_EMAIL_ID_PREFIX = 'ie';
+export const INTAKE_EMAIL_ID_REGEX = createPrefixedIdRegex({ prefix: INTAKE_EMAIL_ID_PREFIX });
+
// Mutualized since it's used in route definition and owlrelay client
export const INTAKE_EMAILS_INGEST_ROUTE = '/api/intake-emails/ingest' as const;
diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.routes.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.routes.ts
index 91774f9f..5cca9e73 100644
--- a/apps/papra-server/src/modules/intake-emails/intake-emails.routes.ts
+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.routes.ts
@@ -5,7 +5,7 @@ import { createUnauthorizedError } from '../app/auth/auth.errors';
import { getUser } from '../app/auth/auth.models';
import { createDocumentsRepository } from '../documents/documents.repository';
import { createDocumentStorageService } from '../documents/storage/documents.storage.services';
-import { organizationIdRegex } from '../organizations/organizations.constants';
+import { organizationIdSchema } from '../organizations/organization.schemas';
import { createOrganizationsRepository } from '../organizations/organizations.repository';
import { ensureUserIsInOrganization } from '../organizations/organizations.usecases';
import { createPlansRepository } from '../plans/plans.repository';
@@ -18,7 +18,7 @@ import { createTaggingRulesRepository } from '../tagging-rules/tagging-rules.rep
import { createTagsRepository } from '../tags/tags.repository';
import { INTAKE_EMAILS_INGEST_ROUTE } from './intake-emails.constants';
import { createIntakeEmailsRepository } from './intake-emails.repository';
-import { intakeEmailsIngestionMetaSchema, parseJson } from './intake-emails.schemas';
+import { intakeEmailIdSchema, intakeEmailsIngestionMetaSchema, parseJson } from './intake-emails.schemas';
import { createIntakeEmailsServices } from './intake-emails.services';
import { createIntakeEmail, deleteIntakeEmail, processIntakeEmailIngestion } from './intake-emails.usecases';
@@ -39,7 +39,7 @@ function setupGetOrganizationIntakeEmailsRoute({ app, db }: RouteDefinitionConte
app.get(
'/api/organizations/:organizationId/intake-emails',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -61,7 +61,7 @@ function setupCreateIntakeEmailRoute({ app, db, config }: RouteDefinitionContext
app.post(
'/api/organizations/:organizationId/intake-emails',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -92,8 +92,8 @@ function setupDeleteIntakeEmailRoute({ app, db, config }: RouteDefinitionContext
app.delete(
'/api/organizations/:organizationId/intake-emails/:intakeEmailId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- intakeEmailId: z.string(),
+ organizationId: organizationIdSchema,
+ intakeEmailId: intakeEmailIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -116,8 +116,8 @@ function setupUpdateIntakeEmailRoute({ app, db }: RouteDefinitionContext) {
app.put(
'/api/organizations/:organizationId/intake-emails/:intakeEmailId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- intakeEmailId: z.string(),
+ organizationId: organizationIdSchema,
+ intakeEmailId: intakeEmailIdSchema,
})),
validateJsonBody(z.object({
isEnabled: z.boolean().optional(),
diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.ts
index c675b049..8c3ae80b 100644
--- a/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.ts
+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.ts
@@ -1,4 +1,5 @@
import { z } from 'zod';
+import { INTAKE_EMAIL_ID_REGEX } from './intake-emails.constants';
export const emailInfoSchema = z.object({
address: z.string().email(),
@@ -22,3 +23,5 @@ export function parseJson(content: string, ctx: z.RefinementCtx) {
return z.never;
}
}
+
+export const intakeEmailIdSchema = z.string().regex(INTAKE_EMAIL_ID_REGEX);
diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.tables.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.tables.ts
index c4269a8b..18737cfd 100644
--- a/apps/papra-server/src/modules/intake-emails/intake-emails.tables.ts
+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.tables.ts
@@ -1,9 +1,10 @@
import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { organizationsTable } from '../organizations/organizations.table';
import { createPrimaryKeyField, createTimestampColumns } from '../shared/db/columns.helpers';
+import { INTAKE_EMAIL_ID_PREFIX } from './intake-emails.constants';
export const intakeEmailsTable = sqliteTable('intake_emails', {
- ...createPrimaryKeyField({ prefix: 'ie' }),
+ ...createPrimaryKeyField({ prefix: INTAKE_EMAIL_ID_PREFIX }),
...createTimestampColumns(),
emailAddress: text('email_address').notNull().unique(),
diff --git a/apps/papra-server/src/modules/organizations/organization.schemas.test.ts b/apps/papra-server/src/modules/organizations/organization.schemas.test.ts
new file mode 100644
index 00000000..c5da7c57
--- /dev/null
+++ b/apps/papra-server/src/modules/organizations/organization.schemas.test.ts
@@ -0,0 +1,16 @@
+import { describe, expect, test } from 'vitest';
+import { organizationIdSchema } from './organization.schemas';
+
+describe('organization schemas', () => {
+ describe('organizationIdSchema', () => {
+ test('an organization id should be a 24 character random string prefixed with "org"', () => {
+ expect(organizationIdSchema.safeParse('org_aaaaaaaaaaaaaaaaaaaaaaaa').success).to.eql(true);
+ expect(organizationIdSchema.safeParse('org_0aaaaaaaaaaaaaaaaaaaaaa1').success).to.eql(true);
+ expect(organizationIdSchema.safeParse('org_000000000000000000000000').success).to.eql(true);
+
+ expect(organizationIdSchema.safeParse('org_aaaa').success).to.eql(false);
+ expect(organizationIdSchema.safeParse('org').success).to.eql(false);
+ expect(organizationIdSchema.safeParse('foo').success).to.eql(false);
+ });
+ });
+});
diff --git a/apps/papra-server/src/modules/organizations/organization.schemas.ts b/apps/papra-server/src/modules/organizations/organization.schemas.ts
new file mode 100644
index 00000000..0b3cd0f5
--- /dev/null
+++ b/apps/papra-server/src/modules/organizations/organization.schemas.ts
@@ -0,0 +1,4 @@
+import { z } from 'zod';
+import { ORGANIZATION_ID_REGEX } from './organizations.constants';
+
+export const organizationIdSchema = z.string().regex(ORGANIZATION_ID_REGEX);
diff --git a/apps/papra-server/src/modules/organizations/organizations.constants.ts b/apps/papra-server/src/modules/organizations/organizations.constants.ts
index 7095e3b8..1ac6945f 100644
--- a/apps/papra-server/src/modules/organizations/organizations.constants.ts
+++ b/apps/papra-server/src/modules/organizations/organizations.constants.ts
@@ -1,4 +1,7 @@
-export const organizationIdRegex = /^org_[a-z0-9]{24}$/;
+import { createPrefixedIdRegex } from '../shared/random/ids';
+
+export const ORGANIZATION_ID_PREFIX = 'org';
+export const ORGANIZATION_ID_REGEX = createPrefixedIdRegex({ prefix: ORGANIZATION_ID_PREFIX });
export const ORGANIZATION_ROLES = {
MEMBER: 'member',
diff --git a/apps/papra-server/src/modules/organizations/organizations.routes.ts b/apps/papra-server/src/modules/organizations/organizations.routes.ts
index 8fcbb11c..9891b3c5 100644
--- a/apps/papra-server/src/modules/organizations/organizations.routes.ts
+++ b/apps/papra-server/src/modules/organizations/organizations.routes.ts
@@ -3,7 +3,7 @@ import { z } from 'zod';
import { getUser } from '../app/auth/auth.models';
import { validateJsonBody, validateParams } from '../shared/validation/validation';
import { createUsersRepository } from '../users/users.repository';
-import { organizationIdRegex } from './organizations.constants';
+import { organizationIdSchema } from './organization.schemas';
import { createOrganizationsRepository } from './organizations.repository';
import { checkIfUserCanCreateNewOrganization, createOrganization, ensureUserIsInOrganization } from './organizations.usecases';
@@ -57,7 +57,7 @@ function setupGetOrganizationRoute({ app, db }: RouteDefinitionContext) {
app.get(
'/api/organizations/:organizationId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -81,7 +81,7 @@ function setupUpdateOrganizationRoute({ app, db }: RouteDefinitionContext) {
name: z.string().min(3).max(50),
})),
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -105,7 +105,7 @@ function setupDeleteOrganizationRoute({ app, db }: RouteDefinitionContext) {
app.delete(
'/api/organizations/:organizationId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
diff --git a/apps/papra-server/src/modules/organizations/organizations.table.ts b/apps/papra-server/src/modules/organizations/organizations.table.ts
index 5cfb0d28..65ffcbf9 100644
--- a/apps/papra-server/src/modules/organizations/organizations.table.ts
+++ b/apps/papra-server/src/modules/organizations/organizations.table.ts
@@ -1,9 +1,10 @@
import { integer, sqliteTable, text, unique } from 'drizzle-orm/sqlite-core';
import { createPrimaryKeyField, createTimestampColumns } from '../shared/db/columns.helpers';
import { usersTable } from '../users/users.table';
+import { ORGANIZATION_ID_PREFIX } from './organizations.constants';
export const organizationsTable = sqliteTable('organizations', {
- ...createPrimaryKeyField({ prefix: 'org' }),
+ ...createPrimaryKeyField({ prefix: ORGANIZATION_ID_PREFIX }),
...createTimestampColumns(),
name: text('name').notNull(),
diff --git a/apps/papra-server/src/modules/shared/db/columns.helpers.ts b/apps/papra-server/src/modules/shared/db/columns.helpers.ts
index d3393bd8..57396463 100644
--- a/apps/papra-server/src/modules/shared/db/columns.helpers.ts
+++ b/apps/papra-server/src/modules/shared/db/columns.helpers.ts
@@ -1,5 +1,5 @@
import { integer, text } from 'drizzle-orm/sqlite-core';
-import { generateId } from '../random';
+import { generateId } from '../random/ids';
export { createCreatedAtField, createPrimaryKeyField, createSoftDeleteColumns, createTimestampColumns, createUpdatedAtField };
diff --git a/apps/papra-server/src/modules/shared/logger/logger.middleware.ts b/apps/papra-server/src/modules/shared/logger/logger.middleware.ts
index 1b541121..a9524be0 100644
--- a/apps/papra-server/src/modules/shared/logger/logger.middleware.ts
+++ b/apps/papra-server/src/modules/shared/logger/logger.middleware.ts
@@ -1,6 +1,6 @@
import { createMiddleware } from 'hono/factory';
import { getHeader } from '../headers/headers.models';
-import { generateId } from '../random';
+import { generateId } from '../random/ids';
import { createLogger, wrapWithLoggerContext } from './logger';
const logger = createLogger({ namespace: 'app' });
diff --git a/apps/papra-server/src/modules/shared/random.ts b/apps/papra-server/src/modules/shared/random.ts
deleted file mode 100644
index 59683641..00000000
--- a/apps/papra-server/src/modules/shared/random.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-import { createId } from '@paralleldrive/cuid2';
-
-export { generateId };
-
-function generateId({ prefix }: { prefix?: string } = {}) {
- const id = createId();
-
- return prefix ? `${prefix}_${id}` : id;
-}
diff --git a/apps/papra-server/src/modules/shared/random/ids.test.ts b/apps/papra-server/src/modules/shared/random/ids.test.ts
new file mode 100644
index 00000000..45d3dbc3
--- /dev/null
+++ b/apps/papra-server/src/modules/shared/random/ids.test.ts
@@ -0,0 +1,12 @@
+import { describe, expect, test } from 'vitest';
+import { createPrefixedIdRegex } from './ids';
+
+describe('database models', () => {
+ describe('createPrefixedIdRegex', () => {
+ test('build a regex for prefixed id validation', () => {
+ const regex = createPrefixedIdRegex({ prefix: 'tag' });
+
+ expect(regex.toString()).to.eql('/^tag_[a-z0-9]{24}$/');
+ });
+ });
+});
diff --git a/apps/papra-server/src/modules/shared/random/ids.ts b/apps/papra-server/src/modules/shared/random/ids.ts
new file mode 100644
index 00000000..ccd0ee0e
--- /dev/null
+++ b/apps/papra-server/src/modules/shared/random/ids.ts
@@ -0,0 +1,14 @@
+import { init } from '@paralleldrive/cuid2';
+import { ID_RANDOM_PART_LENGTH } from '../../app/database/database.constants';
+
+const createId = init({ length: ID_RANDOM_PART_LENGTH });
+
+export function generateId({ prefix, getRandomPart = createId }: { prefix?: string; getRandomPart?: () => string } = {}) {
+ const id = getRandomPart();
+
+ return prefix ? `${prefix}_${id}` : id;
+}
+
+export function createPrefixedIdRegex({ prefix }: { prefix: string }) {
+ return new RegExp(`^${prefix}_[a-z0-9]{${ID_RANDOM_PART_LENGTH}}$`);
+}
diff --git a/apps/papra-server/src/modules/subscriptions/subscriptions.routes.ts b/apps/papra-server/src/modules/subscriptions/subscriptions.routes.ts
index 328009b2..2bf2d5ff 100644
--- a/apps/papra-server/src/modules/subscriptions/subscriptions.routes.ts
+++ b/apps/papra-server/src/modules/subscriptions/subscriptions.routes.ts
@@ -2,7 +2,7 @@ import type { RouteDefinitionContext } from '../app/server.types';
import { get, pick } from 'lodash-es';
import { z } from 'zod';
import { getUser } from '../app/auth/auth.models';
-import { organizationIdRegex } from '../organizations/organizations.constants';
+import { organizationIdSchema } from '../organizations/organization.schemas';
import { createOrganizationNotFoundError } from '../organizations/organizations.errors';
import { createOrganizationsRepository } from '../organizations/organizations.repository';
import { ensureUserIsInOrganization, ensureUserIsOwnerOfOrganization, getOrCreateOrganizationCustomerId } from '../organizations/organizations.usecases';
@@ -68,7 +68,7 @@ async function setupCreateCheckoutSessionRoute({ app, config, db, subscriptionsS
planId: z.enum([PLUS_PLAN_ID]),
})),
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -129,7 +129,7 @@ function setupGetCustomerPortalRoute({ app, db, subscriptionsServices }: RouteDe
app.get(
'/api/organizations/:organizationId/customer-portal',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -156,7 +156,7 @@ function getOrganizationSubscriptionRoute({ app, db }: RouteDefinitionContext) {
app.get(
'/api/organizations/:organizationId/subscription',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
diff --git a/apps/papra-server/src/modules/tagging-rules/tagging-rules.constants.ts b/apps/papra-server/src/modules/tagging-rules/tagging-rules.constants.ts
index f31abf23..ca8f6aa1 100644
--- a/apps/papra-server/src/modules/tagging-rules/tagging-rules.constants.ts
+++ b/apps/papra-server/src/modules/tagging-rules/tagging-rules.constants.ts
@@ -1,7 +1,8 @@
import type { DbSelectableDocument } from '../documents/documents.types';
+import { createPrefixedIdRegex } from '../shared/random/ids';
-export const taggingRuleIdPrefix = 'tr';
-export const taggingRuleIdRegex = new RegExp(`^${taggingRuleIdPrefix}_[a-z0-9]{24}$`);
+export const TAGGING_RULE_ID_PREFIX = 'tr';
+export const TAGGING_RULE_ID_REGEX = createPrefixedIdRegex({ prefix: TAGGING_RULE_ID_PREFIX });
export const TAGGING_RULE_OPERATORS = {
EQUAL: 'equal',
diff --git a/apps/papra-server/src/modules/tagging-rules/tagging-rules.routes.ts b/apps/papra-server/src/modules/tagging-rules/tagging-rules.routes.ts
index 108b74d7..f7e3f4d2 100644
--- a/apps/papra-server/src/modules/tagging-rules/tagging-rules.routes.ts
+++ b/apps/papra-server/src/modules/tagging-rules/tagging-rules.routes.ts
@@ -2,13 +2,14 @@ import type { RouteDefinitionContext } from '../app/server.types';
import type { TaggingRuleField, TaggingRuleOperator } from './tagging-rules.types';
import { z } from 'zod';
import { getUser } from '../app/auth/auth.models';
-import { organizationIdRegex } from '../organizations/organizations.constants';
+import { organizationIdSchema } from '../organizations/organization.schemas';
import { createOrganizationsRepository } from '../organizations/organizations.repository';
import { ensureUserIsInOrganization } from '../organizations/organizations.usecases';
import { validateJsonBody, validateParams } from '../shared/validation/validation';
import { tagIdRegex } from '../tags/tags.constants';
-import { TAGGING_RULE_FIELDS, TAGGING_RULE_OPERATORS, taggingRuleIdRegex } from './tagging-rules.constants';
+import { TAGGING_RULE_FIELDS, TAGGING_RULE_OPERATORS } from './tagging-rules.constants';
import { createTaggingRulesRepository } from './tagging-rules.repository';
+import { taggingRuleIdSchema } from './tagging-rules.schemas';
import { createTaggingRule } from './tagging-rules.usecases';
export function registerTaggingRulesRoutes(context: RouteDefinitionContext) {
@@ -23,7 +24,7 @@ function setupGetOrganizationTaggingRulesRoute({ app, db }: RouteDefinitionConte
app.get(
'/api/organizations/:organizationId/tagging-rules',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -48,7 +49,7 @@ function setupCreateTaggingRuleRoute({ app, db }: RouteDefinitionContext) {
app.post(
'/api/organizations/:organizationId/tagging-rules',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
validateJsonBody(z.object({
name: z.string().min(1).max(64),
@@ -83,8 +84,8 @@ function setupDeleteTaggingRuleRoute({ app, db }: RouteDefinitionContext) {
app.delete(
'/api/organizations/:organizationId/tagging-rules/:taggingRuleId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- taggingRuleId: z.string().regex(taggingRuleIdRegex),
+ organizationId: organizationIdSchema,
+ taggingRuleId: taggingRuleIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -107,8 +108,8 @@ function setupGetTaggingRuleRoute({ app, db }: RouteDefinitionContext) {
app.get(
'/api/organizations/:organizationId/tagging-rules/:taggingRuleId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- taggingRuleId: z.string().regex(taggingRuleIdRegex),
+ organizationId: organizationIdSchema,
+ taggingRuleId: taggingRuleIdSchema,
})),
async (context) => {
const { userId } = getUser({ context });
@@ -133,8 +134,8 @@ function setupUpdateTaggingRuleRoute({ app, db }: RouteDefinitionContext) {
app.put(
'/api/organizations/:organizationId/tagging-rules/:taggingRuleId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- taggingRuleId: z.string().regex(taggingRuleIdRegex),
+ organizationId: organizationIdSchema,
+ taggingRuleId: taggingRuleIdSchema,
})),
validateJsonBody(z.object({
name: z.string().min(1).max(64),
diff --git a/apps/papra-server/src/modules/tagging-rules/tagging-rules.schemas.ts b/apps/papra-server/src/modules/tagging-rules/tagging-rules.schemas.ts
new file mode 100644
index 00000000..5a2fc970
--- /dev/null
+++ b/apps/papra-server/src/modules/tagging-rules/tagging-rules.schemas.ts
@@ -0,0 +1,4 @@
+import { z } from 'zod';
+import { TAGGING_RULE_ID_REGEX } from './tagging-rules.constants';
+
+export const taggingRuleIdSchema = z.string().regex(TAGGING_RULE_ID_REGEX);
diff --git a/apps/papra-server/src/modules/tagging-rules/tagging-rules.tables.ts b/apps/papra-server/src/modules/tagging-rules/tagging-rules.tables.ts
index 762ca0be..9b3a967c 100644
--- a/apps/papra-server/src/modules/tagging-rules/tagging-rules.tables.ts
+++ b/apps/papra-server/src/modules/tagging-rules/tagging-rules.tables.ts
@@ -3,12 +3,12 @@ import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { organizationsTable } from '../organizations/organizations.table';
import { createPrimaryKeyField, createTimestampColumns } from '../shared/db/columns.helpers';
import { tagsTable } from '../tags/tags.table';
-import { taggingRuleIdPrefix } from './tagging-rules.constants';
+import { TAGGING_RULE_ID_PREFIX } from './tagging-rules.constants';
export const taggingRulesTable = sqliteTable(
'tagging_rules',
{
- ...createPrimaryKeyField({ prefix: taggingRuleIdPrefix }),
+ ...createPrimaryKeyField({ prefix: TAGGING_RULE_ID_PREFIX }),
...createTimestampColumns(),
organizationId: text('organization_id').notNull().references(() => organizationsTable.id, { onDelete: 'cascade', onUpdate: 'cascade' }),
diff --git a/apps/papra-server/src/modules/tags/tags.constants.ts b/apps/papra-server/src/modules/tags/tags.constants.ts
index 199a1222..dd70ca02 100644
--- a/apps/papra-server/src/modules/tags/tags.constants.ts
+++ b/apps/papra-server/src/modules/tags/tags.constants.ts
@@ -1,4 +1,6 @@
+import { createPrefixedIdRegex } from '../shared/random/ids';
+
export const TagColorRegex = /^#[0-9a-f]{6}$/;
export const tagIdPrefix = 'tag';
-export const tagIdRegex = new RegExp(`^${tagIdPrefix}_[a-z0-9]{24}$`);
+export const tagIdRegex = createPrefixedIdRegex({ prefix: tagIdPrefix });
diff --git a/apps/papra-server/src/modules/tags/tags.routes.ts b/apps/papra-server/src/modules/tags/tags.routes.ts
index 3ee2f3a8..71234736 100644
--- a/apps/papra-server/src/modules/tags/tags.routes.ts
+++ b/apps/papra-server/src/modules/tags/tags.routes.ts
@@ -1,12 +1,14 @@
import type { RouteDefinitionContext } from '../app/server.types';
import { z } from 'zod';
import { getUser } from '../app/auth/auth.models';
-import { organizationIdRegex } from '../organizations/organizations.constants';
+import { documentIdSchema } from '../documents/documents.schemas';
+import { organizationIdSchema } from '../organizations/organization.schemas';
import { createOrganizationsRepository } from '../organizations/organizations.repository';
import { ensureUserIsInOrganization } from '../organizations/organizations.usecases';
import { validateJsonBody, validateParams } from '../shared/validation/validation';
import { TagColorRegex } from './tags.constants';
import { createTagsRepository } from './tags.repository';
+import { tagIdSchema } from './tags.schemas';
export function registerTagsRoutes(context: RouteDefinitionContext) {
setupCreateNewTagRoute(context);
@@ -22,7 +24,7 @@ function setupCreateNewTagRoute({ app, db }: RouteDefinitionContext) {
'/api/organizations/:organizationId/tags',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
validateJsonBody(z.object({
@@ -56,7 +58,7 @@ function setupGetOrganizationTagsRoute({ app, db }: RouteDefinitionContext) {
'/api/organizations/:organizationId/tags',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
+ organizationId: organizationIdSchema,
})),
async (context) => {
@@ -78,8 +80,8 @@ function setupUpdateTagRoute({ app, db }: RouteDefinitionContext) {
'/api/organizations/:organizationId/tags/:tagId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- tagId: z.string(),
+ organizationId: organizationIdSchema,
+ tagId: tagIdSchema,
})),
validateJsonBody(z.object({
@@ -113,8 +115,8 @@ function setupDeleteTagRoute({ app, db }: RouteDefinitionContext) {
'/api/organizations/:organizationId/tags/:tagId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- tagId: z.string(),
+ organizationId: organizationIdSchema,
+ tagId: tagIdSchema,
})),
async (context) => {
@@ -139,12 +141,12 @@ function setupAddTagToDocumentRoute({ app, db }: RouteDefinitionContext) {
'/api/organizations/:organizationId/documents/:documentId/tags',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- documentId: z.string(),
+ organizationId: organizationIdSchema,
+ documentId: documentIdSchema,
})),
validateJsonBody(z.object({
- tagId: z.string(),
+ tagId: tagIdSchema,
})),
async (context) => {
@@ -170,9 +172,9 @@ function setupRemoveTagFromDocumentRoute({ app, db }: RouteDefinitionContext) {
'/api/organizations/:organizationId/documents/:documentId/tags/:tagId',
validateParams(z.object({
- organizationId: z.string().regex(organizationIdRegex),
- documentId: z.string(),
- tagId: z.string(),
+ organizationId: organizationIdSchema,
+ documentId: documentIdSchema,
+ tagId: tagIdSchema,
})),
async (context) => {
diff --git a/apps/papra-server/src/modules/tags/tags.schemas.ts b/apps/papra-server/src/modules/tags/tags.schemas.ts
new file mode 100644
index 00000000..1b98b3da
--- /dev/null
+++ b/apps/papra-server/src/modules/tags/tags.schemas.ts
@@ -0,0 +1,4 @@
+import { z } from 'zod';
+import { tagIdRegex } from './tags.constants';
+
+export const tagIdSchema = z.string().regex(tagIdRegex);
diff --git a/apps/papra-server/src/modules/tasks/task-scheduler.ts b/apps/papra-server/src/modules/tasks/task-scheduler.ts
index 3bb85b64..e0f22de7 100644
--- a/apps/papra-server/src/modules/tasks/task-scheduler.ts
+++ b/apps/papra-server/src/modules/tasks/task-scheduler.ts
@@ -3,7 +3,7 @@ import type { Config } from '../config/config.types';
import type { TaskDefinition } from './tasks.models';
import cron from 'node-cron';
import { createLogger, wrapWithLoggerContext } from '../shared/logger/logger';
-import { generateId } from '../shared/random';
+import { generateId } from '../shared/random/ids';
export { createTaskScheduler };