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

package/src/clients/assetApi.ts

@@ -0,0 +1,76 @@
+import { logPlaywrightApiResponse } from "../utils/log";
+
+import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
+
+export interface AssetApiCreatePayload {
+	name: string;
+	mimeType: string;
+	buffer: Buffer;
+}
+
+export interface AssetApiCreateResponse {
+	id: string;
+	url: string;
+	filename: string;
+	size: number;
+	width: number;
+	height: number;
+	last_modified: number;
+	kind: string;
+	extension: string;
+	created_at: number;
+	uploader_id: string;
+	tags: string[];
+}
+
+export class AssetApiClient extends AuthenticatedApiClient {
+	/**
+	 * @example To instantiate the class:
+	 *
+	 * ```js
+	 * new AssetApiClient("https://asset-api.prismic.io", {
+	 * 	authToken: "my-secret-token",
+	 * 	repository: "my-repo-name",
+	 * });
+	 * ```
+	 *
+	 * @param baseURL - The API base URL, such as https://asset-api.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.repository}: Repository name.
+	 */
+	constructor(
+		baseURL: string,
+		config: { authToken: AuthServerToken; repository: string },
+	) {
+		super(baseURL, config.authToken, { repository: config.repository });
+	}
+
+	/**
+	 * Uploads an asset file to the server.
+	 *
+	 * @param data - The payload containing the file and filename.
+	 *
+	 * @returns The API response containing asset information.
+	 *
+	 * @throws An error if the upload fails.
+	 */
+	async createAsset(
+		data: AssetApiCreatePayload,
+	): Promise<AssetApiCreateResponse> {
+		const context = await this.getContext();
+
+		const result = await context.post("assets", {
+			multipart: { file: data },
+		});
+
+		if (200 !== result.status()) {
+			await logPlaywrightApiResponse(result);
+			throw new Error("Could not upload the asset with the asset API.");
+		}
+
+		return result.json();
+	}
+}

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;
 			}
 

package/src/clients/wroom.ts

@@ -45,7 +45,7 @@ export class WroomClient {
 		// 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, "prismic-auth")) {
+			if (cookies && extractCookie(cookies, "SESSION")) {
 				this.client.defaults.headers["Cookie"] = cookies;
 			}
 

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}`,
 		};
 	}
 
@@ -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,
 	) {}
 
@@ -121,6 +123,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 +340,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.
 	 *

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;
 };