@prismicio/e2e-tests-utils 1.1.0 → 1.1.2-alpha.0

package/src/managers/repositories.ts

@@ -1,4 +1,4 @@
-import { Credentials } from "../types";
+import { SetupConfiguration, UrlConfig } from "../types";
 
 import {
 	AuthenticationClient,
@@ -6,6 +6,7 @@ import {
 } from "../clients/authenticationApi";
 import { createCoreApiClient } from "../clients/coreApi";
 import { createCustomTypesApiClient } from "../clients/customTypesApi";
+import { ManageV2Client } from "../clients/manageV2";
 import { WroomClient } from "../clients/wroom";
 import { EnvVariableManager } from "../utils/envVariableManager";
 import { logHttpResponse, logger } from "../utils/log";
@@ -18,30 +19,29 @@ import { RepositoryConfig, RepositoryManager } from "./repository";
  * Factory method to create a RepositoriesManager to manage repositories test
  * data.
  *
- * @param urlConfig - If provided as an object:
+ * @param configuration - Global object containing the different configurations
+ *   required to setup the RepositoriesManager.
  *
- *       - {@link UrlConfig.baseURL}: The Prismic base URL.
- *       - {@link UrlConfig.customTypesApi}: The base URL for the Custom Types API.
- *       - {@link UrlConfig.authenticationApi}: The base URL for the Authentication API.
- *
- *   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.
- * @param auth - The authentication credentials
+ *       - {@link configuration.urlConfig}: Configuration around the API's URLs management.
+ *       - {@link configuration.authConfig}: Configuration around the authentication of a user.
+ *       - {@link configuration.manageV2Config}: Optional Configuration used to make calls to ManageV2.
  *
  * @returns An instance of {@link RepositoriesManager} to manage test data.
  */
 export const createRepositoriesManager = (
-	urlConfig: UrlConfig | string,
-	auth: Credentials,
+	configuration: SetupConfiguration,
 ): RepositoriesManager => {
-	return new RepositoriesManager(urlConfig, auth);
+	return new RepositoriesManager(configuration);
 };
 
 /** Utility object to manage Prismic test data */
 export class RepositoriesManager {
-	private readonly urls: UrlConfig;
+	private readonly config: Omit<SetupConfiguration, "urlConfig"> & {
+		urlConfig: UrlConfig;
+	};
 	private readonly wroomClient: WroomClient;
 	private readonly authClient: AuthenticationClient;
+	private readonly manageV2Client: ManageV2Client;
 	/**
 	 * helper to keep track of repositories across independent test phases (setup,
 	 * teardown)
@@ -51,22 +51,31 @@ export class RepositoriesManager {
 	);
 
 	/**
-	 * @param urlConfig - The base URL of the Wroom app.
+	 * @param configuration - Global object containing the different configuration
+	 *   required to setup the different clients.
 	 * @param credentials - Authentication credentials (email and password)
 	 */
-	constructor(
-		urlConfig: UrlConfig | string,
-		private readonly credentials: Credentials,
-	) {
-		if (typeof urlConfig === "string") {
+	constructor(configuration: SetupConfiguration) {
+		this.config = {
+			...configuration,
 			// When a string is provided, treat it as the 'base' property
-			urlConfig = this.inferUrls(urlConfig);
-		}
-		this.urls = urlConfig;
-		this.wroomClient = new WroomClient(this.urls.baseURL, this.credentials);
+			urlConfig:
+				typeof configuration.urlConfig === "string"
+					? this.inferUrls(configuration.urlConfig)
+					: configuration.urlConfig,
+		};
+
+		this.wroomClient = new WroomClient(
+			this.config.urlConfig.baseURL,
+			this.config.authConfig,
+		);
 		this.authClient = createAuthenticationApiClient(
-			this.urls.authenticationApi,
-			this.credentials,
+			this.config.urlConfig.authenticationApi,
+			this.config.authConfig,
+		);
+		this.manageV2Client = new ManageV2Client(
+			this.config.urlConfig.baseURL,
+			this.config.manageV2Config,
 		);
 	}
 
@@ -149,7 +158,7 @@ export class RepositoriesManager {
 		const post = async () =>
 			this.wroomClient.post(repository, "app/settings/delete", {
 				confirm: repository,
-				password: this.credentials.password,
+				password: this.config.authConfig.password,
 			});
 		const response = await post();
 		if (response.status !== 200) {
@@ -183,27 +192,20 @@ export class RepositoriesManager {
 	 */
 	getRepositoryManager(name: string): RepositoryManager {
 		const customTypeClient = createCustomTypesApiClient(
-			this.urls.customTypesApi,
+			this.config.urlConfig.customTypesApi,
 			name,
 			this.authClient,
 		);
-		const coreApiUrl = getRepositoryUrl(this.urls.baseURL, name);
+		const coreApiUrl = getRepositoryUrl(this.config.urlConfig.baseURL, name);
 		const coreApiClient = createCoreApiClient(coreApiUrl, this.authClient);
 
 		return new RepositoryManager(
 			name,
 			coreApiClient,
+			this.authClient,
 			this.wroomClient,
 			customTypeClient,
+			this.manageV2Client,
 		);
 	}
 }
-
-export type UrlConfig = {
-	/** Prismic base url */
-	baseURL: string;
-	/** Custom types api base url */
-	customTypesApi: string;
-	/** Auth service api base url */
-	authenticationApi: string;
-};

package/src/managers/repository.ts

@@ -5,8 +5,10 @@ import {
 	SharedSlice,
 } from "@prismicio/types-internal/lib/customtypes";
 
+import type { AuthenticationClient } from "../clients/authenticationApi";
 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";
@@ -16,8 +18,10 @@ export class RepositoryManager {
 	constructor(
 		readonly name: string,
 		private readonly coreApiClient: CoreClient,
+		private readonly authApiClient: AuthenticationClient,
 		private readonly wroomClient: WroomClient,
 		private readonly customTypesApiClient: CustomTypesClient,
+		private readonly manageV2Client: ManageV2Client,
 	) {}
 
 	async configure(config: RepositoryConfig): Promise<void> {
@@ -65,6 +69,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 +326,143 @@ export class RepositoryManager {
 		// only return the generated token since there is no need to access more
 		return response.data.wroom_auths[0].token;
 	}
+
+	/** Create a machine2machine token */
+	async createMachine2MachineToken(): Promise<string> {
+		const profiler = logger.startTimer();
+
+		const token = await this.authApiClient.getMachine2MachineToken(this.name);
+
+		profiler.done({
+			message: `machine2machine token created`,
+		});
+
+		return 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 +472,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;
+};