feat: add document distribution setting (#1437)

Add a document distribution setting which will allow us to further
configure how recipients currently receive documents.

packages/lib/server-only/document-meta/upsert-document-meta.ts

@@ -7,9 +7,10 @@ import {
   diffDocumentMetaChanges,
 } from '@documenso/lib/utils/document-audit-logs';
 import { prisma } from '@documenso/prisma';
-import type { DocumentSigningOrder } from '@documenso/prisma/client';
+import type { DocumentDistributionMethod, DocumentSigningOrder } from '@documenso/prisma/client';
 
 import type { SupportedLanguageCodes } from '../../constants/i18n';
+import type { TDocumentEmailSettings } from '../../types/document-email';
 
 export type CreateDocumentMetaOptions = {
   documentId: number;
@@ -19,7 +20,9 @@ export type CreateDocumentMetaOptions = {
   password?: string;
   dateFormat?: string;
   redirectUrl?: string;
+  emailSettings?: TDocumentEmailSettings;
   signingOrder?: DocumentSigningOrder;
+  distributionMethod?: DocumentDistributionMethod;
   typedSignatureEnabled?: boolean;
   language?: SupportedLanguageCodes;
   userId: number;
@@ -36,6 +39,8 @@ export const upsertDocumentMeta = async ({
   userId,
   redirectUrl,
   signingOrder,
+  emailSettings,
+  distributionMethod,
   typedSignatureEnabled,
   language,
   requestMetadata,
@@ -88,6 +93,8 @@ export const upsertDocumentMeta = async ({
         documentId,
         redirectUrl,
         signingOrder,
+        emailSettings,
+        distributionMethod,
         typedSignatureEnabled,
         language,
       },
@@ -99,6 +106,8 @@ export const upsertDocumentMeta = async ({
         timezone,
         redirectUrl,
         signingOrder,
+        emailSettings,
+        distributionMethod,
         typedSignatureEnabled,
         language,
       },

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

@@ -14,6 +14,7 @@ import { getI18nInstance } from '../../client-only/providers/i18n.server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
 import { FROM_ADDRESS, FROM_NAME } from '../../constants/email';
 import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
+import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import type { RequestMetadata } from '../../universal/extract-request-metadata';
 import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
@@ -178,6 +179,14 @@ const handleDocumentOwnerDelete = async ({
     });
   });
 
+  const isDocumentDeleteEmailEnabled = extractDerivedDocumentEmailSettings(
+    document.documentMeta,
+  ).documentDeleted;
+
+  if (!isDocumentDeleteEmailEnabled) {
+    return deletedDocument;
+  }
+
   // Send cancellation emails to recipients.
   await Promise.all(
     document.Recipient.map(async (recipient) => {

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

@@ -19,6 +19,7 @@ import type { Prisma } from '@documenso/prisma/client';
 
 import { getI18nInstance } from '../../client-only/providers/i18n.server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
+import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
 import { getDocumentWhereInput } from './get-document-by-id';
 
@@ -89,6 +90,14 @@ export const resendDocument = async ({
     throw new Error('Can not send completed document');
   }
 
+  const isRecipientSigningRequestEmailEnabled = extractDerivedDocumentEmailSettings(
+    document.documentMeta,
+  ).recipientSigningRequest;
+
+  if (!isRecipientSigningRequestEmailEnabled) {
+    return;
+  }
+
   await Promise.all(
     document.Recipient.map(async (recipient) => {
       if (recipient.role === RecipientRole.CC) {

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

@@ -10,6 +10,7 @@ import { DocumentSource } from '@documenso/prisma/client';
 import { getI18nInstance } from '../../client-only/providers/i18n.server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
 import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
+import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import type { RequestMetadata } from '../../universal/extract-request-metadata';
 import { getFile } from '../../universal/upload/get-file';
 import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
@@ -66,8 +67,15 @@ export const sendCompletedEmail = async ({ documentId, requestMetadata }: SendDo
 
   const i18n = await getI18nInstance(document.documentMeta?.language);
 
-  // If the document owner is not a recipient then send the email to them separately
-  if (!document.Recipient.find((recipient) => recipient.email === owner.email)) {
+  const isDocumentCompletedEmailEnabled = extractDerivedDocumentEmailSettings(
+    document.documentMeta,
+  ).documentCompleted;
+
+  // If the document owner is not a recipient, OR recipient emails are disabled, then send the email to them separately.
+  if (
+    !document.Recipient.find((recipient) => recipient.email === owner.email) ||
+    !isDocumentCompletedEmailEnabled
+  ) {
     const template = createElement(DocumentCompletedEmailTemplate, {
       documentName: document.title,
       assetBaseUrl,
@@ -119,6 +127,10 @@ export const sendCompletedEmail = async ({ documentId, requestMetadata }: SendDo
     });
   }
 
+  if (!isDocumentCompletedEmailEnabled) {
+    return;
+  }
+
   await Promise.all(
     document.Recipient.map(async (recipient) => {
       const customEmailTemplate = {

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

@@ -8,6 +8,7 @@ import { prisma } from '@documenso/prisma';
 
 import { getI18nInstance } from '../../client-only/providers/i18n.server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
+import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
 
 export interface SendDeleteEmailOptions {
@@ -22,6 +23,7 @@ export const sendDeleteEmail = async ({ documentId, reason }: SendDeleteEmailOpt
     },
     include: {
       User: true,
+      documentMeta: true,
     },
   });
 
@@ -29,6 +31,14 @@ export const sendDeleteEmail = async ({ documentId, reason }: SendDeleteEmailOpt
     throw new Error('Document not found');
   }
 
+  const isDocumentDeletedEmailEnabled = extractDerivedDocumentEmailSettings(
+    document.documentMeta,
+  ).documentDeleted;
+
+  if (!isDocumentDeletedEmailEnabled) {
+    return;
+  }
+
   const { email, name } = document.User;
 
   const assetBaseUrl = NEXT_PUBLIC_WEBAPP_URL() || 'http://localhost:3000';

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

@@ -13,6 +13,7 @@ import {
 import { WebhookTriggerEvents } from '@documenso/prisma/client';
 
 import { jobs } from '../../jobs/client';
+import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import { getFile } from '../../universal/upload/get-file';
 import { insertFormValuesInPdf } from '../pdf/insert-form-values-in-pdf';
 import { triggerWebhook } from '../webhooks/trigger/trigger-webhook';
@@ -29,7 +30,7 @@ export const sendDocument = async ({
   documentId,
   userId,
   teamId,
-  sendEmail = true,
+  sendEmail,
   requestMetadata,
 }: SendDocumentOptions) => {
   const user = await prisma.user.findFirstOrThrow({
@@ -156,7 +157,14 @@ export const sendDocument = async ({
   //   throw new Error('Some signers have not been assigned a signature field.');
   // }
 
-  if (sendEmail) {
+  const isRecipientSigningRequestEmailEnabled = extractDerivedDocumentEmailSettings(
+    document.documentMeta,
+  ).recipientSigningRequest;
+
+  // Only send email if one of the following is true:
+  // - It is explicitly set
+  // - The email is enabled for signing requests AND sendEmail is undefined
+  if (sendEmail || (isRecipientSigningRequestEmailEnabled && sendEmail === undefined)) {
     await Promise.all(
       recipientsToNotify.map(async (recipient) => {
         if (recipient.sendStatus === SendStatus.SENT || recipient.role === RecipientRole.CC) {

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

@@ -8,6 +8,7 @@ import { prisma } from '@documenso/prisma';
 
 import { getI18nInstance } from '../../client-only/providers/i18n.server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
+import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
 
 export interface SendPendingEmailOptions {
@@ -43,6 +44,14 @@ export const sendPendingEmail = async ({ documentId, recipientId }: SendPendingE
     throw new Error('Document has no recipients');
   }
 
+  const isDocumentPendingEmailEnabled = extractDerivedDocumentEmailSettings(
+    document.documentMeta,
+  ).documentPending;
+
+  if (!isDocumentPendingEmailEnabled) {
+    return;
+  }
+
   const [recipient] = document.Recipient;
 
   const { email, name } = recipient;

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

@@ -13,6 +13,7 @@ import { getI18nInstance } from '../../client-only/providers/i18n.server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
 import { FROM_ADDRESS, FROM_NAME } from '../../constants/email';
 import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
+import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import type { RequestMetadata } from '../../universal/extract-request-metadata';
 import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
@@ -40,8 +41,16 @@ export const superDeleteDocument = async ({ id, requestMetadata }: SuperDeleteDo
 
   const { status, User: user } = document;
 
+  const isDocumentDeletedEmailEnabled = extractDerivedDocumentEmailSettings(
+    document.documentMeta,
+  ).documentDeleted;
+
   // if the document is pending, send cancellation emails to all recipients
-  if (status === DocumentStatus.PENDING && document.Recipient.length > 0) {
+  if (
+    status === DocumentStatus.PENDING &&
+    document.Recipient.length > 0 &&
+    isDocumentDeletedEmailEnabled
+  ) {
     await Promise.all(
       document.Recipient.map(async (recipient) => {
         if (recipient.sendStatus !== SendStatus.SENT) {

packages/lib/server-only/recipient/set-recipients-for-document.ts

@@ -26,6 +26,7 @@ import { getI18nInstance } from '../../client-only/providers/i18n.server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
 import { FROM_ADDRESS, FROM_NAME } from '../../constants/email';
 import { AppError, AppErrorCode } from '../../errors/app-error';
+import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
 import { canRecipientBeModified } from '../../utils/recipients';
 import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
 
@@ -280,10 +281,14 @@ export const setRecipientsForDocument = async ({
       });
     });
 
+    const isRecipientRemovedEmailEnabled = extractDerivedDocumentEmailSettings(
+      document.documentMeta,
+    ).recipientRemoved;
+
     // Send emails to deleted recipients.
     await Promise.all(
       removedRecipients.map(async (recipient) => {
-        if (recipient.sendStatus !== SendStatus.SENT) {
+        if (recipient.sendStatus !== SendStatus.SENT || !isRecipientRemovedEmailEnabled) {
           return;
         }
 

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

@@ -275,6 +275,7 @@ export const createDocumentFromDirectTemplate = async ({
             subject: metaEmailSubject,
             language: metaLanguage,
             signingOrder: metaSigningOrder,
+            distributionMethod: template.templateMeta?.distributionMethod,
           },
         },
       },

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

@@ -1,5 +1,6 @@
 import { nanoid } from '@documenso/lib/universal/id';
 import { prisma } from '@documenso/prisma';
+import type { DocumentDistributionMethod } from '@documenso/prisma/client';
 import {
   DocumentSigningOrder,
   DocumentSource,
@@ -62,6 +63,7 @@ export type CreateDocumentFromTemplateOptions = {
     redirectUrl?: string;
     signingOrder?: DocumentSigningOrder;
     language?: SupportedLanguageCodes;
+    distributionMethod?: DocumentDistributionMethod;
   };
   requestMetadata?: RequestMetadata;
 };
@@ -177,6 +179,9 @@ export const createDocumentFromTemplate = async ({
             password: override?.password || template.templateMeta?.password,
             dateFormat: override?.dateFormat || template.templateMeta?.dateFormat,
             redirectUrl: override?.redirectUrl || template.templateMeta?.redirectUrl,
+            distributionMethod:
+              override?.distributionMethod || template.templateMeta?.distributionMethod,
+            emailSettings: template.templateMeta?.emailSettings || undefined,
             signingOrder:
               override?.signingOrder ||
               template.templateMeta?.signingOrder ||

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

@@ -60,7 +60,10 @@ export const duplicateTemplate = async ({
 
   if (template.templateMeta) {
     templateMeta = {
-      create: omit(template.templateMeta, ['id', 'templateId']),
+      create: {
+        ...omit(template.templateMeta, ['id', 'templateId']),
+        emailSettings: template.templateMeta.emailSettings || undefined,
+      },
     };
   }
 

packages/lib/server-only/template/find-templates.ts

@@ -54,6 +54,7 @@ export const findTemplates = async ({
         templateMeta: {
           select: {
             signingOrder: true,
+            distributionMethod: true,
           },
         },
         directLink: {

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

@@ -112,9 +112,11 @@ export const updateTemplateSettings = async ({
           },
           create: {
             ...meta,
+            emailSettings: meta?.emailSettings || undefined,
           },
           update: {
             ...meta,
+            emailSettings: meta?.emailSettings || undefined,
           },
         },
       },