feat: signing order (#1290)

Adds the ability to specify an optional signing order for documents.
When specified a document will be considered sequential with recipients
only being allowed to sign in the order that they were specified in.

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

@@ -40,6 +40,7 @@ import {
   ZSendDocumentMutationSchema,
   ZSetPasswordForDocumentMutationSchema,
   ZSetSettingsForDocumentMutationSchema,
+  ZSetSigningOrderForDocumentMutationSchema,
   ZSetTitleForDocumentMutationSchema,
 } from './schema';
 
@@ -308,6 +309,29 @@ export const documentRouter = router({
       }
     }),
 
+  setSigningOrderForDocument: authenticatedProcedure
+    .input(ZSetSigningOrderForDocumentMutationSchema)
+    .mutation(async ({ input, ctx }) => {
+      try {
+        const { documentId, signingOrder } = input;
+
+        return await upsertDocumentMeta({
+          documentId,
+          signingOrder,
+          userId: ctx.user.id,
+          requestMetadata: extractNextApiRequestMetadata(ctx.req),
+        });
+      } catch (err) {
+        console.error(err);
+
+        throw new TRPCError({
+          code: 'BAD_REQUEST',
+          message:
+            'We were unable to update the settings for this document. Please try again later.',
+        });
+      }
+    }),
+
   sendDocument: authenticatedProcedure
     .input(ZSendDocumentMutationSchema)
     .mutation(async ({ input, ctx }) => {

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

@@ -6,7 +6,7 @@ import {
 } from '@documenso/lib/types/document-auth';
 import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { isValidRedirectUrl } from '@documenso/lib/utils/is-valid-redirect-url';
-import { FieldType, RecipientRole } from '@documenso/prisma/client';
+import { DocumentSigningOrder, FieldType, RecipientRole } from '@documenso/prisma/client';
 
 export const ZFindDocumentAuditLogsQuerySchema = ZBaseTableSearchParamsSchema.extend({
   documentId: z.number().min(1),
@@ -148,6 +148,15 @@ export type TSetPasswordForDocumentMutationSchema = z.infer<
   typeof ZSetPasswordForDocumentMutationSchema
 >;
 
+export const ZSetSigningOrderForDocumentMutationSchema = z.object({
+  documentId: z.number(),
+  signingOrder: z.nativeEnum(DocumentSigningOrder),
+});
+
+export type TSetSigningOrderForDocumentMutationSchema = z.infer<
+  typeof ZSetSigningOrderForDocumentMutationSchema
+>;
+
 export const ZResendDocumentMutationSchema = z.object({
   documentId: z.number(),
   recipients: z.array(z.number()).min(1),

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

@@ -28,6 +28,7 @@ export const recipientRouter = router({
             email: signer.email,
             name: signer.name,
             role: signer.role,
+            signingOrder: signer.signingOrder,
             actionAuth: signer.actionAuth,
           })),
           requestMetadata: extractNextApiRequestMetadata(ctx.req),
@@ -57,6 +58,7 @@ export const recipientRouter = router({
             email: signer.email,
             name: signer.name,
             role: signer.role,
+            signingOrder: signer.signingOrder,
             actionAuth: signer.actionAuth,
           })),
         });

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

@@ -16,6 +16,7 @@ export const ZAddSignersMutationSchema = z
         email: z.string().email().min(1),
         name: z.string(),
         role: z.nativeEnum(RecipientRole),
+        signingOrder: z.number().optional(),
         actionAuth: ZRecipientActionAuthTypesSchema.optional().nullable(),
       }),
     ),
@@ -42,6 +43,7 @@ export const ZAddTemplateSignersMutationSchema = z
         email: z.string().email().min(1),
         name: z.string(),
         role: z.nativeEnum(RecipientRole),
+        signingOrder: z.number().optional(),
         actionAuth: ZRecipientActionAuthTypesSchema.optional().nullable(),
       }),
     ),

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

@@ -31,6 +31,7 @@ import {
   ZFindTemplatesQuerySchema,
   ZGetTemplateWithDetailsByIdQuerySchema,
   ZMoveTemplatesToTeamSchema,
+  ZSetSigningOrderForTemplateMutationSchema,
   ZToggleTemplateDirectLinkMutationSchema,
   ZUpdateTemplateSettingsMutationSchema,
 } from './schema';
@@ -227,6 +228,31 @@ export const templateRouter = router({
       }
     }),
 
+  setSigningOrderForTemplate: authenticatedProcedure
+    .input(ZSetSigningOrderForTemplateMutationSchema)
+    .mutation(async ({ input, ctx }) => {
+      try {
+        const { templateId, teamId, signingOrder } = input;
+
+        return await updateTemplateSettings({
+          templateId,
+          teamId,
+          data: {},
+          meta: { signingOrder },
+          userId: ctx.user.id,
+          requestMetadata: extractNextApiRequestMetadata(ctx.req),
+        });
+      } catch (err) {
+        console.error(err);
+
+        throw new TRPCError({
+          code: 'BAD_REQUEST',
+          message:
+            'We were unable to update the settings for this document. Please try again later.',
+        });
+      }
+    }),
+
   findTemplates: authenticatedProcedure
     .input(ZFindTemplatesQuerySchema)
     .query(async ({ input, ctx }) => {

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

@@ -6,7 +6,7 @@ import {
 } from '@documenso/lib/types/document-auth';
 import { ZBaseTableSearchParamsSchema } from '@documenso/lib/types/search-params';
 import { isValidRedirectUrl } from '@documenso/lib/utils/is-valid-redirect-url';
-import { TemplateType } from '@documenso/prisma/client';
+import { DocumentSigningOrder, TemplateType } from '@documenso/prisma/client';
 
 import { ZSignFieldWithTokenMutationSchema } from '../field-router/schema';
 
@@ -105,6 +105,12 @@ export const ZUpdateTemplateSettingsMutationSchema = z.object({
     .optional(),
 });
 
+export const ZSetSigningOrderForTemplateMutationSchema = z.object({
+  templateId: z.number(),
+  teamId: z.number().optional(),
+  signingOrder: z.nativeEnum(DocumentSigningOrder),
+});
+
 export const ZFindTemplatesQuerySchema = ZBaseTableSearchParamsSchema.extend({
   teamId: z.number().optional(),
   type: z.nativeEnum(TemplateType).optional(),