feat: add email domains (#1895)

Implemented Email Domains which allows Platform/Enterprise customers to
send emails to recipients using their custom emails.

packages/lib/server-only/template/create-document-from-direct-template.ts

@@ -3,7 +3,6 @@ import { createElement } from 'react';
 import { msg } from '@lingui/core/macro';
 import type { Field, Signature } from '@prisma/client';
 import {
-  DocumentSigningOrder,
   DocumentSource,
   DocumentStatus,
   FieldType,
@@ -25,8 +24,6 @@ import type { TSignFieldWithTokenMutationSchema } from '@documenso/trpc/server/f
 
 import { getI18nInstance } from '../../client-only/providers/i18n-server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
-import { DEFAULT_DOCUMENT_DATE_FORMAT } from '../../constants/date-formats';
-import { DEFAULT_DOCUMENT_TIME_ZONE } from '../../constants/time-zones';
 import { AppError, AppErrorCode } from '../../errors/app-error';
 import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
 import type { TRecipientActionAuthTypes } from '../../types/document-auth';
@@ -38,6 +35,7 @@ import {
 } from '../../types/webhook-payload';
 import type { ApiRequestMetadata } from '../../universal/extract-request-metadata';
 import { isRequiredField } from '../../utils/advanced-fields-helpers';
+import { extractDerivedDocumentMeta } from '../../utils/document';
 import type { CreateDocumentAuditLogDataResponse } from '../../utils/document-audit-logs';
 import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
 import {
@@ -45,7 +43,6 @@ import {
   createRecipientAuthOptions,
   extractDocumentAuthMethods,
 } from '../../utils/document-auth';
-import { env } from '../../utils/env';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
 import { formatDocumentsPath } from '../../utils/teams';
 import { sendDocument } from '../document/send-document';
@@ -116,7 +113,8 @@ export const createDocumentFromDirectTemplate = async ({
     throw new AppError(AppErrorCode.INVALID_REQUEST, { message: 'Invalid or missing template' });
   }
 
-  const { branding, settings } = await getEmailContext({
+  const { branding, settings, senderEmail, emailLanguage } = await getEmailContext({
+    emailType: 'INTERNAL',
     source: {
       type: 'team',
       teamId: template.teamId,
@@ -169,13 +167,7 @@ export const createDocumentFromDirectTemplate = async ({
   const nonDirectTemplateRecipients = template.recipients.filter(
     (recipient) => recipient.id !== directTemplateRecipient.id,
   );
-
-  const metaTimezone = template.templateMeta?.timezone || DEFAULT_DOCUMENT_TIME_ZONE;
-  const metaDateFormat = template.templateMeta?.dateFormat || DEFAULT_DOCUMENT_DATE_FORMAT;
-  const metaEmailMessage = template.templateMeta?.message || '';
-  const metaEmailSubject = template.templateMeta?.subject || '';
-  const metaLanguage = template.templateMeta?.language ?? settings.documentLanguage;
-  const metaSigningOrder = template.templateMeta?.signingOrder || DocumentSigningOrder.PARALLEL;
+  const derivedDocumentMeta = extractDerivedDocumentMeta(settings, template.templateMeta);
 
   // Associate, validate and map to a query every direct template recipient field with the provided fields.
   // Only process fields that are either required or have been signed by the user
@@ -234,7 +226,9 @@ export const createDocumentFromDirectTemplate = async ({
       const typedSignature = isSignatureField && !isBase64 ? value : undefined;
 
       if (templateField.type === FieldType.DATE) {
-        customText = DateTime.now().setZone(metaTimezone).toFormat(metaDateFormat);
+        customText = DateTime.now()
+          .setZone(derivedDocumentMeta.timezone)
+          .toFormat(derivedDocumentMeta.dateFormat);
       }
 
       if (isSignatureField && !signatureImageAsBase64 && !typedSignature) {
@@ -318,18 +312,7 @@ export const createDocumentFromDirectTemplate = async ({
           },
         },
         documentMeta: {
-          create: {
-            timezone: metaTimezone,
-            dateFormat: metaDateFormat,
-            message: metaEmailMessage,
-            subject: metaEmailSubject,
-            language: metaLanguage,
-            signingOrder: metaSigningOrder,
-            distributionMethod: template.templateMeta?.distributionMethod,
-            typedSignatureEnabled: template.templateMeta?.typedSignatureEnabled,
-            uploadSignatureEnabled: template.templateMeta?.uploadSignatureEnabled,
-            drawSignatureEnabled: template.templateMeta?.drawSignatureEnabled,
-          },
+          create: derivedDocumentMeta,
         },
       },
       include: {
@@ -589,11 +572,11 @@ export const createDocumentFromDirectTemplate = async ({
     });
 
     const [html, text] = await Promise.all([
-      renderEmailWithI18N(emailTemplate, { lang: metaLanguage, branding }),
-      renderEmailWithI18N(emailTemplate, { lang: metaLanguage, branding, plainText: true }),
+      renderEmailWithI18N(emailTemplate, { lang: emailLanguage, branding }),
+      renderEmailWithI18N(emailTemplate, { lang: emailLanguage, branding, plainText: true }),
     ]);
 
-    const i18n = await getI18nInstance(metaLanguage);
+    const i18n = await getI18nInstance(emailLanguage);
 
     await mailer.sendMail({
       to: [
@@ -602,10 +585,7 @@ export const createDocumentFromDirectTemplate = async ({
           address: templateOwner.email,
         },
       ],
-      from: {
-        name: env('NEXT_PRIVATE_SMTP_FROM_NAME') || 'Documenso',
-        address: env('NEXT_PRIVATE_SMTP_FROM_ADDRESS') || 'noreply@documenso.com',
-      },
+      from: senderEmail,
       subject: i18n._(msg`Document created from direct template`),
       html,
       text,

packages/lib/server-only/template/create-document-from-template-legacy.ts

@@ -3,6 +3,7 @@ import { DocumentSource, type RecipientRole } from '@prisma/client';
 import { nanoid, prefixedId } from '@documenso/lib/universal/id';
 import { prisma } from '@documenso/prisma';
 
+import { extractDerivedDocumentMeta } from '../../utils/document';
 import { buildTeamWhereQuery } from '../../utils/teams';
 import { getTeamSettings } from '../team/get-team-settings';
 
@@ -78,18 +79,7 @@ export const createDocumentFromTemplateLegacy = async ({
         })),
       },
       documentMeta: {
-        create: {
-          subject: template.templateMeta?.subject,
-          message: template.templateMeta?.message,
-          timezone: template.templateMeta?.timezone,
-          dateFormat: template.templateMeta?.dateFormat,
-          redirectUrl: template.templateMeta?.redirectUrl,
-          signingOrder: template.templateMeta?.signingOrder ?? undefined,
-          language: template.templateMeta?.language || settings.documentLanguage,
-          typedSignatureEnabled: template.templateMeta?.typedSignatureEnabled,
-          uploadSignatureEnabled: template.templateMeta?.uploadSignatureEnabled,
-          drawSignatureEnabled: template.templateMeta?.drawSignatureEnabled,
-        },
+        create: extractDerivedDocumentMeta(settings, template.templateMeta),
       },
     },
 

packages/lib/server-only/template/create-document-from-template.ts

@@ -1,6 +1,5 @@
-import type { DocumentDistributionMethod } from '@prisma/client';
+import type { DocumentDistributionMethod, DocumentSigningOrder } from '@prisma/client';
 import {
-  DocumentSigningOrder,
   DocumentSource,
   type Field,
   type Recipient,
@@ -40,6 +39,7 @@ import {
   mapDocumentToWebhookDocumentPayload,
 } from '../../types/webhook-payload';
 import type { ApiRequestMetadata } from '../../universal/extract-request-metadata';
+import { extractDerivedDocumentMeta } from '../../utils/document';
 import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
 import {
   createDocumentAuthOptions,
@@ -378,7 +378,7 @@ export const createDocumentFromTemplate = async ({
         visibility: template.visibility || settings.documentVisibility,
         useLegacyFieldInsertion: template.useLegacyFieldInsertion ?? false,
         documentMeta: {
-          create: {
+          create: extractDerivedDocumentMeta(settings, {
             subject: override?.subject || template.templateMeta?.subject,
             message: override?.message || template.templateMeta?.message,
             timezone: override?.timezone || template.templateMeta?.timezone,
@@ -387,13 +387,8 @@ export const createDocumentFromTemplate = async ({
             redirectUrl: override?.redirectUrl || template.templateMeta?.redirectUrl,
             distributionMethod:
               override?.distributionMethod || template.templateMeta?.distributionMethod,
-            // last `undefined` is due to JsonValue's
-            emailSettings:
-              override?.emailSettings || template.templateMeta?.emailSettings || undefined,
-            signingOrder:
-              override?.signingOrder ||
-              template.templateMeta?.signingOrder ||
-              DocumentSigningOrder.PARALLEL,
+            emailSettings: override?.emailSettings || template.templateMeta?.emailSettings,
+            signingOrder: override?.signingOrder || template.templateMeta?.signingOrder,
             language:
               override?.language || template.templateMeta?.language || settings.documentLanguage,
             typedSignatureEnabled:
@@ -403,10 +398,8 @@ export const createDocumentFromTemplate = async ({
             drawSignatureEnabled:
               override?.drawSignatureEnabled ?? template.templateMeta?.drawSignatureEnabled,
             allowDictateNextSigner:
-              override?.allowDictateNextSigner ??
-              template.templateMeta?.allowDictateNextSigner ??
-              false,
-          },
+              override?.allowDictateNextSigner ?? template.templateMeta?.allowDictateNextSigner,
+          }),
         },
         recipients: {
           createMany: {

packages/lib/server-only/template/create-template.ts

@@ -6,6 +6,7 @@ import { TemplateSchema } from '@documenso/prisma/generated/zod/modelSchema//Tem
 
 import { AppError, AppErrorCode } from '../../errors/app-error';
 import type { TDocumentAccessAuthTypes, TDocumentActionAuthTypes } from '../../types/document-auth';
+import { extractDerivedDocumentMeta } from '../../utils/document';
 import { createDocumentAuthOptions } from '../../utils/document-auth';
 import { buildTeamWhereQuery } from '../../utils/teams';
 import { getTeamSettings } from '../team/get-team-settings';
@@ -69,6 +70,24 @@ export const createTemplate = async ({
     teamId,
   });
 
+  const emailId = meta.emailId;
+
+  // Validate that the email ID belongs to the organisation.
+  if (emailId) {
+    const email = await prisma.organisationEmail.findFirst({
+      where: {
+        id: emailId,
+        organisationId: team.organisationId,
+      },
+    });
+
+    if (!email) {
+      throw new AppError(AppErrorCode.NOT_FOUND, {
+        message: 'Email not found',
+      });
+    }
+  }
+
   return await prisma.template.create({
     data: {
       title,
@@ -86,14 +105,7 @@ export const createTemplate = async ({
       publicDescription: data.publicDescription,
       type: data.type,
       templateMeta: {
-        create: {
-          ...meta,
-          language: meta?.language ?? settings.documentLanguage,
-          typedSignatureEnabled: meta?.typedSignatureEnabled ?? settings.typedSignatureEnabled,
-          uploadSignatureEnabled: meta?.uploadSignatureEnabled ?? settings.uploadSignatureEnabled,
-          drawSignatureEnabled: meta?.drawSignatureEnabled ?? settings.drawSignatureEnabled,
-          emailSettings: meta?.emailSettings || undefined,
-        },
+        create: extractDerivedDocumentMeta(settings, meta),
       },
     },
   });

packages/lib/server-only/template/update-template.ts

@@ -41,6 +41,7 @@ export const updateTemplate = async ({
       templateMeta: true,
       team: {
         select: {
+          organisationId: true,
           organisation: {
             select: {
               organisationClaim: true,
@@ -86,6 +87,24 @@ export const updateTemplate = async ({
     globalActionAuth: newGlobalActionAuth,
   });
 
+  const emailId = meta.emailId;
+
+  // Validate the emailId belongs to the organisation.
+  if (emailId) {
+    const email = await prisma.organisationEmail.findFirst({
+      where: {
+        id: emailId,
+        organisationId: template.team.organisationId,
+      },
+    });
+
+    if (!email) {
+      throw new AppError(AppErrorCode.NOT_FOUND, {
+        message: 'Email not found',
+      });
+    }
+  }
+
   return await prisma.template.update({
     where: {
       id: templateId,