feat: allow for the deletion of any document (#711)

Allow for the deletion of any document with notifications of document cancellation for pending documents.

packages/prisma/migrations/20231202134005_deletedocuments/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Document" ADD COLUMN     "deletedAt" TIMESTAMP(3);

packages/prisma/schema.prisma

@@ -135,6 +135,7 @@ model Document {
   createdAt      DateTime            @default(now())
   updatedAt      DateTime            @default(now()) @updatedAt
   completedAt    DateTime?
+  deletedAt      DateTime?
 
   @@unique([documentDataId])
   @@index([userId])

packages/prisma/seed-database.ts

@@ -1,74 +1,22 @@
-import { DocumentDataType, Role } from '@prisma/client';
 import fs from 'node:fs';
 import path from 'node:path';
 
-import { hashSync } from '@documenso/lib/server-only/auth/hash';
-
-import { prisma } from './index';
-
 const seedDatabase = async () => {
-  const examplePdf = fs
-    .readFileSync(path.join(__dirname, '../../assets/example.pdf'))
-    .toString('base64');
+  const files = fs.readdirSync(path.join(__dirname, './seed'));
 
-  const exampleUser = await prisma.user.upsert({
-    where: {
-      email: 'example@documenso.com',
-    },
-    create: {
-      name: 'Example User',
-      email: 'example@documenso.com',
-      password: hashSync('password'),
-      roles: [Role.USER],
-    },
-    update: {},
-  });
+  for (const file of files) {
+    const stat = fs.statSync(path.join(__dirname, './seed', file));
 
-  const adminUser = await prisma.user.upsert({
-    where: {
-      email: 'admin@documenso.com',
-    },
-    create: {
-      name: 'Admin User',
-      email: 'admin@documenso.com',
-      password: hashSync('password'),
-      roles: [Role.USER, Role.ADMIN],
-    },
-    update: {},
-  });
+    if (stat.isFile()) {
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      const mod = require(path.join(__dirname, './seed', file));
 
-  const examplePdfData = await prisma.documentData.upsert({
-    where: {
-      id: 'clmn0kv5k0000pe04vcqg5zla',
-    },
-    create: {
-      id: 'clmn0kv5k0000pe04vcqg5zla',
-      type: DocumentDataType.BYTES_64,
-      data: examplePdf,
-      initialData: examplePdf,
-    },
-    update: {},
-  });
-
-  await prisma.document.upsert({
-    where: {
-      id: 1,
-    },
-    create: {
-      id: 1,
-      title: 'Example Document',
-      documentDataId: examplePdfData.id,
-      userId: exampleUser.id,
-      Recipient: {
-        create: {
-          name: String(adminUser.name),
-          email: adminUser.email,
-          token: Math.random().toString(36).slice(2, 9),
-        },
-      },
-    },
-    update: {},
-  });
+      if ('seedDatabase' in mod && typeof mod.seedDatabase === 'function') {
+        console.log(`[SEEDING]: ${file}`);
+        await mod.seedDatabase();
+      }
+    }
+  }
 };
 
 seedDatabase()

packages/prisma/seed/initial-seed.ts

@@ -0,0 +1,67 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+import { hashSync } from '@documenso/lib/server-only/auth/hash';
+
+import { prisma } from '..';
+import { DocumentDataType, Role } from '../client';
+
+export const seedDatabase = async () => {
+  const examplePdf = fs
+    .readFileSync(path.join(__dirname, '../../../assets/example.pdf'))
+    .toString('base64');
+
+  const exampleUser = await prisma.user.upsert({
+    where: {
+      email: 'example@documenso.com',
+    },
+    create: {
+      name: 'Example User',
+      email: 'example@documenso.com',
+      password: hashSync('password'),
+      roles: [Role.USER],
+    },
+    update: {},
+  });
+
+  const adminUser = await prisma.user.upsert({
+    where: {
+      email: 'admin@documenso.com',
+    },
+    create: {
+      name: 'Admin User',
+      email: 'admin@documenso.com',
+      password: hashSync('password'),
+      roles: [Role.USER, Role.ADMIN],
+    },
+    update: {},
+  });
+
+  const examplePdfData = await prisma.documentData.upsert({
+    where: {
+      id: 'clmn0kv5k0000pe04vcqg5zla',
+    },
+    create: {
+      id: 'clmn0kv5k0000pe04vcqg5zla',
+      type: DocumentDataType.BYTES_64,
+      data: examplePdf,
+      initialData: examplePdf,
+    },
+    update: {},
+  });
+
+  await prisma.document.create({
+    data: {
+      title: 'Example Document',
+      documentDataId: examplePdfData.id,
+      userId: exampleUser.id,
+      Recipient: {
+        create: {
+          name: String(adminUser.name),
+          email: adminUser.email,
+          token: Math.random().toString(36).slice(2, 9),
+        },
+      },
+    },
+  });
+};

packages/prisma/seed/pr-711-deletion-of-documents.ts

@@ -0,0 +1,221 @@
+import type { User } from '@prisma/client';
+import fs from 'node:fs';
+import path from 'node:path';
+
+import { hashSync } from '@documenso/lib/server-only/auth/hash';
+
+import { prisma } from '..';
+import {
+  DocumentDataType,
+  DocumentStatus,
+  FieldType,
+  Prisma,
+  ReadStatus,
+  SendStatus,
+  SigningStatus,
+} from '../client';
+
+const PULL_REQUEST_NUMBER = 711;
+const EMAIL_DOMAIN = `pr-${PULL_REQUEST_NUMBER}.documenso.com`;
+
+export const TEST_USERS = [
+  {
+    name: 'Sender 1',
+    email: `sender1@${EMAIL_DOMAIN}`,
+    password: 'Password123',
+  },
+  {
+    name: 'Sender 2',
+    email: `sender2@${EMAIL_DOMAIN}`,
+    password: 'Password123',
+  },
+  {
+    name: 'Sender 3',
+    email: `sender3@${EMAIL_DOMAIN}`,
+    password: 'Password123',
+  },
+] as const;
+
+const examplePdf = fs
+  .readFileSync(path.join(__dirname, '../../../assets/example.pdf'))
+  .toString('base64');
+
+export const seedDatabase = async () => {
+  const users = await Promise.all(
+    TEST_USERS.map(async (u) =>
+      prisma.user.create({
+        data: {
+          name: u.name,
+          email: u.email,
+          password: hashSync(u.password),
+          emailVerified: new Date(),
+        },
+      }),
+    ),
+  );
+
+  const [user1, user2, user3] = users;
+
+  await createDraftDocument(user1, [user2, user3]);
+  await createPendingDocument(user1, [user2, user3]);
+  await createCompletedDocument(user1, [user2, user3]);
+};
+
+const createDraftDocument = async (sender: User, recipients: User[]) => {
+  const documentData = await prisma.documentData.create({
+    data: {
+      type: DocumentDataType.BYTES_64,
+      data: examplePdf,
+      initialData: examplePdf,
+    },
+  });
+
+  const document = await prisma.document.create({
+    data: {
+      title: `[${PULL_REQUEST_NUMBER}] Document 1 - Draft`,
+      status: DocumentStatus.DRAFT,
+      documentDataId: documentData.id,
+      userId: sender.id,
+    },
+  });
+
+  for (const recipient of recipients) {
+    const index = recipients.indexOf(recipient);
+
+    await prisma.recipient.create({
+      data: {
+        email: String(recipient.email),
+        name: String(recipient.name),
+        token: `draft-token-${index}`,
+        readStatus: ReadStatus.NOT_OPENED,
+        sendStatus: SendStatus.NOT_SENT,
+        signingStatus: SigningStatus.NOT_SIGNED,
+        signedAt: new Date(),
+        Document: {
+          connect: {
+            id: document.id,
+          },
+        },
+        Field: {
+          create: {
+            page: 1,
+            type: FieldType.NAME,
+            inserted: true,
+            customText: String(recipient.name),
+            positionX: new Prisma.Decimal(1),
+            positionY: new Prisma.Decimal(1),
+            width: new Prisma.Decimal(1),
+            height: new Prisma.Decimal(1),
+            documentId: document.id,
+          },
+        },
+      },
+    });
+  }
+};
+
+const createPendingDocument = async (sender: User, recipients: User[]) => {
+  const documentData = await prisma.documentData.create({
+    data: {
+      type: DocumentDataType.BYTES_64,
+      data: examplePdf,
+      initialData: examplePdf,
+    },
+  });
+
+  const document = await prisma.document.create({
+    data: {
+      title: `[${PULL_REQUEST_NUMBER}] Document 1 - Pending`,
+      status: DocumentStatus.PENDING,
+      documentDataId: documentData.id,
+      userId: sender.id,
+    },
+  });
+
+  for (const recipient of recipients) {
+    const index = recipients.indexOf(recipient);
+
+    await prisma.recipient.create({
+      data: {
+        email: String(recipient.email),
+        name: String(recipient.name),
+        token: `pending-token-${index}`,
+        readStatus: ReadStatus.OPENED,
+        sendStatus: SendStatus.SENT,
+        signingStatus: SigningStatus.SIGNED,
+        signedAt: new Date(),
+        Document: {
+          connect: {
+            id: document.id,
+          },
+        },
+        Field: {
+          create: {
+            page: 1,
+            type: FieldType.NAME,
+            inserted: true,
+            customText: String(recipient.name),
+            positionX: new Prisma.Decimal(1),
+            positionY: new Prisma.Decimal(1),
+            width: new Prisma.Decimal(1),
+            height: new Prisma.Decimal(1),
+            documentId: document.id,
+          },
+        },
+      },
+    });
+  }
+};
+
+const createCompletedDocument = async (sender: User, recipients: User[]) => {
+  const documentData = await prisma.documentData.create({
+    data: {
+      type: DocumentDataType.BYTES_64,
+      data: examplePdf,
+      initialData: examplePdf,
+    },
+  });
+
+  const document = await prisma.document.create({
+    data: {
+      title: `[${PULL_REQUEST_NUMBER}] Document 1 - Completed`,
+      status: DocumentStatus.COMPLETED,
+      documentDataId: documentData.id,
+      userId: sender.id,
+    },
+  });
+
+  for (const recipient of recipients) {
+    const index = recipients.indexOf(recipient);
+
+    await prisma.recipient.create({
+      data: {
+        email: String(recipient.email),
+        name: String(recipient.name),
+        token: `completed-token-${index}`,
+        readStatus: ReadStatus.OPENED,
+        sendStatus: SendStatus.SENT,
+        signingStatus: SigningStatus.SIGNED,
+        signedAt: new Date(),
+        Document: {
+          connect: {
+            id: document.id,
+          },
+        },
+        Field: {
+          create: {
+            page: 1,
+            type: FieldType.NAME,
+            inserted: true,
+            customText: String(recipient.name),
+            positionX: new Prisma.Decimal(1),
+            positionY: new Prisma.Decimal(1),
+            width: new Prisma.Decimal(1),
+            height: new Prisma.Decimal(1),
+            documentId: document.id,
+          },
+        },
+      },
+    });
+  }
+};