mirror of
https://github.com/documenso/documenso.git
synced 2025-11-13 16:23:06 +10:00
23a0537648
## Description This PR introduces global settings for teams. At the moment, it allows team admins to configure the following: * The default visibility of the documents uploaded to the team account * Whether to include the document owner (sender) details when sending emails to the recipients. ### Include Sender Details If the Sender Details setting is enabled, the emails sent by the team will include the sender's name: > "Example User" on behalf of "Example Team" has invited you to sign "document.pdf" Otherwise, the email will say: > "Example Team" has invited you to sign "document.pdf" ### Default Document Visibility This new option allows users to set the default visibility for the documents uploaded to the team account. It can have the following values: * Everyone * Manager and above * Admins only If the default document visibility isn't set, the document will be set to the role of the user who created the document: * If a user with the "User" role creates a document, the document's visibility is set to "Everyone". * Manager role -> "Manager and above" * Admin role -> "Admins only" Otherwise, if there is a default document visibility value, it uses that value. #### Gotcha To avoid issues, the `document owner` and the `recipient` can access the document irrespective of their role. For example: * If a team member with the role "Member" uploads a document and the default document visibility is "Admins", only the document owner and admins can access the document. * Similar to the other scenarios. * If an admin uploads a document and the default document visibility is "Admins", the recipient can access the document. * The admins have access to all the documents. * Managers have access to documents with the visibility set to "Everyone" and "Manager and above" * Members have access only to the documents with the visibility set to "Everyone". ## Testing Performed Tested it locally.
126 lines
4.2 KiB
TypeScript
126 lines
4.2 KiB
TypeScript
import { Trans, msg } from '@lingui/macro';
|
|
import { useLingui } from '@lingui/react';
|
|
|
|
import { RECIPIENT_ROLES_DESCRIPTION } from '@documenso/lib/constants/recipient-roles';
|
|
import type { RecipientRole } from '@documenso/prisma/client';
|
|
|
|
import { Body, Container, Head, Hr, Html, Img, Link, Preview, Section, Text } from '../components';
|
|
import { useBranding } from '../providers/branding';
|
|
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;
|
|
isTeamInvite?: boolean;
|
|
teamName?: string;
|
|
teamEmail?: string;
|
|
includeSenderDetails?: 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,
|
|
isTeamInvite = false,
|
|
teamName,
|
|
includeSenderDetails,
|
|
}: DocumentInviteEmailTemplateProps) => {
|
|
const { _ } = useLingui();
|
|
const branding = useBranding();
|
|
|
|
const action = _(RECIPIENT_ROLES_DESCRIPTION[role].actionVerb).toLowerCase();
|
|
|
|
let previewText = msg`${inviterName} has invited you to ${action} ${documentName}`;
|
|
|
|
if (isTeamInvite) {
|
|
previewText = includeSenderDetails
|
|
? msg`${inviterName} on behalf of ${teamName} has invited you to ${action} ${documentName}`
|
|
: msg`${teamName} has invited you to ${action} ${documentName}`;
|
|
}
|
|
|
|
if (selfSigner) {
|
|
previewText = msg`Please ${action} your document ${documentName}`;
|
|
}
|
|
|
|
const getAssetUrl = (path: string) => {
|
|
return new URL(path, assetBaseUrl).toString();
|
|
};
|
|
|
|
return (
|
|
<Html>
|
|
<Head />
|
|
<Preview>{_(previewText)}</Preview>
|
|
|
|
<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>
|
|
{branding.brandingEnabled && branding.brandingLogo ? (
|
|
<Img src={branding.brandingLogo} alt="Branding Logo" className="mb-4 h-6" />
|
|
) : (
|
|
<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}
|
|
isTeamInvite={isTeamInvite}
|
|
teamName={teamName}
|
|
includeSenderDetails={includeSenderDetails}
|
|
/>
|
|
</Section>
|
|
</Container>
|
|
|
|
<Container className="mx-auto mt-12 max-w-xl">
|
|
<Section>
|
|
<Text className="my-4 text-base font-semibold">
|
|
<Trans>
|
|
{inviterName}{' '}
|
|
<Link className="font-normal text-slate-400" href="mailto:{inviterEmail}">
|
|
({inviterEmail})
|
|
</Link>
|
|
</Trans>
|
|
</Text>
|
|
|
|
<Text className="mt-2 text-base text-slate-400">
|
|
{customBody ? (
|
|
<pre className="font-sans text-base text-slate-400">{customBody}</pre>
|
|
) : (
|
|
<Trans>
|
|
{inviterName} has invited you to {action} the document "{documentName}".
|
|
</Trans>
|
|
)}
|
|
</Text>
|
|
</Section>
|
|
</Container>
|
|
|
|
<Hr className="mx-auto mt-12 max-w-xl" />
|
|
|
|
<Container className="mx-auto max-w-xl">
|
|
<TemplateFooter />
|
|
</Container>
|
|
</Section>
|
|
</Body>
|
|
</Html>
|
|
);
|
|
};
|
|
|
|
export default DocumentInviteEmailTemplate;
|