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

package/src/clients/authenticationApi.ts

@@ -2,7 +2,6 @@ import { APIRequestContext, request } from "@playwright/test";
 
 import { AuthConfig } from "../types";
 
-import { login as authenticateWithLambda } from "../utils/authentication";
 import { logPlaywrightApiResponse, logger } from "../utils/log";
 
 /** Client for interacting with the authentication service to manage tokens */
@@ -28,13 +27,17 @@ export class AuthenticationApiClient {
 	private async login(): Promise<string> {
 		const profiler = logger.startTimer();
 
-		const { token } = await authenticateWithLambda(
-			this.baseURL,
-			this.auth.email,
-			this.auth.password,
-		);
+		const context = await this.getContext();
+		const result = await context.post("login", {
+			data: {
+				email: this.auth.email,
+				password: this.auth.password,
+			},
+		});
 
-		if (!token) {
+		const token = await result.text();
+		if (!result.ok() || !token) {
+			logPlaywrightApiResponse(result);
 			throw new Error("Authentication failed, no token received.");
 		}
 

package/src/clients/manageV2.ts

@@ -47,8 +47,9 @@ export class ManageV2Client {
 	 * The function generates a JWT token using the provided configuration
 	 * parameters.
 	 *
-	 * @param config - The `config` parameter in the `generateToken` function is
-	 *   of type `ManageV2Config`. It contains the following properties:
+	 * @param {ManageV2Config} 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
@@ -96,8 +97,8 @@ export class ManageV2Client {
 	}
 
 	/**
-	 * The function `toggleRolePerLocal` enables or disables the RolesPerLocale
-	 * workflow
+	 * The function `toggleRolePerLocal` enable or disable the role per local
+	 * feature
 	 *
 	 * @param repository - The Repository name
 	 * @param enabled - The feature new status
@@ -112,23 +113,6 @@ 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 repository - The repository name
-	 * @param email - The email of the user
-	 * @param role - The new role to be given
+	 * @param {string} repository - The repository name
+	 * @param {string} email - The email of the user
+	 * @param {string} 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 repository - The repository name
-	 * @param email - The email of the user
-	 * @param rolePerLocal - The role per local object
+	 * @param {string} repository - The repository name
+	 * @param {string} email - The email of the user
+	 * @param {string} rolePerLocal - The role per local object
 	 *
 	 * @returns The Axios Reponse
 	 */
@@ -140,14 +140,17 @@ export class WroomClient {
 	 * @throws Error if the login to Wroom fails.
 	 */
 	private async login(): Promise<void> {
-		const { cookies } = await login(
-			this.getBaseURL(),
-			this.auth.email,
-			this.auth.password,
-		);
-		if (cookies && extractCookie(cookies, "prismic-auth")) {
-			this.client.defaults.headers["Cookie"] = cookies;
+		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");
 		}
 		this.loggedIn = true;
+		profiler.done({ message: "logged in to Prismic" });
 	}
 }

package/src/managers/repositories.ts

@@ -137,7 +137,7 @@ export class RepositoriesManager {
 			"authentication/newrepository",
 			{
 				domain: repositoryName,
-				framework: "next",
+				framework: "vue",
 				plan: "personal",
 				isAnnual: "false",
 				role: "developer",

package/src/managers/repository.ts

@@ -87,10 +87,6 @@ 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 */
@@ -501,7 +497,7 @@ export class RepositoryManager {
 	}
 
 	/**
-	 * Toggle the Role per Locale workflow
+	 * Toggle the Role per local feature
 	 *
 	 * @param enabled - The feature new status
 	 */
@@ -524,34 +520,10 @@ 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 newPlanId - The Id of the new Plan to apply
+	 * @param {string} newPlanId - The Id of the new Plan to apply
 	 */
 	async changePlan(newPlanId: string): Promise<void> {
 		const profiler = logger.startTimer();
@@ -571,7 +543,7 @@ export class RepositoryManager {
 	/**
 	 * Add a new user to the repository
 	 *
-	 * @param email - The email of the user
+	 * @param {string} email - The email of the user
 	 */
 	async addUser(email: string): Promise<void> {
 		const profiler = logger.startTimer();
@@ -598,7 +570,7 @@ export class RepositoryManager {
 	/**
 	 * Remove a user from the repository
 	 *
-	 * @param email - The email of the user
+	 * @param {string} email - The email of the user
 	 */
 	async removeUser(email: string): Promise<void> {
 		const profiler = logger.startTimer();
@@ -620,9 +592,10 @@ export class RepositoryManager {
 	/**
 	 * Update the role of a user in a repository
 	 *
-	 * @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" }`
+	 * @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
 	 *
@@ -726,7 +699,6 @@ export type RepositoryConfig = {
 	customTypes?: CustomType[];
 	preview?: Preview;
 	rolePerLocal?: boolean;
-	customRoles?: boolean;
 };
 
 export type Preview = {

package/dist/utils/authentication.cjs

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const axios = require("axios");
-const log = require("./log.cjs");
-async function login(baseUrl, email, password) {
-  const profiler = log.logger.startTimer();
-  const payload = {
-    email,
-    password
-  };
-  const url = transformUrl(baseUrl, "auth.internal");
-  const response = await axios.post(`${url}/login-e2e`, payload, {
-    headers: {
-      "User-Agent": "prismic-cli/prismic-e2e-tests-utils",
-      Authorization: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NDE3ODQ5NDEsImF1ZCI6ImF1dGgwLWFjdGlvbnMiLCJpc3MiOiJwcmlzbWljLmlvIn0.1UPoVMXJSTWtsyNzK5XYftK_mW0ScVuXwCK69nsyf5c"
-    }
-  });
-  if (response.status !== 200) {
-    log.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, subdomainPrefix) {
-  try {
-    const url = new URL(baseUrl);
-    const domainParts = url.hostname.split(".");
-    const mainDomain = domainParts.slice(-2).join(".");
-    const transformedHostname = `${subdomainPrefix}.${mainDomain}`;
-    return `${url.protocol}//${transformedHostname}`;
-  } catch (error) {
-    throw new Error(`Invalid URL: ${baseUrl}`);
-  }
-}
-exports.login = login;
-//# sourceMappingURL=authentication.cjs.map

package/dist/utils/authentication.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"authentication.cjs","sources":["../../../src/utils/authentication.ts"],"sourcesContent":["import axios from \"axios\";\n\nimport { logHttpResponse, logger } from \"./log\";\n\nexport async function login(\n\tbaseUrl: string,\n\temail: string,\n\tpassword: string,\n): Promise<{ token: string; cookies: string[] | undefined }> {\n\tconst profiler = logger.startTimer();\n\n\tconst payload = {\n\t\temail,\n\t\tpassword,\n\t};\n\n\tconst url = transformUrl(baseUrl, \"auth.internal\");\n\n\tconst response = await axios.post<{ token: string }>(\n\t\t`${url}/login-e2e`,\n\t\tpayload,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t\"User-Agent\": \"prismic-cli/prismic-e2e-tests-utils\",\n\t\t\t\tAuthorization:\n\t\t\t\t\t\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NDE3ODQ5NDEsImF1ZCI6ImF1dGgwLWFjdGlvbnMiLCJpc3MiOiJwcmlzbWljLmlvIn0.1UPoVMXJSTWtsyNzK5XYftK_mW0ScVuXwCK69nsyf5c\",\n\t\t\t},\n\t\t},\n\t);\n\n\tif (response.status !== 200) {\n\t\tlogHttpResponse(response);\n\t\tthrow new Error(\"Could not obtain OAuth token, check your credentials\");\n\t}\n\n\tprofiler.done({ message: \"logged in via OAuth\" });\n\tconst token = response.data.token;\n\n\treturn { token, cookies: response.headers[\"set-cookie\"] };\n}\n\nfunction transformUrl(baseUrl: string, subdomainPrefix: string): string {\n\ttry {\n\t\tconst url = new URL(baseUrl);\n\t\tconst domainParts = url.hostname.split(\".\");\n\n\t\t// Ensure we retain only the main domain (e.g., \"platform-wroom.com\")\n\t\tconst mainDomain = domainParts.slice(-2).join(\".\"); // Keeps last two parts of domain\n\n\t\t// Construct the new hostname with the custom prefix\n\t\tconst transformedHostname = `${subdomainPrefix}.${mainDomain}`;\n\n\t\t// Construct and return the full URL with the new hostname\n\t\treturn `${url.protocol}//${transformedHostname}`;\n\t} catch (error) {\n\t\tthrow new Error(`Invalid URL: ${baseUrl}`);\n\t}\n}\n"],"names":["logger","logHttpResponse"],"mappings":";;;;AAIsB,eAAA,MACrB,SACA,OACA,UAAgB;AAEV,QAAA,WAAWA,WAAO;AAExB,QAAM,UAAU;AAAA,IACf;AAAA,IACA;AAAA,EAAA;AAGK,QAAA,MAAM,aAAa,SAAS,eAAe;AAEjD,QAAM,WAAW,MAAM,MAAM,KAC5B,GAAG,GAAG,cACN,SACA;AAAA,IACC,SAAS;AAAA,MACR,cAAc;AAAA,MACd,eACC;AAAA,IACD;AAAA,EAAA,CACD;AAGE,MAAA,SAAS,WAAW,KAAK;AAC5BC,QAAA,gBAAgB,QAAQ;AAClB,UAAA,IAAI,MAAM,sDAAsD;AAAA,EACvE;AAEA,WAAS,KAAK,EAAE,SAAS,sBAAuB,CAAA;AAC1C,QAAA,QAAQ,SAAS,KAAK;AAE5B,SAAO,EAAE,OAAO,SAAS,SAAS,QAAQ,YAAY;AACvD;AAEA,SAAS,aAAa,SAAiB,iBAAuB;AACzD,MAAA;AACG,UAAA,MAAM,IAAI,IAAI,OAAO;AAC3B,UAAM,cAAc,IAAI,SAAS,MAAM,GAAG;AAG1C,UAAM,aAAa,YAAY,MAAM,EAAE,EAAE,KAAK,GAAG;AAGjD,UAAM,sBAAsB,GAAG,eAAe,IAAI,UAAU;AAG5D,WAAO,GAAG,IAAI,QAAQ,KAAK,mBAAmB;AAAA,WACtC,OAAO;AACf,UAAM,IAAI,MAAM,gBAAgB,OAAO,EAAE;AAAA,EAC1C;AACD;;"}

package/dist/utils/authentication.d.ts

@@ -1,4 +0,0 @@
-export declare function login(baseUrl: string, email: string, password: string): Promise<{
-    token: string;
-    cookies: string[] | undefined;
-}>;

package/dist/utils/authentication.js

@@ -1,38 +0,0 @@
-import axios from "axios";
-import { logger, logHttpResponse } from "./log.js";
-async function login(baseUrl, email, password) {
-  const profiler = logger.startTimer();
-  const payload = {
-    email,
-    password
-  };
-  const url = transformUrl(baseUrl, "auth.internal");
-  const response = await axios.post(`${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, subdomainPrefix) {
-  try {
-    const url = new URL(baseUrl);
-    const domainParts = url.hostname.split(".");
-    const mainDomain = domainParts.slice(-2).join(".");
-    const transformedHostname = `${subdomainPrefix}.${mainDomain}`;
-    return `${url.protocol}//${transformedHostname}`;
-  } catch (error) {
-    throw new Error(`Invalid URL: ${baseUrl}`);
-  }
-}
-export {
-  login
-};
-//# sourceMappingURL=authentication.js.map

package/dist/utils/authentication.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"authentication.js","sources":["../../../src/utils/authentication.ts"],"sourcesContent":["import axios from \"axios\";\n\nimport { logHttpResponse, logger } from \"./log\";\n\nexport async function login(\n\tbaseUrl: string,\n\temail: string,\n\tpassword: string,\n): Promise<{ token: string; cookies: string[] | undefined }> {\n\tconst profiler = logger.startTimer();\n\n\tconst payload = {\n\t\temail,\n\t\tpassword,\n\t};\n\n\tconst url = transformUrl(baseUrl, \"auth.internal\");\n\n\tconst response = await axios.post<{ token: string }>(\n\t\t`${url}/login-e2e`,\n\t\tpayload,\n\t\t{\n\t\t\theaders: {\n\t\t\t\t\"User-Agent\": \"prismic-cli/prismic-e2e-tests-utils\",\n\t\t\t\tAuthorization:\n\t\t\t\t\t\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NDE3ODQ5NDEsImF1ZCI6ImF1dGgwLWFjdGlvbnMiLCJpc3MiOiJwcmlzbWljLmlvIn0.1UPoVMXJSTWtsyNzK5XYftK_mW0ScVuXwCK69nsyf5c\",\n\t\t\t},\n\t\t},\n\t);\n\n\tif (response.status !== 200) {\n\t\tlogHttpResponse(response);\n\t\tthrow new Error(\"Could not obtain OAuth token, check your credentials\");\n\t}\n\n\tprofiler.done({ message: \"logged in via OAuth\" });\n\tconst token = response.data.token;\n\n\treturn { token, cookies: response.headers[\"set-cookie\"] };\n}\n\nfunction transformUrl(baseUrl: string, subdomainPrefix: string): string {\n\ttry {\n\t\tconst url = new URL(baseUrl);\n\t\tconst domainParts = url.hostname.split(\".\");\n\n\t\t// Ensure we retain only the main domain (e.g., \"platform-wroom.com\")\n\t\tconst mainDomain = domainParts.slice(-2).join(\".\"); // Keeps last two parts of domain\n\n\t\t// Construct the new hostname with the custom prefix\n\t\tconst transformedHostname = `${subdomainPrefix}.${mainDomain}`;\n\n\t\t// Construct and return the full URL with the new hostname\n\t\treturn `${url.protocol}//${transformedHostname}`;\n\t} catch (error) {\n\t\tthrow new Error(`Invalid URL: ${baseUrl}`);\n\t}\n}\n"],"names":[],"mappings":";;AAIsB,eAAA,MACrB,SACA,OACA,UAAgB;AAEV,QAAA,WAAW,OAAO;AAExB,QAAM,UAAU;AAAA,IACf;AAAA,IACA;AAAA,EAAA;AAGK,QAAA,MAAM,aAAa,SAAS,eAAe;AAEjD,QAAM,WAAW,MAAM,MAAM,KAC5B,GAAG,GAAG,cACN,SACA;AAAA,IACC,SAAS;AAAA,MACR,cAAc;AAAA,MACd,eACC;AAAA,IACD;AAAA,EAAA,CACD;AAGE,MAAA,SAAS,WAAW,KAAK;AAC5B,oBAAgB,QAAQ;AAClB,UAAA,IAAI,MAAM,sDAAsD;AAAA,EACvE;AAEA,WAAS,KAAK,EAAE,SAAS,sBAAuB,CAAA;AAC1C,QAAA,QAAQ,SAAS,KAAK;AAE5B,SAAO,EAAE,OAAO,SAAS,SAAS,QAAQ,YAAY;AACvD;AAEA,SAAS,aAAa,SAAiB,iBAAuB;AACzD,MAAA;AACG,UAAA,MAAM,IAAI,IAAI,OAAO;AAC3B,UAAM,cAAc,IAAI,SAAS,MAAM,GAAG;AAG1C,UAAM,aAAa,YAAY,MAAM,EAAE,EAAE,KAAK,GAAG;AAGjD,UAAM,sBAAsB,GAAG,eAAe,IAAI,UAAU;AAG5D,WAAO,GAAG,IAAI,QAAQ,KAAK,mBAAmB;AAAA,WACtC,OAAO;AACf,UAAM,IAAI,MAAM,gBAAgB,OAAO,EAAE;AAAA,EAC1C;AACD;"}

package/src/utils/authentication.ts

@@ -1,58 +0,0 @@
-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}`);
-	}
-}