@prismicio/e2e-tests-utils 1.18.0 → 1.19.0

package/src/clients/contentApi.ts

@@ -1,129 +1,126 @@
-import { APIResponse } from "@playwright/test";
+import type { APIResponse } from "@playwright/test"
 
-import { AuthenticatedApiClient } from "./apiClient";
+import { AuthenticatedApiClient } from "./apiClient"
 
 export interface ContentApiError {
-	type: string;
-	message: string;
+	type: string
+	message: string
 }
 export interface ContentApiSearchResponse {
-	page: number;
-	results_per_page: number;
-	results_size: number;
-	total_results_size: number;
-	total_pages: number;
-	next_page: string | null;
-	prev_page: string | null;
-	results: ContentApiDocument[];
+	page: number
+	results_per_page: number
+	results_size: number
+	total_results_size: number
+	total_pages: number
+	next_page: string | null
+	prev_page: string | null
+	results: ContentApiDocument[]
 }
 
 export interface ContentApiDocument {
-	id: string;
-	uid: string | null;
-	url: string | null;
-	type: string;
-	href: string;
-	tags: string[];
-	first_publication_date: string;
-	last_publication_date: string;
-	slugs: string[];
-	linked_documents: unknown[];
-	lang: string;
-	alternate_languages: ContentApiAlternateLanguage[];
+	id: string
+	uid: string | null
+	url: string | null
+	type: string
+	href: string
+	tags: string[]
+	first_publication_date: string
+	last_publication_date: string
+	slugs: string[]
+	linked_documents: unknown[]
+	lang: string
+	alternate_languages: ContentApiAlternateLanguage[]
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	data: Record<string, any>;
+	data: Record<string, any>
 }
 
 export interface ContentApiGraphQLResponse {
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	data: Record<string, any>;
+	data: Record<string, any>
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	errors?: { message: string; locations: any }[];
+	errors?: { message: string; locations: any }[]
 }
 
 export interface ContentApiRef {
-	id: string;
-	ref: string;
-	label: string;
-	isMasterRef?: boolean;
-	scheduledAt?: number | undefined;
+	id: string
+	ref: string
+	label: string
+	isMasterRef?: boolean
+	scheduledAt?: number | undefined
 }
 
 interface ContentApiAlternateLanguage {
-	id: string;
-	type: string;
-	lang: string;
-	uid?: string;
+	id: string
+	type: string
+	lang: string
+	uid?: string
 }
 
 interface ContentApiRepoConfigResponse {
-	refs: ContentApiRef[];
-	bookmarks: Record<string, unknown>;
-	types: Record<string, string>;
+	refs: ContentApiRef[]
+	bookmarks: Record<string, unknown>
+	types: Record<string, string>
 	languages: {
-		id: string;
-		name: string;
-		is_master: boolean;
-	}[];
-	oauth_initiate: string;
-	oauth_token: string;
-	tags: string[];
-	license: string;
-	version: string;
+		id: string
+		name: string
+		is_master: boolean
+	}[]
+	oauth_initiate: string
+	oauth_token: string
+	tags: string[]
+	license: string
+	version: string
 }
 
 type SearchQueryParams = {
-	ref?: string;
-	query?: string;
-	q?: string;
-	graphQuery?: string;
-	fetchLinks?: string;
-	orderings?: string;
-	pageSize?: number;
-	page?: number;
-	lang?: string;
-	after?: string;
-	routes?: string;
-};
-
-type ApiVersions = "v1" | "v2";
+	ref?: string
+	query?: string
+	q?: string
+	graphQuery?: string
+	fetchLinks?: string
+	orderings?: string
+	pageSize?: number
+	page?: number
+	lang?: string
+	after?: string
+	routes?: string
+}
+
+type ApiVersions = "v1" | "v2"
 
 /**
- * Client to query the Prismic content api. Uses Playwright to benefit from
- * network request traces in your reports. See api docs:
- * https://prismic.io/docs/rest-api-technical-reference
+ * Client to query the Prismic content api. Uses Playwright to benefit from network request traces
+ * in your reports. See api docs: https://prismic.io/docs/rest-api-technical-reference
  */
 export class ContentApiClient extends AuthenticatedApiClient {
-	private version: ApiVersions;
-	private accessToken: string | undefined;
+	private version: ApiVersions
+	private accessToken: string | undefined
 
 	/**
-	 * @example To instantiate the class:
+	 * @example
+	 * 	To instantiate the class:
 	 *
-	 * ```js
-	 * new ContentApiClient("https://my-repo.cdn.prismic.io", {
+	 * 	```js
+	 * 	new ContentApiClient("https://my-repo.cdn.prismic.io", {
 	 * 	version: "v2",
 	 * 	accessToken: "my-secret-token",
-	 * });
-	 * ```
+	 * 	});
+	 * 	```
 	 *
-	 * @param baseURL - the api base URL like https://my-repo.cdn.prismic.io
+	 * @param baseURL - The api base URL like https://my-repo.cdn.prismic.io
 	 * @param config - Optional configuration
 	 *
 	 *   - {@link config.version}: Api version, default is "v2"
 	 *   - {@link config.accessToken}: Access token for the content api -
-	 *       https://prismic.io/docs/access-token
+	 *     https://prismic.io/docs/access-token
 	 */
-	constructor(
-		baseURL: string,
-		config: { version?: ApiVersions; accessToken?: string } = {},
-	) {
+	constructor(baseURL: string, config: { version?: ApiVersions; accessToken?: string } = {}) {
 		// Use an empty string as Authorization header in case it is already set globally in the project Playwright config file.
 		// This is because the content api returns an error in case it gets an non-empty invalid Authorization
 		// even though it actually checks authorization from the access_token query parameter.
-		super(baseURL, config.accessToken || "");
-		this.version = config.version || "v2";
-		this.accessToken = config.accessToken;
+		super(baseURL, config.accessToken || "")
+		this.version = config.version || "v2"
+		this.accessToken = config.accessToken
 	}
 
 	async get(
@@ -131,15 +128,13 @@ export class ContentApiClient extends AuthenticatedApiClient {
 		params?: SearchQueryParams,
 		headers?: Record<string, string>,
 	): Promise<APIResponse> {
-		const context = await this.getContext();
-		const securityParams = {
-			...(this.accessToken ? { access_token: this.accessToken } : {}),
-		};
+		const context = await this.getContext()
+		const securityParams = this.accessToken ? { access_token: this.accessToken } : {} as Record<string, never>
 
 		return context.get(path, {
 			params: { ...securityParams, ...params },
 			headers,
-		});
+		})
 	}
 
 	async getAsJson<T>(
@@ -147,77 +142,62 @@ export class ContentApiClient extends AuthenticatedApiClient {
 		params?: SearchQueryParams,
 		headers?: Record<string, string>,
 	): Promise<T> {
-		const response = await this.get(url, params, headers);
+		const response = await this.get(url, params, headers)
 
-		return response.json() as T;
+		return response.json() as T
 	}
 
 	/** Query the graphql api - https://prismic.io/docs/graphql-technical-reference */
-	async graphql(
-		ref: string,
-		query: string,
-	): Promise<ContentApiGraphQLResponse> {
-		return this.getAsJson<ContentApiGraphQLResponse>(
-			"graphql",
-			{ query },
-			{ "Prismic-ref": ref },
-		);
+	async graphql(ref: string, query: string): Promise<ContentApiGraphQLResponse> {
+		return this.getAsJson<ContentApiGraphQLResponse>("graphql", { query }, { "Prismic-ref": ref })
 	}
 
 	async getRefs(): Promise<ContentApiRef[]> {
-		const data = await this.getAsJson<ContentApiRepoConfigResponse>(
-			`api/${this.version}`,
-		);
+		const data = await this.getAsJson<ContentApiRepoConfigResponse>(`api/${this.version}`)
 
-		return data.refs;
+		return data.refs
 	}
 
 	async getMasterRef(): Promise<string> {
-		const refs = await this.getRefs();
+		const refs = await this.getRefs()
 
-		const masterRef = refs.find(({ isMasterRef }) => isMasterRef === true);
+		const masterRef = refs.find(({ isMasterRef }) => isMasterRef === true)
 		if (!masterRef) {
-			throw "No master ref found";
+			throw "No master ref found"
 		}
 
-		return masterRef.ref;
+		return masterRef.ref
 	}
 
 	async getRefByReleaseID(releaseID: string): Promise<string> {
-		const refs = await this.getRefs();
-		const release = refs.find(({ id }) => id === releaseID);
+		const refs = await this.getRefs()
+		const release = refs.find(({ id }) => id === releaseID)
 		if (!release) {
-			throw `No ref found for release ${releaseID}`;
+			throw `No ref found for release ${releaseID}`
 		}
 
-		return release.ref;
+		return release.ref
 	}
 
 	/** Search documents from the `/api/v<version>/documents/search` endpoint. */
 	async search(filters?: SearchQueryParams): Promise<ContentApiSearchResponse> {
-		let ref = filters?.ref;
+		let ref = filters?.ref
 		if (!ref) {
-			ref = await this.getMasterRef();
+			ref = await this.getMasterRef()
 		}
 
-		return this.getAsJson<ContentApiSearchResponse>(
-			`api/${this.version}/documents/search`,
-			{
-				...filters,
-				ref,
-			},
-		);
+		return this.getAsJson<ContentApiSearchResponse>(`api/${this.version}/documents/search`, {
+			...filters,
+			ref,
+		})
 	}
 
 	/**
-	 * Search for a single document by its it, using the
-	 * `/api/v<version>/documents/search` endpoint and a default filter.
+	 * Search for a single document by its it, using the `/api/v<version>/documents/search` endpoint
+	 * and a default filter.
 	 */
-	async searchByID(
-		id: string,
-		filters?: SearchQueryParams,
-	): Promise<ContentApiSearchResponse> {
-		return this.search({ ...filters, q: `[[at(document.id, "${id}")]]` });
+	async searchByID(id: string, filters?: SearchQueryParams): Promise<ContentApiSearchResponse> {
+		return this.search({ ...filters, q: `[[at(document.id, "${id}")]]` })
 	}
 
 	/** Retrieve a single document or undefined if not found. */
@@ -225,14 +205,14 @@ export class ContentApiClient extends AuthenticatedApiClient {
 		id: string,
 		filters?: SearchQueryParams,
 	): Promise<ContentApiDocument | undefined> {
-		const data = await this.searchByID(id, filters);
+		const data = await this.searchByID(id, filters)
 		switch (data.results_size) {
 			case 0:
-				return;
+				return
 			case 1:
-				return data.results[0];
+				return data.results[0]
 			default:
-				throw new Error(`Too many documents returned with the same id ${id}`);
+				throw new Error(`Too many documents returned with the same id ${id}`)
 		}
 	}
 }