@prismicio/e2e-tests-utils 1.18.0 → 1.19.0-pr.37.21fc0dd

package/dist/clients/contentApi.d.cts

@@ -0,0 +1,116 @@
+import { AuthenticatedApiClient } from "./apiClient.cjs";
+import { APIResponse } from "@playwright/test";
+
+//#region src/clients/contentApi.d.ts
+interface ContentApiError {
+  type: string;
+  message: string;
+}
+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[];
+}
+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[];
+  data: Record<string, any>;
+}
+interface ContentApiGraphQLResponse {
+  data: Record<string, any>;
+  errors?: {
+    message: string;
+    locations: any;
+  }[];
+}
+interface ContentApiRef {
+  id: string;
+  ref: string;
+  label: string;
+  isMasterRef?: boolean;
+  scheduledAt?: number | undefined;
+}
+interface ContentApiAlternateLanguage {
+  id: string;
+  type: string;
+  lang: string;
+  uid?: 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";
+/**
+ * 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
+ */
+declare class ContentApiClient extends AuthenticatedApiClient {
+  private version;
+  private accessToken;
+  /**
+   * @example
+   * 	To instantiate the class:
+   *
+   * 	```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 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
+   */
+  constructor(baseURL: string, config?: {
+    version?: ApiVersions;
+    accessToken?: string;
+  });
+  get(path: string, params?: SearchQueryParams, headers?: Record<string, string>): Promise<APIResponse>;
+  getAsJson<T>(url: string, params?: SearchQueryParams, headers?: Record<string, string>): Promise<T>;
+  /** Query the graphql api - https://prismic.io/docs/graphql-technical-reference */
+  graphql(ref: string, query: string): Promise<ContentApiGraphQLResponse>;
+  getRefs(): Promise<ContentApiRef[]>;
+  getMasterRef(): Promise<string>;
+  getRefByReleaseID(releaseID: string): Promise<string>;
+  /** Search documents from the `/api/v<version>/documents/search` endpoint. */
+  search(filters?: SearchQueryParams): Promise<ContentApiSearchResponse>;
+  /**
+   * Search for a single document by its it, using the `/api/v<version>/documents/search` endpoint
+   * and a default filter.
+   */
+  searchByID(id: string, filters?: SearchQueryParams): Promise<ContentApiSearchResponse>;
+  /** Retrieve a single document or undefined if not found. */
+  getDocumentByID(id: string, filters?: SearchQueryParams): Promise<ContentApiDocument | undefined>;
+}
+//#endregion
+export { ContentApiClient, ContentApiDocument, ContentApiError, ContentApiGraphQLResponse, ContentApiRef, ContentApiSearchResponse };
+//# sourceMappingURL=contentApi.d.cts.map

package/dist/clients/contentApi.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentApi.d.cts","names":[],"sources":["../../src/clients/contentApi.ts"],"mappings":";;;;UAIiB,eAAA;EAChB,IAAA;EACA,OAAO;AAAA;AAAA,UAES,wBAAA;EAChB,IAAA;EACA,gBAAA;EACA,YAAA;EACA,kBAAA;EACA,WAAA;EACA,SAAA;EACA,SAAA;EACA,OAAA,EAAS,kBAAkB;AAAA;AAAA,UAGX,kBAAA;EAChB,EAAA;EACA,GAAA;EACA,GAAA;EACA,IAAA;EACA,IAAA;EACA,IAAA;EACA,sBAAA;EACA,qBAAA;EACA,KAAA;EACA,gBAAA;EACA,IAAA;EACA,mBAAA,EAAqB,2BAAA;EAErB,IAAA,EAAM,MAAM;AAAA;AAAA,UAGI,yBAAA;EAEhB,IAAA,EAAM,MAAM;EAEZ,MAAA;IAAW,OAAA;IAAiB,SAAA;EAAA;AAAA;AAAA,UAGZ,aAAA;EAChB,EAAA;EACA,GAAA;EACA,KAAA;EACA,WAAA;EACA,WAAA;AAAA;AAAA,UAGS,2BAAA;EACT,EAAA;EACA,IAAA;EACA,IAAA;EACA,GAAA;AAAA;AAAA,KAmBI,iBAAA;EACJ,GAAA;EACA,KAAA;EACA,CAAA;EACA,UAAA;EACA,UAAA;EACA,SAAA;EACA,QAAA;EACA,IAAA;EACA,IAAA;EACA,KAAA;EACA,MAAA;AAAA;AAAA,KAGI,WAAA;;AAxCO;AACX;;cA6CY,gBAAA,SAAyB,sBAAA;EAAA,QAC7B,OAAA;EAAA,QACA,WAAA;EA3CR;;;;AAEG;AAAA;;;;;;;;;;;;;cA6DS,OAAA,UAAiB,MAAA;IAAU,OAAA,GAAU,WAAA;IAAa,WAAA;EAAA;EASxD,GAAA,CACL,IAAA,UACA,MAAA,GAAS,iBAAA,EACT,OAAA,GAAU,MAAA,mBACR,OAAA,CAAQ,WAAA;EAYL,SAAA,IACL,GAAA,UACA,MAAA,GAAS,iBAAA,EACT,OAAA,GAAU,MAAA,mBACR,OAAA,CAAQ,CAAA;;EAOL,OAAA,CAAQ,GAAA,UAAa,KAAA,WAAgB,OAAA,CAAQ,yBAAA;EAI7C,OAAA,IAAW,OAAA,CAAQ,aAAA;EAMnB,YAAA,IAAgB,OAAA;EAWhB,iBAAA,CAAkB,SAAA,WAAoB,OAAA;EA/Ef;EA0FvB,MAAA,CAAO,OAAA,GAAU,iBAAA,GAAoB,OAAA,CAAQ,wBAAA;EAzDzC;;;;EAyEJ,UAAA,CAAW,EAAA,UAAY,OAAA,GAAU,iBAAA,GAAoB,OAAA,CAAQ,wBAAA;EAxDxD;EA6DL,eAAA,CACL,EAAA,UACA,OAAA,GAAU,iBAAA,GACR,OAAA,CAAQ,kBAAA;AAAA"}

package/dist/clients/contentApi.d.ts

@@ -1,112 +1,116 @@
+import { AuthenticatedApiClient } from "./apiClient.js";
 import { APIResponse } from "@playwright/test";
-import { AuthenticatedApiClient } from "./apiClient";
-export interface ContentApiError {
-    type: string;
-    message: string;
+
+//#region src/clients/contentApi.d.ts
+interface ContentApiError {
+  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[];
+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[];
 }
-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[];
-    data: Record<string, any>;
+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[];
+  data: Record<string, any>;
 }
-export interface ContentApiGraphQLResponse {
-    data: Record<string, any>;
-    errors?: {
-        message: string;
-        locations: any;
-    }[];
+interface ContentApiGraphQLResponse {
+  data: Record<string, any>;
+  errors?: {
+    message: string;
+    locations: any;
+  }[];
 }
-export interface ContentApiRef {
-    id: string;
-    ref: string;
-    label: string;
-    isMasterRef?: boolean;
-    scheduledAt?: number | undefined;
+interface ContentApiRef {
+  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;
 }
 type SearchQueryParams = {
-    ref?: string;
-    query?: string;
-    q?: string;
-    graphQuery?: string;
-    fetchLinks?: string;
-    orderings?: string;
-    pageSize?: number;
-    page?: number;
-    lang?: string;
-    after?: string;
-    routes?: string;
+  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 declare class ContentApiClient extends AuthenticatedApiClient {
-    private version;
-    private accessToken;
-    /**
-     * @example To instantiate the class:
-     *
-     * ```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 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
-     */
-    constructor(baseURL: string, config?: {
-        version?: ApiVersions;
-        accessToken?: string;
-    });
-    get(path: string, params?: SearchQueryParams, headers?: Record<string, string>): Promise<APIResponse>;
-    getAsJson<T>(url: string, params?: SearchQueryParams, headers?: Record<string, string>): Promise<T>;
-    /** Query the graphql api - https://prismic.io/docs/graphql-technical-reference */
-    graphql(ref: string, query: string): Promise<ContentApiGraphQLResponse>;
-    getRefs(): Promise<ContentApiRef[]>;
-    getMasterRef(): Promise<string>;
-    getRefByReleaseID(releaseID: string): Promise<string>;
-    /** Search documents from the `/api/v<version>/documents/search` endpoint. */
-    search(filters?: SearchQueryParams): Promise<ContentApiSearchResponse>;
-    /**
-     * Search for a single document by its it, using the
-     * `/api/v<version>/documents/search` endpoint and a default filter.
-     */
-    searchByID(id: string, filters?: SearchQueryParams): Promise<ContentApiSearchResponse>;
-    /** Retrieve a single document or undefined if not found. */
-    getDocumentByID(id: string, filters?: SearchQueryParams): Promise<ContentApiDocument | undefined>;
+declare class ContentApiClient extends AuthenticatedApiClient {
+  private version;
+  private accessToken;
+  /**
+   * @example
+   * 	To instantiate the class:
+   *
+   * 	```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 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
+   */
+  constructor(baseURL: string, config?: {
+    version?: ApiVersions;
+    accessToken?: string;
+  });
+  get(path: string, params?: SearchQueryParams, headers?: Record<string, string>): Promise<APIResponse>;
+  getAsJson<T>(url: string, params?: SearchQueryParams, headers?: Record<string, string>): Promise<T>;
+  /** Query the graphql api - https://prismic.io/docs/graphql-technical-reference */
+  graphql(ref: string, query: string): Promise<ContentApiGraphQLResponse>;
+  getRefs(): Promise<ContentApiRef[]>;
+  getMasterRef(): Promise<string>;
+  getRefByReleaseID(releaseID: string): Promise<string>;
+  /** Search documents from the `/api/v<version>/documents/search` endpoint. */
+  search(filters?: SearchQueryParams): Promise<ContentApiSearchResponse>;
+  /**
+   * Search for a single document by its it, using the `/api/v<version>/documents/search` endpoint
+   * and a default filter.
+   */
+  searchByID(id: string, filters?: SearchQueryParams): Promise<ContentApiSearchResponse>;
+  /** Retrieve a single document or undefined if not found. */
+  getDocumentByID(id: string, filters?: SearchQueryParams): Promise<ContentApiDocument | undefined>;
 }
-export {};
+//#endregion
+export { ContentApiClient, ContentApiDocument, ContentApiError, ContentApiGraphQLResponse, ContentApiRef, ContentApiSearchResponse };
+//# sourceMappingURL=contentApi.d.ts.map

package/dist/clients/contentApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentApi.d.ts","names":[],"sources":["../../src/clients/contentApi.ts"],"mappings":";;;;UAIiB,eAAA;EAChB,IAAA;EACA,OAAO;AAAA;AAAA,UAES,wBAAA;EAChB,IAAA;EACA,gBAAA;EACA,YAAA;EACA,kBAAA;EACA,WAAA;EACA,SAAA;EACA,SAAA;EACA,OAAA,EAAS,kBAAkB;AAAA;AAAA,UAGX,kBAAA;EAChB,EAAA;EACA,GAAA;EACA,GAAA;EACA,IAAA;EACA,IAAA;EACA,IAAA;EACA,sBAAA;EACA,qBAAA;EACA,KAAA;EACA,gBAAA;EACA,IAAA;EACA,mBAAA,EAAqB,2BAAA;EAErB,IAAA,EAAM,MAAM;AAAA;AAAA,UAGI,yBAAA;EAEhB,IAAA,EAAM,MAAM;EAEZ,MAAA;IAAW,OAAA;IAAiB,SAAA;EAAA;AAAA;AAAA,UAGZ,aAAA;EAChB,EAAA;EACA,GAAA;EACA,KAAA;EACA,WAAA;EACA,WAAA;AAAA;AAAA,UAGS,2BAAA;EACT,EAAA;EACA,IAAA;EACA,IAAA;EACA,GAAA;AAAA;AAAA,KAmBI,iBAAA;EACJ,GAAA;EACA,KAAA;EACA,CAAA;EACA,UAAA;EACA,UAAA;EACA,SAAA;EACA,QAAA;EACA,IAAA;EACA,IAAA;EACA,KAAA;EACA,MAAA;AAAA;AAAA,KAGI,WAAA;;AAxCO;AACX;;cA6CY,gBAAA,SAAyB,sBAAA;EAAA,QAC7B,OAAA;EAAA,QACA,WAAA;EA3CR;;;;AAEG;AAAA;;;;;;;;;;;;;cA6DS,OAAA,UAAiB,MAAA;IAAU,OAAA,GAAU,WAAA;IAAa,WAAA;EAAA;EASxD,GAAA,CACL,IAAA,UACA,MAAA,GAAS,iBAAA,EACT,OAAA,GAAU,MAAA,mBACR,OAAA,CAAQ,WAAA;EAYL,SAAA,IACL,GAAA,UACA,MAAA,GAAS,iBAAA,EACT,OAAA,GAAU,MAAA,mBACR,OAAA,CAAQ,CAAA;;EAOL,OAAA,CAAQ,GAAA,UAAa,KAAA,WAAgB,OAAA,CAAQ,yBAAA;EAI7C,OAAA,IAAW,OAAA,CAAQ,aAAA;EAMnB,YAAA,IAAgB,OAAA;EAWhB,iBAAA,CAAkB,SAAA,WAAoB,OAAA;EA/Ef;EA0FvB,MAAA,CAAO,OAAA,GAAU,iBAAA,GAAoB,OAAA,CAAQ,wBAAA;EAzDzC;;;;EAyEJ,UAAA,CAAW,EAAA,UAAY,OAAA,GAAU,iBAAA,GAAoB,OAAA,CAAQ,wBAAA;EAxDxD;EA6DL,eAAA,CACL,EAAA,UACA,OAAA,GAAU,iBAAA,GACR,OAAA,CAAQ,kBAAA;AAAA"}

package/dist/clients/contentApi.js

@@ -1,105 +1,96 @@
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 import { AuthenticatedApiClient } from "./apiClient.js";
-class ContentApiClient extends AuthenticatedApiClient {
-  /**
-   * @example To instantiate the class:
-   *
-   * ```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 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
-   */
-  constructor(baseURL, config = {}) {
-    super(baseURL, config.accessToken || "");
-    __publicField(this, "version");
-    __publicField(this, "accessToken");
-    this.version = config.version || "v2";
-    this.accessToken = config.accessToken;
-  }
-  async get(path, params, headers) {
-    const context = await this.getContext();
-    const securityParams = {
-      ...this.accessToken ? { access_token: this.accessToken } : {}
-    };
-    return context.get(path, {
-      params: { ...securityParams, ...params },
-      headers
-    });
-  }
-  async getAsJson(url, params, headers) {
-    const response = await this.get(url, params, headers);
-    return response.json();
-  }
-  /** Query the graphql api - https://prismic.io/docs/graphql-technical-reference */
-  async graphql(ref, query) {
-    return this.getAsJson("graphql", { query }, { "Prismic-ref": ref });
-  }
-  async getRefs() {
-    const data = await this.getAsJson(`api/${this.version}`);
-    return data.refs;
-  }
-  async getMasterRef() {
-    const refs = await this.getRefs();
-    const masterRef = refs.find(({ isMasterRef }) => isMasterRef === true);
-    if (!masterRef) {
-      throw "No master ref found";
-    }
-    return masterRef.ref;
-  }
-  async getRefByReleaseID(releaseID) {
-    const refs = await this.getRefs();
-    const release = refs.find(({ id }) => id === releaseID);
-    if (!release) {
-      throw `No ref found for release ${releaseID}`;
-    }
-    return release.ref;
-  }
-  /** Search documents from the `/api/v<version>/documents/search` endpoint. */
-  async search(filters) {
-    let ref = filters == null ? void 0 : filters.ref;
-    if (!ref) {
-      ref = await this.getMasterRef();
-    }
-    return this.getAsJson(`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.
-   */
-  async searchByID(id, filters) {
-    return this.search({ ...filters, q: `[[at(document.id, "${id}")]]` });
-  }
-  /** Retrieve a single document or undefined if not found. */
-  async getDocumentByID(id, filters) {
-    const data = await this.searchByID(id, filters);
-    switch (data.results_size) {
-      case 0:
-        return;
-      case 1:
-        return data.results[0];
-      default:
-        throw new Error(`Too many documents returned with the same id ${id}`);
-    }
-  }
-}
-export {
-  ContentApiClient
+//#region src/clients/contentApi.ts
+/**
+* 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
+*/
+var ContentApiClient = class extends AuthenticatedApiClient {
+	version;
+	accessToken;
+	/**
+	* @example
+	* 	To instantiate the class:
+	*
+	* 	```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 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
+	*/
+	constructor(baseURL, config = {}) {
+		super(baseURL, config.accessToken || "");
+		this.version = config.version || "v2";
+		this.accessToken = config.accessToken;
+	}
+	async get(path, params, headers) {
+		const context = await this.getContext();
+		const securityParams = this.accessToken ? { access_token: this.accessToken } : {};
+		return context.get(path, {
+			params: {
+				...securityParams,
+				...params
+			},
+			headers
+		});
+	}
+	async getAsJson(url, params, headers) {
+		return (await this.get(url, params, headers)).json();
+	}
+	/** Query the graphql api - https://prismic.io/docs/graphql-technical-reference */
+	async graphql(ref, query) {
+		return this.getAsJson("graphql", { query }, { "Prismic-ref": ref });
+	}
+	async getRefs() {
+		return (await this.getAsJson(`api/${this.version}`)).refs;
+	}
+	async getMasterRef() {
+		const masterRef = (await this.getRefs()).find(({ isMasterRef }) => isMasterRef === true);
+		if (!masterRef) throw "No master ref found";
+		return masterRef.ref;
+	}
+	async getRefByReleaseID(releaseID) {
+		const release = (await this.getRefs()).find(({ id }) => id === releaseID);
+		if (!release) throw `No ref found for release ${releaseID}`;
+		return release.ref;
+	}
+	/** Search documents from the `/api/v<version>/documents/search` endpoint. */
+	async search(filters) {
+		let ref = filters?.ref;
+		if (!ref) ref = await this.getMasterRef();
+		return this.getAsJson(`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.
+	*/
+	async searchByID(id, filters) {
+		return this.search({
+			...filters,
+			q: `[[at(document.id, "${id}")]]`
+		});
+	}
+	/** Retrieve a single document or undefined if not found. */
+	async getDocumentByID(id, filters) {
+		const data = await this.searchByID(id, filters);
+		switch (data.results_size) {
+			case 0: return;
+			case 1: return data.results[0];
+			default: throw new Error(`Too many documents returned with the same id ${id}`);
+		}
+	}
 };
-//# sourceMappingURL=contentApi.js.map
+//#endregion
+export { ContentApiClient };
+
+//# sourceMappingURL=contentApi.js.map

package/dist/clients/contentApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"contentApi.js","sources":["../../../src/clients/contentApi.ts"],"sourcesContent":["import { APIResponse } from \"@playwright/test\";\n\nimport { AuthenticatedApiClient } from \"./apiClient\";\n\nexport interface ContentApiError {\n\ttype: string;\n\tmessage: string;\n}\nexport interface ContentApiSearchResponse {\n\tpage: number;\n\tresults_per_page: number;\n\tresults_size: number;\n\ttotal_results_size: number;\n\ttotal_pages: number;\n\tnext_page: string | null;\n\tprev_page: string | null;\n\tresults: ContentApiDocument[];\n}\n\nexport interface ContentApiDocument {\n\tid: string;\n\tuid: string | null;\n\turl: string | null;\n\ttype: string;\n\thref: string;\n\ttags: string[];\n\tfirst_publication_date: string;\n\tlast_publication_date: string;\n\tslugs: string[];\n\tlinked_documents: unknown[];\n\tlang: string;\n\talternate_languages: ContentApiAlternateLanguage[];\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tdata: Record<string, any>;\n}\n\nexport interface ContentApiGraphQLResponse {\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tdata: Record<string, any>;\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\terrors?: { message: string; locations: any }[];\n}\n\nexport interface ContentApiRef {\n\tid: string;\n\tref: string;\n\tlabel: string;\n\tisMasterRef?: boolean;\n\tscheduledAt?: number | undefined;\n}\n\ninterface ContentApiAlternateLanguage {\n\tid: string;\n\ttype: string;\n\tlang: string;\n\tuid?: string;\n}\n\ninterface ContentApiRepoConfigResponse {\n\trefs: ContentApiRef[];\n\tbookmarks: Record<string, unknown>;\n\ttypes: Record<string, string>;\n\tlanguages: {\n\t\tid: string;\n\t\tname: string;\n\t\tis_master: boolean;\n\t}[];\n\toauth_initiate: string;\n\toauth_token: string;\n\ttags: string[];\n\tlicense: string;\n\tversion: string;\n}\n\ntype SearchQueryParams = {\n\tref?: string;\n\tquery?: string;\n\tq?: string;\n\tgraphQuery?: string;\n\tfetchLinks?: string;\n\torderings?: string;\n\tpageSize?: number;\n\tpage?: number;\n\tlang?: string;\n\tafter?: string;\n\troutes?: string;\n};\n\ntype ApiVersions = \"v1\" | \"v2\";\n\n/**\n * Client to query the Prismic content api. Uses Playwright to benefit from\n * network request traces in your reports. See api docs:\n * https://prismic.io/docs/rest-api-technical-reference\n */\nexport class ContentApiClient extends AuthenticatedApiClient {\n\tprivate version: ApiVersions;\n\tprivate accessToken: string | undefined;\n\n\t/**\n\t * @example To instantiate the class:\n\t *\n\t * ```js\n\t * new ContentApiClient(\"https://my-repo.cdn.prismic.io\", {\n\t * \tversion: \"v2\",\n\t * \taccessToken: \"my-secret-token\",\n\t * });\n\t * ```\n\t *\n\t * @param baseURL - the api base URL like https://my-repo.cdn.prismic.io\n\t * @param config - Optional configuration\n\t *\n\t *   - {@link config.version}: Api version, default is \"v2\"\n\t *   - {@link config.accessToken}: Access token for the content api -\n\t *       https://prismic.io/docs/access-token\n\t */\n\tconstructor(\n\t\tbaseURL: string,\n\t\tconfig: { version?: ApiVersions; accessToken?: string } = {},\n\t) {\n\t\t// Use an empty string as Authorization header in case it is already set globally in the project Playwright config file.\n\t\t// This is because the content api returns an error in case it gets an non-empty invalid Authorization\n\t\t// even though it actually checks authorization from the access_token query parameter.\n\t\tsuper(baseURL, config.accessToken || \"\");\n\t\tthis.version = config.version || \"v2\";\n\t\tthis.accessToken = config.accessToken;\n\t}\n\n\tasync get(\n\t\tpath: string,\n\t\tparams?: SearchQueryParams,\n\t\theaders?: Record<string, string>,\n\t): Promise<APIResponse> {\n\t\tconst context = await this.getContext();\n\t\tconst securityParams = {\n\t\t\t...(this.accessToken ? { access_token: this.accessToken } : {}),\n\t\t};\n\n\t\treturn context.get(path, {\n\t\t\tparams: { ...securityParams, ...params },\n\t\t\theaders,\n\t\t});\n\t}\n\n\tasync getAsJson<T>(\n\t\turl: string,\n\t\tparams?: SearchQueryParams,\n\t\theaders?: Record<string, string>,\n\t): Promise<T> {\n\t\tconst response = await this.get(url, params, headers);\n\n\t\treturn response.json() as T;\n\t}\n\n\t/** Query the graphql api - https://prismic.io/docs/graphql-technical-reference */\n\tasync graphql(\n\t\tref: string,\n\t\tquery: string,\n\t): Promise<ContentApiGraphQLResponse> {\n\t\treturn this.getAsJson<ContentApiGraphQLResponse>(\n\t\t\t\"graphql\",\n\t\t\t{ query },\n\t\t\t{ \"Prismic-ref\": ref },\n\t\t);\n\t}\n\n\tasync getRefs(): Promise<ContentApiRef[]> {\n\t\tconst data = await this.getAsJson<ContentApiRepoConfigResponse>(\n\t\t\t`api/${this.version}`,\n\t\t);\n\n\t\treturn data.refs;\n\t}\n\n\tasync getMasterRef(): Promise<string> {\n\t\tconst refs = await this.getRefs();\n\n\t\tconst masterRef = refs.find(({ isMasterRef }) => isMasterRef === true);\n\t\tif (!masterRef) {\n\t\t\tthrow \"No master ref found\";\n\t\t}\n\n\t\treturn masterRef.ref;\n\t}\n\n\tasync getRefByReleaseID(releaseID: string): Promise<string> {\n\t\tconst refs = await this.getRefs();\n\t\tconst release = refs.find(({ id }) => id === releaseID);\n\t\tif (!release) {\n\t\t\tthrow `No ref found for release ${releaseID}`;\n\t\t}\n\n\t\treturn release.ref;\n\t}\n\n\t/** Search documents from the `/api/v<version>/documents/search` endpoint. */\n\tasync search(filters?: SearchQueryParams): Promise<ContentApiSearchResponse> {\n\t\tlet ref = filters?.ref;\n\t\tif (!ref) {\n\t\t\tref = await this.getMasterRef();\n\t\t}\n\n\t\treturn this.getAsJson<ContentApiSearchResponse>(\n\t\t\t`api/${this.version}/documents/search`,\n\t\t\t{\n\t\t\t\t...filters,\n\t\t\t\tref,\n\t\t\t},\n\t\t);\n\t}\n\n\t/**\n\t * Search for a single document by its it, using the\n\t * `/api/v<version>/documents/search` endpoint and a default filter.\n\t */\n\tasync searchByID(\n\t\tid: string,\n\t\tfilters?: SearchQueryParams,\n\t): Promise<ContentApiSearchResponse> {\n\t\treturn this.search({ ...filters, q: `[[at(document.id, \"${id}\")]]` });\n\t}\n\n\t/** Retrieve a single document or undefined if not found. */\n\tasync getDocumentByID(\n\t\tid: string,\n\t\tfilters?: SearchQueryParams,\n\t): Promise<ContentApiDocument | undefined> {\n\t\tconst data = await this.searchByID(id, filters);\n\t\tswitch (data.results_size) {\n\t\t\tcase 0:\n\t\t\t\treturn;\n\t\t\tcase 1:\n\t\t\t\treturn data.results[0];\n\t\t\tdefault:\n\t\t\t\tthrow new Error(`Too many documents returned with the same id ${id}`);\n\t\t}\n\t}\n}\n"],"names":[],"mappings":";;;;;;;AA+FM,MAAO,yBAAyB,uBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqB3D,YACC,SACA,SAA0D,IAAE;AAKtD,UAAA,SAAS,OAAO,eAAe,EAAE;AA3BhC;AACA;AA2BF,SAAA,UAAU,OAAO,WAAW;AACjC,SAAK,cAAc,OAAO;AAAA,EAC3B;AAAA,EAEA,MAAM,IACL,MACA,QACA,SAAgC;AAE1B,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,iBAAiB;AAAA,MACtB,GAAI,KAAK,cAAc,EAAE,cAAc,KAAK,YAAA,IAAgB;;AAGtD,WAAA,QAAQ,IAAI,MAAM;AAAA,MACxB,QAAQ,EAAE,GAAG,gBAAgB,GAAG,OAAQ;AAAA,MACxC;AAAA,IAAA,CACA;AAAA,EACF;AAAA,EAEA,MAAM,UACL,KACA,QACA,SAAgC;AAEhC,UAAM,WAAW,MAAM,KAAK,IAAI,KAAK,QAAQ,OAAO;AAEpD,WAAO,SAAS;EACjB;AAAA;AAAA,EAGA,MAAM,QACL,KACA,OAAa;AAEN,WAAA,KAAK,UACX,WACA,EAAE,SACF,EAAE,eAAe,IAAA,CAAK;AAAA,EAExB;AAAA,EAEA,MAAM,UAAO;AACZ,UAAM,OAAO,MAAM,KAAK,UACvB,OAAO,KAAK,OAAO,EAAE;AAGtB,WAAO,KAAK;AAAA,EACb;AAAA,EAEA,MAAM,eAAY;AACX,UAAA,OAAO,MAAM,KAAK;AAElB,UAAA,YAAY,KAAK,KAAK,CAAC,EAAE,kBAAkB,gBAAgB,IAAI;AACrE,QAAI,CAAC,WAAW;AACT,YAAA;AAAA,IACP;AAEA,WAAO,UAAU;AAAA,EAClB;AAAA,EAEA,MAAM,kBAAkB,WAAiB;AAClC,UAAA,OAAO,MAAM,KAAK;AAClB,UAAA,UAAU,KAAK,KAAK,CAAC,EAAE,SAAS,OAAO,SAAS;AACtD,QAAI,CAAC,SAAS;AACb,YAAM,4BAA4B,SAAS;AAAA,IAC5C;AAEA,WAAO,QAAQ;AAAA,EAChB;AAAA;AAAA,EAGA,MAAM,OAAO,SAA2B;AACvC,QAAI,MAAM,mCAAS;AACnB,QAAI,CAAC,KAAK;AACH,YAAA,MAAM,KAAK;IAClB;AAEA,WAAO,KAAK,UACX,OAAO,KAAK,OAAO,qBACnB;AAAA,MACC,GAAG;AAAA,MACH;AAAA,IAAA,CACA;AAAA,EAEH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,WACL,IACA,SAA2B;AAEpB,WAAA,KAAK,OAAO,EAAE,GAAG,SAAS,GAAG,sBAAsB,EAAE,OAAA,CAAQ;AAAA,EACrE;AAAA;AAAA,EAGA,MAAM,gBACL,IACA,SAA2B;AAE3B,UAAM,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO;AAC9C,YAAQ,KAAK,cAAc;AAAA,MAC1B,KAAK;AACJ;AAAA,MACD,KAAK;AACG,eAAA,KAAK,QAAQ,CAAC;AAAA,MACtB;AACC,cAAM,IAAI,MAAM,gDAAgD,EAAE,EAAE;AAAA,IACtE;AAAA,EACD;AACA;"}
+{"version":3,"file":"contentApi.js","names":[],"sources":["../../src/clients/contentApi.ts"],"sourcesContent":["import type { APIResponse } from \"@playwright/test\"\n\nimport { AuthenticatedApiClient } from \"./apiClient\"\n\nexport interface ContentApiError {\n\ttype: string\n\tmessage: string\n}\nexport interface ContentApiSearchResponse {\n\tpage: number\n\tresults_per_page: number\n\tresults_size: number\n\ttotal_results_size: number\n\ttotal_pages: number\n\tnext_page: string | null\n\tprev_page: string | null\n\tresults: ContentApiDocument[]\n}\n\nexport interface ContentApiDocument {\n\tid: string\n\tuid: string | null\n\turl: string | null\n\ttype: string\n\thref: string\n\ttags: string[]\n\tfirst_publication_date: string\n\tlast_publication_date: string\n\tslugs: string[]\n\tlinked_documents: unknown[]\n\tlang: string\n\talternate_languages: ContentApiAlternateLanguage[]\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tdata: Record<string, any>\n}\n\nexport interface ContentApiGraphQLResponse {\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tdata: Record<string, any>\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\terrors?: { message: string; locations: any }[]\n}\n\nexport interface ContentApiRef {\n\tid: string\n\tref: string\n\tlabel: string\n\tisMasterRef?: boolean\n\tscheduledAt?: number | undefined\n}\n\ninterface ContentApiAlternateLanguage {\n\tid: string\n\ttype: string\n\tlang: string\n\tuid?: string\n}\n\ninterface ContentApiRepoConfigResponse {\n\trefs: ContentApiRef[]\n\tbookmarks: Record<string, unknown>\n\ttypes: Record<string, string>\n\tlanguages: {\n\t\tid: string\n\t\tname: string\n\t\tis_master: boolean\n\t}[]\n\toauth_initiate: string\n\toauth_token: string\n\ttags: string[]\n\tlicense: string\n\tversion: string\n}\n\ntype SearchQueryParams = {\n\tref?: string\n\tquery?: string\n\tq?: string\n\tgraphQuery?: string\n\tfetchLinks?: string\n\torderings?: string\n\tpageSize?: number\n\tpage?: number\n\tlang?: string\n\tafter?: string\n\troutes?: string\n}\n\ntype ApiVersions = \"v1\" | \"v2\"\n\n/**\n * Client to query the Prismic content api. Uses Playwright to benefit from network request traces\n * in your reports. See api docs: https://prismic.io/docs/rest-api-technical-reference\n */\nexport class ContentApiClient extends AuthenticatedApiClient {\n\tprivate version: ApiVersions\n\tprivate accessToken: string | undefined\n\n\t/**\n\t * @example\n\t * \tTo instantiate the class:\n\t *\n\t * \t```js\n\t * \tnew ContentApiClient(\"https://my-repo.cdn.prismic.io\", {\n\t * \tversion: \"v2\",\n\t * \taccessToken: \"my-secret-token\",\n\t * \t});\n\t * \t```\n\t *\n\t * @param baseURL - The api base URL like https://my-repo.cdn.prismic.io\n\t * @param config - Optional configuration\n\t *\n\t *   - {@link config.version}: Api version, default is \"v2\"\n\t *   - {@link config.accessToken}: Access token for the content api -\n\t *     https://prismic.io/docs/access-token\n\t */\n\tconstructor(baseURL: string, config: { version?: ApiVersions; accessToken?: string } = {}) {\n\t\t// Use an empty string as Authorization header in case it is already set globally in the project Playwright config file.\n\t\t// This is because the content api returns an error in case it gets an non-empty invalid Authorization\n\t\t// even though it actually checks authorization from the access_token query parameter.\n\t\tsuper(baseURL, config.accessToken || \"\")\n\t\tthis.version = config.version || \"v2\"\n\t\tthis.accessToken = config.accessToken\n\t}\n\n\tasync get(\n\t\tpath: string,\n\t\tparams?: SearchQueryParams,\n\t\theaders?: Record<string, string>,\n\t): Promise<APIResponse> {\n\t\tconst context = await this.getContext()\n\t\tconst securityParams = this.accessToken\n\t\t\t? { access_token: this.accessToken }\n\t\t\t: ({} as Record<string, never>)\n\n\t\treturn context.get(path, {\n\t\t\tparams: { ...securityParams, ...params },\n\t\t\theaders,\n\t\t})\n\t}\n\n\tasync getAsJson<T>(\n\t\turl: string,\n\t\tparams?: SearchQueryParams,\n\t\theaders?: Record<string, string>,\n\t): Promise<T> {\n\t\tconst response = await this.get(url, params, headers)\n\n\t\treturn response.json() as T\n\t}\n\n\t/** Query the graphql api - https://prismic.io/docs/graphql-technical-reference */\n\tasync graphql(ref: string, query: string): Promise<ContentApiGraphQLResponse> {\n\t\treturn this.getAsJson<ContentApiGraphQLResponse>(\"graphql\", { query }, { \"Prismic-ref\": ref })\n\t}\n\n\tasync getRefs(): Promise<ContentApiRef[]> {\n\t\tconst data = await this.getAsJson<ContentApiRepoConfigResponse>(`api/${this.version}`)\n\n\t\treturn data.refs\n\t}\n\n\tasync getMasterRef(): Promise<string> {\n\t\tconst refs = await this.getRefs()\n\n\t\tconst masterRef = refs.find(({ isMasterRef }) => isMasterRef === true)\n\t\tif (!masterRef) {\n\t\t\tthrow \"No master ref found\"\n\t\t}\n\n\t\treturn masterRef.ref\n\t}\n\n\tasync getRefByReleaseID(releaseID: string): Promise<string> {\n\t\tconst refs = await this.getRefs()\n\t\tconst release = refs.find(({ id }) => id === releaseID)\n\t\tif (!release) {\n\t\t\tthrow `No ref found for release ${releaseID}`\n\t\t}\n\n\t\treturn release.ref\n\t}\n\n\t/** Search documents from the `/api/v<version>/documents/search` endpoint. */\n\tasync search(filters?: SearchQueryParams): Promise<ContentApiSearchResponse> {\n\t\tlet ref = filters?.ref\n\t\tif (!ref) {\n\t\t\tref = await this.getMasterRef()\n\t\t}\n\n\t\treturn this.getAsJson<ContentApiSearchResponse>(`api/${this.version}/documents/search`, {\n\t\t\t...filters,\n\t\t\tref,\n\t\t})\n\t}\n\n\t/**\n\t * Search for a single document by its it, using the `/api/v<version>/documents/search` endpoint\n\t * and a default filter.\n\t */\n\tasync searchByID(id: string, filters?: SearchQueryParams): Promise<ContentApiSearchResponse> {\n\t\treturn this.search({ ...filters, q: `[[at(document.id, \"${id}\")]]` })\n\t}\n\n\t/** Retrieve a single document or undefined if not found. */\n\tasync getDocumentByID(\n\t\tid: string,\n\t\tfilters?: SearchQueryParams,\n\t): Promise<ContentApiDocument | undefined> {\n\t\tconst data = await this.searchByID(id, filters)\n\t\tswitch (data.results_size) {\n\t\t\tcase 0:\n\t\t\t\treturn\n\t\t\tcase 1:\n\t\t\t\treturn data.results[0]\n\t\t\tdefault:\n\t\t\t\tthrow new Error(`Too many documents returned with the same id ${id}`)\n\t\t}\n\t}\n}\n"],"mappings":";;;;;;AA8FA,IAAa,mBAAb,cAAsC,uBAAuB;CAC5D;CACA;;;;;;;;;;;;;;;;;;;CAoBA,YAAY,SAAiB,SAA0D,CAAC,GAAG;EAI1F,MAAM,SAAS,OAAO,eAAe,EAAE;EACvC,KAAK,UAAU,OAAO,WAAW;EACjC,KAAK,cAAc,OAAO;CAC3B;CAEA,MAAM,IACL,MACA,QACA,SACuB;EACvB,MAAM,UAAU,MAAM,KAAK,WAAW;EACtC,MAAM,iBAAiB,KAAK,cACzB,EAAE,cAAc,KAAK,YAAY,IAChC,CAAC;EAEL,OAAO,QAAQ,IAAI,MAAM;GACxB,QAAQ;IAAE,GAAG;IAAgB,GAAG;GAAO;GACvC;EACD,CAAC;CACF;CAEA,MAAM,UACL,KACA,QACA,SACa;EAGb,QAAO,MAFgB,KAAK,IAAI,KAAK,QAAQ,OAAO,EAAA,CAEpC,KAAK;CACtB;;CAGA,MAAM,QAAQ,KAAa,OAAmD;EAC7E,OAAO,KAAK,UAAqC,WAAW,EAAE,MAAM,GAAG,EAAE,eAAe,IAAI,CAAC;CAC9F;CAEA,MAAM,UAAoC;EAGzC,QAAO,MAFY,KAAK,UAAwC,OAAO,KAAK,SAAS,EAAA,CAEzE;CACb;CAEA,MAAM,eAAgC;EAGrC,MAAM,aAAY,MAFC,KAAK,QAAQ,EAAA,CAET,MAAM,EAAE,kBAAkB,gBAAgB,IAAI;EACrE,IAAI,CAAC,WACJ,MAAM;EAGP,OAAO,UAAU;CAClB;CAEA,MAAM,kBAAkB,WAAoC;EAE3D,MAAM,WAAU,MADG,KAAK,QAAQ,EAAA,CACX,MAAM,EAAE,SAAS,OAAO,SAAS;EACtD,IAAI,CAAC,SACJ,MAAM,4BAA4B;EAGnC,OAAO,QAAQ;CAChB;;CAGA,MAAM,OAAO,SAAgE;EAC5E,IAAI,MAAM,SAAS;EACnB,IAAI,CAAC,KACJ,MAAM,MAAM,KAAK,aAAa;EAG/B,OAAO,KAAK,UAAoC,OAAO,KAAK,QAAQ,oBAAoB;GACvF,GAAG;GACH;EACD,CAAC;CACF;;;;;CAMA,MAAM,WAAW,IAAY,SAAgE;EAC5F,OAAO,KAAK,OAAO;GAAE,GAAG;GAAS,GAAG,sBAAsB,GAAG;EAAM,CAAC;CACrE;;CAGA,MAAM,gBACL,IACA,SAC0C;EAC1C,MAAM,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO;EAC9C,QAAQ,KAAK,cAAb;GACC,KAAK,GACJ;GACD,KAAK,GACJ,OAAO,KAAK,QAAQ;GACrB,SACC,MAAM,IAAI,MAAM,gDAAgD,IAAI;EACtE;CACD;AACD"}