feat: restore deleted document

packages/lib/server-only/document/find-document-audit-logs.ts

@@ -64,6 +64,7 @@ export const findDocumentAuditLogs = async ({
             DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_COMPLETED,
             DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_CREATED,
             DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_DELETED,
+            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RESTORED,
             DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_OPENED,
             DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED,
             DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_SENT,

packages/lib/server-only/document/restore-document.ts

@@ -0,0 +1,204 @@
+'use server';
+
+import { createElement } from 'react';
+
+import { mailer } from '@documenso/email/mailer';
+import { render } from '@documenso/email/render';
+import DocumentRestoreTemplate from '@documenso/email/templates/document-restore';
+import { prisma } from '@documenso/prisma';
+import type { Document, DocumentMeta, Recipient, User } from '@documenso/prisma/client';
+import { DocumentStatus } from '@documenso/prisma/client';
+
+import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
+import { FROM_ADDRESS, FROM_NAME } from '../../constants/email';
+import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
+import type { RequestMetadata } from '../../universal/extract-request-metadata';
+import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
+
+export type RestoreDocumentOptions = {
+  id: number;
+  userId: number;
+  teamId?: number;
+  requestMetadata?: RequestMetadata;
+};
+
+export const restoreDocument = async ({
+  id,
+  userId,
+  teamId,
+  requestMetadata,
+}: RestoreDocumentOptions) => {
+  const user = await prisma.user.findUnique({
+    where: {
+      id: userId,
+    },
+  });
+
+  if (!user) {
+    throw new Error('User not found');
+  }
+
+  const document = await prisma.document.findUnique({
+    where: {
+      id,
+    },
+    include: {
+      Recipient: true,
+      documentMeta: true,
+      team: {
+        select: {
+          members: true,
+        },
+      },
+    },
+  });
+
+  if (!document || (teamId !== undefined && teamId !== document.teamId)) {
+    throw new Error('Document not found');
+  }
+
+  const isUserOwner = document.userId === userId;
+  const isUserTeamMember = document.team?.members.some((member) => member.userId === userId);
+  const userRecipient = document.Recipient.find((recipient) => recipient.email === user.email);
+
+  if (!isUserOwner && !isUserTeamMember && !userRecipient) {
+    throw new Error('Not allowed');
+  }
+
+  // Handle restoring the actual document if user has permission.
+  if (isUserOwner || isUserTeamMember) {
+    await handleDocumentOwnerRestore({
+      document,
+      user,
+      requestMetadata,
+    });
+  }
+
+  // Continue to show the document to the user if they are a recipient.
+  if (userRecipient?.documentDeletedAt !== null) {
+    await prisma.recipient
+      .update({
+        where: {
+          id: userRecipient?.id,
+        },
+        data: {
+          documentDeletedAt: null,
+        },
+      })
+      .catch(() => {
+        // Do nothing.
+      });
+  }
+
+  // Return partial document for API v1 response.
+  return {
+    id: document.id,
+    userId: document.userId,
+    teamId: document.teamId,
+    title: document.title,
+    status: document.status,
+    documentDataId: document.documentDataId,
+    createdAt: document.createdAt,
+    updatedAt: document.updatedAt,
+    completedAt: document.completedAt,
+  };
+};
+
+type HandleDocumentOwnerRestoreOptions = {
+  document: Document & {
+    Recipient: Recipient[];
+    documentMeta: DocumentMeta | null;
+  };
+  user: User;
+  requestMetadata?: RequestMetadata;
+};
+
+const handleDocumentOwnerRestore = async ({
+  document,
+  user,
+  requestMetadata,
+}: HandleDocumentOwnerRestoreOptions) => {
+  if (!document.deletedAt) {
+    return;
+  }
+
+  // Restore soft-deleted documents.
+  if (document.status === DocumentStatus.COMPLETED) {
+    return await prisma.$transaction(async (tx) => {
+      await tx.documentAuditLog.create({
+        data: createDocumentAuditLogData({
+          documentId: document.id,
+          type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RESTORED,
+          user,
+          requestMetadata,
+          data: {
+            type: 'RESTORE',
+          },
+        }),
+      });
+
+      return await tx.document.update({
+        where: {
+          id: document.id,
+        },
+        data: {
+          deletedAt: null,
+        },
+      });
+    });
+  }
+
+  // Restore draft and pending documents.
+  const restoredDocument = await prisma.$transaction(async (tx) => {
+    await tx.documentAuditLog.create({
+      data: createDocumentAuditLogData({
+        documentId: document.id,
+        type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RESTORED,
+        user,
+        requestMetadata,
+        data: {
+          type: 'RESTORE',
+        },
+      }),
+    });
+
+    return await tx.document.update({
+      where: {
+        id: document.id,
+      },
+      data: {
+        deletedAt: null,
+      },
+    });
+  });
+
+  // Send restoration emails to recipients.
+  await Promise.all(
+    document.Recipient.map(async (recipient) => {
+      const assetBaseUrl = NEXT_PUBLIC_WEBAPP_URL() || 'http://localhost:3000';
+
+      const template = createElement(DocumentRestoreTemplate, {
+        documentName: document.title,
+        inviterName: user.name || undefined,
+        inviterEmail: user.email,
+        assetBaseUrl,
+      });
+
+      await mailer.sendMail({
+        to: {
+          address: recipient.email,
+          name: recipient.name,
+        },
+        from: {
+          name: FROM_NAME,
+          address: FROM_ADDRESS,
+        },
+        subject: 'Document Restored',
+        html: render(template),
+        text: render(template, { plainText: true }),
+      });
+    }),
+  );
+
+  return restoredDocument;
+};

packages/lib/types/document-audit-logs.ts

@@ -26,6 +26,7 @@ export const ZDocumentAuditLogTypeSchema = z.enum([
   'DOCUMENT_COMPLETED', // When the document is sealed and fully completed.
   'DOCUMENT_CREATED', // When the document is created.
   'DOCUMENT_DELETED', // When the document is soft deleted.
+  'DOCUMENT_RESTORED', // When the document is restored.
   'DOCUMENT_FIELD_INSERTED', // When a field is inserted (signed/approved/etc) by a recipient.
   'DOCUMENT_FIELD_UNINSERTED', // When a field is uninserted by a recipient.
   'DOCUMENT_GLOBAL_AUTH_ACCESS_UPDATED', // When the global access authentication is updated.
@@ -223,6 +224,16 @@ export const ZDocumentAuditLogEventDocumentDeletedSchema = z.object({
   }),
 });
 
+/**
+ * Event: Document restored.
+ */
+export const ZDocumentAuditLogEventDocumentRestoredSchema = z.object({
+  type: z.literal(DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RESTORED),
+  data: z.object({
+    type: z.enum(['RESTORE']),
+  }),
+});
+
 /**
  * Event: Document field inserted.
  */
@@ -469,6 +480,7 @@ export const ZDocumentAuditLogSchema = ZDocumentAuditLogBaseSchema.and(
     ZDocumentAuditLogEventDocumentCreatedSchema,
     ZDocumentAuditLogEventDocumentDeletedSchema,
     ZDocumentAuditLogEventDocumentMovedToTeamSchema,
+    ZDocumentAuditLogEventDocumentRestoredSchema,
     ZDocumentAuditLogEventDocumentFieldInsertedSchema,
     ZDocumentAuditLogEventDocumentFieldUninsertedSchema,
     ZDocumentAuditLogEventDocumentGlobalAuthAccessUpdatedSchema,

packages/lib/utils/document-audit-logs.ts

@@ -304,6 +304,10 @@ export const formatDocumentAuditLogAction = (auditLog: TDocumentAuditLog, userId
       anonymous: 'Document deleted',
       identified: 'deleted the document',
     }))
+    .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RESTORED }, () => ({
+      anonymous: 'Document restored',
+      identified: 'restored the document',
+    }))
     .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_FIELD_INSERTED }, () => ({
       anonymous: 'Field signed',
       identified: 'signed a field',