feat: better document rejection (#1702)

Improves the existing document rejection process by actually marking a document as completed cancelling further actions. ## Related Issue N/A ## Changes Made - Added a new rejection status for documents - Updated a million areas that check for document completion - Updated email sending, so rejection is confirmed for the rejecting recipient while other recipients are notified that the document is now cancelled. ## Testing Performed - Ran the testing suite to ensure there are no regressions. - Performed manual testing of current core flows.
2025-11-19 19:21:39 +10:00 · 2025-03-13 15:08:57 +11:00
parent 9f17c1e48e
commit 63a4bab0fe
46 changed files with 520 additions and 110 deletions
--- a/apps/remix/app/routes/_authenticated+/admin+/documents.$id.tsx
+++ b/apps/remix/app/routes/_authenticated+/admin+/documents.$id.tsx
@ -103,7 +103,9 @@ export default function AdminDocumentDetailsPage({ loaderData }: Route.Component
                variant="outline"
                loading={isResealDocumentLoading}
                disabled={document.recipients.some(
-                  (recipient) => recipient.signingStatus !== SigningStatus.SIGNED,
+                  (recipient) =>
+                    recipient.signingStatus !== SigningStatus.SIGNED &&
+                    recipient.signingStatus !== SigningStatus.REJECTED,
                )}
                onClick={() => resealDocument({ id: document.id })}
              >
--- a/apps/remix/app/routes/_authenticated+/documents.$id._index.tsx
+++ b/apps/remix/app/routes/_authenticated+/documents.$id._index.tsx
@ -220,6 +220,9 @@ export default function DocumentPage() {
                  .with(DocumentStatus.COMPLETED, () => (
                    <Trans>This document has been signed by all recipients</Trans>
                  ))
+                  .with(DocumentStatus.REJECTED, () => (
+                    <Trans>This document has been rejected by a recipient</Trans>
+                  ))
                  .with(DocumentStatus.DRAFT, () => (
                    <Trans>This document is currently a draft and has not been sent</Trans>
                  ))
--- a/apps/remix/app/routes/_authenticated+/documents.$id.edit.tsx
+++ b/apps/remix/app/routes/_authenticated+/documents.$id.edit.tsx
@ -1,5 +1,5 @@
 import { Plural, Trans } from '@lingui/react/macro';
-import { DocumentStatus as InternalDocumentStatus, TeamMemberRole } from '@prisma/client';
+import { TeamMemberRole } from '@prisma/client';
 import { ChevronLeft, Users2 } from 'lucide-react';
 import { Link, redirect } from 'react-router';
 import { match } from 'ts-pattern';
@ -9,6 +9,7 @@ import { isUserEnterprise } from '@documenso/ee/server-only/util/is-document-ent
 import { getDocumentWithDetailsById } from '@documenso/lib/server-only/document/get-document-with-details-by-id';
 import { type TGetTeamByUrlResponse, getTeamByUrl } from '@documenso/lib/server-only/team/get-team';
 import { DocumentVisibility } from '@documenso/lib/types/document-visibility';
+import { isDocumentCompleted } from '@documenso/lib/utils/document';
 import { formatDocumentsPath } from '@documenso/lib/utils/teams';

 import { DocumentEditForm } from '~/components/general/document/document-edit-form';
@ -71,7 +72,7 @@ export async function loader({ params, request }: Route.LoaderArgs) {
    throw redirect(documentRootPath);
  }

-  if (document.status === InternalDocumentStatus.COMPLETED) {
+  if (isDocumentCompleted(document.status)) {
    throw redirect(`${documentRootPath}/${documentId}`);
  }

--- a/apps/remix/app/routes/_authenticated+/documents._index.tsx
+++ b/apps/remix/app/routes/_authenticated+/documents._index.tsx
@ -50,6 +50,7 @@ export default function DocumentsPage() {
    [ExtendedDocumentStatus.DRAFT]: 0,
    [ExtendedDocumentStatus.PENDING]: 0,
    [ExtendedDocumentStatus.COMPLETED]: 0,
+    [ExtendedDocumentStatus.REJECTED]: 0,
    [ExtendedDocumentStatus.INBOX]: 0,
    [ExtendedDocumentStatus.ALL]: 0,
  });
--- a/apps/remix/app/routes/_internal+/[__htmltopdf]+/certificate.tsx
+++ b/apps/remix/app/routes/_internal+/[__htmltopdf]+/certificate.tsx
@ -1,6 +1,6 @@
 import { msg } from '@lingui/core/macro';
 import { useLingui } from '@lingui/react';
-import { FieldType } from '@prisma/client';
+import { FieldType, SigningStatus } from '@prisma/client';
 import { DateTime } from 'luxon';
 import { redirect } from 'react-router';
 import { match } from 'ts-pattern';
@ -159,6 +159,13 @@ export default function SigningCertificate({ loaderData }: Route.ComponentProps)
          log.type === DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_COMPLETED &&
          log.data.recipientId === recipientId,
      ),
+      [DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_REJECTED]: auditLogs[
+        DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_REJECTED
+      ].filter(
+        (log) =>
+          log.type === DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_RECIPIENT_REJECTED &&
+          log.data.recipientId === recipientId,
+      ),
    };
  };

@ -282,25 +289,42 @@ export default function SigningCertificate({ loaderData }: Route.ComponentProps)
                          </span>
                        </p>

-                        <p className="text-muted-foreground text-sm print:text-xs">
-                          <span className="font-medium">{_(msg`Signed`)}:</span>{' '}
-                          <span className="inline-block">
-                            {logs.DOCUMENT_RECIPIENT_COMPLETED[0]
-                              ? DateTime.fromJSDate(logs.DOCUMENT_RECIPIENT_COMPLETED[0].createdAt)
-                                  .setLocale(APP_I18N_OPTIONS.defaultLocale)
-                                  .toFormat('yyyy-MM-dd hh:mm:ss a (ZZZZ)')
-                              : _(msg`Unknown`)}
-                          </span>
-                        </p>
+                        {logs.DOCUMENT_RECIPIENT_REJECTED[0] ? (
+                          <p className="text-muted-foreground text-sm print:text-xs">
+                            <span className="font-medium">{_(msg`Rejected`)}:</span>{' '}
+                            <span className="inline-block">
+                              {logs.DOCUMENT_RECIPIENT_REJECTED[0]
+                                ? DateTime.fromJSDate(logs.DOCUMENT_RECIPIENT_REJECTED[0].createdAt)
+                                    .setLocale(APP_I18N_OPTIONS.defaultLocale)
+                                    .toFormat('yyyy-MM-dd hh:mm:ss a (ZZZZ)')
+                                : _(msg`Unknown`)}
+                            </span>
+                          </p>
+                        ) : (
+                          <p className="text-muted-foreground text-sm print:text-xs">
+                            <span className="font-medium">{_(msg`Signed`)}:</span>{' '}
+                            <span className="inline-block">
+                              {logs.DOCUMENT_RECIPIENT_COMPLETED[0]
+                                ? DateTime.fromJSDate(
+                                    logs.DOCUMENT_RECIPIENT_COMPLETED[0].createdAt,
+                                  )
+                                    .setLocale(APP_I18N_OPTIONS.defaultLocale)
+                                    .toFormat('yyyy-MM-dd hh:mm:ss a (ZZZZ)')
+                                : _(msg`Unknown`)}
+                            </span>
+                          </p>
+                        )}

                        <p className="text-muted-foreground text-sm print:text-xs">
                          <span className="font-medium">{_(msg`Reason`)}:</span>{' '}
                          <span className="inline-block">
-                            {_(
-                              isOwner(recipient.email)
-                                ? FRIENDLY_SIGNING_REASONS['__OWNER__']
-                                : FRIENDLY_SIGNING_REASONS[recipient.role],
-                            )}
+                            {recipient.signingStatus === SigningStatus.REJECTED
+                              ? recipient.rejectionReason
+                              : _(
+                                  isOwner(recipient.email)
+                                    ? FRIENDLY_SIGNING_REASONS['__OWNER__']
+                                    : FRIENDLY_SIGNING_REASONS[recipient.role],
+                                )}
                          </span>
                        </p>
                      </div>
--- a/apps/remix/app/routes/_recipient+/sign.$token+/_index.tsx
+++ b/apps/remix/app/routes/_recipient+/sign.$token+/_index.tsx
@ -160,7 +160,7 @@ export default function SigningPage() {
    recipientWithFields,
  } = data;

-  if (document.deletedAt) {
+  if (document.deletedAt || document.status === DocumentStatus.REJECTED) {
    return (
      <div className="-mx-4 flex max-w-[100vw] flex-col items-center overflow-x-hidden px-4 pt-16 md:-mx-8 md:px-8 lg:pt-16 xl:pt-24">
        <SigningCard3D
--- a/apps/remix/app/routes/_recipient+/sign.$token+/complete.tsx
+++ b/apps/remix/app/routes/_recipient+/sign.$token+/complete.tsx
@ -17,6 +17,7 @@ import { getFieldsForToken } from '@documenso/lib/server-only/field/get-fields-f
 import { getRecipientByToken } from '@documenso/lib/server-only/recipient/get-recipient-by-token';
 import { getRecipientSignatures } from '@documenso/lib/server-only/recipient/get-recipient-signatures';
 import { getUserByEmail } from '@documenso/lib/server-only/user/get-user-by-email';
+import { isDocumentCompleted } from '@documenso/lib/utils/document';
 import { env } from '@documenso/lib/utils/env';
 import DocumentDialog from '@documenso/ui/components/document/document-dialog';
 import { DocumentDownloadButton } from '@documenso/ui/components/document/document-download-button';
@ -205,12 +206,12 @@ export default function CompletedSigningPage({ loaderData }: Route.ComponentProp
          <div className="mt-8 flex w-full max-w-sm items-center justify-center gap-4">
            <DocumentShareButton documentId={document.id} token={recipient.token} />

-            {document.status === DocumentStatus.COMPLETED ? (
+            {isDocumentCompleted(document.status) ? (
              <DocumentDownloadButton
                className="flex-1"
                fileName={document.title}
                documentData={document.documentData}
-                disabled={document.status !== DocumentStatus.COMPLETED}
+                disabled={!isDocumentCompleted(document.status)}
              />
            ) : (
              <DocumentDialog
@ -268,7 +269,7 @@ export const PollUntilDocumentCompleted = ({ document }: PollUntilDocumentComple
  const { revalidate } = useRevalidator();

  useEffect(() => {
-    if (document.status === DocumentStatus.COMPLETED) {
+    if (isDocumentCompleted(document.status)) {
      return;
    }

--- a/apps/remix/app/routes/embed+/sign.$url.tsx
+++ b/apps/remix/app/routes/embed+/sign.$url.tsx
@ -1,4 +1,4 @@
-import { DocumentStatus, RecipientRole } from '@prisma/client';
+import { RecipientRole } from '@prisma/client';
 import { data } from 'react-router';
 import { match } from 'ts-pattern';

@ -14,6 +14,7 @@ import { getRecipientByToken } from '@documenso/lib/server-only/recipient/get-re
 import { getRecipientsForAssistant } from '@documenso/lib/server-only/recipient/get-recipients-for-assistant';
 import { getTeamById } from '@documenso/lib/server-only/team/get-team';
 import { DocumentAccessAuth } from '@documenso/lib/types/document-auth';
+import { isDocumentCompleted } from '@documenso/lib/utils/document';
 import { extractDocumentAuthMethods } from '@documenso/lib/utils/document-auth';

 import { EmbedSignDocumentClientPage } from '~/components/embed/embed-document-signing-page';
@ -168,7 +169,7 @@ export default function EmbedSignDocumentPage() {
          recipient={recipient}
          fields={fields}
          metadata={document.documentMeta}
-          isCompleted={document.status === DocumentStatus.COMPLETED}
+          isCompleted={isDocumentCompleted(document.status)}
          hidePoweredBy={
            isCommunityPlan || isPlatformDocument || isEnterpriseDocument || hidePoweredBy
          }