Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(intake-emails): add intake email username pattern config (#506)

Corentin Thomasset6bcb2a71e990
diff --git a/.changeset/forty-ducks-switch.md b/.changeset/forty-ducks-switch.md
new file mode 100644
index 00000000..e7003d6f
--- /dev/null
+++ b/.changeset/forty-ducks-switch.md
@@ -0,0 +1,6 @@
+---
+"@papra/app-client": patch
+"@papra/app-server": patch
+---
+
+Added the possibility to define patterns for email intake username generation
diff --git a/apps/papra-client/src/locales/de.dictionary.ts b/apps/papra-client/src/locales/de.dictionary.ts
index 4d22e58f..056caced 100644
--- a/apps/papra-client/src/locales/de.dictionary.ts
+++ b/apps/papra-client/src/locales/de.dictionary.ts
@@ -541,7 +541,8 @@ export const translations: Partial<TranslationsDictionary> = {
'api-errors.document.already_exists': 'Das Dokument existiert bereits',
'api-errors.document.size_too_large': 'Die Datei ist zu groß',
- 'api-errors.intake_email.limit_reached': 'Die maximale Anzahl an Eingangse-Mails für diese Organisation wurde erreicht. Bitte aktualisieren Sie Ihren Plan, um weitere Eingangse-Mails zu erstellen.',
+ 'api-errors.intake-emails.already_exists': 'Eine Eingang-Email mit dieser Adresse existiert bereits.',
+ 'api-errors.intake_email.limit_reached': 'Die maximale Anzahl an Eingang-EMails für diese Organisation wurde erreicht. Bitte aktualisieren Sie Ihren Plan, um weitere Eingangse-Mails zu erstellen.',
'api-errors.user.max_organization_count_reached': 'Sie haben die maximale Anzahl an Organisationen erreicht, die Sie erstellen können. Wenn Sie weitere erstellen möchten, kontaktieren Sie bitte den Support.',
'api-errors.default': 'Beim Verarbeiten Ihrer Anfrage ist ein Fehler aufgetreten.',
'api-errors.organization.invitation_already_exists': 'Eine Einladung für diese E-Mail existiert bereits in dieser Organisation.',
diff --git a/apps/papra-client/src/locales/en.dictionary.ts b/apps/papra-client/src/locales/en.dictionary.ts
index 7523db34..a00210b8 100644
--- a/apps/papra-client/src/locales/en.dictionary.ts
+++ b/apps/papra-client/src/locales/en.dictionary.ts
@@ -539,6 +539,7 @@ export const translations = {
'api-errors.document.already_exists': 'The document already exists',
'api-errors.document.size_too_large': 'The file size is too large',
+ 'api-errors.intake-emails.already_exists': 'An intake email with this address already exists.',
'api-errors.intake_email.limit_reached': 'The maximum number of intake emails for this organization has been reached. Please upgrade your plan to create more intake emails.',
'api-errors.user.max_organization_count_reached': 'You have reached the maximum number of organizations you can create, if you need to create more, please contact support.',
'api-errors.default': 'An error occurred while processing your request.',
diff --git a/apps/papra-client/src/locales/es.dictionary.ts b/apps/papra-client/src/locales/es.dictionary.ts
index 3a356b39..a91617a4 100644
--- a/apps/papra-client/src/locales/es.dictionary.ts
+++ b/apps/papra-client/src/locales/es.dictionary.ts
@@ -541,6 +541,7 @@ export const translations: Partial<TranslationsDictionary> = {
'api-errors.document.already_exists': 'El documento ya existe',
'api-errors.document.size_too_large': 'El archivo es demasiado grande',
+ 'api-errors.intake-emails.already_exists': 'Ya existe un correo de ingreso con esta dirección.',
'api-errors.intake_email.limit_reached': 'Se ha alcanzado el número máximo de correos de ingreso para esta organización. Por favor, mejora tu plan para crear más correos de ingreso.',
'api-errors.user.max_organization_count_reached': 'Has alcanzado el número máximo de organizaciones que puedes crear, si necesitas crear más, contacta al soporte.',
'api-errors.default': 'Ocurrió un error al procesar tu solicitud.',
diff --git a/apps/papra-client/src/locales/fr.dictionary.ts b/apps/papra-client/src/locales/fr.dictionary.ts
index eedb8dcf..3cfd78f0 100644
--- a/apps/papra-client/src/locales/fr.dictionary.ts
+++ b/apps/papra-client/src/locales/fr.dictionary.ts
@@ -541,6 +541,7 @@ export const translations: Partial<TranslationsDictionary> = {
'api-errors.document.already_exists': 'Le document existe déjà',
'api-errors.document.size_too_large': 'Le fichier est trop volumineux',
+ 'api-errors.intake-emails.already_exists': 'Un email de réception avec cette adresse existe déjà.',
'api-errors.intake_email.limit_reached': 'Le nombre maximum d\'emails de réception pour cette organisation a été atteint. Veuillez mettre à niveau votre plan pour créer plus d\'emails de réception.',
'api-errors.user.max_organization_count_reached': 'Vous avez atteint le nombre maximum d\'organisations que vous pouvez créer, si vous avez besoin de créer plus, veuillez contacter le support.',
'api-errors.default': 'Une erreur est survenue lors du traitement de votre requête.',
diff --git a/apps/papra-client/src/locales/it.dictionary.ts b/apps/papra-client/src/locales/it.dictionary.ts
index 85291993..1a13c51e 100644
--- a/apps/papra-client/src/locales/it.dictionary.ts
+++ b/apps/papra-client/src/locales/it.dictionary.ts
@@ -541,6 +541,7 @@ export const translations: Partial<TranslationsDictionary> = {
'api-errors.document.already_exists': 'Il documento esiste già',
'api-errors.document.size_too_large': 'Il file è troppo grande',
+ 'api-errors.intake-emails.already_exists': 'Un\'email di acquisizione con questo indirizzo esiste già.',
'api-errors.intake_email.limit_reached': 'È stato raggiunto il numero massimo di email di acquisizione per questa organizzazione. Aggiorna il tuo piano per crearne altre.',
'api-errors.user.max_organization_count_reached': 'Hai raggiunto il numero massimo di organizzazioni che puoi creare, se hai bisogno di crearne altre contatta il supporto.',
'api-errors.default': 'Si è verificato un errore durante l\'elaborazione della richiesta.',
diff --git a/apps/papra-client/src/locales/pl.dictionary.ts b/apps/papra-client/src/locales/pl.dictionary.ts
index 63badcc5..f3dde67c 100644
--- a/apps/papra-client/src/locales/pl.dictionary.ts
+++ b/apps/papra-client/src/locales/pl.dictionary.ts
@@ -541,6 +541,7 @@ export const translations: Partial<TranslationsDictionary> = {
'api-errors.document.already_exists': 'Dokument już istnieje',
'api-errors.document.size_too_large': 'Plik jest zbyt duży',
+ 'api-errors.intake-emails.already_exists': 'Adres e-mail do przyjęć z tym adresem już istnieje.',
'api-errors.intake_email.limit_reached': 'Osiągnięto maksymalną liczbę adresów e-mail do przyjęć dla tej organizacji. Aby utworzyć więcej adresów e-mail do przyjęć, zaktualizuj swój plan.',
'api-errors.user.max_organization_count_reached': 'Osiągnięto maksymalną liczbę organizacji, które możesz utworzyć. Jeśli potrzebujesz utworzyć więcej, skontaktuj się z pomocą techniczną.',
'api-errors.default': 'Wystąpił błąd podczas przetwarzania żądania.',
diff --git a/apps/papra-client/src/locales/pt-BR.dictionary.ts b/apps/papra-client/src/locales/pt-BR.dictionary.ts
index debeae99..9fb7dc59 100644
--- a/apps/papra-client/src/locales/pt-BR.dictionary.ts
+++ b/apps/papra-client/src/locales/pt-BR.dictionary.ts
@@ -541,6 +541,7 @@ export const translations: Partial<TranslationsDictionary> = {
'api-errors.document.already_exists': 'O documento já existe',
'api-errors.document.size_too_large': 'O arquivo é muito grande',
+ 'api-errors.intake-emails.already_exists': 'Um e-mail de entrada com este endereço já existe.',
'api-errors.intake_email.limit_reached': 'O número máximo de e-mails de entrada para esta organização foi atingido. Faça um upgrade no seu plano para criar mais e-mails de entrada.',
'api-errors.user.max_organization_count_reached': 'Você atingiu o número máximo de organizações que pode criar. Se precisar criar mais, entre em contato com o suporte.',
'api-errors.default': 'Ocorreu um erro ao processar sua solicitação.',
diff --git a/apps/papra-client/src/locales/pt.dictionary.ts b/apps/papra-client/src/locales/pt.dictionary.ts
index 8516be9c..b504b6b0 100644
--- a/apps/papra-client/src/locales/pt.dictionary.ts
+++ b/apps/papra-client/src/locales/pt.dictionary.ts
@@ -541,6 +541,7 @@ export const translations: Partial<TranslationsDictionary> = {
'api-errors.document.already_exists': 'O documento já existe',
'api-errors.document.size_too_large': 'O arquivo é muito grande',
+ 'api-errors.intake-emails.already_exists': 'Um e-mail de entrada com este endereço já existe.',
'api-errors.intake_email.limit_reached': 'O número máximo de e-mails de entrada para esta organização foi atingido. Faça um upgrade no seu plano para criar mais e-mails de entrada.',
'api-errors.user.max_organization_count_reached': 'Atingiu o número máximo de organizações que pode criar. Se precisar de criar mais, entre em contato com o suporte.',
'api-errors.default': 'Ocorreu um erro ao processar a solicitação.',
diff --git a/apps/papra-client/src/locales/ro.dictionary.ts b/apps/papra-client/src/locales/ro.dictionary.ts
index 8f0037f3..d7e3add1 100644
--- a/apps/papra-client/src/locales/ro.dictionary.ts
+++ b/apps/papra-client/src/locales/ro.dictionary.ts
@@ -541,6 +541,7 @@ export const translations: Partial<TranslationsDictionary> = {
'api-errors.document.already_exists': 'Documentul există deja',
'api-errors.document.size_too_large': 'Fișierul este prea mare',
+ 'api-errors.intake-emails.already_exists': 'Un email de primire cu această adresă există deja.',
'api-errors.intake_email.limit_reached': 'Numărul maxim de email-uri de primire pentru această organizație a fost atins. Te rugăm să-ți îmbunătățești planul pentru a crea mai multe email-uri de primire.',
'api-errors.user.max_organization_count_reached': 'Ai atins numărul maxim de organizații pe care le poți crea. Dacă ai nevoie să creezi mai multe, te rugăm să contactezi asistența.',
'api-errors.default': 'A apărut o eroare la procesarea cererii.',
diff --git a/apps/papra-client/src/modules/intake-emails/pages/intake-emails.page.tsx b/apps/papra-client/src/modules/intake-emails/pages/intake-emails.page.tsx
index 8534a106..e321c050 100644
--- a/apps/papra-client/src/modules/intake-emails/pages/intake-emails.page.tsx
+++ b/apps/papra-client/src/modules/intake-emails/pages/intake-emails.page.tsx
@@ -10,7 +10,7 @@ import { useConfig } from '@/modules/config/config.provider';
import { useI18n } from '@/modules/i18n/i18n.provider';
import { useConfirmModal } from '@/modules/shared/confirm';
import { createForm } from '@/modules/shared/form/form';
-import { isHttpErrorWithCode } from '@/modules/shared/http/http-errors';
+import { useI18nApiErrors } from '@/modules/shared/http/composables/i18n-api-errors';
import { queryClient } from '@/modules/shared/query/query-client';
import { cn } from '@/modules/shared/style/cn';
import { Alert, AlertDescription } from '@/modules/ui/components/alert';
@@ -187,6 +187,7 @@ export const IntakeEmailsPage: Component = () => {
const params = useParams();
const { confirm } = useConfirmModal();
+ const { getErrorMessage } = useI18nApiErrors({ t });
const query = useQuery(() => ({
queryKey: ['organizations', params.organizationId, 'intake-emails'],
@@ -196,16 +197,12 @@ export const IntakeEmailsPage: Component = () => {
const createEmail = async () => {
const [,error] = await safely(createIntakeEmail({ organizationId: params.organizationId }));
- if (isHttpErrorWithCode({ error, code: 'intake_email.limit_reached' })) {
+ if (error) {
createToast({
- message: t('api-errors.intake_email.limit_reached'),
+ message: getErrorMessage({ error }),
type: 'error',
});
- return;
- }
-
- if (error) {
throw error;
}
diff --git a/apps/papra-client/src/modules/shared/http/composables/i18n-api-errors.ts b/apps/papra-client/src/modules/shared/http/composables/i18n-api-errors.ts
index a462b335..87854575 100644
--- a/apps/papra-client/src/modules/shared/http/composables/i18n-api-errors.ts
+++ b/apps/papra-client/src/modules/shared/http/composables/i18n-api-errors.ts
@@ -1,5 +1,6 @@
import type { TranslationKeys } from '@/modules/i18n/locales.types';
import { get } from 'lodash-es';
+import { FetchError } from 'ofetch';
import { useI18n } from '@/modules/i18n/i18n.provider';
function codeToKey(code: string): TranslationKeys {
@@ -30,6 +31,11 @@ export function useI18nApiErrors({ t = useI18n().t }: { t?: ReturnType<typeof us
return translation;
}
+ // Fetch error message is not helpful
+ if (error instanceof FetchError) {
+ return getDefaultErrorMessage();
+ }
+
if (typeof error === 'object' && error && 'message' in error && typeof error.message === 'string') {
return error.message;
}
diff --git a/apps/papra-server/package.json b/apps/papra-server/package.json
index cc75413e..fbf33387 100644
--- a/apps/papra-server/package.json
+++ b/apps/papra-server/package.json
@@ -55,6 +55,7 @@
"@papra/lecture": "workspace:*",
"@papra/webhooks": "workspace:*",
"@paralleldrive/cuid2": "^2.2.2",
+ "@sindresorhus/slugify": "^3.0.0",
"better-auth": "catalog:",
"busboy": "^1.6.0",
"c12": "^3.0.4",
diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.errors.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.errors.ts
index 198d9a99..564fc839 100644
--- a/apps/papra-server/src/modules/intake-emails/intake-emails.errors.ts
+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.errors.ts
@@ -11,3 +11,9 @@ export const createIntakeEmailNotFoundError = createErrorFactory({
code: 'intake_email.not_found',
statusCode: 404,
});
+
+export const createIntakeEmailAlreadyExistsError = createErrorFactory({
+ message: 'Intake email already exists',
+ code: 'intake_email.already_exists',
+ statusCode: 400,
+});
diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.repository.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.repository.ts
index c78643bb..d7aad070 100644
--- a/apps/papra-server/src/modules/intake-emails/intake-emails.repository.ts
+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.repository.ts
@@ -1,9 +1,10 @@
import type { Database } from '../app/database/database.types';
-import { injectArguments } from '@corentinth/chisels';
+import { injectArguments, safely } from '@corentinth/chisels';
import { and, count, eq } from 'drizzle-orm';
+import { isUniqueConstraintError } from '../shared/db/constraints.models';
import { createError } from '../shared/errors/errors';
import { omitUndefined } from '../shared/utils';
-import { createIntakeEmailNotFoundError } from './intake-emails.errors';
+import { createIntakeEmailAlreadyExistsError, createIntakeEmailNotFoundError } from './intake-emails.errors';
import { intakeEmailsTable } from './intake-emails.tables';
export type IntakeEmailsRepository = ReturnType<typeof createIntakeEmailsRepository>;
@@ -24,7 +25,17 @@ export function createIntakeEmailsRepository({ db }: { db: Database }) {
}
async function createIntakeEmail({ organizationId, emailAddress, db }: { organizationId: string; emailAddress: string; db: Database }) {
- const [intakeEmail] = await db.insert(intakeEmailsTable).values({ organizationId, emailAddress }).returning();
+ const [result, error] = await safely(db.insert(intakeEmailsTable).values({ organizationId, emailAddress }).returning());
+
+ if (isUniqueConstraintError({ error })) {
+ throw createIntakeEmailAlreadyExistsError();
+ }
+
+ if (error) {
+ throw error;
+ }
+
+ const [intakeEmail] = result;
if (!intakeEmail) {
// Very unlikely to happen as the insertion should throw an issue, it's for type safety
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 6bac4c3d..2f34e8a3 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
@@ -15,12 +15,13 @@ import { createLogger } from '../shared/logger/logger';
import { isNil } from '../shared/utils';
import { validateFormData, validateJsonBody, validateParams } from '../shared/validation/validation';
import { createSubscriptionsRepository } from '../subscriptions/subscriptions.repository';
+import { createUsersRepository } from '../users/users.repository';
import { INTAKE_EMAILS_INGEST_ROUTE } from './intake-emails.constants';
import { createIntakeEmailsRepository } from './intake-emails.repository';
import { allowedOriginsSchema, intakeEmailIdSchema, intakeEmailsIngestionMetaSchema, parseJson } from './intake-emails.schemas';
import { createIntakeEmailsServices } from './intake-emails.services';
import { createIntakeEmail, deleteIntakeEmail, processIntakeEmailIngestion } from './intake-emails.usecases';
-import { createIntakeEmailAddressesServices } from './username-drivers/intake-email-username.services';
+import { createIntakeEmailUsernameServices } from './username-drivers/intake-email-username.services';
const logger = createLogger({ namespace: 'intake-emails.routes' });
@@ -66,22 +67,24 @@ function setupCreateIntakeEmailRoute({ app, db, config }: RouteDefinitionContext
const { userId } = getUser({ context });
const { organizationId } = context.req.valid('param');
+ const usersRepository = createUsersRepository({ db });
const organizationsRepository = createOrganizationsRepository({ db });
const intakeEmailsRepository = createIntakeEmailsRepository({ db });
const intakeEmailsServices = createIntakeEmailsServices({ config });
const plansRepository = createPlansRepository({ config });
const subscriptionsRepository = createSubscriptionsRepository({ db });
- const intakeEmailAddressesServices = createIntakeEmailAddressesServices({ config });
+ const intakeEmailUsernameServices = createIntakeEmailUsernameServices({ config, usersRepository, organizationsRepository });
await ensureUserIsInOrganization({ userId, organizationId, organizationsRepository });
const { intakeEmail } = await createIntakeEmail({
+ userId,
organizationId,
intakeEmailsRepository,
intakeEmailsServices,
plansRepository,
subscriptionsRepository,
- intakeEmailAddressesServices,
+ intakeEmailUsernameServices,
});
return context.json({ intakeEmail });
diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.ts
index 360d2989..c10a5e1e 100644
--- a/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.ts
+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.usecases.ts
@@ -4,7 +4,7 @@ import type { Logger } from '../shared/logger/logger';
import type { SubscriptionsRepository } from '../subscriptions/subscriptions.repository';
import type { IntakeEmailsServices } from './drivers/intake-emails.drivers.models';
import type { IntakeEmailsRepository } from './intake-emails.repository';
-import type { IntakeEmailAddressesServices } from './username-drivers/intake-email-username.services';
+import type { IntakeEmailUsernameServices } from './username-drivers/intake-email-username.services';
import { safely } from '@corentinth/chisels';
import { getOrganizationPlan } from '../plans/plans.usecases';
import { addLogContext, createLogger } from '../shared/logger/logger';
@@ -13,19 +13,21 @@ import { createIntakeEmailLimitReachedError, createIntakeEmailNotFoundError } fr
import { getIsFromAllowedOrigin } from './intake-emails.models';
export async function createIntakeEmail({
+ userId,
organizationId,
intakeEmailsRepository,
intakeEmailsServices,
plansRepository,
subscriptionsRepository,
- intakeEmailAddressesServices,
+ intakeEmailUsernameServices,
}: {
+ userId: string;
organizationId: string;
intakeEmailsRepository: IntakeEmailsRepository;
intakeEmailsServices: IntakeEmailsServices;
plansRepository: PlansRepository;
subscriptionsRepository: SubscriptionsRepository;
- intakeEmailAddressesServices: IntakeEmailAddressesServices;
+ intakeEmailUsernameServices: IntakeEmailUsernameServices;
}) {
await checkIfOrganizationCanCreateNewIntakeEmail({
organizationId,
@@ -34,7 +36,7 @@ export async function createIntakeEmail({
intakeEmailsRepository,
});
- const { username } = await intakeEmailAddressesServices.generateIntakeEmailUsername();
+ const { username } = await intakeEmailUsernameServices.generateIntakeEmailUsername({ userId, organizationId });
const { emailAddress } = await intakeEmailsServices.createEmailAddress({ username });
diff --git a/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.config.ts b/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.config.ts
index f0d3d31e..86f786d0 100644
--- a/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.config.ts
+++ b/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.config.ts
@@ -1,13 +1,17 @@
import type { ConfigDefinition } from 'figue';
import { z } from 'zod';
-import { intakeEmailAddressesDrivers } from './intake-email-username.drivers';
+import { intakeEmailUsernameDrivers } from './intake-email-username.drivers';
+import { patternIntakeEmailDriverConfig } from './pattern/pattern.intake-email-username-driver.config';
import { RANDOM_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME } from './random/random.intake-email-username-driver';
export const intakeEmailUsernameConfig = {
driver: {
- doc: `The driver to use when generating email addresses for intake emails, value can be one of: ${Object.keys(intakeEmailAddressesDrivers).map(x => `\`${x}\``).join(', ')}`,
- schema: z.enum(Object.keys(intakeEmailAddressesDrivers) as [string, ...string[]]),
+ doc: `The driver to use when generating email addresses for intake emails, value can be one of: ${Object.keys(intakeEmailUsernameDrivers).map(x => `\`${x}\``).join(', ')}`,
+ schema: z.enum(Object.keys(intakeEmailUsernameDrivers) as [string, ...string[]]),
default: RANDOM_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME,
env: 'INTAKE_EMAILS_USERNAME_DRIVER',
},
+ drivers: {
+ pattern: patternIntakeEmailDriverConfig,
+ },
} as const satisfies ConfigDefinition;
diff --git a/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.drivers.ts b/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.drivers.ts
index 480cf9bd..06c3c5c8 100644
--- a/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.drivers.ts
+++ b/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.drivers.ts
@@ -1,7 +1,10 @@
-import { RANDOM_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME, randomIntakeEmailAddressesDriverFactory } from './random/random.intake-email-username-driver';
+import { patternIntakeEmailUsernameDriverFactory } from './pattern/pattern.intake-email-username-driver';
+import { PATTERN_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME } from './pattern/pattern.intake-email-username-driver.config';
+import { RANDOM_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME, randomIntakeEmailUsernameDriverFactory } from './random/random.intake-email-username-driver';
-export const intakeEmailAddressesDrivers = {
- [RANDOM_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME]: randomIntakeEmailAddressesDriverFactory,
+export const intakeEmailUsernameDrivers = {
+ [RANDOM_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME]: randomIntakeEmailUsernameDriverFactory,
+ [PATTERN_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME]: patternIntakeEmailUsernameDriverFactory,
} as const;
-export type IntakeEmailAddressesDriverName = keyof typeof intakeEmailAddressesDrivers;
+export type IntakeEmailUsernameDriverName = keyof typeof intakeEmailUsernameDrivers;
diff --git a/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.models.ts b/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.models.ts
index 4d0664d9..51748fc0 100644
--- a/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.models.ts
+++ b/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.models.ts
@@ -1,13 +1,20 @@
import type { Logger } from '@crowlog/logger';
import type { Config } from '../../config/config.types';
+import type { OrganizationsRepository } from '../../organizations/organizations.repository';
+import type { UsersRepository } from '../../users/users.repository';
-export type IntakeEmailAddressesDriver = {
+export type IntakeEmailUsernameDriver = {
name: string;
- generateIntakeEmailUsername: () => Promise<{ username: string }>;
+ generateIntakeEmailUsername: (args: { userId: string; organizationId: string }) => Promise<{ username: string }>;
};
-export type IntakeEmailAddressesDriverFactory = (args: { config: Config; logger?: Logger }) => IntakeEmailAddressesDriver;
+export type IntakeEmailUsernameDriverFactory = (args: {
+ config: Config;
+ logger?: Logger;
+ usersRepository: UsersRepository;
+ organizationsRepository: OrganizationsRepository;
+}) => IntakeEmailUsernameDriver;
-export function defineIntakeEmailAddressesDriverFactory(factory: IntakeEmailAddressesDriverFactory) {
+export function defineIntakeEmailUsernameDriverFactory(factory: IntakeEmailUsernameDriverFactory) {
return factory;
}
diff --git a/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.services.ts b/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.services.ts
index f76ff14d..88439ef5 100644
--- a/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.services.ts
+++ b/apps/papra-server/src/modules/intake-emails/username-drivers/intake-email-username.services.ts
@@ -1,17 +1,26 @@
import type { Config } from '../../config/config.types';
-import type { IntakeEmailAddressesDriverName } from './intake-email-username.drivers';
-import type { IntakeEmailAddressesDriver, IntakeEmailAddressesDriverFactory } from './intake-email-username.models';
+import type { OrganizationsRepository } from '../../organizations/organizations.repository';
+import type { UsersRepository } from '../../users/users.repository';
+import type { IntakeEmailUsernameDriverName } from './intake-email-username.drivers';
+import type { IntakeEmailUsernameDriver, IntakeEmailUsernameDriverFactory } from './intake-email-username.models';
import { createError } from '../../shared/errors/errors';
import { isNil } from '../../shared/utils';
-import { intakeEmailAddressesDrivers } from './intake-email-username.drivers';
+import { intakeEmailUsernameDrivers } from './intake-email-username.drivers';
-export type IntakeEmailAddressesServices = IntakeEmailAddressesDriver;
+export type IntakeEmailUsernameServices = IntakeEmailUsernameDriver;
-export function createIntakeEmailAddressesServices({ config }: { config: Config }) {
+export function createIntakeEmailUsernameServices({
+ config,
+ ...dependencies
+}: {
+ config: Config;
+ usersRepository: UsersRepository;
+ organizationsRepository: OrganizationsRepository;
+}) {
const { driver } = config.intakeEmails.username;
- const intakeEmailAddressesDriver: IntakeEmailAddressesDriverFactory | undefined = intakeEmailAddressesDrivers[driver as IntakeEmailAddressesDriverName];
+ const intakeEmailUsernameDriver: IntakeEmailUsernameDriverFactory | undefined = intakeEmailUsernameDrivers[driver as IntakeEmailUsernameDriverName];
- if (isNil(intakeEmailAddressesDriver)) {
+ if (isNil(intakeEmailUsernameDriver)) {
throw createError({
message: `Invalid intake email addresses driver ${driver}`,
code: 'intake-emails.addresses.invalid_driver',
@@ -20,7 +29,7 @@ export function createIntakeEmailAddressesServices({ config }: { config: Config
});
}
- const intakeEmailAddressesServices = intakeEmailAddressesDriver({ config });
+ const intakeEmailUsernameServices = intakeEmailUsernameDriver({ config, ...dependencies });
- return intakeEmailAddressesServices;
+ return intakeEmailUsernameServices;
}
diff --git a/apps/papra-server/src/modules/intake-emails/username-drivers/pattern/pattern.intake-email-username-driver.config.ts b/apps/papra-server/src/modules/intake-emails/username-drivers/pattern/pattern.intake-email-username-driver.config.ts
new file mode 100644
index 00000000..6d419700
--- /dev/null
+++ b/apps/papra-server/src/modules/intake-emails/username-drivers/pattern/pattern.intake-email-username-driver.config.ts
@@ -0,0 +1,15 @@
+import type { ConfigDefinition } from 'figue';
+
+import { z } from 'zod';
+import { PATTERNS_PLACEHOLDERS } from './pattern.intake-email-username-driver.constants';
+
+export const PATTERN_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME = 'pattern';
+
+export const patternIntakeEmailDriverConfig = {
+ pattern: {
+ doc: `The pattern to use when generating email addresses usernames (before the @) for intake emails. Available placeholders are: ${Object.values(PATTERNS_PLACEHOLDERS).join(', ')}. Note: the resulting username will be slugified to remove special characters and spaces.`,
+ schema: z.string(),
+ default: `${PATTERNS_PLACEHOLDERS.USER_NAME}-${PATTERNS_PLACEHOLDERS.RANDOM_DIGITS}`,
+ env: 'INTAKE_EMAILS_USERNAME_DRIVER_PATTERN',
+ },
+} as const satisfies ConfigDefinition;
diff --git a/apps/papra-server/src/modules/intake-emails/username-drivers/pattern/pattern.intake-email-username-driver.constants.ts b/apps/papra-server/src/modules/intake-emails/username-drivers/pattern/pattern.intake-email-username-driver.constants.ts
new file mode 100644
index 00000000..f3c3717a
--- /dev/null
+++ b/apps/papra-server/src/modules/intake-emails/username-drivers/pattern/pattern.intake-email-username-driver.constants.ts
@@ -0,0 +1,8 @@
+export const PATTERNS_PLACEHOLDERS = {
+ USER_NAME: '{{user.name}}',
+ USER_ID: '{{user.id}}',
+ USER_EMAIL_USERNAME: '{{user.email.username}}',
+ ORGANIZATION_ID: '{{organization.id}}',
+ ORGANIZATION_NAME: '{{organization.name}}',
+ RANDOM_DIGITS: '{{random.digits}}',
+} as const;
diff --git a/apps/papra-server/src/modules/intake-emails/username-drivers/pattern/pattern.intake-email-username-driver.ts b/apps/papra-server/src/modules/intake-emails/username-drivers/pattern/pattern.intake-email-username-driver.ts
new file mode 100644
index 00000000..e618db39
--- /dev/null
+++ b/apps/papra-server/src/modules/intake-emails/username-drivers/pattern/pattern.intake-email-username-driver.ts
@@ -0,0 +1,52 @@
+import slugify from '@sindresorhus/slugify';
+import { createError } from '../../../shared/errors/errors';
+import { createLogger } from '../../../shared/logger/logger';
+import { isNil } from '../../../shared/utils';
+import { parseEmailAddress } from '../../intake-emails.models';
+import { defineIntakeEmailUsernameDriverFactory } from '../intake-email-username.models';
+import { PATTERN_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME } from './pattern.intake-email-username-driver.config';
+import { PATTERNS_PLACEHOLDERS } from './pattern.intake-email-username-driver.constants';
+
+export const patternIntakeEmailUsernameDriverFactory = defineIntakeEmailUsernameDriverFactory(({
+ logger = createLogger({ namespace: 'intake-emails.addresses-drivers.pattern' }),
+ config,
+ usersRepository,
+ organizationsRepository,
+}) => {
+ const { pattern } = config.intakeEmails.username.drivers.pattern;
+
+ return {
+ name: PATTERN_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME,
+ generateIntakeEmailUsername: async ({ userId, organizationId }) => {
+ const [{ user }, { organization }] = await Promise.all([
+ usersRepository.getUserById({ userId }),
+ organizationsRepository.getOrganizationById({ organizationId }),
+ ]);
+
+ if (isNil(user) || isNil(organization)) {
+ // Should not really happen, there is a check on the routes handlers
+ throw createError({
+ message: 'User or organization not found',
+ code: 'intake-emails.addresses.user_or_organization_not_found',
+ statusCode: 404,
+ });
+ }
+
+ const { username: userEmailUsername } = parseEmailAddress({ email: user.email });
+
+ const rawUsername = pattern
+ .replaceAll(PATTERNS_PLACEHOLDERS.USER_NAME, user.name ?? '')
+ .replaceAll(PATTERNS_PLACEHOLDERS.USER_ID, user.id)
+ .replaceAll(PATTERNS_PLACEHOLDERS.USER_EMAIL_USERNAME, userEmailUsername)
+ .replaceAll(PATTERNS_PLACEHOLDERS.ORGANIZATION_ID, organization.id)
+ .replaceAll(PATTERNS_PLACEHOLDERS.ORGANIZATION_NAME, organization.name)
+ .replaceAll(PATTERNS_PLACEHOLDERS.RANDOM_DIGITS, () => Math.floor(Math.random() * 10000).toString());
+
+ const username = slugify(rawUsername);
+
+ logger.debug({ rawUsername, username, pattern, userId, organizationId }, 'Generated email address');
+
+ return { username };
+ },
+ };
+});
diff --git a/apps/papra-server/src/modules/intake-emails/username-drivers/random/random.intake-email-username-driver.ts b/apps/papra-server/src/modules/intake-emails/username-drivers/random/random.intake-email-username-driver.ts
index 19ac4874..b2ed79c7 100644
--- a/apps/papra-server/src/modules/intake-emails/username-drivers/random/random.intake-email-username-driver.ts
+++ b/apps/papra-server/src/modules/intake-emails/username-drivers/random/random.intake-email-username-driver.ts
@@ -1,10 +1,10 @@
import { generateId as generateHumanReadableId } from '@corentinth/friendly-ids';
import { createLogger } from '../../../shared/logger/logger';
-import { defineIntakeEmailAddressesDriverFactory } from '../intake-email-username.models';
+import { defineIntakeEmailUsernameDriverFactory } from '../intake-email-username.models';
export const RANDOM_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME = 'random';
-export const randomIntakeEmailAddressesDriverFactory = defineIntakeEmailAddressesDriverFactory(({ logger = createLogger({ namespace: 'intake-emails.addresses-drivers.random' }) }) => {
+export const randomIntakeEmailUsernameDriverFactory = defineIntakeEmailUsernameDriverFactory(({ logger = createLogger({ namespace: 'intake-emails.addresses-drivers.random' }) }) => {
return {
name: RANDOM_INTAKE_EMAIL_ADDRESSES_DRIVER_NAME,
generateIntakeEmailUsername: async () => {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index acb26b1f..03b1b72b 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -292,6 +292,9 @@ importers:
'@paralleldrive/cuid2':
specifier: ^2.2.2
version: 2.2.2
+ '@sindresorhus/slugify':
+ specifier: ^3.0.0
+ version: 3.0.0
better-auth:
specifier: 'catalog:'
@@ -3080,6 +3083,14 @@ packages:
resolution: {integrity: sha512-1hsLpRHfSuMB9ee2aAdh0Htza/X3f4djhYISrggqGe3xopNjOcePiSDkDDoPzDYaaMCrbqGP1H2TYU7bgL9PmA==}
engines: {node: '>=20.0.0'}
+ '@sindresorhus/[email protected]':
+ resolution: {integrity: sha512-SCrKh1zS96q+CuH5GumHcyQEVPsM4Ve8oE0E6tw7AAhGq50K8ojbTUOQnX/j9Mhcv/AXiIsbCfquovyGOo5fGw==}
+ engines: {node: '>=20'}
+
+ '@sindresorhus/[email protected]':
+ resolution: {integrity: sha512-lRx63oCHxeJ90DqIgmbxH1PQmiBDY1wVaLzB4hK0d/xS5BrG1iZO3HdCJS/DQJk6GJ8xHDev8OMI7iGxvE1ZUA==}
+ engines: {node: '>=20'}
+
'@smithy/[email protected]':
resolution: {integrity: sha512-gJnEjZMvigPDQWHrW3oPrFhQtkrgqBkyjj3pCIdF3A5M6vsZODG93KNlfJprv6bp4245bdT32fsHK4kkH3KYDA==}
engines: {node: '>=18.0.0'}
@@ -11208,6 +11219,13 @@ snapshots:
'@peculiar/asn1-schema': 2.3.15
'@peculiar/asn1-x509': 2.3.15
+ '@sindresorhus/[email protected]':
+ dependencies:
+ '@sindresorhus/transliterate': 2.0.0
+ escape-string-regexp: 5.0.0
+
+ '@sindresorhus/[email protected]': {}
+
'@smithy/[email protected]':
dependencies:
'@smithy/types': 4.3.1