The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
fix: improve mobile signing ux (#2003)
Lucas Smith657db3bc84a4
diff --git a/apps/remix/app/components/embed/embed-direct-template-client-page.tsx b/apps/remix/app/components/embed/embed-direct-template-client-page.tsxindex 8b883a36b..db429f7e4 100644--- a/apps/remix/app/components/embed/embed-direct-template-client-page.tsx+++ b/apps/remix/app/components/embed/embed-direct-template-client-page.tsx@@ -57,7 +57,7 @@ export const EmbedDirectTemplateClientPage = ({token,updatedAt,documentData,- recipient,+ recipient: _recipient,fields,metadata,hidePoweredBy = false,@@ -95,6 +95,8 @@ export const EmbedDirectTemplateClientPage = ({const hasSignatureField = localFields.some((field) => field.type === FieldType.SIGNATURE);+ const signatureValid = !hasSignatureField || (signature && signature.trim() !== '');+const { mutateAsync: createDocumentFromDirectTemplate, isPending: isSubmitting } =trpc.template.createDocumentFromDirectTemplate.useMutation();@@ -345,19 +347,34 @@ export const EmbedDirectTemplateClientPage = ({<Trans>Sign document</Trans></h3>- <Button variant="outline" className="h-8 w-8 p-0 md:hidden">- {isExpanded ? (- <LucideChevronDown- className="text-muted-foreground h-5 w-5"- onClick={() => setIsExpanded(false)}- />- ) : (- <LucideChevronUp- className="text-muted-foreground h-5 w-5"- onClick={() => setIsExpanded(true)}- />- )}- </Button>+ {isExpanded ? (+ <Button+ variant="outline"+ className="h-8 w-8 p-0 md:hidden"+ onClick={() => setIsExpanded(false)}+ >+ <LucideChevronDown className="text-muted-foreground h-5 w-5" />+ </Button>+ ) : pendingFields.length > 0 ? (+ <Button+ variant="outline"+ className="h-8 w-8 p-0 md:hidden"+ onClick={() => setIsExpanded(true)}+ >+ <LucideChevronUp className="text-muted-foreground h-5 w-5" />+ </Button>+ ) : (+ <Button+ variant="default"+ size="sm"+ className="md:hidden"+ disabled={isThrottled || (hasSignatureField && !signatureValid)}+ loading={isSubmitting}+ onClick={() => throttledOnCompleteClick()}+ >+ <Trans>Complete</Trans>+ </Button>+ )}</div></div>diff --git a/apps/remix/app/components/embed/embed-document-signing-page.tsx b/apps/remix/app/components/embed/embed-document-signing-page.tsxindex d7d8a0713..2f24dceeb 100644--- a/apps/remix/app/components/embed/embed-document-signing-page.tsx+++ b/apps/remix/app/components/embed/embed-document-signing-page.tsx@@ -89,7 +89,7 @@ export const EmbedSignDocumentClientPage = ({const [isExpanded, setIsExpanded] = useState(false);const [isNameLocked, setIsNameLocked] = useState(false);const [showPendingFieldTooltip, setShowPendingFieldTooltip] = useState(false);- const [showOtherRecipientsCompletedFields, setShowOtherRecipientsCompletedFields] =+ const [_showOtherRecipientsCompletedFields, setShowOtherRecipientsCompletedFields] =useState(false);const [allowDocumentRejection, setAllowDocumentRejection] = useState(false);@@ -118,6 +118,8 @@ export const EmbedSignDocumentClientPage = ({const hasSignatureField = fields.some((field) => field.type === FieldType.SIGNATURE);+ const signatureValid = !hasSignatureField || (signature && signature.trim() !== '');+const assistantSignersId = useId();const onNextFieldClick = () => {@@ -307,19 +309,36 @@ export const EmbedSignDocumentClientPage = ({)}</h3>- <Button variant="outline" className="h-8 w-8 p-0 md:hidden">- {isExpanded ? (- <LucideChevronDown- className="text-muted-foreground h-5 w-5"- onClick={() => setIsExpanded(false)}- />- ) : (- <LucideChevronUp- className="text-muted-foreground h-5 w-5"- onClick={() => setIsExpanded(true)}- />- )}- </Button>+ {isExpanded ? (+ <Button+ variant="outline"+ className="bg-background dark:bg-foreground h-8 w-8 p-0 md:hidden"+ onClick={() => setIsExpanded(false)}+ >+ <LucideChevronDown className="text-muted-foreground dark:text-background h-5 w-5" />+ </Button>+ ) : pendingFields.length > 0 ? (+ <Button+ variant="outline"+ className="bg-background dark:bg-foreground h-8 w-8 p-0 md:hidden"+ onClick={() => setIsExpanded(true)}+ >+ <LucideChevronUp className="text-muted-foreground dark:text-background h-5 w-5" />+ </Button>+ ) : (+ <Button+ variant="default"+ size="sm"+ className="md:hidden"+ disabled={+ isThrottled || (!isAssistantMode && hasSignatureField && !signatureValid)+ }+ loading={isSubmitting}+ onClick={() => throttledOnCompleteClick()}+ >+ <Trans>Complete</Trans>+ </Button>+ )}</div></div>diff --git a/apps/remix/app/components/general/document-signing/document-signing-form.tsx b/apps/remix/app/components/general/document-signing/document-signing-form.tsxindex b3356bee8..b2b58aa3b 100644--- a/apps/remix/app/components/general/document-signing/document-signing-form.tsx+++ b/apps/remix/app/components/general/document-signing/document-signing-form.tsx@@ -7,14 +7,11 @@ import { type Field, FieldType, type Recipient, RecipientRole } from '@prisma/climport { Controller, useForm } from 'react-hook-form';import { useNavigate } from 'react-router';-import { useAnalytics } from '@documenso/lib/client-only/hooks/use-analytics';-import { useOptionalSession } from '@documenso/lib/client-only/providers/session';import type { DocumentAndSender } from '@documenso/lib/server-only/document/get-document-by-token';import type { TRecipientActionAuth } from '@documenso/lib/types/document-auth';import { isFieldUnsignedAndRequired } from '@documenso/lib/utils/advanced-fields-helpers';-import { sortFieldsByPosition, validateFieldsInserted } from '@documenso/lib/utils/fields';+import { sortFieldsByPosition } from '@documenso/lib/utils/fields';import type { RecipientWithFields } from '@documenso/prisma/types/recipient-with-fields';-import { trpc } from '@documenso/trpc/react';import { FieldToolTip } from '@documenso/ui/components/field/field-tooltip';import { Button } from '@documenso/ui/primitives/button';import { Input } from '@documenso/ui/primitives/input';@@ -34,29 +31,33 @@ export type DocumentSigningFormProps = {document: DocumentAndSender;recipient: Recipient;fields: Field[];- redirectUrl?: string | null;isRecipientsTurn: boolean;allRecipients?: RecipientWithFields[];setSelectedSignerId?: (id: number | null) => void;+ completeDocument: (+ authOptions?: TRecipientActionAuth,+ nextSigner?: { email: string; name: string },+ ) => Promise<void>;+ isSubmitting: boolean;+ fieldsValidated: () => void;+ nextRecipient?: RecipientWithFields;};export const DocumentSigningForm = ({document,recipient,fields,- redirectUrl,isRecipientsTurn,allRecipients = [],setSelectedSignerId,+ completeDocument,+ isSubmitting,+ fieldsValidated,+ nextRecipient,}: DocumentSigningFormProps) => {- const { sessionData } = useOptionalSession();- const user = sessionData?.user;-const { _ } = useLingui();const { toast } = useToast();-const navigate = useNavigate();- const analytics = useAnalytics();const assistantSignersId = useId();@@ -66,21 +67,12 @@ export const DocumentSigningForm = ({const [isConfirmationDialogOpen, setIsConfirmationDialogOpen] = useState(false);const [isAssistantSubmitting, setIsAssistantSubmitting] = useState(false);- const {- mutateAsync: completeDocumentWithToken,- isPending,- isSuccess,- } = trpc.recipient.completeDocumentWithToken.useMutation();-const assistantForm = useForm<{ selectedSignerId: number | undefined }>({defaultValues: {selectedSignerId: undefined,},});- // Keep the loading state going if successful since the redirect may take some time.- const isSubmitting = isPending || isSuccess;-const fieldsRequiringValidation = useMemo(() => fields.filter(isFieldUnsignedAndRequired),[fields],@@ -96,9 +88,9 @@ export const DocumentSigningForm = ({return fieldsRequiringValidation.filter((field) => field.recipientId === recipient.id);}, [fieldsRequiringValidation, recipient]);- const fieldsValidated = () => {+ const localFieldsValidated = () => {setValidateUninsertedFields(true);- validateFieldsInserted(fieldsRequiringValidation);+ fieldsValidated();};const onAssistantFormSubmit = () => {@@ -126,55 +118,6 @@ export const DocumentSigningForm = ({}};- const completeDocument = async (- authOptions?: TRecipientActionAuth,- nextSigner?: { email: string; name: string },- ) => {- const payload = {- token: recipient.token,- documentId: document.id,- authOptions,- ...(nextSigner?.email && nextSigner?.name ? { nextSigner } : {}),- };-- await completeDocumentWithToken(payload);-- analytics.capture('App: Recipient has completed signing', {- signerId: recipient.id,- documentId: document.id,- timestamp: new Date().toISOString(),- });-- if (redirectUrl) {- window.location.href = redirectUrl;- } else {- await navigate(`/sign/${recipient.token}/complete`);- }- };-- const nextRecipient = useMemo(() => {- if (- !document.documentMeta?.signingOrder ||- document.documentMeta.signingOrder !== 'SEQUENTIAL'- ) {- return undefined;- }-- const sortedRecipients = allRecipients.sort((a, b) => {- // Sort by signingOrder first (nulls last), then by id- if (a.signingOrder === null && b.signingOrder === null) return a.id - b.id;- if (a.signingOrder === null) return 1;- if (b.signingOrder === null) return -1;- if (a.signingOrder === b.signingOrder) return a.id - b.id;- return a.signingOrder - b.signingOrder;- });-- const currentIndex = sortedRecipients.findIndex((r) => r.id === recipient.id);- return currentIndex !== -1 && currentIndex < sortedRecipients.length - 1- ? sortedRecipients[currentIndex + 1]- : undefined;- }, [document.documentMeta?.signingOrder, allRecipients, recipient.id]);-return (<div className="flex h-full flex-col">{validateUninsertedFields && uninsertedFields[0] && (@@ -205,7 +148,7 @@ export const DocumentSigningForm = ({isSubmitting={isSubmitting}documentTitle={document.title}fields={fields}- fieldsValidated={fieldsValidated}+ fieldsValidated={localFieldsValidated}onSignatureComplete={async (nextSigner) => {await completeDocument(undefined, nextSigner);}}@@ -364,7 +307,7 @@ export const DocumentSigningForm = ({isSubmitting={isSubmitting || isAssistantSubmitting}documentTitle={document.title}fields={fields}- fieldsValidated={fieldsValidated}+ fieldsValidated={localFieldsValidated}disabled={!isRecipientsTurn}onSignatureComplete={async (nextSigner) => {await completeDocument(undefined, nextSigner);diff --git a/apps/remix/app/components/general/document-signing/document-signing-page-view.tsx b/apps/remix/app/components/general/document-signing/document-signing-page-view.tsxindex cbbdc7926..626a5195f 100644--- a/apps/remix/app/components/general/document-signing/document-signing-page-view.tsx+++ b/apps/remix/app/components/general/document-signing/document-signing-page-view.tsx@@ -1,15 +1,18 @@-import { useState } from 'react';+import { useMemo, useState } from 'react';import { Trans } from '@lingui/react/macro';import type { Field } from '@prisma/client';import { FieldType, RecipientRole } from '@prisma/client';import { LucideChevronDown, LucideChevronUp } from 'lucide-react';-import { match } from 'ts-pattern';+import { useNavigate } from 'react-router';+import { P, match } from 'ts-pattern';+import { useAnalytics } from '@documenso/lib/client-only/hooks/use-analytics';import { DEFAULT_DOCUMENT_DATE_FORMAT } from '@documenso/lib/constants/date-formats';import { PDF_VIEWER_PAGE_SELECTOR } from '@documenso/lib/constants/pdf-viewer';import { DEFAULT_DOCUMENT_TIME_ZONE } from '@documenso/lib/constants/time-zones';import type { DocumentAndSender } from '@documenso/lib/server-only/document/get-document-by-token';+import type { TRecipientActionAuth } from '@documenso/lib/types/document-auth';import {ZCheckboxFieldMeta,ZDropdownFieldMeta,@@ -18,8 +21,11 @@ import {ZTextFieldMeta,} from '@documenso/lib/types/field-meta';import type { CompletedField } from '@documenso/lib/types/fields';+import { isFieldUnsignedAndRequired } from '@documenso/lib/utils/advanced-fields-helpers';+import { validateFieldsInserted } from '@documenso/lib/utils/fields';import type { FieldWithSignatureAndFieldMeta } from '@documenso/prisma/types/field-with-signature-and-fieldmeta';import type { RecipientWithFields } from '@documenso/prisma/types/recipient-with-fields';+import { trpc } from '@documenso/trpc/react';import { DocumentReadOnlyFields } from '@documenso/ui/components/document/document-read-only-fields';import { Button } from '@documenso/ui/primitives/button';import { Card, CardContent } from '@documenso/ui/primitives/card';@@ -40,6 +46,7 @@ import { DocumentSigningRejectDialog } from '~/components/general/document-signiimport { DocumentSigningSignatureField } from '~/components/general/document-signing/document-signing-signature-field';import { DocumentSigningTextField } from '~/components/general/document-signing/document-signing-text-field';+import { DocumentSigningCompleteDialog } from './document-signing-complete-dialog';import { DocumentSigningRecipientProvider } from './document-signing-recipient-provider';export type DocumentSigningPageViewProps = {@@ -63,9 +70,56 @@ export const DocumentSigningPageView = ({}: DocumentSigningPageViewProps) => {const { documentData, documentMeta } = document;+ const navigate = useNavigate();+ const analytics = useAnalytics();+const [selectedSignerId, setSelectedSignerId] = useState<number | null>(allRecipients?.[0]?.id);const [isExpanded, setIsExpanded] = useState(false);+ const {+ mutateAsync: completeDocumentWithToken,+ isPending,+ isSuccess,+ } = trpc.recipient.completeDocumentWithToken.useMutation();++ // Keep the loading state going if successful since the redirect may take some time.+ const isSubmitting = isPending || isSuccess;++ const fieldsRequiringValidation = useMemo(+ () => fields.filter(isFieldUnsignedAndRequired),+ [fields],+ );++ const fieldsValidated = () => {+ validateFieldsInserted(fieldsRequiringValidation);+ };++ const completeDocument = async (+ authOptions?: TRecipientActionAuth,+ nextSigner?: { email: string; name: string },+ ) => {+ const payload = {+ token: recipient.token,+ documentId: document.id,+ authOptions,+ ...(nextSigner?.email && nextSigner?.name ? { nextSigner } : {}),+ };++ await completeDocumentWithToken(payload);++ analytics.capture('App: Recipient has completed signing', {+ signerId: recipient.id,+ documentId: document.id,+ timestamp: new Date().toISOString(),+ });++ if (documentMeta?.redirectUrl) {+ window.location.href = documentMeta.redirectUrl;+ } else {+ await navigate(`/sign/${recipient.token}/complete`);+ }+ };+let senderName = document.user.name ?? '';let senderEmail = `(${document.user.email})`;@@ -78,8 +132,31 @@ export const DocumentSigningPageView = ({const targetSigner =recipient.role === RecipientRole.ASSISTANT && selectedSigner ? selectedSigner : null;+ const nextRecipient = useMemo(() => {+ if (!documentMeta?.signingOrder || documentMeta.signingOrder !== 'SEQUENTIAL') {+ return undefined;+ }++ const sortedRecipients = allRecipients.sort((a, b) => {+ // Sort by signingOrder first (nulls last), then by id+ if (a.signingOrder === null && b.signingOrder === null) return a.id - b.id;+ if (a.signingOrder === null) return 1;+ if (b.signingOrder === null) return -1;+ if (a.signingOrder === b.signingOrder) return a.id - b.id;+ return a.signingOrder - b.signingOrder;+ });++ const currentIndex = sortedRecipients.findIndex((r) => r.id === recipient.id);+ return currentIndex !== -1 && currentIndex < sortedRecipients.length - 1+ ? sortedRecipients[currentIndex + 1]+ : undefined;+ }, [document.documentMeta?.signingOrder, allRecipients, recipient.id]);+const highestPageNumber = Math.max(...fields.map((field) => field.page));+ const pendingFields = fieldsRequiringValidation.filter((field) => !field.inserted);+ const hasPendingFields = pendingFields.length > 0;+return (<DocumentSigningRecipientProvider recipient={recipient} targetSigner={targetSigner}><div className="mx-auto w-full max-w-screen-xl sm:px-6">@@ -165,19 +242,55 @@ export const DocumentSigningPageView = ({.otherwise(() => null)}</h3>- <Button variant="outline" className="h-8 w-8 p-0 md:hidden">- {isExpanded ? (- <LucideChevronDown- className="text-muted-foreground h-5 w-5"+ {match({ hasPendingFields, isExpanded, role: recipient.role })+ .with(+ {+ hasPendingFields: false,+ role: P.not(RecipientRole.ASSISTANT),+ isExpanded: false,+ },+ () => (+ <div className="md:hidden">+ <DocumentSigningCompleteDialog+ isSubmitting={isSubmitting}+ documentTitle={document.title}+ fields={fields}+ fieldsValidated={fieldsValidated}+ disabled={!isRecipientsTurn}+ onSignatureComplete={async (nextSigner) => {+ await completeDocument(undefined, nextSigner);+ }}+ role={recipient.role}+ allowDictateNextSigner={+ nextRecipient && documentMeta?.allowDictateNextSigner+ }+ defaultNextSigner={+ nextRecipient+ ? { name: nextRecipient.name, email: nextRecipient.email }+ : undefined+ }+ />+ </div>+ ),+ )+ .with({ isExpanded: true }, () => (+ <Button+ variant="outline"+ className="bg-background dark:bg-foreground h-8 w-8 p-0 md:hidden"onClick={() => setIsExpanded(false)}- />- ) : (- <LucideChevronUp- className="text-muted-foreground h-5 w-5"+ >+ <LucideChevronDown className="text-muted-foreground dark:text-background h-5 w-5" />+ </Button>+ ))+ .otherwise(() => (+ <Button+ variant="outline"+ className="bg-background dark:bg-foreground h-8 w-8 p-0 md:hidden"onClick={() => setIsExpanded(true)}- />- )}- </Button>+ >+ <LucideChevronUp className="text-muted-foreground dark:text-background h-5 w-5" />+ </Button>+ ))}</div><div className="hidden group-data-[expanded]/document-widget:block md:block">@@ -206,10 +319,13 @@ export const DocumentSigningPageView = ({document={document}recipient={recipient}fields={fields}- redirectUrl={documentMeta?.redirectUrl}isRecipientsTurn={isRecipientsTurn}allRecipients={allRecipients}setSelectedSignerId={setSelectedSignerId}+ completeDocument={completeDocument}+ isSubmitting={isSubmitting}+ fieldsValidated={fieldsValidated}+ nextRecipient={nextRecipient}/></div></div>