feat: move document to team (#1210)

Introduces a new dialog component allowing users to move documents
between teams with included audit logging.

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

@@ -31,7 +31,7 @@ export const findDocumentAuditLogs = async ({
   const orderByColumn = orderBy?.column ?? 'createdAt';
   const orderByDirection = orderBy?.direction ?? 'desc';
 
-  await prisma.document.findFirstOrThrow({
+  const documentFilter = await prisma.document.findFirstOrThrow({
     where: {
       id: documentId,
       OR: [
@@ -67,6 +67,7 @@ export const findDocumentAuditLogs = async ({
             DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_OPENED,
             DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED,
             DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_SENT,
+            DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_MOVED_TO_TEAM,
           ],
         },
       },

packages/lib/server-only/document/move-document-to-team.ts

@@ -0,0 +1,83 @@
+import { TRPCError } from '@trpc/server';
+
+import type { RequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
+import { prisma } from '@documenso/prisma';
+
+import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
+import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
+
+export type MoveDocumentToTeamOptions = {
+  documentId: number;
+  teamId: number;
+  userId: number;
+  requestMetadata?: RequestMetadata;
+};
+
+export const moveDocumentToTeam = async ({
+  documentId,
+  teamId,
+  userId,
+  requestMetadata,
+}: MoveDocumentToTeamOptions) => {
+  return await prisma.$transaction(async (tx) => {
+    const user = await tx.user.findUniqueOrThrow({
+      where: { id: userId },
+    });
+
+    const document = await tx.document.findFirst({
+      where: {
+        id: documentId,
+        userId,
+        teamId: null,
+      },
+    });
+
+    if (!document) {
+      throw new TRPCError({
+        code: 'NOT_FOUND',
+        message: 'Document not found or already associated with a team.',
+      });
+    }
+
+    const team = await tx.team.findFirst({
+      where: {
+        id: teamId,
+        members: {
+          some: {
+            userId,
+          },
+        },
+      },
+    });
+
+    if (!team) {
+      throw new TRPCError({
+        code: 'FORBIDDEN',
+        message: 'You are not a member of this team.',
+      });
+    }
+
+    const updatedDocument = await tx.document.update({
+      where: { id: documentId },
+      data: { teamId },
+    });
+
+    const log = await tx.documentAuditLog.create({
+      data: createDocumentAuditLogData({
+        type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_MOVED_TO_TEAM,
+        documentId: updatedDocument.id,
+        user,
+        requestMetadata,
+        data: {
+          movedByUserId: userId,
+          fromPersonalAccount: true,
+          toTeamId: teamId,
+        },
+      }),
+    });
+
+    console.log(log);
+
+    return updatedDocument;
+  });
+};

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

@@ -35,6 +35,7 @@ export const ZDocumentAuditLogTypeSchema = z.enum([
   'DOCUMENT_RECIPIENT_COMPLETED', // When a recipient completes all their required tasks for the document.
   'DOCUMENT_SENT', // When the document transitions from DRAFT to PENDING.
   'DOCUMENT_TITLE_UPDATED', // When the document title is updated.
+  'DOCUMENT_MOVED_TO_TEAM', // When the document is moved to a team.
 ]);
 
 export const ZDocumentAuditLogEmailTypeSchema = z.enum([
@@ -410,6 +411,18 @@ export const ZDocumentAuditLogEventRecipientRemovedSchema = z.object({
   data: ZBaseRecipientDataSchema,
 });
 
+/**
+ * Event: Document moved to team.
+ */
+export const ZDocumentAuditLogEventDocumentMovedToTeamSchema = z.object({
+  type: z.literal(DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_MOVED_TO_TEAM),
+  data: z.object({
+    movedByUserId: z.number(),
+    fromPersonalAccount: z.boolean(),
+    toTeamId: z.number(),
+  }),
+});
+
 export const ZDocumentAuditLogBaseSchema = z.object({
   id: z.string(),
   createdAt: z.date(),
@@ -427,6 +440,7 @@ export const ZDocumentAuditLogSchema = ZDocumentAuditLogBaseSchema.and(
     ZDocumentAuditLogEventDocumentCompletedSchema,
     ZDocumentAuditLogEventDocumentCreatedSchema,
     ZDocumentAuditLogEventDocumentDeletedSchema,
+    ZDocumentAuditLogEventDocumentMovedToTeamSchema,
     ZDocumentAuditLogEventDocumentFieldInsertedSchema,
     ZDocumentAuditLogEventDocumentFieldUninsertedSchema,
     ZDocumentAuditLogEventDocumentGlobalAuthAccessUpdatedSchema,

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

@@ -336,6 +336,10 @@ export const formatDocumentAuditLogAction = (auditLog: TDocumentAuditLog, userId
       anonymous: 'Document sent',
       identified: 'sent the document',
     }))
+    .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_MOVED_TO_TEAM }, () => ({
+      anonymous: 'Document moved to team',
+      identified: 'moved the document to team',
+    }))
     .with({ type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED }, ({ data }) => {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       const action = RECIPIENT_ROLES_DESCRIPTION[data.recipientRole as RecipientRole]?.actioned;

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

@@ -14,6 +14,7 @@ import { findDocumentAuditLogs } from '@documenso/lib/server-only/document/find-
 import { getDocumentById } from '@documenso/lib/server-only/document/get-document-by-id';
 import { getDocumentAndSenderByToken } from '@documenso/lib/server-only/document/get-document-by-token';
 import { getDocumentWithDetailsById } from '@documenso/lib/server-only/document/get-document-with-details-by-id';
+import { moveDocumentToTeam } from '@documenso/lib/server-only/document/move-document-to-team';
 import { resendDocument } from '@documenso/lib/server-only/document/resend-document';
 import { searchDocumentsWithKeyword } from '@documenso/lib/server-only/document/search-documents-with-keyword';
 import { sendDocument } from '@documenso/lib/server-only/document/send-document';
@@ -32,6 +33,7 @@ import {
   ZGetDocumentByIdQuerySchema,
   ZGetDocumentByTokenQuerySchema,
   ZGetDocumentWithDetailsByIdQuerySchema,
+  ZMoveDocumentsToTeamSchema,
   ZResendDocumentMutationSchema,
   ZSearchDocumentsMutationSchema,
   ZSendDocumentMutationSchema,
@@ -158,6 +160,33 @@ export const documentRouter = router({
       }
     }),
 
+  moveDocumentToTeam: authenticatedProcedure
+    .input(ZMoveDocumentsToTeamSchema)
+    .mutation(async ({ input, ctx }) => {
+      try {
+        const { documentId, teamId } = input;
+        const userId = ctx.user.id;
+
+        return await moveDocumentToTeam({
+          documentId,
+          teamId,
+          userId,
+          requestMetadata: extractNextApiRequestMetadata(ctx.req),
+        });
+      } catch (err) {
+        console.error(err);
+
+        if (err instanceof TRPCError) {
+          throw err;
+        }
+
+        throw new TRPCError({
+          code: 'BAD_REQUEST',
+          message: 'We were unable to move this document. Please try again later.',
+        });
+      }
+    }),
+
   findDocumentAuditLogs: authenticatedProcedure
     .input(ZFindDocumentAuditLogsQuerySchema)
     .query(async ({ input, ctx }) => {

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

@@ -168,3 +168,8 @@ export const ZDownloadAuditLogsMutationSchema = z.object({
   documentId: z.number(),
   teamId: z.number().optional(),
 });
+
+export const ZMoveDocumentsToTeamSchema = z.object({
+  documentId: z.number(),
+  teamId: z.number(),
+});