mirror of
https://github.com/documenso/documenso.git
synced 2025-11-13 00:03:33 +10:00
Compare commits
10 Commits
9350c53c7d
...
feat/unlin
| Author | SHA1 | Date | |
|---|---|---|---|
| bf6f09194d | |||
| 0bbd9aa9a1 | |||
| 5e8c3d5d92 | |||
| c97c2551db | |||
| 1863d990c8 | |||
| 38483bb88c | |||
| 9cbbdfb127 | |||
| fb6e2753df | |||
| a89c781b31 | |||
| 8b131e42c7 |
692
CODE_STYLE.md
692
CODE_STYLE.md
@ -1,692 +0,0 @@
|
|||||||
# 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
|
|
||||||
@ -1,218 +0,0 @@
|
|||||||
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>
|
|
||||||
);
|
|
||||||
};
|
|
||||||
@ -34,7 +34,6 @@ 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';
|
||||||
|
|
||||||
@ -72,6 +71,23 @@ 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 [
|
||||||
{
|
{
|
||||||
@ -104,24 +120,23 @@ export default function OrganisationGroupSettingsPage({ params }: Route.Componen
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
header: t`Actions`,
|
header: t`Actions`,
|
||||||
cell: ({ row }) => {
|
cell: ({ row }) => (
|
||||||
const isOwner = row.original.userId === organisation?.ownerUserId;
|
<div className="flex justify-end space-x-2">
|
||||||
|
<Button
|
||||||
return (
|
variant="outline"
|
||||||
<div className="flex justify-end space-x-2">
|
disabled={row.original.userId === organisation?.ownerUserId}
|
||||||
<AdminOrganisationMemberUpdateDialog
|
loading={isPromotingToOwner}
|
||||||
trigger={
|
onClick={async () =>
|
||||||
<Button variant="outline">
|
promoteToOwner({
|
||||||
<Trans>Update role</Trans>
|
organisationId,
|
||||||
</Button>
|
userId: row.original.userId,
|
||||||
}
|
})
|
||||||
organisationId={organisationId}
|
}
|
||||||
organisationMember={row.original}
|
>
|
||||||
isOwner={isOwner}
|
<Trans>Promote to owner</Trans>
|
||||||
/>
|
</Button>
|
||||||
</div>
|
</div>
|
||||||
);
|
),
|
||||||
},
|
|
||||||
},
|
},
|
||||||
] satisfies DataTableColumnDef<TGetAdminOrganisationResponse['members'][number]>[];
|
] satisfies DataTableColumnDef<TGetAdminOrganisationResponse['members'][number]>[];
|
||||||
}, [organisation]);
|
}, [organisation]);
|
||||||
|
|||||||
@ -68,29 +68,15 @@ 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 "Update role" button for the member
|
// Find and click the "Promote to owner" button for the member
|
||||||
const updateRoleButton = memberRow.getByRole('button', {
|
const promoteButton = memberRow.getByRole('button', { name: 'Promote to owner' });
|
||||||
name: 'Update role',
|
await expect(promoteButton).toBeVisible();
|
||||||
});
|
await expect(promoteButton).not.toBeDisabled();
|
||||||
await expect(updateRoleButton).toBeVisible();
|
|
||||||
await expect(updateRoleButton).not.toBeDisabled();
|
|
||||||
|
|
||||||
await updateRoleButton.click();
|
await promoteButton.click();
|
||||||
|
|
||||||
// Wait for dialog to open and select Owner role
|
// Verify success toast appears
|
||||||
await expect(page.getByRole('dialog')).toBeVisible();
|
await expect(page.getByText('Member promoted to owner successfully').first()).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();
|
||||||
@ -103,18 +89,12 @@ 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 Update role button exists for the new owner and shows Owner as current role
|
// Verify that the promote button is now disabled for the new owner
|
||||||
const newOwnerUpdateButton = newOwnerRow.getByRole('button', {
|
const newOwnerPromoteButton = newOwnerRow.getByRole('button', { name: 'Promote to owner' });
|
||||||
name: 'Update role',
|
await expect(newOwnerPromoteButton).toBeDisabled();
|
||||||
});
|
|
||||||
await expect(newOwnerUpdateButton).toBeVisible();
|
|
||||||
|
|
||||||
// Verify clicking it shows the dialog with Owner already selected
|
// Test that we can't promote the current owner (button should be disabled)
|
||||||
await newOwnerUpdateButton.click();
|
await expect(newOwnerPromoteButton).toHaveAttribute('disabled');
|
||||||
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 }) => {
|
||||||
@ -150,26 +130,10 @@ 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 updateRoleButton = managerRow.getByRole('button', {
|
const promoteButton = managerRow.getByRole('button', { name: 'Promote to owner' });
|
||||||
name: 'Update role',
|
|
||||||
});
|
|
||||||
|
|
||||||
await updateRoleButton.click();
|
await promoteButton.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();
|
||||||
@ -209,27 +173,14 @@ 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 updateRoleButton = adminMemberRow.getByRole('button', {
|
const promoteButton = adminMemberRow.getByRole('button', { name: 'Promote to owner' });
|
||||||
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();
|
||||||
@ -298,25 +249,11 @@ 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 updateRoleButton = memberRow.getByRole('button', {
|
const promoteButton = memberRow.getByRole('button', { name: 'Promote to owner' });
|
||||||
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 page to see updated state
|
// Reload page to see updated state
|
||||||
await page.reload();
|
await page.reload();
|
||||||
@ -325,11 +262,9 @@ 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 Update role button exists and shows Owner as current role
|
// Verify the promote button is now disabled for the new owner
|
||||||
const newOwnerUpdateButton = memberRow.getByRole('button', {
|
const newOwnerPromoteButton = memberRow.getByRole('button', { name: 'Promote to owner' });
|
||||||
name: 'Update role',
|
await expect(newOwnerPromoteButton).toBeDisabled();
|
||||||
});
|
|
||||||
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({
|
||||||
@ -401,56 +336,28 @@ 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 updateRoleButton1 = member1Row.getByRole('button', {
|
let promoteButton1 = member1Row.getByRole('button', { name: 'Promote to owner' });
|
||||||
name: 'Update role',
|
await promoteButton1.click();
|
||||||
|
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
|
// Verify Member 1 is now owner and button is disabled
|
||||||
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();
|
||||||
updateRoleButton1 = member1Row.getByRole('button', { name: 'Update role' });
|
promoteButton1 = member1Row.getByRole('button', { name: 'Promote to owner' });
|
||||||
await expect(updateRoleButton1).toBeVisible();
|
await expect(promoteButton1).toBeDisabled();
|
||||||
|
|
||||||
// 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 updateRoleButton2 = member2Row.getByRole('button', {
|
const promoteButton2 = member2Row.getByRole('button', { name: 'Promote to owner' });
|
||||||
name: 'Update role',
|
await expect(promoteButton2).not.toBeDisabled();
|
||||||
|
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();
|
||||||
|
|
||||||
@ -458,11 +365,9 @@ 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 Update role button is still visible
|
// Verify Member 1's promote button is now enabled again
|
||||||
const newUpdateButton1 = member1Row.getByRole('button', {
|
const newPromoteButton1 = member1Row.getByRole('button', { name: 'Promote to owner' });
|
||||||
name: 'Update role',
|
await expect(newPromoteButton1).not.toBeDisabled();
|
||||||
});
|
|
||||||
await expect(newUpdateButton1).toBeVisible();
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test('[ADMIN]: verify organisation access after ownership change', async ({ page }) => {
|
test('[ADMIN]: verify organisation access after ownership change', async ({ page }) => {
|
||||||
@ -497,25 +402,11 @@ 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 updateRoleButton = memberRow.getByRole('button', {
|
const promoteButton = memberRow.getByRole('button', { name: 'Promote to owner' });
|
||||||
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 });
|
|
||||||
|
|
||||||
// Test that the new owner can access organisation settings
|
// Test that the new owner can access organisation settings
|
||||||
await apiSignin({
|
await apiSignin({
|
||||||
@ -1,5 +1,7 @@
|
|||||||
|
import { EnvelopeType, TeamMemberRole } from '@prisma/client';
|
||||||
import type { Prisma, User } from '@prisma/client';
|
import type { Prisma, User } from '@prisma/client';
|
||||||
import { DocumentVisibility, EnvelopeType, SigningStatus, TeamMemberRole } from '@prisma/client';
|
import { SigningStatus } 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';
|
||||||
|
|
||||||
@ -213,14 +215,13 @@ 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;
|
||||||
@ -264,16 +265,8 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
|
|
||||||
ownerCountsWhereInput = {
|
ownerCountsWhereInput = {
|
||||||
...ownerCountsWhereInput,
|
...ownerCountsWhereInput,
|
||||||
AND: [
|
...visibilityFiltersWhereInput,
|
||||||
...(Array.isArray(visibilityFiltersWhereInput.AND)
|
...searchFilter,
|
||||||
? visibilityFiltersWhereInput.AND
|
|
||||||
: visibilityFiltersWhereInput.AND
|
|
||||||
? [visibilityFiltersWhereInput.AND]
|
|
||||||
: []),
|
|
||||||
searchFilter,
|
|
||||||
rootPageFilter,
|
|
||||||
folderId ? { folderId } : {},
|
|
||||||
],
|
|
||||||
};
|
};
|
||||||
|
|
||||||
if (teamEmail) {
|
if (teamEmail) {
|
||||||
@ -292,7 +285,6 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
deletedAt: null,
|
deletedAt: null,
|
||||||
AND: [searchFilter, rootPageFilter, folderId ? { folderId } : {}],
|
|
||||||
};
|
};
|
||||||
|
|
||||||
notSignedCountsGroupByArgs = {
|
notSignedCountsGroupByArgs = {
|
||||||
@ -304,6 +296,7 @@ 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: {
|
||||||
@ -313,7 +306,6 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
deletedAt: null,
|
deletedAt: null,
|
||||||
AND: [searchFilter, rootPageFilter, folderId ? { folderId } : {}],
|
|
||||||
},
|
},
|
||||||
} satisfies Prisma.EnvelopeGroupByArgs;
|
} satisfies Prisma.EnvelopeGroupByArgs;
|
||||||
|
|
||||||
@ -326,6 +318,7 @@ 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,
|
||||||
@ -349,7 +342,6 @@ const getTeamCounts = async (options: GetTeamCountsOption) => {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
AND: [searchFilter, rootPageFilter, folderId ? { folderId } : {}],
|
|
||||||
},
|
},
|
||||||
} satisfies Prisma.EnvelopeGroupByArgs;
|
} satisfies Prisma.EnvelopeGroupByArgs;
|
||||||
}
|
}
|
||||||
|
|||||||
@ -0,0 +1,84 @@
|
|||||||
|
import { deletedAccountServiceAccount } from '@documenso/lib/server-only/user/service-accounts/deleted-account';
|
||||||
|
import { prisma } from '@documenso/prisma';
|
||||||
|
import { DocumentStatus } from '@documenso/prisma/client';
|
||||||
|
|
||||||
|
type HandleDocumentOwnershipOnDeletionOptions = {
|
||||||
|
documentIds: number[];
|
||||||
|
organisationOwnerId: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const handleDocumentOwnershipOnDeletion = async ({
|
||||||
|
documentIds,
|
||||||
|
organisationOwnerId,
|
||||||
|
}: HandleDocumentOwnershipOnDeletionOptions) => {
|
||||||
|
if (documentIds.length === 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const serviceAccount = await deletedAccountServiceAccount();
|
||||||
|
const serviceAccountTeam = serviceAccount.ownedOrganisations[0].teams[0];
|
||||||
|
|
||||||
|
await prisma.document.deleteMany({
|
||||||
|
where: {
|
||||||
|
id: {
|
||||||
|
in: documentIds,
|
||||||
|
},
|
||||||
|
status: DocumentStatus.DRAFT,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const organisationOwner = await prisma.user.findUnique({
|
||||||
|
where: {
|
||||||
|
id: organisationOwnerId,
|
||||||
|
},
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
ownedOrganisations: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
teams: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
if (organisationOwner && organisationOwner.ownedOrganisations.length > 0) {
|
||||||
|
const ownerPersonalTeam = organisationOwner.ownedOrganisations[0].teams[0];
|
||||||
|
|
||||||
|
await prisma.document.updateMany({
|
||||||
|
where: {
|
||||||
|
id: {
|
||||||
|
in: documentIds,
|
||||||
|
},
|
||||||
|
status: {
|
||||||
|
in: [DocumentStatus.PENDING, DocumentStatus.REJECTED, DocumentStatus.COMPLETED],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
data: {
|
||||||
|
userId: organisationOwner.id,
|
||||||
|
teamId: ownerPersonalTeam.id,
|
||||||
|
deletedAt: new Date(),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
await prisma.document.updateMany({
|
||||||
|
where: {
|
||||||
|
id: {
|
||||||
|
in: documentIds,
|
||||||
|
},
|
||||||
|
status: {
|
||||||
|
in: [DocumentStatus.PENDING, DocumentStatus.REJECTED, DocumentStatus.COMPLETED],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
data: {
|
||||||
|
userId: serviceAccount.id,
|
||||||
|
teamId: serviceAccountTeam.id,
|
||||||
|
deletedAt: new Date(),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
@ -5,6 +5,20 @@ export const deletedAccountServiceAccount = async () => {
|
|||||||
where: {
|
where: {
|
||||||
email: 'deleted-account@documenso.com',
|
email: 'deleted-account@documenso.com',
|
||||||
},
|
},
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
email: true,
|
||||||
|
ownedOrganisations: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
teams: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!serviceAccount) {
|
if (!serviceAccount) {
|
||||||
|
|||||||
@ -39,11 +39,6 @@ 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,8 +3,6 @@ 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';
|
||||||
@ -32,18 +30,6 @@ 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,7 +17,6 @@ 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';
|
||||||
@ -32,7 +31,6 @@ export const adminRouter = router({
|
|||||||
},
|
},
|
||||||
organisationMember: {
|
organisationMember: {
|
||||||
promoteToOwner: promoteMemberToOwnerRoute,
|
promoteToOwner: promoteMemberToOwnerRoute,
|
||||||
updateRole: updateOrganisationMemberRoleRoute,
|
|
||||||
},
|
},
|
||||||
claims: {
|
claims: {
|
||||||
find: findSubscriptionClaimsRoute,
|
find: findSubscriptionClaimsRoute,
|
||||||
|
|||||||
@ -1,220 +0,0 @@
|
|||||||
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,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@ -1,30 +0,0 @@
|
|||||||
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
|
|
||||||
>;
|
|
||||||
@ -3,6 +3,7 @@ import {
|
|||||||
ORGANISATION_USER_ACCOUNT_TYPE,
|
ORGANISATION_USER_ACCOUNT_TYPE,
|
||||||
} from '@documenso/lib/constants/organisations';
|
} from '@documenso/lib/constants/organisations';
|
||||||
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
||||||
|
import { handleDocumentOwnershipOnDeletion } from '@documenso/lib/server-only/document/handle-document-ownership-on-deletion';
|
||||||
import { buildOrganisationWhereQuery } from '@documenso/lib/utils/organisations';
|
import { buildOrganisationWhereQuery } from '@documenso/lib/utils/organisations';
|
||||||
import { prisma } from '@documenso/prisma';
|
import { prisma } from '@documenso/prisma';
|
||||||
|
|
||||||
@ -32,6 +33,24 @@ export const deleteOrganisationRoute = authenticatedProcedure
|
|||||||
userId: user.id,
|
userId: user.id,
|
||||||
roles: ORGANISATION_MEMBER_ROLE_PERMISSIONS_MAP['DELETE_ORGANISATION'],
|
roles: ORGANISATION_MEMBER_ROLE_PERMISSIONS_MAP['DELETE_ORGANISATION'],
|
||||||
}),
|
}),
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
owner: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
teams: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
documents: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!organisation) {
|
if (!organisation) {
|
||||||
@ -40,6 +59,15 @@ export const deleteOrganisationRoute = authenticatedProcedure
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const documentIds = organisation.teams.flatMap((team) => team.documents.map((doc) => doc.id));
|
||||||
|
|
||||||
|
if (documentIds && documentIds.length > 0) {
|
||||||
|
await handleDocumentOwnershipOnDeletion({
|
||||||
|
documentIds,
|
||||||
|
organisationOwnerId: organisation.owner.id,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
await prisma.$transaction(async (tx) => {
|
await prisma.$transaction(async (tx) => {
|
||||||
await tx.account.deleteMany({
|
await tx.account.deleteMany({
|
||||||
where: {
|
where: {
|
||||||
|
|||||||
@ -1,4 +1,8 @@
|
|||||||
|
import { ORGANISATION_MEMBER_ROLE_PERMISSIONS_MAP } from '@documenso/lib/constants/organisations';
|
||||||
|
import { handleDocumentOwnershipOnDeletion } from '@documenso/lib/server-only/document/handle-document-ownership-on-deletion';
|
||||||
import { deleteTeam } from '@documenso/lib/server-only/team/delete-team';
|
import { deleteTeam } from '@documenso/lib/server-only/team/delete-team';
|
||||||
|
import { buildOrganisationWhereQuery } from '@documenso/lib/utils/organisations';
|
||||||
|
import { prisma } from '@documenso/prisma';
|
||||||
|
|
||||||
import { authenticatedProcedure } from '../trpc';
|
import { authenticatedProcedure } from '../trpc';
|
||||||
import { ZDeleteTeamRequestSchema, ZDeleteTeamResponseSchema } from './delete-team.types';
|
import { ZDeleteTeamRequestSchema, ZDeleteTeamResponseSchema } from './delete-team.types';
|
||||||
@ -11,12 +15,53 @@ export const deleteTeamRoute = authenticatedProcedure
|
|||||||
const { teamId } = input;
|
const { teamId } = input;
|
||||||
const { user } = ctx;
|
const { user } = ctx;
|
||||||
|
|
||||||
|
const team = await prisma.team.findUnique({
|
||||||
|
where: {
|
||||||
|
id: teamId,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const organisation = await prisma.organisation.findFirst({
|
||||||
|
where: buildOrganisationWhereQuery({
|
||||||
|
organisationId: team?.organisationId,
|
||||||
|
userId: user.id,
|
||||||
|
roles: ORGANISATION_MEMBER_ROLE_PERMISSIONS_MAP['DELETE_ORGANISATION'],
|
||||||
|
}),
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
owner: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
teams: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
documents: {
|
||||||
|
select: {
|
||||||
|
id: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
ctx.logger.info({
|
ctx.logger.info({
|
||||||
input: {
|
input: {
|
||||||
teamId,
|
teamId,
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const documentIds = organisation?.teams.flatMap((team) => team.documents.map((doc) => doc.id));
|
||||||
|
|
||||||
|
if (documentIds && documentIds.length > 0 && organisation) {
|
||||||
|
await handleDocumentOwnershipOnDeletion({
|
||||||
|
documentIds,
|
||||||
|
organisationOwnerId: organisation.owner.id,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
await deleteTeam({
|
await deleteTeam({
|
||||||
userId: user.id,
|
userId: user.id,
|
||||||
teamId,
|
teamId,
|
||||||
|
|||||||
Reference in New Issue
Block a user