feat: add typed signature (#1357)

Add the ability to insert typed signatures.

Once the signature field is placed on the document, a checkbox appears
in the document editor where the document owner can allow signers to add
typed signatures. Typed signatures are disabled by default.

![CleanShot 2024-09-30 at 14 57
54](https://github.com/user-attachments/assets/c388abb5-bcb1-49d0-aad8-9148c3020420)

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

@@ -112,6 +112,24 @@ export const EditDocumentForm = ({
     },
   });
 
+  const { mutateAsync: updateTypedSignature } =
+    trpc.document.updateTypedSignatureSettings.useMutation({
+      ...DO_NOT_INVALIDATE_QUERY_ON_MUTATION,
+      onSuccess: (newData) => {
+        utils.document.getDocumentWithDetailsById.setData(
+          {
+            id: initialDocument.id,
+            teamId: team?.id,
+          },
+          (oldData) => ({
+            ...(oldData || initialDocument),
+            ...newData,
+            id: Number(newData.id),
+          }),
+        );
+      },
+    });
+
   const { mutateAsync: addSigners } = trpc.recipient.addSigners.useMutation({
     ...DO_NOT_INVALIDATE_QUERY_ON_MUTATION,
     onSuccess: (newRecipients) => {
@@ -258,6 +276,11 @@ export const EditDocumentForm = ({
         fields: data.fields,
       });
 
+      await updateTypedSignature({
+        documentId: document.id,
+        typedSignatureEnabled: data.typedSignatureEnabled,
+      });
+
       // Clear all field data from localStorage
       for (let i = 0; i < localStorage.length; i++) {
         const key = localStorage.key(i);
@@ -387,6 +410,7 @@ export const EditDocumentForm = ({
               fields={fields}
               onSubmit={onAddFieldsFormSubmit}
               isDocumentPdfLoaded={isDocumentPdfLoaded}
+              typedSignatureEnabled={document.documentMeta?.typedSignatureEnabled}
               teamId={team?.id}
             />
 

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

@@ -9,9 +9,10 @@ import { useSession } from 'next-auth/react';
 import { useForm } from 'react-hook-form';
 
 import { useAnalytics } from '@documenso/lib/client-only/hooks/use-analytics';
+import type { DocumentAndSender } from '@documenso/lib/server-only/document/get-document-by-token';
 import type { TRecipientActionAuth } from '@documenso/lib/types/document-auth';
 import { sortFieldsByPosition, validateFieldsInserted } from '@documenso/lib/utils/fields';
-import { type Document, type Field, type Recipient, RecipientRole } from '@documenso/prisma/client';
+import { type Field, type Recipient, RecipientRole } from '@documenso/prisma/client';
 import { trpc } from '@documenso/trpc/react';
 import { FieldToolTip } from '@documenso/ui/components/field/field-tooltip';
 import { cn } from '@documenso/ui/lib/utils';
@@ -25,7 +26,7 @@ import { useRequiredSigningContext } from './provider';
 import { SignDialog } from './sign-dialog';
 
 export type SigningFormProps = {
-  document: Document;
+  document: DocumentAndSender;
   recipient: Recipient;
   fields: Field[];
   redirectUrl?: string | null;
@@ -196,6 +197,7 @@ export const SigningForm = ({
                           onChange={(value) => {
                             setSignature(value);
                           }}
+                          allowTypedSignature={document.documentMeta?.typedSignatureEnabled}
                         />
                       </CardContent>
                     </Card>

apps/web/src/app/(signing)/sign/[token]/signature-field.tsx

@@ -31,12 +31,12 @@ import { useRequiredSigningContext } from './provider';
 import { SigningFieldContainer } from './signing-field-container';
 
 type SignatureFieldState = 'empty' | 'signed-image' | 'signed-text';
-
 export type SignatureFieldProps = {
   field: FieldWithSignature;
   recipient: Recipient;
   onSignField?: (value: TSignFieldWithTokenMutationSchema) => Promise<void> | void;
   onUnsignField?: (value: TRemovedSignedFieldWithTokenMutationSchema) => Promise<void> | void;
+  typedSignatureEnabled?: boolean;
 };
 
 export const SignatureField = ({
@@ -44,6 +44,7 @@ export const SignatureField = ({
   recipient,
   onSignField,
   onUnsignField,
+  typedSignatureEnabled,
 }: SignatureFieldProps) => {
   const router = useRouter();
 
@@ -92,14 +93,12 @@ export const SignatureField = ({
 
     return true;
   };
-
   /**
    * When the user clicks the sign button in the dialog where they enter their signature.
    */
   const onDialogSignClick = () => {
     setShowSignatureModal(false);
     setProvidedSignature(localSignature);
-
     if (!localSignature) {
       return;
     }
@@ -109,7 +108,6 @@ export const SignatureField = ({
       actionTarget: field.type,
     });
   };
-
   const onSign = async (authOptions?: TRecipientActionAuth, signature?: string) => {
     try {
       const value = signature || providedSignature;
@@ -231,11 +229,11 @@ export const SignatureField = ({
               id="signature"
               className="border-border mt-2 h-44 w-full rounded-md border"
               onChange={(value) => setLocalSignature(value)}
+              allowTypedSignature={typedSignatureEnabled}
             />
           </div>
 
           <SigningDisclosure />
-
           <DialogFooter>
             <div className="flex w-full flex-1 flex-nowrap gap-4">
               <Button
@@ -249,7 +247,6 @@ export const SignatureField = ({
               >
                 <Trans>Cancel</Trans>
               </Button>
-
               <Button
                 type="button"
                 className="flex-1"

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

@@ -112,7 +112,12 @@ export const SigningPageView = ({
         {fields.map((field) =>
           match(field.type)
             .with(FieldType.SIGNATURE, () => (
-              <SignatureField key={field.id} field={field} recipient={recipient} />
+              <SignatureField
+                key={field.id}
+                field={field}
+                recipient={recipient}
+                typedSignatureEnabled={documentMeta?.typedSignatureEnabled}
+              />
             ))
             .with(FieldType.INITIALS, () => (
               <InitialsField key={field.id} field={field} recipient={recipient} />