mirror of
https://github.com/documenso/documenso.git
synced 2025-11-17 10:11:35 +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.
63 lines
1.8 KiB
TypeScript
63 lines
1.8 KiB
TypeScript
import { z } from 'zod';
|
|
|
|
import { DocumentVisibility } from '@documenso/prisma/client';
|
|
|
|
import { sendTeamDeleteEmail } from '../../../server-only/team/delete-team';
|
|
import type { JobDefinition } from '../../client/_internal/job';
|
|
|
|
const SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION_ID = 'send.team-deleted.email';
|
|
|
|
const SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION_SCHEMA = z.object({
|
|
team: z.object({
|
|
name: z.string(),
|
|
url: z.string(),
|
|
ownerUserId: z.number(),
|
|
teamGlobalSettings: z
|
|
.object({
|
|
documentVisibility: z.nativeEnum(DocumentVisibility),
|
|
documentLanguage: z.string(),
|
|
includeSenderDetails: z.boolean(),
|
|
brandingEnabled: z.boolean(),
|
|
brandingLogo: z.string(),
|
|
brandingUrl: z.string(),
|
|
brandingCompanyDetails: z.string(),
|
|
brandingHidePoweredBy: z.boolean(),
|
|
teamId: z.number(),
|
|
})
|
|
.nullish(),
|
|
}),
|
|
members: z.array(
|
|
z.object({
|
|
id: z.number(),
|
|
name: z.string(),
|
|
email: z.string(),
|
|
}),
|
|
),
|
|
});
|
|
|
|
export const SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION = {
|
|
id: SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION_ID,
|
|
name: 'Send Team Deleted Email',
|
|
version: '1.0.0',
|
|
trigger: {
|
|
name: SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION_ID,
|
|
schema: SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION_SCHEMA,
|
|
},
|
|
handler: async ({ payload, io }) => {
|
|
const { team, members } = payload;
|
|
|
|
for (const member of members) {
|
|
await io.runTask(`send-team-deleted-email--${team.url}_${member.id}`, async () => {
|
|
await sendTeamDeleteEmail({
|
|
email: member.email,
|
|
team,
|
|
isOwner: member.id === team.ownerUserId,
|
|
});
|
|
});
|
|
}
|
|
},
|
|
} as const satisfies JobDefinition<
|
|
typeof SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION_ID,
|
|
z.infer<typeof SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION_SCHEMA>
|
|
>;
|