@prismicio/e2e-tests-utils 1.2.0 → 1.3.0

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 {
@@ -260,62 +268,6 @@ export class RepositoryManager {
 		profiler.done({ message: `preview '${id}' deleted` });
 	}
 
-	/**
-	 * Create a webhook.
-	 *
-	 * @returns A Promise that resolves with the webhook id.
-	 */
-	async createWebhook(
-		name: string,
-		url: string,
-		secret: string,
-		triggers: {
-			documentsPublished?: boolean;
-			documentsUnpublished?: boolean;
-			releasesCreated?: boolean;
-			releasesUpdated?: boolean;
-			tagsCreated?: boolean;
-			tagsDeleted?: boolean;
-		},
-		active: boolean,
-	): Promise<string> {
-		const profiler = logger.startTimer();
-
-		const response = await this.wroomClient.post(
-			this.name,
-			"app/settings/webhooks/create",
-			{
-				name,
-				url,
-				secret,
-				active: active ? "on" : "off",
-				...triggers,
-			},
-		);
-		this.failIfNot200(response, `Could not create webhook ${name}`);
-		profiler.done({ message: `webhook '${name}' created` });
-
-		return response.data.created;
-	}
-
-	/**
-	 * Deletes a webhook.
-	 *
-	 * @param id - The webhook ID.
-	 */
-	async deleteWebhook(id: string): Promise<void> {
-		const profiler = logger.startTimer();
-
-		const response = await this.wroomClient.post(
-			this.name,
-			`app/settings/webhooks/${id}/delete`,
-			{},
-		);
-
-		this.failIfNot200(response, `Could not delete webhook with id ${id}`);
-		profiler.done({ message: `webhook '${id}' deleted` });
-	}
-
 	/**
 	 * Create Custom Types using the Custom types api.
 	 *
@@ -335,44 +287,217 @@ export class RepositoryManager {
 	}
 
 	/**
-	 * Create a permanent access token along with an application name
+	 * Create an access token to query private items of the Content api.
 	 *
 	 * @param appName - mandatory authorized application name
+	 * @param tokenScope - access token scope. Use "master" to when your content
+	 *   api is fully private or "master+releases" to access private releases
 	 */
-	async createPermanentAccessToken(appName: string): Promise<string> {
+	async createContentAPIToken(
+		appName: string,
+		tokenScope: "master" | "master+releases" = "master",
+	): Promise<string> {
 		const profiler = logger.startTimer();
 		type AuthorizedAppResponse = {
+			id: string;
 			name: string;
-			wroom_auths: { token: string }[];
+			wroom_auths: { token: string; scope: "master" | "master+releases" }[];
 		};
 		const existingApps: AxiosResponse<AuthorizedAppResponse[]> =
 			await this.wroomClient.get(this.name, "settings/security/contentapi");
 
 		this.failIfNot200(
 			existingApps,
-			`Could not get status of existing applications to generate a permanent token`,
+			`Could not get status of existing applications to generate a content api token`,
 		);
-		const existingApp = existingApps.data.find(({ name, wroom_auths }) => {
+		let app = existingApps.data.find(({ name, wroom_auths }) => {
 			return name === appName && wroom_auths.length > 0;
 		});
-		if (existingApp) {
-			return existingApp.wroom_auths[0].token;
+
+		if (!app) {
+			const response: AxiosResponse<AuthorizedAppResponse> =
+				await this.wroomClient.post(this.name, "settings/security/oauthapp", {
+					app_name: appName,
+				});
+
+			this.failIfNot200(
+				response,
+				`Could not create content api app ${appName}`,
+			);
+			app = response.data;
+		}
+
+		let tokenInfo = app.wroom_auths.find(({ scope }) => scope === tokenScope);
+		if (!tokenInfo) {
+			const response = await this.wroomClient.post(
+				this.name,
+				"settings/security/authorizations",
+				{
+					app: app.id,
+					scope: tokenScope,
+				},
+			);
+			this.failIfNot200(
+				response,
+				`Could not create content api access token for app ${appName} with scope ${tokenScope}`,
+			);
+			tokenInfo = response.data;
+		}
+
+		profiler.done({
+			message: `content api access token for app '${appName}' created`,
+		});
+
+		if (!tokenInfo?.token) {
+			throw `Could not create content api access token for app ${appName} with scope ${tokenScope}`;
+		}
+
+		return tokenInfo.token;
+	}
+
+	/** Create a permanent access token to authenticate to Prismic public apis. */
+	async createPermanentAccessToken(): 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,
+		});
+
+		const { data, status } = response;
+		const success =
+			status === 200 ||
+			(status === 409 &&
+				JSON.stringify(data).includes("already a member of the repo"));
+		if (!success) {
+			logHttpResponse(response);
+			throw new Error(`Could not add a new user ${email} to the repository`);
 		}
-		const response: AxiosResponse<AuthorizedAppResponse> =
-			await this.wroomClient.post(this.name, "settings/security/oauthapp", {
-				app_name: appName,
-			});
+		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 create permanent access token for app name ${appName}`,
+			`Could not remove the user ${email} from the repository`,
 		);
 		profiler.done({
-			message: `permanent access token for app name '${appName}' created`,
+			message: `User ${email} was removed from the repository`,
 		});
+	}
 
-		// only return the generated token since there is no need to access more
-		return response.data.wroom_auths[0].token;
+	/**
+	 * 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}`,
+		});
 	}
 }
 
@@ -383,6 +508,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;
+};