feat: migrate templates and documents to envelope model

packages/app-tests/e2e/api/v1/document-sending.spec.ts

@@ -2,6 +2,7 @@ import { expect, test } from '@playwright/test';
 
 import { NEXT_PUBLIC_WEBAPP_URL } from '@documenso/lib/constants/app';
 import { createApiToken } from '@documenso/lib/server-only/public-api/create-api-token';
+import { mapSecondaryIdToDocumentId } from '@documenso/lib/utils/envelope';
 import { prisma } from '@documenso/prisma';
 import { seedPendingDocumentWithFullFields } from '@documenso/prisma/seed/documents';
 import { seedUser } from '@documenso/prisma/seed/users';
@@ -25,7 +26,7 @@ test.describe('Document API', () => {
 
     // Test with sendCompletionEmails: false
     const response = await request.post(
-      `${NEXT_PUBLIC_WEBAPP_URL()}/api/v1/documents/${document.id}/send`,
+      `${NEXT_PUBLIC_WEBAPP_URL()}/api/v1/documents/${mapSecondaryIdToDocumentId(document.secondaryId)}/send`,
       {
         headers: {
           Authorization: `Bearer ${token}`,
@@ -41,7 +42,7 @@ test.describe('Document API', () => {
     expect(response.status()).toBe(200);
 
     // Verify email settings were updated
-    const updatedDocument = await prisma.document.findUnique({
+    const updatedDocument = await prisma.envelope.findUnique({
       where: { id: document.id },
       include: { documentMeta: true },
     });
@@ -53,7 +54,7 @@ test.describe('Document API', () => {
 
     // Test with sendCompletionEmails: true
     const response2 = await request.post(
-      `${NEXT_PUBLIC_WEBAPP_URL()}/api/v1/documents/${document.id}/send`,
+      `${NEXT_PUBLIC_WEBAPP_URL()}/api/v1/documents/${mapSecondaryIdToDocumentId(document.secondaryId)}/send`,
       {
         headers: {
           Authorization: `Bearer ${token}`,
@@ -69,7 +70,7 @@ test.describe('Document API', () => {
     expect(response2.status()).toBe(200);
 
     // Verify email settings were updated
-    const updatedDocument2 = await prisma.document.findUnique({
+    const updatedDocument2 = await prisma.envelope.findUnique({
       where: { id: document.id },
       include: { documentMeta: true },
     });
@@ -93,16 +94,16 @@ test.describe('Document API', () => {
 
     // Set initial email settings
     await prisma.documentMeta.upsert({
-      where: { documentId: document.id },
+      where: { id: document.documentMetaId },
       create: {
-        documentId: document.id,
+        id: document.documentMetaId,
         emailSettings: {
           documentCompleted: true,
           ownerDocumentCompleted: false,
         },
       },
       update: {
-        documentId: document.id,
+        id: document.documentMetaId,
         emailSettings: {
           documentCompleted: true,
           ownerDocumentCompleted: false,
@@ -118,7 +119,7 @@ test.describe('Document API', () => {
     });
 
     const response = await request.post(
-      `${NEXT_PUBLIC_WEBAPP_URL()}/api/v1/documents/${document.id}/send`,
+      `${NEXT_PUBLIC_WEBAPP_URL()}/api/v1/documents/${mapSecondaryIdToDocumentId(document.secondaryId)}/send`,
       {
         headers: {
           Authorization: `Bearer ${token}`,
@@ -134,7 +135,7 @@ test.describe('Document API', () => {
     expect(response.status()).toBe(200);
 
     // Verify email settings were not modified
-    const updatedDocument = await prisma.document.findUnique({
+    const updatedDocument = await prisma.envelope.findUnique({
       where: { id: document.id },
       include: { documentMeta: true },
     });

packages/app-tests/e2e/api/v1/template-field-prefill.spec.ts

@@ -3,6 +3,11 @@ import { expect, test } from '@playwright/test';
 import { NEXT_PUBLIC_WEBAPP_URL } from '@documenso/lib/constants/app';
 import { createApiToken } from '@documenso/lib/server-only/public-api/create-api-token';
 import type { TCheckboxFieldMeta, TRadioFieldMeta } from '@documenso/lib/types/field-meta';
+import {
+  mapDocumentIdToSecondaryId,
+  mapSecondaryIdToDocumentId,
+  mapSecondaryIdToTemplateId,
+} from '@documenso/lib/utils/envelope';
 import { prisma } from '@documenso/prisma';
 import { FieldType, RecipientRole } from '@documenso/prisma/client';
 import { seedBlankTemplate } from '@documenso/prisma/seed/templates';
@@ -35,10 +40,12 @@ test.describe('Template Field Prefill API v1', () => {
       },
     });
 
+    const firstEnvelopeItem = template.envelopeItems[0];
+
     // 4. Create a recipient for the template
     const recipient = await prisma.recipient.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
         email: 'recipient@example.com',
         name: 'Test Recipient',
         role: RecipientRole.SIGNER,
@@ -53,7 +60,8 @@ test.describe('Template Field Prefill API v1', () => {
     // Add TEXT field
     const textField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.TEXT,
         page: 1,
@@ -73,7 +81,8 @@ test.describe('Template Field Prefill API v1', () => {
     // Add NUMBER field
     const numberField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.NUMBER,
         page: 1,
@@ -93,7 +102,8 @@ test.describe('Template Field Prefill API v1', () => {
     // Add RADIO field
     const radioField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.RADIO,
         page: 1,
@@ -117,7 +127,8 @@ test.describe('Template Field Prefill API v1', () => {
     // Add CHECKBOX field
     const checkboxField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.CHECKBOX,
         page: 1,
@@ -141,7 +152,8 @@ test.describe('Template Field Prefill API v1', () => {
     // Add DROPDOWN field
     const dropdownField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.DROPDOWN,
         page: 1,
@@ -166,11 +178,13 @@ test.describe('Template Field Prefill API v1', () => {
     });
 
     // 7. Navigate to the template
-    await page.goto(`${WEBAPP_BASE_URL}/templates/${template.id}`);
+    await page.goto(
+      `${WEBAPP_BASE_URL}/templates/${mapSecondaryIdToTemplateId(template.secondaryId)}`,
+    );
 
     // 8. Create a document from the template with prefilled fields
     const response = await request.post(
-      `${WEBAPP_BASE_URL}/api/v1/templates/${template.id}/generate-document`,
+      `${WEBAPP_BASE_URL}/api/v1/templates/${mapSecondaryIdToTemplateId(template.secondaryId)}/generate-document`,
       {
         headers: {
           Authorization: `Bearer ${token}`,
@@ -229,9 +243,9 @@ test.describe('Template Field Prefill API v1', () => {
     expect(responseData.documentId).toBeDefined();
 
     // 9. Verify the document was created with prefilled fields
-    const document = await prisma.document.findUnique({
+    const document = await prisma.envelope.findUnique({
       where: {
-        id: responseData.documentId,
+        secondaryId: mapDocumentIdToSecondaryId(responseData.documentId),
       },
       include: {
         fields: true,
@@ -240,6 +254,10 @@ test.describe('Template Field Prefill API v1', () => {
 
     expect(document).not.toBeNull();
 
+    if (!document) {
+      throw new Error('Document not found');
+    }
+
     // 10. Verify each field has the correct prefilled values
     const documentTextField = document?.fields.find(
       (field) => field.type === FieldType.TEXT && field.fieldMeta?.type === 'text',
@@ -297,14 +315,14 @@ test.describe('Template Field Prefill API v1', () => {
     // 11. Sign in as the recipient and verify the prefilled fields are visible
     const documentRecipient = await prisma.recipient.findFirst({
       where: {
-        documentId: document?.id,
+        envelopeId: document?.id,
         email: 'recipient@example.com',
       },
     });
 
     // Send the document to the recipient
     const sendResponse = await request.post(
-      `${WEBAPP_BASE_URL}/api/v1/documents/${document?.id}/send`,
+      `${WEBAPP_BASE_URL}/api/v1/documents/${mapSecondaryIdToDocumentId(document.secondaryId)}/send`,
       {
         headers: {
           Authorization: `Bearer ${token}`,
@@ -367,10 +385,12 @@ test.describe('Template Field Prefill API v1', () => {
       },
     });
 
+    const firstEnvelopeItem = template.envelopeItems[0];
+
     // 4. Create a recipient for the template
     const recipient = await prisma.recipient.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
         email: 'recipient@example.com',
         name: 'Test Recipient',
         role: RecipientRole.SIGNER,
@@ -385,7 +405,8 @@ test.describe('Template Field Prefill API v1', () => {
     // Add TEXT field
     await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.TEXT,
         page: 1,
@@ -405,7 +426,8 @@ test.describe('Template Field Prefill API v1', () => {
     // Add NUMBER field
     await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.NUMBER,
         page: 1,
@@ -429,11 +451,13 @@ test.describe('Template Field Prefill API v1', () => {
     });
 
     // 7. Navigate to the template
-    await page.goto(`${WEBAPP_BASE_URL}/templates/${template.id}`);
+    await page.goto(
+      `${WEBAPP_BASE_URL}/templates/${mapSecondaryIdToTemplateId(template.secondaryId)}`,
+    );
 
     // 8. Create a document from the template without prefilled fields
     const response = await request.post(
-      `${WEBAPP_BASE_URL}/api/v1/templates/${template.id}/generate-document`,
+      `${WEBAPP_BASE_URL}/api/v1/templates/${mapSecondaryIdToTemplateId(template.secondaryId)}/generate-document`,
       {
         headers: {
           Authorization: `Bearer ${token}`,
@@ -461,9 +485,9 @@ test.describe('Template Field Prefill API v1', () => {
     expect(responseData.documentId).toBeDefined();
 
     // 9. Verify the document was created with default fields
-    const document = await prisma.document.findUnique({
+    const document = await prisma.envelope.findUnique({
       where: {
-        id: responseData.documentId,
+        secondaryId: mapDocumentIdToSecondaryId(responseData.documentId),
       },
       include: {
         fields: true,
@@ -472,6 +496,10 @@ test.describe('Template Field Prefill API v1', () => {
 
     expect(document).not.toBeNull();
 
+    if (!document) {
+      throw new Error('Document not found');
+    }
+
     // 10. Verify fields have their default values
     const documentTextField = document?.fields.find((field) => field.type === FieldType.TEXT);
     expect(documentTextField?.fieldMeta).toMatchObject({
@@ -488,7 +516,7 @@ test.describe('Template Field Prefill API v1', () => {
     // 11. Sign in as the recipient and verify the default fields are visible
     const documentRecipient = await prisma.recipient.findFirst({
       where: {
-        documentId: document?.id,
+        envelopeId: document?.id,
         email: 'recipient@example.com',
       },
     });
@@ -496,7 +524,7 @@ test.describe('Template Field Prefill API v1', () => {
     expect(documentRecipient).not.toBeNull();
 
     const sendResponse = await request.post(
-      `${WEBAPP_BASE_URL}/api/v1/documents/${document?.id}/send`,
+      `${WEBAPP_BASE_URL}/api/v1/documents/${mapSecondaryIdToDocumentId(document.secondaryId)}/send`,
       {
         headers: {
           Authorization: `Bearer ${token}`,
@@ -539,10 +567,12 @@ test.describe('Template Field Prefill API v1', () => {
       },
     });
 
+    const firstEnvelopeItem = template.envelopeItems[0];
+
     // 4. Create a recipient for the template
     const recipient = await prisma.recipient.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
         email: 'recipient@example.com',
         name: 'Test Recipient',
         role: RecipientRole.SIGNER,
@@ -556,7 +586,8 @@ test.describe('Template Field Prefill API v1', () => {
     // 5. Add a field to the template
     const field = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.RADIO,
         page: 1,
@@ -579,7 +610,7 @@ test.describe('Template Field Prefill API v1', () => {
 
     // 6. Try to create a document with invalid prefill value
     const response = await request.post(
-      `${WEBAPP_BASE_URL}/api/v1/templates/${template.id}/generate-document`,
+      `${WEBAPP_BASE_URL}/api/v1/templates/${mapSecondaryIdToTemplateId(template.secondaryId)}/generate-document`,
       {
         headers: {
           Authorization: `Bearer ${token}`,

packages/app-tests/e2e/api/v2/template-field-prefill.spec.ts

@@ -3,6 +3,11 @@ import { expect, test } from '@playwright/test';
 import { NEXT_PUBLIC_WEBAPP_URL } from '@documenso/lib/constants/app';
 import { createApiToken } from '@documenso/lib/server-only/public-api/create-api-token';
 import type { TCheckboxFieldMeta, TRadioFieldMeta } from '@documenso/lib/types/field-meta';
+import {
+  mapDocumentIdToSecondaryId,
+  mapSecondaryIdToDocumentId,
+  mapSecondaryIdToTemplateId,
+} from '@documenso/lib/utils/envelope';
 import { prisma } from '@documenso/prisma';
 import { FieldType, RecipientRole } from '@documenso/prisma/client';
 import { seedBlankTemplate } from '@documenso/prisma/seed/templates';
@@ -35,10 +40,12 @@ test.describe('Template Field Prefill API v2', () => {
       },
     });
 
+    const firstEnvelopeItem = template.envelopeItems[0];
+
     // 4. Create a recipient for the template
     const recipient = await prisma.recipient.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
         email: 'recipient@example.com',
         name: 'Test Recipient',
         role: RecipientRole.SIGNER,
@@ -53,7 +60,8 @@ test.describe('Template Field Prefill API v2', () => {
     // Add TEXT field
     const textField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.TEXT,
         page: 1,
@@ -73,7 +81,8 @@ test.describe('Template Field Prefill API v2', () => {
     // Add NUMBER field
     const numberField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.NUMBER,
         page: 1,
@@ -93,7 +102,8 @@ test.describe('Template Field Prefill API v2', () => {
     // Add RADIO field
     const radioField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.RADIO,
         page: 1,
@@ -117,7 +127,8 @@ test.describe('Template Field Prefill API v2', () => {
     // Add CHECKBOX field
     const checkboxField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.CHECKBOX,
         page: 1,
@@ -141,7 +152,8 @@ test.describe('Template Field Prefill API v2', () => {
     // Add DROPDOWN field
     const dropdownField = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.DROPDOWN,
         page: 1,
@@ -166,7 +178,9 @@ test.describe('Template Field Prefill API v2', () => {
     });
 
     // 7. Navigate to the template
-    await page.goto(`${WEBAPP_BASE_URL}/templates/${template.id}`);
+    await page.goto(
+      `${WEBAPP_BASE_URL}/templates/${mapSecondaryIdToTemplateId(template.secondaryId)}`,
+    );
 
     // 8. Create a document from the template with prefilled fields using v2 API
     const response = await request.post(`${WEBAPP_BASE_URL}/api/v2-beta/template/use`, {
@@ -175,7 +189,7 @@ test.describe('Template Field Prefill API v2', () => {
         'Content-Type': 'application/json',
       },
       data: {
-        templateId: template.id,
+        templateId: mapSecondaryIdToTemplateId(template.secondaryId),
         recipients: [
           {
             id: recipient.id,
@@ -226,9 +240,9 @@ test.describe('Template Field Prefill API v2', () => {
     expect(responseData.id).toBeDefined();
 
     // 9. Verify the document was created with prefilled fields
-    const document = await prisma.document.findUnique({
+    const document = await prisma.envelope.findUnique({
       where: {
-        id: responseData.id,
+        secondaryId: mapDocumentIdToSecondaryId(responseData.id),
       },
       include: {
         fields: true,
@@ -237,6 +251,10 @@ test.describe('Template Field Prefill API v2', () => {
 
     expect(document).not.toBeNull();
 
+    if (!document) {
+      throw new Error('Document not found');
+    }
+
     // 10. Verify each field has the correct prefilled values
     const documentTextField = document?.fields.find(
       (field) => field.type === FieldType.TEXT && field.fieldMeta?.type === 'text',
@@ -297,7 +315,7 @@ test.describe('Template Field Prefill API v2', () => {
         'Content-Type': 'application/json',
       },
       data: {
-        documentId: document?.id,
+        documentId: mapSecondaryIdToDocumentId(document?.secondaryId),
         meta: {
           subject: 'Test Subject',
           message: 'Test Message',
@@ -311,7 +329,7 @@ test.describe('Template Field Prefill API v2', () => {
     // 11. Sign in as the recipient and verify the prefilled fields are visible
     const documentRecipient = await prisma.recipient.findFirst({
       where: {
-        documentId: document?.id,
+        envelopeId: document?.id,
         email: 'recipient@example.com',
       },
     });
@@ -364,10 +382,12 @@ test.describe('Template Field Prefill API v2', () => {
       },
     });
 
+    const firstEnvelopeItem = template.envelopeItems[0];
+
     // 4. Create a recipient for the template
     const recipient = await prisma.recipient.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
         email: 'recipient@example.com',
         name: 'Test Recipient',
         role: RecipientRole.SIGNER,
@@ -382,7 +402,8 @@ test.describe('Template Field Prefill API v2', () => {
     // Add TEXT field
     await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.TEXT,
         page: 1,
@@ -402,7 +423,8 @@ test.describe('Template Field Prefill API v2', () => {
     // Add NUMBER field
     await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.NUMBER,
         page: 1,
@@ -426,7 +448,9 @@ test.describe('Template Field Prefill API v2', () => {
     });
 
     // 7. Navigate to the template
-    await page.goto(`${WEBAPP_BASE_URL}/templates/${template.id}`);
+    await page.goto(
+      `${WEBAPP_BASE_URL}/templates/${mapSecondaryIdToTemplateId(template.secondaryId)}`,
+    );
 
     // 8. Create a document from the template without prefilled fields using v2 API
     const response = await request.post(`${WEBAPP_BASE_URL}/api/v2-beta/template/use`, {
@@ -435,7 +459,7 @@ test.describe('Template Field Prefill API v2', () => {
         'Content-Type': 'application/json',
       },
       data: {
-        templateId: template.id,
+        templateId: mapSecondaryIdToTemplateId(template.secondaryId),
         recipients: [
           {
             id: recipient.id,
@@ -454,9 +478,9 @@ test.describe('Template Field Prefill API v2', () => {
     expect(responseData.id).toBeDefined();
 
     // 9. Verify the document was created with default fields
-    const document = await prisma.document.findUnique({
+    const document = await prisma.envelope.findUnique({
       where: {
-        id: responseData.id,
+        secondaryId: mapDocumentIdToSecondaryId(responseData.id),
       },
       include: {
         fields: true,
@@ -465,6 +489,10 @@ test.describe('Template Field Prefill API v2', () => {
 
     expect(document).not.toBeNull();
 
+    if (!document) {
+      throw new Error('Document not found');
+    }
+
     // 10. Verify fields have their default values
     const documentTextField = document?.fields.find((field) => field.type === FieldType.TEXT);
     expect(documentTextField?.fieldMeta).toMatchObject({
@@ -484,7 +512,7 @@ test.describe('Template Field Prefill API v2', () => {
         'Content-Type': 'application/json',
       },
       data: {
-        documentId: document?.id,
+        documentId: mapSecondaryIdToDocumentId(document?.secondaryId),
         meta: {
           subject: 'Test Subject',
           message: 'Test Message',
@@ -498,7 +526,7 @@ test.describe('Template Field Prefill API v2', () => {
     // 11. Sign in as the recipient and verify the default fields are visible
     const documentRecipient = await prisma.recipient.findFirst({
       where: {
-        documentId: document?.id,
+        envelopeId: document?.id,
         email: 'recipient@example.com',
       },
     });
@@ -531,10 +559,12 @@ test.describe('Template Field Prefill API v2', () => {
       },
     });
 
+    const firstEnvelopeItem = template.envelopeItems[0];
+
     // 4. Create a recipient for the template
     const recipient = await prisma.recipient.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
         email: 'recipient@example.com',
         name: 'Test Recipient',
         role: RecipientRole.SIGNER,
@@ -548,7 +578,8 @@ test.describe('Template Field Prefill API v2', () => {
     // 5. Add a field to the template
     const field = await prisma.field.create({
       data: {
-        templateId: template.id,
+        envelopeId: template.id,
+        envelopeItemId: firstEnvelopeItem.id,
         recipientId: recipient.id,
         type: FieldType.RADIO,
         page: 1,
@@ -576,7 +607,7 @@ test.describe('Template Field Prefill API v2', () => {
         'Content-Type': 'application/json',
       },
       data: {
-        templateId: template.id,
+        templateId: mapSecondaryIdToTemplateId(template.secondaryId),
         recipients: [
           {
             id: recipient.id,