@prismicio/e2e-tests-utils 1.18.0 → 1.19.0-pr.37.6283e4a

package/src/clients/coreApi.ts

@@ -1,111 +1,118 @@
-import { logPlaywrightApiResponse, logger } from "../utils/log";
-
-import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
+import { logPlaywrightApiResponse, logger } from "../utils/log"
+import type { AuthServerToken } from "./apiClient"
+import { AuthenticatedApiClient } from "./apiClient"
 
 type Language = {
-	id: string;
-	name: string;
-	is_master: boolean;
-};
+	id: string
+	name: string
+	is_master: boolean
+}
 
 export type Release = {
-	id: string;
-	label: string;
-	migration: boolean;
-};
+	id: string
+	label: string
+	migration: boolean
+}
 
 export type CoreApiDocumentCreationPayload = {
-	title: string;
-	locale?: string;
-	group_lang_id?: string;
-	release_id?: string;
-	integration_field_ids: string[];
-	data: Record<string, unknown>;
-	custom_type_id: string;
-	tags: string[];
-};
+	title: string
+	locale?: string
+	group_lang_id?: string
+	release_id?: string
+	integration_field_ids: string[]
+	data: Record<string, unknown>
+	custom_type_id: string
+	tags: string[]
+}
+
+export type CoreApiDocumentUpdatePayload = {
+	data: Record<string, unknown>
+	integration_field_ids: string[]
+	tags: string[]
+}
 
 export type CoreApiRepository = Record<string, unknown> & {
-	simulator_url?: string;
-};
+	simulator_url?: string
+}
 
 export type CoreApiDocumentCreationResponse = {
-	id: string;
-	group_lang_id: string;
-	custom_type_id: string;
-	locale: string;
-	language: { id: string; name: string };
-	first_publication_date: number | null;
-	last_publication_date: number | null;
-	title: string;
+	id: string
+	group_lang_id: string
+	custom_type_id: string
+	locale: string
+	language: { id: string; name: string }
+	first_publication_date: number | null
+	last_publication_date: number | null
+	title: string
 	versions: {
-		status: string;
-		version_id: string;
+		status: string
+		version_id: string
 		author: {
-			id: string;
-			first_name: string | null;
-			last_name: string | null;
-			email: string;
-		};
-		release_id: string | null;
-		last_modified_date: number;
-		tags: string[];
-		custom_type_label: string;
-		preview_summary?: string;
-		preview_image?: string;
-		uid?: string;
-	}[];
-};
+			id: string
+			first_name: string | null
+			last_name: string | null
+			email: string
+		}
+		release_id: string | null
+		last_modified_date: number
+		tags: string[]
+		custom_type_label: string
+		preview_summary?: string
+		preview_image?: string
+		uid?: string
+	}[]
+}
 
 export type CoreApiDocumentsPayload = {
-	language?: string;
-	limit?: number;
-	statuses?: string[];
-	groupLangIds?: string[];
-};
+	language?: string
+	limit?: number
+	statuses?: string[]
+	groupLangIds?: string[]
+}
 
 export type CoreApiDocumentsResponse = {
-	total: number;
-	cursor: string;
-	results: CoreApiDocumentCreationResponse[];
-};
+	total: number
+	cursor: string
+	results: CoreApiDocumentCreationResponse[]
+}
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type CoreApiDocumentData = Record<string, any>;
+export type CoreApiDocumentData = Record<string, any>
 
 export class CoreApiClient extends AuthenticatedApiClient {
 	/**
-	 * @example To instantiate the class:
+	 * @example
+	 * 	To instantiate the class:
 	 *
-	 * ```js
-	 * new CoreApiClient("https://my-repo.prismic.io", {
+	 * 	```js
+	 * 	new CoreApiClient("https://my-repo.prismic.io", {
 	 * 	authToken: "my-secret-token",
-	 * });
-	 * ```
+	 * 	});
+	 * 	```
 	 *
-	 * @param baseURL - the api base URL like https://my-repo.prismic.io
+	 * @param baseURL - The api base URL like https://my-repo.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.
 	 */
 	constructor(baseURL: string, config: AuthServerToken) {
-		super(baseURL, config);
+		super(baseURL, config)
 	}
 
 	async getLanguages(): Promise<Language[]> {
-		const profiler = logger.startTimer();
-		const context = await this.getContext();
-		const result = await context.get("core/repository");
+		const profiler = logger.startTimer()
+		const context = await this.getContext()
+		const result = await context.get("core/repository")
 
 		if (200 !== result.status() || !(await result.json()).languages) {
-			await logPlaywrightApiResponse(result);
-			throw new Error("Could not get languages from the core api.");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not get languages from the core api.")
 		}
 
-		profiler.done({ message: "retrieved languages configuration" });
+		profiler.done({ message: "retrieved languages configuration" })
 
-		return (await result.json()).languages;
+		return (await result.json()).languages
 	}
 
 	/**
@@ -114,49 +121,95 @@ export class CoreApiClient extends AuthenticatedApiClient {
 	 * @returns An array of release metadata.
 	 */
 	async getReleases(): Promise<Release[]> {
-		const profiler = logger.startTimer();
-		const context = await this.getContext();
+		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.");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not get releases from the core api.")
 		}
 
-		profiler.done({ message: "retrieved releases" });
+		profiler.done({ message: "retrieved releases" })
 
-		return (await result.json()).results;
+		return (await result.json()).results
 	}
 
 	async createDraft(
 		data: CoreApiDocumentCreationPayload,
 	): Promise<CoreApiDocumentCreationResponse> {
-		const context = await this.getContext();
+		const context = await this.getContext()
 		const result = await context.post("core/documents", {
 			data,
-		});
+		})
 
 		if (201 !== result.status()) {
-			await logPlaywrightApiResponse(result);
-			throw new Error("Could not create draft document");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not create draft document")
 		}
 
-		return result.json();
+		return result.json()
+	}
+
+	/**
+	 * Creates a new draft version of an existing document, on top of the given base version.
+	 *
+	 * @param documentId - The id of the document to update.
+	 * @param data - The new version payload in the core api format.
+	 * @param baseVersionId - The id of the version the draft is created from.
+	 * @returns The updated document, including the new version's id.
+	 */
+	async updateDraft(
+		documentId: string,
+		data: CoreApiDocumentUpdatePayload,
+		baseVersionId: string,
+	): Promise<CoreApiDocumentCreationResponse> {
+		const context = await this.getContext()
+		const result = await context.put(`core/documents/${documentId}/draft`, {
+			params: { base_version_id: baseVersionId },
+			data,
+		})
+
+		if (200 !== result.status()) {
+			await logPlaywrightApiResponse(result)
+			throw new Error(`Could not update draft for document with id ${documentId}`)
+		}
+
+		return result.json()
 	}
 
 	async publishDraft(documentId: string): Promise<void> {
-		const context = await this.getContext();
+		const context = await this.getContext()
 		const result = await context.patch(`core/documents/${documentId}/draft`, {
 			data: {
 				status: "published",
 			},
-		});
+		})
 
 		if (204 !== result.status()) {
-			await logPlaywrightApiResponse(result);
-			throw new Error(`Could not publish document with id ${documentId}`);
+			await logPlaywrightApiResponse(result)
+			throw new Error(`Could not publish document with id ${documentId}`)
+		}
+	}
+
+	/**
+	 * Unpublishes (archives) a live document.
+	 *
+	 * @param documentId - The id of the document to unpublish.
+	 */
+	async unpublishDocument(documentId: string): Promise<void> {
+		const context = await this.getContext()
+		const result = await context.patch(`core/documents/${documentId}/live`, {
+			data: {
+				status: "archived",
+			},
+		})
+
+		if (204 !== result.status()) {
+			await logPlaywrightApiResponse(result)
+			throw new Error(`Could not unpublish document with id ${documentId}`)
 		}
 	}
 
@@ -164,82 +217,77 @@ export class CoreApiClient extends AuthenticatedApiClient {
 	 * 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();
+	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");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not search documents")
 		}
 
-		return result.json();
+		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}`);
+		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");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not retrieve document data")
 		}
 
-		return result.json();
+		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`);
+		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}");
+			await logPlaywrightApiResponse(result)
+			throw new Error("Could not publish release ${id}")
 		}
 	}
 
 	async getRepository(): Promise<CoreApiRepository> {
-		const context = await this.getContext();
-		const result = await context.get(`core/repository`);
+		const context = await this.getContext()
+		const result = await context.get(`core/repository`)
 
 		if (200 !== result.status()) {
-			await logPlaywrightApiResponse(result);
-			throw new Error(`Could not get repository`);
+			await logPlaywrightApiResponse(result)
+			throw new Error(`Could not get repository`)
 		}
 
-		return result.json();
+		return result.json()
 	}
 
 	async updateRepository(data: CoreApiRepository): Promise<void> {
-		const context = await this.getContext();
+		const context = await this.getContext()
 		const result = await context.patch(`core/repository`, {
 			data,
-		});
+		})
 
 		if (204 !== result.status()) {
-			await logPlaywrightApiResponse(result);
-			throw new Error(`Could not update repository`);
+			await logPlaywrightApiResponse(result)
+			throw new Error(`Could not update repository`)
 		}
 	}
 }

package/src/clients/customTypesApi.ts

@@ -1,88 +1,72 @@
-import isEqual from "lodash.isequal";
+import type { DynamicCustomTypeModel, SharedSliceModel } from "@prismicio/types-internal"
+import isEqual from "lodash.isequal"
 
-import {
-	CustomType,
-	SharedSlice,
-} from "@prismicio/types-internal/lib/customtypes";
+import { logPlaywrightApiResponse, logger } from "../utils/log"
+import type { AuthServerToken } from "./apiClient"
+import { AuthenticatedApiClient } from "./apiClient"
 
-import { logPlaywrightApiResponse, logger } from "../utils/log";
+type ItemType = DynamicCustomTypeModel | SharedSliceModel
+type ItemTypePath = "customtypes" | "slices"
+type ItemOperation = "insert" | "update"
 
-import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
-
-type ItemType = CustomType | SharedSlice;
-type ItemTypePath = "customtypes" | "slices";
-type ItemOperation = "insert" | "update";
-
-/**
- * Client for interacting with the Custom Types API to create/update custom
- * types and slices.
- */
+/** Client for interacting with the Custom Types API to create/update custom types and slices. */
 export class CustomTypesApiClient extends AuthenticatedApiClient {
-	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 })
 	}
 
 	/**
 	 * Create or update a custom type or slice.
 	 *
-	 * @param endpoint - - The API endpoint for custom types or slices
-	 *   ('customtypes' or 'slices').
+	 * @param endpoint - - The API endpoint for custom types or slices ('customtypes' or 'slices').
 	 * @param data - - The data representing the custom type or slice.
-	 *
 	 * @throws Error if the item status cannot be retrieved or the item cannot be
-	 *   created/updated.
+	 * created/updated.
 	 */
-	private async upsert(
-		endpoint: ItemTypePath,
-		operation: ItemOperation,
-		data: ItemType,
-	) {
-		const profiler = logger.startTimer();
-		const path = `${endpoint}/${operation}`;
-
-		const context = await this.getContext();
-		const result = await context.post(path, { data });
+	private async upsert(endpoint: ItemTypePath, operation: ItemOperation, data: ItemType) {
+		const profiler = logger.startTimer()
+		const path = `${endpoint}/${operation}`
+
+		const context = await this.getContext()
+		const result = await context.post(path, { data })
 		if (!result.ok()) {
-			logPlaywrightApiResponse(result);
-			throw new Error(`Could not ${operation} item`);
+			logPlaywrightApiResponse(result)
+			throw new Error(`Could not ${operation} item`)
 		}
 		profiler.done({
 			message: `called customtypes api /${path} for item with id '${data.id}'`,
-		});
+		})
 	}
 
 	private async getRemoteItems(
 		endpoint: ItemTypePath,
-	): Promise<CustomType[] | SharedSlice[]> {
-		const context = await this.getContext();
-		const result = await context.get(endpoint);
+	): Promise<DynamicCustomTypeModel[] | SharedSliceModel[]> {
+		const context = await this.getContext()
+		const result = await context.get(endpoint)
 
 		if (!result.ok()) {
-			logPlaywrightApiResponse(result);
-			throw new Error("Could not get items status from the Custom Type api.");
+			logPlaywrightApiResponse(result)
+			throw new Error("Could not get items status from the Custom Type api.")
 		}
 
-		return result.json();
+		return result.json()
 	}
 
 	private async getDifference(
-		remoteItems: CustomType[] | SharedSlice[],
+		remoteItems: DynamicCustomTypeModel[] | SharedSliceModel[],
 		local: ItemType,
 	): Promise<ItemOperation | undefined> {
 		const remoteItem = remoteItems.find(
-			(remote: CustomType | SharedSlice) => remote.id === local.id,
-		);
+			(remote: DynamicCustomTypeModel | SharedSliceModel) => remote.id === local.id,
+		)
 		if (!remoteItem) {
-			return "insert";
+			return "insert"
 		}
 		if (!isEqual(local, remoteItem)) {
-			return "update";
+			return "update"
 		}
 
-		return;
+		return
 	}
 
 	/** Create items only if they have changed compared to their remote status */
@@ -90,44 +74,42 @@ export class CustomTypesApiClient extends AuthenticatedApiClient {
 		itemType: ItemTypePath,
 		localItems: ItemType[] = [],
 	): Promise<void> {
-		const remoteItems = await this.getRemoteItems(itemType);
+		const remoteItems = await this.getRemoteItems(itemType)
 		await Promise.all(
 			localItems.map(async (localItem) => {
-				const operation = await this.getDifference(remoteItems, localItem);
+				const operation = await this.getDifference(remoteItems, localItem)
 
-				return operation && this.upsert(itemType, operation, localItem);
+				return operation && this.upsert(itemType, operation, localItem)
 			}),
-		);
+		)
 	}
 
 	/**
 	 * Create Custom Types using the Custom types api.
 	 *
-	 * @param customTypes -
+	 * @param customTypes
 	 */
-	async createCustomTypes(customTypes: CustomType[] = []): Promise<void> {
-		await this.upsertIfChanged("customtypes", customTypes);
+	async createCustomTypes(customTypes: DynamicCustomTypeModel[] = []): Promise<void> {
+		await this.upsertIfChanged("customtypes", customTypes)
 	}
 
 	async deleteCustomType(customTypeId: string): Promise<void> {
-		const context = await this.getContext();
-		const result = await context.delete(`customtypes/${customTypeId}`);
+		const context = await this.getContext()
+		const result = await context.delete(`customtypes/${customTypeId}`)
 
 		if (!result.ok()) {
-			logPlaywrightApiResponse(result);
-			throw new Error(
-				`Could not delete ${customTypeId} from the Custom Type api.`,
-			);
+			logPlaywrightApiResponse(result)
+			throw new Error(`Could not delete ${customTypeId} from the Custom Type api.`)
 		}
 	}
 
 	/**
 	 * Create slices using the Custom types api.
 	 *
-	 * @param slices -
+	 * @param slices
 	 */
-	async createSlices(slices: SharedSlice[] = []): Promise<void> {
-		await this.upsertIfChanged("slices", slices);
+	async createSlices(slices: SharedSliceModel[] = []): Promise<void> {
+		await this.upsertIfChanged("slices", slices)
 	}
 
 	/**
@@ -135,17 +117,15 @@ export class CustomTypesApiClient extends AuthenticatedApiClient {
 	 *
 	 * @param customTypeId - The id of the custom type to get.
 	 */
-	async getTypeById(customTypeId: string): Promise<CustomType> {
-		const context = await this.getContext();
-		const result = await context.get(`customtypes/${customTypeId}`);
+	async getTypeById(customTypeId: string): Promise<DynamicCustomTypeModel> {
+		const context = await this.getContext()
+		const result = await context.get(`customtypes/${customTypeId}`)
 
 		if (!result.ok()) {
-			logPlaywrightApiResponse(result);
-			throw new Error(
-				`Could not get ${customTypeId} type from the Custom Type api.`,
-			);
+			logPlaywrightApiResponse(result)
+			throw new Error(`Could not get ${customTypeId} type from the Custom Type api.`)
 		}
 
-		return result.json();
+		return result.json()
 	}
 }