feat: add envelope editor

packages/lib/server-only/field/get-completed-fields-for-token.ts

@@ -6,7 +6,7 @@ export type GetCompletedFieldsForTokenOptions = {
   token: string;
 };
 
-// Todo: Envelopes - This needs to be redone since we need to determine which document to show the fields on.
+// Note: You many need to filter this on a per envelope item ID basis.
 export const getCompletedFieldsForToken = async ({ token }: GetCompletedFieldsForTokenOptions) => {
   return await prisma.field.findMany({
     where: {

packages/lib/server-only/field/get-fields-for-token.ts

@@ -6,7 +6,7 @@ export type GetFieldsForTokenOptions = {
   token: string;
 };
 
-// Todo: Envelopes, this will return all fields, might need to filter based on actual documentId.
+// Note: You many need to filter this on a per envelope item ID basis.
 export const getFieldsForToken = async ({ token }: GetFieldsForTokenOptions) => {
   if (!token) {
     throw new Error('Missing token');

packages/lib/server-only/field/set-fields-for-document.ts

@@ -24,13 +24,14 @@ import {
 import { prisma } from '@documenso/prisma';
 
 import { AppError, AppErrorCode } from '../../errors/app-error';
+import type { EnvelopeIdOptions } from '../../utils/envelope';
 import { canRecipientFieldsBeModified } from '../../utils/recipients';
 import { getEnvelopeWhereInput } from '../envelope/get-envelope-by-id';
 
 export interface SetFieldsForDocumentOptions {
   userId: number;
   teamId: number;
-  documentId: number;
+  id: EnvelopeIdOptions;
   fields: FieldData[];
   requestMetadata: ApiRequestMetadata;
 }
@@ -38,15 +39,12 @@ export interface SetFieldsForDocumentOptions {
 export const setFieldsForDocument = async ({
   userId,
   teamId,
-  documentId,
+  id,
   fields,
   requestMetadata,
 }: SetFieldsForDocumentOptions) => {
   const { envelopeWhereInput } = await getEnvelopeWhereInput({
-    id: {
-      type: 'documentId',
-      id: documentId,
-    },
+    id,
     type: EnvelopeType.DOCUMENT,
     userId,
     teamId,
@@ -69,10 +67,7 @@ export const setFieldsForDocument = async ({
     },
   });
 
-  // Todo: Envelopes
-  const firstEnvelopeItemId = envelope?.envelopeItems[0]?.id;
-
-  if (!envelope || !firstEnvelopeItemId) {
+  if (!envelope) {
     throw new AppError(AppErrorCode.NOT_FOUND, {
       message: 'Document not found',
     });
@@ -95,6 +90,17 @@ export const setFieldsForDocument = async ({
 
     const recipient = envelope.recipients.find((recipient) => recipient.id === field.recipientId);
 
+    // Check whether the field is being attached to an allowed envelope item.
+    const foundEnvelopeItem = envelope.envelopeItems.find(
+      (envelopeItem) => envelopeItem.id === field.envelopeItemId,
+    );
+
+    if (!foundEnvelopeItem) {
+      throw new AppError(AppErrorCode.INVALID_REQUEST, {
+        message: `Envelope item ${field.envelopeItemId} not found`,
+      });
+    }
+
     // Each field MUST have a recipient associated with it.
     if (!recipient) {
       throw new AppError(AppErrorCode.INVALID_REQUEST, {
@@ -114,6 +120,14 @@ export const setFieldsForDocument = async ({
       });
     }
 
+    // Prevent creating new fields when recipient has interacted with the document.
+    if (!existing && !canRecipientFieldsBeModified(recipient, existingFields)) {
+      throw new AppError(AppErrorCode.INVALID_REQUEST, {
+        message:
+          'Cannot modify a field where the recipient has already interacted with the document',
+      });
+    }
+
     return {
       ...field,
       _persisted: existing,
@@ -124,7 +138,7 @@ export const setFieldsForDocument = async ({
   const persistedFields = await prisma.$transaction(async (tx) => {
     return await Promise.all(
       linkedFields.map(async (field) => {
-        const fieldSignerEmail = field.signerEmail.toLowerCase();
+        const fieldSignerEmail = field._recipient.email.toLowerCase();
 
         const parsedFieldMeta = field.fieldMeta
           ? ZFieldMetaSchema.parse(field.fieldMeta)
@@ -207,6 +221,7 @@ export const setFieldsForDocument = async ({
           where: {
             id: field._persisted?.id ?? -1,
             envelopeId: envelope.id,
+            envelopeItemId: field.envelopeItemId,
           },
           update: {
             page: field.pageNumber,
@@ -217,8 +232,6 @@ export const setFieldsForDocument = async ({
             fieldMeta: parsedFieldMeta,
           },
           create: {
-            envelopeId: envelope.id,
-            envelopeItemId: firstEnvelopeItemId, // Todo: Envelopes
             type: field.type,
             page: field.pageNumber,
             positionX: field.pageX,
@@ -228,7 +241,23 @@ export const setFieldsForDocument = async ({
             customText: '',
             inserted: false,
             fieldMeta: parsedFieldMeta,
-            recipientId: field._recipient.id,
+            envelope: {
+              connect: {
+                id: envelope.id,
+              },
+            },
+            envelopeItem: {
+              connect: {
+                id: field.envelopeItemId,
+                envelopeId: envelope.id,
+              },
+            },
+            recipient: {
+              connect: {
+                id: field._recipient.id,
+                envelopeId: envelope.id,
+              },
+            },
           },
         });
 
@@ -325,8 +354,8 @@ export const setFieldsForDocument = async ({
  */
 type FieldData = {
   id?: number | null;
+  envelopeItemId: string;
   type: FieldType;
-  signerEmail: string;
   recipientId: number;
   pageNumber: number;
   pageX: number;
@@ -341,6 +370,7 @@ const hasFieldBeenChanged = (field: Field, newFieldData: FieldData) => {
   const newFieldMeta = newFieldData.fieldMeta || null;
 
   return (
+    field.envelopeItemId !== newFieldData.envelopeItemId ||
     field.type !== newFieldData.type ||
     field.page !== newFieldData.pageNumber ||
     field.positionX.toNumber() !== newFieldData.pageX ||

packages/lib/server-only/field/set-fields-for-template.ts

@@ -16,16 +16,18 @@ import {
 } from '@documenso/lib/types/field-meta';
 import { prisma } from '@documenso/prisma';
 
+import { AppError, AppErrorCode } from '../../errors/app-error';
+import type { EnvelopeIdOptions } from '../../utils/envelope';
 import { getEnvelopeWhereInput } from '../envelope/get-envelope-by-id';
 
 export type SetFieldsForTemplateOptions = {
   userId: number;
   teamId: number;
-  templateId: number;
+  id: EnvelopeIdOptions;
   fields: {
     id?: number | null;
+    envelopeItemId: string;
     type: FieldType;
-    signerEmail: string;
     recipientId: number;
     pageNumber: number;
     pageX: number;
@@ -39,14 +41,11 @@ export type SetFieldsForTemplateOptions = {
 export const setFieldsForTemplate = async ({
   userId,
   teamId,
-  templateId,
+  id,
   fields,
 }: SetFieldsForTemplateOptions) => {
   const { envelopeWhereInput } = await getEnvelopeWhereInput({
-    id: {
-      type: 'templateId',
-      id: templateId,
-    },
+    id,
     type: EnvelopeType.TEMPLATE,
     userId,
     teamId,
@@ -55,6 +54,7 @@ export const setFieldsForTemplate = async ({
   const envelope = await prisma.envelope.findFirst({
     where: envelopeWhereInput,
     include: {
+      recipients: true,
       envelopeItems: {
         select: {
           id: true,
@@ -68,11 +68,10 @@ export const setFieldsForTemplate = async ({
     },
   });
 
-  // Todo: Envelopes
-  const firstEnvelopeItemId = envelope?.envelopeItems[0]?.id;
-
-  if (!envelope || !firstEnvelopeItemId) {
-    throw new Error('Template not found');
+  if (!envelope) {
+    throw new AppError(AppErrorCode.NOT_FOUND, {
+      message: 'Document not found',
+    });
   }
 
   const existingFields = envelope.fields;
@@ -84,9 +83,30 @@ export const setFieldsForTemplate = async ({
   const linkedFields = fields.map((field) => {
     const existing = existingFields.find((existingField) => existingField.id === field.id);
 
+    const recipient = envelope.recipients.find((recipient) => recipient.id === field.recipientId);
+
+    // Check whether the field is being attached to an allowed envelope item.
+    const foundEnvelopeItem = envelope.envelopeItems.find(
+      (envelopeItem) => envelopeItem.id === field.envelopeItemId,
+    );
+
+    if (!foundEnvelopeItem) {
+      throw new AppError(AppErrorCode.INVALID_REQUEST, {
+        message: `Envelope item ${field.envelopeItemId} not found`,
+      });
+    }
+
+    // Each field MUST have a recipient associated with it.
+    if (!recipient) {
+      throw new AppError(AppErrorCode.INVALID_REQUEST, {
+        message: `Recipient not found for field ${field.id}`,
+      });
+    }
+
     return {
       ...field,
       _persisted: existing,
+      _recipient: recipient,
     };
   });
 
@@ -159,7 +179,7 @@ export const setFieldsForTemplate = async ({
         where: {
           id: field._persisted?.id ?? -1,
           envelopeId: envelope.id,
-          envelopeItemId: firstEnvelopeItemId, // Todo: Envelopes
+          envelopeItemId: field.envelopeItemId,
         },
         update: {
           page: field.pageNumber,
@@ -186,12 +206,13 @@ export const setFieldsForTemplate = async ({
           },
           envelopeItem: {
             connect: {
-              id: firstEnvelopeItemId, // Todo: Envelopes
+              id: field.envelopeItemId,
+              envelopeId: envelope.id,
             },
           },
           recipient: {
             connect: {
-              id: field.recipientId,
+              id: field._recipient.id,
               envelopeId: envelope.id,
             },
           },