n8n/packages/testing/playwright/services/project-api-helper.ts

import type { Folder, Project } from '@n8n/db';
import { nanoid } from 'nanoid';

import type { ApiHelpers } from './api-helper';
import { TestError } from '../Types';

export class ProjectApiHelper {
	constructor(private api: ApiHelpers) {}

	/**
	 * Create a new project with a unique name
	 * @param projectName Optional base name for the project. If not provided, generates a default name.
	 * @returns The created project data
	 */
	async createProject(projectName?: string): Promise<Project> {
		const uniqueName = projectName ? `${projectName} (${nanoid(8)})` : `Test Project ${nanoid(8)}`;

		const response = await this.api.request.post('/rest/projects', {
			data: {
				name: uniqueName,
			},
		});

		if (!response.ok()) {
			throw new TestError(`Failed to create project: ${await response.text()}`);
		}

		const result = await response.json();
		return result.data ?? result;
	}

	/**
	 * Get the current logged-in user's personal project.
	 * Uses the dedicated /rest/projects/personal endpoint which returns
	 * only the authenticated user's personal project, not all visible personal projects.
	 * @returns The current user's personal project
	 */
	async getMyPersonalProject(): Promise<Project> {
		const response = await this.api.request.get('/rest/projects/personal');

		if (!response.ok()) {
			throw new TestError(`Failed to get personal project: ${await response.text()}`);
		}

		const result = await response.json();
		return result.data ?? result;
	}

	/**
	 * Delete a project
	 * @param projectId The ID of the project to delete
	 * @returns True if deletion was successful
	 */
	async deleteProject(projectId: string): Promise<boolean> {
		const response = await this.api.request.delete(`/rest/projects/${projectId}`);

		if (!response.ok()) {
			throw new TestError(`Failed to delete project: ${await response.text()}`);
		}

		return true;
	}

	/**
	 * Create a new folder in a project
	 * @param projectId The ID of the project to create the folder in
	 * @param folderName The name of the folder to create
	 * @param parentFolderId Optional parent folder ID for nested folders
	 * @returns The created folder data
	 */
	async createFolder(
		projectId: string,
		folderName?: string,
		parentFolderId?: string,
	): Promise<Folder> {
		const uniqueName = folderName ? `${folderName} (${nanoid(8)})` : `Test Folder ${nanoid(8)}`;
		const response = await this.api.request.post(`/rest/projects/${projectId}/folders`, {
			data: {
				name: uniqueName,
				...(parentFolderId && { parentFolderId }),
			},
		});

		if (!response.ok()) {
			throw new TestError(`Failed to create folder: ${await response.text()}`);
		}

		const result = await response.json();
		return result.data ?? result;
	}

	/**
	 * Private helper: Add multiple users to a project
	 * @param projectId The ID of the project
	 * @param relations Array of userId and role pairs
	 * @returns True if users were added successfully
	 */
	private async addUsersToProject(
		projectId: string,
		relations: Array<{ userId: string; role: string }>,
	): Promise<boolean> {
		const response = await this.api.request.post(`/rest/projects/${projectId}/users`, {
			data: { relations },
		});

		if (!response.ok()) {
			throw new TestError(`Failed to add users to project: ${await response.text()}`);
		}

		return true;
	}

	/**
	 * Add a user to a project
	 * @param projectId The ID of the project
	 * @param userId The ID of the user to add
	 * @param role The role to assign to the user (e.g., 'project:editor', 'project:viewer', 'project:admin')
	 * @returns True if user was added successfully
	 */
	async addUserToProject(projectId: string, userId: string, role: string): Promise<boolean> {
		return await this.addUsersToProject(projectId, [{ userId, role }]);
	}

	/**
	 * Add a user to a project by email
	 * @param projectId The ID of the project
	 * @param email The email of the user to add
	 * @param role The role to assign to the user (e.g., 'project:editor', 'project:viewer', 'project:admin')
	 * @returns True if user was added successfully
	 */
	async addUserToProjectByEmail(projectId: string, email: string, role: string): Promise<boolean> {
		const user = await this.api.users.getUserByEmail(email);
		if (!user) {
			throw new TestError(`User with email ${email} not found`);
		}
		return await this.addUserToProject(projectId, user.id, role);
	}
}