feat: add consistent response schemas (#1582)

2025-01-14 00:43:35 +11:00
parent 7d0a9c6439
commit 901be70f97
41 changed files with 532 additions and 619 deletions
--- a/packages/trpc/server/field-router/router.ts
+++ b/packages/trpc/server/field-router/router.ts
@@ -1,60 +1,46 @@
 import { z } from 'zod';

-import {
-  ZCreateDocumentFieldsResponseSchema,
-  createDocumentFields,
-} from '@documenso/lib/server-only/field/create-document-fields';
-import {
-  ZCreateTemplateFieldsResponseSchema,
-  createTemplateFields,
-} from '@documenso/lib/server-only/field/create-template-fields';
+import { createDocumentFields } from '@documenso/lib/server-only/field/create-document-fields';
+import { createTemplateFields } from '@documenso/lib/server-only/field/create-template-fields';
 import { deleteDocumentField } from '@documenso/lib/server-only/field/delete-document-field';
 import { deleteTemplateField } from '@documenso/lib/server-only/field/delete-template-field';
-import {
-  ZGetFieldByIdResponseSchema,
-  getFieldById,
-} from '@documenso/lib/server-only/field/get-field-by-id';
+import { getFieldById } from '@documenso/lib/server-only/field/get-field-by-id';
 import { removeSignedFieldWithToken } from '@documenso/lib/server-only/field/remove-signed-field-with-token';
-import {
-  ZSetFieldsForDocumentResponseSchema,
-  setFieldsForDocument,
-} from '@documenso/lib/server-only/field/set-fields-for-document';
-import {
-  ZSetFieldsForTemplateResponseSchema,
-  setFieldsForTemplate,
-} from '@documenso/lib/server-only/field/set-fields-for-template';
+import { setFieldsForDocument } from '@documenso/lib/server-only/field/set-fields-for-document';
+import { setFieldsForTemplate } from '@documenso/lib/server-only/field/set-fields-for-template';
 import { signFieldWithToken } from '@documenso/lib/server-only/field/sign-field-with-token';
-import {
-  ZUpdateDocumentFieldsResponseSchema,
-  updateDocumentFields,
-} from '@documenso/lib/server-only/field/update-document-fields';
-import {
-  ZUpdateTemplateFieldsResponseSchema,
-  updateTemplateFields,
-} from '@documenso/lib/server-only/field/update-template-fields';
+import { updateDocumentFields } from '@documenso/lib/server-only/field/update-document-fields';
+import { updateTemplateFields } from '@documenso/lib/server-only/field/update-template-fields';
 import { extractNextApiRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';

 import { authenticatedProcedure, procedure, router } from '../trpc';
 import {
-  ZAddFieldsMutationSchema,
-  ZAddTemplateFieldsMutationSchema,
  ZCreateDocumentFieldRequestSchema,
  ZCreateDocumentFieldResponseSchema,
  ZCreateDocumentFieldsRequestSchema,
+  ZCreateDocumentFieldsResponseSchema,
  ZCreateTemplateFieldRequestSchema,
  ZCreateTemplateFieldResponseSchema,
  ZCreateTemplateFieldsRequestSchema,
+  ZCreateTemplateFieldsResponseSchema,
  ZDeleteDocumentFieldRequestSchema,
  ZDeleteTemplateFieldRequestSchema,
-  ZGetFieldQuerySchema,
+  ZGetFieldRequestSchema,
+  ZGetFieldResponseSchema,
  ZRemovedSignedFieldWithTokenMutationSchema,
+  ZSetDocumentFieldsRequestSchema,
+  ZSetDocumentFieldsResponseSchema,
+  ZSetFieldsForTemplateRequestSchema,
+  ZSetFieldsForTemplateResponseSchema,
  ZSignFieldWithTokenMutationSchema,
  ZUpdateDocumentFieldRequestSchema,
  ZUpdateDocumentFieldResponseSchema,
  ZUpdateDocumentFieldsRequestSchema,
+  ZUpdateDocumentFieldsResponseSchema,
  ZUpdateTemplateFieldRequestSchema,
  ZUpdateTemplateFieldResponseSchema,
  ZUpdateTemplateFieldsRequestSchema,
+  ZUpdateTemplateFieldsResponseSchema,
 } from './schema';

 export const fieldRouter = router({
@@ -72,8 +58,8 @@ export const fieldRouter = router({
        tags: ['Document Fields', 'Template Fields'],
      },
    })
-    .input(ZGetFieldQuerySchema)
-    .output(ZGetFieldByIdResponseSchema)
+    .input(ZGetFieldRequestSchema)
+    .output(ZGetFieldResponseSchema)
    .query(async ({ input, ctx }) => {
      const { teamId } = ctx;
      const { fieldId } = input;
@@ -229,6 +215,8 @@ export const fieldRouter = router({

  /**
   * @private
+   *
+   * Todo: Refactor to setFieldsForDocument function.
   */
  addFields: authenticatedProcedure
    // .meta({
@@ -239,8 +227,8 @@ export const fieldRouter = router({
    //     tags: ['Document Fields'],
    //   },
    // })
-    .input(ZAddFieldsMutationSchema)
-    .output(ZSetFieldsForDocumentResponseSchema)
+    .input(ZSetDocumentFieldsRequestSchema)
+    .output(ZSetDocumentFieldsResponseSchema)
    .mutation(async ({ input, ctx }) => {
      const { teamId } = ctx;
      const { documentId, fields } = input;
@@ -403,6 +391,8 @@ export const fieldRouter = router({

  /**
   * @private
+   *
+   * Todo: Refactor to setFieldsForTemplate.
   */
  addTemplateFields: authenticatedProcedure
    // .meta({
@@ -413,7 +403,7 @@ export const fieldRouter = router({
    //     tags: ['Template Fields'],
    //   },
    // })
-    .input(ZAddTemplateFieldsMutationSchema)
+    .input(ZSetFieldsForTemplateRequestSchema)
    .output(ZSetFieldsForTemplateResponseSchema)
    .mutation(async ({ input, ctx }) => {
      const { teamId } = ctx;
--- a/packages/trpc/server/field-router/schema.ts
+++ b/packages/trpc/server/field-router/schema.ts
@@ -1,13 +1,13 @@
 import { z } from 'zod';

 import { ZRecipientActionAuthSchema } from '@documenso/lib/types/document-auth';
+import { ZFieldSchema } from '@documenso/lib/types/field';
 import { ZFieldMetaSchema } from '@documenso/lib/types/field-meta';
 import { FieldType } from '@documenso/prisma/client';
-import { FieldSchema } from '@documenso/prisma/generated/zod';

 const ZCreateFieldSchema = z.object({
  recipientId: z.number().describe('The ID of the recipient to create the field for.'),
-  type: FieldSchema.shape.type.describe('The type of the field to create.'),
+  type: ZFieldSchema.shape.type.describe('The type of the field to create.'),
  pageNumber: z.number().describe('The page number the field will be on.'),
  pageX: z.number().describe('The X coordinate of where the field will be placed.'),
  pageY: z.number().describe('The Y coordinate of where the field will be placed.'),
@@ -18,7 +18,7 @@ const ZCreateFieldSchema = z.object({

 const ZUpdateFieldSchema = z.object({
  id: z.number().describe('The ID of the field to update.'),
-  type: FieldSchema.shape.type.optional().describe('The type of the field to update.'),
+  type: ZFieldSchema.shape.type.optional().describe('The type of the field to update.'),
  pageNumber: z.number().optional().describe('The page number the field will be on.'),
  pageX: z.number().optional().describe('The X coordinate of where the field will be placed.'),
  pageY: z.number().optional().describe('The Y coordinate of where the field will be placed.'),
@@ -28,59 +28,78 @@ const ZUpdateFieldSchema = z.object({
 });

 export const ZCreateDocumentFieldRequestSchema = z.object({
-  documentId: z.number().min(1),
+  documentId: z.number(),
  field: ZCreateFieldSchema,
 });

+export const ZCreateDocumentFieldResponseSchema = ZFieldSchema;
+
 export const ZCreateDocumentFieldsRequestSchema = z.object({
-  documentId: z.number().min(1),
+  documentId: z.number(),
  fields: ZCreateFieldSchema.array(),
 });

+export const ZCreateDocumentFieldsResponseSchema = z.object({
+  fields: z.array(ZFieldSchema),
+});
+
 export const ZUpdateDocumentFieldRequestSchema = z.object({
-  documentId: z.number().min(1),
+  documentId: z.number(),
  field: ZUpdateFieldSchema,
 });

+export const ZUpdateDocumentFieldResponseSchema = ZFieldSchema;
+
 export const ZUpdateDocumentFieldsRequestSchema = z.object({
-  documentId: z.number().min(1),
+  documentId: z.number(),
  fields: ZUpdateFieldSchema.array(),
 });

+export const ZUpdateDocumentFieldsResponseSchema = z.object({
+  fields: z.array(ZFieldSchema),
+});
+
 export const ZDeleteDocumentFieldRequestSchema = z.object({
-  fieldId: z.number().min(1),
+  fieldId: z.number(),
 });

 export const ZCreateTemplateFieldRequestSchema = z.object({
-  templateId: z.number().min(1),
+  templateId: z.number(),
  field: ZCreateFieldSchema,
 });

-export const ZCreateDocumentFieldResponseSchema = FieldSchema;
-export const ZUpdateTemplateFieldResponseSchema = FieldSchema;
-export const ZUpdateDocumentFieldResponseSchema = FieldSchema;
-export const ZCreateTemplateFieldResponseSchema = FieldSchema;
+export const ZCreateTemplateFieldResponseSchema = ZFieldSchema;

 export const ZCreateTemplateFieldsRequestSchema = z.object({
-  templateId: z.number().min(1),
+  templateId: z.number(),
  fields: ZCreateFieldSchema.array(),
 });

+export const ZCreateTemplateFieldsResponseSchema = z.object({
+  fields: z.array(ZFieldSchema),
+});
+
 export const ZUpdateTemplateFieldRequestSchema = z.object({
-  templateId: z.number().min(1),
+  templateId: z.number(),
  field: ZUpdateFieldSchema,
 });

 export const ZUpdateTemplateFieldsRequestSchema = z.object({
-  templateId: z.number().min(1),
+  templateId: z.number(),
  fields: ZUpdateFieldSchema.array(),
 });

-export const ZDeleteTemplateFieldRequestSchema = z.object({
-  fieldId: z.number().min(1),
+export const ZUpdateTemplateFieldsResponseSchema = z.object({
+  fields: z.array(ZFieldSchema),
 });

-export const ZAddFieldsMutationSchema = z.object({
+export const ZUpdateTemplateFieldResponseSchema = ZFieldSchema;
+
+export const ZDeleteTemplateFieldRequestSchema = z.object({
+  fieldId: z.number(),
+});
+
+export const ZSetDocumentFieldsRequestSchema = z.object({
  documentId: z.number(),
  fields: z.array(
    z.object({
@@ -98,9 +117,11 @@ export const ZAddFieldsMutationSchema = z.object({
  ),
 });

-export type TAddFieldsMutationSchema = z.infer<typeof ZAddFieldsMutationSchema>;
+export const ZSetDocumentFieldsResponseSchema = z.object({
+  fields: z.array(ZFieldSchema),
+});

-export const ZAddTemplateFieldsMutationSchema = z.object({
+export const ZSetFieldsForTemplateRequestSchema = z.object({
  templateId: z.number(),
  fields: z.array(
    z.object({
@@ -118,7 +139,9 @@ export const ZAddTemplateFieldsMutationSchema = z.object({
  ),
 });

-export type TAddTemplateFieldsMutationSchema = z.infer<typeof ZAddTemplateFieldsMutationSchema>;
+export const ZSetFieldsForTemplateResponseSchema = z.object({
+  fields: z.array(ZFieldSchema),
+});

 export const ZSignFieldWithTokenMutationSchema = z.object({
  token: z.string(),
@@ -139,15 +162,8 @@ export type TRemovedSignedFieldWithTokenMutationSchema = z.infer<
  typeof ZRemovedSignedFieldWithTokenMutationSchema
 >;

-export const ZGetFieldQuerySchema = z.object({
+export const ZGetFieldRequestSchema = z.object({
  fieldId: z.number(),
 });

-export type TGetFieldQuerySchema = z.infer<typeof ZGetFieldQuerySchema>;
-
-export const ZUpdateFieldMutationSchema = z.object({
-  fieldId: z.number(),
-  documentId: z.number(),
-  fieldMeta: ZFieldMetaSchema,
-  teamId: z.number().optional(),
-});
+export const ZGetFieldResponseSchema = ZFieldSchema;