@prismicio/e2e-tests-utils 1.1.0 → 1.1.1

package/src/managers/repository.ts

@@ -7,6 +7,7 @@ import {
 
 import type { CoreClient } from "../clients/coreApi";
 import { CustomTypesClient } from "../clients/customTypesApi";
+import { ManageV2Client } from "../clients/manageV2";
 import { WroomClient } from "../clients/wroom";
 import { logHttpResponse, logger } from "../utils/log";
 import { getRepositoryUrl } from "../utils/urls";
@@ -18,6 +19,7 @@ export class RepositoryManager {
 		private readonly coreApiClient: CoreClient,
 		private readonly wroomClient: WroomClient,
 		private readonly customTypesApiClient: CustomTypesClient,
+		private readonly manageV2Client: ManageV2Client,
 	) {}
 
 	async configure(config: RepositoryConfig): Promise<void> {
@@ -65,6 +67,10 @@ export class RepositoryManager {
 		if (config.preview) {
 			await this.createPreview(config.preview);
 		}
+
+		if (config.rolePerLocal) {
+			await this.toggleRolePerLocal(true);
+		}
 	}
 	/** @returns the repository base url, like https://my-repo.prismic.io */
 	getBaseURL(): string {
@@ -318,6 +324,130 @@ export class RepositoryManager {
 		// only return the generated token since there is no need to access more
 		return response.data.wroom_auths[0].token;
 	}
+
+	/**
+	 * Toggle the Role per local feature
+	 *
+	 * @param enabled - The feature new status
+	 */
+	async toggleRolePerLocal(enabled: boolean): Promise<void> {
+		const profiler = logger.startTimer();
+
+		const response = await this.manageV2Client.toggleRolePerLocal({
+			repository: this.name,
+			enabled: enabled,
+		});
+
+		this.failIfNot200(
+			response,
+			`Could not ${enabled ? "enable" : "disable"} Role per local for ${
+				this.name
+			}`,
+		);
+		profiler.done({
+			message: `Role per local ${enabled ? "enabled" : "disabled"}`,
+		});
+	}
+
+	/**
+	 * Change the Repository Plan
+	 *
+	 * @param {string} newPlanId - The Id of the new Plan to apply
+	 */
+	async changePlan(newPlanId: string): Promise<void> {
+		const profiler = logger.startTimer();
+
+		const response = await this.manageV2Client.changePlan({
+			repository: this.name,
+			newPlanId: newPlanId,
+			bypassManualBilling: true, // For now the library does not support Stripe features
+		});
+
+		this.failIfNot200(response, "Could not change the Repository Plan");
+		profiler.done({
+			message: `Repository Plan changed to ${newPlanId}`,
+		});
+	}
+
+	/**
+	 * Add a new user to the repository
+	 *
+	 * @param {string} email - The email of the user
+	 */
+	async addUser(email: string): Promise<void> {
+		const profiler = logger.startTimer();
+
+		const response = await this.manageV2Client.addUserToRepository({
+			repository: this.name,
+			email: email,
+		});
+
+		this.failIfNot200(response, "Could not add a new user to the repository");
+		profiler.done({
+			message: `User ${email} was added to the repository`,
+		});
+	}
+
+	/**
+	 * Remove a user from the repository
+	 *
+	 * @param {string} email - The email of the user
+	 */
+	async removeUser(email: string): Promise<void> {
+		const profiler = logger.startTimer();
+
+		const response = await this.manageV2Client.removeUserFromRepository({
+			repository: this.name,
+			email: email,
+		});
+
+		this.failIfNot200(
+			response,
+			`Could not remove the user ${email} from the repository`,
+		);
+		profiler.done({
+			message: `User ${email} was removed from the repository`,
+		});
+	}
+
+	/**
+	 * Update the role of a user in a repository
+	 *
+	 * @param {string} email - The email of the user
+	 * @param {string | Record<string, string>} role - The new Role of the user,
+	 *   either a string for basic workflow or an object such as `{ "lang_id":
+	 *   "Writer" }`
+	 *
+	 *   Example of roles are
+	 *
+	 *   - Administrator
+	 *   - Writer
+	 *   - Contributor
+	 *   - Manager (publisher)
+	 */
+	async updateUserRole(
+		email: string,
+		role: string | Record<string, string>,
+	): Promise<void> {
+		const profiler = logger.startTimer();
+
+		const response =
+			typeof role === "string"
+				? await this.wroomClient.updateRole(this.name, email, role)
+				: await this.wroomClient.updateRolePerLocal(this.name, email, role);
+
+		this.failIfNot200(
+			response,
+			`Could not update the ${
+				typeof role === "string" ? "role" : "rolePerLocal"
+			} of the user ${email}`,
+		);
+		profiler.done({
+			message: `Updated User's ${
+				typeof role === "string" ? "role" : "rolePerLocal"
+			} for user ${email}`,
+		});
+	}
 }
 
 export type RepositoryConfig = {
@@ -327,6 +457,7 @@ export type RepositoryConfig = {
 	slices?: SharedSlice[];
 	customTypes?: CustomType[];
 	preview?: Preview;
+	rolePerLocal?: boolean;
 };
 
 export type Preview = {

package/src/types.ts

@@ -1 +1,27 @@
-export type Credentials = { email: string; password: string };
+export type UrlConfig = {
+	/** Prismic base url */
+	baseURL: string;
+	/** Custom types api base url */
+	customTypesApi: string;
+	/** Auth service api base url */
+	authenticationApi: string;
+};
+
+export type AuthConfig = {
+	email: string;
+	password: string;
+};
+
+export type ManageV2Config = {
+	secret: string;
+	audience: string;
+};
+
+// Global configuration Object
+export type SetupConfiguration = {
+	// If provided as a string: It is treated as the base URL for Prismic. Other
+	// URLs (Custom Types API, Auth API) will be derived from it.
+	urlConfig: UrlConfig | string;
+	authConfig: AuthConfig;
+	manageV2Config?: ManageV2Config;
+};