feat: add template and field endpoints (#1572)

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

@@ -8,7 +8,7 @@ import { z } from 'zod';
 
 import { DocumentSource, FieldType } from '@documenso/prisma/client';
 
-import { ZRecipientActionAuthTypesSchema } from './document-auth';
+import { ZRecipientAccessAuthTypesSchema, ZRecipientActionAuthTypesSchema } from './document-auth';
 
 export const ZDocumentAuditLogTypeSchema = z.enum([
   // Document actions.
@@ -127,11 +127,11 @@ export const ZGenericFromToSchema = z.object({
 });
 
 export const ZRecipientDiffActionAuthSchema = ZGenericFromToSchema.extend({
-  type: z.literal(RECIPIENT_DIFF_TYPE.ACCESS_AUTH),
+  type: z.literal(RECIPIENT_DIFF_TYPE.ACTION_AUTH),
 });
 
 export const ZRecipientDiffAccessAuthSchema = ZGenericFromToSchema.extend({
-  type: z.literal(RECIPIENT_DIFF_TYPE.ACTION_AUTH),
+  type: z.literal(RECIPIENT_DIFF_TYPE.ACCESS_AUTH),
 });
 
 export const ZRecipientDiffNameSchema = ZGenericFromToSchema.extend({
@@ -438,6 +438,7 @@ export const ZDocumentAuditLogEventFieldUpdatedSchema = z.object({
 export const ZDocumentAuditLogEventRecipientAddedSchema = z.object({
   type: z.literal(DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_CREATED),
   data: ZBaseRecipientDataSchema.extend({
+    accessAuth: ZRecipientAccessAuthTypesSchema.optional(),
     actionAuth: ZRecipientActionAuthTypesSchema.optional(),
   }),
 });

packages/lib/types/document-auth.ts

@@ -48,7 +48,9 @@ export const ZDocumentAuthMethodsSchema = z.discriminatedUnion('type', [
  * Must keep these two in sync.
  */
 export const ZDocumentAccessAuthSchema = z.discriminatedUnion('type', [ZDocumentAuthAccountSchema]);
-export const ZDocumentAccessAuthTypesSchema = z.enum([DocumentAuth.ACCOUNT]);
+export const ZDocumentAccessAuthTypesSchema = z
+  .enum([DocumentAuth.ACCOUNT])
+  .describe('The type of authentication required for the recipient to access the document.');
 
 /**
  * The global document action auth methods.
@@ -60,11 +62,11 @@ export const ZDocumentActionAuthSchema = z.discriminatedUnion('type', [
   ZDocumentAuthPasskeySchema,
   ZDocumentAuth2FASchema,
 ]);
-export const ZDocumentActionAuthTypesSchema = z.enum([
-  DocumentAuth.ACCOUNT,
-  DocumentAuth.PASSKEY,
-  DocumentAuth.TWO_FACTOR_AUTH,
-]);
+export const ZDocumentActionAuthTypesSchema = z
+  .enum([DocumentAuth.ACCOUNT, DocumentAuth.PASSKEY, DocumentAuth.TWO_FACTOR_AUTH])
+  .describe(
+    'The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only.',
+  );
 
 /**
  * The recipient access auth methods.
@@ -74,7 +76,9 @@ export const ZDocumentActionAuthTypesSchema = z.enum([
 export const ZRecipientAccessAuthSchema = z.discriminatedUnion('type', [
   ZDocumentAuthAccountSchema,
 ]);
-export const ZRecipientAccessAuthTypesSchema = z.enum([DocumentAuth.ACCOUNT]);
+export const ZRecipientAccessAuthTypesSchema = z
+  .enum([DocumentAuth.ACCOUNT])
+  .describe('The type of authentication required for the recipient to access the document.');
 
 /**
  * The recipient action auth methods.
@@ -87,12 +91,14 @@ export const ZRecipientActionAuthSchema = z.discriminatedUnion('type', [
   ZDocumentAuth2FASchema,
   ZDocumentAuthExplicitNoneSchema,
 ]);
-export const ZRecipientActionAuthTypesSchema = z.enum([
-  DocumentAuth.ACCOUNT,
-  DocumentAuth.PASSKEY,
-  DocumentAuth.TWO_FACTOR_AUTH,
-  DocumentAuth.EXPLICIT_NONE,
-]);
+export const ZRecipientActionAuthTypesSchema = z
+  .enum([
+    DocumentAuth.ACCOUNT,
+    DocumentAuth.PASSKEY,
+    DocumentAuth.TWO_FACTOR_AUTH,
+    DocumentAuth.EXPLICIT_NONE,
+  ])
+  .describe('The type of authentication required for the recipient to sign the document.');
 
 export const DocumentAccessAuth = ZDocumentAccessAuthTypesSchema.Enum;
 export const DocumentActionAuth = ZDocumentActionAuthTypesSchema.Enum;

packages/lib/types/document-email.ts

@@ -15,13 +15,44 @@ export enum DocumentEmailEvents {
 
 export const ZDocumentEmailSettingsSchema = z
   .object({
-    recipientSigningRequest: z.boolean().default(true),
-    recipientRemoved: z.boolean().default(true),
-    recipientSigned: z.boolean().default(true),
-    documentPending: z.boolean().default(true),
-    documentCompleted: z.boolean().default(true),
-    documentDeleted: z.boolean().default(true),
-    ownerDocumentCompleted: z.boolean().default(true),
+    recipientSigningRequest: z
+      .boolean()
+      .describe(
+        'Whether to send an email to all recipients that the document is ready for them to sign.',
+      )
+      .default(true),
+    recipientRemoved: z
+      .boolean()
+      .describe(
+        'Whether to send an email to the recipient who was removed from a pending document.',
+      )
+      .default(true),
+    recipientSigned: z
+      .boolean()
+      .describe(
+        'Whether to send an email to the document owner when a recipient has signed the document.',
+      )
+      .default(true),
+    documentPending: z
+      .boolean()
+      .describe(
+        'Whether to send an email to the recipient who has just signed the document indicating that there are still other recipients who need to sign the document. This will only be sent if the document is still pending after the recipient has signed.',
+      )
+      .default(true),
+    documentCompleted: z
+      .boolean()
+      .describe('Whether to send an email to all recipients when the document is complete.')
+      .default(true),
+    documentDeleted: z
+      .boolean()
+      .describe(
+        'Whether to send an email to all recipients if a pending document has been deleted.',
+      )
+      .default(true),
+    ownerDocumentCompleted: z
+      .boolean()
+      .describe('Whether to send an email to the document owner when the document is complete.')
+      .default(true),
   })
   .strip()
   .catch(() => ({

packages/lib/types/search-params.ts

@@ -8,9 +8,9 @@ import { z } from 'zod';
  * Keep this and `ZUrlSearchParamsSchema` in sync.
  */
 export const ZFindSearchParamsSchema = z.object({
-  query: z.string().optional(),
-  page: z.coerce.number().min(1).optional(),
-  perPage: z.coerce.number().min(1).optional(),
+  query: z.string().describe('The search query.').optional(),
+  page: z.coerce.number().min(1).describe('The pagination page number, starts at 1.').optional(),
+  perPage: z.coerce.number().min(1).describe('The number of items per page.').max(100).optional(),
 });
 
 /**
@@ -31,16 +31,17 @@ export const ZUrlSearchParamsSchema = z.object({
   perPage: z.coerce
     .number()
     .min(1)
+    .max(100)
     .optional()
     .catch(() => undefined),
 });
 
 export const ZFindResultResponse = z.object({
-  data: z.union([z.array(z.unknown()), z.unknown()]),
-  count: z.number(),
-  currentPage: z.number(),
-  perPage: z.number(),
-  totalPages: z.number(),
+  data: z.union([z.array(z.unknown()), z.unknown()]).describe('The results from the search.'),
+  count: z.number().describe('The total number of items.'),
+  currentPage: z.number().describe('The current page number, starts at 1.'),
+  perPage: z.number().describe('The number of items per page.'),
+  totalPages: z.number().describe('The total number of pages.'),
 });
 
 // Can't infer generics from Zod.