mirror of
https://github.com/documenso/documenso.git
synced 2025-11-14 08:42:12 +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.
112 lines
2.1 KiB
TypeScript
112 lines
2.1 KiB
TypeScript
import { prisma } from '@documenso/prisma';
|
|
import type { Prisma } from '@documenso/prisma/client';
|
|
|
|
export type GetTeamByIdOptions = {
|
|
userId?: number;
|
|
teamId: number;
|
|
};
|
|
|
|
export type GetTeamResponse = Awaited<ReturnType<typeof getTeamById>>;
|
|
|
|
/**
|
|
* Get a team given a teamId.
|
|
*
|
|
* Provide an optional userId to check that the user is a member of the team.
|
|
*/
|
|
export const getTeamById = async ({ userId, teamId }: GetTeamByIdOptions) => {
|
|
const whereFilter: Prisma.TeamWhereUniqueInput = {
|
|
id: teamId,
|
|
};
|
|
|
|
if (userId !== undefined) {
|
|
whereFilter['members'] = {
|
|
some: {
|
|
userId,
|
|
},
|
|
};
|
|
}
|
|
|
|
const result = await prisma.team.findUniqueOrThrow({
|
|
where: whereFilter,
|
|
include: {
|
|
teamEmail: true,
|
|
teamGlobalSettings: true,
|
|
members: {
|
|
where: {
|
|
userId,
|
|
},
|
|
select: {
|
|
role: true,
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
const { members, ...team } = result;
|
|
|
|
return {
|
|
...team,
|
|
currentTeamMember: userId !== undefined ? members[0] : null,
|
|
};
|
|
};
|
|
|
|
export type GetTeamByUrlOptions = {
|
|
userId: number;
|
|
teamUrl: string;
|
|
};
|
|
|
|
/**
|
|
* Get a team given a team URL.
|
|
*/
|
|
export const getTeamByUrl = async ({ userId, teamUrl }: GetTeamByUrlOptions) => {
|
|
const whereFilter: Prisma.TeamWhereUniqueInput = {
|
|
url: teamUrl,
|
|
};
|
|
|
|
if (userId !== undefined) {
|
|
whereFilter['members'] = {
|
|
some: {
|
|
userId,
|
|
},
|
|
};
|
|
}
|
|
|
|
const result = await prisma.team.findUniqueOrThrow({
|
|
where: whereFilter,
|
|
include: {
|
|
teamEmail: true,
|
|
emailVerification: {
|
|
select: {
|
|
expiresAt: true,
|
|
name: true,
|
|
email: true,
|
|
},
|
|
},
|
|
transferVerification: {
|
|
select: {
|
|
expiresAt: true,
|
|
name: true,
|
|
email: true,
|
|
},
|
|
},
|
|
subscription: true,
|
|
teamGlobalSettings: true,
|
|
members: {
|
|
where: {
|
|
userId,
|
|
},
|
|
select: {
|
|
role: true,
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
const { members, ...team } = result;
|
|
|
|
return {
|
|
...team,
|
|
currentTeamMember: members[0],
|
|
};
|
|
};
|