2023-09-07 19:27:21 +10:00
|
|
|
'use server';
|
|
|
|
|
|
2024-02-12 12:04:53 +11:00
|
|
|
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
2024-12-18 08:14:14 +11:00
|
|
|
import { normalizePdf as makeNormalizedPdf } from '@documenso/lib/server-only/pdf/normalize-pdf';
|
2024-02-12 12:04:53 +11:00
|
|
|
import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
|
2025-01-11 15:33:20 +11:00
|
|
|
import type { ApiRequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
|
2024-02-12 12:04:53 +11:00
|
|
|
import { createDocumentAuditLogData } from '@documenso/lib/utils/document-audit-logs';
|
2023-09-14 12:46:36 +10:00
|
|
|
import { prisma } from '@documenso/prisma';
|
2025-01-16 13:36:00 +11:00
|
|
|
import { DocumentSource, WebhookTriggerEvents } from '@documenso/prisma/client';
|
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 type { Team, TeamGlobalSettings } from '@documenso/prisma/client';
|
|
|
|
|
import { TeamMemberRole } from '@documenso/prisma/client';
|
2024-02-16 11:04:11 +02:00
|
|
|
|
2025-01-13 13:41:53 +11:00
|
|
|
import {
|
|
|
|
|
ZWebhookDocumentSchema,
|
|
|
|
|
mapDocumentToWebhookDocumentPayload,
|
|
|
|
|
} from '../../types/webhook-payload';
|
2024-12-18 08:14:14 +11:00
|
|
|
import { getFile } from '../../universal/upload/get-file';
|
|
|
|
|
import { putPdfFile } from '../../universal/upload/put-file';
|
2025-01-16 13:36:00 +11:00
|
|
|
import { determineDocumentVisibility } from '../../utils/document-visibility';
|
2024-02-27 15:16:14 +11:00
|
|
|
import { triggerWebhook } from '../webhooks/trigger/trigger-webhook';
|
2023-09-14 12:46:36 +10:00
|
|
|
|
2023-09-07 19:27:21 +10:00
|
|
|
export type CreateDocumentOptions = {
|
2023-09-14 12:46:36 +10:00
|
|
|
title: string;
|
2024-07-13 16:45:09 +10:00
|
|
|
externalId?: string | null;
|
2023-09-07 19:27:21 +10:00
|
|
|
userId: number;
|
2024-02-06 16:16:10 +11:00
|
|
|
teamId?: number;
|
2023-09-14 12:46:36 +10:00
|
|
|
documentDataId: string;
|
2024-04-08 17:01:11 +07:00
|
|
|
formValues?: Record<string, string | number | boolean>;
|
2024-12-18 08:14:14 +11:00
|
|
|
normalizePdf?: boolean;
|
2024-12-31 01:27:24 +02:00
|
|
|
timezone?: string;
|
2025-01-11 15:33:20 +11:00
|
|
|
requestMetadata: ApiRequestMetadata;
|
2023-09-07 19:27:21 +10:00
|
|
|
};
|
|
|
|
|
|
2024-02-06 16:16:10 +11:00
|
|
|
export const createDocument = async ({
|
|
|
|
|
userId,
|
|
|
|
|
title,
|
2024-07-13 16:45:09 +10:00
|
|
|
externalId,
|
2024-02-06 16:16:10 +11:00
|
|
|
documentDataId,
|
|
|
|
|
teamId,
|
2024-12-18 08:14:14 +11:00
|
|
|
normalizePdf,
|
2024-04-08 17:01:11 +07:00
|
|
|
formValues,
|
2024-02-12 12:04:53 +11:00
|
|
|
requestMetadata,
|
2024-12-31 01:27:24 +02:00
|
|
|
timezone,
|
2025-01-14 00:43:35 +11:00
|
|
|
}: CreateDocumentOptions) => {
|
2024-02-12 12:04:53 +11:00
|
|
|
const user = await prisma.user.findFirstOrThrow({
|
|
|
|
|
where: {
|
|
|
|
|
id: userId,
|
|
|
|
|
},
|
|
|
|
|
include: {
|
|
|
|
|
teamMembers: {
|
|
|
|
|
select: {
|
|
|
|
|
teamId: true,
|
2024-02-06 16:16:10 +11:00
|
|
|
},
|
2024-02-12 12:04:53 +11:00
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
});
|
2024-02-06 16:16:10 +11:00
|
|
|
|
2024-02-12 12:04:53 +11:00
|
|
|
if (
|
|
|
|
|
teamId !== undefined &&
|
|
|
|
|
!user.teamMembers.some((teamMember) => teamMember.teamId === teamId)
|
|
|
|
|
) {
|
2024-11-28 16:05:37 +07:00
|
|
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
|
|
|
message: 'Team not found',
|
|
|
|
|
});
|
2024-02-12 12:04:53 +11:00
|
|
|
}
|
2024-02-06 16:16:10 +11:00
|
|
|
|
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
|
|
|
let team: (Team & { teamGlobalSettings: TeamGlobalSettings | null }) | null = null;
|
|
|
|
|
let userTeamRole: TeamMemberRole | undefined;
|
|
|
|
|
|
|
|
|
|
if (teamId) {
|
|
|
|
|
const teamWithUserRole = await prisma.team.findFirstOrThrow({
|
|
|
|
|
where: {
|
|
|
|
|
id: teamId,
|
|
|
|
|
},
|
|
|
|
|
include: {
|
|
|
|
|
teamGlobalSettings: true,
|
|
|
|
|
members: {
|
|
|
|
|
where: {
|
|
|
|
|
userId: userId,
|
|
|
|
|
},
|
|
|
|
|
select: {
|
|
|
|
|
role: true,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
team = teamWithUserRole;
|
|
|
|
|
userTeamRole = teamWithUserRole.members[0]?.role;
|
|
|
|
|
}
|
|
|
|
|
|
2024-12-18 08:14:14 +11:00
|
|
|
if (normalizePdf) {
|
|
|
|
|
const documentData = await prisma.documentData.findFirst({
|
|
|
|
|
where: {
|
|
|
|
|
id: documentDataId,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
if (documentData) {
|
|
|
|
|
const buffer = await getFile(documentData);
|
|
|
|
|
|
|
|
|
|
const normalizedPdf = await makeNormalizedPdf(Buffer.from(buffer));
|
|
|
|
|
|
|
|
|
|
const newDocumentData = await putPdfFile({
|
|
|
|
|
name: title.endsWith('.pdf') ? title : `${title}.pdf`,
|
|
|
|
|
type: 'application/pdf',
|
|
|
|
|
arrayBuffer: async () => Promise.resolve(normalizedPdf),
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
// eslint-disable-next-line require-atomic-updates
|
|
|
|
|
documentDataId = newDocumentData.id;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2024-02-12 12:04:53 +11:00
|
|
|
return await prisma.$transaction(async (tx) => {
|
|
|
|
|
const document = await tx.document.create({
|
2024-02-06 16:16:10 +11:00
|
|
|
data: {
|
|
|
|
|
title,
|
2024-07-13 16:45:09 +10:00
|
|
|
externalId,
|
2024-02-06 16:16:10 +11:00
|
|
|
documentDataId,
|
|
|
|
|
userId,
|
|
|
|
|
teamId,
|
2025-01-16 13:36:00 +11:00
|
|
|
visibility: determineDocumentVisibility(
|
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
|
|
|
team?.teamGlobalSettings?.documentVisibility,
|
|
|
|
|
userTeamRole ?? TeamMemberRole.MEMBER,
|
|
|
|
|
),
|
2024-04-08 17:01:11 +07:00
|
|
|
formValues,
|
2024-06-02 15:49:09 +10:00
|
|
|
source: DocumentSource.DOCUMENT,
|
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
|
|
|
documentMeta: {
|
|
|
|
|
create: {
|
|
|
|
|
language: team?.teamGlobalSettings?.documentLanguage,
|
2024-11-26 12:03:44 +02:00
|
|
|
typedSignatureEnabled: team?.teamGlobalSettings?.typedSignatureEnabled,
|
2024-12-31 01:27:24 +02:00
|
|
|
timezone: timezone,
|
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
|
|
|
},
|
|
|
|
|
},
|
2024-02-06 16:16:10 +11:00
|
|
|
},
|
|
|
|
|
});
|
2024-02-16 11:04:11 +02:00
|
|
|
|
2024-02-12 12:04:53 +11:00
|
|
|
await tx.documentAuditLog.create({
|
|
|
|
|
data: createDocumentAuditLogData({
|
|
|
|
|
type: DOCUMENT_AUDIT_LOG_TYPE.DOCUMENT_CREATED,
|
|
|
|
|
documentId: document.id,
|
2025-01-11 15:33:20 +11:00
|
|
|
metadata: requestMetadata,
|
2024-02-12 12:04:53 +11:00
|
|
|
data: {
|
|
|
|
|
title,
|
2024-06-02 15:49:09 +10:00
|
|
|
source: {
|
|
|
|
|
type: DocumentSource.DOCUMENT,
|
|
|
|
|
},
|
2024-02-12 12:04:53 +11:00
|
|
|
},
|
|
|
|
|
}),
|
|
|
|
|
});
|
|
|
|
|
|
2024-12-04 14:35:20 +11:00
|
|
|
const createdDocument = await tx.document.findFirst({
|
|
|
|
|
where: {
|
|
|
|
|
id: document.id,
|
|
|
|
|
},
|
|
|
|
|
include: {
|
|
|
|
|
documentMeta: true,
|
2025-01-13 13:41:53 +11:00
|
|
|
recipients: true,
|
2024-12-04 14:35:20 +11:00
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
if (!createdDocument) {
|
|
|
|
|
throw new Error('Document not found');
|
|
|
|
|
}
|
|
|
|
|
|
2024-02-16 11:04:11 +02:00
|
|
|
await triggerWebhook({
|
2024-02-27 15:16:14 +11:00
|
|
|
event: WebhookTriggerEvents.DOCUMENT_CREATED,
|
2025-01-13 13:41:53 +11:00
|
|
|
data: ZWebhookDocumentSchema.parse(mapDocumentToWebhookDocumentPayload(createdDocument)),
|
2024-02-27 15:16:14 +11:00
|
|
|
userId,
|
|
|
|
|
teamId,
|
2024-02-16 11:04:11 +02:00
|
|
|
});
|
|
|
|
|
|
2024-12-04 14:35:20 +11:00
|
|
|
return createdDocument;
|
2023-09-14 12:46:36 +10:00
|
|
|
});
|
2023-09-07 19:27:21 +10:00
|
|
|
};
|