feat: add consistent response schemas (#1582)

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

@@ -8,63 +8,47 @@ import { DOCUMENSO_ENCRYPTION_KEY } from '@documenso/lib/constants/crypto';
 import { AppError } from '@documenso/lib/errors/app-error';
 import { encryptSecondaryData } from '@documenso/lib/server-only/crypto/encrypt';
 import { upsertDocumentMeta } from '@documenso/lib/server-only/document-meta/upsert-document-meta';
-import {
-  ZCreateDocumentResponseSchema,
-  createDocument,
-} from '@documenso/lib/server-only/document/create-document';
+import { createDocument } from '@documenso/lib/server-only/document/create-document';
 import { deleteDocument } from '@documenso/lib/server-only/document/delete-document';
-import {
-  ZDuplicateDocumentResponseSchema,
-  duplicateDocument,
-} from '@documenso/lib/server-only/document/duplicate-document-by-id';
+import { duplicateDocument } from '@documenso/lib/server-only/document/duplicate-document-by-id';
 import { findDocumentAuditLogs } from '@documenso/lib/server-only/document/find-document-audit-logs';
-import {
-  ZFindDocumentsResponseSchema,
-  findDocuments,
-} from '@documenso/lib/server-only/document/find-documents';
+import { findDocuments } from '@documenso/lib/server-only/document/find-documents';
 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 {
-  ZGetDocumentWithDetailsByIdResponseSchema,
-  getDocumentWithDetailsById,
-} from '@documenso/lib/server-only/document/get-document-with-details-by-id';
-import {
-  ZMoveDocumentToTeamResponseSchema,
-  moveDocumentToTeam,
-} from '@documenso/lib/server-only/document/move-document-to-team';
+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 {
-  ZSendDocumentResponseSchema,
-  sendDocument,
-} from '@documenso/lib/server-only/document/send-document';
-import {
-  ZUpdateDocumentResponseSchema,
-  updateDocument,
-} from '@documenso/lib/server-only/document/update-document';
+import { sendDocument } from '@documenso/lib/server-only/document/send-document';
+import { updateDocument } from '@documenso/lib/server-only/document/update-document';
 import { symmetricEncrypt } from '@documenso/lib/universal/crypto';
 import { DocumentStatus } from '@documenso/prisma/client';
 
 import { authenticatedProcedure, procedure, router } from '../trpc';
 import {
-  ZCreateDocumentMutationSchema,
+  ZCreateDocumentRequestSchema,
   ZDeleteDocumentMutationSchema,
+  ZDistributeDocumentRequestSchema,
+  ZDistributeDocumentResponseSchema,
   ZDownloadAuditLogsMutationSchema,
   ZDownloadCertificateMutationSchema,
-  ZDuplicateDocumentMutationSchema,
+  ZDuplicateDocumentRequestSchema,
+  ZDuplicateDocumentResponseSchema,
   ZFindDocumentAuditLogsQuerySchema,
-  ZFindDocumentsQuerySchema,
+  ZFindDocumentsRequestSchema,
+  ZFindDocumentsResponseSchema,
   ZGetDocumentByIdQuerySchema,
   ZGetDocumentByTokenQuerySchema,
-  ZGetDocumentWithDetailsByIdQuerySchema,
+  ZGetDocumentWithDetailsByIdRequestSchema,
+  ZGetDocumentWithDetailsByIdResponseSchema,
+  ZMoveDocumentToTeamResponseSchema,
   ZMoveDocumentToTeamSchema,
   ZResendDocumentMutationSchema,
   ZSearchDocumentsMutationSchema,
-  ZSendDocumentMutationSchema,
   ZSetPasswordForDocumentMutationSchema,
   ZSetSigningOrderForDocumentMutationSchema,
   ZUpdateDocumentRequestSchema,
-  ZUpdateTypedSignatureSettingsMutationSchema,
+  ZUpdateDocumentResponseSchema,
 } from './schema';
 
 export const documentRouter = router({
@@ -111,7 +95,7 @@ export const documentRouter = router({
         tags: ['Document'],
       },
     })
-    .input(ZFindDocumentsQuerySchema)
+    .input(ZFindDocumentsRequestSchema)
     .output(ZFindDocumentsResponseSchema)
     .query(async ({ input, ctx }) => {
       const { user, teamId } = ctx;
@@ -149,7 +133,7 @@ export const documentRouter = router({
         tags: ['Document'],
       },
     })
-    .input(ZGetDocumentWithDetailsByIdQuerySchema)
+    .input(ZGetDocumentWithDetailsByIdRequestSchema)
     .output(ZGetDocumentWithDetailsByIdResponseSchema)
     .query(async ({ input, ctx }) => {
       const { teamId, user } = ctx;
@@ -176,8 +160,7 @@ export const documentRouter = router({
     //     tags: ['Document'],
     //   },
     // })
-    .input(ZCreateDocumentMutationSchema)
-    .output(ZCreateDocumentResponseSchema)
+    .input(ZCreateDocumentRequestSchema)
     .mutation(async ({ input, ctx }) => {
       const { teamId } = ctx;
       const { title, documentDataId, timezone } = input;
@@ -353,39 +336,6 @@ export const documentRouter = router({
       });
     }),
 
-  /**
-   * @deprecated Remove after deployment.
-   *
-   * @private
-   */
-  updateTypedSignatureSettings: authenticatedProcedure
-    .input(ZUpdateTypedSignatureSettingsMutationSchema)
-    .mutation(async ({ input, ctx }) => {
-      const { teamId } = ctx;
-      const { documentId, typedSignatureEnabled } = input;
-
-      const document = await getDocumentById({
-        documentId,
-        teamId,
-        userId: ctx.user.id,
-      }).catch(() => null);
-
-      if (!document) {
-        throw new TRPCError({
-          code: 'NOT_FOUND',
-          message: 'Document not found',
-        });
-      }
-
-      return await upsertDocumentMeta({
-        userId: ctx.user.id,
-        teamId,
-        documentId,
-        typedSignatureEnabled,
-        requestMetadata: ctx.metadata,
-      });
-    }),
-
   /**
    * @public
    *
@@ -402,8 +352,8 @@ export const documentRouter = router({
         tags: ['Document'],
       },
     })
-    .input(ZSendDocumentMutationSchema)
-    .output(ZSendDocumentResponseSchema)
+    .input(ZDistributeDocumentRequestSchema)
+    .output(ZDistributeDocumentResponseSchema)
     .mutation(async ({ input, ctx }) => {
       const { teamId } = ctx;
       const { documentId, meta = {} } = input;
@@ -476,7 +426,7 @@ export const documentRouter = router({
         tags: ['Document'],
       },
     })
-    .input(ZDuplicateDocumentMutationSchema)
+    .input(ZDuplicateDocumentRequestSchema)
     .output(ZDuplicateDocumentResponseSchema)
     .mutation(async ({ input, ctx }) => {
       const { teamId, user } = ctx;

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

@@ -1,12 +1,17 @@
 import { z } from 'zod';
 
 import { SUPPORTED_LANGUAGE_CODES } from '@documenso/lib/constants/i18n';
+import {
+  ZDocumentLiteSchema,
+  ZDocumentManySchema,
+  ZDocumentSchema,
+} from '@documenso/lib/types/document';
 import {
   ZDocumentAccessAuthTypesSchema,
   ZDocumentActionAuthTypesSchema,
 } from '@documenso/lib/types/document-auth';
 import { ZDocumentEmailSettingsSchema } from '@documenso/lib/types/document-email';
-import { ZFindSearchParamsSchema } from '@documenso/lib/types/search-params';
+import { ZFindResultResponse, ZFindSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { isValidRedirectUrl } from '@documenso/lib/utils/is-valid-redirect-url';
 import {
   DocumentDistributionMethod,
@@ -17,7 +22,6 @@ import {
   FieldType,
 } from '@documenso/prisma/client';
 
-// Todo: Refactor all to ZDocumentMeta---
 export const ZDocumentMetaTimezoneSchema = z
   .string()
   .describe('The timezone to use for date fields and signing the document.');
@@ -53,7 +57,7 @@ export const ZDocumentMetaTypedSignatureEnabledSchema = z
   .boolean()
   .describe('Whether to allow typed signatures.');
 
-export const ZFindDocumentsQuerySchema = ZFindSearchParamsSchema.extend({
+export const ZFindDocumentsRequestSchema = ZFindSearchParamsSchema.extend({
   templateId: z
     .number()
     .describe('Filter documents by the template ID used to create it.')
@@ -70,6 +74,12 @@ export const ZFindDocumentsQuerySchema = ZFindSearchParamsSchema.extend({
   orderByDirection: z.enum(['asc', 'desc']).describe('').default('desc'),
 });
 
+export const ZFindDocumentsResponseSchema = ZFindResultResponse.extend({
+  data: ZDocumentManySchema.array(),
+});
+
+export type TFindDocumentsResponse = z.infer<typeof ZFindDocumentsResponseSchema>;
+
 export const ZFindDocumentAuditLogsQuerySchema = ZFindSearchParamsSchema.extend({
   documentId: z.number().min(1),
   cursor: z.string().optional(),
@@ -82,11 +92,13 @@ export const ZGetDocumentByIdQuerySchema = z.object({
   documentId: z.number(),
 });
 
-export const ZDuplicateDocumentMutationSchema = z.object({
+export const ZDuplicateDocumentRequestSchema = z.object({
   documentId: z.number(),
 });
 
-export type TGetDocumentByIdQuerySchema = z.infer<typeof ZGetDocumentByIdQuerySchema>;
+export const ZDuplicateDocumentResponseSchema = z.object({
+  documentId: z.number(),
+});
 
 export const ZGetDocumentByTokenQuerySchema = z.object({
   token: z.string().min(1),
@@ -94,22 +106,18 @@ export const ZGetDocumentByTokenQuerySchema = z.object({
 
 export type TGetDocumentByTokenQuerySchema = z.infer<typeof ZGetDocumentByTokenQuerySchema>;
 
-export const ZGetDocumentWithDetailsByIdQuerySchema = z.object({
+export const ZGetDocumentWithDetailsByIdRequestSchema = z.object({
   documentId: z.number(),
 });
 
-export type TGetDocumentWithDetailsByIdQuerySchema = z.infer<
-  typeof ZGetDocumentWithDetailsByIdQuerySchema
->;
+export const ZGetDocumentWithDetailsByIdResponseSchema = ZDocumentSchema;
 
-export const ZCreateDocumentMutationSchema = z.object({
+export const ZCreateDocumentRequestSchema = z.object({
   title: z.string().min(1),
   documentDataId: z.string().min(1),
   timezone: z.string().optional(),
 });
 
-export type TCreateDocumentMutationSchema = z.infer<typeof ZCreateDocumentMutationSchema>;
-
 export const ZUpdateDocumentRequestSchema = z.object({
   documentId: z.number(),
   data: z
@@ -139,7 +147,7 @@ export const ZUpdateDocumentRequestSchema = z.object({
     .optional(),
 });
 
-export type TUpdateDocumentRequestSchema = z.infer<typeof ZUpdateDocumentRequestSchema>;
+export const ZUpdateDocumentResponseSchema = ZDocumentLiteSchema;
 
 export const ZSetFieldsForDocumentMutationSchema = z.object({
   documentId: z.number(),
@@ -161,7 +169,7 @@ export type TSetFieldsForDocumentMutationSchema = z.infer<
   typeof ZSetFieldsForDocumentMutationSchema
 >;
 
-export const ZSendDocumentMutationSchema = z.object({
+export const ZDistributeDocumentRequestSchema = z.object({
   documentId: z.number().describe('The ID of the document to send.'),
   meta: z
     .object({
@@ -177,6 +185,8 @@ export const ZSendDocumentMutationSchema = z.object({
     .optional(),
 });
 
+export const ZDistributeDocumentResponseSchema = ZDocumentLiteSchema;
+
 export const ZSetPasswordForDocumentMutationSchema = z.object({
   documentId: z.number(),
   password: z.string(),
@@ -195,15 +205,6 @@ export type TSetSigningOrderForDocumentMutationSchema = z.infer<
   typeof ZSetSigningOrderForDocumentMutationSchema
 >;
 
-export const ZUpdateTypedSignatureSettingsMutationSchema = z.object({
-  documentId: z.number(),
-  typedSignatureEnabled: z.boolean(),
-});
-
-export type TUpdateTypedSignatureSettingsMutationSchema = z.infer<
-  typeof ZUpdateTypedSignatureSettingsMutationSchema
->;
-
 export const ZResendDocumentMutationSchema = z.object({
   documentId: z.number(),
   recipients: z
@@ -212,8 +213,6 @@ export const ZResendDocumentMutationSchema = z.object({
     .describe('The IDs of the recipients to redistribute the document to.'),
 });
 
-export type TSendDocumentMutationSchema = z.infer<typeof ZSendDocumentMutationSchema>;
-
 export const ZDeleteDocumentMutationSchema = z.object({
   documentId: z.number(),
 });
@@ -236,3 +235,5 @@ export const ZMoveDocumentToTeamSchema = z.object({
   documentId: z.number().describe('The ID of the document to move to a team.'),
   teamId: z.number().describe('The ID of the team to move the document to.'),
 });
+
+export const ZMoveDocumentToTeamResponseSchema = ZDocumentLiteSchema;