@prismicio/e2e-tests-utils 1.12.0-alpha.1 → 1.12.0-alpha.3

package/src/clients/integrationFields.ts

@@ -0,0 +1,166 @@
+import axios, { AxiosInstance } from "axios";
+
+import { IntegrationFieldConfig, IntegrationFieldData } from "../types";
+
+import { logHttpResponse } from "../utils/log";
+import { toSnakeCase } from "../utils/strings";
+
+import { CustomTypesApiClient } from "./customTypesApi";
+import { WroomClient } from "./wroom";
+
+/**
+ * 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> = {};
+
+	constructor(
+		baseURL: string,
+		config: {
+			customTypesApiClient: CustomTypesApiClient;
+			wroomClient: WroomClient;
+			repository: string;
+		},
+	) {
+		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 client = axios.create({
+			baseURL: `${this.baseURL}/if/`,
+			withCredentials: true,
+			validateStatus: () => true,
+			headers: {
+				"User-Agent": "prismic-cli/prismic-e2e-tests-utils",
+				Authorization: `Bearer ${token}`,
+			},
+		});
+
+		return client;
+	}
+
+	private async addCatalog({
+		name,
+		description,
+	}: {
+		name: string;
+		description: string;
+	}): Promise<string> {
+		const response = await this.wroomClient.post(
+			this.repository,
+			"app/settings/integrationfields/pushcustom",
+			{
+				"catalog-name": name,
+				"catalog-description": description,
+			},
+		);
+
+		const { data, status } = response;
+		const success =
+			status === 200 ||
+			(status === 400 &&
+				(data as string).includes("Already existing integration field"));
+		if (!success) {
+			logHttpResponse(response);
+			throw new Error(`Could not add integration field catalog ${name}`);
+		}
+
+		return `${this.repository}--${toSnakeCase(name)}`;
+	}
+
+	private async createToken(catalogId: string): Promise<void> {
+		const response = await this.wroomClient.post(
+			this.repository,
+			`app/settings/integrationfields/pushcustom/${catalogId}/token`,
+		);
+
+		const { data: tokenData, status } = response;
+		if (status !== 200) {
+			logHttpResponse(response);
+			throw new Error(
+				`Could not create token for integration field catalog ${catalogId}`,
+			);
+		}
+
+		const token = tokenData[0];
+		this.tokens[catalogId] = token;
+
+		return token;
+	}
+
+	private async addDataToCatalog({
+		catalogId,
+		data,
+	}: {
+		catalogId: string;
+		data: IntegrationFieldData[];
+	}): Promise<void> {
+		const client = await this.getClient(catalogId);
+		const response = await client.post(
+			`/write/${catalogId}`,
+			JSON.stringify(data),
+		);
+
+		const { status } = response;
+		if (status !== 200) {
+			logHttpResponse(response);
+			throw new Error(
+				`Could not add data to integration field catalog ${catalogId}`,
+			);
+		}
+	}
+
+	private async addToCustomType({
+		catalogId,
+		customTypeId,
+		fieldId,
+	}: {
+		catalogId: string;
+		customTypeId: string;
+		fieldId: string;
+	}): Promise<void> {
+		const customType =
+			await this.customTypesApiClient.getTypeById(customTypeId);
+
+		const field = customType.json.Main[fieldId];
+		if (!field || field.type !== "IntegrationFields") {
+			throw new Error(
+				`Field ${fieldId} not found or is not an Integration Field`,
+			);
+		}
+
+		field.config = { ...(field.config ?? {}), catalog: catalogId };
+
+		await this.customTypesApiClient.createCustomTypes([customType]);
+	}
+
+	async setupIntegrationFields(
+		integrationFields: IntegrationFieldConfig[],
+	): Promise<void> {
+		for (const integrationField of integrationFields) {
+			const catalogId = await this.addCatalog({
+				name: integrationField.name,
+				description: integrationField.description,
+			});
+			await this.addDataToCatalog({
+				catalogId,
+				data: integrationField.data,
+			});
+			await this.addToCustomType({
+				catalogId,
+				customTypeId: integrationField.customTypeId,
+				fieldId: integrationField.fieldId,
+			});
+		}
+	}
+}

package/src/managers/repositories.ts

@@ -4,6 +4,7 @@ import { AssetApiClient } from "../clients/assetApi";
 import { AuthenticationApiClient } from "../clients/authenticationApi";
 import { CoreApiClient } from "../clients/coreApi";
 import { CustomTypesApiClient } from "../clients/customTypesApi";
+import { IntegrationFieldsClient } from "../clients/integrationFields";
 import { ManageV2Client } from "../clients/manageV2";
 import { MigrationApiClient } from "../clients/migrationApi";
 import { WroomClient } from "../clients/wroom";
@@ -103,6 +104,10 @@ export class RepositoriesManager {
 			customTypesApi: `${protocol}://customtypes.${url.hostname}`,
 			migrationApi: `${protocol}://migration.${url.hostname}`,
 			assetApi: `${protocol}://asset-api.${url.hostname}`,
+			integrationFieldApi:
+				url.hostname === "prismic.io"
+					? `${protocol}://if-api.${url.hostname}/if`
+					: `${protocol}://api.${url.hostname}/if`, // IS THIS CORRECT FOR SQUAD ENV?
 		};
 	}
 
@@ -227,6 +232,13 @@ export class RepositoriesManager {
 			authToken,
 			repository,
 		});
+		const integrationFieldsClient = urlConfig.integrationFieldApi
+			? new IntegrationFieldsClient(urlConfig.integrationFieldApi, {
+					customTypesApiClient: customTypeClient,
+					wroomClient: this.wroomClient,
+					repository,
+				})
+			: undefined;
 
 		return new RepositoryManager(
 			repository,
@@ -237,6 +249,7 @@ export class RepositoriesManager {
 			migrationApiClient,
 			assetApiClient,
 			this.manageV2Client,
+			integrationFieldsClient,
 		);
 	}
 }

package/src/managers/repository.ts

@@ -6,6 +6,8 @@ import {
 	SharedSlice,
 } from "@prismicio/types-internal/lib/customtypes";
 
+import { IntegrationFieldConfig } from "../types";
+
 import { AssetApiClient } from "../clients/assetApi";
 import { AuthenticationApiClient } from "../clients/authenticationApi";
 import { ContentApiClient } from "../clients/contentApi";
@@ -15,6 +17,7 @@ import {
 	CoreApiDocumentCreationResponse,
 } from "../clients/coreApi";
 import { CustomTypesApiClient } from "../clients/customTypesApi";
+import { IntegrationFieldsClient } from "../clients/integrationFields";
 import { ManageV2Client } from "../clients/manageV2";
 import { MigrationApiClient } from "../clients/migrationApi";
 import { WroomClient } from "../clients/wroom";
@@ -32,6 +35,9 @@ export class RepositoryManager {
 		private readonly migrationApiClient: MigrationApiClient | undefined,
 		private readonly assetApiClient: AssetApiClient,
 		private readonly manageV2Client: ManageV2Client,
+		private readonly integrationFieldsClient:
+			| IntegrationFieldsClient
+			| undefined,
 	) {}
 
 	async configure(config: RepositoryConfig): Promise<void> {
@@ -94,6 +100,7 @@ export class RepositoryManager {
 
 		if (config.integrationFields) {
 			await this.toggleIntegrationFields(true);
+			await this.setupIntegrationFields(config.integrationFields);
 		}
 	}
 
@@ -745,6 +752,25 @@ export class RepositoryManager {
 
 		return result;
 	}
+
+	async setupIntegrationFields(
+		integrationFields: IntegrationFieldConfig[],
+	): Promise<void> {
+		const profiler = logger.startTimer();
+
+		if (!this.integrationFieldsClient) {
+			throw new Error(
+				"Integration Fields client not found. Did you provide a integration fields api url in the configuration?",
+			);
+		}
+
+		await this.integrationFieldsClient.setupIntegrationFields(
+			integrationFields,
+		);
+		profiler.done({
+			message: `Integration Fields setup`,
+		});
+	}
 }
 
 export type RepositoryConfig = {
@@ -756,7 +782,7 @@ export type RepositoryConfig = {
 	preview?: Preview;
 	rolePerLocal?: boolean;
 	customRoles?: boolean;
-	integrationFields?: boolean;
+	integrationFields?: IntegrationFieldConfig[];
 };
 
 export type Preview = {

package/src/types.ts

@@ -9,6 +9,8 @@ export type UrlConfig = {
 	migrationApi?: string;
 	/** Asset api base url */
 	assetApi: string;
+	/** Integration fields api base url */
+	integrationFieldApi?: string;
 };
 
 export type AuthConfig = {
@@ -30,4 +32,20 @@ export type SetupConfiguration = {
 	manageV2Config?: ManageV2Config;
 	cluster?: string;
 	environment?: string;
+	integrationFieldsConfig?: IntegrationFieldConfig[];
+};
+
+export type IntegrationFieldData = {
+	id: string;
+	title: string;
+	description: string;
+	blob: Record<string, unknown>;
+};
+
+export type IntegrationFieldConfig = {
+	name: string;
+	description: string;
+	customTypeId: string;
+	fieldId: string;
+	data: IntegrationFieldData[];
 };

package/src/utils/strings.ts

@@ -0,0 +1,15 @@
+/**
+ * Convert a string to snake_case
+ *
+ * @param str - The string to convert to snake_case
+ *
+ * @returns The snake_case string
+ */
+export const toSnakeCase = (str: string): string => {
+	return str
+		.replace(/[\s\-]+/g, "_")
+		.replace(/([a-z])([A-Z])/g, "$1_$2")
+		.toLowerCase()
+		.replace(/[^a-z0-9_]/g, "")
+		.replace(/^_+|_+$/g, "");
+};