@prismicio/e2e-tests-utils 1.12.0 → 1.14.0

package/src/clients/coreApi.ts

@@ -8,6 +8,12 @@ type Language = {
 	is_master: boolean;
 };
 
+export type Release = {
+	id: string;
+	label: string;
+	migration: boolean;
+};
+
 export type CoreApiDocumentCreationPayload = {
 	title: string;
 	locale?: string;
@@ -47,6 +53,22 @@ export type CoreApiDocumentCreationResponse = {
 	}[];
 };
 
+export type CoreApiDocumentsPayload = {
+	language?: string;
+	limit?: number;
+	statuses?: string[];
+	groupLangIds?: string[];
+};
+
+export type CoreApiDocumentsResponse = {
+	total: number;
+	cursor: string;
+	results: CoreApiDocumentCreationResponse[];
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type CoreApiDocumentData = Record<string, any>;
+
 export class CoreApiClient extends AuthenticatedApiClient {
 	/**
 	 * @example To instantiate the class:
@@ -82,6 +104,28 @@ export class CoreApiClient extends AuthenticatedApiClient {
 		return (await result.json()).languages;
 	}
 
+	/**
+	 * Retrieves all releases, including the migration release.
+	 *
+	 * @returns An array of release metadata.
+	 */
+	async getReleases(): Promise<Release[]> {
+		const profiler = logger.startTimer();
+		const context = await this.getContext();
+		const result = await context.get("core/releases", {
+			params: { include_migration_releases: true },
+		});
+
+		if (200 !== result.status() || !(await result.json()).results) {
+			await logPlaywrightApiResponse(result);
+			throw new Error("Could not get releases from the core api.");
+		}
+
+		profiler.done({ message: "retrieved releases" });
+
+		return (await result.json()).results;
+	}
+
 	async createDraft(
 		data: CoreApiDocumentCreationPayload,
 	): Promise<CoreApiDocumentCreationResponse> {
@@ -111,4 +155,63 @@ export class CoreApiClient extends AuthenticatedApiClient {
 			throw new Error(`Could not publish document with id ${documentId}`);
 		}
 	}
+
+	/**
+	 * Retrieves documents.
+	 *
+	 * @param args - Configure which documents are retrieved.
+	 *
+	 * @returns A paginated set of documents.
+	 */
+	async getDocuments(
+		args: CoreApiDocumentsPayload,
+	): Promise<CoreApiDocumentsResponse> {
+		const context = await this.getContext();
+		const result = await context.post("core/documents/search", {
+			data: args,
+		});
+
+		if (200 !== result.status()) {
+			await logPlaywrightApiResponse(result);
+			throw new Error("Could not search documents");
+		}
+
+		return result.json();
+	}
+
+	/**
+	 * Retrieves data for a specific document version.
+	 *
+	 * @param versionId - The document's version ID.
+	 *
+	 * @returns The document's version data.
+	 */
+	async getDocumentData(versionId: string): Promise<CoreApiDocumentData> {
+		const context = await this.getContext();
+		const result = await context.get(`core/documents/data/${versionId}`);
+
+		if (200 !== result.status()) {
+			await logPlaywrightApiResponse(result);
+			throw new Error("Could not retrieve document data");
+		}
+
+		return result.json();
+	}
+
+	/**
+	 * Publishes a release.
+	 *
+	 * @param id - The ID of the release.
+	 *
+	 * @returns A Promise that resolves when the release is published.
+	 */
+	async publishRelease(id: string): Promise<void> {
+		const context = await this.getContext();
+		const result = await context.post(`core/releases/${id}/publish`);
+
+		if (200 !== result.status()) {
+			await logPlaywrightApiResponse(result);
+			throw new Error("Could not publish release ${id}");
+		}
+	}
 }

package/src/index.ts

@@ -1,5 +1,7 @@
 export * from "./managers/repositories";
 export * from "./managers/repository";
+export * from "./clients/coreApi";
 export * from "./clients/contentApi";
+export * from "./clients/assetApi";
 export * from "./clients/migrationApi";
 export * from "./types";

package/src/managers/repository.ts

@@ -15,6 +15,10 @@ import {
 	CoreApiClient,
 	CoreApiDocumentCreationPayload,
 	CoreApiDocumentCreationResponse,
+	CoreApiDocumentData,
+	CoreApiDocumentsPayload,
+	CoreApiDocumentsResponse,
+	Release,
 } from "../clients/coreApi";
 import { CustomTypesApiClient } from "../clients/customTypesApi";
 import { IntegrationFieldsClient } from "../clients/integrationFields";
@@ -279,6 +283,19 @@ export class RepositoryManager {
 		profiler.done({ message: `default locale set to '${locale}'` });
 	}
 
+	/**
+	 * Retrieves documents.
+	 *
+	 * @param args - Configure which documents are retrieved.
+	 *
+	 * @returns A paginated set of documents.
+	 */
+	async getDocuments(
+		args: CoreApiDocumentsPayload,
+	): Promise<CoreApiDocumentsResponse> {
+		return this.coreApiClient.getDocuments(args);
+	}
+
 	/**
 	 * Creates a release.
 	 *
@@ -298,10 +315,50 @@ export class RepositoryManager {
 		return response.data;
 	}
 
+	/**
+	 * Retrieves the migration release.
+	 *
+	 * @returns The migration relese metadata.
+	 */
+	async getMigrationRelease(): Promise<Release> {
+		const releases = await this.coreApiClient.getReleases();
+		const migrationRelease = releases.find((release) => release.migration);
+		if (!migrationRelease) {
+			throw new Error(`The repository does not have a migration release`);
+		}
+
+		return migrationRelease;
+	}
+
+	/**
+	 * Publishes a release.
+	 *
+	 * @param id - The ID of the release.
+	 *
+	 * @returns A Promise that resolves when the release is published and a new
+	 *   master ref is available.
+	 */
+	async publishRelease(id: string): Promise<void> {
+		const profiler = logger.startTimer();
+
+		const contentApi = this.getContentApiClient();
+		const masterRef = await contentApi.getMasterRef();
+		await this.coreApiClient.publishRelease(id);
+		await expect
+			.poll(async () => contentApi.getMasterRef(), {
+				timeout: 10_000,
+				message: "Waiting for new master ref to be available",
+			})
+			.not.toBe(masterRef);
+
+		profiler.done({
+			message: `release '${id}' published and new master ref available`,
+		});
+	}
+
 	/**
 	 * Deletes a repository release.
 	 *
-	 * @param repository - The name of the repository.
 	 * @param id - The ID of the release to be deleted.
 	 */
 	async deleteRelease(id: string): Promise<void> {
@@ -753,6 +810,17 @@ export class RepositoryManager {
 		return result;
 	}
 
+	/**
+	 * Retrieves data for a specific document version.
+	 *
+	 * @param versionId - The document's version ID.
+	 *
+	 * @returns The document's version data.
+	 */
+	async getDocumentData(versionId: string): Promise<CoreApiDocumentData> {
+		return await this.coreApiClient.getDocumentData(versionId);
+	}
+
 	async setupIntegrationFields(
 		integrationFields: IntegrationFieldConfig[],
 	): Promise<void> {