@prismicio/e2e-tests-utils 2.0.0-alpha.0 → 2.0.0-alpha.10

package/src/clients/manageV2.ts

@@ -35,7 +35,7 @@ export class ManageV2Client {
 		// cookies are not forwarded automatically in a non-browser env
 		this.client.interceptors.response.use((response) => {
 			const cookies = response.headers["set-cookie"];
-			if (cookies && extractCookie(cookies, "SESSION")) {
+			if (cookies && extractCookie(cookies, "prismic-auth")) {
 				this.client.defaults.headers["Cookie"] = cookies;
 			}
 
@@ -47,9 +47,8 @@ export class ManageV2Client {
 	 * The function generates a JWT token using the provided configuration
 	 * parameters.
 	 *
-	 * @param {ManageV2Config} config - The `config` parameter in the
-	 *   `generateToken` function is of type `ManageV2Config`. It contains the
-	 *   following properties:
+	 * @param config - The `config` parameter in the `generateToken` function is
+	 *   of type `ManageV2Config`. It contains the following properties:
 	 *
 	 * @returns A JSON Web Token (JWT) is being returned by the `generateToken`
 	 *   function. The token is signed using the provided `config.secret` with the
@@ -97,8 +96,8 @@ export class ManageV2Client {
 	}
 
 	/**
-	 * The function `toggleRolePerLocal` enable or disable the role per local
-	 * feature
+	 * The function `toggleRolePerLocal` enables or disables the RolesPerLocale
+	 * workflow
 	 *
 	 * @param repository - The Repository name
 	 * @param enabled - The feature new status
@@ -113,6 +112,23 @@ export class ManageV2Client {
 		},
 	);
 
+	/**
+	 * The function `toggleCustomRoles` enables or disables the CustomRoles
+	 * workflow
+	 *
+	 * @param repository - The Repository name
+	 * @param enabled - The feature new status
+	 */
+	toggleCustomRoles = this.assertTokenExist(
+		(params: { repository: string; enabled: boolean }) => {
+			return this.client.post("/repository/toggleCustomRoles", {
+				domain: params.repository,
+				enabled: params.enabled,
+				author: ManageV2StaticAuthor,
+			});
+		},
+	);
+
 	/**
 	 * The function `changePlan` changes the plan of a repository the database
 	 *

package/src/clients/wroom.ts

@@ -2,8 +2,8 @@ import axios, { AxiosInstance, AxiosResponse } from "axios";
 
 import { AuthConfig } from "../types";
 
+import { login } from "../utils/authentication";
 import { extractCookie } from "../utils/cookies";
-import { logHttpResponse, logger } from "../utils/log";
 import { getRepositoryUrl } from "../utils/urls";
 
 /**
@@ -97,9 +97,9 @@ export class WroomClient {
 	/**
 	 * Update the role of a user in the repository
 	 *
-	 * @param {string} repository - The repository name
-	 * @param {string} email - The email of the user
-	 * @param {string} role - The new role to be given
+	 * @param repository - The repository name
+	 * @param email - The email of the user
+	 * @param role - The new role to be given
 	 *
 	 * @returns The Axios Reponse
 	 */
@@ -117,9 +117,9 @@ export class WroomClient {
 	/**
 	 * Update the role of a user in the repository
 	 *
-	 * @param {string} repository - The repository name
-	 * @param {string} email - The email of the user
-	 * @param {string} rolePerLocal - The role per local object
+	 * @param repository - The repository name
+	 * @param email - The email of the user
+	 * @param rolePerLocal - The role per local object
 	 *
 	 * @returns The Axios Reponse
 	 */
@@ -140,17 +140,14 @@ export class WroomClient {
 	 * @throws Error if the login to Wroom fails.
 	 */
 	private async login(): Promise<void> {
-		const profiler = logger.startTimer();
-		const response = await this.client.post<string>("/authentication/signin", {
-			email: this.auth.email,
-			password: this.auth.password,
-		});
-
-		if (response.status !== 200) {
-			logHttpResponse(response);
-			throw new Error("Could not login to Prismic, check your credentials");
+		const { cookies } = await login(
+			this.getBaseURL(),
+			this.auth.email,
+			this.auth.password,
+		);
+		if (cookies && extractCookie(cookies, "prismic-auth")) {
+			this.client.defaults.headers["Cookie"] = cookies;
 		}
 		this.loggedIn = true;
-		profiler.done({ message: "logged in to Prismic" });
 	}
 }

package/src/managers/repositories.ts

@@ -1,5 +1,6 @@
 import { SetupConfiguration, UrlConfig } from "../types";
 
+import { AssetApiClient } from "../clients/assetApi";
 import { AuthenticationApiClient } from "../clients/authenticationApi";
 import { CoreApiClient } from "../clients/coreApi";
 import { CustomTypesApiClient } from "../clients/customTypesApi";
@@ -77,6 +78,15 @@ export class RepositoriesManager {
 			this.config.urlConfig.baseURL,
 			this.config.manageV2Config,
 		);
+
+		// This logic specific to staging environment allow us to target a specific version of the custom types API.
+		// This is only works for unify-exp at the moment.
+		// Having this logic here avoids duplicating it across different CI workflows.
+		this.config.urlConfig.customTypesApi =
+			configuration.environment === "stage" &&
+			configuration.cluster === "unify-exp"
+				? `https://customtypes.wroom.io/${configuration.cluster}/`
+				: this.config.urlConfig.customTypesApi;
 	}
 
 	/**
@@ -92,6 +102,7 @@ export class RepositoriesManager {
 			authenticationApi: `${protocol}://auth.${url.hostname}`,
 			customTypesApi: `${protocol}://customtypes.${url.hostname}`,
 			migrationApi: `${protocol}://migration.${url.hostname}`,
+			assetApi: `${protocol}://asset-api.${url.hostname}`,
 		};
 	}
 
@@ -126,7 +137,7 @@ export class RepositoriesManager {
 			"authentication/newrepository",
 			{
 				domain: repositoryName,
-				framework: "vue",
+				framework: "next",
 				plan: "personal",
 				isAnnual: "false",
 				role: "developer",
@@ -212,6 +223,10 @@ export class RepositoriesManager {
 					repository,
 				})
 			: undefined;
+		const assetApiClient = new AssetApiClient(urlConfig.assetApi, {
+			authToken,
+			repository,
+		});
 
 		return new RepositoryManager(
 			repository,
@@ -220,6 +235,7 @@ export class RepositoriesManager {
 			this.wroomClient,
 			customTypeClient,
 			migrationApiClient,
+			assetApiClient,
 			this.manageV2Client,
 		);
 	}

package/src/managers/repository.ts

@@ -6,6 +6,7 @@ import {
 	SharedSlice,
 } from "@prismicio/types-internal/lib/customtypes";
 
+import { AssetApiClient } from "../clients/assetApi";
 import { AuthenticationApiClient } from "../clients/authenticationApi";
 import { ContentApiClient } from "../clients/contentApi";
 import {
@@ -29,6 +30,7 @@ export class RepositoryManager {
 		private readonly wroomClient: WroomClient,
 		private readonly customTypesApiClient: CustomTypesApiClient,
 		private readonly migrationApiClient: MigrationApiClient | undefined,
+		private readonly assetApiClient: AssetApiClient,
 		private readonly manageV2Client: ManageV2Client,
 	) {}
 
@@ -85,6 +87,10 @@ export class RepositoryManager {
 		if (config.rolePerLocal) {
 			await this.toggleRolePerLocal(true);
 		}
+
+		if (config.customRoles) {
+			await this.toggleCustomRoles(true);
+		}
 	}
 
 	/** @returns the repository base url, like https://my-repo.prismic.io */
@@ -121,6 +127,14 @@ export class RepositoryManager {
 		return this.migrationApiClient;
 	}
 
+	/**
+	 * @returns an instance of the Asset api client, see
+	 *   https://prismic.io/docs/asset-api-technical-reference
+	 */
+	getAssetApiClient(): AssetApiClient {
+		return this.assetApiClient;
+	}
+
 	/** @returns the Wroom commit hash deployed on the current repository */
 	async getDeployedVersion(): Promise<string | undefined> {
 		const response = await this.wroomClient.get(
@@ -330,6 +344,62 @@ 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.
 	 *
@@ -431,7 +501,7 @@ export class RepositoryManager {
 	}
 
 	/**
-	 * Toggle the Role per local feature
+	 * Toggle the Role per Locale workflow
 	 *
 	 * @param enabled - The feature new status
 	 */
@@ -454,10 +524,34 @@ export class RepositoryManager {
 		});
 	}
 
+	/**
+	 * Toggle the Custom Roles workflow
+	 *
+	 * @param enabled - The feature new status
+	 */
+	async toggleCustomRoles(enabled: boolean): Promise<void> {
+		const profiler = logger.startTimer();
+
+		const response = await this.manageV2Client.toggleCustomRoles({
+			repository: this.name,
+			enabled: enabled,
+		});
+
+		this.failIfNot200(
+			response,
+			`Could not ${enabled ? "enable" : "disable"} Custom Roles for ${
+				this.name
+			}`,
+		);
+		profiler.done({
+			message: `Custom Roles ${enabled ? "enabled" : "disabled"}`,
+		});
+	}
+
 	/**
 	 * Change the Repository Plan
 	 *
-	 * @param {string} newPlanId - The Id of the new Plan to apply
+	 * @param newPlanId - The Id of the new Plan to apply
 	 */
 	async changePlan(newPlanId: string): Promise<void> {
 		const profiler = logger.startTimer();
@@ -477,7 +571,7 @@ export class RepositoryManager {
 	/**
 	 * Add a new user to the repository
 	 *
-	 * @param {string} email - The email of the user
+	 * @param email - The email of the user
 	 */
 	async addUser(email: string): Promise<void> {
 		const profiler = logger.startTimer();
@@ -504,7 +598,7 @@ export class RepositoryManager {
 	/**
 	 * Remove a user from the repository
 	 *
-	 * @param {string} email - The email of the user
+	 * @param email - The email of the user
 	 */
 	async removeUser(email: string): Promise<void> {
 		const profiler = logger.startTimer();
@@ -526,10 +620,9 @@ export class RepositoryManager {
 	/**
 	 * 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" }`
+	 * @param email - The email of the user
+	 * @param 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
 	 *
@@ -633,6 +726,7 @@ export type RepositoryConfig = {
 	customTypes?: CustomType[];
 	preview?: Preview;
 	rolePerLocal?: boolean;
+	customRoles?: boolean;
 };
 
 export type Preview = {

package/src/types.ts

@@ -7,6 +7,8 @@ export type UrlConfig = {
 	authenticationApi: string;
 	/** Prismic migration api base url */
 	migrationApi?: string;
+	/** Asset api base url */
+	assetApi: string;
 };
 
 export type AuthConfig = {
@@ -27,4 +29,5 @@ export type SetupConfiguration = {
 	authConfig: AuthConfig;
 	manageV2Config?: ManageV2Config;
 	cluster?: string;
+	environment?: string;
 };

package/src/utils/authentication.ts

@@ -0,0 +1,58 @@
+import axios from "axios";
+
+import { logHttpResponse, logger } from "./log";
+
+export async function login(
+	baseUrl: string,
+	email: string,
+	password: string,
+): Promise<{ token: string; cookies: string[] | undefined }> {
+	const profiler = logger.startTimer();
+
+	const payload = {
+		email,
+		password,
+	};
+
+	const url = transformUrl(baseUrl, "auth.internal");
+
+	const response = await axios.post<{ token: string }>(
+		`${url}/login-e2e`,
+		payload,
+		{
+			headers: {
+				"User-Agent": "prismic-cli/prismic-e2e-tests-utils",
+				Authorization:
+					"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NDE3ODQ5NDEsImF1ZCI6ImF1dGgwLWFjdGlvbnMiLCJpc3MiOiJwcmlzbWljLmlvIn0.1UPoVMXJSTWtsyNzK5XYftK_mW0ScVuXwCK69nsyf5c",
+			},
+		},
+	);
+
+	if (response.status !== 200) {
+		logHttpResponse(response);
+		throw new Error("Could not obtain OAuth token, check your credentials");
+	}
+
+	profiler.done({ message: "logged in via OAuth" });
+	const token = response.data.token;
+
+	return { token, cookies: response.headers["set-cookie"] };
+}
+
+function transformUrl(baseUrl: string, subdomainPrefix: string): string {
+	try {
+		const url = new URL(baseUrl);
+		const domainParts = url.hostname.split(".");
+
+		// Ensure we retain only the main domain (e.g., "platform-wroom.com")
+		const mainDomain = domainParts.slice(-2).join("."); // Keeps last two parts of domain
+
+		// Construct the new hostname with the custom prefix
+		const transformedHostname = `${subdomainPrefix}.${mainDomain}`;
+
+		// Construct and return the full URL with the new hostname
+		return `${url.protocol}//${transformedHostname}`;
+	} catch (error) {
+		throw new Error(`Invalid URL: ${baseUrl}`);
+	}
+}