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';
|
2023-12-06 05:41:51 +05:30
|
|
|
|
2024-11-05 11:52:54 +11:00
|
|
|
import { Body, Container, Head, Hr, Html, Img, Preview, Section } 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';
|
2023-12-06 05:41:51 +05:30
|
|
|
import type { TemplateDocumentCancelProps } from '../template-components/template-document-cancel';
|
|
|
|
|
import { TemplateDocumentCancel } from '../template-components/template-document-cancel';
|
|
|
|
|
import { TemplateFooter } from '../template-components/template-footer';
|
|
|
|
|
|
|
|
|
|
export type DocumentCancelEmailTemplateProps = Partial<TemplateDocumentCancelProps>;
|
|
|
|
|
|
|
|
|
|
export const DocumentCancelTemplate = ({
|
|
|
|
|
inviterName = 'Lucas Smith',
|
|
|
|
|
inviterEmail = 'lucas@documenso.com',
|
|
|
|
|
documentName = 'Open Source Pledge.pdf',
|
|
|
|
|
assetBaseUrl = 'http://localhost:3002',
|
|
|
|
|
}: DocumentCancelEmailTemplateProps) => {
|
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
|
|
|
|
|
|
|
|
const previewText = msg`${inviterName} has cancelled the document ${documentName}, you don't need to sign it anymore.`;
|
2023-12-06 05:41:51 +05:30
|
|
|
|
|
|
|
|
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 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>
|
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-11-05 11:52:54 +11:00
|
|
|
|
|
|
|
|
<TemplateDocumentCancel
|
|
|
|
|
inviterName={inviterName}
|
|
|
|
|
inviterEmail={inviterEmail}
|
|
|
|
|
documentName={documentName}
|
|
|
|
|
assetBaseUrl={assetBaseUrl}
|
|
|
|
|
/>
|
|
|
|
|
</Section>
|
|
|
|
|
</Container>
|
|
|
|
|
|
|
|
|
|
<Hr className="mx-auto mt-12 max-w-xl" />
|
|
|
|
|
|
|
|
|
|
<Container className="mx-auto max-w-xl">
|
|
|
|
|
<TemplateFooter />
|
|
|
|
|
</Container>
|
|
|
|
|
</Section>
|
|
|
|
|
</Body>
|
2023-12-06 05:41:51 +05:30
|
|
|
</Html>
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export default DocumentCancelTemplate;
|
