@prismicio/e2e-tests-utils 1.4.0-alpha.2 → 1.4.0

package/README.md

@@ -26,9 +26,9 @@ const config: RepositoryConfig = {
 	defaultLocale: "en-gb",
 	// ... see RepositoryConfig for other options
 };
-const credentials = { email, password };
+const authConfig = { email, password };
 
-const testUtils = createRepositoriesManager("https://prismic.io", credentials);
+const testUtils = createRepositoriesManager({ urlConfig :"https://prismic.io", authConfig});
 const repository = await testUtils.createRepository(config);
 
 // A repository is now available with a unique name and configured as required
@@ -93,6 +93,18 @@ await testUtils.createRepository(config);
 const token = await testUtils.getUserApiToken();
 ```
 
+### Get API clients
+
+The library provides a few api clients for Prismic services. For example the Content Api.
+
+```typescript
+const contentApi = repository.getContentApiClient();
+const document = await contentApi.getDocumentByID(documentId);
+```
+
+The `@prismicio/client` package could have been used but had too many abstractions (caching, error handling) that we don't necessarly want for test execution.
+
+
 ### Retrieve a RepositoryManager of an existing repository
 
 ```typescript
@@ -107,8 +119,8 @@ await repository.createRelease("next release");
 
 When you create the manager, you have 2 options:
 
-- Provide the base Prismic url, like `createRepositoriesManager("https://prismic.io", credentials)`. The library infers the service urls from the base URL like `http://authentication.prismic.io`
-- One a dev environment, you might want to have control over each service url. Use `createRepositoriesManager({ baseURL: "https://...", customTypesApi : "https://...", authenticationApi : "https://..."}, credentials)`
+- Provide the base Prismic url, like `createRepositoriesManager({ urlConfig: "https://prismic.io", authConfig: credentials })`. The library infers the service urls from the base URL like `http://authentication.prismic.io`
+- One a dev environment, you might want to have control over each service url. Use `createRepositoriesManager({ urlConfig: { baseURL: "https://...", customTypesApi : "https://...", authenticationApi : "https://..."}, authConfig })`
 
 #### Customise the log level
 
@@ -116,8 +128,3 @@ By default, the library logs each operation, this can be changed:
 
 - Set the environment variable to `prismic_e2e_tests_utils_silent` to `true` to remove all logs.
 - Set the environment variable to `prismic_e2e_tests_utils_log_level` to `info` or `debug`.
-
-
----
-
-_Note: Make sure to replace placeholders like `email`, `password` and other specific values with your actual configuration._

package/dist/clients/apiClient.cjs

@@ -0,0 +1,39 @@
+"use strict";
+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;
+};
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const test = require("@playwright/test");
+class AuthenticatedApiClient {
+  constructor(baseURL, token, headers) {
+    __publicField(this, "baseURL");
+    __publicField(this, "token");
+    __publicField(this, "headers");
+    __publicField(this, "_context");
+    this.baseURL = baseURL;
+    this.token = token;
+    this.headers = headers;
+  }
+  /**
+   * Returns a Playwright ApiRequestContext instance with the necessary
+   * authorization headers.
+   */
+  async getContext() {
+    if (!this._context) {
+      const token = typeof this.token === "string" ? this.token : await this.token();
+      this._context = await test.request.newContext({
+        baseURL: this.baseURL,
+        extraHTTPHeaders: {
+          Authorization: `Bearer ${token}`,
+          ...this.headers
+        }
+      });
+    }
+    return this._context;
+  }
+}
+exports.AuthenticatedApiClient = AuthenticatedApiClient;
+//# sourceMappingURL=apiClient.cjs.map

package/dist/clients/apiClient.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiClient.cjs","sources":["../../../src/clients/apiClient.ts"],"sourcesContent":["import { APIRequestContext, request } from \"@playwright/test\";\n\n/**\n * The authentication token. Can be a string or a function that returns a\n * promise resolving to the token.\n */\nexport type AuthServerToken = string | (() => Promise<string>);\n\n/**\n * Abstract class for Prismic api clients that use the Prismic authentication\n * server. This class takes care or creating the Playwright context with the\n * necessary authorization headers.\n *\n * This class performs requests with Playwright instead of a library like Axios\n * which has the advantage of tracing all the network details in the Playwright\n * reports making test failures investigation easier for projects that use\n * Playwright.\n */\nexport abstract class AuthenticatedApiClient {\n\tprivate _context?: APIRequestContext;\n\n\tconstructor(\n\t\tprivate readonly baseURL: string,\n\t\tprivate readonly token: AuthServerToken,\n\t\tprivate readonly headers?: { [key: string]: string } | undefined,\n\t) {}\n\n\t/**\n\t * Returns a Playwright ApiRequestContext instance with the necessary\n\t * authorization headers.\n\t */\n\tprotected async getContext(): Promise<APIRequestContext> {\n\t\tif (!this._context) {\n\t\t\tconst token =\n\t\t\t\ttypeof this.token === \"string\" ? this.token : await this.token();\n\n\t\t\tthis._context = await request.newContext({\n\t\t\t\tbaseURL: this.baseURL,\n\t\t\t\textraHTTPHeaders: {\n\t\t\t\t\tAuthorization: `Bearer ${token}`,\n\t\t\t\t\t...this.headers,\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\n\t\treturn this._context;\n\t}\n}\n"],"names":["request"],"mappings":";;;;;;;;;MAkBsB,uBAAsB;AAAA,EAG3C,YACkB,SACA,OACA,SAA+C;AAF/C;AACA;AACA;AALV;AAGU,SAAO,UAAP;AACA,SAAK,QAAL;AACA,SAAO,UAAP;AAAA,EACf;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,MAAM,aAAU;AACrB,QAAA,CAAC,KAAK,UAAU;AACb,YAAA,QACL,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ,MAAM,KAAK;AAErD,WAAA,WAAW,MAAMA,KAAA,QAAQ,WAAW;AAAA,QACxC,SAAS,KAAK;AAAA,QACd,kBAAkB;AAAA,UACjB,eAAe,UAAU,KAAK;AAAA,UAC9B,GAAG,KAAK;AAAA,QACR;AAAA,MAAA,CACD;AAAA,IACF;AAEA,WAAO,KAAK;AAAA,EACb;AACA;;"}

package/dist/clients/apiClient.d.ts

@@ -0,0 +1,30 @@
+import { APIRequestContext } from "@playwright/test";
+/**
+ * The authentication token. Can be a string or a function that returns a
+ * promise resolving to the token.
+ */
+export type AuthServerToken = string | (() => Promise<string>);
+/**
+ * Abstract class for Prismic api clients that use the Prismic authentication
+ * server. This class takes care or creating the Playwright context with the
+ * necessary authorization headers.
+ *
+ * This class performs requests with Playwright instead of a library like Axios
+ * which has the advantage of tracing all the network details in the Playwright
+ * reports making test failures investigation easier for projects that use
+ * Playwright.
+ */
+export declare abstract class AuthenticatedApiClient {
+    private readonly baseURL;
+    private readonly token;
+    private readonly headers?;
+    private _context?;
+    constructor(baseURL: string, token: AuthServerToken, headers?: {
+        [key: string]: string;
+    } | undefined);
+    /**
+     * Returns a Playwright ApiRequestContext instance with the necessary
+     * authorization headers.
+     */
+    protected getContext(): Promise<APIRequestContext>;
+}

package/dist/clients/apiClient.js

@@ -0,0 +1,39 @@
+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 { request } from "@playwright/test";
+class AuthenticatedApiClient {
+  constructor(baseURL, token, headers) {
+    __publicField(this, "baseURL");
+    __publicField(this, "token");
+    __publicField(this, "headers");
+    __publicField(this, "_context");
+    this.baseURL = baseURL;
+    this.token = token;
+    this.headers = headers;
+  }
+  /**
+   * Returns a Playwright ApiRequestContext instance with the necessary
+   * authorization headers.
+   */
+  async getContext() {
+    if (!this._context) {
+      const token = typeof this.token === "string" ? this.token : await this.token();
+      this._context = await request.newContext({
+        baseURL: this.baseURL,
+        extraHTTPHeaders: {
+          Authorization: `Bearer ${token}`,
+          ...this.headers
+        }
+      });
+    }
+    return this._context;
+  }
+}
+export {
+  AuthenticatedApiClient
+};
+//# sourceMappingURL=apiClient.js.map

package/dist/clients/apiClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiClient.js","sources":["../../../src/clients/apiClient.ts"],"sourcesContent":["import { APIRequestContext, request } from \"@playwright/test\";\n\n/**\n * The authentication token. Can be a string or a function that returns a\n * promise resolving to the token.\n */\nexport type AuthServerToken = string | (() => Promise<string>);\n\n/**\n * Abstract class for Prismic api clients that use the Prismic authentication\n * server. This class takes care or creating the Playwright context with the\n * necessary authorization headers.\n *\n * This class performs requests with Playwright instead of a library like Axios\n * which has the advantage of tracing all the network details in the Playwright\n * reports making test failures investigation easier for projects that use\n * Playwright.\n */\nexport abstract class AuthenticatedApiClient {\n\tprivate _context?: APIRequestContext;\n\n\tconstructor(\n\t\tprivate readonly baseURL: string,\n\t\tprivate readonly token: AuthServerToken,\n\t\tprivate readonly headers?: { [key: string]: string } | undefined,\n\t) {}\n\n\t/**\n\t * Returns a Playwright ApiRequestContext instance with the necessary\n\t * authorization headers.\n\t */\n\tprotected async getContext(): Promise<APIRequestContext> {\n\t\tif (!this._context) {\n\t\t\tconst token =\n\t\t\t\ttypeof this.token === \"string\" ? this.token : await this.token();\n\n\t\t\tthis._context = await request.newContext({\n\t\t\t\tbaseURL: this.baseURL,\n\t\t\t\textraHTTPHeaders: {\n\t\t\t\t\tAuthorization: `Bearer ${token}`,\n\t\t\t\t\t...this.headers,\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\n\t\treturn this._context;\n\t}\n}\n"],"names":[],"mappings":";;;;;;;MAkBsB,uBAAsB;AAAA,EAG3C,YACkB,SACA,OACA,SAA+C;AAF/C;AACA;AACA;AALV;AAGU,SAAO,UAAP;AACA,SAAK,QAAL;AACA,SAAO,UAAP;AAAA,EACf;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,MAAM,aAAU;AACrB,QAAA,CAAC,KAAK,UAAU;AACb,YAAA,QACL,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ,MAAM,KAAK;AAErD,WAAA,WAAW,MAAM,QAAQ,WAAW;AAAA,QACxC,SAAS,KAAK;AAAA,QACd,kBAAkB;AAAA,UACjB,eAAe,UAAU,KAAK;AAAA,UAC9B,GAAG,KAAK;AAAA,QACR;AAAA,MAAA,CACD;AAAA,IACF;AAEA,WAAO,KAAK;AAAA,EACb;AACA;"}

package/dist/clients/authenticationApi.cjs

@@ -1,55 +1,75 @@
 "use strict";
+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;
+};
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const axios = require("axios");
+const test = require("@playwright/test");
 const log = require("../utils/log.cjs");
-const createAuthenticationApiClient = (baseURL, auth) => {
-  let authToken;
-  const client = axios.create({
-    baseURL,
-    validateStatus: () => true
-    // Don't throw on 4XX errors
-  });
-  async function login() {
+class AuthenticationApiClient {
+  constructor(baseURL, auth) {
+    __publicField(this, "baseURL");
+    __publicField(this, "auth");
+    __publicField(this, "authToken");
+    __publicField(this, "_context");
+    this.baseURL = baseURL;
+    this.auth = auth;
+  }
+  async getContext() {
+    if (!this._context) {
+      this._context = await test.request.newContext({
+        baseURL: this.baseURL
+      });
+    }
+    return this._context;
+  }
+  async login() {
     const profiler = log.logger.startTimer();
-    const result = await client.post("login", {
-      email: auth.email,
-      password: auth.password
+    const context = await this.getContext();
+    const result = await context.post("login", {
+      data: {
+        email: this.auth.email,
+        password: this.auth.password
+      }
     });
-    if (!result.data || typeof result.data !== "string") {
-      log.logHttpResponse(result);
+    const token = await result.text();
+    if (!result.ok() || !token) {
+      log.logPlaywrightApiResponse(result);
       throw new Error("Authentication failed, no token received.");
     }
     profiler.done({
-      message: `generated user token for ${auth.email} from auth service`
+      message: `generated user token for ${this.auth.email} from auth service`
     });
-    return result.data;
+    return token;
   }
-  async function getToken() {
-    if (!authToken) {
-      authToken = await login();
+  /** Return an api user token. Creates one if needed. */
+  async getToken() {
+    if (!this.authToken) {
+      this.authToken = await this.login();
     }
-    return authToken;
+    return this.authToken;
   }
-  async function getMachine2MachineToken(repository) {
-    if (!authToken) {
-      authToken = await login();
+  /** Return an api user token. Creates one if needed. */
+  async getMachine2MachineToken(repository) {
+    if (!this.authToken) {
+      this.authToken = await this.login();
     }
-    const result = await client.get("machine2machine", {
+    const context = await this.getContext();
+    const result = await context.get("machine2machine", {
       headers: {
-        Authorization: `Bearer ${authToken}`,
+        Authorization: `Bearer ${this.authToken}`,
         repository
       }
     });
-    if (![200].includes(result.status) || !result.data.token) {
-      log.logHttpResponse(result);
+    if (!result.ok()) {
+      log.logPlaywrightApiResponse(result);
       throw new Error("Machine2Machine token generation failed, no token received.");
     }
-    return result.data.token;
+    const token = (await result.json()).token;
+    return token;
   }
-  return {
-    getToken,
-    getMachine2MachineToken
-  };
-};
-exports.createAuthenticationApiClient = createAuthenticationApiClient;
+}
+exports.AuthenticationApiClient = AuthenticationApiClient;
 //# sourceMappingURL=authenticationApi.cjs.map

package/dist/clients/authenticationApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"authenticationApi.cjs","sources":["../../../src/clients/authenticationApi.ts"],"sourcesContent":["import axios, { AxiosInstance } from \"axios\";\n\nimport { AuthConfig } from \"../types\";\n\nimport { logHttpResponse, logger } from \"../utils/log\";\n\nexport type AuthenticationClient = {\n\tgetToken: () => Promise<string>;\n\tgetMachine2MachineToken: (repository: string) => Promise<string>;\n};\n\n/** Client for interacting with the authentication service to manage tokens */\nexport const createAuthenticationApiClient = (\n\tbaseURL: string,\n\tauth: AuthConfig,\n): AuthenticationClient => {\n\tlet authToken: string;\n\n\tconst client: AxiosInstance = axios.create({\n\t\tbaseURL,\n\t\tvalidateStatus: () => true, // Don't throw on 4XX errors\n\t});\n\n\tasync function login(): Promise<string> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst result = await client.post(\"login\", {\n\t\t\temail: auth.email,\n\t\t\tpassword: auth.password,\n\t\t});\n\n\t\tif (!result.data || typeof result.data !== \"string\") {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\"Authentication failed, no token received.\");\n\t\t}\n\n\t\tprofiler.done({\n\t\t\tmessage: `generated user token for ${auth.email} from auth service`,\n\t\t});\n\n\t\treturn result.data;\n\t}\n\n\t/** Return an api user token. Creates one if needed. */\n\tasync function getToken(): Promise<string> {\n\t\tif (!authToken) {\n\t\t\tauthToken = await login();\n\t\t}\n\n\t\treturn authToken;\n\t}\n\n\t/** Return an api user token. Creates one if needed. */\n\tasync function getMachine2MachineToken(repository: string): Promise<string> {\n\t\tif (!authToken) {\n\t\t\tauthToken = await login();\n\t\t}\n\t\tconst result = await client.get<{ token: string; timestamp: number }>(\n\t\t\t\"machine2machine\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\tAuthorization: `Bearer ${authToken}`,\n\t\t\t\t\trepository,\n\t\t\t\t},\n\t\t\t},\n\t\t);\n\n\t\tif (![200].includes(result.status) || !result.data.token) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\n\t\t\t\t\"Machine2Machine token generation failed, no token received.\",\n\t\t\t);\n\t\t}\n\n\t\treturn result.data.token;\n\t}\n\n\treturn {\n\t\tgetToken,\n\t\tgetMachine2MachineToken,\n\t};\n};\n"],"names":["logger","logHttpResponse"],"mappings":";;;;AAYa,MAAA,gCAAgC,CAC5C,SACA,SACyB;AACrB,MAAA;AAEE,QAAA,SAAwB,MAAM,OAAO;AAAA,IAC1C;AAAA,IACA,gBAAgB,MAAM;AAAA;AAAA,EAAA,CACtB;AAED,iBAAe,QAAK;AACb,UAAA,WAAWA,WAAO;AAExB,UAAM,SAAS,MAAM,OAAO,KAAK,SAAS;AAAA,MACzC,OAAO,KAAK;AAAA,MACZ,UAAU,KAAK;AAAA,IAAA,CACf;AAED,QAAI,CAAC,OAAO,QAAQ,OAAO,OAAO,SAAS,UAAU;AACpDC,UAAA,gBAAgB,MAAM;AAChB,YAAA,IAAI,MAAM,2CAA2C;AAAA,IAC5D;AAEA,aAAS,KAAK;AAAA,MACb,SAAS,4BAA4B,KAAK,KAAK;AAAA,IAAA,CAC/C;AAED,WAAO,OAAO;AAAA,EACf;AAGA,iBAAe,WAAQ;AACtB,QAAI,CAAC,WAAW;AACf,kBAAY,MAAM;IACnB;AAEO,WAAA;AAAA,EACR;AAGA,iBAAe,wBAAwB,YAAkB;AACxD,QAAI,CAAC,WAAW;AACf,kBAAY,MAAM;IACnB;AACA,UAAM,SAAS,MAAM,OAAO,IAC3B,mBACA;AAAA,MACC,SAAS;AAAA,QACR,eAAe,UAAU,SAAS;AAAA,QAClC;AAAA,MACA;AAAA,IAAA,CACD;AAGE,QAAA,CAAC,CAAC,GAAG,EAAE,SAAS,OAAO,MAAM,KAAK,CAAC,OAAO,KAAK,OAAO;AACzDA,UAAA,gBAAgB,MAAM;AAChB,YAAA,IAAI,MACT,6DAA6D;AAAA,IAE/D;AAEA,WAAO,OAAO,KAAK;AAAA,EACpB;AAEO,SAAA;AAAA,IACN;AAAA,IACA;AAAA,EAAA;AAEF;;"}
+{"version":3,"file":"authenticationApi.cjs","sources":["../../../src/clients/authenticationApi.ts"],"sourcesContent":["import { APIRequestContext, request } from \"@playwright/test\";\n\nimport { AuthConfig } from \"../types\";\n\nimport { logPlaywrightApiResponse, logger } from \"../utils/log\";\n\n/** Client for interacting with the authentication service to manage tokens */\nexport class AuthenticationApiClient {\n\tprivate authToken?: string;\n\tprivate _context?: APIRequestContext;\n\n\tconstructor(\n\t\tprivate readonly baseURL: string,\n\t\tprivate readonly auth: AuthConfig,\n\t) {}\n\n\tprivate async getContext(): Promise<APIRequestContext> {\n\t\tif (!this._context) {\n\t\t\tthis._context = await request.newContext({\n\t\t\t\tbaseURL: this.baseURL,\n\t\t\t});\n\t\t}\n\n\t\treturn this._context;\n\t}\n\n\tprivate async login(): Promise<string> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.post(\"login\", {\n\t\t\tdata: {\n\t\t\t\temail: this.auth.email,\n\t\t\t\tpassword: this.auth.password,\n\t\t\t},\n\t\t});\n\n\t\tconst token = await result.text();\n\t\tif (!result.ok() || !token) {\n\t\t\tlogPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Authentication failed, no token received.\");\n\t\t}\n\n\t\tprofiler.done({\n\t\t\tmessage: `generated user token for ${this.auth.email} from auth service`,\n\t\t});\n\n\t\treturn token;\n\t}\n\n\t/** Return an api user token. Creates one if needed. */\n\tasync getToken(): Promise<string> {\n\t\tif (!this.authToken) {\n\t\t\tthis.authToken = await this.login();\n\t\t}\n\n\t\treturn this.authToken;\n\t}\n\n\t/** Return an api user token. Creates one if needed. */\n\tasync getMachine2MachineToken(repository: string): Promise<string> {\n\t\tif (!this.authToken) {\n\t\t\tthis.authToken = await this.login();\n\t\t}\n\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(\"machine2machine\", {\n\t\t\theaders: {\n\t\t\t\tAuthorization: `Bearer ${this.authToken}`,\n\t\t\t\trepository,\n\t\t\t},\n\t\t});\n\n\t\tif (!result.ok()) {\n\t\t\tlogPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\n\t\t\t\t\"Machine2Machine token generation failed, no token received.\",\n\t\t\t);\n\t\t}\n\t\tconst token = (await result.json()).token;\n\n\t\treturn token;\n\t}\n}\n"],"names":["request","logger","logPlaywrightApiResponse"],"mappings":";;;;;;;;;;MAOa,wBAAuB;AAAA,EAInC,YACkB,SACA,MAAgB;AADhB;AACA;AALV;AACA;AAGU,SAAO,UAAP;AACA,SAAI,OAAJ;AAAA,EACf;AAAA,EAEK,MAAM,aAAU;AACnB,QAAA,CAAC,KAAK,UAAU;AACd,WAAA,WAAW,MAAMA,KAAA,QAAQ,WAAW;AAAA,QACxC,SAAS,KAAK;AAAA,MAAA,CACd;AAAA,IACF;AAEA,WAAO,KAAK;AAAA,EACb;AAAA,EAEQ,MAAM,QAAK;AACZ,UAAA,WAAWC,WAAO;AAElB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,KAAK,SAAS;AAAA,MAC1C,MAAM;AAAA,QACL,OAAO,KAAK,KAAK;AAAA,QACjB,UAAU,KAAK,KAAK;AAAA,MACpB;AAAA,IAAA,CACD;AAEK,UAAA,QAAQ,MAAM,OAAO;AAC3B,QAAI,CAAC,OAAO,QAAQ,CAAC,OAAO;AAC3BC,UAAA,yBAAyB,MAAM;AACzB,YAAA,IAAI,MAAM,2CAA2C;AAAA,IAC5D;AAEA,aAAS,KAAK;AAAA,MACb,SAAS,4BAA4B,KAAK,KAAK,KAAK;AAAA,IAAA,CACpD;AAEM,WAAA;AAAA,EACR;AAAA;AAAA,EAGA,MAAM,WAAQ;AACT,QAAA,CAAC,KAAK,WAAW;AACf,WAAA,YAAY,MAAM,KAAK;IAC7B;AAEA,WAAO,KAAK;AAAA,EACb;AAAA;AAAA,EAGA,MAAM,wBAAwB,YAAkB;AAC3C,QAAA,CAAC,KAAK,WAAW;AACf,WAAA,YAAY,MAAM,KAAK;IAC7B;AAEM,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,mBAAmB;AAAA,MACnD,SAAS;AAAA,QACR,eAAe,UAAU,KAAK,SAAS;AAAA,QACvC;AAAA,MACA;AAAA,IAAA,CACD;AAEG,QAAA,CAAC,OAAO,MAAM;AACjBA,UAAA,yBAAyB,MAAM;AACzB,YAAA,IAAI,MACT,6DAA6D;AAAA,IAE/D;AACA,UAAM,SAAS,MAAM,OAAO,KAAA,GAAQ;AAE7B,WAAA;AAAA,EACR;AACA;;"}

package/dist/clients/authenticationApi.d.ts

@@ -1,7 +1,15 @@
 import { AuthConfig } from "../types";
-export type AuthenticationClient = {
-    getToken: () => Promise<string>;
-    getMachine2MachineToken: (repository: string) => Promise<string>;
-};
 /** Client for interacting with the authentication service to manage tokens */
-export declare const createAuthenticationApiClient: (baseURL: string, auth: AuthConfig) => AuthenticationClient;
+export declare class AuthenticationApiClient {
+    private readonly baseURL;
+    private readonly auth;
+    private authToken?;
+    private _context?;
+    constructor(baseURL: string, auth: AuthConfig);
+    private getContext;
+    private login;
+    /** Return an api user token. Creates one if needed. */
+    getToken(): Promise<string>;
+    /** Return an api user token. Creates one if needed. */
+    getMachine2MachineToken(repository: string): Promise<string>;
+}

package/dist/clients/authenticationApi.js

@@ -1,55 +1,75 @@
-import axios from "axios";
-import { logHttpResponse, logger } from "../utils/log.js";
-const createAuthenticationApiClient = (baseURL, auth) => {
-  let authToken;
-  const client = axios.create({
-    baseURL,
-    validateStatus: () => true
-    // Don't throw on 4XX errors
-  });
-  async function login() {
+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 { request } from "@playwright/test";
+import { logger, logPlaywrightApiResponse } from "../utils/log.js";
+class AuthenticationApiClient {
+  constructor(baseURL, auth) {
+    __publicField(this, "baseURL");
+    __publicField(this, "auth");
+    __publicField(this, "authToken");
+    __publicField(this, "_context");
+    this.baseURL = baseURL;
+    this.auth = auth;
+  }
+  async getContext() {
+    if (!this._context) {
+      this._context = await request.newContext({
+        baseURL: this.baseURL
+      });
+    }
+    return this._context;
+  }
+  async login() {
     const profiler = logger.startTimer();
-    const result = await client.post("login", {
-      email: auth.email,
-      password: auth.password
+    const context = await this.getContext();
+    const result = await context.post("login", {
+      data: {
+        email: this.auth.email,
+        password: this.auth.password
+      }
     });
-    if (!result.data || typeof result.data !== "string") {
-      logHttpResponse(result);
+    const token = await result.text();
+    if (!result.ok() || !token) {
+      logPlaywrightApiResponse(result);
       throw new Error("Authentication failed, no token received.");
     }
     profiler.done({
-      message: `generated user token for ${auth.email} from auth service`
+      message: `generated user token for ${this.auth.email} from auth service`
     });
-    return result.data;
+    return token;
   }
-  async function getToken() {
-    if (!authToken) {
-      authToken = await login();
+  /** Return an api user token. Creates one if needed. */
+  async getToken() {
+    if (!this.authToken) {
+      this.authToken = await this.login();
     }
-    return authToken;
+    return this.authToken;
   }
-  async function getMachine2MachineToken(repository) {
-    if (!authToken) {
-      authToken = await login();
+  /** Return an api user token. Creates one if needed. */
+  async getMachine2MachineToken(repository) {
+    if (!this.authToken) {
+      this.authToken = await this.login();
     }
-    const result = await client.get("machine2machine", {
+    const context = await this.getContext();
+    const result = await context.get("machine2machine", {
       headers: {
-        Authorization: `Bearer ${authToken}`,
+        Authorization: `Bearer ${this.authToken}`,
         repository
       }
     });
-    if (![200].includes(result.status) || !result.data.token) {
-      logHttpResponse(result);
+    if (!result.ok()) {
+      logPlaywrightApiResponse(result);
       throw new Error("Machine2Machine token generation failed, no token received.");
     }
-    return result.data.token;
+    const token = (await result.json()).token;
+    return token;
   }
-  return {
-    getToken,
-    getMachine2MachineToken
-  };
-};
+}
 export {
-  createAuthenticationApiClient
+  AuthenticationApiClient
 };
 //# sourceMappingURL=authenticationApi.js.map

package/dist/clients/authenticationApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"authenticationApi.js","sources":["../../../src/clients/authenticationApi.ts"],"sourcesContent":["import axios, { AxiosInstance } from \"axios\";\n\nimport { AuthConfig } from \"../types\";\n\nimport { logHttpResponse, logger } from \"../utils/log\";\n\nexport type AuthenticationClient = {\n\tgetToken: () => Promise<string>;\n\tgetMachine2MachineToken: (repository: string) => Promise<string>;\n};\n\n/** Client for interacting with the authentication service to manage tokens */\nexport const createAuthenticationApiClient = (\n\tbaseURL: string,\n\tauth: AuthConfig,\n): AuthenticationClient => {\n\tlet authToken: string;\n\n\tconst client: AxiosInstance = axios.create({\n\t\tbaseURL,\n\t\tvalidateStatus: () => true, // Don't throw on 4XX errors\n\t});\n\n\tasync function login(): Promise<string> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst result = await client.post(\"login\", {\n\t\t\temail: auth.email,\n\t\t\tpassword: auth.password,\n\t\t});\n\n\t\tif (!result.data || typeof result.data !== \"string\") {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\"Authentication failed, no token received.\");\n\t\t}\n\n\t\tprofiler.done({\n\t\t\tmessage: `generated user token for ${auth.email} from auth service`,\n\t\t});\n\n\t\treturn result.data;\n\t}\n\n\t/** Return an api user token. Creates one if needed. */\n\tasync function getToken(): Promise<string> {\n\t\tif (!authToken) {\n\t\t\tauthToken = await login();\n\t\t}\n\n\t\treturn authToken;\n\t}\n\n\t/** Return an api user token. Creates one if needed. */\n\tasync function getMachine2MachineToken(repository: string): Promise<string> {\n\t\tif (!authToken) {\n\t\t\tauthToken = await login();\n\t\t}\n\t\tconst result = await client.get<{ token: string; timestamp: number }>(\n\t\t\t\"machine2machine\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\tAuthorization: `Bearer ${authToken}`,\n\t\t\t\t\trepository,\n\t\t\t\t},\n\t\t\t},\n\t\t);\n\n\t\tif (![200].includes(result.status) || !result.data.token) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\n\t\t\t\t\"Machine2Machine token generation failed, no token received.\",\n\t\t\t);\n\t\t}\n\n\t\treturn result.data.token;\n\t}\n\n\treturn {\n\t\tgetToken,\n\t\tgetMachine2MachineToken,\n\t};\n};\n"],"names":[],"mappings":";;AAYa,MAAA,gCAAgC,CAC5C,SACA,SACyB;AACrB,MAAA;AAEE,QAAA,SAAwB,MAAM,OAAO;AAAA,IAC1C;AAAA,IACA,gBAAgB,MAAM;AAAA;AAAA,EAAA,CACtB;AAED,iBAAe,QAAK;AACb,UAAA,WAAW,OAAO;AAExB,UAAM,SAAS,MAAM,OAAO,KAAK,SAAS;AAAA,MACzC,OAAO,KAAK;AAAA,MACZ,UAAU,KAAK;AAAA,IAAA,CACf;AAED,QAAI,CAAC,OAAO,QAAQ,OAAO,OAAO,SAAS,UAAU;AACpD,sBAAgB,MAAM;AAChB,YAAA,IAAI,MAAM,2CAA2C;AAAA,IAC5D;AAEA,aAAS,KAAK;AAAA,MACb,SAAS,4BAA4B,KAAK,KAAK;AAAA,IAAA,CAC/C;AAED,WAAO,OAAO;AAAA,EACf;AAGA,iBAAe,WAAQ;AACtB,QAAI,CAAC,WAAW;AACf,kBAAY,MAAM;IACnB;AAEO,WAAA;AAAA,EACR;AAGA,iBAAe,wBAAwB,YAAkB;AACxD,QAAI,CAAC,WAAW;AACf,kBAAY,MAAM;IACnB;AACA,UAAM,SAAS,MAAM,OAAO,IAC3B,mBACA;AAAA,MACC,SAAS;AAAA,QACR,eAAe,UAAU,SAAS;AAAA,QAClC;AAAA,MACA;AAAA,IAAA,CACD;AAGE,QAAA,CAAC,CAAC,GAAG,EAAE,SAAS,OAAO,MAAM,KAAK,CAAC,OAAO,KAAK,OAAO;AACzD,sBAAgB,MAAM;AAChB,YAAA,IAAI,MACT,6DAA6D;AAAA,IAE/D;AAEA,WAAO,OAAO,KAAK;AAAA,EACpB;AAEO,SAAA;AAAA,IACN;AAAA,IACA;AAAA,EAAA;AAEF;"}
+{"version":3,"file":"authenticationApi.js","sources":["../../../src/clients/authenticationApi.ts"],"sourcesContent":["import { APIRequestContext, request } from \"@playwright/test\";\n\nimport { AuthConfig } from \"../types\";\n\nimport { logPlaywrightApiResponse, logger } from \"../utils/log\";\n\n/** Client for interacting with the authentication service to manage tokens */\nexport class AuthenticationApiClient {\n\tprivate authToken?: string;\n\tprivate _context?: APIRequestContext;\n\n\tconstructor(\n\t\tprivate readonly baseURL: string,\n\t\tprivate readonly auth: AuthConfig,\n\t) {}\n\n\tprivate async getContext(): Promise<APIRequestContext> {\n\t\tif (!this._context) {\n\t\t\tthis._context = await request.newContext({\n\t\t\t\tbaseURL: this.baseURL,\n\t\t\t});\n\t\t}\n\n\t\treturn this._context;\n\t}\n\n\tprivate async login(): Promise<string> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.post(\"login\", {\n\t\t\tdata: {\n\t\t\t\temail: this.auth.email,\n\t\t\t\tpassword: this.auth.password,\n\t\t\t},\n\t\t});\n\n\t\tconst token = await result.text();\n\t\tif (!result.ok() || !token) {\n\t\t\tlogPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Authentication failed, no token received.\");\n\t\t}\n\n\t\tprofiler.done({\n\t\t\tmessage: `generated user token for ${this.auth.email} from auth service`,\n\t\t});\n\n\t\treturn token;\n\t}\n\n\t/** Return an api user token. Creates one if needed. */\n\tasync getToken(): Promise<string> {\n\t\tif (!this.authToken) {\n\t\t\tthis.authToken = await this.login();\n\t\t}\n\n\t\treturn this.authToken;\n\t}\n\n\t/** Return an api user token. Creates one if needed. */\n\tasync getMachine2MachineToken(repository: string): Promise<string> {\n\t\tif (!this.authToken) {\n\t\t\tthis.authToken = await this.login();\n\t\t}\n\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(\"machine2machine\", {\n\t\t\theaders: {\n\t\t\t\tAuthorization: `Bearer ${this.authToken}`,\n\t\t\t\trepository,\n\t\t\t},\n\t\t});\n\n\t\tif (!result.ok()) {\n\t\t\tlogPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\n\t\t\t\t\"Machine2Machine token generation failed, no token received.\",\n\t\t\t);\n\t\t}\n\t\tconst token = (await result.json()).token;\n\n\t\treturn token;\n\t}\n}\n"],"names":[],"mappings":";;;;;;;;MAOa,wBAAuB;AAAA,EAInC,YACkB,SACA,MAAgB;AADhB;AACA;AALV;AACA;AAGU,SAAO,UAAP;AACA,SAAI,OAAJ;AAAA,EACf;AAAA,EAEK,MAAM,aAAU;AACnB,QAAA,CAAC,KAAK,UAAU;AACd,WAAA,WAAW,MAAM,QAAQ,WAAW;AAAA,QACxC,SAAS,KAAK;AAAA,MAAA,CACd;AAAA,IACF;AAEA,WAAO,KAAK;AAAA,EACb;AAAA,EAEQ,MAAM,QAAK;AACZ,UAAA,WAAW,OAAO;AAElB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,KAAK,SAAS;AAAA,MAC1C,MAAM;AAAA,QACL,OAAO,KAAK,KAAK;AAAA,QACjB,UAAU,KAAK,KAAK;AAAA,MACpB;AAAA,IAAA,CACD;AAEK,UAAA,QAAQ,MAAM,OAAO;AAC3B,QAAI,CAAC,OAAO,QAAQ,CAAC,OAAO;AAC3B,+BAAyB,MAAM;AACzB,YAAA,IAAI,MAAM,2CAA2C;AAAA,IAC5D;AAEA,aAAS,KAAK;AAAA,MACb,SAAS,4BAA4B,KAAK,KAAK,KAAK;AAAA,IAAA,CACpD;AAEM,WAAA;AAAA,EACR;AAAA;AAAA,EAGA,MAAM,WAAQ;AACT,QAAA,CAAC,KAAK,WAAW;AACf,WAAA,YAAY,MAAM,KAAK;IAC7B;AAEA,WAAO,KAAK;AAAA,EACb;AAAA;AAAA,EAGA,MAAM,wBAAwB,YAAkB;AAC3C,QAAA,CAAC,KAAK,WAAW;AACf,WAAA,YAAY,MAAM,KAAK;IAC7B;AAEM,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,mBAAmB;AAAA,MACnD,SAAS;AAAA,QACR,eAAe,UAAU,KAAK,SAAS;AAAA,QACvC;AAAA,MACA;AAAA,IAAA,CACD;AAEG,QAAA,CAAC,OAAO,MAAM;AACjB,+BAAyB,MAAM;AACzB,YAAA,IAAI,MACT,6DAA6D;AAAA,IAE/D;AACA,UAAM,SAAS,MAAM,OAAO,KAAA,GAAQ;AAE7B,WAAA;AAAA,EACR;AACA;"}

package/dist/clients/contentApi.cjs

@@ -5,35 +5,18 @@ var __publicField = (obj, key, value) => {
   __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
-var __privateMethod = (obj, member, method) => {
-  __accessCheck(obj, member, "access private method");
-  return method;
-};
-var _version, _accessToken, _context, context_fn;
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const test = require("@playwright/test");
-class ContentApiClient {
+const apiClient = require("./apiClient.cjs");
+class ContentApiClient extends apiClient.AuthenticatedApiClient {
   /**
-   * @example new ContentApiClient("https://my-repo.cdn.prismic.io" { version :
-   * "v2", accessToken: "my-secret-token" })
+   * @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
@@ -43,18 +26,16 @@ class ContentApiClient {
    *       https://prismic.io/docs/access-token
    */
   constructor(baseURL, config = {}) {
-    __privateAdd(this, _context);
-    __publicField(this, "baseURL");
-    __privateAdd(this, _version, void 0);
-    __privateAdd(this, _accessToken, void 0);
-    this.baseURL = baseURL;
-    __privateSet(this, _version, config.version || "v2");
-    __privateSet(this, _accessToken, config.accessToken);
+    super(baseURL, "");
+    __publicField(this, "version");
+    __publicField(this, "accessToken");
+    this.version = config.version || "v2";
+    this.accessToken = config.accessToken;
   }
   async get(path, params, headers) {
-    const context = await __privateMethod(this, _context, context_fn).call(this);
+    const context = await this.getContext();
     const securityParams = {
-      ...__privateGet(this, _accessToken) ? { access_token: __privateGet(this, _accessToken) } : {}
+      ...this.accessToken ? { access_token: this.accessToken } : {}
     };
     return context.get(path, {
       params: { ...securityParams, ...params },
@@ -67,10 +48,10 @@ class ContentApiClient {
   }
   /** Query the graphql api - https://prismic.io/docs/graphql-technical-reference */
   async graphql(ref, query) {
-    return this.getAsJson("/graphql", { query }, { "Prismic-ref": ref });
+    return this.getAsJson("graphql", { query }, { "Prismic-ref": ref });
   }
   async getRefs() {
-    const data = await this.getAsJson(`/api/${__privateGet(this, _version)}`);
+    const data = await this.getAsJson(`api/${this.version}`);
     return data.refs;
   }
   async getMasterRef() {
@@ -95,7 +76,7 @@ class ContentApiClient {
     if (!ref) {
       ref = await this.getMasterRef();
     }
-    return this.getAsJson(`/api/${__privateGet(this, _version)}/documents/search`, {
+    return this.getAsJson(`api/${this.version}/documents/search`, {
       ...filters,
       ref
     });
@@ -120,16 +101,5 @@ class ContentApiClient {
     }
   }
 }
-_version = new WeakMap();
-_accessToken = new WeakMap();
-_context = new WeakSet();
-context_fn = function() {
-  return test.request.newContext({
-    baseURL: this.baseURL,
-    // reset any Authorization header set globally with Playwright
-    // didn't find a way to delete it
-    extraHTTPHeaders: { Authorization: "" }
-  });
-};
 exports.ContentApiClient = ContentApiClient;
 //# sourceMappingURL=contentApi.cjs.map

package/dist/clients/contentApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"contentApi.cjs","sources":["../../../src/clients/contentApi.ts"],"sourcesContent":["import { APIResponse, request } from \"@playwright/test\";\n\nexport interface Error {\n\ttype: string;\n\tmessage: string;\n}\nexport interface SearchResponse {\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: Document[];\n}\n\nexport interface Document {\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: string[];\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tdata: Record<string, any>;\n}\n\nexport interface GraphQLResponse {\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 Ref {\n\tid: string;\n\tref: string;\n\tlabel: string;\n\tisMasterRef?: boolean;\n}\n\nexport interface RepoConfig {\n\trefs: Ref[];\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\nexport type QueryParams = {\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. The @prismicio/client could have been\n * used but had too many abstractions (caching, error handling) that we didn't\n * want for test execution. See api docs:\n * https://prismic.io/docs/rest-api-technical-reference\n */\nexport class ContentApiClient {\n\t#version: ApiVersions;\n\t#accessToken: string | undefined;\n\n\t/**\n\t * @example new ContentApiClient(\"https://my-repo.cdn.prismic.io\" { version :\n\t * \"v2\", accessToken: \"my-secret-token\" })\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\tprivate readonly baseURL: string,\n\t\tconfig: { version?: ApiVersions; accessToken?: string } = {},\n\t) {\n\t\tthis.#version = config.version || \"v2\";\n\t\tthis.#accessToken = config.accessToken;\n\t}\n\n\t#context() {\n\t\treturn request.newContext({\n\t\t\tbaseURL: this.baseURL,\n\t\t\t// reset any Authorization header set globally with Playwright\n\t\t\t// didn't find a way to delete it\n\t\t\textraHTTPHeaders: { Authorization: \"\" },\n\t\t});\n\t}\n\n\tasync get(\n\t\tpath: string,\n\t\tparams?: QueryParams,\n\t\theaders?: Record<string, string>,\n\t): Promise<APIResponse> {\n\t\tconst context = await this.#context();\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?: QueryParams,\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<GraphQLResponse> {\n\t\treturn this.getAsJson<GraphQLResponse>(\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<Ref[]> {\n\t\tconst data = await this.getAsJson<RepoConfig>(`/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?: QueryParams): Promise<SearchResponse> {\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<SearchResponse>(\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(id: string, filters?: QueryParams): Promise<SearchResponse> {\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?: QueryParams,\n\t): Promise<Document | 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":["request"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAuFa,iBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAe5B,YACkB,SACjB,SAA0D,IAAE;AAM7D;AAPkB;AAflB;AACA;AAckB,SAAO,UAAP;AAGZ,uBAAA,UAAW,OAAO,WAAW;AAClC,uBAAK,cAAe,OAAO;AAAA,EAC5B;AAAA,EAWA,MAAM,IACL,MACA,QACA,SAAgC;AAE1B,UAAA,UAAU,MAAM,sBAAK,sBAAL;AACtB,UAAM,iBAAiB;AAAA,MACtB,GAAI,mBAAK,gBAAe,EAAE,cAAc,mBAAK,cAAA,IAAiB;;AAGxD,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,QAAQ,KAAa,OAAa;AAChC,WAAA,KAAK,UACX,YACA,EAAE,SACF,EAAE,eAAe,IAAA,CAAK;AAAA,EAExB;AAAA,EAEA,MAAM,UAAO;AACZ,UAAM,OAAO,MAAM,KAAK,UAAsB,QAAQ,mBAAK,SAAQ,EAAE;AAErE,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,SAAqB;AACjC,QAAI,MAAM,mCAAS;AACnB,QAAI,CAAC,KAAK;AACH,YAAA,MAAM,KAAK;IAClB;AAEA,WAAO,KAAK,UACX,QAAQ,mBAAK,SAAQ,qBACrB;AAAA,MACC,GAAG;AAAA,MACH;AAAA,IAAA,CACA;AAAA,EAEH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,WAAW,IAAY,SAAqB;AAC1C,WAAA,KAAK,OAAO,EAAE,GAAG,SAAS,GAAG,sBAAsB,EAAE,OAAA,CAAQ;AAAA,EACrE;AAAA;AAAA,EAGA,MAAM,gBACL,IACA,SAAqB;AAErB,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;AApIA;AACA;AAqBA;AAAA,aAAQ,WAAA;AACP,SAAOA,KAAAA,QAAQ,WAAW;AAAA,IACzB,SAAS,KAAK;AAAA;AAAA;AAAA,IAGd,kBAAkB,EAAE,eAAe,GAAI;AAAA,EAAA,CACvC;AACF;;"}
+{"version":3,"file":"contentApi.cjs","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: string[];\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}\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 auth header in case it is already set globally in the project Playwright config file.\n\t\t// This is because the api returns an error whenever an auth header is present in the content api request.\n\t\tsuper(baseURL, \"\");\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":["AuthenticatedApiClient"],"mappings":";;;;;;;;;AAuFM,MAAO,yBAAyBA,UAAAA,uBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqB3D,YACC,SACA,SAA0D,IAAE;AAI5D,UAAM,SAAS,EAAE;AA1BV;AACA;AA0BF,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;;"}