mirror of
https://github.com/documenso/documenso.git
synced 2025-11-12 15:53:02 +10:00
fceb0eaac9
## Description Updated the email content based on whether the document owner is a recipient or not. If the document owner is a recipient (self-signer): * the email subject will be `Please view/sign/approve your document` * the email header will be `Please view/sign/approve your document "<your-doc-title>"` * the email content will be `You have initiated the document "<your-doc-title>" that requires you to view/sign/approve it.` Otherwise: * the email subject will be `Please view/sign/approve this document` * the email header will be `<doc-owner> has invited you to view/sign/approve "<doc-title>"` * the email content will be `<doc-owner> has invited you to view/sign/approve the document "<doc-title>".` ## Related Issue Related to #1091 ## Testing Performed Tested the feature with a different number of recipients (including and excluding the document owner - self-signer). Tested both the sending and resending functionality. ## Checklist - [x] I have tested these changes locally and they work as expected. - [ ] I have added/updated tests that prove the effectiveness of these changes. - [ ] I have updated the documentation to reflect these changes, if applicable. - [x] I have followed the project's coding style guidelines. - [ ] I have addressed the code review feedback from the previous submission, if applicable. ## UI Screenshots     <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit - **New Features** - Enhanced the document invitation components to support scenarios where the recipient is also the sender, providing customized email content and subject lines. - Introduced new properties in email templates to improve clarity and relevance based on the user's role in the document signing process. - **Refactor** - Updated components to use a more flexible `headerContent` property for displaying invitation headers, replacing previous individual inviter details. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
115 lines
3.5 KiB
TypeScript
115 lines
3.5 KiB
TypeScript
import { RECIPIENT_ROLES_DESCRIPTION } from '@documenso/lib/constants/recipient-roles';
|
|
import type { RecipientRole } from '@documenso/prisma/client';
|
|
import config from '@documenso/tailwind-config';
|
|
|
|
import {
|
|
Body,
|
|
Container,
|
|
Head,
|
|
Hr,
|
|
Html,
|
|
Img,
|
|
Link,
|
|
Preview,
|
|
Section,
|
|
Tailwind,
|
|
Text,
|
|
} from '../components';
|
|
import type { TemplateDocumentInviteProps } from '../template-components/template-document-invite';
|
|
import { TemplateDocumentInvite } from '../template-components/template-document-invite';
|
|
import { TemplateFooter } from '../template-components/template-footer';
|
|
|
|
export type DocumentInviteEmailTemplateProps = Partial<TemplateDocumentInviteProps> & {
|
|
customBody?: string;
|
|
role: RecipientRole;
|
|
selfSigner?: boolean;
|
|
};
|
|
|
|
export const DocumentInviteEmailTemplate = ({
|
|
inviterName = 'Lucas Smith',
|
|
inviterEmail = 'lucas@documenso.com',
|
|
documentName = 'Open Source Pledge.pdf',
|
|
signDocumentLink = 'https://documenso.com',
|
|
assetBaseUrl = 'http://localhost:3002',
|
|
customBody,
|
|
role,
|
|
selfSigner = false,
|
|
}: DocumentInviteEmailTemplateProps) => {
|
|
const action = RECIPIENT_ROLES_DESCRIPTION[role].actionVerb.toLowerCase();
|
|
|
|
const previewText = selfSigner
|
|
? `Please ${action} your document ${documentName}`
|
|
: `${inviterName} has invited you to ${action} ${documentName}`;
|
|
|
|
const getAssetUrl = (path: string) => {
|
|
return new URL(path, assetBaseUrl).toString();
|
|
};
|
|
|
|
return (
|
|
<Html>
|
|
<Head />
|
|
<Preview>{previewText}</Preview>
|
|
<Tailwind
|
|
config={{
|
|
theme: {
|
|
extend: {
|
|
colors: config.theme.extend.colors,
|
|
},
|
|
},
|
|
}}
|
|
>
|
|
<Body className="mx-auto my-auto bg-white font-sans">
|
|
<Section>
|
|
<Container className="mx-auto mb-2 mt-8 max-w-xl rounded-lg border border-solid border-slate-200 p-4 backdrop-blur-sm">
|
|
<Section>
|
|
<Img
|
|
src={getAssetUrl('/static/logo.png')}
|
|
alt="Documenso Logo"
|
|
className="mb-4 h-6"
|
|
/>
|
|
|
|
<TemplateDocumentInvite
|
|
inviterName={inviterName}
|
|
inviterEmail={inviterEmail}
|
|
documentName={documentName}
|
|
signDocumentLink={signDocumentLink}
|
|
assetBaseUrl={assetBaseUrl}
|
|
role={role}
|
|
selfSigner={selfSigner}
|
|
/>
|
|
</Section>
|
|
</Container>
|
|
|
|
<Container className="mx-auto mt-12 max-w-xl">
|
|
<Section>
|
|
<Text className="my-4 text-base font-semibold">
|
|
{inviterName}{' '}
|
|
<Link className="font-normal text-slate-400" href="mailto:{inviterEmail}">
|
|
({inviterEmail})
|
|
</Link>
|
|
</Text>
|
|
|
|
<Text className="mt-2 text-base text-slate-400">
|
|
{customBody ? (
|
|
<pre className="font-sans text-base text-slate-400">{customBody}</pre>
|
|
) : (
|
|
`${inviterName} has invited you to ${action} the document "${documentName}".`
|
|
)}
|
|
</Text>
|
|
</Section>
|
|
</Container>
|
|
|
|
<Hr className="mx-auto mt-12 max-w-xl" />
|
|
|
|
<Container className="mx-auto max-w-xl">
|
|
<TemplateFooter />
|
|
</Container>
|
|
</Section>
|
|
</Body>
|
|
</Tailwind>
|
|
</Html>
|
|
);
|
|
};
|
|
|
|
export default DocumentInviteEmailTemplate;
|