feat: force signature fields for document signers

packages/lib/server-only/document/send-document.tsx

@@ -21,6 +21,7 @@ import {
  RECIPIENT_ROLE_TO_EMAIL_TYPE,
 } from '../../constants/recipient-roles';
 import { getFile } from '../../universal/upload/get-file';
+import { getFieldsForDocument } from '../field/get-fields-for-document';
 import { insertFormValuesInPdf } from '../pdf/insert-form-values-in-pdf';
 import { triggerWebhook } from '../webhooks/trigger/trigger-webhook';
 
@@ -120,6 +121,29 @@ export const sendDocument = async ({
  Object.assign(document, result);
  }
 
+ const fields = await getFieldsForDocument({
+ documentId: documentId,
+ userId: userId,
+ });
+
+ const fieldsWithSignerEmail = fields.map((field) => ({
+ ...field,
+ signerEmail:
+ document.Recipient.find((recipient) => recipient.id === field.recipientId)?.email ?? '',
+ }));
+
+ const everySignerHasSignature = document?.Recipient.every(
+ (recipient) =>
+ recipient.role !== RecipientRole.SIGNER ||
+ fieldsWithSignerEmail.some(
+ (field) => field.type === 'SIGNATURE' && field.signerEmail === recipient.email,
+ ),
+ );
+
+ if (!everySignerHasSignature) {
+ throw new Error('Some signers have not been assigned a signature field.');
+ }
+
  await Promise.all(
  document.Recipient.map(async (recipient) => {
  if (recipient.sendStatus === SendStatus.SENT || recipient.role === RecipientRole.CC) {

packages/ui/primitives/document-flow/add-fields.tsx

@@ -32,6 +32,7 @@ import {
  DocumentFlowFormContainerStep,
 } from './document-flow-root';
 import { FieldItem } from './field-item';
+import { MissingSignatureFieldDialog } from './missing-signature-field-dialog';
 import { type DocumentFlowStep, FRIENDLY_FIELD_TYPE } from './types';
 
 const fontCaveat = Caveat({
@@ -64,6 +65,8 @@ export const AddFieldsFormPartial = ({
  onSubmit,
  isDocumentPdfLoaded,
 }: AddFieldsFormProps) => {
+ const [isMissingSignatureDialogVisible, setIsMissingSignatureDialogVisible] = useState(false);
+
  const { isWithinPageBounds, getFieldPosition, getPage } = useDocumentElement();
  const { currentStep, totalSteps, previousStep } = useStep();
 
@@ -313,6 +316,22 @@ export const AddFieldsFormPartial = ({
  );
  }, [recipientsByRole]);
 
+ const everySignerHasSignature = recipientsByRole.SIGNER.every((signer) =>
+ localFields.some((field) => field.type === 'SIGNATURE' && field.signerEmail === signer.email),
+ );
+
+ const handleGoNextClick = () => {
+ if (!everySignerHasSignature) {
+ setIsMissingSignatureDialogVisible(true);
+ } else {
+ void onFormSubmit();
+ }
+ };
+
+ const handleOpenChange = () => {
+ setIsMissingSignatureDialogVisible((prev) => !prev);
+ };
+
  return (
  <>
  <DocumentFlowFormContainerHeader
@@ -596,9 +615,16 @@ export const AddFieldsFormPartial = ({
  previousStep();
  remove();
  }}
- onGoNextClick={() => void onFormSubmit()}
+ onGoNextClick={handleGoNextClick}
  />
  </DocumentFlowFormContainerFooter>
+
+ {!everySignerHasSignature && (
+ <MissingSignatureFieldDialog
+ isOpen={isMissingSignatureDialogVisible}
+ onOpenChange={handleOpenChange}
+ />
+ )}
  </>
  );
 };

packages/ui/primitives/document-flow/missing-signature-field-dialog.tsx

@@ -0,0 +1,45 @@
+'use client';
+
+import { Button } from '@documenso/ui/primitives/button';
+import {
+ Dialog,
+ DialogContent,
+ DialogDescription,
+ DialogFooter,
+ DialogHeader,
+ DialogTitle,
+} from '@documenso/ui/primitives/dialog';
+
+export type MissingSignatureFieldDialogProps = {
+ isOpen: boolean;
+ onOpenChange: () => void;
+};
+
+export const MissingSignatureFieldDialog = ({
+ isOpen,
+ onOpenChange,
+}: MissingSignatureFieldDialogProps) => {
+ return (
+ <Dialog open={isOpen} onOpenChange={onOpenChange}>
+ <DialogContent className="max-w-lg" position="center">
+ <DialogHeader>
+ <DialogTitle>No signature field found</DialogTitle>
+ <DialogDescription>
+ <p className="mt-2">
+ Some signers have not been assigned a signature field. Please assign at least 1 signature field
+ to each signer before proceeding.
+ </p>
+ </DialogDescription>
+ </DialogHeader>
+ <DialogFooter>
+ <Button type="button" variant="secondary" onClick={onOpenChange}>
+ Cancel
+ </Button>
+ <Button type="submit" onClick={onOpenChange}>
+ Proceed
+ </Button>
+ </DialogFooter>
+ </DialogContent>
+ </Dialog>
+ );
+};