@prismicio/e2e-tests-utils 1.18.0 → 1.19.0

package/src/clients/integrationFields.ts

@@ -1,40 +1,39 @@
-import axios, { AxiosInstance } from "axios";
+import type { AxiosInstance } from "axios"
+import axios from "axios"
 
-import { IntegrationFieldConfig, IntegrationFieldData } from "../types";
-
-import { logHttpResponse } from "../utils/log";
-import { slugify } from "../utils/strings";
-
-import { CustomTypesApiClient } from "./customTypesApi";
-import { WroomClient } from "./wroom";
+import type { IntegrationFieldConfig, IntegrationFieldData } from "../types"
+import { logHttpResponse } from "../utils/log"
+import { slugify } from "../utils/strings"
+import type { CustomTypesApiClient } from "./customTypesApi"
+import type { WroomClient } from "./wroom"
 
 /**
- * Client for interacting with Integration Fields routes to create integration
- * field catalogs and add them to custom type fields.
+ * Client for interacting with Integration Fields routes to create integration field catalogs and
+ * add them to custom type fields.
  */
 export class IntegrationFieldsClient {
-	private readonly baseURL: string;
-	private readonly customTypesApiClient: CustomTypesApiClient;
-	private readonly wroomClient: WroomClient;
-	private readonly repository: string;
-	private readonly tokens: Record<string, string> = {};
+	private readonly baseURL: string
+	private readonly customTypesApiClient: CustomTypesApiClient
+	private readonly wroomClient: WroomClient
+	private readonly repository: string
+	private readonly tokens: Record<string, string> = {}
 
 	constructor(
 		baseURL: string,
 		config: {
-			customTypesApiClient: CustomTypesApiClient;
-			wroomClient: WroomClient;
-			repository: string;
+			customTypesApiClient: CustomTypesApiClient
+			wroomClient: WroomClient
+			repository: string
 		},
 	) {
-		this.baseURL = baseURL;
-		this.customTypesApiClient = config.customTypesApiClient;
-		this.wroomClient = config.wroomClient;
-		this.repository = config.repository;
+		this.baseURL = baseURL
+		this.customTypesApiClient = config.customTypesApiClient
+		this.wroomClient = config.wroomClient
+		this.repository = config.repository
 	}
 
 	private async getClient(catalogId: string): Promise<AxiosInstance> {
-		const token = this.tokens[catalogId] || (await this.createToken(catalogId));
+		const token = this.tokens[catalogId] || (await this.createToken(catalogId))
 
 		const client = axios.create({
 			baseURL: `${this.baseURL}/if/`,
@@ -44,17 +43,17 @@ export class IntegrationFieldsClient {
 				"User-Agent": "prismic-cli/prismic-e2e-tests-utils",
 				Authorization: `Bearer ${token}`,
 			},
-		});
+		})
 
-		return client;
+		return client
 	}
 
 	private async addCatalog({
 		name,
 		description,
 	}: {
-		name: string;
-		description: string;
+		name: string
+		description: string
 	}): Promise<string> {
 		const response = await this.wroomClient.post(
 			this.repository,
@@ -63,60 +62,52 @@ export class IntegrationFieldsClient {
 				"catalog-name": name,
 				"catalog-description": description,
 			},
-		);
+		)
 
-		const { data, status } = response;
+		const { data, status } = response
 		const success =
 			status === 200 ||
-			(status === 400 &&
-				(data as string).includes("Already existing integration field"));
+			(status === 400 && (data as string).includes("Already existing integration field"))
 		if (!success) {
-			logHttpResponse(response);
-			throw new Error(`Could not add integration field catalog ${name}`);
+			logHttpResponse(response)
+			throw new Error(`Could not add integration field catalog ${name}`)
 		}
 
-		return `${this.repository}--${slugify(name)}`;
+		return `${this.repository}--${slugify(name)}`
 	}
 
 	private async createToken(catalogId: string): Promise<string> {
 		const response = await this.wroomClient.post(
 			this.repository,
 			`app/settings/integrationfields/pushcustom/${catalogId}/token`,
-		);
+		)
 
-		const { data: tokenData, status } = response;
+		const { data: tokenData, status } = response
 		if (status !== 201) {
-			logHttpResponse(response);
-			throw new Error(
-				`Could not create token for integration field catalog ${catalogId}`,
-			);
+			logHttpResponse(response)
+			throw new Error(`Could not create token for integration field catalog ${catalogId}`)
 		}
 
-		const token = tokenData[0];
-		this.tokens[catalogId] = token;
+		const token = tokenData[0]
+		this.tokens[catalogId] = token
 
-		return token;
+		return token
 	}
 
 	private async addDataToCatalog({
 		catalogId,
 		data,
 	}: {
-		catalogId: string;
-		data: IntegrationFieldData[];
+		catalogId: string
+		data: IntegrationFieldData[]
 	}): Promise<void> {
-		const client = await this.getClient(catalogId);
-		const response = await client.post(
-			`/write/${catalogId}`,
-			JSON.stringify(data),
-		);
+		const client = await this.getClient(catalogId)
+		const response = await client.post(`/write/${catalogId}`, JSON.stringify(data))
 
-		const { status } = response;
+		const { status } = response
 		if (status !== 200) {
-			logHttpResponse(response);
-			throw new Error(
-				`Could not add data to integration field catalog ${catalogId}`,
-			);
+			logHttpResponse(response)
+			throw new Error(`Could not add data to integration field catalog ${catalogId}`)
 		}
 	}
 
@@ -125,35 +116,29 @@ export class IntegrationFieldsClient {
 		customTypeId,
 		fieldId,
 	}: {
-		catalogId: string;
-		customTypeId: string;
-		fieldId: string;
+		catalogId: string
+		customTypeId: string
+		fieldId: string
 	}): Promise<void> {
-		const customType =
-			await this.customTypesApiClient.getTypeById(customTypeId);
+		const customType = await this.customTypesApiClient.getTypeById(customTypeId)
 
-		const field = customType.json.Main[fieldId];
+		const field = customType.json.Main[fieldId]
 		if (!field || field.type !== "IntegrationFields") {
-			throw new Error(
-				`Field ${fieldId} not found or is not an Integration Field`,
-			);
+			throw new Error(`Field ${fieldId} not found or is not an Integration Field`)
 		}
 
-		field.config = { ...(field.config ?? {}), catalog: catalogId };
+		field.config = { ...field.config, catalog: catalogId }
 
-		await this.customTypesApiClient.createCustomTypes([customType]);
+		await this.customTypesApiClient.createCustomTypes([customType])
 	}
 
-	async setupIntegrationFields(
-		integrationFields: IntegrationFieldConfig[],
-	): Promise<void> {
+	async setupIntegrationFields(integrationFields: IntegrationFieldConfig[]): Promise<void> {
 		for (const integrationField of integrationFields) {
-			const { name, description, customTypeId, fieldId, data } =
-				integrationField;
+			const { name, description, customTypeId, fieldId, data } = integrationField
 
-			const catalogId = await this.addCatalog({ name, description });
-			await this.addDataToCatalog({ catalogId, data });
-			await this.addToCustomType({ catalogId, customTypeId, fieldId });
+			const catalogId = await this.addCatalog({ name, description })
+			await this.addDataToCatalog({ catalogId, data })
+			await this.addToCustomType({ catalogId, customTypeId, fieldId })
 		}
 	}
 }

package/src/clients/manageV2.ts

@@ -1,26 +1,23 @@
-import axios, { AxiosInstance, AxiosResponse } from "axios";
-import jwt from "jsonwebtoken";
+import type { AxiosInstance, AxiosResponse } from "axios"
+import axios from "axios"
+import jwt from "jsonwebtoken"
 
-import { ManageV2Config } from "../types";
+import type { ManageV2Config } from "../types"
+import { extractCookie } from "../utils/cookies"
 
-import { extractCookie } from "../utils/cookies";
+const ManageV2StaticAuthor = "prismic-e2e-tests-utils"
 
-const ManageV2StaticAuthor = "prismic-e2e-tests-utils";
-
-/**
- * Client for interacting with ManageV2 routes to perform operations on
- * repositories.
- */
+/** Client for interacting with ManageV2 routes to perform operations on repositories. */
 export class ManageV2Client {
-	readonly client: AxiosInstance; // Not private to have it available on tests
-	private token: string | null = null;
+	readonly client: AxiosInstance // Not private to have it available on tests
+	private token: string | null = null
 
 	/**
 	 * @param baseURL - The base URL of the Wroom app. ex: https://prismic.io
 	 * @param config - ManageV2 configuration variable to call ManageV2.
 	 */
 	constructor(baseUrl: string, config?: ManageV2Config | undefined) {
-		this.token = config ? this.generateToken(config) : null;
+		this.token = config ? this.generateToken(config) : null
 
 		this.client = axios.create({
 			baseURL: `${baseUrl}/manageroutes/`,
@@ -30,109 +27,91 @@ export class ManageV2Client {
 				"User-Agent": "prismic-cli/prismic-e2e-tests-utils",
 				Authorization: `Bearer ${this.token}`,
 			},
-		});
+		})
 
 		// cookies are not forwarded automatically in a non-browser env
 		this.client.interceptors.response.use((response) => {
-			const cookies = response.headers["set-cookie"];
+			const cookies = response.headers["set-cookie"]
 			if (cookies && extractCookie(cookies, "SESSION")) {
-				this.client.defaults.headers["Cookie"] = cookies;
+				this.client.defaults.headers["Cookie"] = cookies
 			}
 
-			return response;
-		});
+			return response
+		})
 	}
 
 	/**
-	 * 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:
+	 * The function generates a JWT token using the provided configuration parameters.
 	 *
-	 * @returns A JSON Web Token (JWT) is being returned by the `generateToken`
-	 *   function. The token is signed using the provided `config.secret` with the
-	 *   HS256 algorithm and includes the specified audience and issuer values.
+	 * @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 HS256 algorithm and includes the specified
+	 *   audience and issuer values.
 	 */
 	private generateToken(config: ManageV2Config): string {
 		return jwt.sign({}, config.secret, {
 			algorithm: "HS256",
 			audience: config.audience,
 			issuer: "prismic.io",
-		});
+		})
 	}
 
 	/**
-	 * The function `assertTokenExist` checks if a token exists before executing a
-	 * given function.
+	 * The function `assertTokenExist` checks if a token exists before executing a given function.
 	 *
-	 * @param f - The `assertTokenExist` function takes a function `f` as a
-	 *   parameter. This function `f` should accept a parameter of type
-	 *   `Parameters` and return a Promise that resolves to an AxiosResponse. The
-	 *   `assertTokenExist` function ensures that a token is not null before
+	 * @param f - The `assertTokenExist` function takes a function `f` as a parameter. This function
+	 *   `f` should accept a parameter of type `Parameters` and return a Promise that resolves to an
+	 *   AxiosResponse. The `assertTokenExist` function ensures that a token is not null before
 	 *   calling the provided
-	 *
-	 * @returns A function is being returned that takes a parameter of type
-	 *   Parameters and checks if the token is null. If the token is null, an
-	 *   error is thrown. Otherwise, the function f is called with the provided
-	 *   parameters.
+	 * @returns A function is being returned that takes a parameter of type Parameters and checks if
+	 *   the token is null. If the token is null, an error is thrown. Otherwise, the function f is
+	 *   called with the provided parameters.
 	 */
-	private assertTokenExist<Parameters>(
-		f: (_: Parameters) => Promise<AxiosResponse>,
-	) {
+	private assertTokenExist<Parameters>(f: (_: Parameters) => Promise<AxiosResponse>) {
 		return (params: Parameters) => {
 			if (this.token === null) {
-				throw new Error(
-					"Undefined configuration for ManageV2 while trying to use it's routes",
-				);
+				throw new Error("Undefined configuration for ManageV2 while trying to use it's routes")
 			} else {
-				return f(params);
+				return f(params)
 			}
-		};
+		}
 	}
 
 	getBaseURL(): string {
-		return this.client.getUri();
+		return this.client.getUri()
 	}
 
 	/**
-	 * The function `toggleRolePerLocal` enables or disables the RolesPerLocale
-	 * workflow
+	 * The function `toggleRolePerLocal` enables or disables the RolesPerLocale workflow
 	 *
 	 * @param repository - The Repository name
 	 * @param enabled - The feature new status
 	 */
-	toggleRolePerLocal = this.assertTokenExist(
-		(params: { repository: string; enabled: boolean }) => {
-			return this.client.post("/repository/toggleRolesPerLocale", {
-				domain: params.repository,
-				enabled: params.enabled,
-				author: ManageV2StaticAuthor,
-			});
-		},
-	);
+	toggleRolePerLocal = this.assertTokenExist((params: { repository: string; enabled: boolean }) => {
+		return this.client.post("/repository/toggleRolesPerLocale", {
+			domain: params.repository,
+			enabled: params.enabled,
+			author: ManageV2StaticAuthor,
+		})
+	})
 
 	/**
-	 * The function `toggleCustomRoles` enables or disables the CustomRoles
-	 * workflow
+	 * 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,
-			});
-		},
-	);
+	toggleCustomRoles = this.assertTokenExist((params: { repository: string; enabled: boolean }) => {
+		return this.client.post("/repository/toggleCustomRoles", {
+			domain: params.repository,
+			enabled: params.enabled,
+			author: ManageV2StaticAuthor,
+		})
+	})
 
 	/**
-	 * The function `toggleIntegrationFields` enables or disables the Integration
-	 * Fields feature
+	 * The function `toggleIntegrationFields` enables or disables the Integration Fields feature
 	 *
 	 * @param repository - The Repository name
 	 * @param enabled - The feature new status
@@ -143,17 +122,17 @@ export class ManageV2Client {
 				domain: params.repository,
 				enabled: params.enabled,
 				author: ManageV2StaticAuthor,
-			});
+			})
 		},
-	);
+	)
 
 	/**
 	 * The function `changePlan` changes the plan of a repository the database
 	 *
 	 * @param repository - The Repository name
 	 * @param newPlanId - The new planId
-	 * @param bypassManualBilling - Beware that using this will not verify that
-	 *   the database and Stripe are in sync
+	 * @param bypassManualBilling - Beware that using this will not verify that the database and
+	 *   Stripe are in sync
 	 */
 	changePlan = this.assertTokenExist(
 		({
@@ -161,24 +140,21 @@ export class ManageV2Client {
 			newPlanId,
 			bypassManualBilling = false,
 		}: {
-			repository: string;
-			newPlanId: string;
-			bypassManualBilling?: boolean;
+			repository: string
+			newPlanId: string
+			bypassManualBilling?: boolean
 		}) => {
-			return this.client.post(
-				`/repository/changePlan?bypassManualBilling=${bypassManualBilling}`,
-				{
-					domain: repository,
-					newPlan: newPlanId,
-					author: ManageV2StaticAuthor,
-				},
-			);
+			return this.client.post(`/repository/changePlan?bypassManualBilling=${bypassManualBilling}`, {
+				domain: repository,
+				newPlan: newPlanId,
+				author: ManageV2StaticAuthor,
+			})
 		},
-	);
+	)
 
 	/**
-	 * The function `addUserToRepository` adds a user corresponding to the email
-	 * to the given repository
+	 * The function `addUserToRepository` adds a user corresponding to the email to the given
+	 * repository
 	 *
 	 * @param repository - The Repository name
 	 * @param email - The user email
@@ -189,13 +165,13 @@ export class ManageV2Client {
 				domain: repository,
 				email: email,
 				author: ManageV2StaticAuthor,
-			});
+			})
 		},
-	);
+	)
 
 	/**
-	 * The function `removeUserFromRepository` removes a user corresponding to the
-	 * email from the given repository
+	 * The function `removeUserFromRepository` removes a user corresponding to the email from the
+	 * given repository
 	 *
 	 * @param repository - The Repository name
 	 * @param email - The user email
@@ -206,7 +182,7 @@ export class ManageV2Client {
 				domain: repository,
 				email: email,
 				author: ManageV2StaticAuthor,
-			});
+			})
 		},
-	);
+	)
 }

package/src/clients/migrationApi.ts

@@ -1,62 +1,58 @@
-import { logPlaywrightApiResponse } from "../utils/log";
-
-import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
+import { logPlaywrightApiResponse } from "../utils/log"
+import type { AuthServerToken } from "./apiClient"
+import { AuthenticatedApiClient } from "./apiClient"
 
 export type MigrationApiDocumentPayload = {
-	uid?: string | null;
-	type: string;
-	lang: string;
-	title: string;
-	tags?: string[];
-	alternate_language_id?: string;
-	data: Record<string, unknown>;
+	uid?: string | null
+	type: string
+	lang: string
+	title: string
+	tags?: string[]
+	alternate_language_id?: string
+	data: Record<string, unknown>
 	// if true, the document will be part of the documents list instead of in the migration release
-	inDocuments?: boolean;
-};
+	inDocuments?: boolean
+}
 export type MigrationApiDocumentResponse = {
-	id: string;
-	type: string;
-	lang: string;
-	title: string;
-	uid?: string;
-};
+	id: string
+	type: string
+	lang: string
+	title: string
+	uid?: string
+}
 
 export class MigrationApiClient extends AuthenticatedApiClient {
 	/**
-	 * @example To instantiate the class:
+	 * @example
+	 * 	To instantiate the class:
 	 *
-	 * ```js
-	 * new MigrationApiClient("https://migration.prismic.io", {
+	 * 	```js
+	 * 	new MigrationApiClient("https://migration.prismic.io", {
 	 * 	authToken: "my-secret-token",
 	 * 	repository: "my-repo-name",
-	 * });
-	 * ```
+	 * 	});
+	 * 	```
 	 *
-	 * @param baseURL - the api base URL like https://migration.prismic.io
+	 * @param baseURL - The api base URL like https://migration.prismic.io
 	 * @param config - Optional configuration
 	 *
-	 *   - {@link config.authToken}: Api token generated from the auth service or a
-	 *       function to fetch it when it's needed.
+	 *   - {@link config.authToken}: Api token generated from the auth service or a function to fetch it
+	 *     when it's needed.
 	 *   - {@link config.repository}: Repository name.
 	 */
-	constructor(
-		baseURL: string,
-		config: { authToken: AuthServerToken; repository: string },
-	) {
-		super(baseURL, config.authToken, { repository: config.repository });
+	constructor(baseURL: string, config: { authToken: AuthServerToken; repository: string }) {
+		super(baseURL, config.authToken, { repository: config.repository })
 	}
 
-	async createDocument(
-		data: MigrationApiDocumentPayload,
-	): Promise<MigrationApiDocumentResponse> {
-		const context = await this.getContext();
-		const result = await context.post("documents", { data });
+	async createDocument(data: MigrationApiDocumentPayload): Promise<MigrationApiDocumentResponse> {
+		const context = await this.getContext()
+		const result = await context.post("documents", { data })
 
 		if (201 !== result.status()) {
-			await logPlaywrightApiResponse(result);
-			throw new Error("Could not create a document with the migration api.");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not create a document with the migration api.")
 		}
 
-		return result.json();
+		return result.json()
 	}
 }