feat: add attachments (#2091)

packages/lib/server-only/envelope-attachment/create-attachment.ts

@@ -0,0 +1,50 @@
+import { DocumentStatus } from '@prisma/client';
+
+import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
+import { prisma } from '@documenso/prisma';
+
+import { buildTeamWhereQuery } from '../../utils/teams';
+
+export type CreateAttachmentOptions = {
+  envelopeId: string;
+  teamId: number;
+  userId: number;
+  data: {
+    label: string;
+    data: string;
+  };
+};
+
+export const createAttachment = async ({
+  envelopeId,
+  teamId,
+  userId,
+  data,
+}: CreateAttachmentOptions) => {
+  const envelope = await prisma.envelope.findFirst({
+    where: {
+      id: envelopeId,
+      team: buildTeamWhereQuery({ teamId, userId }),
+    },
+  });
+
+  if (!envelope) {
+    throw new AppError(AppErrorCode.NOT_FOUND, {
+      message: 'Envelope not found',
+    });
+  }
+
+  if (envelope.status === DocumentStatus.COMPLETED || envelope.status === DocumentStatus.REJECTED) {
+    throw new AppError(AppErrorCode.INVALID_REQUEST, {
+      message: 'Attachments can not be modified after the document has been completed or rejected',
+    });
+  }
+
+  return await prisma.envelopeAttachment.create({
+    data: {
+      envelopeId,
+      type: 'link',
+      ...data,
+    },
+  });
+};

packages/lib/server-only/envelope-attachment/delete-attachment.ts

@@ -0,0 +1,47 @@
+import { DocumentStatus } from '@prisma/client';
+
+import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
+import { prisma } from '@documenso/prisma';
+
+import { buildTeamWhereQuery } from '../../utils/teams';
+
+export type DeleteAttachmentOptions = {
+  id: string;
+  userId: number;
+  teamId: number;
+};
+
+export const deleteAttachment = async ({ id, userId, teamId }: DeleteAttachmentOptions) => {
+  const attachment = await prisma.envelopeAttachment.findFirst({
+    where: {
+      id,
+      envelope: {
+        team: buildTeamWhereQuery({ teamId, userId }),
+      },
+    },
+    include: {
+      envelope: true,
+    },
+  });
+
+  if (!attachment) {
+    throw new AppError(AppErrorCode.NOT_FOUND, {
+      message: 'Attachment not found',
+    });
+  }
+
+  if (
+    attachment.envelope.status === DocumentStatus.COMPLETED ||
+    attachment.envelope.status === DocumentStatus.REJECTED
+  ) {
+    throw new AppError(AppErrorCode.INVALID_REQUEST, {
+      message: 'Attachments can not be modified after the document has been completed or rejected',
+    });
+  }
+
+  await prisma.envelopeAttachment.delete({
+    where: {
+      id,
+    },
+  });
+};

packages/lib/server-only/envelope-attachment/find-attachments-by-envelope-id.ts

@@ -0,0 +1,38 @@
+import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
+import { prisma } from '@documenso/prisma';
+
+import { buildTeamWhereQuery } from '../../utils/teams';
+
+export type FindAttachmentsByEnvelopeIdOptions = {
+  envelopeId: string;
+  userId: number;
+  teamId: number;
+};
+
+export const findAttachmentsByEnvelopeId = async ({
+  envelopeId,
+  userId,
+  teamId,
+}: FindAttachmentsByEnvelopeIdOptions) => {
+  const envelope = await prisma.envelope.findFirst({
+    where: {
+      id: envelopeId,
+      team: buildTeamWhereQuery({ teamId, userId }),
+    },
+  });
+
+  if (!envelope) {
+    throw new AppError(AppErrorCode.NOT_FOUND, {
+      message: 'Envelope not found',
+    });
+  }
+
+  return await prisma.envelopeAttachment.findMany({
+    where: {
+      envelopeId,
+    },
+    orderBy: {
+      createdAt: 'asc',
+    },
+  });
+};

packages/lib/server-only/envelope-attachment/find-attachments-by-token.ts

@@ -0,0 +1,70 @@
+import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
+import { prisma } from '@documenso/prisma';
+
+export type FindAttachmentsByTokenOptions = {
+  envelopeId: string;
+  token: string;
+};
+
+export const findAttachmentsByToken = async ({
+  envelopeId,
+  token,
+}: FindAttachmentsByTokenOptions) => {
+  const envelope = await prisma.envelope.findFirst({
+    where: {
+      id: envelopeId,
+      recipients: {
+        some: {
+          token,
+        },
+      },
+    },
+  });
+
+  if (!envelope) {
+    throw new AppError(AppErrorCode.NOT_FOUND, {
+      message: 'Envelope not found',
+    });
+  }
+
+  return await prisma.envelopeAttachment.findMany({
+    where: {
+      envelopeId,
+    },
+    orderBy: {
+      createdAt: 'asc',
+    },
+  });
+};
+
+export type FindAttachmentsByTeamOptions = {
+  envelopeId: string;
+  teamId: number;
+};
+
+export const findAttachmentsByTeam = async ({
+  envelopeId,
+  teamId,
+}: FindAttachmentsByTeamOptions) => {
+  const envelope = await prisma.envelope.findFirst({
+    where: {
+      id: envelopeId,
+      teamId,
+    },
+  });
+
+  if (!envelope) {
+    throw new AppError(AppErrorCode.NOT_FOUND, {
+      message: 'Envelope not found',
+    });
+  }
+
+  return await prisma.envelopeAttachment.findMany({
+    where: {
+      envelopeId,
+    },
+    orderBy: {
+      createdAt: 'asc',
+    },
+  });
+};

packages/lib/server-only/envelope-attachment/update-attachment.ts

@@ -0,0 +1,49 @@
+import { DocumentStatus } from '@prisma/client';
+
+import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
+import { prisma } from '@documenso/prisma';
+
+import { buildTeamWhereQuery } from '../../utils/teams';
+
+export type UpdateAttachmentOptions = {
+  id: string;
+  userId: number;
+  teamId: number;
+  data: { label?: string; data?: string };
+};
+
+export const updateAttachment = async ({ id, teamId, userId, data }: UpdateAttachmentOptions) => {
+  const attachment = await prisma.envelopeAttachment.findFirst({
+    where: {
+      id,
+      envelope: {
+        team: buildTeamWhereQuery({ teamId, userId }),
+      },
+    },
+    include: {
+      envelope: true,
+    },
+  });
+
+  if (!attachment) {
+    throw new AppError(AppErrorCode.NOT_FOUND, {
+      message: 'Attachment not found',
+    });
+  }
+
+  if (
+    attachment.envelope.status === DocumentStatus.COMPLETED ||
+    attachment.envelope.status === DocumentStatus.REJECTED
+  ) {
+    throw new AppError(AppErrorCode.INVALID_REQUEST, {
+      message: 'Attachments can not be modified after the document has been completed or rejected',
+    });
+  }
+
+  return await prisma.envelopeAttachment.update({
+    where: {
+      id,
+    },
+    data,
+  });
+};

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

@@ -20,6 +20,7 @@ import type { TCreateEnvelopeRequest } from '@documenso/trpc/server/envelope-rou
 
 import type { TDocumentAccessAuthTypes, TDocumentActionAuthTypes } from '../../types/document-auth';
 import type { TDocumentFormValues } from '../../types/document-form-values';
+import type { TEnvelopeAttachmentType } from '../../types/envelope-attachment';
 import {
   ZWebhookDocumentSchema,
   mapEnvelopeToWebhookDocumentPayload,
@@ -58,6 +59,11 @@ export type CreateEnvelopeOptions = {
     recipients?: TCreateEnvelopeRequest['recipients'];
     folderId?: string;
   };
+  attachments?: Array<{
+    label: string;
+    data: string;
+    type?: TEnvelopeAttachmentType;
+  }>;
   meta?: Partial<Omit<DocumentMeta, 'id'>>;
   requestMetadata: ApiRequestMetadata;
 };
@@ -67,6 +73,7 @@ export const createEnvelope = async ({
   teamId,
   normalizePdf,
   data,
+  attachments,
   meta,
   requestMetadata,
   internalVersion,
@@ -246,6 +253,15 @@ export const createEnvelope = async ({
             })),
           },
         },
+        envelopeAttachments: {
+          createMany: {
+            data: (attachments || []).map((attachment) => ({
+              label: attachment.label,
+              data: attachment.data,
+              type: attachment.type ?? 'link',
+            })),
+          },
+        },
         userId,
         teamId,
         authOptions,
@@ -338,6 +354,7 @@ export const createEnvelope = async ({
         fields: true,
         folder: true,
         envelopeItems: true,
+        envelopeAttachments: true,
       },
     });
 

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

@@ -640,6 +640,23 @@ export const createDocumentFromDirectTemplate = async ({
       data: auditLogsToCreate,
     });
 
+    const templateAttachments = await tx.envelopeAttachment.findMany({
+      where: {
+        envelopeId: directTemplateEnvelope.id,
+      },
+    });
+
+    if (templateAttachments.length > 0) {
+      await tx.envelopeAttachment.createMany({
+        data: templateAttachments.map((attachment) => ({
+          envelopeId: createdEnvelope.id,
+          type: attachment.type,
+          label: attachment.label,
+          data: attachment.data,
+        })),
+      });
+    }
+
     // Send email to template owner.
     const emailTemplate = createElement(DocumentCreatedFromDirectTemplateEmailTemplate, {
       recipientName: directRecipientEmail,

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

@@ -91,6 +91,12 @@ export type CreateDocumentFromTemplateOptions = {
     envelopeItemId?: string;
   }[];
 
+  attachments?: Array<{
+    label: string;
+    data: string;
+    type?: 'link';
+  }>;
+
   /**
    * Values that will override the predefined values in the template.
    */
@@ -295,6 +301,7 @@ export const createDocumentFromTemplate = async ({
   requestMetadata,
   folderId,
   prefillFields,
+  attachments,
 }: CreateDocumentFromTemplateOptions) => {
   const { envelopeWhereInput } = await getEnvelopeWhereInput({
     id,
@@ -667,6 +674,33 @@ export const createDocumentFromTemplate = async ({
       }),
     });
 
+    const templateAttachments = await tx.envelopeAttachment.findMany({
+      where: {
+        envelopeId: template.id,
+      },
+    });
+
+    const attachmentsToCreate = [
+      ...templateAttachments.map((attachment) => ({
+        envelopeId: envelope.id,
+        type: attachment.type,
+        label: attachment.label,
+        data: attachment.data,
+      })),
+      ...(attachments || []).map((attachment) => ({
+        envelopeId: envelope.id,
+        type: attachment.type || 'link',
+        label: attachment.label,
+        data: attachment.data,
+      })),
+    ];
+
+    if (attachmentsToCreate.length > 0) {
+      await tx.envelopeAttachment.createMany({
+        data: attachmentsToCreate,
+      });
+    }
+
     const createdEnvelope = await tx.envelope.findFirst({
       where: {
         id: envelope.id,