mirror of
https://github.com/documenso/documenso.git
synced 2025-11-13 08:13:56 +10:00
Compare commits
7 Commits
bf6f09194d
...
feat/webho
| Author | SHA1 | Date | |
|---|---|---|---|
| 3bcd023b00 | |||
| f6f66272b2 | |||
| d2a009d52e | |||
| 776cd3aa8b | |||
| 9350c53c7d | |||
| ffce7a2c81 | |||
| 353bdce86b |
692
CODE_STYLE.md
Normal file
692
CODE_STYLE.md
Normal file
@ -0,0 +1,692 @@
|
|||||||
|
# Documenso Code Style Guide
|
||||||
|
|
||||||
|
This document captures the code style, patterns, and conventions used in the Documenso codebase. It covers both enforceable rules and subjective "taste" elements that make our code consistent and maintainable.
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
1. [General Principles](#general-principles)
|
||||||
|
2. [TypeScript Conventions](#typescript-conventions)
|
||||||
|
3. [Imports & Dependencies](#imports--dependencies)
|
||||||
|
4. [Functions & Methods](#functions--methods)
|
||||||
|
5. [React & Components](#react--components)
|
||||||
|
6. [Error Handling](#error-handling)
|
||||||
|
7. [Async/Await Patterns](#asyncawait-patterns)
|
||||||
|
8. [Whitespace & Formatting](#whitespace--formatting)
|
||||||
|
9. [Naming Conventions](#naming-conventions)
|
||||||
|
10. [Pattern Matching](#pattern-matching)
|
||||||
|
11. [Database & Prisma](#database--prisma)
|
||||||
|
12. [TRPC Patterns](#trpc-patterns)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## General Principles
|
||||||
|
|
||||||
|
- **Functional over Object-Oriented**: Prefer functional programming patterns over classes
|
||||||
|
- **Explicit over Implicit**: Be explicit about types, return values, and error cases
|
||||||
|
- **Early Returns**: Use guard clauses and early returns to reduce nesting
|
||||||
|
- **Immutability**: Favor `const` over `let`; avoid mutation where possible
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## TypeScript Conventions
|
||||||
|
|
||||||
|
### Type Definitions
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Prefer `type` over `interface`
|
||||||
|
type CreateDocumentOptions = {
|
||||||
|
templateId: number;
|
||||||
|
userId: number;
|
||||||
|
recipients: Recipient[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// ❌ Avoid interfaces unless absolutely necessary
|
||||||
|
interface CreateDocumentOptions {
|
||||||
|
templateId: number;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Type Imports
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use `type` keyword for type-only imports
|
||||||
|
import type { Document, Recipient } from '@prisma/client';
|
||||||
|
import { DocumentStatus } from '@prisma/client';
|
||||||
|
|
||||||
|
// Types in function signatures
|
||||||
|
export const findDocuments = async ({ userId, teamId }: FindDocumentsOptions) => {
|
||||||
|
// ...
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
### Inline Types for Function Parameters
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Extract inline types to named types
|
||||||
|
type FinalRecipient = Pick<Recipient, 'name' | 'email' | 'role' | 'authOptions'> & {
|
||||||
|
templateRecipientId: number;
|
||||||
|
fields: Field[];
|
||||||
|
};
|
||||||
|
|
||||||
|
const finalRecipients: FinalRecipient[] = [];
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Imports & Dependencies
|
||||||
|
|
||||||
|
### Import Organization
|
||||||
|
|
||||||
|
Imports should be organized in the following order with blank lines between groups:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// 1. React imports
|
||||||
|
import { useCallback, useEffect, useMemo } from 'react';
|
||||||
|
|
||||||
|
// 2. Third-party library imports (alphabetically)
|
||||||
|
import { zodResolver } from '@hookform/resolvers/zod';
|
||||||
|
import { Trans } from '@lingui/react/macro';
|
||||||
|
import type { Document, Recipient } from '@prisma/client';
|
||||||
|
import { DocumentStatus, RecipientRole } from '@prisma/client';
|
||||||
|
import { match } from 'ts-pattern';
|
||||||
|
|
||||||
|
// 3. Internal package imports (from @documenso/*)
|
||||||
|
import { AppError } from '@documenso/lib/errors/app-error';
|
||||||
|
import { prisma } from '@documenso/prisma';
|
||||||
|
import { Button } from '@documenso/ui/primitives/button';
|
||||||
|
|
||||||
|
// 4. Relative imports
|
||||||
|
import { getTeamById } from '../team/get-team';
|
||||||
|
import type { FindResultResponse } from './types';
|
||||||
|
```
|
||||||
|
|
||||||
|
### Destructuring Imports
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Destructure specific exports
|
||||||
|
// ✅ Use type imports for types
|
||||||
|
import type { Document } from '@prisma/client';
|
||||||
|
|
||||||
|
import { Button } from '@documenso/ui/primitives/button';
|
||||||
|
import { Input } from '@documenso/ui/primitives/input';
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Functions & Methods
|
||||||
|
|
||||||
|
### Arrow Functions
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Always use arrow functions for functions
|
||||||
|
export const createDocument = async ({
|
||||||
|
userId,
|
||||||
|
title,
|
||||||
|
}: CreateDocumentOptions) => {
|
||||||
|
// ...
|
||||||
|
};
|
||||||
|
|
||||||
|
// ✅ Callbacks and handlers
|
||||||
|
const onSubmit = useCallback(async () => {
|
||||||
|
// ...
|
||||||
|
}, [dependencies]);
|
||||||
|
|
||||||
|
// ❌ Avoid regular function declarations
|
||||||
|
function createDocument() {
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Function Parameters
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use destructured object parameters for multiple params
|
||||||
|
export const findDocuments = async ({
|
||||||
|
userId,
|
||||||
|
teamId,
|
||||||
|
status = ExtendedDocumentStatus.ALL,
|
||||||
|
page = 1,
|
||||||
|
perPage = 10,
|
||||||
|
}: FindDocumentsOptions) => {
|
||||||
|
// ...
|
||||||
|
};
|
||||||
|
|
||||||
|
// ✅ Destructure on separate line when needed
|
||||||
|
const onFormSubmit = form.handleSubmit(onSubmit);
|
||||||
|
|
||||||
|
// ✅ Deconstruct nested properties explicitly
|
||||||
|
const { user } = ctx;
|
||||||
|
const { templateId } = input;
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## React & Components
|
||||||
|
|
||||||
|
### Component Definition
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use const with arrow function
|
||||||
|
export const AddSignersFormPartial = ({
|
||||||
|
documentFlow,
|
||||||
|
recipients,
|
||||||
|
fields,
|
||||||
|
onSubmit,
|
||||||
|
}: AddSignersFormProps) => {
|
||||||
|
// ...
|
||||||
|
};
|
||||||
|
|
||||||
|
// ❌ Never use classes
|
||||||
|
class MyComponent extends React.Component {
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Hooks
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Group related hooks together with blank line separation
|
||||||
|
const { _ } = useLingui();
|
||||||
|
const { toast } = useToast();
|
||||||
|
|
||||||
|
const { currentStep, totalSteps, previousStep } = useStep();
|
||||||
|
|
||||||
|
const form = useForm<TFormSchema>({
|
||||||
|
resolver: zodResolver(ZFormSchema),
|
||||||
|
defaultValues: {
|
||||||
|
// ...
|
||||||
|
},
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Event Handlers
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use arrow functions with descriptive names
|
||||||
|
const onFormSubmit = async () => {
|
||||||
|
await form.trigger();
|
||||||
|
// ...
|
||||||
|
};
|
||||||
|
|
||||||
|
const onFieldCopy = useCallback(
|
||||||
|
(event?: KeyboardEvent | null) => {
|
||||||
|
event?.preventDefault();
|
||||||
|
// ...
|
||||||
|
},
|
||||||
|
[dependencies],
|
||||||
|
);
|
||||||
|
|
||||||
|
// ✅ Inline handlers for simple operations
|
||||||
|
<Button onClick={() => setOpen(false)}>Close</Button>
|
||||||
|
```
|
||||||
|
|
||||||
|
### State Management
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Descriptive state names with auxiliary verbs
|
||||||
|
const [isLoading, setIsLoading] = useState(false);
|
||||||
|
const [hasError, setHasError] = useState(false);
|
||||||
|
const [showAdvancedSettings, setShowAdvancedSettings] = useState(false);
|
||||||
|
|
||||||
|
// ✅ Complex state in single useState when related
|
||||||
|
const [coords, setCoords] = useState({
|
||||||
|
x: 0,
|
||||||
|
y: 0,
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
### Try-Catch Blocks
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use try-catch for operations that might fail
|
||||||
|
try {
|
||||||
|
const document = await getDocumentById({
|
||||||
|
documentId: Number(documentId),
|
||||||
|
userId: user.id,
|
||||||
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
status: 200,
|
||||||
|
body: document,
|
||||||
|
};
|
||||||
|
} catch (err) {
|
||||||
|
return {
|
||||||
|
status: 404,
|
||||||
|
body: {
|
||||||
|
message: 'Document not found',
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Throwing Errors
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use AppError for application errors
|
||||||
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
||||||
|
message: 'Template not found',
|
||||||
|
});
|
||||||
|
|
||||||
|
// ✅ Use descriptive error messages
|
||||||
|
if (!template) {
|
||||||
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
||||||
|
message: `Template with ID ${templateId} not found`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Error Parsing on Frontend
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Parse errors on the frontend
|
||||||
|
try {
|
||||||
|
await updateOrganisation({ organisationId, data });
|
||||||
|
} catch (err) {
|
||||||
|
const error = AppError.parseError(err);
|
||||||
|
console.error(error);
|
||||||
|
|
||||||
|
toast({
|
||||||
|
title: t`An error occurred`,
|
||||||
|
description: error.message,
|
||||||
|
variant: 'destructive',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Async/Await Patterns
|
||||||
|
|
||||||
|
### Async Function Definitions
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Mark async functions clearly
|
||||||
|
export const createDocument = async ({
|
||||||
|
userId,
|
||||||
|
title,
|
||||||
|
}: Options): Promise<Document> => {
|
||||||
|
// ...
|
||||||
|
};
|
||||||
|
|
||||||
|
// ✅ Use await for promises
|
||||||
|
const document = await prisma.document.create({ data });
|
||||||
|
|
||||||
|
// ✅ Use Promise.all for parallel operations
|
||||||
|
const [document, recipients] = await Promise.all([
|
||||||
|
getDocumentById({ documentId }),
|
||||||
|
getRecipientsForDocument({ documentId }),
|
||||||
|
]);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Void for Fire-and-Forget
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use void for intentionally unwaited promises
|
||||||
|
void handleAutoSave();
|
||||||
|
|
||||||
|
// ✅ Or in event handlers
|
||||||
|
onClick={() => void onFormSubmit()}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Whitespace & Formatting
|
||||||
|
|
||||||
|
### Blank Lines Between Concepts
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Blank line after imports
|
||||||
|
import { prisma } from '@documenso/prisma';
|
||||||
|
|
||||||
|
export const findDocuments = async () => {
|
||||||
|
// ...
|
||||||
|
};
|
||||||
|
|
||||||
|
// ✅ Blank line between logical sections
|
||||||
|
const user = await prisma.user.findFirst({ where: { id: userId } });
|
||||||
|
|
||||||
|
let team = null;
|
||||||
|
|
||||||
|
if (teamId !== undefined) {
|
||||||
|
team = await getTeamById({ userId, teamId });
|
||||||
|
}
|
||||||
|
|
||||||
|
// ✅ Blank line before return statements
|
||||||
|
const result = await someOperation();
|
||||||
|
|
||||||
|
return result;
|
||||||
|
```
|
||||||
|
|
||||||
|
### Function/Method Spacing
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ No blank lines between chained methods in same operation
|
||||||
|
const documents = await prisma.document
|
||||||
|
.findMany({ where: { userId } })
|
||||||
|
.then((docs) => docs.map(maskTokens));
|
||||||
|
|
||||||
|
// ✅ Blank line between different operations
|
||||||
|
const document = await createDocument({ userId });
|
||||||
|
|
||||||
|
await sendDocument({ documentId: document.id });
|
||||||
|
|
||||||
|
return document;
|
||||||
|
```
|
||||||
|
|
||||||
|
### Object and Array Formatting
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Multi-line when complex
|
||||||
|
const options = {
|
||||||
|
userId,
|
||||||
|
teamId,
|
||||||
|
status: ExtendedDocumentStatus.ALL,
|
||||||
|
page: 1,
|
||||||
|
};
|
||||||
|
|
||||||
|
// ✅ Single line when simple
|
||||||
|
const coords = { x: 0, y: 0 };
|
||||||
|
|
||||||
|
// ✅ Array items on separate lines when objects
|
||||||
|
const recipients = [
|
||||||
|
{
|
||||||
|
name: 'John',
|
||||||
|
email: 'john@example.com',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Jane',
|
||||||
|
email: 'jane@example.com',
|
||||||
|
},
|
||||||
|
];
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Naming Conventions
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ camelCase for variables and functions
|
||||||
|
const documentId = 123;
|
||||||
|
const onSubmit = () => {};
|
||||||
|
|
||||||
|
// ✅ Descriptive names with auxiliary verbs for booleans
|
||||||
|
const isLoading = false;
|
||||||
|
const hasError = false;
|
||||||
|
const canEdit = true;
|
||||||
|
const shouldRender = true;
|
||||||
|
|
||||||
|
// ✅ Prefix with $ for DOM elements
|
||||||
|
const $page = document.querySelector('.page');
|
||||||
|
const $inputRef = useRef<HTMLInputElement>(null);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Types and Schemas
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ PascalCase for types
|
||||||
|
type CreateDocumentOptions = {
|
||||||
|
userId: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
// ✅ Prefix Zod schemas with Z
|
||||||
|
const ZCreateDocumentSchema = z.object({
|
||||||
|
title: z.string(),
|
||||||
|
});
|
||||||
|
|
||||||
|
// ✅ Prefix type from Zod schema with T
|
||||||
|
type TCreateDocumentSchema = z.infer<typeof ZCreateDocumentSchema>;
|
||||||
|
```
|
||||||
|
|
||||||
|
### Constants
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ UPPER_SNAKE_CASE for true constants
|
||||||
|
const DEFAULT_DOCUMENT_DATE_FORMAT = 'dd/MM/yyyy';
|
||||||
|
const MAX_FILE_SIZE = 1024 * 1024 * 5;
|
||||||
|
|
||||||
|
// ✅ camelCase for const variables that aren't "constants"
|
||||||
|
const userId = await getUserId();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Functions
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Verb-based names for functions
|
||||||
|
const createDocument = async () => {};
|
||||||
|
const findDocuments = async () => {};
|
||||||
|
const updateDocument = async () => {};
|
||||||
|
const deleteDocument = async () => {};
|
||||||
|
|
||||||
|
// ✅ On prefix for event handlers
|
||||||
|
const onSubmit = () => {};
|
||||||
|
const onClick = () => {};
|
||||||
|
const onFieldCopy = () => {}; // 'on' is also acceptable
|
||||||
|
```
|
||||||
|
|
||||||
|
### Clarity Over Brevity
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Prefer descriptive names over abbreviations
|
||||||
|
const superLongMethodThatIsCorrect = () => {};
|
||||||
|
const recipientAuthenticationOptions = {};
|
||||||
|
const documentMetadata = {};
|
||||||
|
|
||||||
|
// ❌ Avoid abbreviations that sacrifice clarity
|
||||||
|
const supLongMethThatIsCorrect = () => {};
|
||||||
|
const recipAuthOpts = {};
|
||||||
|
const docMeta = {};
|
||||||
|
|
||||||
|
// ✅ Common abbreviations that are widely understood are acceptable
|
||||||
|
const userId = 123;
|
||||||
|
const htmlElement = document.querySelector('div');
|
||||||
|
const apiResponse = await fetch('/api');
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Pattern Matching
|
||||||
|
|
||||||
|
### Using ts-pattern
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { match } from 'ts-pattern';
|
||||||
|
|
||||||
|
// ✅ Use match for complex conditionals
|
||||||
|
const result = match(status)
|
||||||
|
.with(ExtendedDocumentStatus.DRAFT, () => ({
|
||||||
|
status: 'draft',
|
||||||
|
}))
|
||||||
|
.with(ExtendedDocumentStatus.PENDING, () => ({
|
||||||
|
status: 'pending',
|
||||||
|
}))
|
||||||
|
.with(ExtendedDocumentStatus.COMPLETED, () => ({
|
||||||
|
status: 'completed',
|
||||||
|
}))
|
||||||
|
.exhaustive();
|
||||||
|
|
||||||
|
// ✅ Use .otherwise() for default case when not exhaustive
|
||||||
|
const value = match(type)
|
||||||
|
.with('text', () => 'Text field')
|
||||||
|
.with('number', () => 'Number field')
|
||||||
|
.otherwise(() => 'Unknown field');
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Database & Prisma
|
||||||
|
|
||||||
|
### Query Structure
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Destructure commonly used fields
|
||||||
|
const { id, email, name } = user;
|
||||||
|
|
||||||
|
// ✅ Use select to limit returned fields
|
||||||
|
const user = await prisma.user.findFirst({
|
||||||
|
where: { id: userId },
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
email: true,
|
||||||
|
name: true,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// ✅ Use include for relations
|
||||||
|
const document = await prisma.document.findFirst({
|
||||||
|
where: { id: documentId },
|
||||||
|
include: {
|
||||||
|
recipients: true,
|
||||||
|
fields: true,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Transactions
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use transactions for related operations
|
||||||
|
return await prisma.$transaction(async (tx) => {
|
||||||
|
const document = await tx.document.create({ data });
|
||||||
|
|
||||||
|
await tx.field.createMany({ data: fieldsData });
|
||||||
|
|
||||||
|
await tx.documentAuditLog.create({ data: auditData });
|
||||||
|
|
||||||
|
return document;
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Where Clauses
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Build complex where clauses separately
|
||||||
|
const whereClause: Prisma.DocumentWhereInput = {
|
||||||
|
AND: [
|
||||||
|
{ userId: user.id },
|
||||||
|
{ deletedAt: null },
|
||||||
|
{ status: { in: [DocumentStatus.DRAFT, DocumentStatus.PENDING] } },
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
const documents = await prisma.document.findMany({
|
||||||
|
where: whereClause,
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## TRPC Patterns
|
||||||
|
|
||||||
|
### Router Structure
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Destructure context and input at start
|
||||||
|
.query(async ({ input, ctx }) => {
|
||||||
|
const { teamId } = ctx;
|
||||||
|
const { templateId } = input;
|
||||||
|
|
||||||
|
ctx.logger.info({
|
||||||
|
input: { templateId },
|
||||||
|
});
|
||||||
|
|
||||||
|
return await getTemplateById({
|
||||||
|
id: templateId,
|
||||||
|
userId: ctx.user.id,
|
||||||
|
teamId,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Request/Response Schemas
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Name schemas clearly
|
||||||
|
const ZCreateDocumentRequestSchema = z.object({
|
||||||
|
title: z.string(),
|
||||||
|
recipients: z.array(ZRecipientSchema),
|
||||||
|
});
|
||||||
|
|
||||||
|
const ZCreateDocumentResponseSchema = z.object({
|
||||||
|
documentId: z.number(),
|
||||||
|
status: z.string(),
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Error Handling in TRPC
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Catch and transform errors appropriately
|
||||||
|
try {
|
||||||
|
const result = await createDocument({ userId, data });
|
||||||
|
|
||||||
|
return result;
|
||||||
|
} catch (err) {
|
||||||
|
return AppError.toRestAPIError(err);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ✅ Or throw AppError directly
|
||||||
|
if (!template) {
|
||||||
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
||||||
|
message: 'Template not found',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Additional Patterns
|
||||||
|
|
||||||
|
### Optional Chaining
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use optional chaining for potentially undefined values
|
||||||
|
const email = user?.email;
|
||||||
|
const recipientToken = recipient?.token ?? '';
|
||||||
|
|
||||||
|
// ✅ Use nullish coalescing for defaults
|
||||||
|
const pageSize = perPage ?? 10;
|
||||||
|
const status = documentStatus ?? DocumentStatus.DRAFT;
|
||||||
|
```
|
||||||
|
|
||||||
|
### Array Operations
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use functional array methods
|
||||||
|
const activeRecipients = recipients.filter((r) => r.signingStatus === 'SIGNED');
|
||||||
|
const recipientEmails = recipients.map((r) => r.email);
|
||||||
|
const hasSignedRecipients = recipients.some((r) => r.signingStatus === 'SIGNED');
|
||||||
|
|
||||||
|
// ✅ Use find instead of filter + [0]
|
||||||
|
const recipient = recipients.find((r) => r.id === recipientId);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Conditional Rendering
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// ✅ Use && for conditional rendering
|
||||||
|
{isLoading && <Loader />}
|
||||||
|
|
||||||
|
// ✅ Use ternary for either/or
|
||||||
|
{isLoading ? <Loader /> : <Content />}
|
||||||
|
|
||||||
|
// ✅ Extract complex conditions to variables
|
||||||
|
const shouldShowAdvanced = isAdmin && hasPermission && !isDisabled;
|
||||||
|
{shouldShowAdvanced && <AdvancedSettings />}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## When in Doubt
|
||||||
|
|
||||||
|
- **Consistency**: Follow the patterns you see in similar files
|
||||||
|
- **Readability**: Favor code that's easy to read over clever one-liners
|
||||||
|
- **Explicitness**: Be explicit rather than implicit
|
||||||
|
- **Whitespace**: Use blank lines to separate logical sections
|
||||||
|
- **Early Returns**: Use guard clauses to reduce nesting
|
||||||
|
- **Functional**: Prefer functional patterns over imperative ones
|
||||||
@ -22,6 +22,15 @@ Documenso supports Webhooks and allows you to subscribe to the following events:
|
|||||||
- `document.completed`
|
- `document.completed`
|
||||||
- `document.rejected`
|
- `document.rejected`
|
||||||
- `document.cancelled`
|
- `document.cancelled`
|
||||||
|
- `document.viewed`
|
||||||
|
- `document.recipient.completed`
|
||||||
|
- `document.downloaded`
|
||||||
|
- `document.reminder.sent`
|
||||||
|
- `template.created`
|
||||||
|
- `template.updated`
|
||||||
|
- `template.deleted`
|
||||||
|
- `template.used`
|
||||||
|
- `recipient.authentication.failed`
|
||||||
|
|
||||||
## Create a webhook subscription
|
## Create a webhook subscription
|
||||||
|
|
||||||
@ -38,7 +47,7 @@ Clicking on the "**Create Webhook**" button opens a modal to create a new webhoo
|
|||||||
To create a new webhook subscription, you need to provide the following information:
|
To create a new webhook subscription, you need to provide the following information:
|
||||||
|
|
||||||
- Enter the webhook URL that will receive the event payload.
|
- Enter the webhook URL that will receive the event payload.
|
||||||
- Select the event(s) you want to subscribe to: `document.created`, `document.sent`, `document.opened`, `document.signed`, `document.completed`, `document.rejected`, `document.cancelled`.
|
- Select the event(s) you want to subscribe to: `document.created`, `document.sent`, `document.opened`, `document.signed`, `document.completed`, `document.rejected`, `document.cancelled`, `document.viewed`, `document.recipient.completed`, `document.downloaded`, `document.reminder.sent`, `template.created`, `template.updated`, `template.deleted`, `template.used`, `recipient.authentication.failed`.
|
||||||
- Optionally, you can provide a secret key that will be used to sign the payload. This key will be included in the `X-Documenso-Secret` header of the request.
|
- Optionally, you can provide a secret key that will be used to sign the payload. This key will be included in the `X-Documenso-Secret` header of the request.
|
||||||
|
|
||||||

|

|
||||||
@ -619,6 +628,591 @@ Example payload for the `document.rejected` event:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Example payload for the `document.viewed` event:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"event": "DOCUMENT_VIEWED",
|
||||||
|
"payload": {
|
||||||
|
"id": 10,
|
||||||
|
"externalId": null,
|
||||||
|
"userId": 1,
|
||||||
|
"authOptions": null,
|
||||||
|
"formValues": null,
|
||||||
|
"visibility": "EVERYONE",
|
||||||
|
"title": "documenso.pdf",
|
||||||
|
"status": "PENDING",
|
||||||
|
"documentDataId": "hs8qz1ktr9204jn7mg6c5dxy0",
|
||||||
|
"createdAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"updatedAt": "2024-04-22T11:48:07.569Z",
|
||||||
|
"completedAt": null,
|
||||||
|
"deletedAt": null,
|
||||||
|
"teamId": null,
|
||||||
|
"templateId": null,
|
||||||
|
"source": "DOCUMENT",
|
||||||
|
"documentMeta": {
|
||||||
|
"id": "doc_meta_123",
|
||||||
|
"subject": "Please sign this document",
|
||||||
|
"message": "Hello, please review and sign this document.",
|
||||||
|
"timezone": "UTC",
|
||||||
|
"password": null,
|
||||||
|
"dateFormat": "MM/DD/YYYY",
|
||||||
|
"redirectUrl": null,
|
||||||
|
"signingOrder": "PARALLEL",
|
||||||
|
"typedSignatureEnabled": true,
|
||||||
|
"language": "en",
|
||||||
|
"distributionMethod": "EMAIL",
|
||||||
|
"emailSettings": null
|
||||||
|
},
|
||||||
|
"Recipient": [
|
||||||
|
{
|
||||||
|
"id": 52,
|
||||||
|
"documentId": 10,
|
||||||
|
"templateId": null,
|
||||||
|
"email": "signer@documenso.com",
|
||||||
|
"name": "John Doe",
|
||||||
|
"token": "vbT8hi3jKQmrFP_LN1WcS",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": null,
|
||||||
|
"authOptions": null,
|
||||||
|
"signingOrder": 1,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "OPENED",
|
||||||
|
"signingStatus": "NOT_SIGNED",
|
||||||
|
"sendStatus": "SENT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"createdAt": "2024-04-22T11:50:26.174Z",
|
||||||
|
"webhookEndpoint": "https://mywebhooksite.com/mywebhook"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example payload for the `document.recipient.completed` event:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"event": "DOCUMENT_RECIPIENT_COMPLETED",
|
||||||
|
"payload": {
|
||||||
|
"id": 10,
|
||||||
|
"externalId": null,
|
||||||
|
"userId": 1,
|
||||||
|
"authOptions": null,
|
||||||
|
"formValues": null,
|
||||||
|
"visibility": "EVERYONE",
|
||||||
|
"title": "documenso.pdf",
|
||||||
|
"status": "PENDING",
|
||||||
|
"documentDataId": "hs8qz1ktr9204jn7mg6c5dxy0",
|
||||||
|
"createdAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"updatedAt": "2024-04-22T11:51:10.055Z",
|
||||||
|
"completedAt": null,
|
||||||
|
"deletedAt": null,
|
||||||
|
"teamId": null,
|
||||||
|
"templateId": null,
|
||||||
|
"source": "DOCUMENT",
|
||||||
|
"documentMeta": {
|
||||||
|
"id": "doc_meta_123",
|
||||||
|
"subject": "Please sign this document",
|
||||||
|
"message": "Hello, please review and sign this document.",
|
||||||
|
"timezone": "UTC",
|
||||||
|
"password": null,
|
||||||
|
"dateFormat": "MM/DD/YYYY",
|
||||||
|
"redirectUrl": null,
|
||||||
|
"signingOrder": "PARALLEL",
|
||||||
|
"typedSignatureEnabled": true,
|
||||||
|
"language": "en",
|
||||||
|
"distributionMethod": "EMAIL",
|
||||||
|
"emailSettings": null
|
||||||
|
},
|
||||||
|
"Recipient": [
|
||||||
|
{
|
||||||
|
"id": 50,
|
||||||
|
"documentId": 10,
|
||||||
|
"templateId": null,
|
||||||
|
"email": "signer1@documenso.com",
|
||||||
|
"name": "Signer 1",
|
||||||
|
"token": "vbT8hi3jKQmrFP_LN1WcS",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": "2024-04-22T11:51:10.055Z",
|
||||||
|
"authOptions": {
|
||||||
|
"accessAuth": null,
|
||||||
|
"actionAuth": null
|
||||||
|
},
|
||||||
|
"signingOrder": 1,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "OPENED",
|
||||||
|
"signingStatus": "SIGNED",
|
||||||
|
"sendStatus": "SENT"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 51,
|
||||||
|
"documentId": 10,
|
||||||
|
"templateId": null,
|
||||||
|
"email": "signer2@documenso.com",
|
||||||
|
"name": "Signer 2",
|
||||||
|
"token": "HkrptwS42ZBXdRKj1TyUo",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": null,
|
||||||
|
"authOptions": null,
|
||||||
|
"signingOrder": 2,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "NOT_OPENED",
|
||||||
|
"signingStatus": "NOT_SIGNED",
|
||||||
|
"sendStatus": "SENT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"createdAt": "2024-04-22T11:51:10.577Z",
|
||||||
|
"webhookEndpoint": "https://mywebhooksite.com/mywebhook"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example payload for the `document.downloaded` event:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"event": "DOCUMENT_DOWNLOADED",
|
||||||
|
"payload": {
|
||||||
|
"id": 10,
|
||||||
|
"externalId": null,
|
||||||
|
"userId": 1,
|
||||||
|
"authOptions": null,
|
||||||
|
"formValues": null,
|
||||||
|
"visibility": "EVERYONE",
|
||||||
|
"title": "documenso.pdf",
|
||||||
|
"status": "COMPLETED",
|
||||||
|
"documentDataId": "hs8qz1ktr9204jn7mg6c5dxy0",
|
||||||
|
"createdAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"updatedAt": "2024-04-22T11:52:05.708Z",
|
||||||
|
"completedAt": "2024-04-22T11:52:05.707Z",
|
||||||
|
"deletedAt": null,
|
||||||
|
"teamId": null,
|
||||||
|
"templateId": null,
|
||||||
|
"source": "DOCUMENT",
|
||||||
|
"documentMeta": {
|
||||||
|
"id": "doc_meta_123",
|
||||||
|
"subject": "Please sign this document",
|
||||||
|
"message": "Hello, please review and sign this document.",
|
||||||
|
"timezone": "UTC",
|
||||||
|
"password": null,
|
||||||
|
"dateFormat": "MM/DD/YYYY",
|
||||||
|
"redirectUrl": null,
|
||||||
|
"signingOrder": "PARALLEL",
|
||||||
|
"typedSignatureEnabled": true,
|
||||||
|
"language": "en",
|
||||||
|
"distributionMethod": "EMAIL",
|
||||||
|
"emailSettings": null
|
||||||
|
},
|
||||||
|
"Recipient": [
|
||||||
|
{
|
||||||
|
"id": 51,
|
||||||
|
"documentId": 10,
|
||||||
|
"templateId": null,
|
||||||
|
"email": "signer@documenso.com",
|
||||||
|
"name": "Signer",
|
||||||
|
"token": "HkrptwS42ZBXdRKj1TyUo",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": "2024-04-22T11:52:05.688Z",
|
||||||
|
"authOptions": {
|
||||||
|
"accessAuth": null,
|
||||||
|
"actionAuth": null
|
||||||
|
},
|
||||||
|
"signingOrder": 1,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "OPENED",
|
||||||
|
"signingStatus": "SIGNED",
|
||||||
|
"sendStatus": "SENT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"createdAt": "2024-04-22T11:53:18.577Z",
|
||||||
|
"webhookEndpoint": "https://mywebhooksite.com/mywebhook"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example payload for the `document.reminder.sent` event:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"event": "DOCUMENT_REMINDER_SENT",
|
||||||
|
"payload": {
|
||||||
|
"id": 10,
|
||||||
|
"externalId": null,
|
||||||
|
"userId": 1,
|
||||||
|
"authOptions": null,
|
||||||
|
"formValues": null,
|
||||||
|
"visibility": "EVERYONE",
|
||||||
|
"title": "documenso.pdf",
|
||||||
|
"status": "PENDING",
|
||||||
|
"documentDataId": "hs8qz1ktr9204jn7mg6c5dxy0",
|
||||||
|
"createdAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"updatedAt": "2024-04-22T11:48:07.569Z",
|
||||||
|
"completedAt": null,
|
||||||
|
"deletedAt": null,
|
||||||
|
"teamId": null,
|
||||||
|
"templateId": null,
|
||||||
|
"source": "DOCUMENT",
|
||||||
|
"documentMeta": {
|
||||||
|
"id": "doc_meta_123",
|
||||||
|
"subject": "Please sign this document",
|
||||||
|
"message": "Hello, please review and sign this document.",
|
||||||
|
"timezone": "UTC",
|
||||||
|
"password": null,
|
||||||
|
"dateFormat": "MM/DD/YYYY",
|
||||||
|
"redirectUrl": null,
|
||||||
|
"signingOrder": "PARALLEL",
|
||||||
|
"typedSignatureEnabled": true,
|
||||||
|
"language": "en",
|
||||||
|
"distributionMethod": "EMAIL",
|
||||||
|
"emailSettings": null
|
||||||
|
},
|
||||||
|
"Recipient": [
|
||||||
|
{
|
||||||
|
"id": 52,
|
||||||
|
"documentId": 10,
|
||||||
|
"templateId": null,
|
||||||
|
"email": "signer@documenso.com",
|
||||||
|
"name": "Signer",
|
||||||
|
"token": "vbT8hi3jKQmrFP_LN1WcS",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": null,
|
||||||
|
"authOptions": null,
|
||||||
|
"signingOrder": 1,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "OPENED",
|
||||||
|
"signingStatus": "NOT_SIGNED",
|
||||||
|
"sendStatus": "SENT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"createdAt": "2024-04-22T12:00:00.000Z",
|
||||||
|
"webhookEndpoint": "https://mywebhooksite.com/mywebhook"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example payload for the `template.created` event:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"event": "TEMPLATE_CREATED",
|
||||||
|
"payload": {
|
||||||
|
"id": 5,
|
||||||
|
"externalId": null,
|
||||||
|
"userId": 1,
|
||||||
|
"authOptions": null,
|
||||||
|
"formValues": null,
|
||||||
|
"visibility": "EVERYONE",
|
||||||
|
"title": "employment_contract.pdf",
|
||||||
|
"status": "DRAFT",
|
||||||
|
"documentDataId": "hs8qz1ktr9204jn7mg6c5dxy0",
|
||||||
|
"createdAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"updatedAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"completedAt": null,
|
||||||
|
"deletedAt": null,
|
||||||
|
"teamId": 2,
|
||||||
|
"templateId": 5,
|
||||||
|
"source": "TEMPLATE",
|
||||||
|
"documentMeta": {
|
||||||
|
"id": "doc_meta_456",
|
||||||
|
"subject": "Employment Contract",
|
||||||
|
"message": "Please review and sign your employment contract.",
|
||||||
|
"timezone": "UTC",
|
||||||
|
"password": null,
|
||||||
|
"dateFormat": "MM/DD/YYYY",
|
||||||
|
"redirectUrl": null,
|
||||||
|
"signingOrder": "PARALLEL",
|
||||||
|
"typedSignatureEnabled": true,
|
||||||
|
"language": "en",
|
||||||
|
"distributionMethod": "EMAIL",
|
||||||
|
"emailSettings": null
|
||||||
|
},
|
||||||
|
"Recipient": [
|
||||||
|
{
|
||||||
|
"id": 25,
|
||||||
|
"documentId": null,
|
||||||
|
"templateId": 5,
|
||||||
|
"email": "employee@company.com",
|
||||||
|
"name": "Employee",
|
||||||
|
"token": "TemplateToken123",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": null,
|
||||||
|
"authOptions": null,
|
||||||
|
"signingOrder": 1,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "NOT_OPENED",
|
||||||
|
"signingStatus": "NOT_SIGNED",
|
||||||
|
"sendStatus": "NOT_SENT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"createdAt": "2024-04-22T11:44:44.779Z",
|
||||||
|
"webhookEndpoint": "https://mywebhooksite.com/mywebhook"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example payload for the `template.updated` event:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"event": "TEMPLATE_UPDATED",
|
||||||
|
"payload": {
|
||||||
|
"id": 5,
|
||||||
|
"externalId": null,
|
||||||
|
"userId": 1,
|
||||||
|
"authOptions": null,
|
||||||
|
"formValues": null,
|
||||||
|
"visibility": "EVERYONE",
|
||||||
|
"title": "employment_contract_v2.pdf",
|
||||||
|
"status": "DRAFT",
|
||||||
|
"documentDataId": "hs8qz1ktr9204jn7mg6c5dxy0",
|
||||||
|
"createdAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"updatedAt": "2024-04-22T12:30:00.000Z",
|
||||||
|
"completedAt": null,
|
||||||
|
"deletedAt": null,
|
||||||
|
"teamId": 2,
|
||||||
|
"templateId": 5,
|
||||||
|
"source": "TEMPLATE",
|
||||||
|
"documentMeta": {
|
||||||
|
"id": "doc_meta_456",
|
||||||
|
"subject": "Employment Contract - Updated",
|
||||||
|
"message": "Please review and sign your employment contract.",
|
||||||
|
"timezone": "UTC",
|
||||||
|
"password": null,
|
||||||
|
"dateFormat": "MM/DD/YYYY",
|
||||||
|
"redirectUrl": null,
|
||||||
|
"signingOrder": "PARALLEL",
|
||||||
|
"typedSignatureEnabled": true,
|
||||||
|
"language": "en",
|
||||||
|
"distributionMethod": "EMAIL",
|
||||||
|
"emailSettings": null
|
||||||
|
},
|
||||||
|
"Recipient": [
|
||||||
|
{
|
||||||
|
"id": 25,
|
||||||
|
"documentId": null,
|
||||||
|
"templateId": 5,
|
||||||
|
"email": "employee@company.com",
|
||||||
|
"name": "Employee",
|
||||||
|
"token": "TemplateToken123",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": null,
|
||||||
|
"authOptions": null,
|
||||||
|
"signingOrder": 1,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "NOT_OPENED",
|
||||||
|
"signingStatus": "NOT_SIGNED",
|
||||||
|
"sendStatus": "NOT_SENT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"createdAt": "2024-04-22T12:30:01.000Z",
|
||||||
|
"webhookEndpoint": "https://mywebhooksite.com/mywebhook"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example payload for the `template.deleted` event:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"event": "TEMPLATE_DELETED",
|
||||||
|
"payload": {
|
||||||
|
"id": 5,
|
||||||
|
"externalId": null,
|
||||||
|
"userId": 1,
|
||||||
|
"authOptions": null,
|
||||||
|
"formValues": null,
|
||||||
|
"visibility": "EVERYONE",
|
||||||
|
"title": "employment_contract.pdf",
|
||||||
|
"status": "DRAFT",
|
||||||
|
"documentDataId": "hs8qz1ktr9204jn7mg6c5dxy0",
|
||||||
|
"createdAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"updatedAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"completedAt": null,
|
||||||
|
"deletedAt": null,
|
||||||
|
"teamId": 2,
|
||||||
|
"templateId": 5,
|
||||||
|
"source": "TEMPLATE",
|
||||||
|
"documentMeta": {
|
||||||
|
"id": "doc_meta_456",
|
||||||
|
"subject": "Employment Contract",
|
||||||
|
"message": "Please review and sign your employment contract.",
|
||||||
|
"timezone": "UTC",
|
||||||
|
"password": null,
|
||||||
|
"dateFormat": "MM/DD/YYYY",
|
||||||
|
"redirectUrl": null,
|
||||||
|
"signingOrder": "PARALLEL",
|
||||||
|
"typedSignatureEnabled": true,
|
||||||
|
"language": "en",
|
||||||
|
"distributionMethod": "EMAIL",
|
||||||
|
"emailSettings": null
|
||||||
|
},
|
||||||
|
"Recipient": [
|
||||||
|
{
|
||||||
|
"id": 25,
|
||||||
|
"documentId": null,
|
||||||
|
"templateId": 5,
|
||||||
|
"email": "employee@company.com",
|
||||||
|
"name": "Employee",
|
||||||
|
"token": "TemplateToken123",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": null,
|
||||||
|
"authOptions": null,
|
||||||
|
"signingOrder": 1,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "NOT_OPENED",
|
||||||
|
"signingStatus": "NOT_SIGNED",
|
||||||
|
"sendStatus": "NOT_SENT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"createdAt": "2024-04-22T13:00:00.000Z",
|
||||||
|
"webhookEndpoint": "https://mywebhooksite.com/mywebhook"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example payload for the `template.used` event:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"event": "TEMPLATE_USED",
|
||||||
|
"payload": {
|
||||||
|
"id": 15,
|
||||||
|
"externalId": null,
|
||||||
|
"userId": 1,
|
||||||
|
"authOptions": null,
|
||||||
|
"formValues": null,
|
||||||
|
"visibility": "EVERYONE",
|
||||||
|
"title": "employment_contract.pdf",
|
||||||
|
"status": "DRAFT",
|
||||||
|
"documentDataId": "new_doc_data_123",
|
||||||
|
"createdAt": "2024-04-22T14:00:00.000Z",
|
||||||
|
"updatedAt": "2024-04-22T14:00:00.000Z",
|
||||||
|
"completedAt": null,
|
||||||
|
"deletedAt": null,
|
||||||
|
"teamId": 2,
|
||||||
|
"templateId": 5,
|
||||||
|
"source": "TEMPLATE",
|
||||||
|
"documentMeta": {
|
||||||
|
"id": "doc_meta_789",
|
||||||
|
"subject": "Employment Contract",
|
||||||
|
"message": "Please review and sign your employment contract.",
|
||||||
|
"timezone": "UTC",
|
||||||
|
"password": null,
|
||||||
|
"dateFormat": "MM/DD/YYYY",
|
||||||
|
"redirectUrl": null,
|
||||||
|
"signingOrder": "PARALLEL",
|
||||||
|
"typedSignatureEnabled": true,
|
||||||
|
"language": "en",
|
||||||
|
"distributionMethod": "EMAIL",
|
||||||
|
"emailSettings": null
|
||||||
|
},
|
||||||
|
"Recipient": [
|
||||||
|
{
|
||||||
|
"id": 60,
|
||||||
|
"documentId": 15,
|
||||||
|
"templateId": 5,
|
||||||
|
"email": "newemployee@company.com",
|
||||||
|
"name": "New Employee",
|
||||||
|
"token": "DocToken456",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": null,
|
||||||
|
"authOptions": null,
|
||||||
|
"signingOrder": 1,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "NOT_OPENED",
|
||||||
|
"signingStatus": "NOT_SIGNED",
|
||||||
|
"sendStatus": "NOT_SENT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"createdAt": "2024-04-22T14:00:01.000Z",
|
||||||
|
"webhookEndpoint": "https://mywebhooksite.com/mywebhook"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example payload for the `recipient.authentication.failed` event:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"event": "RECIPIENT_AUTHENTICATION_FAILED",
|
||||||
|
"payload": {
|
||||||
|
"id": 10,
|
||||||
|
"externalId": null,
|
||||||
|
"userId": 1,
|
||||||
|
"authOptions": null,
|
||||||
|
"formValues": null,
|
||||||
|
"visibility": "EVERYONE",
|
||||||
|
"title": "documenso.pdf",
|
||||||
|
"status": "PENDING",
|
||||||
|
"documentDataId": "hs8qz1ktr9204jn7mg6c5dxy0",
|
||||||
|
"createdAt": "2024-04-22T11:44:43.341Z",
|
||||||
|
"updatedAt": "2024-04-22T11:48:07.569Z",
|
||||||
|
"completedAt": null,
|
||||||
|
"deletedAt": null,
|
||||||
|
"teamId": null,
|
||||||
|
"templateId": null,
|
||||||
|
"source": "DOCUMENT",
|
||||||
|
"documentMeta": {
|
||||||
|
"id": "doc_meta_123",
|
||||||
|
"subject": "Please sign this document",
|
||||||
|
"message": "Hello, please review and sign this document.",
|
||||||
|
"timezone": "UTC",
|
||||||
|
"password": null,
|
||||||
|
"dateFormat": "MM/DD/YYYY",
|
||||||
|
"redirectUrl": null,
|
||||||
|
"signingOrder": "PARALLEL",
|
||||||
|
"typedSignatureEnabled": true,
|
||||||
|
"language": "en",
|
||||||
|
"distributionMethod": "EMAIL",
|
||||||
|
"emailSettings": null
|
||||||
|
},
|
||||||
|
"Recipient": [
|
||||||
|
{
|
||||||
|
"id": 52,
|
||||||
|
"documentId": 10,
|
||||||
|
"templateId": null,
|
||||||
|
"email": "signer@documenso.com",
|
||||||
|
"name": "Signer",
|
||||||
|
"token": "vbT8hi3jKQmrFP_LN1WcS",
|
||||||
|
"documentDeletedAt": null,
|
||||||
|
"expired": null,
|
||||||
|
"signedAt": null,
|
||||||
|
"authOptions": {
|
||||||
|
"accessAuth": "TWO_FACTOR_AUTH",
|
||||||
|
"actionAuth": null
|
||||||
|
},
|
||||||
|
"signingOrder": 1,
|
||||||
|
"rejectionReason": null,
|
||||||
|
"role": "SIGNER",
|
||||||
|
"readStatus": "NOT_OPENED",
|
||||||
|
"signingStatus": "NOT_SIGNED",
|
||||||
|
"sendStatus": "SENT"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"createdAt": "2024-04-22T11:49:00.000Z",
|
||||||
|
"webhookEndpoint": "https://mywebhooksite.com/mywebhook"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Webhook Events Testing
|
## Webhook Events Testing
|
||||||
|
|
||||||
You can trigger test webhook events to test the webhook functionality. To trigger a test webhook, navigate to the [Webhooks page](/developers/webhooks) and click on the "Test Webhook" button.
|
You can trigger test webhook events to test the webhook functionality. To trigger a test webhook, navigate to the [Webhooks page](/developers/webhooks) and click on the "Test Webhook" button.
|
||||||
|
|||||||
@ -0,0 +1,218 @@
|
|||||||
|
import { useEffect, useState } from 'react';
|
||||||
|
|
||||||
|
import { zodResolver } from '@hookform/resolvers/zod';
|
||||||
|
import { useLingui } from '@lingui/react/macro';
|
||||||
|
import { Trans } from '@lingui/react/macro';
|
||||||
|
import { OrganisationMemberRole } from '@prisma/client';
|
||||||
|
import type * as DialogPrimitive from '@radix-ui/react-dialog';
|
||||||
|
import { useForm } from 'react-hook-form';
|
||||||
|
import { useNavigate } from 'react-router';
|
||||||
|
import { match } from 'ts-pattern';
|
||||||
|
import { z } from 'zod';
|
||||||
|
|
||||||
|
import { getHighestOrganisationRoleInGroup } from '@documenso/lib/utils/organisations';
|
||||||
|
import { trpc } from '@documenso/trpc/react';
|
||||||
|
import type { TGetAdminOrganisationResponse } from '@documenso/trpc/server/admin-router/get-admin-organisation.types';
|
||||||
|
import { Button } from '@documenso/ui/primitives/button';
|
||||||
|
import {
|
||||||
|
Dialog,
|
||||||
|
DialogContent,
|
||||||
|
DialogDescription,
|
||||||
|
DialogFooter,
|
||||||
|
DialogHeader,
|
||||||
|
DialogTitle,
|
||||||
|
DialogTrigger,
|
||||||
|
} from '@documenso/ui/primitives/dialog';
|
||||||
|
import {
|
||||||
|
Form,
|
||||||
|
FormControl,
|
||||||
|
FormField,
|
||||||
|
FormItem,
|
||||||
|
FormLabel,
|
||||||
|
FormMessage,
|
||||||
|
} from '@documenso/ui/primitives/form/form';
|
||||||
|
import {
|
||||||
|
Select,
|
||||||
|
SelectContent,
|
||||||
|
SelectItem,
|
||||||
|
SelectTrigger,
|
||||||
|
SelectValue,
|
||||||
|
} from '@documenso/ui/primitives/select';
|
||||||
|
import { useToast } from '@documenso/ui/primitives/use-toast';
|
||||||
|
|
||||||
|
export type AdminOrganisationMemberUpdateDialogProps = {
|
||||||
|
trigger?: React.ReactNode;
|
||||||
|
organisationId: string;
|
||||||
|
organisationMember: TGetAdminOrganisationResponse['members'][number];
|
||||||
|
isOwner: boolean;
|
||||||
|
} & Omit<DialogPrimitive.DialogProps, 'children'>;
|
||||||
|
|
||||||
|
const ZUpdateOrganisationMemberFormSchema = z.object({
|
||||||
|
role: z.enum(['OWNER', 'ADMIN', 'MANAGER', 'MEMBER']),
|
||||||
|
});
|
||||||
|
|
||||||
|
type ZUpdateOrganisationMemberSchema = z.infer<typeof ZUpdateOrganisationMemberFormSchema>;
|
||||||
|
|
||||||
|
export const AdminOrganisationMemberUpdateDialog = ({
|
||||||
|
trigger,
|
||||||
|
organisationId,
|
||||||
|
organisationMember,
|
||||||
|
isOwner,
|
||||||
|
...props
|
||||||
|
}: AdminOrganisationMemberUpdateDialogProps) => {
|
||||||
|
const [open, setOpen] = useState(false);
|
||||||
|
|
||||||
|
const { t } = useLingui();
|
||||||
|
const { toast } = useToast();
|
||||||
|
const navigate = useNavigate();
|
||||||
|
|
||||||
|
// Determine the current role value for the form
|
||||||
|
const currentRoleValue = isOwner
|
||||||
|
? 'OWNER'
|
||||||
|
: getHighestOrganisationRoleInGroup(
|
||||||
|
organisationMember.organisationGroupMembers.map((ogm) => ogm.group),
|
||||||
|
);
|
||||||
|
const organisationMemberName = organisationMember.user.name ?? organisationMember.user.email;
|
||||||
|
|
||||||
|
const form = useForm<ZUpdateOrganisationMemberSchema>({
|
||||||
|
resolver: zodResolver(ZUpdateOrganisationMemberFormSchema),
|
||||||
|
defaultValues: {
|
||||||
|
role: currentRoleValue,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const { mutateAsync: updateOrganisationMemberRole } =
|
||||||
|
trpc.admin.organisationMember.updateRole.useMutation();
|
||||||
|
|
||||||
|
const onFormSubmit = async ({ role }: ZUpdateOrganisationMemberSchema) => {
|
||||||
|
try {
|
||||||
|
await updateOrganisationMemberRole({
|
||||||
|
organisationId,
|
||||||
|
userId: organisationMember.userId,
|
||||||
|
role,
|
||||||
|
});
|
||||||
|
|
||||||
|
const roleLabel = match(role)
|
||||||
|
.with('OWNER', () => t`Owner`)
|
||||||
|
.with(OrganisationMemberRole.ADMIN, () => t`Admin`)
|
||||||
|
.with(OrganisationMemberRole.MANAGER, () => t`Manager`)
|
||||||
|
.with(OrganisationMemberRole.MEMBER, () => t`Member`)
|
||||||
|
.exhaustive();
|
||||||
|
|
||||||
|
toast({
|
||||||
|
title: t`Success`,
|
||||||
|
description:
|
||||||
|
role === 'OWNER'
|
||||||
|
? t`Ownership transferred to ${organisationMemberName}.`
|
||||||
|
: t`Updated ${organisationMemberName} to ${roleLabel}.`,
|
||||||
|
duration: 5000,
|
||||||
|
});
|
||||||
|
|
||||||
|
setOpen(false);
|
||||||
|
|
||||||
|
// Refresh the page to show updated data
|
||||||
|
await navigate(0);
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
|
||||||
|
toast({
|
||||||
|
title: t`An unknown error occurred`,
|
||||||
|
description: t`We encountered an unknown error while attempting to update this organisation member. Please try again later.`,
|
||||||
|
variant: 'destructive',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (!open) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
form.reset({
|
||||||
|
role: currentRoleValue,
|
||||||
|
});
|
||||||
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||||
|
}, [open, currentRoleValue, form]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Dialog
|
||||||
|
{...props}
|
||||||
|
open={open}
|
||||||
|
onOpenChange={(value) => !form.formState.isSubmitting && setOpen(value)}
|
||||||
|
>
|
||||||
|
<DialogTrigger onClick={(e) => e.stopPropagation()} asChild>
|
||||||
|
{trigger ?? (
|
||||||
|
<Button variant="secondary">
|
||||||
|
<Trans>Update role</Trans>
|
||||||
|
</Button>
|
||||||
|
)}
|
||||||
|
</DialogTrigger>
|
||||||
|
|
||||||
|
<DialogContent position="center">
|
||||||
|
<DialogHeader>
|
||||||
|
<DialogTitle>
|
||||||
|
<Trans>Update organisation member</Trans>
|
||||||
|
</DialogTitle>
|
||||||
|
|
||||||
|
<DialogDescription className="mt-4">
|
||||||
|
<Trans>
|
||||||
|
You are currently updating{' '}
|
||||||
|
<span className="font-bold">{organisationMemberName}.</span>
|
||||||
|
</Trans>
|
||||||
|
</DialogDescription>
|
||||||
|
</DialogHeader>
|
||||||
|
|
||||||
|
<Form {...form}>
|
||||||
|
<form onSubmit={form.handleSubmit(onFormSubmit)}>
|
||||||
|
<fieldset className="flex h-full flex-col" disabled={form.formState.isSubmitting}>
|
||||||
|
<FormField
|
||||||
|
control={form.control}
|
||||||
|
name="role"
|
||||||
|
render={({ field }) => (
|
||||||
|
<FormItem className="w-full">
|
||||||
|
<FormLabel required>
|
||||||
|
<Trans>Role</Trans>
|
||||||
|
</FormLabel>
|
||||||
|
<FormControl>
|
||||||
|
<Select {...field} onValueChange={field.onChange}>
|
||||||
|
<SelectTrigger className="text-muted-foreground">
|
||||||
|
<SelectValue />
|
||||||
|
</SelectTrigger>
|
||||||
|
|
||||||
|
<SelectContent className="w-full" position="popper">
|
||||||
|
<SelectItem value="OWNER">
|
||||||
|
<Trans>Owner</Trans>
|
||||||
|
</SelectItem>
|
||||||
|
<SelectItem value={OrganisationMemberRole.ADMIN}>
|
||||||
|
<Trans>Admin</Trans>
|
||||||
|
</SelectItem>
|
||||||
|
<SelectItem value={OrganisationMemberRole.MANAGER}>
|
||||||
|
<Trans>Manager</Trans>
|
||||||
|
</SelectItem>
|
||||||
|
<SelectItem value={OrganisationMemberRole.MEMBER}>
|
||||||
|
<Trans>Member</Trans>
|
||||||
|
</SelectItem>
|
||||||
|
</SelectContent>
|
||||||
|
</Select>
|
||||||
|
</FormControl>
|
||||||
|
<FormMessage />
|
||||||
|
</FormItem>
|
||||||
|
)}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<DialogFooter className="mt-4">
|
||||||
|
<Button type="button" variant="secondary" onClick={() => setOpen(false)}>
|
||||||
|
<Trans>Cancel</Trans>
|
||||||
|
</Button>
|
||||||
|
|
||||||
|
<Button type="submit" loading={form.formState.isSubmitting}>
|
||||||
|
<Trans>Update</Trans>
|
||||||
|
</Button>
|
||||||
|
</DialogFooter>
|
||||||
|
</fieldset>
|
||||||
|
</form>
|
||||||
|
</Form>
|
||||||
|
</DialogContent>
|
||||||
|
</Dialog>
|
||||||
|
);
|
||||||
|
};
|
||||||
@ -89,7 +89,10 @@ export const DirectTemplatePageView = ({
|
|||||||
setStep('sign');
|
setStep('sign');
|
||||||
};
|
};
|
||||||
|
|
||||||
const onSignDirectTemplateSubmit = async (fields: DirectTemplateLocalField[]) => {
|
const onSignDirectTemplateSubmit = async (
|
||||||
|
fields: DirectTemplateLocalField[],
|
||||||
|
nextSigner?: { name: string; email: string },
|
||||||
|
) => {
|
||||||
try {
|
try {
|
||||||
let directTemplateExternalId = searchParams?.get('externalId') || undefined;
|
let directTemplateExternalId = searchParams?.get('externalId') || undefined;
|
||||||
|
|
||||||
@ -98,6 +101,7 @@ export const DirectTemplatePageView = ({
|
|||||||
}
|
}
|
||||||
|
|
||||||
const { token } = await createDocumentFromDirectTemplate({
|
const { token } = await createDocumentFromDirectTemplate({
|
||||||
|
nextSigner,
|
||||||
directTemplateToken,
|
directTemplateToken,
|
||||||
directTemplateExternalId,
|
directTemplateExternalId,
|
||||||
directRecipientName: fullName,
|
directRecipientName: fullName,
|
||||||
|
|||||||
@ -55,10 +55,13 @@ import { DocumentSigningRecipientProvider } from '../document-signing/document-s
|
|||||||
|
|
||||||
export type DirectTemplateSigningFormProps = {
|
export type DirectTemplateSigningFormProps = {
|
||||||
flowStep: DocumentFlowStep;
|
flowStep: DocumentFlowStep;
|
||||||
directRecipient: Pick<Recipient, 'authOptions' | 'email' | 'role' | 'name' | 'token'>;
|
directRecipient: Pick<Recipient, 'authOptions' | 'email' | 'role' | 'name' | 'token' | 'id'>;
|
||||||
directRecipientFields: Field[];
|
directRecipientFields: Field[];
|
||||||
template: Omit<TTemplate, 'user'>;
|
template: Omit<TTemplate, 'user'>;
|
||||||
onSubmit: (_data: DirectTemplateLocalField[]) => Promise<void>;
|
onSubmit: (
|
||||||
|
_data: DirectTemplateLocalField[],
|
||||||
|
_nextSigner?: { name: string; email: string },
|
||||||
|
) => Promise<void>;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type DirectTemplateLocalField = Field & {
|
export type DirectTemplateLocalField = Field & {
|
||||||
@ -149,7 +152,7 @@ export const DirectTemplateSigningForm = ({
|
|||||||
validateFieldsInserted(fieldsRequiringValidation);
|
validateFieldsInserted(fieldsRequiringValidation);
|
||||||
};
|
};
|
||||||
|
|
||||||
const handleSubmit = async () => {
|
const handleSubmit = async (nextSigner?: { name: string; email: string }) => {
|
||||||
setValidateUninsertedFields(true);
|
setValidateUninsertedFields(true);
|
||||||
|
|
||||||
const isFieldsValid = validateFieldsInserted(fieldsRequiringValidation);
|
const isFieldsValid = validateFieldsInserted(fieldsRequiringValidation);
|
||||||
@ -161,7 +164,7 @@ export const DirectTemplateSigningForm = ({
|
|||||||
setIsSubmitting(true);
|
setIsSubmitting(true);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await onSubmit(localFields);
|
await onSubmit(localFields, nextSigner);
|
||||||
} catch {
|
} catch {
|
||||||
setIsSubmitting(false);
|
setIsSubmitting(false);
|
||||||
}
|
}
|
||||||
@ -218,6 +221,30 @@ export const DirectTemplateSigningForm = ({
|
|||||||
setLocalFields(updatedFields);
|
setLocalFields(updatedFields);
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
|
const nextRecipient = useMemo(() => {
|
||||||
|
if (
|
||||||
|
!template.templateMeta?.signingOrder ||
|
||||||
|
template.templateMeta.signingOrder !== 'SEQUENTIAL' ||
|
||||||
|
!template.templateMeta.allowDictateNextSigner
|
||||||
|
) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
const sortedRecipients = template.recipients.sort((a, b) => {
|
||||||
|
// Sort by signingOrder first (nulls last), then by id
|
||||||
|
if (a.signingOrder === null && b.signingOrder === null) return a.id - b.id;
|
||||||
|
if (a.signingOrder === null) return 1;
|
||||||
|
if (b.signingOrder === null) return -1;
|
||||||
|
if (a.signingOrder === b.signingOrder) return a.id - b.id;
|
||||||
|
return a.signingOrder - b.signingOrder;
|
||||||
|
});
|
||||||
|
|
||||||
|
const currentIndex = sortedRecipients.findIndex((r) => r.id === directRecipient.id);
|
||||||
|
return currentIndex !== -1 && currentIndex < sortedRecipients.length - 1
|
||||||
|
? sortedRecipients[currentIndex + 1]
|
||||||
|
: undefined;
|
||||||
|
}, [template.templateMeta?.signingOrder, template.recipients, directRecipient.id]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<DocumentSigningRecipientProvider recipient={directRecipient}>
|
<DocumentSigningRecipientProvider recipient={directRecipient}>
|
||||||
<DocumentFlowFormContainerHeader title={flowStep.title} description={flowStep.description} />
|
<DocumentFlowFormContainerHeader title={flowStep.title} description={flowStep.description} />
|
||||||
@ -417,11 +444,15 @@ export const DirectTemplateSigningForm = ({
|
|||||||
|
|
||||||
<DocumentSigningCompleteDialog
|
<DocumentSigningCompleteDialog
|
||||||
isSubmitting={isSubmitting}
|
isSubmitting={isSubmitting}
|
||||||
onSignatureComplete={async () => handleSubmit()}
|
onSignatureComplete={async (nextSigner) => handleSubmit(nextSigner)}
|
||||||
documentTitle={template.title}
|
documentTitle={template.title}
|
||||||
fields={localFields}
|
fields={localFields}
|
||||||
fieldsValidated={fieldsValidated}
|
fieldsValidated={fieldsValidated}
|
||||||
recipient={directRecipient}
|
recipient={directRecipient}
|
||||||
|
allowDictateNextSigner={nextRecipient && template.templateMeta?.allowDictateNextSigner}
|
||||||
|
defaultNextSigner={
|
||||||
|
nextRecipient ? { name: nextRecipient.name, email: nextRecipient.email } : undefined
|
||||||
|
}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
</DocumentFlowFormContainerFooter>
|
</DocumentFlowFormContainerFooter>
|
||||||
|
|||||||
@ -9,7 +9,7 @@ import { Button } from '@documenso/ui/primitives/button';
|
|||||||
import { useToast } from '@documenso/ui/primitives/use-toast';
|
import { useToast } from '@documenso/ui/primitives/use-toast';
|
||||||
|
|
||||||
export type DocumentSigningAuthPageViewProps = {
|
export type DocumentSigningAuthPageViewProps = {
|
||||||
email: string;
|
email?: string;
|
||||||
emailHasAccount?: boolean;
|
emailHasAccount?: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -22,12 +22,18 @@ export const DocumentSigningAuthPageView = ({
|
|||||||
|
|
||||||
const [isSigningOut, setIsSigningOut] = useState(false);
|
const [isSigningOut, setIsSigningOut] = useState(false);
|
||||||
|
|
||||||
const handleChangeAccount = async (email: string) => {
|
const handleChangeAccount = async (email?: string) => {
|
||||||
try {
|
try {
|
||||||
setIsSigningOut(true);
|
setIsSigningOut(true);
|
||||||
|
|
||||||
|
let redirectPath = '/signin';
|
||||||
|
|
||||||
|
if (email) {
|
||||||
|
redirectPath = emailHasAccount ? `/signin#email=${email}` : `/signup#email=${email}`;
|
||||||
|
}
|
||||||
|
|
||||||
await authClient.signOut({
|
await authClient.signOut({
|
||||||
redirectPath: emailHasAccount ? `/signin#email=${email}` : `/signup#email=${email}`,
|
redirectPath,
|
||||||
});
|
});
|
||||||
} catch {
|
} catch {
|
||||||
toast({
|
toast({
|
||||||
@ -49,9 +55,13 @@ export const DocumentSigningAuthPageView = ({
|
|||||||
</h1>
|
</h1>
|
||||||
|
|
||||||
<p className="text-muted-foreground mt-2 text-sm">
|
<p className="text-muted-foreground mt-2 text-sm">
|
||||||
<Trans>
|
{email ? (
|
||||||
You need to be logged in as <strong>{email}</strong> to view this page.
|
<Trans>
|
||||||
</Trans>
|
You need to be logged in as <strong>{email}</strong> to view this page.
|
||||||
|
</Trans>
|
||||||
|
) : (
|
||||||
|
<Trans>You need to be logged in to view this page.</Trans>
|
||||||
|
)}
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<Button
|
<Button
|
||||||
|
|||||||
@ -24,7 +24,10 @@ type PasskeyData = {
|
|||||||
isError: boolean;
|
isError: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
type SigningAuthRecipient = Pick<Recipient, 'authOptions' | 'email' | 'role' | 'name' | 'token'>;
|
type SigningAuthRecipient = Pick<
|
||||||
|
Recipient,
|
||||||
|
'authOptions' | 'email' | 'role' | 'name' | 'token' | 'id'
|
||||||
|
>;
|
||||||
|
|
||||||
export type DocumentSigningAuthContextValue = {
|
export type DocumentSigningAuthContextValue = {
|
||||||
executeActionAuthProcedure: (_value: ExecuteActionAuthProcedureOptions) => Promise<void>;
|
executeActionAuthProcedure: (_value: ExecuteActionAuthProcedureOptions) => Promise<void>;
|
||||||
|
|||||||
@ -304,7 +304,6 @@ export const DocumentSigningCompleteDialog = ({
|
|||||||
<form onSubmit={form.handleSubmit(onFormSubmit)}>
|
<form onSubmit={form.handleSubmit(onFormSubmit)}>
|
||||||
{allowDictateNextSigner && defaultNextSigner && (
|
{allowDictateNextSigner && defaultNextSigner && (
|
||||||
<div className="mb-4 flex flex-col gap-4">
|
<div className="mb-4 flex flex-col gap-4">
|
||||||
{/* Todo: Envelopes - Should we say "The next recipient to sign this document will be"? */}
|
|
||||||
<div className="flex flex-col gap-4 md:flex-row">
|
<div className="flex flex-col gap-4 md:flex-row">
|
||||||
<FormField
|
<FormField
|
||||||
control={form.control}
|
control={form.control}
|
||||||
|
|||||||
@ -285,8 +285,6 @@ export const EnvelopeSigningProvider = ({
|
|||||||
}, [envelope.documentMeta?.signingOrder, envelope.recipients, recipient.id]);
|
}, [envelope.documentMeta?.signingOrder, envelope.recipients, recipient.id]);
|
||||||
|
|
||||||
const signField = async (fieldId: number, fieldValue: TSignEnvelopeFieldValue) => {
|
const signField = async (fieldId: number, fieldValue: TSignEnvelopeFieldValue) => {
|
||||||
console.log('insertField', fieldId, fieldValue);
|
|
||||||
|
|
||||||
// Set the field locally for direct templates.
|
// Set the field locally for direct templates.
|
||||||
if (isDirectTemplate) {
|
if (isDirectTemplate) {
|
||||||
handleDirectTemplateFieldInsertion(fieldId, fieldValue);
|
handleDirectTemplateFieldInsertion(fieldId, fieldValue);
|
||||||
|
|||||||
@ -127,6 +127,7 @@ export const EnvelopeSignerCompleteDialog = () => {
|
|||||||
isBase64,
|
isBase64,
|
||||||
};
|
};
|
||||||
}),
|
}),
|
||||||
|
nextSigner,
|
||||||
});
|
});
|
||||||
|
|
||||||
const redirectUrl = envelope.documentMeta.redirectUrl;
|
const redirectUrl = envelope.documentMeta.redirectUrl;
|
||||||
|
|||||||
@ -34,6 +34,7 @@ import { Input } from '@documenso/ui/primitives/input';
|
|||||||
import { Tooltip, TooltipContent, TooltipTrigger } from '@documenso/ui/primitives/tooltip';
|
import { Tooltip, TooltipContent, TooltipTrigger } from '@documenso/ui/primitives/tooltip';
|
||||||
import { useToast } from '@documenso/ui/primitives/use-toast';
|
import { useToast } from '@documenso/ui/primitives/use-toast';
|
||||||
|
|
||||||
|
import { AdminOrganisationMemberUpdateDialog } from '~/components/dialogs/admin-organisation-member-update-dialog';
|
||||||
import { GenericErrorLayout } from '~/components/general/generic-error-layout';
|
import { GenericErrorLayout } from '~/components/general/generic-error-layout';
|
||||||
import { SettingsHeader } from '~/components/general/settings-header';
|
import { SettingsHeader } from '~/components/general/settings-header';
|
||||||
|
|
||||||
@ -71,23 +72,6 @@ export default function OrganisationGroupSettingsPage({ params }: Route.Componen
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const { mutateAsync: promoteToOwner, isPending: isPromotingToOwner } =
|
|
||||||
trpc.admin.organisationMember.promoteToOwner.useMutation({
|
|
||||||
onSuccess: () => {
|
|
||||||
toast({
|
|
||||||
title: t`Success`,
|
|
||||||
description: t`Member promoted to owner successfully`,
|
|
||||||
});
|
|
||||||
},
|
|
||||||
onError: () => {
|
|
||||||
toast({
|
|
||||||
title: t`Error`,
|
|
||||||
description: t`We couldn't promote the member to owner. Please try again.`,
|
|
||||||
variant: 'destructive',
|
|
||||||
});
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
const teamsColumns = useMemo(() => {
|
const teamsColumns = useMemo(() => {
|
||||||
return [
|
return [
|
||||||
{
|
{
|
||||||
@ -120,23 +104,24 @@ export default function OrganisationGroupSettingsPage({ params }: Route.Componen
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
header: t`Actions`,
|
header: t`Actions`,
|
||||||
cell: ({ row }) => (
|
cell: ({ row }) => {
|
||||||
<div className="flex justify-end space-x-2">
|
const isOwner = row.original.userId === organisation?.ownerUserId;
|
||||||
<Button
|
|
||||||
variant="outline"
|
return (
|
||||||
disabled={row.original.userId === organisation?.ownerUserId}
|
<div className="flex justify-end space-x-2">
|
||||||
loading={isPromotingToOwner}
|
<AdminOrganisationMemberUpdateDialog
|
||||||
onClick={async () =>
|
trigger={
|
||||||
promoteToOwner({
|
<Button variant="outline">
|
||||||
organisationId,
|
<Trans>Update role</Trans>
|
||||||
userId: row.original.userId,
|
</Button>
|
||||||
})
|
}
|
||||||
}
|
organisationId={organisationId}
|
||||||
>
|
organisationMember={row.original}
|
||||||
<Trans>Promote to owner</Trans>
|
isOwner={isOwner}
|
||||||
</Button>
|
/>
|
||||||
</div>
|
</div>
|
||||||
),
|
);
|
||||||
|
},
|
||||||
},
|
},
|
||||||
] satisfies DataTableColumnDef<TGetAdminOrganisationResponse['members'][number]>[];
|
] satisfies DataTableColumnDef<TGetAdminOrganisationResponse['members'][number]>[];
|
||||||
}, [organisation]);
|
}, [organisation]);
|
||||||
|
|||||||
@ -8,7 +8,6 @@ import { EnvelopeRenderProvider } from '@documenso/lib/client-only/providers/env
|
|||||||
import { useOptionalSession } from '@documenso/lib/client-only/providers/session';
|
import { useOptionalSession } from '@documenso/lib/client-only/providers/session';
|
||||||
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
||||||
import { getEnvelopeForDirectTemplateSigning } from '@documenso/lib/server-only/envelope/get-envelope-for-direct-template-signing';
|
import { getEnvelopeForDirectTemplateSigning } from '@documenso/lib/server-only/envelope/get-envelope-for-direct-template-signing';
|
||||||
import { getEnvelopeRequiredAccessData } from '@documenso/lib/server-only/envelope/get-envelope-required-access-data';
|
|
||||||
import { getTemplateByDirectLinkToken } from '@documenso/lib/server-only/template/get-template-by-direct-link-token';
|
import { getTemplateByDirectLinkToken } from '@documenso/lib/server-only/template/get-template-by-direct-link-token';
|
||||||
import { DocumentAccessAuth } from '@documenso/lib/types/document-auth';
|
import { DocumentAccessAuth } from '@documenso/lib/types/document-auth';
|
||||||
import { extractDocumentAuthMethods } from '@documenso/lib/utils/document-auth';
|
import { extractDocumentAuthMethods } from '@documenso/lib/utils/document-auth';
|
||||||
@ -98,15 +97,12 @@ const handleV2Loader = async ({ params, request }: Route.LoaderArgs) => {
|
|||||||
envelopeForSigning,
|
envelopeForSigning,
|
||||||
} as const;
|
} as const;
|
||||||
})
|
})
|
||||||
.catch(async (e) => {
|
.catch((e) => {
|
||||||
const error = AppError.parseError(e);
|
const error = AppError.parseError(e);
|
||||||
|
|
||||||
if (error.code === AppErrorCode.UNAUTHORIZED) {
|
if (error.code === AppErrorCode.UNAUTHORIZED) {
|
||||||
const requiredAccessData = await getEnvelopeRequiredAccessData({ token });
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
isDocumentAccessValid: false,
|
isDocumentAccessValid: false,
|
||||||
...requiredAccessData,
|
|
||||||
} as const;
|
} as const;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -226,20 +222,21 @@ const DirectSigningPageV2 = ({ data }: { data: Awaited<ReturnType<typeof handleV
|
|||||||
const user = sessionData?.user;
|
const user = sessionData?.user;
|
||||||
|
|
||||||
if (!data.isDocumentAccessValid) {
|
if (!data.isDocumentAccessValid) {
|
||||||
return (
|
return <DocumentSigningAuthPageView email={''} emailHasAccount={true} />;
|
||||||
<DocumentSigningAuthPageView
|
|
||||||
email={data.recipientEmail}
|
|
||||||
emailHasAccount={!!data.recipientHasAccount}
|
|
||||||
/>
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const { envelope, recipient } = data.envelopeForSigning;
|
const { envelope, recipient } = data.envelopeForSigning;
|
||||||
|
|
||||||
|
const { derivedRecipientAccessAuth } = extractDocumentAuthMethods({
|
||||||
|
documentAuth: envelope.authOptions,
|
||||||
|
});
|
||||||
|
|
||||||
|
const isEmailForced = derivedRecipientAccessAuth.includes(DocumentAccessAuth.ACCOUNT);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<EnvelopeSigningProvider
|
<EnvelopeSigningProvider
|
||||||
envelopeData={data.envelopeForSigning}
|
envelopeData={data.envelopeForSigning}
|
||||||
email={''} // Doing this allows us to let users change the email if they want to.
|
email={isEmailForced ? user?.email || '' : ''} // Doing this allows us to let users change the email if they want to for non-auth templates.
|
||||||
fullName={user?.name}
|
fullName={user?.name}
|
||||||
signature={user?.signature}
|
signature={user?.signature}
|
||||||
>
|
>
|
||||||
|
|||||||
@ -68,15 +68,29 @@ test('[ADMIN]: promote member to owner', async ({ page }) => {
|
|||||||
// Test promoting a MEMBER to owner
|
// Test promoting a MEMBER to owner
|
||||||
const memberRow = page.getByRole('row', { name: memberUser.email });
|
const memberRow = page.getByRole('row', { name: memberUser.email });
|
||||||
|
|
||||||
// Find and click the "Promote to owner" button for the member
|
// Find and click the "Update role" button for the member
|
||||||
const promoteButton = memberRow.getByRole('button', { name: 'Promote to owner' });
|
const updateRoleButton = memberRow.getByRole('button', {
|
||||||
await expect(promoteButton).toBeVisible();
|
name: 'Update role',
|
||||||
await expect(promoteButton).not.toBeDisabled();
|
});
|
||||||
|
await expect(updateRoleButton).toBeVisible();
|
||||||
|
await expect(updateRoleButton).not.toBeDisabled();
|
||||||
|
|
||||||
await promoteButton.click();
|
await updateRoleButton.click();
|
||||||
|
|
||||||
// Verify success toast appears
|
// Wait for dialog to open and select Owner role
|
||||||
await expect(page.getByText('Member promoted to owner successfully').first()).toBeVisible();
|
await expect(page.getByRole('dialog')).toBeVisible();
|
||||||
|
|
||||||
|
// Find and click the select trigger - it's a button with role="combobox"
|
||||||
|
await page.getByRole('dialog').locator('button[role="combobox"]').click();
|
||||||
|
|
||||||
|
// Select "Owner" from the dropdown options
|
||||||
|
await page.getByRole('option', { name: 'Owner' }).click();
|
||||||
|
|
||||||
|
// Click Update button
|
||||||
|
await page.getByRole('dialog').getByRole('button', { name: 'Update' }).click();
|
||||||
|
|
||||||
|
// Wait for dialog to close (indicates success)
|
||||||
|
await expect(page.getByRole('dialog')).not.toBeVisible({ timeout: 10_000 });
|
||||||
|
|
||||||
// Reload the page to see the changes
|
// Reload the page to see the changes
|
||||||
await page.reload();
|
await page.reload();
|
||||||
@ -89,12 +103,18 @@ test('[ADMIN]: promote member to owner', async ({ page }) => {
|
|||||||
const previousOwnerRow = page.getByRole('row', { name: ownerUser.email });
|
const previousOwnerRow = page.getByRole('row', { name: ownerUser.email });
|
||||||
await expect(previousOwnerRow.getByRole('status').filter({ hasText: 'Owner' })).not.toBeVisible();
|
await expect(previousOwnerRow.getByRole('status').filter({ hasText: 'Owner' })).not.toBeVisible();
|
||||||
|
|
||||||
// Verify that the promote button is now disabled for the new owner
|
// Verify that the Update role button exists for the new owner and shows Owner as current role
|
||||||
const newOwnerPromoteButton = newOwnerRow.getByRole('button', { name: 'Promote to owner' });
|
const newOwnerUpdateButton = newOwnerRow.getByRole('button', {
|
||||||
await expect(newOwnerPromoteButton).toBeDisabled();
|
name: 'Update role',
|
||||||
|
});
|
||||||
|
await expect(newOwnerUpdateButton).toBeVisible();
|
||||||
|
|
||||||
// Test that we can't promote the current owner (button should be disabled)
|
// Verify clicking it shows the dialog with Owner already selected
|
||||||
await expect(newOwnerPromoteButton).toHaveAttribute('disabled');
|
await newOwnerUpdateButton.click();
|
||||||
|
await expect(page.getByRole('dialog')).toBeVisible();
|
||||||
|
|
||||||
|
// Close the dialog without making changes
|
||||||
|
await page.getByRole('button', { name: 'Cancel' }).click();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('[ADMIN]: promote manager to owner', async ({ page }) => {
|
test('[ADMIN]: promote manager to owner', async ({ page }) => {
|
||||||
@ -130,10 +150,26 @@ test('[ADMIN]: promote manager to owner', async ({ page }) => {
|
|||||||
|
|
||||||
// Promote the manager to owner
|
// Promote the manager to owner
|
||||||
const managerRow = page.getByRole('row', { name: managerUser.email });
|
const managerRow = page.getByRole('row', { name: managerUser.email });
|
||||||
const promoteButton = managerRow.getByRole('button', { name: 'Promote to owner' });
|
const updateRoleButton = managerRow.getByRole('button', {
|
||||||
|
name: 'Update role',
|
||||||
|
});
|
||||||
|
|
||||||
await promoteButton.click();
|
await updateRoleButton.click();
|
||||||
await expect(page.getByText('Member promoted to owner successfully').first()).toBeVisible();
|
|
||||||
|
// Wait for dialog to open and select Owner role
|
||||||
|
await expect(page.getByRole('dialog')).toBeVisible();
|
||||||
|
|
||||||
|
// Find and click the select trigger - it's a button with role="combobox"
|
||||||
|
await page.getByRole('dialog').locator('button[role="combobox"]').click();
|
||||||
|
|
||||||
|
// Select "Owner" from the dropdown options
|
||||||
|
await page.getByRole('option', { name: 'Owner' }).click();
|
||||||
|
|
||||||
|
// Click Update button
|
||||||
|
await page.getByRole('dialog').getByRole('button', { name: 'Update' }).click();
|
||||||
|
|
||||||
|
// Wait for dialog to close (indicates success)
|
||||||
|
await expect(page.getByRole('dialog')).not.toBeVisible({ timeout: 10_000 });
|
||||||
|
|
||||||
// Reload and verify the change
|
// Reload and verify the change
|
||||||
await page.reload();
|
await page.reload();
|
||||||
@ -173,14 +209,27 @@ test('[ADMIN]: promote admin member to owner', async ({ page }) => {
|
|||||||
|
|
||||||
// Promote the admin member to owner
|
// Promote the admin member to owner
|
||||||
const adminMemberRow = page.getByRole('row', { name: adminMemberUser.email });
|
const adminMemberRow = page.getByRole('row', { name: adminMemberUser.email });
|
||||||
const promoteButton = adminMemberRow.getByRole('button', { name: 'Promote to owner' });
|
const updateRoleButton = adminMemberRow.getByRole('button', {
|
||||||
|
name: 'Update role',
|
||||||
await promoteButton.click();
|
|
||||||
|
|
||||||
await expect(page.getByText('Member promoted to owner successfully').first()).toBeVisible({
|
|
||||||
timeout: 10_000,
|
|
||||||
});
|
});
|
||||||
|
|
||||||
|
await updateRoleButton.click();
|
||||||
|
|
||||||
|
// Wait for dialog to open and select Owner role
|
||||||
|
await expect(page.getByRole('dialog')).toBeVisible();
|
||||||
|
|
||||||
|
// Find and click the select trigger - it's a button with role="combobox"
|
||||||
|
await page.getByRole('dialog').locator('button[role="combobox"]').click();
|
||||||
|
|
||||||
|
// Select "Owner" from the dropdown options
|
||||||
|
await page.getByRole('option', { name: 'Owner' }).click();
|
||||||
|
|
||||||
|
// Click Update button
|
||||||
|
await page.getByRole('dialog').getByRole('button', { name: 'Update' }).click();
|
||||||
|
|
||||||
|
// Wait for dialog to close (indicates success)
|
||||||
|
await expect(page.getByRole('dialog')).not.toBeVisible({ timeout: 10_000 });
|
||||||
|
|
||||||
// Reload and verify the change
|
// Reload and verify the change
|
||||||
await page.reload();
|
await page.reload();
|
||||||
await expect(adminMemberRow.getByRole('status').filter({ hasText: 'Owner' })).toBeVisible();
|
await expect(adminMemberRow.getByRole('status').filter({ hasText: 'Owner' })).toBeVisible();
|
||||||
@ -249,11 +298,25 @@ test('[ADMIN]: verify role hierarchy after promotion', async ({ page }) => {
|
|||||||
await expect(memberRow.getByRole('status').filter({ hasText: 'Owner' })).not.toBeVisible();
|
await expect(memberRow.getByRole('status').filter({ hasText: 'Owner' })).not.toBeVisible();
|
||||||
|
|
||||||
// Promote member to owner
|
// Promote member to owner
|
||||||
const promoteButton = memberRow.getByRole('button', { name: 'Promote to owner' });
|
const updateRoleButton = memberRow.getByRole('button', {
|
||||||
await promoteButton.click();
|
name: 'Update role',
|
||||||
await expect(page.getByText('Member promoted to owner successfully').first()).toBeVisible({
|
|
||||||
timeout: 10_000,
|
|
||||||
});
|
});
|
||||||
|
await updateRoleButton.click();
|
||||||
|
|
||||||
|
// Wait for dialog to open and select Owner role
|
||||||
|
await expect(page.getByRole('dialog')).toBeVisible();
|
||||||
|
|
||||||
|
// Find and click the select trigger - it's a button with role="combobox"
|
||||||
|
await page.getByRole('dialog').locator('button[role="combobox"]').click();
|
||||||
|
|
||||||
|
// Select "Owner" from the dropdown options
|
||||||
|
await page.getByRole('option', { name: 'Owner' }).click();
|
||||||
|
|
||||||
|
// Click Update button
|
||||||
|
await page.getByRole('dialog').getByRole('button', { name: 'Update' }).click();
|
||||||
|
|
||||||
|
// Wait for dialog to close (indicates success)
|
||||||
|
await expect(page.getByRole('dialog')).not.toBeVisible({ timeout: 10_000 });
|
||||||
|
|
||||||
// Reload page to see updated state
|
// Reload page to see updated state
|
||||||
await page.reload();
|
await page.reload();
|
||||||
@ -262,9 +325,11 @@ test('[ADMIN]: verify role hierarchy after promotion', async ({ page }) => {
|
|||||||
memberRow = page.getByRole('row', { name: memberUser.email });
|
memberRow = page.getByRole('row', { name: memberUser.email });
|
||||||
await expect(memberRow.getByRole('status').filter({ hasText: 'Owner' })).toBeVisible();
|
await expect(memberRow.getByRole('status').filter({ hasText: 'Owner' })).toBeVisible();
|
||||||
|
|
||||||
// Verify the promote button is now disabled for the new owner
|
// Verify the Update role button exists and shows Owner as current role
|
||||||
const newOwnerPromoteButton = memberRow.getByRole('button', { name: 'Promote to owner' });
|
const newOwnerUpdateButton = memberRow.getByRole('button', {
|
||||||
await expect(newOwnerPromoteButton).toBeDisabled();
|
name: 'Update role',
|
||||||
|
});
|
||||||
|
await expect(newOwnerUpdateButton).toBeVisible();
|
||||||
|
|
||||||
// Sign in as the newly promoted user to verify they have owner permissions
|
// Sign in as the newly promoted user to verify they have owner permissions
|
||||||
await apiSignin({
|
await apiSignin({
|
||||||
@ -336,28 +401,56 @@ test('[ADMIN]: multiple promotions in sequence', async ({ page }) => {
|
|||||||
|
|
||||||
// First promotion: Member 1 becomes owner
|
// First promotion: Member 1 becomes owner
|
||||||
let member1Row = page.getByRole('row', { name: member1User.email });
|
let member1Row = page.getByRole('row', { name: member1User.email });
|
||||||
let promoteButton1 = member1Row.getByRole('button', { name: 'Promote to owner' });
|
let updateRoleButton1 = member1Row.getByRole('button', {
|
||||||
await promoteButton1.click();
|
name: 'Update role',
|
||||||
await expect(page.getByText('Member promoted to owner successfully').first()).toBeVisible({
|
|
||||||
timeout: 10_000,
|
|
||||||
});
|
});
|
||||||
|
await updateRoleButton1.click();
|
||||||
|
|
||||||
|
// Wait for dialog to open and select Owner role
|
||||||
|
await expect(page.getByRole('dialog')).toBeVisible();
|
||||||
|
|
||||||
|
// Find and click the select trigger - it's a button with role="combobox"
|
||||||
|
await page.getByRole('dialog').locator('button[role="combobox"]').click();
|
||||||
|
|
||||||
|
// Select "Owner" from the dropdown options
|
||||||
|
await page.getByRole('option', { name: 'Owner' }).click();
|
||||||
|
|
||||||
|
// Click Update button
|
||||||
|
await page.getByRole('dialog').getByRole('button', { name: 'Update' }).click();
|
||||||
|
|
||||||
|
// Wait for dialog to close (indicates success)
|
||||||
|
await expect(page.getByRole('dialog')).not.toBeVisible({ timeout: 10_000 });
|
||||||
|
|
||||||
await page.reload();
|
await page.reload();
|
||||||
|
|
||||||
// Verify Member 1 is now owner and button is disabled
|
// Verify Member 1 is now owner
|
||||||
member1Row = page.getByRole('row', { name: member1User.email });
|
member1Row = page.getByRole('row', { name: member1User.email });
|
||||||
await expect(member1Row.getByRole('status').filter({ hasText: 'Owner' })).toBeVisible();
|
await expect(member1Row.getByRole('status').filter({ hasText: 'Owner' })).toBeVisible();
|
||||||
promoteButton1 = member1Row.getByRole('button', { name: 'Promote to owner' });
|
updateRoleButton1 = member1Row.getByRole('button', { name: 'Update role' });
|
||||||
await expect(promoteButton1).toBeDisabled();
|
await expect(updateRoleButton1).toBeVisible();
|
||||||
|
|
||||||
// Second promotion: Member 2 becomes the new owner
|
// Second promotion: Member 2 becomes the new owner
|
||||||
const member2Row = page.getByRole('row', { name: member2User.email });
|
const member2Row = page.getByRole('row', { name: member2User.email });
|
||||||
const promoteButton2 = member2Row.getByRole('button', { name: 'Promote to owner' });
|
const updateRoleButton2 = member2Row.getByRole('button', {
|
||||||
await expect(promoteButton2).not.toBeDisabled();
|
name: 'Update role',
|
||||||
await promoteButton2.click();
|
|
||||||
await expect(page.getByText('Member promoted to owner successfully').first()).toBeVisible({
|
|
||||||
timeout: 10_000,
|
|
||||||
});
|
});
|
||||||
|
await expect(updateRoleButton2).toBeVisible();
|
||||||
|
await updateRoleButton2.click();
|
||||||
|
|
||||||
|
// Wait for dialog to open and select Owner role
|
||||||
|
await expect(page.getByRole('dialog')).toBeVisible();
|
||||||
|
|
||||||
|
// Find and click the select trigger - it's a button with role="combobox"
|
||||||
|
await page.getByRole('dialog').locator('button[role="combobox"]').click();
|
||||||
|
|
||||||
|
// Select "Owner" from the dropdown options
|
||||||
|
await page.getByRole('option', { name: 'Owner' }).click();
|
||||||
|
|
||||||
|
// Click Update button
|
||||||
|
await page.getByRole('dialog').getByRole('button', { name: 'Update' }).click();
|
||||||
|
|
||||||
|
// Wait for dialog to close (indicates success)
|
||||||
|
await expect(page.getByRole('dialog')).not.toBeVisible({ timeout: 10_000 });
|
||||||
|
|
||||||
await page.reload();
|
await page.reload();
|
||||||
|
|
||||||
@ -365,9 +458,11 @@ test('[ADMIN]: multiple promotions in sequence', async ({ page }) => {
|
|||||||
await expect(member2Row.getByRole('status').filter({ hasText: 'Owner' })).toBeVisible();
|
await expect(member2Row.getByRole('status').filter({ hasText: 'Owner' })).toBeVisible();
|
||||||
await expect(member1Row.getByRole('status').filter({ hasText: 'Owner' })).not.toBeVisible();
|
await expect(member1Row.getByRole('status').filter({ hasText: 'Owner' })).not.toBeVisible();
|
||||||
|
|
||||||
// Verify Member 1's promote button is now enabled again
|
// Verify Member 1's Update role button is still visible
|
||||||
const newPromoteButton1 = member1Row.getByRole('button', { name: 'Promote to owner' });
|
const newUpdateButton1 = member1Row.getByRole('button', {
|
||||||
await expect(newPromoteButton1).not.toBeDisabled();
|
name: 'Update role',
|
||||||
|
});
|
||||||
|
await expect(newUpdateButton1).toBeVisible();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('[ADMIN]: verify organisation access after ownership change', async ({ page }) => {
|
test('[ADMIN]: verify organisation access after ownership change', async ({ page }) => {
|
||||||
@ -402,11 +497,25 @@ test('[ADMIN]: verify organisation access after ownership change', async ({ page
|
|||||||
});
|
});
|
||||||
|
|
||||||
const memberRow = page.getByRole('row', { name: memberUser.email });
|
const memberRow = page.getByRole('row', { name: memberUser.email });
|
||||||
const promoteButton = memberRow.getByRole('button', { name: 'Promote to owner' });
|
const updateRoleButton = memberRow.getByRole('button', {
|
||||||
await promoteButton.click();
|
name: 'Update role',
|
||||||
await expect(page.getByText('Member promoted to owner successfully').first()).toBeVisible({
|
|
||||||
timeout: 10_000,
|
|
||||||
});
|
});
|
||||||
|
await updateRoleButton.click();
|
||||||
|
|
||||||
|
// Wait for dialog to open and select Owner role
|
||||||
|
await expect(page.getByRole('dialog')).toBeVisible();
|
||||||
|
|
||||||
|
// Find and click the select trigger - it's a button with role="combobox"
|
||||||
|
await page.getByRole('dialog').locator('button[role="combobox"]').click();
|
||||||
|
|
||||||
|
// Select "Owner" from the dropdown options
|
||||||
|
await page.getByRole('option', { name: 'Owner' }).click();
|
||||||
|
|
||||||
|
// Click Update button
|
||||||
|
await page.getByRole('dialog').getByRole('button', { name: 'Update' }).click();
|
||||||
|
|
||||||
|
// Wait for dialog to close (indicates success)
|
||||||
|
await expect(page.getByRole('dialog')).not.toBeVisible({ timeout: 10_000 });
|
||||||
|
|
||||||
// Test that the new owner can access organisation settings
|
// Test that the new owner can access organisation settings
|
||||||
await apiSignin({
|
await apiSignin({
|
||||||
@ -1,9 +1,12 @@
|
|||||||
import { expect, test } from '@playwright/test';
|
import { expect, test } from '@playwright/test';
|
||||||
|
import { DocumentSigningOrder, RecipientRole } from '@prisma/client';
|
||||||
import { customAlphabet } from 'nanoid';
|
import { customAlphabet } from 'nanoid';
|
||||||
|
|
||||||
import { NEXT_PUBLIC_WEBAPP_URL } from '@documenso/lib/constants/app';
|
import { NEXT_PUBLIC_WEBAPP_URL } from '@documenso/lib/constants/app';
|
||||||
import { createDocumentAuthOptions } from '@documenso/lib/utils/document-auth';
|
import { createDocumentAuthOptions } from '@documenso/lib/utils/document-auth';
|
||||||
|
import { mapSecondaryIdToTemplateId } from '@documenso/lib/utils/envelope';
|
||||||
import { formatDirectTemplatePath } from '@documenso/lib/utils/templates';
|
import { formatDirectTemplatePath } from '@documenso/lib/utils/templates';
|
||||||
|
import { prisma } from '@documenso/prisma';
|
||||||
import { seedTeam } from '@documenso/prisma/seed/teams';
|
import { seedTeam } from '@documenso/prisma/seed/teams';
|
||||||
import { seedDirectTemplate, seedTemplate } from '@documenso/prisma/seed/templates';
|
import { seedDirectTemplate, seedTemplate } from '@documenso/prisma/seed/templates';
|
||||||
import { seedTestEmail, seedUser } from '@documenso/prisma/seed/users';
|
import { seedTestEmail, seedUser } from '@documenso/prisma/seed/users';
|
||||||
@ -121,7 +124,7 @@ test('[DIRECT_TEMPLATES]: delete direct template link', async ({ page }) => {
|
|||||||
await expect(page.getByText('404 not found')).toBeVisible();
|
await expect(page.getByText('404 not found')).toBeVisible();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('[DIRECT_TEMPLATES]: direct template link auth access', async ({ page }) => {
|
test('[DIRECT_TEMPLATES]: V1 direct template link auth access', async ({ page }) => {
|
||||||
const { user, team } = await seedUser();
|
const { user, team } = await seedUser();
|
||||||
|
|
||||||
const directTemplateWithAuth = await seedDirectTemplate({
|
const directTemplateWithAuth = await seedDirectTemplate({
|
||||||
@ -153,6 +156,53 @@ test('[DIRECT_TEMPLATES]: direct template link auth access', async ({ page }) =>
|
|||||||
|
|
||||||
await expect(page.getByRole('heading', { name: 'General' })).toBeVisible();
|
await expect(page.getByRole('heading', { name: 'General' })).toBeVisible();
|
||||||
await expect(page.getByLabel('Email')).toBeDisabled();
|
await expect(page.getByLabel('Email')).toBeDisabled();
|
||||||
|
|
||||||
|
await page.getByRole('button', { name: 'Continue' }).click();
|
||||||
|
await page.getByRole('button', { name: 'Complete' }).click();
|
||||||
|
|
||||||
|
await page.getByRole('button', { name: 'Sign' }).click();
|
||||||
|
await page.waitForURL(/\/sign/);
|
||||||
|
await expect(page.getByRole('heading', { name: 'Document Signed' })).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('[DIRECT_TEMPLATES]: V2 direct template link auth access', async ({ page }) => {
|
||||||
|
const { user, team } = await seedUser();
|
||||||
|
|
||||||
|
const directTemplateWithAuth = await seedDirectTemplate({
|
||||||
|
title: 'Personal direct template link',
|
||||||
|
userId: user.id,
|
||||||
|
teamId: team.id,
|
||||||
|
internalVersion: 2,
|
||||||
|
createTemplateOptions: {
|
||||||
|
authOptions: createDocumentAuthOptions({
|
||||||
|
globalAccessAuth: ['ACCOUNT'],
|
||||||
|
globalActionAuth: [],
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const directTemplatePath = formatDirectTemplatePath(
|
||||||
|
directTemplateWithAuth.directLink?.token || '',
|
||||||
|
);
|
||||||
|
|
||||||
|
await page.goto(directTemplatePath);
|
||||||
|
|
||||||
|
await expect(page.getByText('Authentication required')).toBeVisible();
|
||||||
|
|
||||||
|
await apiSignin({
|
||||||
|
page,
|
||||||
|
email: user.email,
|
||||||
|
});
|
||||||
|
|
||||||
|
await page.goto(directTemplatePath);
|
||||||
|
|
||||||
|
await expect(page.getByRole('heading', { name: 'Personal direct template link' })).toBeVisible();
|
||||||
|
await page.getByRole('button', { name: 'Complete' }).click();
|
||||||
|
await expect(page.getByLabel('Your Email')).not.toBeVisible();
|
||||||
|
|
||||||
|
await page.getByRole('button', { name: 'Sign' }).click();
|
||||||
|
await page.waitForURL(/\/sign/);
|
||||||
|
await expect(page.getByRole('heading', { name: 'Document Signed' })).toBeVisible();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('[DIRECT_TEMPLATES]: use direct template link with 1 recipient', async ({ page }) => {
|
test('[DIRECT_TEMPLATES]: use direct template link with 1 recipient', async ({ page }) => {
|
||||||
@ -175,6 +225,9 @@ test('[DIRECT_TEMPLATES]: use direct template link with 1 recipient', async ({ p
|
|||||||
await page.getByPlaceholder('recipient@documenso.com').fill(seedTestEmail());
|
await page.getByPlaceholder('recipient@documenso.com').fill(seedTestEmail());
|
||||||
|
|
||||||
await page.getByRole('button', { name: 'Continue' }).click();
|
await page.getByRole('button', { name: 'Continue' }).click();
|
||||||
|
|
||||||
|
await expect(page.getByText('Next Recipient Name')).not.toBeVisible();
|
||||||
|
|
||||||
await page.getByRole('button', { name: 'Complete' }).click();
|
await page.getByRole('button', { name: 'Complete' }).click();
|
||||||
await page.getByRole('button', { name: 'Sign' }).click();
|
await page.getByRole('button', { name: 'Sign' }).click();
|
||||||
await page.waitForURL(/\/sign/);
|
await page.waitForURL(/\/sign/);
|
||||||
@ -183,3 +236,173 @@ test('[DIRECT_TEMPLATES]: use direct template link with 1 recipient', async ({ p
|
|||||||
// Add a longer waiting period to ensure document status is updated
|
// Add a longer waiting period to ensure document status is updated
|
||||||
await page.waitForTimeout(3000);
|
await page.waitForTimeout(3000);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('[DIRECT_TEMPLATES]: V1 use direct template link with 2 recipients with next signer dictation', async ({
|
||||||
|
page,
|
||||||
|
}) => {
|
||||||
|
const { team, owner, organisation } = await seedTeam({
|
||||||
|
createTeamMembers: 1,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Should be visible to team members.
|
||||||
|
const template = await seedDirectTemplate({
|
||||||
|
title: 'Team direct template link 1',
|
||||||
|
userId: owner.id,
|
||||||
|
teamId: team.id,
|
||||||
|
});
|
||||||
|
|
||||||
|
await prisma.documentMeta.update({
|
||||||
|
where: {
|
||||||
|
id: template.documentMetaId,
|
||||||
|
},
|
||||||
|
data: {
|
||||||
|
allowDictateNextSigner: true,
|
||||||
|
signingOrder: DocumentSigningOrder.SEQUENTIAL,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const originalName = 'Signer 2';
|
||||||
|
const originalSecondSignerEmail = seedTestEmail();
|
||||||
|
|
||||||
|
// Add another signer
|
||||||
|
await prisma.recipient.create({
|
||||||
|
data: {
|
||||||
|
signingOrder: 2,
|
||||||
|
envelopeId: template.id,
|
||||||
|
email: originalSecondSignerEmail,
|
||||||
|
name: originalName,
|
||||||
|
token: Math.random().toString().slice(2, 7),
|
||||||
|
role: RecipientRole.SIGNER,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Check that the direct template link is accessible.
|
||||||
|
await page.goto(formatDirectTemplatePath(template.directLink?.token || ''));
|
||||||
|
await expect(page.getByRole('heading', { name: 'General' })).toBeVisible();
|
||||||
|
|
||||||
|
await page.waitForTimeout(100);
|
||||||
|
await page.getByPlaceholder('recipient@documenso.com').fill(seedTestEmail());
|
||||||
|
|
||||||
|
await page.getByRole('button', { name: 'Continue' }).click();
|
||||||
|
await page.getByRole('button', { name: 'Complete' }).click();
|
||||||
|
|
||||||
|
await expect(page.getByText('Next Recipient Name')).toBeVisible();
|
||||||
|
|
||||||
|
const nextRecipientNameInputValue = await page.getByLabel('Next Recipient Name').inputValue();
|
||||||
|
expect(nextRecipientNameInputValue).toBe(originalName);
|
||||||
|
|
||||||
|
const nextRecipientEmailInputValue = await page.getByLabel('Next Recipient Email').inputValue();
|
||||||
|
expect(nextRecipientEmailInputValue).toBe(originalSecondSignerEmail);
|
||||||
|
|
||||||
|
const newName = 'Hello';
|
||||||
|
const newSecondSignerEmail = seedTestEmail();
|
||||||
|
|
||||||
|
await page.getByLabel('Next Recipient Email').fill(newSecondSignerEmail);
|
||||||
|
await page.getByLabel('Next Recipient Name').fill(newName);
|
||||||
|
|
||||||
|
await page.getByRole('button', { name: 'Sign' }).click();
|
||||||
|
await page.waitForURL(/\/sign/);
|
||||||
|
await expect(page.getByRole('heading', { name: 'Document Signed' })).toBeVisible();
|
||||||
|
|
||||||
|
const createdEnvelopeRecipients = await prisma.recipient.findMany({
|
||||||
|
where: {
|
||||||
|
envelope: {
|
||||||
|
templateId: mapSecondaryIdToTemplateId(template.secondaryId),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const updatedSecondRecipient = createdEnvelopeRecipients.find(
|
||||||
|
(recipient) => recipient.signingOrder === 2,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(updatedSecondRecipient?.name).toBe(newName);
|
||||||
|
expect(updatedSecondRecipient?.email).toBe(newSecondSignerEmail);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('[DIRECT_TEMPLATES]: V2 use direct template link with 2 recipients with next signer dictation', async ({
|
||||||
|
page,
|
||||||
|
}) => {
|
||||||
|
const { team, owner, organisation } = await seedTeam({
|
||||||
|
createTeamMembers: 1,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Should be visible to team members.
|
||||||
|
const template = await seedDirectTemplate({
|
||||||
|
title: 'Team direct template link 1',
|
||||||
|
userId: owner.id,
|
||||||
|
teamId: team.id,
|
||||||
|
internalVersion: 2,
|
||||||
|
});
|
||||||
|
|
||||||
|
await prisma.documentMeta.update({
|
||||||
|
where: {
|
||||||
|
id: template.documentMetaId,
|
||||||
|
},
|
||||||
|
data: {
|
||||||
|
allowDictateNextSigner: true,
|
||||||
|
signingOrder: DocumentSigningOrder.SEQUENTIAL,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const originalName = 'Signer 2';
|
||||||
|
const originalSecondSignerEmail = seedTestEmail();
|
||||||
|
|
||||||
|
// Add another signer
|
||||||
|
await prisma.recipient.create({
|
||||||
|
data: {
|
||||||
|
signingOrder: 2,
|
||||||
|
envelopeId: template.id,
|
||||||
|
email: originalSecondSignerEmail,
|
||||||
|
name: originalName,
|
||||||
|
token: Math.random().toString().slice(2, 7),
|
||||||
|
role: RecipientRole.SIGNER,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Check that the direct template link is accessible.
|
||||||
|
await page.goto(formatDirectTemplatePath(template.directLink?.token || ''));
|
||||||
|
await expect(page.getByRole('heading', { name: 'Team direct template link 1' })).toBeVisible();
|
||||||
|
await page.waitForTimeout(100);
|
||||||
|
|
||||||
|
await page.getByRole('button', { name: 'Complete' }).click();
|
||||||
|
|
||||||
|
const currentName = 'John Doe';
|
||||||
|
const currentEmail = seedTestEmail();
|
||||||
|
|
||||||
|
await page.getByPlaceholder('Enter Your Name').fill(currentName);
|
||||||
|
await page.getByPlaceholder('Enter Your Email').fill(currentEmail);
|
||||||
|
|
||||||
|
await expect(page.getByText('Next Recipient Name')).toBeVisible();
|
||||||
|
|
||||||
|
const nextRecipientNameInputValue = await page.getByLabel('Next Recipient Name').inputValue();
|
||||||
|
expect(nextRecipientNameInputValue).toBe(originalName);
|
||||||
|
|
||||||
|
const nextRecipientEmailInputValue = await page.getByLabel('Next Recipient Email').inputValue();
|
||||||
|
expect(nextRecipientEmailInputValue).toBe(originalSecondSignerEmail);
|
||||||
|
|
||||||
|
const newName = 'Hello';
|
||||||
|
const newSecondSignerEmail = seedTestEmail();
|
||||||
|
|
||||||
|
await page.getByLabel('Next Recipient Email').fill(newSecondSignerEmail);
|
||||||
|
await page.getByLabel('Next Recipient Name').fill(newName);
|
||||||
|
|
||||||
|
await page.getByRole('button', { name: 'Sign' }).click();
|
||||||
|
await page.waitForURL(/\/sign/);
|
||||||
|
await expect(page.getByRole('heading', { name: 'Document Signed' })).toBeVisible();
|
||||||
|
|
||||||
|
const createdEnvelopeRecipients = await prisma.recipient.findMany({
|
||||||
|
where: {
|
||||||
|
envelope: {
|
||||||
|
templateId: mapSecondaryIdToTemplateId(template.secondaryId),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const updatedSecondRecipient = createdEnvelopeRecipients.find(
|
||||||
|
(recipient) => recipient.signingOrder === 2,
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(updatedSecondRecipient?.name).toBe(newName);
|
||||||
|
expect(updatedSecondRecipient?.email).toBe(newSecondSignerEmail);
|
||||||
|
});
|
||||||
|
|||||||
@ -97,7 +97,9 @@ export const completeDocumentWithToken = async ({
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (envelope.documentMeta?.signingOrder === DocumentSigningOrder.SEQUENTIAL) {
|
if (envelope.documentMeta?.signingOrder === DocumentSigningOrder.SEQUENTIAL) {
|
||||||
const isRecipientsTurn = await getIsRecipientsTurnToSign({ token: recipient.token });
|
const isRecipientsTurn = await getIsRecipientsTurnToSign({
|
||||||
|
token: recipient.token,
|
||||||
|
});
|
||||||
|
|
||||||
if (!isRecipientsTurn) {
|
if (!isRecipientsTurn) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
@ -151,6 +153,18 @@ export const completeDocumentWithToken = async ({
|
|||||||
}),
|
}),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const envelopeForFailure = await prisma.envelope.findUniqueOrThrow({
|
||||||
|
where: { id: envelope.id },
|
||||||
|
include: { documentMeta: true, recipients: true },
|
||||||
|
});
|
||||||
|
|
||||||
|
await triggerWebhook({
|
||||||
|
event: WebhookTriggerEvents.RECIPIENT_AUTHENTICATION_FAILED,
|
||||||
|
data: ZWebhookDocumentSchema.parse(mapEnvelopeToWebhookDocumentPayload(envelopeForFailure)),
|
||||||
|
userId: envelope.userId,
|
||||||
|
teamId: envelope.teamId,
|
||||||
|
});
|
||||||
|
|
||||||
throw new AppError(AppErrorCode.TWO_FACTOR_AUTH_FAILED, {
|
throw new AppError(AppErrorCode.TWO_FACTOR_AUTH_FAILED, {
|
||||||
message: 'Invalid 2FA authentication',
|
message: 'Invalid 2FA authentication',
|
||||||
});
|
});
|
||||||
@ -205,6 +219,18 @@ export const completeDocumentWithToken = async ({
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const envelopeWithRelations = await prisma.envelope.findUniqueOrThrow({
|
||||||
|
where: { id: envelope.id },
|
||||||
|
include: { documentMeta: true, recipients: true },
|
||||||
|
});
|
||||||
|
|
||||||
|
await triggerWebhook({
|
||||||
|
event: WebhookTriggerEvents.DOCUMENT_RECIPIENT_COMPLETED,
|
||||||
|
data: ZWebhookDocumentSchema.parse(mapEnvelopeToWebhookDocumentPayload(envelopeWithRelations)),
|
||||||
|
userId: envelope.userId,
|
||||||
|
teamId: envelope.teamId,
|
||||||
|
});
|
||||||
|
|
||||||
await jobs.triggerJob({
|
await jobs.triggerJob({
|
||||||
name: 'send.recipient.signed.email',
|
name: 'send.recipient.signed.email',
|
||||||
payload: {
|
payload: {
|
||||||
|
|||||||
@ -1,7 +1,5 @@
|
|||||||
import { EnvelopeType, TeamMemberRole } from '@prisma/client';
|
|
||||||
import type { Prisma, User } from '@prisma/client';
|
import type { Prisma, User } from '@prisma/client';
|
||||||
import { SigningStatus } from '@prisma/client';
|
import { DocumentVisibility, EnvelopeType, SigningStatus, TeamMemberRole } from '@prisma/client';
|
||||||
import { DocumentVisibility } from '@prisma/client';
|
|
||||||
import { DateTime } from 'luxon';
|
import { DateTime } from 'luxon';
|
||||||
import { match } from 'ts-pattern';
|
import { match } from 'ts-pattern';
|
||||||
|
|
||||||
@ -215,13 +213,14 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const rootPageFilter = folderId === undefined ? { folderId: null } : {};
|
||||||
|
|
||||||
let ownerCountsWhereInput: Prisma.EnvelopeWhereInput = {
|
let ownerCountsWhereInput: Prisma.EnvelopeWhereInput = {
|
||||||
type: EnvelopeType.DOCUMENT,
|
type: EnvelopeType.DOCUMENT,
|
||||||
userId: userIdWhereClause,
|
userId: userIdWhereClause,
|
||||||
createdAt,
|
createdAt,
|
||||||
teamId,
|
teamId,
|
||||||
deletedAt: null,
|
deletedAt: null,
|
||||||
folderId,
|
|
||||||
};
|
};
|
||||||
|
|
||||||
let notSignedCountsGroupByArgs = null;
|
let notSignedCountsGroupByArgs = null;
|
||||||
@ -265,8 +264,16 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
|
|
||||||
ownerCountsWhereInput = {
|
ownerCountsWhereInput = {
|
||||||
...ownerCountsWhereInput,
|
...ownerCountsWhereInput,
|
||||||
...visibilityFiltersWhereInput,
|
AND: [
|
||||||
...searchFilter,
|
...(Array.isArray(visibilityFiltersWhereInput.AND)
|
||||||
|
? visibilityFiltersWhereInput.AND
|
||||||
|
: visibilityFiltersWhereInput.AND
|
||||||
|
? [visibilityFiltersWhereInput.AND]
|
||||||
|
: []),
|
||||||
|
searchFilter,
|
||||||
|
rootPageFilter,
|
||||||
|
folderId ? { folderId } : {},
|
||||||
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
if (teamEmail) {
|
if (teamEmail) {
|
||||||
@ -285,6 +292,7 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
deletedAt: null,
|
deletedAt: null,
|
||||||
|
AND: [searchFilter, rootPageFilter, folderId ? { folderId } : {}],
|
||||||
};
|
};
|
||||||
|
|
||||||
notSignedCountsGroupByArgs = {
|
notSignedCountsGroupByArgs = {
|
||||||
@ -296,7 +304,6 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
type: EnvelopeType.DOCUMENT,
|
type: EnvelopeType.DOCUMENT,
|
||||||
userId: userIdWhereClause,
|
userId: userIdWhereClause,
|
||||||
createdAt,
|
createdAt,
|
||||||
folderId,
|
|
||||||
status: ExtendedDocumentStatus.PENDING,
|
status: ExtendedDocumentStatus.PENDING,
|
||||||
recipients: {
|
recipients: {
|
||||||
some: {
|
some: {
|
||||||
@ -306,6 +313,7 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
deletedAt: null,
|
deletedAt: null,
|
||||||
|
AND: [searchFilter, rootPageFilter, folderId ? { folderId } : {}],
|
||||||
},
|
},
|
||||||
} satisfies Prisma.EnvelopeGroupByArgs;
|
} satisfies Prisma.EnvelopeGroupByArgs;
|
||||||
|
|
||||||
@ -318,7 +326,6 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
type: EnvelopeType.DOCUMENT,
|
type: EnvelopeType.DOCUMENT,
|
||||||
userId: userIdWhereClause,
|
userId: userIdWhereClause,
|
||||||
createdAt,
|
createdAt,
|
||||||
folderId,
|
|
||||||
OR: [
|
OR: [
|
||||||
{
|
{
|
||||||
status: ExtendedDocumentStatus.PENDING,
|
status: ExtendedDocumentStatus.PENDING,
|
||||||
@ -342,6 +349,7 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
AND: [searchFilter, rootPageFilter, folderId ? { folderId } : {}],
|
||||||
},
|
},
|
||||||
} satisfies Prisma.EnvelopeGroupByArgs;
|
} satisfies Prisma.EnvelopeGroupByArgs;
|
||||||
}
|
}
|
||||||
|
|||||||
@ -7,6 +7,7 @@ import {
|
|||||||
OrganisationType,
|
OrganisationType,
|
||||||
RecipientRole,
|
RecipientRole,
|
||||||
SigningStatus,
|
SigningStatus,
|
||||||
|
WebhookTriggerEvents,
|
||||||
} from '@prisma/client';
|
} from '@prisma/client';
|
||||||
|
|
||||||
import { mailer } from '@documenso/email/mailer';
|
import { mailer } from '@documenso/email/mailer';
|
||||||
@ -24,11 +25,16 @@ import { prisma } from '@documenso/prisma';
|
|||||||
import { getI18nInstance } from '../../client-only/providers/i18n-server';
|
import { getI18nInstance } from '../../client-only/providers/i18n-server';
|
||||||
import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
|
import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
|
||||||
import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
|
import { extractDerivedDocumentEmailSettings } from '../../types/document-email';
|
||||||
|
import {
|
||||||
|
ZWebhookDocumentSchema,
|
||||||
|
mapEnvelopeToWebhookDocumentPayload,
|
||||||
|
} from '../../types/webhook-payload';
|
||||||
import { isDocumentCompleted } from '../../utils/document';
|
import { isDocumentCompleted } from '../../utils/document';
|
||||||
import type { EnvelopeIdOptions } from '../../utils/envelope';
|
import type { EnvelopeIdOptions } from '../../utils/envelope';
|
||||||
import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
|
import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
|
||||||
import { getEmailContext } from '../email/get-email-context';
|
import { getEmailContext } from '../email/get-email-context';
|
||||||
import { getEnvelopeWhereInput } from '../envelope/get-envelope-by-id';
|
import { getEnvelopeWhereInput } from '../envelope/get-envelope-by-id';
|
||||||
|
import { triggerWebhook } from '../webhooks/trigger/trigger-webhook';
|
||||||
|
|
||||||
export type ResendDocumentOptions = {
|
export type ResendDocumentOptions = {
|
||||||
id: EnvelopeIdOptions;
|
id: EnvelopeIdOptions;
|
||||||
@ -230,4 +236,11 @@ export const resendDocument = async ({
|
|||||||
);
|
);
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
|
await triggerWebhook({
|
||||||
|
event: WebhookTriggerEvents.DOCUMENT_REMINDER_SENT,
|
||||||
|
data: ZWebhookDocumentSchema.parse(mapEnvelopeToWebhookDocumentPayload(envelope)),
|
||||||
|
userId: envelope.userId,
|
||||||
|
teamId: envelope.teamId,
|
||||||
|
});
|
||||||
};
|
};
|
||||||
|
|||||||
@ -1,5 +1,4 @@
|
|||||||
import { EnvelopeType, ReadStatus, SendStatus } from '@prisma/client';
|
import { EnvelopeType, ReadStatus, SendStatus, WebhookTriggerEvents } from '@prisma/client';
|
||||||
import { WebhookTriggerEvents } from '@prisma/client';
|
|
||||||
|
|
||||||
import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
|
import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
|
||||||
import type { RequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
|
import type { RequestMetadata } from '@documenso/lib/universal/extract-request-metadata';
|
||||||
@ -66,6 +65,13 @@ export const viewedDocument = async ({
|
|||||||
}),
|
}),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
await triggerWebhook({
|
||||||
|
event: WebhookTriggerEvents.DOCUMENT_VIEWED,
|
||||||
|
data: ZWebhookDocumentSchema.parse(mapEnvelopeToWebhookDocumentPayload(envelope)),
|
||||||
|
userId: envelope.userId,
|
||||||
|
teamId: envelope.teamId,
|
||||||
|
});
|
||||||
|
|
||||||
// Early return if already opened.
|
// Early return if already opened.
|
||||||
if (recipient.readStatus === ReadStatus.OPENED) {
|
if (recipient.readStatus === ReadStatus.OPENED) {
|
||||||
return;
|
return;
|
||||||
|
|||||||
@ -386,6 +386,13 @@ export const createEnvelope = async ({
|
|||||||
userId,
|
userId,
|
||||||
teamId,
|
teamId,
|
||||||
});
|
});
|
||||||
|
} else if (type === EnvelopeType.TEMPLATE) {
|
||||||
|
await triggerWebhook({
|
||||||
|
event: WebhookTriggerEvents.TEMPLATE_CREATED,
|
||||||
|
data: ZWebhookDocumentSchema.parse(mapEnvelopeToWebhookDocumentPayload(createdEnvelope)),
|
||||||
|
userId,
|
||||||
|
teamId,
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
return createdEnvelope;
|
return createdEnvelope;
|
||||||
|
|||||||
@ -1,10 +1,11 @@
|
|||||||
import { DocumentStatus, EnvelopeType } from '@prisma/client';
|
import { DocumentStatus, EnvelopeType } from '@prisma/client';
|
||||||
|
import { match } from 'ts-pattern';
|
||||||
|
|
||||||
import { prisma } from '@documenso/prisma';
|
import { prisma } from '@documenso/prisma';
|
||||||
|
|
||||||
import { AppError, AppErrorCode } from '../../errors/app-error';
|
import { AppError, AppErrorCode } from '../../errors/app-error';
|
||||||
import type { TDocumentAuthMethods } from '../../types/document-auth';
|
import { DocumentAccessAuth, type TDocumentAuthMethods } from '../../types/document-auth';
|
||||||
import { isRecipientAuthorized } from '../document/is-recipient-authorized';
|
import { extractDocumentAuthMethods } from '../../utils/document-auth';
|
||||||
import { getTeamSettings } from '../team/get-team-settings';
|
import { getTeamSettings } from '../team/get-team-settings';
|
||||||
import type { EnvelopeForSigningResponse } from './get-envelope-for-recipient-signing';
|
import type { EnvelopeForSigningResponse } from './get-envelope-for-recipient-signing';
|
||||||
import { ZEnvelopeForSigningResponse } from './get-envelope-for-recipient-signing';
|
import { ZEnvelopeForSigningResponse } from './get-envelope-for-recipient-signing';
|
||||||
@ -98,14 +99,28 @@ export const getEnvelopeForDirectTemplateSigning = async ({
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
const documentAccessValid = await isRecipientAuthorized({
|
// Currently not using this since for direct templates "User" access means they just need to be
|
||||||
type: 'ACCESS',
|
// logged in.
|
||||||
documentAuthOptions: envelope.authOptions,
|
// const documentAccessValid = await isRecipientAuthorized({
|
||||||
recipient,
|
// type: 'ACCESS',
|
||||||
userId,
|
// documentAuthOptions: envelope.authOptions,
|
||||||
authOptions: accessAuth,
|
// recipient,
|
||||||
|
// userId,
|
||||||
|
// authOptions: accessAuth,
|
||||||
|
// });
|
||||||
|
|
||||||
|
const { derivedRecipientAccessAuth } = extractDocumentAuthMethods({
|
||||||
|
documentAuth: envelope.authOptions,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Ensure typesafety when we add more options.
|
||||||
|
const documentAccessValid = derivedRecipientAccessAuth.every((auth) =>
|
||||||
|
match(auth)
|
||||||
|
.with(DocumentAccessAuth.ACCOUNT, () => Boolean(userId))
|
||||||
|
.with(DocumentAccessAuth.TWO_FACTOR_AUTH, () => true)
|
||||||
|
.exhaustive(),
|
||||||
|
);
|
||||||
|
|
||||||
if (!documentAccessValid) {
|
if (!documentAccessValid) {
|
||||||
throw new AppError(AppErrorCode.UNAUTHORIZED, {
|
throw new AppError(AppErrorCode.UNAUTHORIZED, {
|
||||||
message: 'Invalid access values',
|
message: 'Invalid access values',
|
||||||
|
|||||||
@ -54,54 +54,3 @@ export const getEnvelopeRequiredAccessData = async ({ token }: { token: string }
|
|||||||
recipientHasAccount: Boolean(recipientUserAccount),
|
recipientHasAccount: Boolean(recipientUserAccount),
|
||||||
} as const;
|
} as const;
|
||||||
};
|
};
|
||||||
|
|
||||||
export const getEnvelopeDirectTemplateRequiredAccessData = async ({ token }: { token: string }) => {
|
|
||||||
const envelope = await prisma.envelope.findFirst({
|
|
||||||
where: {
|
|
||||||
type: EnvelopeType.TEMPLATE,
|
|
||||||
directLink: {
|
|
||||||
enabled: true,
|
|
||||||
token,
|
|
||||||
},
|
|
||||||
status: DocumentStatus.DRAFT,
|
|
||||||
},
|
|
||||||
include: {
|
|
||||||
recipients: {
|
|
||||||
where: {
|
|
||||||
token,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
directLink: true,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!envelope) {
|
|
||||||
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
||||||
message: 'Envelope not found',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const recipient = envelope.recipients.find(
|
|
||||||
(r) => r.id === envelope.directLink?.directTemplateRecipientId,
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!recipient) {
|
|
||||||
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
||||||
message: 'Recipient not found',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const recipientUserAccount = await prisma.user.findFirst({
|
|
||||||
where: {
|
|
||||||
email: recipient.email.toLowerCase(),
|
|
||||||
},
|
|
||||||
select: {
|
|
||||||
id: true,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
return {
|
|
||||||
recipientEmail: recipient.email,
|
|
||||||
recipientHasAccount: Boolean(recipientUserAccount),
|
|
||||||
} as const;
|
|
||||||
};
|
|
||||||
|
|||||||
@ -1,6 +1,5 @@
|
|||||||
import type { DocumentMeta, DocumentVisibility, Prisma, TemplateType } from '@prisma/client';
|
import type { DocumentMeta, DocumentVisibility, Prisma, TemplateType } from '@prisma/client';
|
||||||
import { EnvelopeType, FolderType } from '@prisma/client';
|
import { DocumentStatus, EnvelopeType, FolderType, WebhookTriggerEvents } from '@prisma/client';
|
||||||
import { DocumentStatus } from '@prisma/client';
|
|
||||||
import { isDeepEqual } from 'remeda';
|
import { isDeepEqual } from 'remeda';
|
||||||
|
|
||||||
import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
|
import { DOCUMENT_AUDIT_LOG_TYPE } from '@documenso/lib/types/document-audit-logs';
|
||||||
@ -12,9 +11,14 @@ import { prisma } from '@documenso/prisma';
|
|||||||
import { TEAM_DOCUMENT_VISIBILITY_MAP } from '../../constants/teams';
|
import { TEAM_DOCUMENT_VISIBILITY_MAP } from '../../constants/teams';
|
||||||
import { AppError, AppErrorCode } from '../../errors/app-error';
|
import { AppError, AppErrorCode } from '../../errors/app-error';
|
||||||
import type { TDocumentAccessAuthTypes, TDocumentActionAuthTypes } from '../../types/document-auth';
|
import type { TDocumentAccessAuthTypes, TDocumentActionAuthTypes } from '../../types/document-auth';
|
||||||
|
import {
|
||||||
|
ZWebhookDocumentSchema,
|
||||||
|
mapEnvelopeToWebhookDocumentPayload,
|
||||||
|
} from '../../types/webhook-payload';
|
||||||
import { createDocumentAuthOptions, extractDocumentAuthMethods } from '../../utils/document-auth';
|
import { createDocumentAuthOptions, extractDocumentAuthMethods } from '../../utils/document-auth';
|
||||||
import type { EnvelopeIdOptions } from '../../utils/envelope';
|
import type { EnvelopeIdOptions } from '../../utils/envelope';
|
||||||
import { buildTeamWhereQuery, canAccessTeamDocument } from '../../utils/teams';
|
import { buildTeamWhereQuery, canAccessTeamDocument } from '../../utils/teams';
|
||||||
|
import { triggerWebhook } from '../webhooks/trigger/trigger-webhook';
|
||||||
import { getEnvelopeWhereInput } from './get-envelope-by-id';
|
import { getEnvelopeWhereInput } from './get-envelope-by-id';
|
||||||
|
|
||||||
export type UpdateEnvelopeOptions = {
|
export type UpdateEnvelopeOptions = {
|
||||||
@ -339,6 +343,22 @@ export const updateEnvelope = async ({
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (envelope.type === EnvelopeType.TEMPLATE) {
|
||||||
|
const envelopeWithRelations = await tx.envelope.findUniqueOrThrow({
|
||||||
|
where: { id: updatedEnvelope.id },
|
||||||
|
include: { documentMeta: true, recipients: true },
|
||||||
|
});
|
||||||
|
|
||||||
|
void triggerWebhook({
|
||||||
|
event: WebhookTriggerEvents.TEMPLATE_UPDATED,
|
||||||
|
data: ZWebhookDocumentSchema.parse(
|
||||||
|
mapEnvelopeToWebhookDocumentPayload(envelopeWithRelations),
|
||||||
|
),
|
||||||
|
userId,
|
||||||
|
teamId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
return updatedEnvelope;
|
return updatedEnvelope;
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|||||||
@ -3,6 +3,7 @@ import { createElement } from 'react';
|
|||||||
import { msg } from '@lingui/core/macro';
|
import { msg } from '@lingui/core/macro';
|
||||||
import type { Field, Signature } from '@prisma/client';
|
import type { Field, Signature } from '@prisma/client';
|
||||||
import {
|
import {
|
||||||
|
DocumentSigningOrder,
|
||||||
DocumentSource,
|
DocumentSource,
|
||||||
DocumentStatus,
|
DocumentStatus,
|
||||||
EnvelopeType,
|
EnvelopeType,
|
||||||
@ -26,7 +27,7 @@ import type { TSignFieldWithTokenMutationSchema } from '@documenso/trpc/server/f
|
|||||||
import { getI18nInstance } from '../../client-only/providers/i18n-server';
|
import { getI18nInstance } from '../../client-only/providers/i18n-server';
|
||||||
import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
|
import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
|
||||||
import { AppError, AppErrorCode } from '../../errors/app-error';
|
import { AppError, AppErrorCode } from '../../errors/app-error';
|
||||||
import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
|
import { DOCUMENT_AUDIT_LOG_TYPE, RECIPIENT_DIFF_TYPE } from '../../types/document-audit-logs';
|
||||||
import type { TRecipientActionAuthTypes } from '../../types/document-auth';
|
import type { TRecipientActionAuthTypes } from '../../types/document-auth';
|
||||||
import { DocumentAccessAuth, ZRecipientAuthOptionsSchema } from '../../types/document-auth';
|
import { DocumentAccessAuth, ZRecipientAuthOptionsSchema } from '../../types/document-auth';
|
||||||
import { ZFieldMetaSchema } from '../../types/field-meta';
|
import { ZFieldMetaSchema } from '../../types/field-meta';
|
||||||
@ -68,6 +69,10 @@ export type CreateDocumentFromDirectTemplateOptions = {
|
|||||||
name?: string;
|
name?: string;
|
||||||
email: string;
|
email: string;
|
||||||
};
|
};
|
||||||
|
nextSigner?: {
|
||||||
|
email: string;
|
||||||
|
name: string;
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
type CreatedDirectRecipientField = {
|
type CreatedDirectRecipientField = {
|
||||||
@ -92,6 +97,7 @@ export const createDocumentFromDirectTemplate = async ({
|
|||||||
directTemplateExternalId,
|
directTemplateExternalId,
|
||||||
signedFieldValues,
|
signedFieldValues,
|
||||||
templateUpdatedAt,
|
templateUpdatedAt,
|
||||||
|
nextSigner,
|
||||||
requestMetadata,
|
requestMetadata,
|
||||||
user,
|
user,
|
||||||
}: CreateDocumentFromDirectTemplateOptions): Promise<TCreateDocumentFromDirectTemplateResponse> => {
|
}: CreateDocumentFromDirectTemplateOptions): Promise<TCreateDocumentFromDirectTemplateResponse> => {
|
||||||
@ -128,6 +134,17 @@ export const createDocumentFromDirectTemplate = async ({
|
|||||||
throw new AppError(AppErrorCode.INVALID_REQUEST, { message: 'Invalid or missing template' });
|
throw new AppError(AppErrorCode.INVALID_REQUEST, { message: 'Invalid or missing template' });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
nextSigner &&
|
||||||
|
(!directTemplateEnvelope.documentMeta?.allowDictateNextSigner ||
|
||||||
|
directTemplateEnvelope.documentMeta?.signingOrder !== DocumentSigningOrder.SEQUENTIAL)
|
||||||
|
) {
|
||||||
|
throw new AppError(AppErrorCode.INVALID_REQUEST, {
|
||||||
|
message:
|
||||||
|
'You need to enable allowDictateNextSigner and sequential signing to dictate the next signer',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
const directTemplateEnvelopeLegacyId = mapSecondaryIdToTemplateId(
|
const directTemplateEnvelopeLegacyId = mapSecondaryIdToTemplateId(
|
||||||
directTemplateEnvelope.secondaryId,
|
directTemplateEnvelope.secondaryId,
|
||||||
);
|
);
|
||||||
@ -630,6 +647,77 @@ export const createDocumentFromDirectTemplate = async ({
|
|||||||
}),
|
}),
|
||||||
];
|
];
|
||||||
|
|
||||||
|
if (nextSigner) {
|
||||||
|
const pendingRecipients = await tx.recipient.findMany({
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
signingOrder: true,
|
||||||
|
name: true,
|
||||||
|
email: true,
|
||||||
|
role: true,
|
||||||
|
},
|
||||||
|
where: {
|
||||||
|
envelopeId: createdEnvelope.id,
|
||||||
|
signingStatus: {
|
||||||
|
not: SigningStatus.SIGNED,
|
||||||
|
},
|
||||||
|
role: {
|
||||||
|
not: RecipientRole.CC,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
// Composite sort so our next recipient is always the one with the lowest signing order or id
|
||||||
|
// if there is a tie.
|
||||||
|
orderBy: [{ signingOrder: { sort: 'asc', nulls: 'last' } }, { id: 'asc' }],
|
||||||
|
});
|
||||||
|
|
||||||
|
const nextRecipient = pendingRecipients[0];
|
||||||
|
|
||||||
|
if (nextRecipient) {
|
||||||
|
auditLogsToCreate.push(
|
||||||
|
createDocumentAuditLogData({
|
||||||
|
type: DOCUMENT_AUDIT_LOG_TYPE.RECIPIENT_UPDATED,
|
||||||
|
envelopeId: createdEnvelope.id,
|
||||||
|
user: {
|
||||||
|
name: user?.name || directRecipientName || '',
|
||||||
|
email: user?.email || directRecipientEmail,
|
||||||
|
},
|
||||||
|
metadata: requestMetadata,
|
||||||
|
data: {
|
||||||
|
recipientEmail: nextRecipient.email,
|
||||||
|
recipientName: nextRecipient.name,
|
||||||
|
recipientId: nextRecipient.id,
|
||||||
|
recipientRole: nextRecipient.role,
|
||||||
|
changes: [
|
||||||
|
{
|
||||||
|
type: RECIPIENT_DIFF_TYPE.NAME,
|
||||||
|
from: nextRecipient.name,
|
||||||
|
to: nextSigner.name,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: RECIPIENT_DIFF_TYPE.EMAIL,
|
||||||
|
from: nextRecipient.email,
|
||||||
|
to: nextSigner.email,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
await tx.recipient.update({
|
||||||
|
where: { id: nextRecipient.id },
|
||||||
|
data: {
|
||||||
|
sendStatus: SendStatus.SENT,
|
||||||
|
...(nextSigner && documentMeta?.allowDictateNextSigner
|
||||||
|
? {
|
||||||
|
name: nextSigner.name,
|
||||||
|
email: nextSigner.email,
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
await tx.documentAuditLog.createMany({
|
await tx.documentAuditLog.createMany({
|
||||||
data: auditLogsToCreate,
|
data: auditLogsToCreate,
|
||||||
});
|
});
|
||||||
|
|||||||
@ -725,6 +725,13 @@ export const createDocumentFromTemplate = async ({
|
|||||||
teamId,
|
teamId,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
await triggerWebhook({
|
||||||
|
event: WebhookTriggerEvents.TEMPLATE_USED,
|
||||||
|
data: ZWebhookDocumentSchema.parse(mapEnvelopeToWebhookDocumentPayload(createdEnvelope)),
|
||||||
|
userId,
|
||||||
|
teamId,
|
||||||
|
});
|
||||||
|
|
||||||
return envelope;
|
return envelope;
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|||||||
@ -1,9 +1,14 @@
|
|||||||
import { EnvelopeType } from '@prisma/client';
|
import { EnvelopeType, WebhookTriggerEvents } from '@prisma/client';
|
||||||
|
|
||||||
import { prisma } from '@documenso/prisma';
|
import { prisma } from '@documenso/prisma';
|
||||||
|
|
||||||
|
import {
|
||||||
|
ZWebhookDocumentSchema,
|
||||||
|
mapEnvelopeToWebhookDocumentPayload,
|
||||||
|
} from '../../types/webhook-payload';
|
||||||
import { type EnvelopeIdOptions } from '../../utils/envelope';
|
import { type EnvelopeIdOptions } from '../../utils/envelope';
|
||||||
import { getEnvelopeWhereInput } from '../envelope/get-envelope-by-id';
|
import { getEnvelopeWhereInput } from '../envelope/get-envelope-by-id';
|
||||||
|
import { triggerWebhook } from '../webhooks/trigger/trigger-webhook';
|
||||||
|
|
||||||
export type DeleteTemplateOptions = {
|
export type DeleteTemplateOptions = {
|
||||||
id: EnvelopeIdOptions;
|
id: EnvelopeIdOptions;
|
||||||
@ -19,6 +24,18 @@ export const deleteTemplate = async ({ id, userId, teamId }: DeleteTemplateOptio
|
|||||||
teamId,
|
teamId,
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const templateToDelete = await prisma.envelope.findUniqueOrThrow({
|
||||||
|
where: envelopeWhereInput,
|
||||||
|
include: { documentMeta: true, recipients: true },
|
||||||
|
});
|
||||||
|
|
||||||
|
await triggerWebhook({
|
||||||
|
event: WebhookTriggerEvents.TEMPLATE_DELETED,
|
||||||
|
data: ZWebhookDocumentSchema.parse(mapEnvelopeToWebhookDocumentPayload(templateToDelete)),
|
||||||
|
userId,
|
||||||
|
teamId,
|
||||||
|
});
|
||||||
|
|
||||||
return await prisma.envelope.delete({
|
return await prisma.envelope.delete({
|
||||||
where: envelopeWhereInput,
|
where: envelopeWhereInput,
|
||||||
});
|
});
|
||||||
|
|||||||
@ -480,5 +480,198 @@ export const generateSampleWebhookPayload = (
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (event === WebhookTriggerEvents.DOCUMENT_VIEWED) {
|
||||||
|
return {
|
||||||
|
event,
|
||||||
|
payload: {
|
||||||
|
...basePayload,
|
||||||
|
status: DocumentStatus.PENDING,
|
||||||
|
recipients: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
readStatus: ReadStatus.OPENED,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
Recipient: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
readStatus: ReadStatus.OPENED,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
createdAt: now.toISOString(),
|
||||||
|
webhookEndpoint: webhookUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event === WebhookTriggerEvents.DOCUMENT_RECIPIENT_COMPLETED) {
|
||||||
|
return {
|
||||||
|
event,
|
||||||
|
payload: {
|
||||||
|
...basePayload,
|
||||||
|
status: DocumentStatus.PENDING,
|
||||||
|
recipients: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
readStatus: ReadStatus.OPENED,
|
||||||
|
signingStatus: SigningStatus.SIGNED,
|
||||||
|
signedAt: now,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
Recipient: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
readStatus: ReadStatus.OPENED,
|
||||||
|
signingStatus: SigningStatus.SIGNED,
|
||||||
|
signedAt: now,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
createdAt: now.toISOString(),
|
||||||
|
webhookEndpoint: webhookUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event === WebhookTriggerEvents.DOCUMENT_DOWNLOADED) {
|
||||||
|
return {
|
||||||
|
event,
|
||||||
|
payload: {
|
||||||
|
...basePayload,
|
||||||
|
status: DocumentStatus.COMPLETED,
|
||||||
|
completedAt: now,
|
||||||
|
recipients: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
readStatus: ReadStatus.OPENED,
|
||||||
|
signingStatus: SigningStatus.SIGNED,
|
||||||
|
signedAt: now,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
Recipient: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
readStatus: ReadStatus.OPENED,
|
||||||
|
signingStatus: SigningStatus.SIGNED,
|
||||||
|
signedAt: now,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
createdAt: now.toISOString(),
|
||||||
|
webhookEndpoint: webhookUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event === WebhookTriggerEvents.DOCUMENT_REMINDER_SENT) {
|
||||||
|
return {
|
||||||
|
event,
|
||||||
|
payload: {
|
||||||
|
...basePayload,
|
||||||
|
status: DocumentStatus.PENDING,
|
||||||
|
recipients: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
sendStatus: SendStatus.SENT,
|
||||||
|
signingStatus: SigningStatus.NOT_SIGNED,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
Recipient: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
sendStatus: SendStatus.SENT,
|
||||||
|
signingStatus: SigningStatus.NOT_SIGNED,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
createdAt: now.toISOString(),
|
||||||
|
webhookEndpoint: webhookUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event === WebhookTriggerEvents.RECIPIENT_AUTHENTICATION_FAILED) {
|
||||||
|
return {
|
||||||
|
event,
|
||||||
|
payload: {
|
||||||
|
...basePayload,
|
||||||
|
status: DocumentStatus.PENDING,
|
||||||
|
recipients: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
readStatus: ReadStatus.NOT_OPENED,
|
||||||
|
signingStatus: SigningStatus.NOT_SIGNED,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
Recipient: [
|
||||||
|
{
|
||||||
|
...basePayload.recipients[0],
|
||||||
|
readStatus: ReadStatus.NOT_OPENED,
|
||||||
|
signingStatus: SigningStatus.NOT_SIGNED,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
createdAt: now.toISOString(),
|
||||||
|
webhookEndpoint: webhookUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event === WebhookTriggerEvents.TEMPLATE_CREATED) {
|
||||||
|
return {
|
||||||
|
event,
|
||||||
|
payload: {
|
||||||
|
...basePayload,
|
||||||
|
title: 'My Template',
|
||||||
|
status: DocumentStatus.DRAFT,
|
||||||
|
templateId: 10,
|
||||||
|
source: DocumentSource.TEMPLATE,
|
||||||
|
},
|
||||||
|
createdAt: now.toISOString(),
|
||||||
|
webhookEndpoint: webhookUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event === WebhookTriggerEvents.TEMPLATE_UPDATED) {
|
||||||
|
return {
|
||||||
|
event,
|
||||||
|
payload: {
|
||||||
|
...basePayload,
|
||||||
|
title: 'My Updated Template',
|
||||||
|
status: DocumentStatus.DRAFT,
|
||||||
|
templateId: 10,
|
||||||
|
source: DocumentSource.TEMPLATE,
|
||||||
|
},
|
||||||
|
createdAt: now.toISOString(),
|
||||||
|
webhookEndpoint: webhookUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event === WebhookTriggerEvents.TEMPLATE_DELETED) {
|
||||||
|
return {
|
||||||
|
event,
|
||||||
|
payload: {
|
||||||
|
...basePayload,
|
||||||
|
title: 'Deleted Template',
|
||||||
|
status: DocumentStatus.DRAFT,
|
||||||
|
templateId: 10,
|
||||||
|
source: DocumentSource.TEMPLATE,
|
||||||
|
},
|
||||||
|
createdAt: now.toISOString(),
|
||||||
|
webhookEndpoint: webhookUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event === WebhookTriggerEvents.TEMPLATE_USED) {
|
||||||
|
return {
|
||||||
|
event,
|
||||||
|
payload: {
|
||||||
|
...basePayload,
|
||||||
|
title: 'Document from Template',
|
||||||
|
status: DocumentStatus.DRAFT,
|
||||||
|
templateId: 10,
|
||||||
|
source: DocumentSource.TEMPLATE,
|
||||||
|
},
|
||||||
|
createdAt: now.toISOString(),
|
||||||
|
webhookEndpoint: webhookUrl,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
throw new Error(`Unsupported event type: ${event}`);
|
throw new Error(`Unsupported event type: ${event}`);
|
||||||
};
|
};
|
||||||
|
|||||||
@ -0,0 +1,17 @@
|
|||||||
|
-- AlterEnum
|
||||||
|
-- This migration adds more than one value to an enum.
|
||||||
|
-- With PostgreSQL versions 11 and earlier, this is not possible
|
||||||
|
-- in a single migration. This can be worked around by creating
|
||||||
|
-- multiple migrations, each migration adding only one value to
|
||||||
|
-- the enum.
|
||||||
|
|
||||||
|
|
||||||
|
ALTER TYPE "WebhookTriggerEvents" ADD VALUE 'DOCUMENT_VIEWED';
|
||||||
|
ALTER TYPE "WebhookTriggerEvents" ADD VALUE 'DOCUMENT_RECIPIENT_COMPLETED';
|
||||||
|
ALTER TYPE "WebhookTriggerEvents" ADD VALUE 'DOCUMENT_DOWNLOADED';
|
||||||
|
ALTER TYPE "WebhookTriggerEvents" ADD VALUE 'DOCUMENT_REMINDER_SENT';
|
||||||
|
ALTER TYPE "WebhookTriggerEvents" ADD VALUE 'TEMPLATE_CREATED';
|
||||||
|
ALTER TYPE "WebhookTriggerEvents" ADD VALUE 'TEMPLATE_UPDATED';
|
||||||
|
ALTER TYPE "WebhookTriggerEvents" ADD VALUE 'TEMPLATE_DELETED';
|
||||||
|
ALTER TYPE "WebhookTriggerEvents" ADD VALUE 'TEMPLATE_USED';
|
||||||
|
ALTER TYPE "WebhookTriggerEvents" ADD VALUE 'RECIPIENT_AUTHENTICATION_FAILED';
|
||||||
@ -172,6 +172,15 @@ enum WebhookTriggerEvents {
|
|||||||
DOCUMENT_COMPLETED
|
DOCUMENT_COMPLETED
|
||||||
DOCUMENT_REJECTED
|
DOCUMENT_REJECTED
|
||||||
DOCUMENT_CANCELLED
|
DOCUMENT_CANCELLED
|
||||||
|
DOCUMENT_VIEWED
|
||||||
|
DOCUMENT_RECIPIENT_COMPLETED
|
||||||
|
DOCUMENT_DOWNLOADED
|
||||||
|
DOCUMENT_REMINDER_SENT
|
||||||
|
TEMPLATE_CREATED
|
||||||
|
TEMPLATE_UPDATED
|
||||||
|
TEMPLATE_DELETED
|
||||||
|
TEMPLATE_USED
|
||||||
|
RECIPIENT_AUTHENTICATION_FAILED
|
||||||
}
|
}
|
||||||
|
|
||||||
model Webhook {
|
model Webhook {
|
||||||
|
|||||||
@ -28,6 +28,7 @@ type SeedTemplateOptions = {
|
|||||||
title?: string;
|
title?: string;
|
||||||
userId: number;
|
userId: number;
|
||||||
teamId: number;
|
teamId: number;
|
||||||
|
internalVersion?: 1 | 2;
|
||||||
createTemplateOptions?: Partial<Prisma.EnvelopeUncheckedCreateInput>;
|
createTemplateOptions?: Partial<Prisma.EnvelopeUncheckedCreateInput>;
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -167,7 +168,7 @@ export const seedDirectTemplate = async (options: SeedTemplateOptions) => {
|
|||||||
data: {
|
data: {
|
||||||
id: prefixedId('envelope'),
|
id: prefixedId('envelope'),
|
||||||
secondaryId: templateId.formattedTemplateId,
|
secondaryId: templateId.formattedTemplateId,
|
||||||
internalVersion: 1,
|
internalVersion: options.internalVersion ?? 1,
|
||||||
type: EnvelopeType.TEMPLATE,
|
type: EnvelopeType.TEMPLATE,
|
||||||
title,
|
title,
|
||||||
envelopeItems: {
|
envelopeItems: {
|
||||||
@ -184,6 +185,7 @@ export const seedDirectTemplate = async (options: SeedTemplateOptions) => {
|
|||||||
teamId,
|
teamId,
|
||||||
recipients: {
|
recipients: {
|
||||||
create: {
|
create: {
|
||||||
|
signingOrder: 1,
|
||||||
email: DIRECT_TEMPLATE_RECIPIENT_EMAIL,
|
email: DIRECT_TEMPLATE_RECIPIENT_EMAIL,
|
||||||
name: DIRECT_TEMPLATE_RECIPIENT_NAME,
|
name: DIRECT_TEMPLATE_RECIPIENT_NAME,
|
||||||
token: Math.random().toString().slice(2, 7),
|
token: Math.random().toString().slice(2, 7),
|
||||||
|
|||||||
@ -39,6 +39,11 @@ export const getAdminOrganisation = async ({ organisationId }: GetOrganisationOp
|
|||||||
teams: true,
|
teams: true,
|
||||||
members: {
|
members: {
|
||||||
include: {
|
include: {
|
||||||
|
organisationGroupMembers: {
|
||||||
|
include: {
|
||||||
|
group: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
user: {
|
user: {
|
||||||
select: {
|
select: {
|
||||||
id: true,
|
id: true,
|
||||||
|
|||||||
@ -3,6 +3,8 @@ import { z } from 'zod';
|
|||||||
import { ZOrganisationSchema } from '@documenso/lib/types/organisation';
|
import { ZOrganisationSchema } from '@documenso/lib/types/organisation';
|
||||||
import OrganisationClaimSchema from '@documenso/prisma/generated/zod/modelSchema/OrganisationClaimSchema';
|
import OrganisationClaimSchema from '@documenso/prisma/generated/zod/modelSchema/OrganisationClaimSchema';
|
||||||
import OrganisationGlobalSettingsSchema from '@documenso/prisma/generated/zod/modelSchema/OrganisationGlobalSettingsSchema';
|
import OrganisationGlobalSettingsSchema from '@documenso/prisma/generated/zod/modelSchema/OrganisationGlobalSettingsSchema';
|
||||||
|
import OrganisationGroupMemberSchema from '@documenso/prisma/generated/zod/modelSchema/OrganisationGroupMemberSchema';
|
||||||
|
import OrganisationGroupSchema from '@documenso/prisma/generated/zod/modelSchema/OrganisationGroupSchema';
|
||||||
import OrganisationMemberSchema from '@documenso/prisma/generated/zod/modelSchema/OrganisationMemberSchema';
|
import OrganisationMemberSchema from '@documenso/prisma/generated/zod/modelSchema/OrganisationMemberSchema';
|
||||||
import SubscriptionSchema from '@documenso/prisma/generated/zod/modelSchema/SubscriptionSchema';
|
import SubscriptionSchema from '@documenso/prisma/generated/zod/modelSchema/SubscriptionSchema';
|
||||||
import TeamSchema from '@documenso/prisma/generated/zod/modelSchema/TeamSchema';
|
import TeamSchema from '@documenso/prisma/generated/zod/modelSchema/TeamSchema';
|
||||||
@ -30,6 +32,18 @@ export const ZGetAdminOrganisationResponseSchema = ZOrganisationSchema.extend({
|
|||||||
email: true,
|
email: true,
|
||||||
name: true,
|
name: true,
|
||||||
}),
|
}),
|
||||||
|
organisationGroupMembers: z.array(
|
||||||
|
OrganisationGroupMemberSchema.pick({
|
||||||
|
id: true,
|
||||||
|
groupId: true,
|
||||||
|
}).extend({
|
||||||
|
group: OrganisationGroupSchema.pick({
|
||||||
|
id: true,
|
||||||
|
type: true,
|
||||||
|
organisationRole: true,
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
),
|
||||||
}).array(),
|
}).array(),
|
||||||
subscription: SubscriptionSchema.nullable(),
|
subscription: SubscriptionSchema.nullable(),
|
||||||
organisationClaim: OrganisationClaimSchema,
|
organisationClaim: OrganisationClaimSchema,
|
||||||
|
|||||||
@ -17,6 +17,7 @@ import { promoteMemberToOwnerRoute } from './promote-member-to-owner';
|
|||||||
import { resealDocumentRoute } from './reseal-document';
|
import { resealDocumentRoute } from './reseal-document';
|
||||||
import { resetTwoFactorRoute } from './reset-two-factor-authentication';
|
import { resetTwoFactorRoute } from './reset-two-factor-authentication';
|
||||||
import { updateAdminOrganisationRoute } from './update-admin-organisation';
|
import { updateAdminOrganisationRoute } from './update-admin-organisation';
|
||||||
|
import { updateOrganisationMemberRoleRoute } from './update-organisation-member-role';
|
||||||
import { updateRecipientRoute } from './update-recipient';
|
import { updateRecipientRoute } from './update-recipient';
|
||||||
import { updateSiteSettingRoute } from './update-site-setting';
|
import { updateSiteSettingRoute } from './update-site-setting';
|
||||||
import { updateSubscriptionClaimRoute } from './update-subscription-claim';
|
import { updateSubscriptionClaimRoute } from './update-subscription-claim';
|
||||||
@ -31,6 +32,7 @@ export const adminRouter = router({
|
|||||||
},
|
},
|
||||||
organisationMember: {
|
organisationMember: {
|
||||||
promoteToOwner: promoteMemberToOwnerRoute,
|
promoteToOwner: promoteMemberToOwnerRoute,
|
||||||
|
updateRole: updateOrganisationMemberRoleRoute,
|
||||||
},
|
},
|
||||||
claims: {
|
claims: {
|
||||||
find: findSubscriptionClaimsRoute,
|
find: findSubscriptionClaimsRoute,
|
||||||
|
|||||||
@ -0,0 +1,220 @@
|
|||||||
|
import { OrganisationGroupType, OrganisationMemberRole } from '@prisma/client';
|
||||||
|
|
||||||
|
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
||||||
|
import { generateDatabaseId } from '@documenso/lib/universal/id';
|
||||||
|
import { getHighestOrganisationRoleInGroup } from '@documenso/lib/utils/organisations';
|
||||||
|
import { prisma } from '@documenso/prisma';
|
||||||
|
|
||||||
|
import { adminProcedure } from '../trpc';
|
||||||
|
import {
|
||||||
|
ZUpdateOrganisationMemberRoleRequestSchema,
|
||||||
|
ZUpdateOrganisationMemberRoleResponseSchema,
|
||||||
|
} from './update-organisation-member-role.types';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Admin mutation to update organisation member role or transfer ownership.
|
||||||
|
*
|
||||||
|
* This mutation handles two scenarios:
|
||||||
|
* 1. When role='OWNER': Transfers organisation ownership and promotes to ADMIN
|
||||||
|
* 2. When role=ADMIN/MANAGER/MEMBER: Updates group membership
|
||||||
|
*
|
||||||
|
* Admin privileges bypass normal hierarchy restrictions.
|
||||||
|
*/
|
||||||
|
export const updateOrganisationMemberRoleRoute = adminProcedure
|
||||||
|
.input(ZUpdateOrganisationMemberRoleRequestSchema)
|
||||||
|
.output(ZUpdateOrganisationMemberRoleResponseSchema)
|
||||||
|
.mutation(async ({ input, ctx }) => {
|
||||||
|
const { organisationId, userId, role } = input;
|
||||||
|
|
||||||
|
ctx.logger.info({
|
||||||
|
input: {
|
||||||
|
organisationId,
|
||||||
|
userId,
|
||||||
|
role,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const organisation = await prisma.organisation.findUnique({
|
||||||
|
where: {
|
||||||
|
id: organisationId,
|
||||||
|
},
|
||||||
|
include: {
|
||||||
|
groups: {
|
||||||
|
where: {
|
||||||
|
type: OrganisationGroupType.INTERNAL_ORGANISATION,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
members: {
|
||||||
|
where: {
|
||||||
|
userId,
|
||||||
|
},
|
||||||
|
include: {
|
||||||
|
organisationGroupMembers: {
|
||||||
|
include: {
|
||||||
|
group: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!organisation) {
|
||||||
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
||||||
|
message: 'Organisation not found',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const [member] = organisation.members;
|
||||||
|
|
||||||
|
if (!member) {
|
||||||
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
||||||
|
message: 'User is not a member of this organisation',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const currentOrganisationRole = getHighestOrganisationRoleInGroup(
|
||||||
|
member.organisationGroupMembers.flatMap((member) => member.group),
|
||||||
|
);
|
||||||
|
|
||||||
|
if (role === 'OWNER') {
|
||||||
|
if (organisation.ownerUserId === userId) {
|
||||||
|
throw new AppError(AppErrorCode.INVALID_REQUEST, {
|
||||||
|
message: 'User is already the owner of this organisation',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const currentMemberGroup = organisation.groups.find(
|
||||||
|
(group) => group.organisationRole === currentOrganisationRole,
|
||||||
|
);
|
||||||
|
|
||||||
|
const adminGroup = organisation.groups.find(
|
||||||
|
(group) => group.organisationRole === OrganisationMemberRole.ADMIN,
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!currentMemberGroup) {
|
||||||
|
ctx.logger.error({
|
||||||
|
message: '[CRITICAL]: Missing internal group',
|
||||||
|
organisationId,
|
||||||
|
userId,
|
||||||
|
role: currentOrganisationRole,
|
||||||
|
});
|
||||||
|
|
||||||
|
throw new AppError(AppErrorCode.UNKNOWN_ERROR, {
|
||||||
|
message: 'Current member group not found',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!adminGroup) {
|
||||||
|
ctx.logger.error({
|
||||||
|
message: '[CRITICAL]: Missing internal group',
|
||||||
|
organisationId,
|
||||||
|
userId,
|
||||||
|
targetRole: 'ADMIN',
|
||||||
|
});
|
||||||
|
|
||||||
|
throw new AppError(AppErrorCode.UNKNOWN_ERROR, {
|
||||||
|
message: 'Admin group not found',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
await prisma.$transaction(async (tx) => {
|
||||||
|
await tx.organisation.update({
|
||||||
|
where: {
|
||||||
|
id: organisationId,
|
||||||
|
},
|
||||||
|
data: {
|
||||||
|
ownerUserId: userId,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
if (currentOrganisationRole !== OrganisationMemberRole.ADMIN) {
|
||||||
|
await tx.organisationGroupMember.delete({
|
||||||
|
where: {
|
||||||
|
organisationMemberId_groupId: {
|
||||||
|
organisationMemberId: member.id,
|
||||||
|
groupId: currentMemberGroup.id,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await tx.organisationGroupMember.create({
|
||||||
|
data: {
|
||||||
|
id: generateDatabaseId('group_member'),
|
||||||
|
organisationMemberId: member.id,
|
||||||
|
groupId: adminGroup.id,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const targetRole = role as OrganisationMemberRole;
|
||||||
|
|
||||||
|
if (currentOrganisationRole === targetRole) {
|
||||||
|
throw new AppError(AppErrorCode.INVALID_REQUEST, {
|
||||||
|
message: 'User already has this role',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (userId === organisation.ownerUserId && targetRole !== OrganisationMemberRole.ADMIN) {
|
||||||
|
throw new AppError(AppErrorCode.INVALID_REQUEST, {
|
||||||
|
message: 'Organisation owner must be an admin. Transfer ownership first.',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const currentMemberGroup = organisation.groups.find(
|
||||||
|
(group) => group.organisationRole === currentOrganisationRole,
|
||||||
|
);
|
||||||
|
|
||||||
|
const newMemberGroup = organisation.groups.find(
|
||||||
|
(group) => group.organisationRole === targetRole,
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!currentMemberGroup) {
|
||||||
|
ctx.logger.error({
|
||||||
|
message: '[CRITICAL]: Missing internal group',
|
||||||
|
organisationId,
|
||||||
|
userId,
|
||||||
|
role: currentOrganisationRole,
|
||||||
|
});
|
||||||
|
|
||||||
|
throw new AppError(AppErrorCode.UNKNOWN_ERROR, {
|
||||||
|
message: 'Current member group not found',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!newMemberGroup) {
|
||||||
|
ctx.logger.error({
|
||||||
|
message: '[CRITICAL]: Missing internal group',
|
||||||
|
organisationId,
|
||||||
|
userId,
|
||||||
|
targetRole,
|
||||||
|
});
|
||||||
|
|
||||||
|
throw new AppError(AppErrorCode.UNKNOWN_ERROR, {
|
||||||
|
message: 'New member group not found',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
await prisma.$transaction(async (tx) => {
|
||||||
|
await tx.organisationGroupMember.delete({
|
||||||
|
where: {
|
||||||
|
organisationMemberId_groupId: {
|
||||||
|
organisationMemberId: member.id,
|
||||||
|
groupId: currentMemberGroup.id,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await tx.organisationGroupMember.create({
|
||||||
|
data: {
|
||||||
|
id: generateDatabaseId('group_member'),
|
||||||
|
organisationMemberId: member.id,
|
||||||
|
groupId: newMemberGroup.id,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@ -0,0 +1,30 @@
|
|||||||
|
import { OrganisationMemberRole } from '@prisma/client';
|
||||||
|
import { z } from 'zod';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Admin-only role selection that includes OWNER as a special case.
|
||||||
|
* OWNER is not a database role but triggers ownership transfer.
|
||||||
|
*/
|
||||||
|
export const ZAdminRoleSelection = z.enum([
|
||||||
|
'OWNER',
|
||||||
|
OrganisationMemberRole.ADMIN,
|
||||||
|
OrganisationMemberRole.MANAGER,
|
||||||
|
OrganisationMemberRole.MEMBER,
|
||||||
|
]);
|
||||||
|
|
||||||
|
export type TAdminRoleSelection = z.infer<typeof ZAdminRoleSelection>;
|
||||||
|
|
||||||
|
export const ZUpdateOrganisationMemberRoleRequestSchema = z.object({
|
||||||
|
organisationId: z.string().min(1),
|
||||||
|
userId: z.number().min(1),
|
||||||
|
role: ZAdminRoleSelection,
|
||||||
|
});
|
||||||
|
|
||||||
|
export const ZUpdateOrganisationMemberRoleResponseSchema = z.void();
|
||||||
|
|
||||||
|
export type TUpdateOrganisationMemberRoleRequest = z.infer<
|
||||||
|
typeof ZUpdateOrganisationMemberRoleRequestSchema
|
||||||
|
>;
|
||||||
|
export type TUpdateOrganisationMemberRoleResponse = z.infer<
|
||||||
|
typeof ZUpdateOrganisationMemberRoleResponseSchema
|
||||||
|
>;
|
||||||
@ -1,8 +1,13 @@
|
|||||||
import type { DocumentData } from '@prisma/client';
|
import type { DocumentData } from '@prisma/client';
|
||||||
import { DocumentDataType, EnvelopeType } from '@prisma/client';
|
import { DocumentDataType, EnvelopeType, WebhookTriggerEvents } from '@prisma/client';
|
||||||
|
|
||||||
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
||||||
import { getEnvelopeById } from '@documenso/lib/server-only/envelope/get-envelope-by-id';
|
import { getEnvelopeById } from '@documenso/lib/server-only/envelope/get-envelope-by-id';
|
||||||
|
import { triggerWebhook } from '@documenso/lib/server-only/webhooks/trigger/trigger-webhook';
|
||||||
|
import {
|
||||||
|
ZWebhookDocumentSchema,
|
||||||
|
mapEnvelopeToWebhookDocumentPayload,
|
||||||
|
} from '@documenso/lib/types/webhook-payload';
|
||||||
import { getPresignGetUrl } from '@documenso/lib/universal/upload/server-actions';
|
import { getPresignGetUrl } from '@documenso/lib/universal/upload/server-actions';
|
||||||
import { isDocumentCompleted } from '@documenso/lib/utils/document';
|
import { isDocumentCompleted } from '@documenso/lib/utils/document';
|
||||||
|
|
||||||
@ -76,6 +81,13 @@ export const downloadDocumentRoute = authenticatedProcedure
|
|||||||
const suffix = version === 'signed' ? '_signed.pdf' : '.pdf';
|
const suffix = version === 'signed' ? '_signed.pdf' : '.pdf';
|
||||||
const filename = `${baseTitle}${suffix}`;
|
const filename = `${baseTitle}${suffix}`;
|
||||||
|
|
||||||
|
void triggerWebhook({
|
||||||
|
event: WebhookTriggerEvents.DOCUMENT_DOWNLOADED,
|
||||||
|
data: ZWebhookDocumentSchema.parse(mapEnvelopeToWebhookDocumentPayload(envelope)),
|
||||||
|
userId: envelope.userId,
|
||||||
|
teamId: envelope.teamId,
|
||||||
|
});
|
||||||
|
|
||||||
return {
|
return {
|
||||||
downloadUrl: url,
|
downloadUrl: url,
|
||||||
filename,
|
filename,
|
||||||
|
|||||||
@ -519,6 +519,7 @@ export const templateRouter = router({
|
|||||||
directTemplateExternalId,
|
directTemplateExternalId,
|
||||||
signedFieldValues,
|
signedFieldValues,
|
||||||
templateUpdatedAt,
|
templateUpdatedAt,
|
||||||
|
nextSigner,
|
||||||
} = input;
|
} = input;
|
||||||
|
|
||||||
ctx.logger.info({
|
ctx.logger.info({
|
||||||
@ -541,6 +542,7 @@ export const templateRouter = router({
|
|||||||
email: ctx.user.email,
|
email: ctx.user.email,
|
||||||
}
|
}
|
||||||
: undefined,
|
: undefined,
|
||||||
|
nextSigner,
|
||||||
requestMetadata: ctx.metadata,
|
requestMetadata: ctx.metadata,
|
||||||
});
|
});
|
||||||
}),
|
}),
|
||||||
|
|||||||
@ -90,6 +90,12 @@ export const ZCreateDocumentFromDirectTemplateRequestSchema = z.object({
|
|||||||
directTemplateExternalId: z.string().optional(),
|
directTemplateExternalId: z.string().optional(),
|
||||||
signedFieldValues: z.array(ZSignFieldWithTokenMutationSchema),
|
signedFieldValues: z.array(ZSignFieldWithTokenMutationSchema),
|
||||||
templateUpdatedAt: z.date(),
|
templateUpdatedAt: z.date(),
|
||||||
|
nextSigner: z
|
||||||
|
.object({
|
||||||
|
email: z.string().email().max(254),
|
||||||
|
name: z.string().min(1).max(255),
|
||||||
|
})
|
||||||
|
.optional(),
|
||||||
});
|
});
|
||||||
|
|
||||||
export const ZCreateDocumentFromTemplateRequestSchema = z.object({
|
export const ZCreateDocumentFromTemplateRequestSchema = z.object({
|
||||||
|
|||||||
Reference in New Issue
Block a user