fix: refactor routers (#1523)

2024-12-10 16:11:20 +09:00
parent dd162205fa
commit fae9c0ca24
33 changed files with 1122 additions and 738 deletions
--- a/packages/trpc/server/document-router/router.ts
+++ b/packages/trpc/server/document-router/router.ts
@@ -1,5 +1,6 @@
 import { TRPCError } from '@trpc/server';
 import { DateTime } from 'luxon';
+import { z } from 'zod';

 import { getServerLimits } from '@documenso/ee/server-only/limits/server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '@documenso/lib/constants/app';
@@ -28,7 +29,7 @@ import { DocumentStatus } from '@documenso/prisma/client';
 import { authenticatedProcedure, procedure, router } from '../trpc';
 import {
  ZCreateDocumentMutationSchema,
-  ZDeleteDraftDocumentMutationSchema as ZDeleteDocumentMutationSchema,
+  ZDeleteDocumentMutationSchema,
  ZDownloadAuditLogsMutationSchema,
  ZDownloadCertificateMutationSchema,
  ZFindDocumentAuditLogsQuerySchema,
@@ -48,6 +49,7 @@ import {
 } from './schema';

 export const documentRouter = router({
+  // Internal endpoint for now.
  getDocumentById: authenticatedProcedure
    .input(ZGetDocumentByIdQuerySchema)
    .query(async ({ input, ctx }) => {
@@ -57,6 +59,7 @@ export const documentRouter = router({
      });
    }),

+  // Internal endpoint for now.
  getDocumentByToken: procedure
    .input(ZGetDocumentByTokenQuerySchema)
    .query(async ({ input, ctx }) => {
@@ -68,8 +71,50 @@ export const documentRouter = router({
      });
    }),

+  findDocuments: authenticatedProcedure
+    .meta({
+      openapi: {
+        method: 'GET',
+        path: '/document/find',
+        summary: 'Find documents',
+        description: 'Find documents based on a search criteria',
+        tags: ['Documents'],
+      },
+    })
+    .input(ZFindDocumentsQuerySchema)
+    .output(z.unknown())
+    .query(async ({ input, ctx }) => {
+      const { user } = ctx;
+
+      const { search, teamId, templateId, page, perPage, orderBy, source, status } = input;
+
+      const documents = await findDocuments({
+        userId: user.id,
+        teamId,
+        templateId,
+        search,
+        source,
+        status,
+        page,
+        perPage,
+        orderBy,
+      });
+
+      return documents;
+    }),
+
  getDocumentWithDetailsById: authenticatedProcedure
+    .meta({
+      openapi: {
+        method: 'GET',
+        path: '/document/{documentId}',
+        summary: 'Get document',
+        description: 'Returns a document given an ID',
+        tags: ['Documents'],
+      },
+    })
    .input(ZGetDocumentWithDetailsByIdQuerySchema)
+    .output(z.unknown())
    .query(async ({ input, ctx }) => {
      return await getDocumentWithDetailsById({
        ...input,
@@ -78,7 +123,16 @@ export const documentRouter = router({
    }),

  createDocument: authenticatedProcedure
+    .meta({
+      openapi: {
+        method: 'POST',
+        path: '/document/create',
+        summary: 'Create document',
+        tags: ['Documents'],
+      },
+    })
    .input(ZCreateDocumentMutationSchema)
+    .output(z.unknown())
    .mutation(async ({ input, ctx }) => {
      const { title, documentDataId, teamId } = input;

@@ -100,76 +154,18 @@ export const documentRouter = router({
      });
    }),

-  deleteDocument: authenticatedProcedure
-    .input(ZDeleteDocumentMutationSchema)
-    .mutation(async ({ input, ctx }) => {
-      const { id, teamId } = input;
-
-      const userId = ctx.user.id;
-
-      return await deleteDocument({
-        id,
-        userId,
-        teamId,
-        requestMetadata: extractNextApiRequestMetadata(ctx.req),
-      });
-    }),
-
-  moveDocumentToTeam: authenticatedProcedure
-    .input(ZMoveDocumentsToTeamSchema)
-    .mutation(async ({ input, ctx }) => {
-      const { documentId, teamId } = input;
-      const userId = ctx.user.id;
-
-      return await moveDocumentToTeam({
-        documentId,
-        teamId,
-        userId,
-        requestMetadata: extractNextApiRequestMetadata(ctx.req),
-      });
-    }),
-
-  findDocuments: authenticatedProcedure
-    .input(ZFindDocumentsQuerySchema)
-    .query(async ({ input, ctx }) => {
-      const { user } = ctx;
-
-      const { search, teamId, templateId, page, perPage, orderBy, source, status } = input;
-
-      const documents = await findDocuments({
-        userId: user.id,
-        teamId,
-        templateId,
-        search,
-        source,
-        status,
-        page,
-        perPage,
-        orderBy,
-      });
-
-      return documents;
-    }),
-
-  findDocumentAuditLogs: authenticatedProcedure
-    .input(ZFindDocumentAuditLogsQuerySchema)
-    .query(async ({ input, ctx }) => {
-      const { page, perPage, documentId, cursor, filterForRecentActivity, orderBy } = input;
-
-      return await findDocumentAuditLogs({
-        page,
-        perPage,
-        documentId,
-        cursor,
-        filterForRecentActivity,
-        orderBy,
-        userId: ctx.user.id,
-      });
-    }),
-
-  // Todo: Add API
+  // Todo: Refactor to updateDocument.
  setSettingsForDocument: authenticatedProcedure
+    .meta({
+      openapi: {
+        method: 'POST',
+        path: '/document/{documentId}',
+        summary: 'Update document',
+        tags: ['Documents'],
+      },
+    })
    .input(ZSetSettingsForDocumentMutationSchema)
+    .output(z.unknown())
    .mutation(async ({ input, ctx }) => {
      const { documentId, teamId, data, meta } = input;

@@ -198,6 +194,56 @@ export const documentRouter = router({
      });
    }),

+  deleteDocument: authenticatedProcedure
+    .meta({
+      openapi: {
+        method: 'POST',
+        path: '/document/{documentId}/delete',
+        summary: 'Delete document',
+        tags: ['Documents'],
+      },
+    })
+    .input(ZDeleteDocumentMutationSchema)
+    .output(z.unknown())
+    .mutation(async ({ input, ctx }) => {
+      const { documentId, teamId } = input;
+
+      const userId = ctx.user.id;
+
+      return await deleteDocument({
+        id: documentId,
+        userId,
+        teamId,
+        requestMetadata: extractNextApiRequestMetadata(ctx.req),
+      });
+    }),
+
+  moveDocumentToTeam: authenticatedProcedure
+    .meta({
+      openapi: {
+        method: 'POST',
+        path: '/document/{documentId}/move',
+        summary: 'Move document',
+        description: 'Move a document to a team',
+        tags: ['Documents'],
+      },
+    })
+    .input(ZMoveDocumentsToTeamSchema)
+    .output(z.unknown())
+    .mutation(async ({ input, ctx }) => {
+      const { documentId, teamId } = input;
+      const userId = ctx.user.id;
+
+      return await moveDocumentToTeam({
+        documentId,
+        teamId,
+        userId,
+        requestMetadata: extractNextApiRequestMetadata(ctx.req),
+      });
+    }),
+
+  // Internal endpoint for now.
+  // Should probably use `updateDocument`
  setTitleForDocument: authenticatedProcedure
    .input(ZSetTitleForDocumentMutationSchema)
    .mutation(async ({ input, ctx }) => {
@@ -214,6 +260,7 @@ export const documentRouter = router({
      });
    }),

+  // Internal endpoint for now.
  setPasswordForDocument: authenticatedProcedure
    .input(ZSetPasswordForDocumentMutationSchema)
    .mutation(async ({ input, ctx }) => {
@@ -238,6 +285,7 @@ export const documentRouter = router({
      });
    }),

+  // Internal endpoint for now.
  setSigningOrderForDocument: authenticatedProcedure
    .input(ZSetSigningOrderForDocumentMutationSchema)
    .mutation(async ({ input, ctx }) => {
@@ -251,13 +299,14 @@ export const documentRouter = router({
      });
    }),

+  // Internal endpoint for now.
  updateTypedSignatureSettings: authenticatedProcedure
    .input(ZUpdateTypedSignatureSettingsMutationSchema)
    .mutation(async ({ input, ctx }) => {
      const { documentId, teamId, typedSignatureEnabled } = input;

      const document = await getDocumentById({
-        id: documentId,
+        documentId,
        teamId,
        userId: ctx.user.id,
      }).catch(() => null);
@@ -277,8 +326,20 @@ export const documentRouter = router({
      });
    }),

+  // Todo: Refactor to distributeDocument.
+  // Todo: Rework before releasing API.
  sendDocument: authenticatedProcedure
+    .meta({
+      openapi: {
+        method: 'POST',
+        path: '/document/{documentId}/distribute',
+        summary: 'Distribute document',
+        description: 'Send the document out to recipients based on your distribution method',
+        tags: ['Documents'],
+      },
+    })
    .input(ZSendDocumentMutationSchema)
+    .output(z.unknown())
    .mutation(async ({ input, ctx }) => {
      const { documentId, teamId, meta } = input;

@@ -314,7 +375,18 @@ export const documentRouter = router({
    }),

  resendDocument: authenticatedProcedure
+    .meta({
+      openapi: {
+        method: 'POST',
+        path: '/document/{documentId}/resend',
+        summary: 'Resend document',
+        description:
+          'Resend the document to recipients who have not signed. Will use the distribution method set in the document.',
+        tags: ['Documents'],
+      },
+    })
    .input(ZResendDocumentMutationSchema)
+    .output(z.unknown())
    .mutation(async ({ input, ctx }) => {
      return await resendDocument({
        userId: ctx.user.id,
@@ -324,7 +396,16 @@ export const documentRouter = router({
    }),

  duplicateDocument: authenticatedProcedure
+    .meta({
+      openapi: {
+        method: 'POST',
+        path: '/document/{documentId}/duplicate',
+        summary: 'Duplicate document',
+        tags: ['Documents'],
+      },
+    })
    .input(ZGetDocumentByIdQuerySchema)
+    .output(z.unknown())
    .mutation(async ({ input, ctx }) => {
      return await duplicateDocumentById({
        userId: ctx.user.id,
@@ -332,6 +413,7 @@ export const documentRouter = router({
      });
    }),

+  // Internal endpoint for now.
  searchDocuments: authenticatedProcedure
    .input(ZSearchDocumentsMutationSchema)
    .query(async ({ input, ctx }) => {
@@ -345,13 +427,31 @@ export const documentRouter = router({
      return documents;
    }),

+  // Internal endpoint for now.
+  findDocumentAuditLogs: authenticatedProcedure
+    .input(ZFindDocumentAuditLogsQuerySchema)
+    .query(async ({ input, ctx }) => {
+      const { page, perPage, documentId, cursor, filterForRecentActivity, orderBy } = input;
+
+      return await findDocumentAuditLogs({
+        page,
+        perPage,
+        documentId,
+        cursor,
+        filterForRecentActivity,
+        orderBy,
+        userId: ctx.user.id,
+      });
+    }),
+
+  // Internal endpoint for now.
  downloadAuditLogs: authenticatedProcedure
    .input(ZDownloadAuditLogsMutationSchema)
    .mutation(async ({ input, ctx }) => {
      const { documentId, teamId } = input;

      const document = await getDocumentById({
-        id: documentId,
+        documentId,
        userId: ctx.user.id,
        teamId,
      }).catch(() => null);
@@ -373,13 +473,14 @@ export const documentRouter = router({
      };
    }),

+  // Internal endpoint for now.
  downloadCertificate: authenticatedProcedure
    .input(ZDownloadCertificateMutationSchema)
    .mutation(async ({ input, ctx }) => {
      const { documentId, teamId } = input;

      const document = await getDocumentById({
-        id: documentId,
+        documentId,
        userId: ctx.user.id,
        teamId,
      });
--- a/packages/trpc/server/document-router/schema.ts
+++ b/packages/trpc/server/document-router/schema.ts
@@ -48,7 +48,7 @@ export const ZFindDocumentAuditLogsQuerySchema = ZBaseTableSearchParamsSchema.ex
 });

 export const ZGetDocumentByIdQuerySchema = z.object({
-  id: z.number().min(1),
+  documentId: z.number().min(1),
  teamId: z.number().min(1).optional(),
 });

@@ -61,7 +61,7 @@ export const ZGetDocumentByTokenQuerySchema = z.object({
 export type TGetDocumentByTokenQuerySchema = z.infer<typeof ZGetDocumentByTokenQuerySchema>;

 export const ZGetDocumentWithDetailsByIdQuerySchema = z.object({
-  id: z.number().min(1),
+  documentId: z.number().min(1),
  teamId: z.number().min(1).optional(),
 });

@@ -206,12 +206,12 @@ export const ZResendDocumentMutationSchema = z.object({

 export type TSendDocumentMutationSchema = z.infer<typeof ZSendDocumentMutationSchema>;

-export const ZDeleteDraftDocumentMutationSchema = z.object({
-  id: z.number().min(1),
+export const ZDeleteDocumentMutationSchema = z.object({
+  documentId: z.number().min(1),
  teamId: z.number().min(1).optional(),
 });

-export type TDeleteDraftDocumentMutationSchema = z.infer<typeof ZDeleteDraftDocumentMutationSchema>;
+export type TDeleteDocumentMutationSchema = z.infer<typeof ZDeleteDocumentMutationSchema>;

 export const ZSearchDocumentsMutationSchema = z.object({
  query: z.string(),