@prismicio/e2e-tests-utils 1.18.0 → 1.19.0

package/src/types.ts

@@ -1,51 +1,51 @@
 export type UrlConfig = {
 	/** Prismic base url */
-	baseURL: string;
+	baseURL: string
 	/** Custom types api base url */
-	customTypesApi: string;
+	customTypesApi: string
 	/** Auth service api base url */
-	authenticationApi: string;
+	authenticationApi: string
 	/** Prismic migration api base url */
-	migrationApi?: string;
+	migrationApi?: string
 	/** Asset api base url */
-	assetApi: string;
+	assetApi: string
 	/** Integration fields api base url */
-	integrationFieldApi?: string;
-};
+	integrationFieldApi?: string
+}
 
 export type AuthConfig = {
-	email: string;
-	password: string;
-};
+	email: string
+	password: string
+}
 
 export type ManageV2Config = {
-	secret: string;
-	audience: string;
-};
+	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;
-	cluster?: string;
-	environment?: string;
-	integrationFieldsConfig?: IntegrationFieldConfig[];
-};
+	urlConfig: UrlConfig | string
+	authConfig: AuthConfig
+	manageV2Config?: ManageV2Config
+	cluster?: string
+	environment?: string
+	integrationFieldsConfig?: IntegrationFieldConfig[]
+}
 
 export type IntegrationFieldData = {
-	id: string;
-	title: string;
-	description: string;
-	blob: Record<string, unknown>;
-};
+	id: string
+	title: string
+	description: string
+	blob: Record<string, unknown>
+}
 
 export type IntegrationFieldConfig = {
-	name: string;
-	description: string;
-	customTypeId: string;
-	fieldId: string;
-	data: IntegrationFieldData[];
-};
+	name: string
+	description: string
+	customTypeId: string
+	fieldId: string
+	data: IntegrationFieldData[]
+}

package/src/utils/cookies.ts

@@ -1,4 +1,4 @@
-import { AxiosHeaderValue } from "axios";
+import type { AxiosHeaderValue } from "axios"
 
 /**
  * Extract the value of a specific cookie from Axios cookies.
@@ -10,21 +10,21 @@ export const extractCookie = (
 	cookies: AxiosHeaderValue | undefined,
 	cookieName: string,
 ): string | undefined => {
-	const regex = new RegExp(`${cookieName}=([^;]+)`, "i"); // 'i' flag for case-insensitivity
+	const regex = new RegExp(`${cookieName}=([^;]+)`, "i") // 'i' flag for case-insensitivity
 
 	if (typeof cookies === "string") {
-		const match = cookies.match(regex);
+		const match = cookies.match(regex)
 
-		return match ? match[1] : undefined;
+		return match ? match[1] : undefined
 	}
 	if (Array.isArray(cookies)) {
 		for (const cookie of cookies) {
-			const match = cookie.match(regex);
+			const match = cookie.match(regex)
 			if (match) {
-				return match[1];
+				return match[1]
 			}
 		}
 	}
 
-	return undefined;
-};
+	return undefined
+}

package/src/utils/envVariableManager.ts

@@ -1,35 +1,35 @@
 /**
- * Manage a list of strings within an environment variable. This is useful to
- * share data across different test phases (setup, teardown, test execution) as
- * most test frameworks run these in independent states
+ * Manage a list of strings within an environment variable. This is useful to share data across
+ * different test phases (setup, teardown, test execution) as most test frameworks run these in
+ * independent states
  */
 export class EnvVariableManager {
 	constructor(private variableName: string) {}
 
-	/** add a string and persist it in the environment variable */
+	/** Add a string and persist it in the environment variable */
 	add(value: string): void {
-		const existingValues = this.getAll();
-		existingValues.push(value);
+		const existingValues = this.getAll()
+		existingValues.push(value)
 
-		this.setAll(existingValues);
+		this.setAll(existingValues)
 	}
 
-	/** remove a string from the environment variable */
+	/** Remove a string from the environment variable */
 	remove(value: string): void {
-		const existingValues = this.getAll();
-		const updatedValues = existingValues.filter((item) => item !== value);
+		const existingValues = this.getAll()
+		const updatedValues = existingValues.filter((item) => item !== value)
 
-		this.setAll(updatedValues);
+		this.setAll(updatedValues)
 	}
 
-	/** return all items stored in the environment variable */
+	/** Return all items stored in the environment variable */
 	getAll(): string[] {
-		const value = process.env[this.variableName] || "[]";
+		const value = process.env[this.variableName] || "[]"
 
-		return JSON.parse(value);
+		return JSON.parse(value)
 	}
 
 	private setAll(values: string[]): void {
-		process.env[this.variableName] = JSON.stringify(values);
+		process.env[this.variableName] = JSON.stringify(values)
 	}
 }

package/src/utils/log.ts

@@ -1,43 +1,39 @@
-import { APIResponse } from "@playwright/test";
-import { AxiosResponse } from "axios";
-import { createLogger, format, transports } from "winston";
+import type { APIResponse } from "@playwright/test"
+import type { AxiosResponse } from "axios"
+import { createLogger, format, transports } from "winston"
 
 export const logHttpResponse = (response: AxiosResponse): void => {
-	const { status, data } = response;
-	const { baseURL = "", url = "" } = response.config;
+	const { status, data } = response
+	const { baseURL = "", url = "" } = response.config
 	// make sure the url always shows baseURL + path.
 	// Depending on how the AxiosInstance was called, the url already contains the baseURL
-	const fullUrl = url.startsWith("http") ? url : `${baseURL}/${url}`;
+	const fullUrl = url.startsWith("http") ? url : `${baseURL}/${url}`
 
-	logger.info(
-		`Call to ${fullUrl} failed, received [${status}] ${JSON.stringify(data)}`,
-	);
-};
+	logger.info(`Call to ${fullUrl} failed, received [${status}] ${JSON.stringify(data)}`)
+}
 
-export const logPlaywrightApiResponse = async (
-	response: APIResponse,
-): Promise<void> => {
+export const logPlaywrightApiResponse = async (response: APIResponse): Promise<void> => {
 	logger.info(
 		`Call to ${response.url()} failed, received [${response.status()}] ${JSON.stringify(
 			await response.text(),
 		)}`,
-	);
-};
+	)
+}
 
-const { combine, printf } = format;
+const { combine, printf } = format
 
 const customFormat = printf(({ message, durationMs }) => {
-	const baseMsg = `[test data] ${message}`;
+	const baseMsg = `[test data] ${message}`
 	if (durationMs) {
-		return `${baseMsg} in ${durationMs}ms`;
+		return `${baseMsg} in ${durationMs}ms`
 	}
 
-	return baseMsg;
-});
+	return baseMsg
+})
 
 export const logger = createLogger({
 	silent: process.env["prismic_e2e_tests_utils_silent"] === "true",
 	level: process.env["prismic_e2e_tests_utils_log_level"] || "info",
 	format: combine(customFormat),
 	transports: [new transports.Console()],
-});
+})

package/src/utils/random.ts

@@ -1,14 +1,13 @@
-import { createHash } from "crypto";
+import { createHash } from "crypto"
 
 /**
  * Generate a random string
  *
- * @param length - max 32
- *
+ * @param length - Max 32
  * @returns
  */
 export const randomString = (length = 16): string => {
-	const uniqueInput = Math.random().toString();
+	const uniqueInput = Math.random().toString()
 
-	return createHash("md5").update(uniqueInput).digest("hex").slice(0, length);
-};
+	return createHash("md5").update(uniqueInput).digest("hex").slice(0, length)
+}

package/src/utils/strings.ts

@@ -2,16 +2,14 @@
  * Convert string to a slug suitable for Integration Fields.
  *
  * @param str - The input string to slugify.
- *
- * @returns The slugified string (empty string if no valid characters remain).
- *
- *   Inspired by the Wroom slugify function:
+ * @returns The slugified string (empty string if no valid characters remain). Inspired by the Wroom
+ *   slugify function:
  *   https://github.com/prismicio/wroom/blob/09452b75fa5fabdaf3cd81383741cd02d30c9c9f/subprojects/common/app/utils/String.scala#L55
  */
 export const slugify = (str: string): string => {
-	const noWhitespace = str.trim().replace(/ /g, "_");
-	const normalized = noWhitespace.normalize("NFD").replace(/\p{M}+/gu, "");
-	const slug = normalized.replace(/[^A-Za-z0-9_-]/g, "").toLowerCase();
+	const noWhitespace = str.trim().replace(/ /g, "_")
+	const normalized = noWhitespace.normalize("NFD").replace(/\p{M}+/gu, "")
+	const slug = normalized.replace(/[^A-Za-z0-9_-]/g, "").toLowerCase()
 
-	return slug || "";
-};
+	return slug || ""
+}

package/src/utils/urls.ts

@@ -1,28 +1,26 @@
 /**
  * Build a repository base url from the prismic base url
  *
- * @param baseUrl - prismic base url like prismic.io
- * @param repository - the repository name
- *
- * @returns the repository url like https://my-repo.prismic.io
+ * @param baseUrl - Prismic base url like prismic.io
+ * @param repository - The repository name
+ * @returns The repository url like https://my-repo.prismic.io
  */
 export function getRepositoryUrl(baseUrl: string, repository: string): string {
-	const url = new URL(baseUrl);
-	url.hostname = `${repository}.${url.hostname}`;
+	const url = new URL(baseUrl)
+	url.hostname = `${repository}.${url.hostname}`
 
-	return url.toString();
+	return url.toString()
 }
 
 /**
- * Prevent issues when building urls using `URL` that contain sub path without
- * trailing slashes.
+ * Prevent issues when building urls using `URL` that contain sub path without trailing slashes.
  *
- * @returns the original url with a trailing slash, if needed.
+ * @returns The original url with a trailing slash, if needed.
  */
 export function appendTrailingSlash(url: string): string {
 	if (!url.endsWith("/")) {
-		return url + "/";
+		return url + "/"
 	}
 
-	return url;
+	return url
 }

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}

package/dist/utils/cookies.d.ts

@@ -1,8 +0,0 @@
-import { AxiosHeaderValue } from "axios";
-/**
- * Extract the value of a specific cookie from Axios cookies.
- *
- * @param cookies - Axios cookies, can be a string or an array
- * @param cookieName - The name of the cookie to extract.
- */
-export declare const extractCookie: (cookies: AxiosHeaderValue | undefined, cookieName: string) => string | undefined;

package/dist/utils/envVariableManager.d.ts

@@ -1,16 +0,0 @@
-/**
- * Manage a list of strings within an environment variable. This is useful to
- * share data across different test phases (setup, teardown, test execution) as
- * most test frameworks run these in independent states
- */
-export declare class EnvVariableManager {
-    private variableName;
-    constructor(variableName: string);
-    /** add a string and persist it in the environment variable */
-    add(value: string): void;
-    /** remove a string from the environment variable */
-    remove(value: string): void;
-    /** return all items stored in the environment variable */
-    getAll(): string[];
-    private setAll;
-}

package/dist/utils/log.d.ts

@@ -1,5 +0,0 @@
-import { APIResponse } from "@playwright/test";
-import { AxiosResponse } from "axios";
-export declare const logHttpResponse: (response: AxiosResponse) => void;
-export declare const logPlaywrightApiResponse: (response: APIResponse) => Promise<void>;
-export declare const logger: import("winston").Logger;

package/dist/utils/random.d.ts

@@ -1,8 +0,0 @@
-/**
- * Generate a random string
- *
- * @param length - max 32
- *
- * @returns
- */
-export declare const randomString: (length?: number) => string;

package/dist/utils/strings.d.ts

@@ -1,11 +0,0 @@
-/**
- * Convert string to a slug suitable for Integration Fields.
- *
- * @param str - The input string to slugify.
- *
- * @returns The slugified string (empty string if no valid characters remain).
- *
- *   Inspired by the Wroom slugify function:
- *   https://github.com/prismicio/wroom/blob/09452b75fa5fabdaf3cd81383741cd02d30c9c9f/subprojects/common/app/utils/String.scala#L55
- */
-export declare const slugify: (str: string) => string;

package/dist/utils/urls.d.ts

@@ -1,16 +0,0 @@
-/**
- * Build a repository base url from the prismic base url
- *
- * @param baseUrl - prismic base url like prismic.io
- * @param repository - the repository name
- *
- * @returns the repository url like https://my-repo.prismic.io
- */
-export declare function getRepositoryUrl(baseUrl: string, repository: string): string;
-/**
- * Prevent issues when building urls using `URL` that contain sub path without
- * trailing slashes.
- *
- * @returns the original url with a trailing slash, if needed.
- */
-export declare function appendTrailingSlash(url: string): string;