feat: signature rejection (#1472)

## Description

Adds support for rejecting a given document informing the document
owner.

Flows for resolving a rejection don't currently exist so it's up to the
document owner to reach out to the recipient and work out a way to move
forward via a new document or offline agreement.

## Related Issue


## Changes Made

- Added new rejection properties to the recipient schema
- Added API endpoints to support rejection
- Added email templates for notifying the document owner and recipient
- Added a dialog on the signing page to start the rejection flow.

## Testing Performed

- Manually tested the flow end to end
- Automated tests are planned

apps/web/src/app/(dashboard)/documents/[id]/document-page-view-recent-activity.tsx

@@ -4,7 +4,7 @@ import { useMemo } from 'react';
 
 import { Trans, msg } from '@lingui/macro';
 import { useLingui } from '@lingui/react';
-import { CheckCheckIcon, CheckIcon, Loader, MailOpen } from 'lucide-react';
+import { AlertTriangle, CheckCheckIcon, CheckIcon, Loader, MailOpen } from 'lucide-react';
 import { DateTime } from 'luxon';
 import { match } from 'ts-pattern';
 
@@ -133,6 +133,11 @@ export const DocumentPageViewRecentActivity = ({
                         <CheckIcon className="h-3 w-3" aria-hidden="true" />
                       </div>
                     ))
+                    .with(DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_REJECTED, () => (
+                      <div className="bg-widget rounded-full border border-gray-300 p-1 dark:border-neutral-600">
+                        <AlertTriangle className="h-3 w-3" aria-hidden="true" />
+                      </div>
+                    ))
                     .with(DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_OPENED, () => (
                       <div className="bg-widget rounded-full border border-gray-300 p-1 dark:border-neutral-600">
                         <MailOpen className="h-3 w-3" aria-hidden="true" />

apps/web/src/app/(dashboard)/documents/[id]/document-page-view-recipients.tsx

@@ -4,7 +4,15 @@ import Link from 'next/link';
 
 import { Trans, msg } from '@lingui/macro';
 import { useLingui } from '@lingui/react';
-import { CheckIcon, Clock, MailIcon, MailOpenIcon, PenIcon, PlusIcon } from 'lucide-react';
+import {
+  AlertTriangle,
+  CheckIcon,
+  Clock,
+  MailIcon,
+  MailOpenIcon,
+  PenIcon,
+  PlusIcon,
+} from 'lucide-react';
 import { match } from 'ts-pattern';
 
 import { RECIPIENT_ROLES_DESCRIPTION } from '@documenso/lib/constants/recipient-roles';
@@ -15,6 +23,7 @@ import { CopyTextButton } from '@documenso/ui/components/common/copy-text-button
 import { SignatureIcon } from '@documenso/ui/icons/signature';
 import { AvatarWithText } from '@documenso/ui/primitives/avatar';
 import { Badge } from '@documenso/ui/primitives/badge';
+import { PopoverHover } from '@documenso/ui/primitives/popover';
 import { useToast } from '@documenso/ui/primitives/use-toast';
 
 export type DocumentPageViewRecipientsProps = {
@@ -123,6 +132,26 @@ export const DocumentPageViewRecipients = ({
                   </Badge>
                 )}
 
+              {document.status !== DocumentStatus.DRAFT &&
+                recipient.signingStatus === SigningStatus.REJECTED && (
+                  <PopoverHover
+                    trigger={
+                      <Badge variant="destructive">
+                        <AlertTriangle className="mr-1 h-3 w-3" />
+                        <Trans>Rejected</Trans>
+                      </Badge>
+                    }
+                  >
+                    <p className="text-sm">
+                      <Trans>Reason for rejection: </Trans>
+                    </p>
+
+                    <p className="text-muted-foreground mt-1 text-sm">
+                      {recipient.rejectionReason}
+                    </p>
+                  </PopoverHover>
+                )}
+
               {document.status === DocumentStatus.PENDING &&
                 recipient.signingStatus === SigningStatus.NOT_SIGNED &&
                 recipient.role !== RecipientRole.CC && (

apps/web/src/app/(dashboard)/documents/data-table.tsx

@@ -78,7 +78,7 @@ export const DocumentsDataTable = ({
       {
         header: _(msg`Status`),
         accessorKey: 'status',
-        cell: ({ row }) => <DocumentStatus status={row.getValue('status')} />,
+        cell: ({ row }) => <DocumentStatus status={row.original.status} />,
         size: 140,
       },
       {

apps/web/src/app/(signing)/sign/[token]/page.tsx

@@ -99,6 +99,10 @@ export default async function SigningPage({ params: { token } }: SigningPageProp
 
   const { documentMeta } = document;
 
+  if (recipient.signingStatus === SigningStatus.REJECTED) {
+    return redirect(`/sign/${token}/rejected`);
+  }
+
   if (
     document.status === DocumentStatus.COMPLETED ||
     recipient.signingStatus === SigningStatus.SIGNED

apps/web/src/app/(signing)/sign/[token]/reject-document-dialog.tsx

@@ -0,0 +1,170 @@
+'use client';
+
+import { useEffect, useState } from 'react';
+
+import { useRouter, useSearchParams } from 'next/navigation';
+
+import { zodResolver } from '@hookform/resolvers/zod';
+import { Trans, msg } from '@lingui/macro';
+import { useForm } from 'react-hook-form';
+import { z } from 'zod';
+
+import type { Document } from '@documenso/prisma/client';
+import { trpc } from '@documenso/trpc/react';
+import { Button } from '@documenso/ui/primitives/button';
+import {
+  Dialog,
+  DialogContent,
+  DialogDescription,
+  DialogFooter,
+  DialogHeader,
+  DialogTitle,
+  DialogTrigger,
+} from '@documenso/ui/primitives/dialog';
+import {
+  Form,
+  FormControl,
+  FormField,
+  FormItem,
+  FormMessage,
+} from '@documenso/ui/primitives/form/form';
+import { Textarea } from '@documenso/ui/primitives/textarea';
+import { useToast } from '@documenso/ui/primitives/use-toast';
+
+const ZRejectDocumentFormSchema = z.object({
+  reason: z
+    .string()
+    .min(5, msg`Please provide a reason`)
+    .max(500, msg`Reason must be less than 500 characters`),
+});
+
+type TRejectDocumentFormSchema = z.infer<typeof ZRejectDocumentFormSchema>;
+
+export interface RejectDocumentDialogProps {
+  document: Pick<Document, 'id'>;
+  token: string;
+}
+
+export function RejectDocumentDialog({ document, token }: RejectDocumentDialogProps) {
+  const { toast } = useToast();
+  const router = useRouter();
+  const searchParams = useSearchParams();
+
+  const [isOpen, setIsOpen] = useState(false);
+
+  const { mutateAsync: rejectDocumentWithToken } =
+    trpc.recipient.rejectDocumentWithToken.useMutation();
+
+  const form = useForm<TRejectDocumentFormSchema>({
+    resolver: zodResolver(ZRejectDocumentFormSchema),
+    defaultValues: {
+      reason: '',
+    },
+  });
+
+  const onRejectDocument = async ({ reason }: TRejectDocumentFormSchema) => {
+    try {
+      // TODO: Add trpc mutation here
+      await rejectDocumentWithToken({
+        documentId: document.id,
+        token,
+        reason,
+      });
+
+      toast({
+        title: 'Document rejected',
+        description: 'The document has been successfully rejected.',
+        duration: 5000,
+      });
+
+      setIsOpen(false);
+
+      router.push(`/sign/${token}/rejected`);
+    } catch (err) {
+      toast({
+        title: 'Error',
+        description: 'An error occurred while rejecting the document. Please try again.',
+        variant: 'destructive',
+        duration: 5000,
+      });
+    }
+  };
+
+  useEffect(() => {
+    if (searchParams?.get('reject') === 'true') {
+      setIsOpen(true);
+    }
+  }, []);
+
+  useEffect(() => {
+    if (!isOpen) {
+      form.reset();
+    }
+  }, [isOpen]);
+
+  return (
+    <Dialog open={isOpen} onOpenChange={setIsOpen}>
+      <DialogTrigger asChild>
+        <Button variant="outline">
+          <Trans>Reject Document</Trans>
+        </Button>
+      </DialogTrigger>
+
+      <DialogContent>
+        <DialogHeader>
+          <DialogTitle>
+            <Trans>Reject Document</Trans>
+          </DialogTitle>
+
+          <DialogDescription>
+            <Trans>
+              Are you sure you want to reject this document? This action cannot be undone.
+            </Trans>
+          </DialogDescription>
+        </DialogHeader>
+
+        <Form {...form}>
+          <form onSubmit={form.handleSubmit(onRejectDocument)} className="space-y-4">
+            <FormField
+              control={form.control}
+              name="reason"
+              render={({ field }) => (
+                <FormItem>
+                  <FormControl>
+                    <Textarea
+                      {...field}
+                      rows={4}
+                      placeholder="Please provide a reason for rejecting this document"
+                      disabled={form.formState.isSubmitting}
+                    />
+                  </FormControl>
+                  <FormMessage />
+                </FormItem>
+              )}
+            />
+
+            <DialogFooter>
+              <Button
+                type="button"
+                variant="ghost"
+                onClick={() => setIsOpen(false)}
+                disabled={form.formState.isSubmitting}
+              >
+                <Trans>Cancel</Trans>
+              </Button>
+
+              <Button
+                type="submit"
+                variant="destructive"
+                loading={form.formState.isSubmitting}
+                disabled={!form.formState.isValid}
+              >
+                <Trans>Reject Document</Trans>
+              </Button>
+            </DialogFooter>
+          </form>
+        </Form>
+      </DialogContent>
+    </Dialog>
+  );
+}

apps/web/src/app/(signing)/sign/[token]/rejected/page.tsx

@@ -0,0 +1,110 @@
+import Link from 'next/link';
+import { notFound } from 'next/navigation';
+
+import { Trans } from '@lingui/macro';
+import { XCircle } from 'lucide-react';
+
+import { setupI18nSSR } from '@documenso/lib/client-only/providers/i18n.server';
+import { getServerComponentSession } from '@documenso/lib/next-auth/get-server-component-session';
+import { getDocumentAndSenderByToken } from '@documenso/lib/server-only/document/get-document-by-token';
+import { isRecipientAuthorized } from '@documenso/lib/server-only/document/is-recipient-authorized';
+import { getFieldsForToken } from '@documenso/lib/server-only/field/get-fields-for-token';
+import { getRecipientByToken } from '@documenso/lib/server-only/recipient/get-recipient-by-token';
+import { FieldType } from '@documenso/prisma/client';
+import { Badge } from '@documenso/ui/primitives/badge';
+import { Button } from '@documenso/ui/primitives/button';
+
+import { truncateTitle } from '~/helpers/truncate-title';
+
+import { SigningAuthPageView } from '../signing-auth-page';
+
+export type RejectedSigningPageProps = {
+  params: {
+    token?: string;
+  };
+};
+
+export default async function RejectedSigningPage({ params: { token } }: RejectedSigningPageProps) {
+  await setupI18nSSR();
+
+  if (!token) {
+    return notFound();
+  }
+
+  const { user } = await getServerComponentSession();
+
+  const document = await getDocumentAndSenderByToken({
+    token,
+    requireAccessAuth: false,
+  }).catch(() => null);
+
+  if (!document) {
+    return notFound();
+  }
+
+  const truncatedTitle = truncateTitle(document.title);
+
+  const [fields, recipient] = await Promise.all([
+    getFieldsForToken({ token }),
+    getRecipientByToken({ token }).catch(() => null),
+  ]);
+
+  if (!recipient) {
+    return notFound();
+  }
+
+  const isDocumentAccessValid = await isRecipientAuthorized({
+    type: 'ACCESS',
+    documentAuthOptions: document.authOptions,
+    recipient,
+    userId: user?.id,
+  });
+
+  if (!isDocumentAccessValid) {
+    return <SigningAuthPageView email={recipient.email} />;
+  }
+
+  const recipientName =
+    recipient.name ||
+    fields.find((field) => field.type === FieldType.NAME)?.customText ||
+    recipient.email;
+
+  return (
+    <div className="flex flex-col items-center pt-24 lg:pt-36 xl:pt-44">
+      <Badge variant="neutral" size="default" className="mb-6 rounded-xl border bg-transparent">
+        {truncatedTitle}
+      </Badge>
+
+      <div className="flex flex-col items-center">
+        <div className="flex items-center gap-x-4">
+          <XCircle className="text-destructive h-10 w-10" />
+
+          <h2 className="max-w-[35ch] text-center text-2xl font-semibold leading-normal md:text-3xl lg:text-4xl">
+            <Trans>Document Rejected</Trans>
+          </h2>
+        </div>
+
+        <div className="text-destructive mt-4 flex items-center text-center text-sm">
+          <Trans>You have rejected this document</Trans>
+        </div>
+
+        <p className="text-muted-foreground mt-6 max-w-[60ch] text-center text-sm">
+          <Trans>
+            The document owner has been notified of your decision. They may contact you with further
+            instructions if necessary.
+          </Trans>
+        </p>
+
+        <p className="text-muted-foreground mt-2 max-w-[60ch] text-center text-sm">
+          <Trans>No further action is required from you at this time.</Trans>
+        </p>
+
+        {user && (
+          <Button className="mt-6" asChild>
+            <Link href={`/`}>Return Home</Link>
+          </Button>
+        )}
+      </div>
+    </div>
+  );
+}

apps/web/src/app/(signing)/sign/[token]/signing-page-view.tsx

@@ -31,6 +31,7 @@ import { InitialsField } from './initials-field';
 import { NameField } from './name-field';
 import { NumberField } from './number-field';
 import { RadioField } from './radio-field';
+import { RejectDocumentDialog } from './reject-document-dialog';
 import { SignatureField } from './signature-field';
 import { TextField } from './text-field';
 
@@ -57,28 +58,32 @@ export const SigningPageView = ({
         {document.title}
       </h1>
 
-      <div className="mt-2.5 flex items-center gap-x-6">
-        <p
-          className="text-muted-foreground truncate"
-          title={document.User.name ? document.User.name : ''}
-        >
-          {document.User.name}
-        </p>
-      </div>
+      <div className="mt-2.5 flex flex-wrap items-center justify-between gap-x-6">
+        <div>
+          <p
+            className="text-muted-foreground truncate"
+            title={document.User.name ? document.User.name : ''}
+          >
+            {document.User.name}
+          </p>
 
-      <p className="text-muted-foreground">
-        {match(recipient.role)
-          .with(RecipientRole.VIEWER, () => (
-            <Trans>({document.User.email}) has invited you to view this document</Trans>
-          ))
-          .with(RecipientRole.SIGNER, () => (
-            <Trans>({document.User.email}) has invited you to sign this document</Trans>
-          ))
-          .with(RecipientRole.APPROVER, () => (
-            <Trans>({document.User.email}) has invited you to approve this document</Trans>
-          ))
-          .otherwise(() => null)}
-      </p>
+          <p className="text-muted-foreground">
+            {match(recipient.role)
+              .with(RecipientRole.VIEWER, () => (
+                <Trans>({document.User.email}) has invited you to view this document</Trans>
+              ))
+              .with(RecipientRole.SIGNER, () => (
+                <Trans>({document.User.email}) has invited you to sign this document</Trans>
+              ))
+              .with(RecipientRole.APPROVER, () => (
+                <Trans>({document.User.email}) has invited you to approve this document</Trans>
+              ))
+              .otherwise(() => null)}
+          </p>
+        </div>
+
+        <RejectDocumentDialog document={document} token={recipient.token} />
+      </div>
 
       <div className="mt-8 grid grid-cols-12 gap-y-8 lg:gap-x-8 lg:gap-y-0">
         <Card

apps/web/src/components/(dashboard)/avatar/stack-avatar.tsx

@@ -1,3 +1,4 @@
+import { RecipientStatusType } from '@documenso/lib/client-only/recipient-type';
 import { Avatar, AvatarFallback } from '@documenso/ui/primitives/avatar';
 
 const ZIndexes: { [key: string]: string } = {
@@ -12,7 +13,7 @@ export type StackAvatarProps = {
   first?: boolean;
   zIndex?: string;
   fallbackText?: string;
-  type: 'unsigned' | 'waiting' | 'opened' | 'completed';
+  type: RecipientStatusType;
 };
 
 export const StackAvatar = ({ first, zIndex, fallbackText = '', type }: StackAvatarProps) => {
@@ -24,19 +25,24 @@ export const StackAvatar = ({ first, zIndex, fallbackText = '', type }: StackAva
     zIndexClass = ZIndexes[zIndex] ?? '';
   }
 
+  console.log({ type, fallbackText });
+
   switch (type) {
-    case 'unsigned':
+    case RecipientStatusType.UNSIGNED:
       classes = 'bg-dawn-200 text-dawn-900';
       break;
-    case 'opened':
+    case RecipientStatusType.OPENED:
       classes = 'bg-yellow-200 text-yellow-700';
       break;
-    case 'waiting':
+    case RecipientStatusType.WAITING:
       classes = 'bg-water text-water-700';
       break;
-    case 'completed':
+    case RecipientStatusType.COMPLETED:
       classes = 'bg-documenso-200 text-documenso-800';
       break;
+    case RecipientStatusType.REJECTED:
+      classes = 'bg-red-200 text-red-800';
+      break;
     default:
       break;
   }

apps/web/src/components/(dashboard)/avatar/stack-avatars-with-tooltip.tsx

@@ -8,7 +8,7 @@ import { useLingui } from '@lingui/react';
 import { RecipientStatusType, getRecipientType } from '@documenso/lib/client-only/recipient-type';
 import { RECIPIENT_ROLES_DESCRIPTION } from '@documenso/lib/constants/recipient-roles';
 import { recipientAbbreviation } from '@documenso/lib/utils/recipient-formatter';
-import type { DocumentStatus, Recipient } from '@documenso/prisma/client';
+import { type DocumentStatus, type Recipient } from '@documenso/prisma/client';
 import { PopoverHover } from '@documenso/ui/primitives/popover';
 
 import { AvatarWithRecipient } from './avatar-with-recipient';
@@ -46,7 +46,22 @@ export const StackAvatarsWithTooltip = ({
     (recipient) => getRecipientType(recipient) === RecipientStatusType.UNSIGNED,
   );
 
-  const sortedRecipients = useMemo(() => recipients.sort((a, b) => a.id - b.id), [recipients]);
+  const rejectedRecipients = recipients.filter(
+    (recipient) => getRecipientType(recipient) === RecipientStatusType.REJECTED,
+  );
+
+  const sortedRecipients = useMemo(() => {
+    const otherRecipients = recipients.filter(
+      (recipient) => getRecipientType(recipient) !== RecipientStatusType.REJECTED,
+    );
+
+    return [
+      ...rejectedRecipients.sort((a, b) => a.id - b.id),
+      ...otherRecipients.sort((a, b) => {
+        return a.id - b.id;
+      }),
+    ];
+  }, [recipients]);
 
   return (
     <PopoverHover
@@ -80,6 +95,30 @@ export const StackAvatarsWithTooltip = ({
         </div>
       )}
 
+      {rejectedRecipients.length > 0 && (
+        <div>
+          <h1 className="text-base font-medium">
+            <Trans>Rejected</Trans>
+          </h1>
+          {rejectedRecipients.map((recipient: Recipient) => (
+            <div key={recipient.id} className="my-1 flex items-center gap-2">
+              <StackAvatar
+                first={true}
+                key={recipient.id}
+                type={getRecipientType(recipient)}
+                fallbackText={recipientAbbreviation(recipient)}
+              />
+              <div>
+                <p className="text-muted-foreground text-sm">{recipient.email}</p>
+                <p className="text-muted-foreground/70 text-xs">
+                  {_(RECIPIENT_ROLES_DESCRIPTION[recipient.role].roleName)}
+                </p>
+              </div>
+            </div>
+          ))}
+        </div>
+      )}
+
       {waitingRecipients.length > 0 && (
         <div>
           <h1 className="text-base font-medium">

apps/web/src/components/document/document-history-sheet.tsx

@@ -169,6 +169,7 @@ export const DocumentHistorySheet = ({
                     { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_DELETED },
                     { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_OPENED },
                     { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED },
+                    { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_REJECTED },
                     { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_SENT },
                     { type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_MOVED_TO_TEAM },
                     () => null,