feat: add attachments (#2091)

packages/trpc/server/document-router/attachment/create-attachment.ts

@@ -0,0 +1,50 @@
+import { EnvelopeType } from '@prisma/client';
+
+import { createAttachment } from '@documenso/lib/server-only/envelope-attachment/create-attachment';
+import { getEnvelopeById } from '@documenso/lib/server-only/envelope/get-envelope-by-id';
+
+import { authenticatedProcedure } from '../../trpc';
+import {
+  ZCreateAttachmentRequestSchema,
+  ZCreateAttachmentResponseSchema,
+} from './create-attachment.types';
+
+export const createAttachmentRoute = authenticatedProcedure
+  .meta({
+    openapi: {
+      method: 'POST',
+      path: '/document/attachment/create',
+      summary: 'Create attachment',
+      description: 'Create a new attachment for a document',
+      tags: ['Document'],
+    },
+  })
+  .input(ZCreateAttachmentRequestSchema)
+  .output(ZCreateAttachmentResponseSchema)
+  .mutation(async ({ input, ctx }) => {
+    const { teamId } = ctx;
+    const userId = ctx.user.id;
+
+    const { documentId, data } = input;
+
+    ctx.logger.info({
+      input: { documentId, label: data.label },
+    });
+
+    const envelope = await getEnvelopeById({
+      id: {
+        type: 'documentId',
+        id: documentId,
+      },
+      userId,
+      teamId,
+      type: EnvelopeType.DOCUMENT,
+    });
+
+    await createAttachment({
+      envelopeId: envelope.id,
+      teamId,
+      userId,
+      data,
+    });
+  });

packages/trpc/server/document-router/attachment/create-attachment.types.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+
+export const ZCreateAttachmentRequestSchema = z.object({
+  documentId: z.number(),
+  data: z.object({
+    label: z.string().min(1, 'Label is required'),
+    data: z.string().url('Must be a valid URL'),
+  }),
+});
+
+export const ZCreateAttachmentResponseSchema = z.void();
+
+export type TCreateAttachmentRequest = z.infer<typeof ZCreateAttachmentRequestSchema>;
+export type TCreateAttachmentResponse = z.infer<typeof ZCreateAttachmentResponseSchema>;

packages/trpc/server/document-router/attachment/delete-attachment.ts

@@ -0,0 +1,36 @@
+import { deleteAttachment } from '@documenso/lib/server-only/envelope-attachment/delete-attachment';
+
+import { authenticatedProcedure } from '../../trpc';
+import {
+  ZDeleteAttachmentRequestSchema,
+  ZDeleteAttachmentResponseSchema,
+} from './delete-attachment.types';
+
+export const deleteAttachmentRoute = authenticatedProcedure
+  .meta({
+    openapi: {
+      method: 'POST',
+      path: '/document/attachment/delete',
+      summary: 'Delete attachment',
+      description: 'Delete an attachment from a document',
+      tags: ['Document'],
+    },
+  })
+  .input(ZDeleteAttachmentRequestSchema)
+  .output(ZDeleteAttachmentResponseSchema)
+  .mutation(async ({ input, ctx }) => {
+    const { teamId } = ctx;
+    const userId = ctx.user.id;
+
+    const { id } = input;
+
+    ctx.logger.info({
+      input: { id },
+    });
+
+    await deleteAttachment({
+      id,
+      userId,
+      teamId,
+    });
+  });

packages/trpc/server/document-router/attachment/delete-attachment.types.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+
+export const ZDeleteAttachmentRequestSchema = z.object({
+  id: z.string(),
+});
+
+export const ZDeleteAttachmentResponseSchema = z.void();
+
+export type TDeleteAttachmentRequest = z.infer<typeof ZDeleteAttachmentRequestSchema>;
+export type TDeleteAttachmentResponse = z.infer<typeof ZDeleteAttachmentResponseSchema>;

packages/trpc/server/document-router/attachment/find-attachments.ts

@@ -0,0 +1,52 @@
+import { EnvelopeType } from '@prisma/client';
+
+import { findAttachmentsByEnvelopeId } from '@documenso/lib/server-only/envelope-attachment/find-attachments-by-envelope-id';
+import { getEnvelopeById } from '@documenso/lib/server-only/envelope/get-envelope-by-id';
+
+import { authenticatedProcedure } from '../../trpc';
+import {
+  ZFindAttachmentsRequestSchema,
+  ZFindAttachmentsResponseSchema,
+} from './find-attachments.types';
+
+export const findAttachmentsRoute = authenticatedProcedure
+  .meta({
+    openapi: {
+      method: 'GET',
+      path: '/document/attachment',
+      summary: 'Find attachments',
+      description: 'Find all attachments for a document',
+      tags: ['Document'],
+    },
+  })
+  .input(ZFindAttachmentsRequestSchema)
+  .output(ZFindAttachmentsResponseSchema)
+  .query(async ({ input, ctx }) => {
+    const { documentId } = input;
+    const { teamId } = ctx;
+    const userId = ctx.user.id;
+
+    ctx.logger.info({
+      input: { documentId },
+    });
+
+    const envelope = await getEnvelopeById({
+      id: {
+        type: 'documentId',
+        id: documentId,
+      },
+      userId,
+      teamId,
+      type: EnvelopeType.DOCUMENT,
+    });
+
+    const data = await findAttachmentsByEnvelopeId({
+      envelopeId: envelope.id,
+      teamId,
+      userId,
+    });
+
+    return {
+      data,
+    };
+  });

packages/trpc/server/document-router/attachment/find-attachments.types.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+
+import { ZEnvelopeAttachmentTypeSchema } from '@documenso/lib/types/envelope-attachment';
+
+export const ZFindAttachmentsRequestSchema = z.object({
+  documentId: z.number(),
+});
+
+export const ZFindAttachmentsResponseSchema = z.object({
+  data: z.array(
+    z.object({
+      id: z.string(),
+      type: ZEnvelopeAttachmentTypeSchema,
+      label: z.string(),
+      data: z.string(),
+    }),
+  ),
+});
+
+export type TFindAttachmentsRequest = z.infer<typeof ZFindAttachmentsRequestSchema>;
+export type TFindAttachmentsResponse = z.infer<typeof ZFindAttachmentsResponseSchema>;

packages/trpc/server/document-router/attachment/update-attachment.ts

@@ -0,0 +1,37 @@
+import { updateAttachment } from '@documenso/lib/server-only/envelope-attachment/update-attachment';
+
+import { authenticatedProcedure } from '../../trpc';
+import {
+  ZUpdateAttachmentRequestSchema,
+  ZUpdateAttachmentResponseSchema,
+} from './update-attachment.types';
+
+export const updateAttachmentRoute = authenticatedProcedure
+  .meta({
+    openapi: {
+      method: 'POST',
+      path: '/document/attachment/update',
+      summary: 'Update attachment',
+      description: 'Update an existing attachment',
+      tags: ['Document'],
+    },
+  })
+  .input(ZUpdateAttachmentRequestSchema)
+  .output(ZUpdateAttachmentResponseSchema)
+  .mutation(async ({ input, ctx }) => {
+    const { teamId } = ctx;
+    const userId = ctx.user.id;
+
+    const { id, data } = input;
+
+    ctx.logger.info({
+      input: { id },
+    });
+
+    await updateAttachment({
+      id,
+      userId,
+      teamId,
+      data,
+    });
+  });

packages/trpc/server/document-router/attachment/update-attachment.types.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+
+export const ZUpdateAttachmentRequestSchema = z.object({
+  id: z.string(),
+  data: z.object({
+    label: z.string().min(1, 'Label is required'),
+    data: z.string().url('Must be a valid URL'),
+  }),
+});
+
+export const ZUpdateAttachmentResponseSchema = z.void();
+
+export type TUpdateAttachmentRequest = z.infer<typeof ZUpdateAttachmentRequestSchema>;
+export type TUpdateAttachmentResponse = z.infer<typeof ZUpdateAttachmentResponseSchema>;

packages/trpc/server/document-router/create-document-temporary.ts

@@ -37,6 +37,7 @@ export const createDocumentTemporaryRoute = authenticatedProcedure
       recipients,
       meta,
       folderId,
+      attachments,
     } = input;
 
     const { remaining } = await getServerLimits({ userId: user.id, teamId });
@@ -86,6 +87,7 @@ export const createDocumentTemporaryRoute = authenticatedProcedure
           },
         ],
       },
+      attachments,
       meta: {
         ...meta,
         emailSettings: meta?.emailSettings ?? undefined,

packages/trpc/server/document-router/create-document-temporary.types.ts

@@ -7,6 +7,7 @@ import {
 } from '@documenso/lib/types/document-auth';
 import { ZDocumentFormValuesSchema } from '@documenso/lib/types/document-form-values';
 import { ZDocumentMetaCreateSchema } from '@documenso/lib/types/document-meta';
+import { ZEnvelopeAttachmentTypeSchema } from '@documenso/lib/types/envelope-attachment';
 import {
   ZFieldHeightSchema,
   ZFieldPageNumberSchema,
@@ -68,6 +69,15 @@ export const ZCreateDocumentTemporaryRequestSchema = z.object({
       }),
     )
 
+    .optional(),
+  attachments: z
+    .array(
+      z.object({
+        label: z.string().min(1, 'Label is required'),
+        data: z.string().url('Must be a valid URL'),
+        type: ZEnvelopeAttachmentTypeSchema.optional().default('link'),
+      }),
+    )
     .optional(),
   meta: ZDocumentMetaCreateSchema.optional(),
 });

packages/trpc/server/document-router/create-document.ts

@@ -16,7 +16,7 @@ export const createDocumentRoute = authenticatedProcedure
   .output(ZCreateDocumentResponseSchema)
   .mutation(async ({ input, ctx }) => {
     const { user, teamId } = ctx;
-    const { title, documentDataId, timezone, folderId } = input;
+    const { title, documentDataId, timezone, folderId, attachments } = input;
 
     ctx.logger.info({
       input: {
@@ -48,6 +48,7 @@ export const createDocumentRoute = authenticatedProcedure
           },
         ],
       },
+      attachments,
       normalizePdf: true,
       requestMetadata: ctx.metadata,
     });

packages/trpc/server/document-router/create-document.types.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 
 import { ZDocumentMetaTimezoneSchema } from '@documenso/lib/types/document-meta';
+import { ZEnvelopeAttachmentTypeSchema } from '@documenso/lib/types/envelope-attachment';
 
 import { ZDocumentTitleSchema } from './schema';
 
@@ -19,6 +20,15 @@ export const ZCreateDocumentRequestSchema = z.object({
   documentDataId: z.string().min(1),
   timezone: ZDocumentMetaTimezoneSchema.optional(),
   folderId: z.string().describe('The ID of the folder to create the document in').optional(),
+  attachments: z
+    .array(
+      z.object({
+        label: z.string().min(1, 'Label is required'),
+        data: z.string().url('Must be a valid URL'),
+        type: ZEnvelopeAttachmentTypeSchema.optional().default('link'),
+      }),
+    )
+    .optional(),
 });
 
 export const ZCreateDocumentResponseSchema = z.object({

packages/trpc/server/document-router/router.ts

@@ -1,5 +1,9 @@
 import { router } from '../trpc';
 import { accessAuthRequest2FAEmailRoute } from './access-auth-request-2fa-email';
+import { createAttachmentRoute } from './attachment/create-attachment';
+import { deleteAttachmentRoute } from './attachment/delete-attachment';
+import { findAttachmentsRoute } from './attachment/find-attachments';
+import { updateAttachmentRoute } from './attachment/update-attachment';
 import { createDocumentRoute } from './create-document';
 import { createDocumentTemporaryRoute } from './create-document-temporary';
 import { deleteDocumentRoute } from './delete-document';
@@ -53,4 +57,10 @@ export const documentRouter = router({
     find: findInboxRoute,
     getCount: getInboxCountRoute,
   }),
+  attachment: {
+    create: createAttachmentRoute,
+    update: updateAttachmentRoute,
+    delete: deleteAttachmentRoute,
+    find: findAttachmentsRoute,
+  },
 });