chore: finish and clean-up redirect post signing

Signed-off-by: Adithya Krishna <adi@documenso.com>
This commit is contained in:
Adithya Krishna
2024-02-06 18:04:56 +05:30
parent 9ed16c64d8
commit 2636d5fd16
13 changed files with 128 additions and 92 deletions

View File

@ -8,7 +8,6 @@ import { useSession } from 'next-auth/react';
import { useForm } from 'react-hook-form'; import { useForm } from 'react-hook-form';
import { useAnalytics } from '@documenso/lib/client-only/hooks/use-analytics'; import { useAnalytics } from '@documenso/lib/client-only/hooks/use-analytics';
import { getDocumentMetaByDocumentId } from '@documenso/lib/server-only/document/get-document-meta-by-document-id';
import { sortFieldsByPosition, validateFieldsInserted } from '@documenso/lib/utils/fields'; import { sortFieldsByPosition, validateFieldsInserted } from '@documenso/lib/utils/fields';
import { type Document, type Field, type Recipient, RecipientRole } from '@documenso/prisma/client'; import { type Document, type Field, type Recipient, RecipientRole } from '@documenso/prisma/client';
import { trpc } from '@documenso/trpc/react'; import { trpc } from '@documenso/trpc/react';
@ -27,9 +26,10 @@ export type SigningFormProps = {
document: Document; document: Document;
recipient: Recipient; recipient: Recipient;
fields: Field[]; fields: Field[];
redirectUrl?: string | null;
}; };
export const SigningForm = ({ document, recipient, fields }: SigningFormProps) => { export const SigningForm = ({ document, recipient, fields, redirectUrl }: SigningFormProps) => {
const router = useRouter(); const router = useRouter();
const analytics = useAnalytics(); const analytics = useAnalytics();
const { data: session } = useSession(); const { data: session } = useSession();
@ -56,7 +56,6 @@ export const SigningForm = ({ document, recipient, fields }: SigningFormProps) =
}; };
const onFormSubmit = async () => { const onFormSubmit = async () => {
const documentMeta = await getDocumentMetaByDocumentId({ id: document!.id }).catch(() => null);
setValidateUninsertedFields(true); setValidateUninsertedFields(true);
const isFieldsValid = validateFieldsInserted(fields); const isFieldsValid = validateFieldsInserted(fields);
@ -75,9 +74,8 @@ export const SigningForm = ({ document, recipient, fields }: SigningFormProps) =
documentId: document.id, documentId: document.id,
timestamp: new Date().toISOString(), timestamp: new Date().toISOString(),
}); });
documentMeta?.redirectUrl
? router.push(documentMeta.redirectUrl) redirectUrl ? router.push(redirectUrl) : router.push(`/sign/${recipient.token}/complete`);
: router.push(`/sign/${recipient.token}/complete`);
}; };
return ( return (

View File

@ -8,7 +8,6 @@ import { PDF_VIEWER_PAGE_SELECTOR } from '@documenso/lib/constants/pdf-viewer';
import { DEFAULT_DOCUMENT_TIME_ZONE } from '@documenso/lib/constants/time-zones'; import { DEFAULT_DOCUMENT_TIME_ZONE } from '@documenso/lib/constants/time-zones';
import { getServerComponentSession } from '@documenso/lib/next-auth/get-server-component-session'; import { getServerComponentSession } from '@documenso/lib/next-auth/get-server-component-session';
import { getDocumentAndSenderByToken } from '@documenso/lib/server-only/document/get-document-by-token'; import { getDocumentAndSenderByToken } from '@documenso/lib/server-only/document/get-document-by-token';
import { getDocumentMetaByDocumentId } from '@documenso/lib/server-only/document/get-document-meta-by-document-id';
import { viewedDocument } from '@documenso/lib/server-only/document/viewed-document'; import { viewedDocument } from '@documenso/lib/server-only/document/viewed-document';
import { getFieldsForToken } from '@documenso/lib/server-only/field/get-fields-for-token'; import { getFieldsForToken } from '@documenso/lib/server-only/field/get-fields-for-token';
import { getRecipientByToken } from '@documenso/lib/server-only/recipient/get-recipient-by-token'; import { getRecipientByToken } from '@documenso/lib/server-only/recipient/get-recipient-by-token';
@ -49,15 +48,13 @@ export default async function SigningPage({ params: { token } }: SigningPageProp
viewedDocument({ token }).catch(() => null), viewedDocument({ token }).catch(() => null),
]); ]);
const documentMeta = await getDocumentMetaByDocumentId({ id: document!.id }).catch(() => null);
if (!document || !document.documentData || !recipient) { if (!document || !document.documentData || !recipient) {
return notFound(); return notFound();
} }
const truncatedTitle = truncateTitle(document.title); const truncatedTitle = truncateTitle(document.title);
const { documentData } = document; const { documentData, documentMeta } = document;
const { user } = await getServerComponentSession(); const { user } = await getServerComponentSession();
@ -65,8 +62,9 @@ export default async function SigningPage({ params: { token } }: SigningPageProp
document.status === DocumentStatus.COMPLETED || document.status === DocumentStatus.COMPLETED ||
recipient.signingStatus === SigningStatus.SIGNED recipient.signingStatus === SigningStatus.SIGNED
) { ) {
// documentMeta?.redirectUrl
redirect(`/sign/${token}/complete`); ? redirect(documentMeta.redirectUrl)
: redirect(`/sign/${token}/complete`);
} }
if (documentMeta?.password) { if (documentMeta?.password) {
@ -134,7 +132,12 @@ export default async function SigningPage({ params: { token } }: SigningPageProp
</Card> </Card>
<div className="col-span-12 lg:col-span-5 xl:col-span-4"> <div className="col-span-12 lg:col-span-5 xl:col-span-4">
<SigningForm document={document} recipient={recipient} fields={fields} /> <SigningForm
document={document}
recipient={recipient}
fields={fields}
redirectUrl={documentMeta?.redirectUrl}
/>
</div> </div>
</div> </div>

View File

@ -1,4 +1,5 @@
import { NextRequest, NextResponse } from 'next/server'; import type { NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
import { getToken } from 'next-auth/jwt'; import { getToken } from 'next-auth/jwt';

13
package-lock.json generated
View File

@ -14610,6 +14610,7 @@
"version": "6.9.7", "version": "6.9.7",
"resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-6.9.7.tgz", "resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-6.9.7.tgz",
"integrity": "sha512-rUtR77ksqex/eZRLmQ21LKVH5nAAsVicAtAYudK7JgwenEDZ0UIQ1adUGqErz7sMkWYxWTTU1aeP2Jga6WQyJw==", "integrity": "sha512-rUtR77ksqex/eZRLmQ21LKVH5nAAsVicAtAYudK7JgwenEDZ0UIQ1adUGqErz7sMkWYxWTTU1aeP2Jga6WQyJw==",
"peer": true,
"engines": { "engines": {
"node": ">=6.0.0" "node": ">=6.0.0"
} }
@ -19602,14 +19603,14 @@
"@react-email/section": "0.0.10", "@react-email/section": "0.0.10",
"@react-email/tailwind": "0.0.9", "@react-email/tailwind": "0.0.9",
"@react-email/text": "0.0.6", "@react-email/text": "0.0.6",
"nodemailer": "^6.9.3", "nodemailer": "^6.9.9",
"react-email": "^1.9.5", "react-email": "^1.9.5",
"resend": "^2.0.0" "resend": "^2.0.0"
}, },
"devDependencies": { "devDependencies": {
"@documenso/tailwind-config": "*", "@documenso/tailwind-config": "*",
"@documenso/tsconfig": "*", "@documenso/tsconfig": "*",
"@types/nodemailer": "^6.4.8", "@types/nodemailer": "^6.4.14",
"tsup": "^7.1.0" "tsup": "^7.1.0"
} }
}, },
@ -19627,6 +19628,14 @@
"node": ">=16.0.0" "node": ">=16.0.0"
} }
}, },
"packages/email/node_modules/nodemailer": {
"version": "6.9.9",
"resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-6.9.9.tgz",
"integrity": "sha512-dexTll8zqQoVJEZPwQAKzxxtFn0qTnjdQTchoU6Re9BUUGBJiOy3YMn/0ShTW6J5M0dfQ1NeDeRTTl4oIWgQMA==",
"engines": {
"node": ">=6.0.0"
}
},
"packages/eslint-config": { "packages/eslint-config": {
"name": "@documenso/eslint-config", "name": "@documenso/eslint-config",
"version": "0.0.0", "version": "0.0.0",

View File

@ -35,14 +35,14 @@
"@react-email/section": "0.0.10", "@react-email/section": "0.0.10",
"@react-email/tailwind": "0.0.9", "@react-email/tailwind": "0.0.9",
"@react-email/text": "0.0.6", "@react-email/text": "0.0.6",
"nodemailer": "^6.9.3", "nodemailer": "^6.9.9",
"react-email": "^1.9.5", "react-email": "^1.9.5",
"resend": "^2.0.0" "resend": "^2.0.0"
}, },
"devDependencies": { "devDependencies": {
"@documenso/tailwind-config": "*", "@documenso/tailwind-config": "*",
"@documenso/tsconfig": "*", "@documenso/tsconfig": "*",
"@types/nodemailer": "^6.4.8", "@types/nodemailer": "^6.4.14",
"tsup": "^7.1.0" "tsup": "^7.1.0"
} }
} }

View File

@ -0,0 +1,2 @@
export const URL_REGEX =
/^(https?):\/\/(?:www\.)?[a-zA-Z0-9-]+\.[a-zA-Z0-9()]{2,}(?:\/[a-zA-Z0-9-._?&=/]*)?$/i;

View File

@ -28,6 +28,7 @@ export const duplicateDocumentById = async ({ id, userId }: DuplicateDocumentByI
dateFormat: true, dateFormat: true,
password: true, password: true,
timezone: true, timezone: true,
redirectUrl: true,
}, },
}, },
}, },

View File

@ -27,6 +27,7 @@ export const getDocumentAndSenderByToken = async ({
include: { include: {
User: true, User: true,
documentData: true, documentData: true,
documentMeta: true,
}, },
}); });

View File

@ -192,7 +192,7 @@ model DocumentMeta {
dateFormat String? @default("yyyy-MM-dd hh:mm a") @db.Text dateFormat String? @default("yyyy-MM-dd hh:mm a") @db.Text
documentId Int @unique documentId Int @unique
document Document @relation(fields: [documentId], references: [id], onDelete: Cascade) document Document @relation(fields: [documentId], references: [id], onDelete: Cascade)
redirectUrl String? @db.Text redirectUrl String?
} }
enum ReadStatus { enum ReadStatus {

View File

@ -1,5 +1,6 @@
import { z } from 'zod'; import { z } from 'zod';
import { URL_REGEX } from '@documenso/lib/constants/url-regex';
import { DocumentStatus, FieldType, RecipientRole } from '@documenso/prisma/client'; import { DocumentStatus, FieldType, RecipientRole } from '@documenso/prisma/client';
export const ZGetDocumentByIdQuerySchema = z.object({ export const ZGetDocumentByIdQuerySchema = z.object({
@ -71,7 +72,12 @@ export const ZSendDocumentMutationSchema = z.object({
message: z.string(), message: z.string(),
timezone: z.string(), timezone: z.string(),
dateFormat: z.string(), dateFormat: z.string(),
redirectUrl: z.string().optional(), redirectUrl: z
.string()
.optional()
.refine((value) => value === undefined || URL_REGEX.test(value), {
message: 'Please enter a valid URL',
}),
}), }),
}); });

View File

@ -2,6 +2,7 @@
import { useEffect } from 'react'; import { useEffect } from 'react';
import { Info } from 'lucide-react';
import { Controller, useForm } from 'react-hook-form'; import { Controller, useForm } from 'react-hook-form';
import { DATE_FORMATS, DEFAULT_DOCUMENT_DATE_FORMAT } from '@documenso/lib/constants/date-formats'; import { DATE_FORMATS, DEFAULT_DOCUMENT_DATE_FORMAT } from '@documenso/lib/constants/date-formats';
@ -23,6 +24,7 @@ import {
SelectTrigger, SelectTrigger,
SelectValue, SelectValue,
} from '@documenso/ui/primitives/select'; } from '@documenso/ui/primitives/select';
import { Tooltip, TooltipContent, TooltipTrigger } from '@documenso/ui/primitives/tooltip';
import { Combobox } from '../combobox'; import { Combobox } from '../combobox';
import { FormErrorMessage } from '../form/form-error-message'; import { FormErrorMessage } from '../form/form-error-message';
@ -69,7 +71,6 @@ export const AddSubjectFormPartial = ({
message: document.documentMeta?.message ?? '', message: document.documentMeta?.message ?? '',
timezone: document.documentMeta?.timezone ?? DEFAULT_DOCUMENT_TIME_ZONE, timezone: document.documentMeta?.timezone ?? DEFAULT_DOCUMENT_TIME_ZONE,
dateFormat: document.documentMeta?.dateFormat ?? DEFAULT_DOCUMENT_DATE_FORMAT, dateFormat: document.documentMeta?.dateFormat ?? DEFAULT_DOCUMENT_DATE_FORMAT,
redirectUrl: document.documentMeta?.redirectUrl ?? '',
}, },
}, },
}); });
@ -164,86 +165,94 @@ export const AddSubjectFormPartial = ({
</ul> </ul>
</div> </div>
{hasDateField && ( <Accordion type="multiple" className="mt-8 border-none">
<Accordion type="multiple" className="mt-8 border-none"> <AccordionItem value="advanced-options" className="border-none">
<AccordionItem value="advanced-options" className="border-none"> <AccordionTrigger className="mb-2 border-b text-left hover:no-underline">
<AccordionTrigger className="mb-2 border-b text-left hover:no-underline"> Advanced Options
Advanced Options </AccordionTrigger>
</AccordionTrigger>
<AccordionContent className="text-muted-foreground -mx-1 flex max-w-prose flex-col px-1 text-sm leading-relaxed"> <AccordionContent className="text-muted-foreground -mx-1 flex max-w-prose flex-col px-1 text-sm leading-relaxed">
<div className="mt-2 flex flex-col"> {hasDateField && (
<Label htmlFor="date-format"> <>
Date Format <span className="text-muted-foreground">(Optional)</span> <div className="mt-2 flex flex-col">
</Label> <Label htmlFor="date-format">
Date Format <span className="text-muted-foreground">(Optional)</span>
</Label>
<Controller <Controller
control={control} control={control}
name={`meta.dateFormat`} name={`meta.dateFormat`}
disabled={documentHasBeenSent} disabled={documentHasBeenSent}
render={({ field: { value, onChange, disabled } }) => ( render={({ field: { value, onChange, disabled } }) => (
<Select value={value} onValueChange={onChange} disabled={disabled}> <Select value={value} onValueChange={onChange} disabled={disabled}>
<SelectTrigger className="bg-background mt-2"> <SelectTrigger className="bg-background mt-2">
<SelectValue /> <SelectValue />
</SelectTrigger> </SelectTrigger>
<SelectContent> <SelectContent>
{DATE_FORMATS.map((format) => ( {DATE_FORMATS.map((format) => (
<SelectItem key={format.key} value={format.value}> <SelectItem key={format.key} value={format.value}>
{format.label} {format.label}
</SelectItem> </SelectItem>
))} ))}
</SelectContent> </SelectContent>
</Select> </Select>
)} )}
/> />
</div> </div>
<div className="mt-4 flex flex-col"> <div className="mt-4 flex flex-col">
<Label htmlFor="time-zone"> <Label htmlFor="time-zone">
Time Zone <span className="text-muted-foreground">(Optional)</span> Time Zone <span className="text-muted-foreground">(Optional)</span>
</Label> </Label>
<Controller <Controller
control={control} control={control}
name={`meta.timezone`} name={`meta.timezone`}
render={({ field: { value, onChange } }) => ( render={({ field: { value, onChange } }) => (
<Combobox <Combobox
className="bg-background" className="bg-background"
options={TIME_ZONES} options={TIME_ZONES}
value={value} value={value}
onChange={(value) => value && onChange(value)} onChange={(value) => value && onChange(value)}
disabled={documentHasBeenSent} disabled={documentHasBeenSent}
/> />
)} )}
/> />
</div> </div>
</>
)}
<div className="flex flex-col"> <div className="flex flex-col">
<div className="flex flex-col gap-y-4"> <div className="flex flex-col gap-y-4">
<div> <div>
<Label htmlFor="redirectUrl"> <Label htmlFor="redirectUrl" className="flex items-center">
Title Redirect URL{' '}
<span className="text-destructive ml-1 inline-block font-medium"> <Tooltip>
* <TooltipTrigger>
</span> <Info className="mx-2 h-4 w-4" />
</Label> </TooltipTrigger>
<Input <TooltipContent className="text-muted-foreground max-w-xs">
id="redirectUrl" Add a URL to redirect the user to once the document is signed
className="bg-background my-2" </TooltipContent>
disabled={isSubmitting} </Tooltip>
{...register('meta.redirectUrl')} </Label>
/>
<FormErrorMessage className="mt-2" error={errors.meta} /> <Input
</div> id="redirectUrl"
type="url"
className="bg-background my-2"
{...register('meta.redirectUrl')}
/>
<FormErrorMessage className="mt-2" error={errors.meta} />
</div> </div>
</div> </div>
</AccordionContent> </div>
</AccordionItem> </AccordionContent>
</Accordion> </AccordionItem>
)} </Accordion>
</div> </div>
</div> </div>
</DocumentFlowFormContainerContent> </DocumentFlowFormContainerContent>

View File

@ -2,6 +2,7 @@ import { z } from 'zod';
import { DEFAULT_DOCUMENT_DATE_FORMAT } from '@documenso/lib/constants/date-formats'; import { DEFAULT_DOCUMENT_DATE_FORMAT } from '@documenso/lib/constants/date-formats';
import { DEFAULT_DOCUMENT_TIME_ZONE } from '@documenso/lib/constants/time-zones'; import { DEFAULT_DOCUMENT_TIME_ZONE } from '@documenso/lib/constants/time-zones';
import { URL_REGEX } from '@documenso/lib/constants/url-regex';
export const ZAddSubjectFormSchema = z.object({ export const ZAddSubjectFormSchema = z.object({
meta: z.object({ meta: z.object({
@ -9,7 +10,12 @@ export const ZAddSubjectFormSchema = z.object({
message: z.string(), message: z.string(),
timezone: z.string().optional().default(DEFAULT_DOCUMENT_TIME_ZONE), timezone: z.string().optional().default(DEFAULT_DOCUMENT_TIME_ZONE),
dateFormat: z.string().optional().default(DEFAULT_DOCUMENT_DATE_FORMAT), dateFormat: z.string().optional().default(DEFAULT_DOCUMENT_DATE_FORMAT),
redirectUrl: z.string().optional(), redirectUrl: z
.string()
.optional()
.refine((value) => value === undefined || URL_REGEX.test(value), {
message: 'Please enter a valid URL',
}),
}), }),
}); });