mirror of
https://github.com/documenso/documenso.git
synced 2025-11-14 16:51:38 +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.
81 lines
2.1 KiB
TypeScript
81 lines
2.1 KiB
TypeScript
import { z } from 'zod';
|
|
|
|
import { TEAM_MEMBER_ROLE_PERMISSIONS_MAP } from '@documenso/lib/constants/teams';
|
|
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
|
import { prisma } from '@documenso/prisma';
|
|
import { Prisma } from '@documenso/prisma/client';
|
|
import type { DocumentVisibility } from '@documenso/prisma/client';
|
|
|
|
export type UpdateTeamOptions = {
|
|
userId: number;
|
|
teamId: number;
|
|
data: {
|
|
name?: string;
|
|
url?: string;
|
|
documentVisibility?: DocumentVisibility;
|
|
includeSenderDetails?: boolean;
|
|
};
|
|
};
|
|
|
|
export const updateTeam = async ({ userId, teamId, data }: UpdateTeamOptions) => {
|
|
try {
|
|
await prisma.$transaction(async (tx) => {
|
|
const foundPendingTeamWithUrl = await tx.teamPending.findFirst({
|
|
where: {
|
|
url: data.url,
|
|
},
|
|
});
|
|
|
|
if (foundPendingTeamWithUrl) {
|
|
throw new AppError(AppErrorCode.ALREADY_EXISTS, 'Team URL already exists.');
|
|
}
|
|
|
|
const team = await tx.team.update({
|
|
where: {
|
|
id: teamId,
|
|
members: {
|
|
some: {
|
|
userId,
|
|
role: {
|
|
in: TEAM_MEMBER_ROLE_PERMISSIONS_MAP['MANAGE_TEAM'],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
data: {
|
|
url: data.url,
|
|
name: data.name,
|
|
teamGlobalSettings: {
|
|
upsert: {
|
|
create: {
|
|
documentVisibility: data.documentVisibility,
|
|
includeSenderDetails: data.includeSenderDetails,
|
|
},
|
|
update: {
|
|
documentVisibility: data.documentVisibility,
|
|
includeSenderDetails: data.includeSenderDetails,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
return team;
|
|
});
|
|
} catch (err) {
|
|
console.error(err);
|
|
|
|
if (!(err instanceof Prisma.PrismaClientKnownRequestError)) {
|
|
throw err;
|
|
}
|
|
|
|
const target = z.array(z.string()).safeParse(err.meta?.target);
|
|
|
|
if (err.code === 'P2002' && target.success && target.data.includes('url')) {
|
|
throw new AppError(AppErrorCode.ALREADY_EXISTS, 'Team URL already exists.');
|
|
}
|
|
|
|
throw err;
|
|
}
|
|
};
|