2025-01-02 15:33:37 +11:00
|
|
|
import { msg } from '@lingui/core/macro';
|
2024-11-05 11:52:54 +11:00
|
|
|
import { useLingui } from '@lingui/react';
|
2025-01-02 15:33:37 +11:00
|
|
|
import { Trans } from '@lingui/react/macro';
|
2025-03-03 14:49:28 +11:00
|
|
|
import { RecipientRole } from '@prisma/client';
|
2024-11-05 11:52:54 +11:00
|
|
|
|
2024-11-08 00:33:48 +09:00
|
|
|
import { RECIPIENT_ROLES_DESCRIPTION } from '@documenso/lib/constants/recipient-roles';
|
2024-06-02 15:49:09 +10:00
|
|
|
|
2024-11-05 11:52:54 +11:00
|
|
|
import { Body, Button, Container, Head, Html, Img, Preview, Section, Text } from '../components';
|
feat: add global settings for teams (#1391)
## 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.
2024-11-08 13:50:49 +02:00
|
|
|
import { useBranding } from '../providers/branding';
|
2024-06-02 15:49:09 +10:00
|
|
|
import TemplateDocumentImage from '../template-components/template-document-image';
|
|
|
|
|
import { TemplateFooter } from '../template-components/template-footer';
|
|
|
|
|
|
|
|
|
|
export type DocumentCompletedEmailTemplateProps = {
|
|
|
|
|
recipientName?: string;
|
2024-06-05 14:40:45 +10:00
|
|
|
recipientRole?: RecipientRole;
|
2024-06-02 15:49:09 +10:00
|
|
|
documentLink?: string;
|
|
|
|
|
documentName?: string;
|
|
|
|
|
assetBaseUrl?: string;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const DocumentCreatedFromDirectTemplateEmailTemplate = ({
|
|
|
|
|
recipientName = 'John Doe',
|
2024-06-05 14:40:45 +10:00
|
|
|
recipientRole = RecipientRole.SIGNER,
|
2024-06-02 15:49:09 +10:00
|
|
|
documentLink = 'http://localhost:3000',
|
|
|
|
|
documentName = 'Open Source Pledge.pdf',
|
|
|
|
|
assetBaseUrl = 'http://localhost:3002',
|
|
|
|
|
}: DocumentCompletedEmailTemplateProps) => {
|
2024-11-05 11:52:54 +11:00
|
|
|
const { _ } = useLingui();
|
feat: add global settings for teams (#1391)
## 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.
2024-11-08 13:50:49 +02:00
|
|
|
const branding = useBranding();
|
2024-11-05 11:52:54 +11:00
|
|
|
|
2024-11-08 00:33:48 +09:00
|
|
|
const action = _(RECIPIENT_ROLES_DESCRIPTION[recipientRole].actioned).toLowerCase();
|
2024-06-05 14:40:45 +10:00
|
|
|
|
2024-11-05 11:52:54 +11:00
|
|
|
const previewText = msg`Document created from direct template`;
|
2024-06-02 15:49:09 +10:00
|
|
|
|
|
|
|
|
const getAssetUrl = (path: string) => {
|
|
|
|
|
return new URL(path, assetBaseUrl).toString();
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
return (
|
|
|
|
|
<Html>
|
|
|
|
|
<Head />
|
2024-11-05 11:52:54 +11:00
|
|
|
<Preview>{_(previewText)}</Preview>
|
|
|
|
|
|
|
|
|
|
<Body className="mx-auto my-auto font-sans">
|
|
|
|
|
<Section className="bg-white">
|
|
|
|
|
<Container className="mx-auto mb-2 mt-8 max-w-xl rounded-lg border border-solid border-slate-200 p-2 backdrop-blur-sm">
|
|
|
|
|
<Section className="p-2">
|
feat: add global settings for teams (#1391)
## 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.
2024-11-08 13:50:49 +02:00
|
|
|
{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"
|
|
|
|
|
/>
|
|
|
|
|
)}
|
2024-06-02 15:49:09 +10:00
|
|
|
|
2024-11-05 11:52:54 +11:00
|
|
|
<TemplateDocumentImage className="mt-6" assetBaseUrl={assetBaseUrl} />
|
2024-06-02 15:49:09 +10:00
|
|
|
|
2024-11-05 11:52:54 +11:00
|
|
|
<Section>
|
|
|
|
|
<Text className="text-primary mb-0 text-center text-lg font-semibold">
|
|
|
|
|
<Trans>
|
2024-06-05 14:40:45 +10:00
|
|
|
{recipientName} {action} a document by using one of your direct links
|
2024-11-05 11:52:54 +11:00
|
|
|
</Trans>
|
|
|
|
|
</Text>
|
2024-06-02 15:49:09 +10:00
|
|
|
|
2024-11-05 11:52:54 +11:00
|
|
|
<div className="mx-auto my-2 w-fit rounded-lg bg-gray-50 px-4 py-2 text-sm text-slate-600">
|
|
|
|
|
{documentName}
|
|
|
|
|
</div>
|
2024-06-02 15:49:09 +10:00
|
|
|
|
2024-11-05 11:52:54 +11:00
|
|
|
<Section className="my-6 text-center">
|
|
|
|
|
<Button
|
|
|
|
|
className="bg-documenso-500 inline-flex items-center justify-center rounded-lg px-6 py-3 text-center text-sm font-medium text-black no-underline"
|
|
|
|
|
href={documentLink}
|
|
|
|
|
>
|
|
|
|
|
<Trans>View document</Trans>
|
|
|
|
|
</Button>
|
2024-06-02 15:49:09 +10:00
|
|
|
</Section>
|
|
|
|
|
</Section>
|
2024-11-05 11:52:54 +11:00
|
|
|
</Section>
|
|
|
|
|
</Container>
|
2024-06-02 15:49:09 +10:00
|
|
|
|
2024-11-05 11:52:54 +11:00
|
|
|
<Container className="mx-auto max-w-xl">
|
|
|
|
|
<TemplateFooter />
|
|
|
|
|
</Container>
|
|
|
|
|
</Section>
|
|
|
|
|
</Body>
|
2024-06-02 15:49:09 +10:00
|
|
|
</Html>
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export default DocumentCreatedFromDirectTemplateEmailTemplate;
|