2025-01-02 15:33:37 +11:00
|
|
|
import { DocumentVisibility } from '@prisma/client';
|
2024-07-25 04:27:19 +00:00
|
|
|
import { z } from 'zod';
|
|
|
|
|
|
|
|
|
|
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(),
|
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
|
|
|
teamGlobalSettings: z
|
|
|
|
|
.object({
|
|
|
|
|
documentVisibility: z.nativeEnum(DocumentVisibility),
|
|
|
|
|
documentLanguage: z.string(),
|
|
|
|
|
includeSenderDetails: z.boolean(),
|
2024-11-25 06:47:26 +02:00
|
|
|
includeSigningCertificate: z.boolean(),
|
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
|
|
|
brandingEnabled: z.boolean(),
|
|
|
|
|
brandingLogo: z.string(),
|
|
|
|
|
brandingUrl: z.string(),
|
|
|
|
|
brandingCompanyDetails: z.string(),
|
|
|
|
|
brandingHidePoweredBy: z.boolean(),
|
|
|
|
|
teamId: z.number(),
|
2024-11-26 12:03:44 +02:00
|
|
|
typedSignatureEnabled: z.boolean(),
|
2025-03-24 15:25:29 +11:00
|
|
|
uploadSignatureEnabled: z.boolean(),
|
|
|
|
|
drawSignatureEnabled: z.boolean(),
|
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
|
|
|
})
|
|
|
|
|
.nullish(),
|
2024-07-25 04:27:19 +00:00
|
|
|
}),
|
|
|
|
|
members: z.array(
|
|
|
|
|
z.object({
|
|
|
|
|
id: z.number(),
|
|
|
|
|
name: z.string(),
|
|
|
|
|
email: z.string(),
|
|
|
|
|
}),
|
|
|
|
|
),
|
|
|
|
|
});
|
|
|
|
|
|
2024-12-18 15:01:57 +11:00
|
|
|
export type TSendTeamDeletedEmailJobDefinition = z.infer<
|
|
|
|
|
typeof SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION_SCHEMA
|
|
|
|
|
>;
|
|
|
|
|
|
2024-07-25 04:27:19 +00:00
|
|
|
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 }) => {
|
2024-12-18 15:01:57 +11:00
|
|
|
const handler = await import('./send-team-deleted-email.handler');
|
2024-07-25 04:27:19 +00:00
|
|
|
|
2024-12-18 15:01:57 +11:00
|
|
|
await handler.run({ payload, io });
|
2024-07-25 04:27:19 +00:00
|
|
|
},
|
|
|
|
|
} as const satisfies JobDefinition<
|
|
|
|
|
typeof SEND_TEAM_DELETED_EMAIL_JOB_DEFINITION_ID,
|
2024-12-18 15:01:57 +11:00
|
|
|
TSendTeamDeletedEmailJobDefinition
|
2024-07-25 04:27:19 +00:00
|
|
|
>;
|