The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
feat: sign document with a custom text
Ephraim Atta-Duncan5687503dfc8a
diff --git a/apps/web/src/app/(signing)/sign/[token]/page.tsx b/apps/web/src/app/(signing)/sign/[token]/page.tsxindex 99b9d1dd7..83cdb93e2 100644--- a/apps/web/src/app/(signing)/sign/[token]/page.tsx+++ b/apps/web/src/app/(signing)/sign/[token]/page.tsx@@ -29,6 +29,7 @@ import { NameField } from './name-field';import { NoLongerAvailable } from './no-longer-available';import { SigningProvider } from './provider';import { SignatureField } from './signature-field';+import { TextField } from './text-field';export type SigningPageProps = {params: {@@ -168,6 +169,9 @@ export default async function SigningPage({ params: { token } }: SigningPageProp.with(FieldType.EMAIL, () => (<EmailField key={field.id} field={field} recipient={recipient} />))+ .with(FieldType.TEXT, () => (+ <TextField key={field.id} field={field} recipient={recipient} />+ )).otherwise(() => null),)}</ElementVisible>diff --git a/apps/web/src/app/(signing)/sign/[token]/provider.tsx b/apps/web/src/app/(signing)/sign/[token]/provider.tsxindex 454007cb0..6531e8a40 100644--- a/apps/web/src/app/(signing)/sign/[token]/provider.tsx+++ b/apps/web/src/app/(signing)/sign/[token]/provider.tsx@@ -9,6 +9,8 @@ export type SigningContextValue = {setEmail: (_value: string) => void;signature: string | null;setSignature: (_value: string | null) => void;+ customText: string;+ setCustomText: (_value: string) => void;};const SigningContext = createContext<SigningContextValue | null>(null);@@ -31,6 +33,7 @@ export interface SigningProviderProps {fullName?: string | null;email?: string | null;signature?: string | null;+ customText?: string | null;children: React.ReactNode;}@@ -38,11 +41,13 @@ export const SigningProvider = ({fullName: initialFullName,email: initialEmail,signature: initialSignature,+ customText: initialCustomText,children,}: SigningProviderProps) => {const [fullName, setFullName] = useState(initialFullName || '');const [email, setEmail] = useState(initialEmail || '');const [signature, setSignature] = useState(initialSignature || null);+ const [customText, setCustomText] = useState(initialCustomText || '');return (<SigningContext.Provider@@ -53,6 +58,8 @@ export const SigningProvider = ({setEmail,signature,setSignature,+ customText,+ setCustomText,}}>{children}diff --git a/apps/web/src/app/(signing)/sign/[token]/text-field.tsx b/apps/web/src/app/(signing)/sign/[token]/text-field.tsxnew file mode 100644index 000000000..d324a50ba--- /dev/null+++ b/apps/web/src/app/(signing)/sign/[token]/text-field.tsx@@ -0,0 +1,178 @@+'use client';++import { useEffect, useState, useTransition } from 'react';++import { useRouter } from 'next/navigation';++import { Loader } from 'lucide-react';++import type { Recipient } from '@documenso/prisma/client';+import type { FieldWithSignature } from '@documenso/prisma/types/field-with-signature';+import { trpc } from '@documenso/trpc/react';+import { Button } from '@documenso/ui/primitives/button';+import { Dialog, DialogContent, DialogFooter, DialogTitle } from '@documenso/ui/primitives/dialog';+import { Label } from '@documenso/ui/primitives/label';+import { Textarea } from '@documenso/ui/primitives/textarea';+import { useToast } from '@documenso/ui/primitives/use-toast';++import { useRequiredSigningContext } from './provider';+import { SigningFieldContainer } from './signing-field-container';++export type TextFieldProps = {+ field: FieldWithSignature;+ recipient: Recipient;+};++export const TextField = ({ field, recipient }: TextFieldProps) => {+ const router = useRouter();++ const { toast } = useToast();+ const { customText: providedCustomText, setCustomText: setProvidedCustomText } =+ useRequiredSigningContext();++ const [isPending, startTransition] = useTransition();++ const { mutateAsync: signFieldWithToken, isLoading: isSignFieldWithTokenLoading } =+ trpc.field.signFieldWithToken.useMutation();++ const {+ mutateAsync: removeSignedFieldWithToken,+ isLoading: isRemoveSignedFieldWithTokenLoading,+ } = trpc.field.removeSignedFieldWithToken.useMutation();++ const isLoading = isSignFieldWithTokenLoading || isRemoveSignedFieldWithTokenLoading || isPending;++ const [showCustomTextModal, setShowCustomTextModal] = useState(false);+ const [localText, setLocalCustomText] = useState('');+ const [isLocalSignatureSet, setIsLocalSignatureSet] = useState(false);++ useEffect(() => {+ if (!showCustomTextModal && !isLocalSignatureSet) {+ setLocalCustomText('');+ }+ }, [showCustomTextModal, isLocalSignatureSet]);++ const onSign = async (source: 'local' | 'provider' = 'provider') => {+ try {+ if (!providedCustomText && !localText) {+ setIsLocalSignatureSet(false);+ setShowCustomTextModal(true);+ return;+ }++ const value = source === 'local' && localText ? localText : providedCustomText ?? '';++ if (!value) {+ return;+ }++ await signFieldWithToken({+ token: recipient.token,+ fieldId: field.id,+ value,+ isBase64: true,+ });++ if (source === 'local' && !providedCustomText) {+ setProvidedCustomText(localText);+ }++ setLocalCustomText('');++ startTransition(() => router.refresh());+ } catch (err) {+ console.error(err);++ toast({+ title: 'Error',+ description: 'An error occurred while signing the document.',+ variant: 'destructive',+ });+ }+ };++ const onRemove = async () => {+ try {+ // Necessary to reset the custom text if the user removes the signature+ setProvidedCustomText('');++ await removeSignedFieldWithToken({+ token: recipient.token,+ fieldId: field.id,+ });++ startTransition(() => router.refresh());+ } catch (err) {+ console.error(err);++ toast({+ title: 'Error',+ description: 'An error occurred while removing the signature.',+ variant: 'destructive',+ });+ }+ };++ return (+ <SigningFieldContainer field={field} onSign={onSign} onRemove={onRemove} type="Signature">+ {isLoading && (+ <div className="bg-background absolute inset-0 flex items-center justify-center rounded-md">+ <Loader className="text-primary h-5 w-5 animate-spin md:h-8 md:w-8" />+ </div>+ )}++ {!field.inserted && (+ <p className="group-hover:text-primary text-muted-foreground text-lg duration-200">Text</p>+ )}++ {field.inserted && <p className="text-muted-foreground duration-200">{field.customText}</p>}++ <Dialog open={showCustomTextModal} onOpenChange={setShowCustomTextModal}>+ <DialogContent>+ <DialogTitle>+ Enter a Text <span className="text-muted-foreground">({recipient.email})</span>+ </DialogTitle>++ <div className="">+ <Label htmlFor="signature">Custom Text</Label>++ <Textarea+ id="custom-text"+ className="border-border mt-2 h-44 w-full rounded-md border"+ onChange={(e) => setLocalCustomText(e.target.value)}+ />+ </div>++ <DialogFooter>+ <div className="flex w-full flex-1 flex-nowrap gap-4">+ <Button+ type="button"+ className="dark:bg-muted dark:hover:bg-muted/80 flex-1 bg-black/5 hover:bg-black/10"+ variant="secondary"+ onClick={() => {+ setShowCustomTextModal(false);+ setLocalCustomText('');+ }}+ >+ Cancel+ </Button>++ <Button+ type="button"+ className="flex-1"+ disabled={!localText}+ onClick={() => {+ setShowCustomTextModal(false);+ setIsLocalSignatureSet(true);+ void onSign('local');+ }}+ >+ Save Text+ </Button>+ </div>+ </DialogFooter>+ </DialogContent>+ </Dialog>+ </SigningFieldContainer>+ );+};diff --git a/packages/ui/primitives/document-flow/add-fields.tsx b/packages/ui/primitives/document-flow/add-fields.tsxindex a6266d1aa..f5b839158 100644--- a/packages/ui/primitives/document-flow/add-fields.tsx+++ b/packages/ui/primitives/document-flow/add-fields.tsx@@ -552,6 +552,28 @@ export const AddFieldsFormPartial = ({</CardContent></Card></button>++ <button+ type="button"+ className="group h-full w-full"+ onClick={() => setSelectedField(FieldType.TEXT)}+ onMouseDown={() => setSelectedField(FieldType.TEXT)}+ data-selected={selectedField === FieldType.TEXT ? true : undefined}+ >+ <Card className="group-data-[selected]:border-documenso h-full w-full cursor-pointer group-disabled:opacity-50">+ <CardContent className="flex flex-col items-center justify-center px-6 py-4">+ <p+ className={cn(+ 'text-muted-foreground group-data-[selected]:text-foreground text-xl font-medium',+ )}+ >+ {'Text'}+ </p>++ <p className="text-muted-foreground mt-2 text-xs">Custom Text</p>+ </CardContent>+ </Card>+ </button></fieldset></div></div>