mirror of
https://github.com/documenso/documenso.git
synced 2025-11-12 07:43:16 +10:00
## 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.
119 lines
3.6 KiB
TypeScript
119 lines
3.6 KiB
TypeScript
import { createElement } from 'react';
|
|
|
|
import { msg } from '@lingui/macro';
|
|
import { z } from 'zod';
|
|
|
|
import { mailer } from '@documenso/email/mailer';
|
|
import TeamJoinEmailTemplate from '@documenso/email/templates/team-join';
|
|
import { prisma } from '@documenso/prisma';
|
|
import { TeamMemberRole } from '@documenso/prisma/client';
|
|
|
|
import { getI18nInstance } from '../../../client-only/providers/i18n.server';
|
|
import { WEBAPP_BASE_URL } from '../../../constants/app';
|
|
import { FROM_ADDRESS, FROM_NAME } from '../../../constants/email';
|
|
import { renderEmailWithI18N } from '../../../utils/render-email-with-i18n';
|
|
import { teamGlobalSettingsToBranding } from '../../../utils/team-global-settings-to-branding';
|
|
import type { JobDefinition } from '../../client/_internal/job';
|
|
|
|
const SEND_TEAM_MEMBER_JOINED_EMAIL_JOB_DEFINITION_ID = 'send.team-member-joined.email';
|
|
|
|
const SEND_TEAM_MEMBER_JOINED_EMAIL_JOB_DEFINITION_SCHEMA = z.object({
|
|
teamId: z.number(),
|
|
memberId: z.number(),
|
|
});
|
|
|
|
export const SEND_TEAM_MEMBER_JOINED_EMAIL_JOB_DEFINITION = {
|
|
id: SEND_TEAM_MEMBER_JOINED_EMAIL_JOB_DEFINITION_ID,
|
|
name: 'Send Team Member Joined Email',
|
|
version: '1.0.0',
|
|
trigger: {
|
|
name: SEND_TEAM_MEMBER_JOINED_EMAIL_JOB_DEFINITION_ID,
|
|
schema: SEND_TEAM_MEMBER_JOINED_EMAIL_JOB_DEFINITION_SCHEMA,
|
|
},
|
|
handler: async ({ payload, io }) => {
|
|
const team = await prisma.team.findFirstOrThrow({
|
|
where: {
|
|
id: payload.teamId,
|
|
},
|
|
include: {
|
|
members: {
|
|
where: {
|
|
role: {
|
|
in: [TeamMemberRole.ADMIN, TeamMemberRole.MANAGER],
|
|
},
|
|
},
|
|
include: {
|
|
user: true,
|
|
},
|
|
},
|
|
teamGlobalSettings: true,
|
|
},
|
|
});
|
|
|
|
const invitedMember = await prisma.teamMember.findFirstOrThrow({
|
|
where: {
|
|
id: payload.memberId,
|
|
teamId: payload.teamId,
|
|
},
|
|
include: {
|
|
user: true,
|
|
},
|
|
});
|
|
|
|
for (const member of team.members) {
|
|
if (member.id === invitedMember.id) {
|
|
continue;
|
|
}
|
|
|
|
await io.runTask(
|
|
`send-team-member-joined-email--${invitedMember.id}_${member.id}`,
|
|
async () => {
|
|
const emailContent = createElement(TeamJoinEmailTemplate, {
|
|
assetBaseUrl: WEBAPP_BASE_URL,
|
|
baseUrl: WEBAPP_BASE_URL,
|
|
memberName: invitedMember.user.name || '',
|
|
memberEmail: invitedMember.user.email,
|
|
teamName: team.name,
|
|
teamUrl: team.url,
|
|
});
|
|
|
|
const branding = team.teamGlobalSettings
|
|
? teamGlobalSettingsToBranding(team.teamGlobalSettings)
|
|
: undefined;
|
|
|
|
const lang = team.teamGlobalSettings?.documentLanguage;
|
|
|
|
// !: Replace with the actual language of the recipient later
|
|
const [html, text] = await Promise.all([
|
|
renderEmailWithI18N(emailContent, {
|
|
lang,
|
|
branding,
|
|
}),
|
|
renderEmailWithI18N(emailContent, {
|
|
lang,
|
|
branding,
|
|
plainText: true,
|
|
}),
|
|
]);
|
|
|
|
const i18n = await getI18nInstance(lang);
|
|
|
|
await mailer.sendMail({
|
|
to: member.user.email,
|
|
from: {
|
|
name: FROM_NAME,
|
|
address: FROM_ADDRESS,
|
|
},
|
|
subject: i18n._(msg`A new member has joined your team`),
|
|
html,
|
|
text,
|
|
});
|
|
},
|
|
);
|
|
}
|
|
},
|
|
} as const satisfies JobDefinition<
|
|
typeof SEND_TEAM_MEMBER_JOINED_EMAIL_JOB_DEFINITION_ID,
|
|
z.infer<typeof SEND_TEAM_MEMBER_JOINED_EMAIL_JOB_DEFINITION_SCHEMA>
|
|
>;
|