Skip to content

The Open Source DocuSign Alternative.

fix: allow direct template recipient dictation (#2108)

David Nguyend2a009d52e2f
diff --git a/apps/remix/app/components/general/direct-template/direct-template-page.tsx b/apps/remix/app/components/general/direct-template/direct-template-page.tsx
index 686074a27..9bddf9c0d 100644
--- a/apps/remix/app/components/general/direct-template/direct-template-page.tsx
+++ b/apps/remix/app/components/general/direct-template/direct-template-page.tsx
@@ -89,7 +89,10 @@ export const DirectTemplatePageView = ({
setStep('sign');
};
- const onSignDirectTemplateSubmit = async (fields: DirectTemplateLocalField[]) => {
+ const onSignDirectTemplateSubmit = async (
+ fields: DirectTemplateLocalField[],
+ nextSigner?: { name: string; email: string },
+ ) => {
try {
let directTemplateExternalId = searchParams?.get('externalId') || undefined;
@@ -98,6 +101,7 @@ export const DirectTemplatePageView = ({
}
const { token } = await createDocumentFromDirectTemplate({
+ nextSigner,
directTemplateToken,
directTemplateExternalId,
directRecipientName: fullName,
diff --git a/apps/remix/app/components/general/direct-template/direct-template-signing-form.tsx b/apps/remix/app/components/general/direct-template/direct-template-signing-form.tsx
index 3ab3046ae..932a693fd 100644
--- a/apps/remix/app/components/general/direct-template/direct-template-signing-form.tsx
+++ b/apps/remix/app/components/general/direct-template/direct-template-signing-form.tsx
@@ -55,10 +55,13 @@ import { DocumentSigningRecipientProvider } from '../document-signing/document-s
export type DirectTemplateSigningFormProps = {
flowStep: DocumentFlowStep;
- directRecipient: Pick<Recipient, 'authOptions' | 'email' | 'role' | 'name' | 'token'>;
+ directRecipient: Pick<Recipient, 'authOptions' | 'email' | 'role' | 'name' | 'token' | 'id'>;
directRecipientFields: Field[];
template: Omit<TTemplate, 'user'>;
- onSubmit: (_data: DirectTemplateLocalField[]) => Promise<void>;
+ onSubmit: (
+ _data: DirectTemplateLocalField[],
+ _nextSigner?: { name: string; email: string },
+ ) => Promise<void>;
};
export type DirectTemplateLocalField = Field & {
@@ -149,7 +152,7 @@ export const DirectTemplateSigningForm = ({
validateFieldsInserted(fieldsRequiringValidation);
};
- const handleSubmit = async () => {
+ const handleSubmit = async (nextSigner?: { name: string; email: string }) => {
setValidateUninsertedFields(true);
const isFieldsValid = validateFieldsInserted(fieldsRequiringValidation);
@@ -161,7 +164,7 @@ export const DirectTemplateSigningForm = ({
setIsSubmitting(true);
try {
- await onSubmit(localFields);
+ await onSubmit(localFields, nextSigner);
} catch {
setIsSubmitting(false);
}
@@ -218,6 +221,30 @@ export const DirectTemplateSigningForm = ({
setLocalFields(updatedFields);
}, []);
+ const nextRecipient = useMemo(() => {
+ if (
+ !template.templateMeta?.signingOrder ||
+ template.templateMeta.signingOrder !== 'SEQUENTIAL' ||
+ !template.templateMeta.allowDictateNextSigner
+ ) {
+ return undefined;
+ }
+
+ const sortedRecipients = template.recipients.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 === directRecipient.id);
+ return currentIndex !== -1 && currentIndex < sortedRecipients.length - 1
+ ? sortedRecipients[currentIndex + 1]
+ : undefined;
+ }, [template.templateMeta?.signingOrder, template.recipients, directRecipient.id]);
+
return (
<DocumentSigningRecipientProvider recipient={directRecipient}>
<DocumentFlowFormContainerHeader title={flowStep.title} description={flowStep.description} />
@@ -417,11 +444,15 @@ export const DirectTemplateSigningForm = ({
<DocumentSigningCompleteDialog
isSubmitting={isSubmitting}
- onSignatureComplete={async () => handleSubmit()}
+ onSignatureComplete={async (nextSigner) => handleSubmit(nextSigner)}
documentTitle={template.title}
fields={localFields}
fieldsValidated={fieldsValidated}
recipient={directRecipient}
+ allowDictateNextSigner={nextRecipient && template.templateMeta?.allowDictateNextSigner}
+ defaultNextSigner={
+ nextRecipient ? { name: nextRecipient.name, email: nextRecipient.email } : undefined
+ }
/>
</div>
</DocumentFlowFormContainerFooter>
diff --git a/apps/remix/app/components/general/document-signing/document-signing-auth-page.tsx b/apps/remix/app/components/general/document-signing/document-signing-auth-page.tsx
index 21b1be6ca..123baafa5 100644
--- a/apps/remix/app/components/general/document-signing/document-signing-auth-page.tsx
+++ b/apps/remix/app/components/general/document-signing/document-signing-auth-page.tsx
@@ -9,7 +9,7 @@ import { Button } from '@documenso/ui/primitives/button';
import { useToast } from '@documenso/ui/primitives/use-toast';
export type DocumentSigningAuthPageViewProps = {
- email: string;
+ email?: string;
emailHasAccount?: boolean;
};
@@ -22,12 +22,18 @@ export const DocumentSigningAuthPageView = ({
const [isSigningOut, setIsSigningOut] = useState(false);
- const handleChangeAccount = async (email: string) => {
+ const handleChangeAccount = async (email?: string) => {
try {
setIsSigningOut(true);
+ let redirectPath = '/signin';
+
+ if (email) {
+ redirectPath = emailHasAccount ? `/signin#email=${email}` : `/signup#email=${email}`;
+ }
+
await authClient.signOut({
- redirectPath: emailHasAccount ? `/signin#email=${email}` : `/signup#email=${email}`,
+ redirectPath,
});
} catch {
toast({
@@ -49,9 +55,13 @@ export const DocumentSigningAuthPageView = ({
</h1>
<p className="text-muted-foreground mt-2 text-sm">
- <Trans>
- You need to be logged in as <strong>{email}</strong> to view this page.
- </Trans>
+ {email ? (
+ <Trans>
+ You need to be logged in as <strong>{email}</strong> to view this page.
+ </Trans>
+ ) : (
+ <Trans>You need to be logged in to view this page.</Trans>
+ )}
</p>
<Button
diff --git a/apps/remix/app/components/general/document-signing/document-signing-auth-provider.tsx b/apps/remix/app/components/general/document-signing/document-signing-auth-provider.tsx
index bd962b01d..b5c82ecfe 100644
--- a/apps/remix/app/components/general/document-signing/document-signing-auth-provider.tsx
+++ b/apps/remix/app/components/general/document-signing/document-signing-auth-provider.tsx
@@ -24,7 +24,10 @@ type PasskeyData = {
isError: boolean;
};
-type SigningAuthRecipient = Pick<Recipient, 'authOptions' | 'email' | 'role' | 'name' | 'token'>;
+type SigningAuthRecipient = Pick<
+ Recipient,
+ 'authOptions' | 'email' | 'role' | 'name' | 'token' | 'id'
+>;
export type DocumentSigningAuthContextValue = {
executeActionAuthProcedure: (_value: ExecuteActionAuthProcedureOptions) => Promise<void>;
diff --git a/apps/remix/app/components/general/document-signing/document-signing-complete-dialog.tsx b/apps/remix/app/components/general/document-signing/document-signing-complete-dialog.tsx
index 780f59f12..e910b7060 100644
--- a/apps/remix/app/components/general/document-signing/document-signing-complete-dialog.tsx
+++ b/apps/remix/app/components/general/document-signing/document-signing-complete-dialog.tsx
@@ -304,7 +304,6 @@ export const DocumentSigningCompleteDialog = ({
<form onSubmit={form.handleSubmit(onFormSubmit)}>
{allowDictateNextSigner && defaultNextSigner && (
<div className="mb-4 flex flex-col gap-4">
- {/* Todo: Envelopes - Should we say "The next recipient to sign this document will be"? */}
<div className="flex flex-col gap-4 md:flex-row">
<FormField
control={form.control}
diff --git a/apps/remix/app/components/general/document-signing/envelope-signing-provider.tsx b/apps/remix/app/components/general/document-signing/envelope-signing-provider.tsx
index b7d1a1d08..aaecd3ee9 100644
--- a/apps/remix/app/components/general/document-signing/envelope-signing-provider.tsx
+++ b/apps/remix/app/components/general/document-signing/envelope-signing-provider.tsx
@@ -285,8 +285,6 @@ export const EnvelopeSigningProvider = ({
}, [envelope.documentMeta?.signingOrder, envelope.recipients, recipient.id]);
const signField = async (fieldId: number, fieldValue: TSignEnvelopeFieldValue) => {
- console.log('insertField', fieldId, fieldValue);
-
// Set the field locally for direct templates.
if (isDirectTemplate) {
handleDirectTemplateFieldInsertion(fieldId, fieldValue);
diff --git a/apps/remix/app/components/general/envelope-signing/envelope-signing-complete-dialog.tsx b/apps/remix/app/components/general/envelope-signing/envelope-signing-complete-dialog.tsx
index 4c410e921..8b8e64fa5 100644
--- a/apps/remix/app/components/general/envelope-signing/envelope-signing-complete-dialog.tsx
+++ b/apps/remix/app/components/general/envelope-signing/envelope-signing-complete-dialog.tsx
@@ -127,6 +127,7 @@ export const EnvelopeSignerCompleteDialog = () => {
isBase64,
};
}),
+ nextSigner,
});
const redirectUrl = envelope.documentMeta.redirectUrl;
diff --git a/apps/remix/app/routes/_recipient+/d.$token+/_index.tsx b/apps/remix/app/routes/_recipient+/d.$token+/_index.tsx
index 6d7d9a31b..dbe4c5ddd 100644
--- a/apps/remix/app/routes/_recipient+/d.$token+/_index.tsx
+++ b/apps/remix/app/routes/_recipient+/d.$token+/_index.tsx
@@ -8,7 +8,6 @@ import { EnvelopeRenderProvider } from '@documenso/lib/client-only/providers/env
import { useOptionalSession } from '@documenso/lib/client-only/providers/session';
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
import { getEnvelopeForDirectTemplateSigning } from '@documenso/lib/server-only/envelope/get-envelope-for-direct-template-signing';
-import { getEnvelopeRequiredAccessData } from '@documenso/lib/server-only/envelope/get-envelope-required-access-data';
import { getTemplateByDirectLinkToken } from '@documenso/lib/server-only/template/get-template-by-direct-link-token';
import { DocumentAccessAuth } from '@documenso/lib/types/document-auth';
import { extractDocumentAuthMethods } from '@documenso/lib/utils/document-auth';
@@ -98,15 +97,12 @@ const handleV2Loader = async ({ params, request }: Route.LoaderArgs) => {
envelopeForSigning,
} as const;
})
- .catch(async (e) => {
+ .catch((e) => {
const error = AppError.parseError(e);
if (error.code === AppErrorCode.UNAUTHORIZED) {
- const requiredAccessData = await getEnvelopeRequiredAccessData({ token });
-
return {
isDocumentAccessValid: false,
- ...requiredAccessData,
} as const;
}
@@ -226,20 +222,21 @@ const DirectSigningPageV2 = ({ data }: { data: Awaited<ReturnType<typeof handleV
const user = sessionData?.user;
if (!data.isDocumentAccessValid) {
- return (
- <DocumentSigningAuthPageView
- email={data.recipientEmail}
- emailHasAccount={!!data.recipientHasAccount}
- />
- );
+ return <DocumentSigningAuthPageView email={''} emailHasAccount={true} />;
}
const { envelope, recipient } = data.envelopeForSigning;
+ const { derivedRecipientAccessAuth } = extractDocumentAuthMethods({
+ documentAuth: envelope.authOptions,
+ });
+
+ const isEmailForced = derivedRecipientAccessAuth.includes(DocumentAccessAuth.ACCOUNT);
+
return (
<EnvelopeSigningProvider
envelopeData={data.envelopeForSigning}
- email={''} // Doing this allows us to let users change the email if they want to.
+ email={isEmailForced ? user?.email || '' : ''} // Doing this allows us to let users change the email if they want to for non-auth templates.
fullName={user?.name}
signature={user?.signature}
>
diff --git a/packages/app-tests/e2e/templates/direct-templates.spec.ts b/packages/app-tests/e2e/templates/direct-templates.spec.ts
index cc5eb0051..dbe165cdd 100644
--- a/packages/app-tests/e2e/templates/direct-templates.spec.ts
+++ b/packages/app-tests/e2e/templates/direct-templates.spec.ts
@@ -1,9 +1,12 @@
import { expect, test } from '@playwright/test';
+import { DocumentSigningOrder, RecipientRole } from '@prisma/client';
import { customAlphabet } from 'nanoid';
import { NEXT_PUBLIC_WEBAPP_URL } from '@documenso/lib/constants/app';
import { createDocumentAuthOptions } from '@documenso/lib/utils/document-auth';
+import { mapSecondaryIdToTemplateId } from '@documenso/lib/utils/envelope';
import { formatDirectTemplatePath } from '@documenso/lib/utils/templates';
+import { prisma } from '@documenso/prisma';
import { seedTeam } from '@documenso/prisma/seed/teams';
import { seedDirectTemplate, seedTemplate } from '@documenso/prisma/seed/templates';
import { seedTestEmail, seedUser } from '@documenso/prisma/seed/users';
@@ -121,7 +124,7 @@ test('[DIRECT_TEMPLATES]: delete direct template link', async ({ page }) => {
await expect(page.getByText('404 not found')).toBeVisible();
});
-test('[DIRECT_TEMPLATES]: direct template link auth access', async ({ page }) => {
+test('[DIRECT_TEMPLATES]: V1 direct template link auth access', async ({ page }) => {
const { user, team } = await seedUser();
const directTemplateWithAuth = await seedDirectTemplate({
@@ -153,6 +156,53 @@ test('[DIRECT_TEMPLATES]: direct template link auth access', async ({ page }) =>
await expect(page.getByRole('heading', { name: 'General' })).toBeVisible();
await expect(page.getByLabel('Email')).toBeDisabled();
+
+ await page.getByRole('button', { name: 'Continue' }).click();
+ await page.getByRole('button', { name: 'Complete' }).click();
+
+ await page.getByRole('button', { name: 'Sign' }).click();
+ await page.waitForURL(/\/sign/);
+ await expect(page.getByRole('heading', { name: 'Document Signed' })).toBeVisible();
+});
+
+test('[DIRECT_TEMPLATES]: V2 direct template link auth access', async ({ page }) => {
+ const { user, team } = await seedUser();
+
+ const directTemplateWithAuth = await seedDirectTemplate({
+ title: 'Personal direct template link',
+ userId: user.id,
+ teamId: team.id,
+ internalVersion: 2,
+ createTemplateOptions: {
+ authOptions: createDocumentAuthOptions({
+ globalAccessAuth: ['ACCOUNT'],
+ globalActionAuth: [],
+ }),
+ },
+ });
+
+ const directTemplatePath = formatDirectTemplatePath(
+ directTemplateWithAuth.directLink?.token || '',
+ );
+
+ await page.goto(directTemplatePath);
+
+ await expect(page.getByText('Authentication required')).toBeVisible();
+
+ await apiSignin({
+ page,
+ email: user.email,
+ });
+
+ await page.goto(directTemplatePath);
+
+ await expect(page.getByRole('heading', { name: 'Personal direct template link' })).toBeVisible();
+ await page.getByRole('button', { name: 'Complete' }).click();
+ await expect(page.getByLabel('Your Email')).not.toBeVisible();
+
+ await page.getByRole('button', { name: 'Sign' }).click();
+ await page.waitForURL(/\/sign/);
+ await expect(page.getByRole('heading', { name: 'Document Signed' })).toBeVisible();
});
test('[DIRECT_TEMPLATES]: use direct template link with 1 recipient', async ({ page }) => {
@@ -175,6 +225,9 @@ test('[DIRECT_TEMPLATES]: use direct template link with 1 recipient', async ({ p
await page.getByPlaceholder('[email protected]').fill(seedTestEmail());
await page.getByRole('button', { name: 'Continue' }).click();
+
+ await expect(page.getByText('Next Recipient Name')).not.toBeVisible();
+
await page.getByRole('button', { name: 'Complete' }).click();
await page.getByRole('button', { name: 'Sign' }).click();
await page.waitForURL(/\/sign/);
@@ -183,3 +236,173 @@ test('[DIRECT_TEMPLATES]: use direct template link with 1 recipient', async ({ p
// Add a longer waiting period to ensure document status is updated
await page.waitForTimeout(3000);
});
+
+test('[DIRECT_TEMPLATES]: V1 use direct template link with 2 recipients with next signer dictation', async ({
+ page,
+}) => {
+ const { team, owner, organisation } = await seedTeam({
+ createTeamMembers: 1,
+ });
+
+ // Should be visible to team members.
+ const template = await seedDirectTemplate({
+ title: 'Team direct template link 1',
+ userId: owner.id,
+ teamId: team.id,
+ });
+
+ await prisma.documentMeta.update({
+ where: {
+ id: template.documentMetaId,
+ },
+ data: {
+ allowDictateNextSigner: true,
+ signingOrder: DocumentSigningOrder.SEQUENTIAL,
+ },
+ });
+
+ const originalName = 'Signer 2';
+ const originalSecondSignerEmail = seedTestEmail();
+
+ // Add another signer
+ await prisma.recipient.create({
+ data: {
+ signingOrder: 2,
+ envelopeId: template.id,
+ email: originalSecondSignerEmail,
+ name: originalName,
+ token: Math.random().toString().slice(2, 7),
+ role: RecipientRole.SIGNER,
+ },
+ });
+
+ // Check that the direct template link is accessible.
+ await page.goto(formatDirectTemplatePath(template.directLink?.token || ''));
+ await expect(page.getByRole('heading', { name: 'General' })).toBeVisible();
+
+ await page.waitForTimeout(100);
+ await page.getByPlaceholder('[email protected]').fill(seedTestEmail());
+
+ await page.getByRole('button', { name: 'Continue' }).click();
+ await page.getByRole('button', { name: 'Complete' }).click();
+
+ await expect(page.getByText('Next Recipient Name')).toBeVisible();
+
+ const nextRecipientNameInputValue = await page.getByLabel('Next Recipient Name').inputValue();
+ expect(nextRecipientNameInputValue).toBe(originalName);
+
+ const nextRecipientEmailInputValue = await page.getByLabel('Next Recipient Email').inputValue();
+ expect(nextRecipientEmailInputValue).toBe(originalSecondSignerEmail);
+
+ const newName = 'Hello';
+ const newSecondSignerEmail = seedTestEmail();
+
+ await page.getByLabel('Next Recipient Email').fill(newSecondSignerEmail);
+ await page.getByLabel('Next Recipient Name').fill(newName);
+
+ await page.getByRole('button', { name: 'Sign' }).click();
+ await page.waitForURL(/\/sign/);
+ await expect(page.getByRole('heading', { name: 'Document Signed' })).toBeVisible();
+
+ const createdEnvelopeRecipients = await prisma.recipient.findMany({
+ where: {
+ envelope: {
+ templateId: mapSecondaryIdToTemplateId(template.secondaryId),
+ },
+ },
+ });
+
+ const updatedSecondRecipient = createdEnvelopeRecipients.find(
+ (recipient) => recipient.signingOrder === 2,
+ );
+
+ expect(updatedSecondRecipient?.name).toBe(newName);
+ expect(updatedSecondRecipient?.email).toBe(newSecondSignerEmail);
+});
+
+test('[DIRECT_TEMPLATES]: V2 use direct template link with 2 recipients with next signer dictation', async ({
+ page,
+}) => {
+ const { team, owner, organisation } = await seedTeam({
+ createTeamMembers: 1,
+ });
+
+ // Should be visible to team members.
+ const template = await seedDirectTemplate({
+ title: 'Team direct template link 1',
+ userId: owner.id,
+ teamId: team.id,
+ internalVersion: 2,
+ });
+
+ await prisma.documentMeta.update({
+ where: {
+ id: template.documentMetaId,
+ },
+ data: {
+ allowDictateNextSigner: true,
+ signingOrder: DocumentSigningOrder.SEQUENTIAL,
+ },
+ });
+
+ const originalName = 'Signer 2';
+ const originalSecondSignerEmail = seedTestEmail();
+
+ // Add another signer
+ await prisma.recipient.create({
+ data: {
+ signingOrder: 2,
+ envelopeId: template.id,
+ email: originalSecondSignerEmail,
+ name: originalName,
+ token: Math.random().toString().slice(2, 7),
+ role: RecipientRole.SIGNER,
+ },
+ });
+
+ // Check that the direct template link is accessible.
+ await page.goto(formatDirectTemplatePath(template.directLink?.token || ''));
+ await expect(page.getByRole('heading', { name: 'Team direct template link 1' })).toBeVisible();
+ await page.waitForTimeout(100);
+
+ await page.getByRole('button', { name: 'Complete' }).click();
+
+ const currentName = 'John Doe';
+ const currentEmail = seedTestEmail();
+
+ await page.getByPlaceholder('Enter Your Name').fill(currentName);
+ await page.getByPlaceholder('Enter Your Email').fill(currentEmail);
+
+ await expect(page.getByText('Next Recipient Name')).toBeVisible();
+
+ const nextRecipientNameInputValue = await page.getByLabel('Next Recipient Name').inputValue();
+ expect(nextRecipientNameInputValue).toBe(originalName);
+
+ const nextRecipientEmailInputValue = await page.getByLabel('Next Recipient Email').inputValue();
+ expect(nextRecipientEmailInputValue).toBe(originalSecondSignerEmail);
+
+ const newName = 'Hello';
+ const newSecondSignerEmail = seedTestEmail();
+
+ await page.getByLabel('Next Recipient Email').fill(newSecondSignerEmail);
+ await page.getByLabel('Next Recipient Name').fill(newName);
+
+ await page.getByRole('button', { name: 'Sign' }).click();
+ await page.waitForURL(/\/sign/);
+ await expect(page.getByRole('heading', { name: 'Document Signed' })).toBeVisible();
+
+ const createdEnvelopeRecipients = await prisma.recipient.findMany({
+ where: {
+ envelope: {
+ templateId: mapSecondaryIdToTemplateId(template.secondaryId),
+ },
+ },
+ });
+
+ const updatedSecondRecipient = createdEnvelopeRecipients.find(
+ (recipient) => recipient.signingOrder === 2,
+ );
+
+ expect(updatedSecondRecipient?.name).toBe(newName);
+ expect(updatedSecondRecipient?.email).toBe(newSecondSignerEmail);
+});
diff --git a/packages/lib/server-only/envelope/get-envelope-for-direct-template-signing.ts b/packages/lib/server-only/envelope/get-envelope-for-direct-template-signing.ts
index 3045aa068..e9547885c 100644
--- a/packages/lib/server-only/envelope/get-envelope-for-direct-template-signing.ts
+++ b/packages/lib/server-only/envelope/get-envelope-for-direct-template-signing.ts
@@ -1,10 +1,11 @@
import { DocumentStatus, EnvelopeType } from '@prisma/client';
+import { match } from 'ts-pattern';
import { prisma } from '@documenso/prisma';
import { AppError, AppErrorCode } from '../../errors/app-error';
-import type { TDocumentAuthMethods } from '../../types/document-auth';
-import { isRecipientAuthorized } from '../document/is-recipient-authorized';
+import { DocumentAccessAuth, type TDocumentAuthMethods } from '../../types/document-auth';
+import { extractDocumentAuthMethods } from '../../utils/document-auth';
import { getTeamSettings } from '../team/get-team-settings';
import type { EnvelopeForSigningResponse } from './get-envelope-for-recipient-signing';
import { ZEnvelopeForSigningResponse } from './get-envelope-for-recipient-signing';
@@ -98,14 +99,28 @@ export const getEnvelopeForDirectTemplateSigning = async ({
});
}
- const documentAccessValid = await isRecipientAuthorized({
- type: 'ACCESS',
- documentAuthOptions: envelope.authOptions,
- recipient,
- userId,
- authOptions: accessAuth,
+ // Currently not using this since for direct templates "User" access means they just need to be
+ // logged in.
+ // const documentAccessValid = await isRecipientAuthorized({
+ // type: 'ACCESS',
+ // documentAuthOptions: envelope.authOptions,
+ // recipient,
+ // userId,
+ // authOptions: accessAuth,
+ // });
+
+ const { derivedRecipientAccessAuth } = extractDocumentAuthMethods({
+ documentAuth: envelope.authOptions,
});
+ // Ensure typesafety when we add more options.
+ const documentAccessValid = derivedRecipientAccessAuth.every((auth) =>
+ match(auth)
+ .with(DocumentAccessAuth.ACCOUNT, () => Boolean(userId))
+ .with(DocumentAccessAuth.TWO_FACTOR_AUTH, () => true)
+ .exhaustive(),
+ );
+
if (!documentAccessValid) {
throw new AppError(AppErrorCode.UNAUTHORIZED, {
message: 'Invalid access values',
diff --git a/packages/lib/server-only/envelope/get-envelope-required-access-data.ts b/packages/lib/server-only/envelope/get-envelope-required-access-data.ts
index b543f1042..c5aef69ff 100644
--- a/packages/lib/server-only/envelope/get-envelope-required-access-data.ts
+++ b/packages/lib/server-only/envelope/get-envelope-required-access-data.ts
@@ -54,54 +54,3 @@ export const getEnvelopeRequiredAccessData = async ({ token }: { token: string }
recipientHasAccount: Boolean(recipientUserAccount),
} as const;
};
-
-export const getEnvelopeDirectTemplateRequiredAccessData = async ({ token }: { token: string }) => {
- const envelope = await prisma.envelope.findFirst({
- where: {
- type: EnvelopeType.TEMPLATE,
- directLink: {
- enabled: true,
- token,
- },
- status: DocumentStatus.DRAFT,
- },
- include: {
- recipients: {
- where: {
- token,
- },
- },
- directLink: true,
- },
- });
-
- if (!envelope) {
- throw new AppError(AppErrorCode.NOT_FOUND, {
- message: 'Envelope not found',
- });
- }
-
- const recipient = envelope.recipients.find(
- (r) => r.id === envelope.directLink?.directTemplateRecipientId,
- );
-
- if (!recipient) {
- throw new AppError(AppErrorCode.NOT_FOUND, {
- message: 'Recipient not found',
- });
- }
-
- const recipientUserAccount = await prisma.user.findFirst({
- where: {
- email: recipient.email.toLowerCase(),
- },
- select: {
- id: true,
- },
- });
-
- return {
- recipientEmail: recipient.email,
- recipientHasAccount: Boolean(recipientUserAccount),
- } as const;
-};
diff --git a/packages/lib/server-only/template/create-document-from-direct-template.ts b/packages/lib/server-only/template/create-document-from-direct-template.ts
index f2274c09f..bda55ee7a 100644
--- a/packages/lib/server-only/template/create-document-from-direct-template.ts
+++ b/packages/lib/server-only/template/create-document-from-direct-template.ts
@@ -3,6 +3,7 @@ import { createElement } from 'react';
import { msg } from '@lingui/core/macro';
import type { Field, Signature } from '@prisma/client';
import {
+ DocumentSigningOrder,
DocumentSource,
DocumentStatus,
EnvelopeType,
@@ -26,7 +27,7 @@ import type { TSignFieldWithTokenMutationSchema } from '@documenso/trpc/server/f
import { getI18nInstance } from '../../client-only/providers/i18n-server';
import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
import { AppError, AppErrorCode } from '../../errors/app-error';
-import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
+import { DOCUMENT_AUDIT_LOG_TYPE, RECIPIENT_DIFF_TYPE } from '../../types/document-audit-logs';
import type { TRecipientActionAuthTypes } from '../../types/document-auth';
import { DocumentAccessAuth, ZRecipientAuthOptionsSchema } from '../../types/document-auth';
import { ZFieldMetaSchema } from '../../types/field-meta';
@@ -68,6 +69,10 @@ export type CreateDocumentFromDirectTemplateOptions = {
name?: string;
email: string;
};
+ nextSigner?: {
+ email: string;
+ name: string;
+ };
};
type CreatedDirectRecipientField = {
@@ -92,6 +97,7 @@ export const createDocumentFromDirectTemplate = async ({
directTemplateExternalId,
signedFieldValues,
templateUpdatedAt,
+ nextSigner,
requestMetadata,
user,
}: CreateDocumentFromDirectTemplateOptions): Promise<TCreateDocumentFromDirectTemplateResponse> => {
@@ -128,6 +134,17 @@ export const createDocumentFromDirectTemplate = async ({
throw new AppError(AppErrorCode.INVALID_REQUEST, { message: 'Invalid or missing template' });
}
+ if (
+ nextSigner &&
+ (!directTemplateEnvelope.documentMeta?.allowDictateNextSigner ||
+ directTemplateEnvelope.documentMeta?.signingOrder !== DocumentSigningOrder.SEQUENTIAL)
+ ) {
+ throw new AppError(AppErrorCode.INVALID_REQUEST, {
+ message:
+ 'You need to enable allowDictateNextSigner and sequential signing to dictate the next signer',
+ });
+ }
+
const directTemplateEnvelopeLegacyId = mapSecondaryIdToTemplateId(
directTemplateEnvelope.secondaryId,
);
@@ -630,6 +647,77 @@ export const createDocumentFromDirectTemplate = async ({
}),
];
+ if (nextSigner) {
+ const pendingRecipients = await tx.recipient.findMany({
+ select: {
+ id: true,
+ signingOrder: true,
+ name: true,
+ email: true,
+ role: true,
+ },
+ where: {
+ envelopeId: createdEnvelope.id,
+ signingStatus: {
+ not: SigningStatus.SIGNED,
+ },
+ role: {
+ not: RecipientRole.CC,
+ },
+ },
+ // Composite sort so our next recipient is always the one with the lowest signing order or id
+ // if there is a tie.
+ orderBy: [{ signingOrder: { sort: 'asc', nulls: 'last' } }, { id: 'asc' }],
+ });
+
+ const nextRecipient = pendingRecipients[0];
+
+ if (nextRecipient) {
+ auditLogsToCreate.push(
+ createDocumentAuditLogData({
+ type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_UPDATED,
+ envelopeId: createdEnvelope.id,
+ user: {
+ name: user?.name || directRecipientName || '',
+ email: user?.email || directRecipientEmail,
+ },
+ metadata: requestMetadata,
+ data: {
+ recipientEmail: nextRecipient.email,
+ recipientName: nextRecipient.name,
+ recipientId: nextRecipient.id,
+ recipientRole: nextRecipient.role,
+ changes: [
+ {
+ type: RECIPIENT_DIFF_TYPE.NAME,
+ from: nextRecipient.name,
+ to: nextSigner.name,
+ },
+ {
+ type: RECIPIENT_DIFF_TYPE.EMAIL,
+ from: nextRecipient.email,
+ to: nextSigner.email,
+ },
+ ],
+ },
+ }),
+ );
+
+ await tx.recipient.update({
+ where: { id: nextRecipient.id },
+ data: {
+ sendStatus: SendStatus.SENT,
+ ...(nextSigner && documentMeta?.allowDictateNextSigner
+ ? {
+ name: nextSigner.name,
+ email: nextSigner.email,
+ }
+ : {}),
+ },
+ });
+ }
+ }
+
await tx.documentAuditLog.createMany({
data: auditLogsToCreate,
});
diff --git a/packages/prisma/seed/templates.ts b/packages/prisma/seed/templates.ts
index 3ea381abc..c83dfa1d9 100644
--- a/packages/prisma/seed/templates.ts
+++ b/packages/prisma/seed/templates.ts
@@ -28,6 +28,7 @@ type SeedTemplateOptions = {
title?: string;
userId: number;
teamId: number;
+ internalVersion?: 1 | 2;
createTemplateOptions?: Partial<Prisma.EnvelopeUncheckedCreateInput>;
};
@@ -167,7 +168,7 @@ export const seedDirectTemplate = async (options: SeedTemplateOptions) => {
data: {
id: prefixedId('envelope'),
secondaryId: templateId.formattedTemplateId,
- internalVersion: 1,
+ internalVersion: options.internalVersion ?? 1,
type: EnvelopeType.TEMPLATE,
title,
envelopeItems: {
@@ -184,6 +185,7 @@ export const seedDirectTemplate = async (options: SeedTemplateOptions) => {
teamId,
recipients: {
create: {
+ signingOrder: 1,
email: DIRECT_TEMPLATE_RECIPIENT_EMAIL,
name: DIRECT_TEMPLATE_RECIPIENT_NAME,
token: Math.random().toString().slice(2, 7),
diff --git a/packages/trpc/server/template-router/router.ts b/packages/trpc/server/template-router/router.ts
index 3cefb136f..0ee4669d4 100644
--- a/packages/trpc/server/template-router/router.ts
+++ b/packages/trpc/server/template-router/router.ts
@@ -519,6 +519,7 @@ export const templateRouter = router({
directTemplateExternalId,
signedFieldValues,
templateUpdatedAt,
+ nextSigner,
} = input;
ctx.logger.info({
@@ -541,6 +542,7 @@ export const templateRouter = router({
email: ctx.user.email,
}
: undefined,
+ nextSigner,
requestMetadata: ctx.metadata,
});
}),
diff --git a/packages/trpc/server/template-router/schema.ts b/packages/trpc/server/template-router/schema.ts
index 0783ef232..a199f1c1a 100644
--- a/packages/trpc/server/template-router/schema.ts
+++ b/packages/trpc/server/template-router/schema.ts
@@ -90,6 +90,12 @@ export const ZCreateDocumentFromDirectTemplateRequestSchema = z.object({
directTemplateExternalId: z.string().optional(),
signedFieldValues: z.array(ZSignFieldWithTokenMutationSchema),
templateUpdatedAt: z.date(),
+ nextSigner: z
+ .object({
+ email: z.string().email().max(254),
+ name: z.string().min(1).max(255),
+ })
+ .optional(),
});
export const ZCreateDocumentFromTemplateRequestSchema = z.object({