feat: add empty emails for envelopes

packages/lib/server-only/document/complete-document-with-token.ts

@@ -2,6 +2,7 @@ import {
   DocumentSigningOrder,
   DocumentStatus,
   EnvelopeType,
+  FieldType,
   RecipientRole,
   SendStatus,
   SigningStatus,
@@ -43,6 +44,14 @@ export type CompleteDocumentWithTokenOptions = {
     email: string;
     name: string;
   };
+  /**
+   * Override the recipient information. This will only work if the recipient
+   * does not have a name or email set.
+   */
+  recipientOverride?: {
+    email?: string;
+    name?: string;
+  };
 };
 
 export const completeDocumentWithToken = async ({
@@ -52,6 +61,7 @@ export const completeDocumentWithToken = async ({
   accessAuthOptions,
   requestMetadata,
   nextSigner,
+  recipientOverride,
 }: CompleteDocumentWithTokenOptions) => {
   const envelope = await prisma.envelope.findFirstOrThrow({
     where: {
@@ -116,6 +126,35 @@ export const completeDocumentWithToken = async ({
     throw new Error(`Recipient ${recipient.id} has unsigned fields`);
   }
 
+  let recipientName = recipient.name;
+  let recipientEmail = recipient.email;
+
+  // Only trim the name if it's been derived.
+  if (!recipientName) {
+    recipientName = (
+      recipientOverride?.name ||
+      fields.find((field) => field.type === FieldType.NAME)?.customText ||
+      ''
+    ).trim();
+  }
+
+  // Only trim the email if it's been derived.
+  if (!recipient.email) {
+    recipientEmail = (
+      recipientOverride?.email ||
+      fields.find((field) => field.type === FieldType.EMAIL)?.customText ||
+      ''
+    )
+      .trim()
+      .toLowerCase();
+  }
+
+  if (!recipientEmail) {
+    throw new AppError(AppErrorCode.INVALID_BODY, {
+      message: 'Recipient email is required',
+    });
+  }
+
   // Check ACCESS AUTH 2FA validation during document completion
   const { derivedRecipientAccessAuth } = extractDocumentAuthMethods({
     documentAuth: envelope.authOptions,
@@ -129,6 +168,12 @@ export const completeDocumentWithToken = async ({
       });
     }
 
+    if (!recipient.email.trim()) {
+      throw new AppError(AppErrorCode.INVALID_REQUEST, {
+        message: `Recipient ${recipient.id} requires an email because they have auth requirements.`,
+      });
+    }
+
     const isValid = await isRecipientAuthorized({
       type: 'ACCESS_2FA',
       documentAuthOptions: envelope.authOptions,
@@ -176,9 +221,43 @@ export const completeDocumentWithToken = async ({
       data: {
         signingStatus: SigningStatus.SIGNED,
         signedAt: new Date(),
+        name: recipientName,
+        email: recipientEmail,
       },
     });
 
+    if (recipientEmail !== recipient.email || recipientName !== recipient.name) {
+      await tx.documentAuditLog.create({
+        data: createDocumentAuditLogData({
+          type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_UPDATED,
+          envelopeId: envelope.id,
+          user: {
+            name: recipientName,
+            email: recipientEmail,
+          },
+          requestMetadata,
+          data: {
+            recipientEmail: recipient.email,
+            recipientName: recipient.name,
+            recipientId: recipient.id,
+            recipientRole: recipient.role,
+            changes: [
+              {
+                type: RECIPIENT_DIFF_TYPE.NAME,
+                from: recipient.name,
+                to: recipientName,
+              },
+              {
+                type: RECIPIENT_DIFF_TYPE.EMAIL,
+                from: recipientEmail,
+                to: recipientEmail,
+              },
+            ],
+          },
+        }),
+      });
+    }
+
     const authOptions = extractDocumentAuthMethods({
       documentAuth: envelope.authOptions,
       recipientAuth: recipient.authOptions,
@@ -189,13 +268,13 @@ export const completeDocumentWithToken = async ({
         type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED,
         envelopeId: envelope.id,
         user: {
-          name: recipient.name,
-          email: recipient.email,
+          name: recipientName,
+          email: recipientEmail,
         },
         requestMetadata,
         data: {
-          recipientEmail: recipient.email,
-          recipientName: recipient.name,
+          recipientEmail: recipientEmail,
+          recipientName: recipientName,
           recipientId: recipient.id,
           recipientRole: recipient.role,
           actionAuth: authOptions.derivedRecipientActionAuth,
@@ -204,13 +283,15 @@ export const completeDocumentWithToken = async ({
     });
   });
 
-  await jobs.triggerJob({
-    name: 'send.recipient.signed.email',
-    payload: {
-      documentId: legacyDocumentId,
-      recipientId: recipient.id,
-    },
-  });
+  if (recipientEmail) {
+    await jobs.triggerJob({
+      name: 'send.recipient.signed.email',
+      payload: {
+        documentId: legacyDocumentId,
+        recipientId: recipient.id,
+      },
+    });
+  }
 
   const pendingRecipients = await prisma.recipient.findMany({
     select: {
@@ -247,8 +328,8 @@ export const completeDocumentWithToken = async ({
               type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_UPDATED,
               envelopeId: envelope.id,
               user: {
-                name: recipient.name,
-                email: recipient.email,
+                name: recipientName,
+                email: recipientEmail,
               },
               requestMetadata,
               data: {

packages/lib/server-only/document/delete-document.ts

@@ -21,6 +21,7 @@ import type { ApiRequestMetadata } from '../../universal/extract-request-metadat
 import { isDocumentCompleted } from '../../utils/document';
 import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
 import { type EnvelopeIdOptions, unsafeBuildEnvelopeIdQuery } from '../../utils/envelope';
+import { isRecipientEmailValidForSending } from '../../utils/recipients';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
 import { getEmailContext } from '../email/get-email-context';
 import { getMemberRoles } from '../team/get-member-roles';
@@ -209,7 +210,7 @@ const handleDocumentOwnerDelete = async ({
   // Send cancellation emails to recipients.
   await Promise.all(
     envelope.recipients.map(async (recipient) => {
-      if (recipient.sendStatus !== SendStatus.SENT) {
+      if (recipient.sendStatus !== SendStatus.SENT || !isRecipientEmailValidForSending(recipient)) {
         return;
       }
 

packages/lib/server-only/document/resend-document.ts

@@ -26,6 +26,7 @@ import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
 import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import { isDocumentCompleted } from '../../utils/document';
 import type { EnvelopeIdOptions } from '../../utils/envelope';
+import { isRecipientEmailValidForSending } from '../../utils/recipients';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
 import { getEmailContext } from '../email/get-email-context';
 import { getEnvelopeWhereInput } from '../envelope/get-envelope-by-id';
@@ -118,7 +119,7 @@ export const resendDocument = async ({
 
   await Promise.all(
     recipientsToRemind.map(async (recipient) => {
-      if (recipient.role === RecipientRole.CC) {
+      if (recipient.role === RecipientRole.CC || !isRecipientEmailValidForSending(recipient)) {
         return;
       }
 

packages/lib/server-only/document/send-completed-email.ts

@@ -16,6 +16,7 @@ import { getFileServerSide } from '../../universal/upload/get-file.server';
 import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
 import type { EnvelopeIdOptions } from '../../utils/envelope';
 import { unsafeBuildEnvelopeIdQuery } from '../../utils/envelope';
+import { isRecipientEmailValidForSending } from '../../utils/recipients';
 import { renderCustomEmailTemplate } from '../../utils/render-custom-email-template';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
 import { formatDocumentsPath } from '../../utils/teams';
@@ -176,8 +177,12 @@ export const sendCompletedEmail = async ({ id, requestMetadata }: SendDocumentOp
     return;
   }
 
+  const recipientsToNotify = envelope.recipients.filter((recipient) =>
+    isRecipientEmailValidForSending(recipient),
+  );
+
   await Promise.all(
-    envelope.recipients.map(async (recipient) => {
+    recipientsToNotify.map(async (recipient) => {
       const customEmailTemplate = {
         'signer.name': recipient.name,
         'signer.email': recipient.email,

packages/lib/server-only/document/send-document.ts

@@ -35,8 +35,10 @@ import {
 import { getFileServerSide } from '../../universal/upload/get-file.server';
 import { putPdfFileServerSide } from '../../universal/upload/put-file.server';
 import { isDocumentCompleted } from '../../utils/document';
+import { extractDocumentAuthMethods } from '../../utils/document-auth';
 import { type EnvelopeIdOptions, mapSecondaryIdToDocumentId } from '../../utils/envelope';
 import { toCheckboxCustomText, toRadioCustomText } from '../../utils/fields';
+import { isRecipientEmailValidForSending } from '../../utils/recipients';
 import { getEnvelopeWhereInput } from '../envelope/get-envelope-by-id';
 import { insertFormValuesInPdf } from '../pdf/insert-form-values-in-pdf';
 import { triggerWebhook } from '../webhooks/trigger/trigger-webhook';
@@ -128,6 +130,24 @@ export const sendDocument = async ({
     );
   }
 
+  // Validate that recipients with auth requirements have a valid email.
+  envelope.recipients.forEach((recipient) => {
+    const auth = extractDocumentAuthMethods({
+      documentAuth: envelope.authOptions,
+      recipientAuth: recipient.authOptions,
+    });
+
+    if (
+      recipient.role !== RecipientRole.CC &&
+      (auth.recipientAccessAuthRequired || auth.recipientActionAuthRequired) &&
+      !isRecipientEmailValidForSending(recipient)
+    ) {
+      throw new AppError(AppErrorCode.INVALID_REQUEST, {
+        message: `Recipient ${recipient.id} requires an email because they have auth requirements.`,
+      });
+    }
+  });
+
   // Commented out server side checks for minimum 1 signature per signer now since we need to
   // decide if we want to enforce this for API & templates.
   // const fields = await getFieldsForDocument({

packages/lib/server-only/document/send-pending-email.ts

@@ -12,6 +12,7 @@ import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
 import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import type { EnvelopeIdOptions } from '../../utils/envelope';
 import { unsafeBuildEnvelopeIdQuery } from '../../utils/envelope';
+import { isRecipientEmailValidForSending } from '../../utils/recipients';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
 import { getEmailContext } from '../email/get-email-context';
 
@@ -69,6 +70,11 @@ export const sendPendingEmail = async ({ id, recipientId }: SendPendingEmailOpti
 
   const { email, name } = recipient;
 
+  // Skip sending email if recipient has no email address
+  if (!isRecipientEmailValidForSending(recipient)) {
+    return;
+  }
+
   const assetBaseUrl = NEXT_PUBLIC_WEBAPP_URL() || 'http://localhost:3000';
 
   const template = createElement(DocumentPendingEmailTemplate, {