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

package/dist/clients/contentApi.d.ts

@@ -1,9 +1,10 @@
 import { APIResponse } from "@playwright/test";
-export interface Error {
+import { AuthenticatedApiClient } from "./apiClient";
+export interface ContentApiError {
     type: string;
     message: string;
 }
-export interface SearchResponse {
+export interface ContentApiSearchResponse {
     page: number;
     results_per_page: number;
     results_size: number;
@@ -11,9 +12,9 @@ export interface SearchResponse {
     total_pages: number;
     next_page: string | null;
     prev_page: string | null;
-    results: Document[];
+    results: ContentApiDocument[];
 }
-export interface Document {
+export interface ContentApiDocument {
     id: string;
     uid: string | null;
     url: string | null;
@@ -28,35 +29,20 @@ export interface Document {
     alternate_languages: string[];
     data: Record<string, any>;
 }
-export interface GraphQLResponse {
+export interface ContentApiGraphQLResponse {
     data: Record<string, any>;
     errors?: {
         message: string;
         locations: any;
     }[];
 }
-export interface Ref {
+export interface ContentApiRef {
     id: string;
     ref: string;
     label: string;
     isMasterRef?: boolean;
 }
-export interface RepoConfig {
-    refs: Ref[];
-    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;
-}
-export type QueryParams = {
+type SearchQueryParams = {
     ref?: string;
     query?: string;
     q?: string;
@@ -72,17 +58,21 @@ export type QueryParams = {
 type ApiVersions = "v1" | "v2";
 /**
  * Client to query the Prismic content api. Uses Playwright to benefit from
- * network request traces in your reports. The @prismicio/client could have been
- * used but had too many abstractions (caching, error handling) that we didn't
- * want for test execution. See api docs:
+ * network request traces in your reports. See api docs:
  * https://prismic.io/docs/rest-api-technical-reference
  */
-export declare class ContentApiClient {
-    #private;
-    private readonly baseURL;
+export declare class ContentApiClient extends AuthenticatedApiClient {
+    private version;
+    private accessToken;
     /**
-     * @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
@@ -95,21 +85,21 @@ export declare class ContentApiClient {
         version?: ApiVersions;
         accessToken?: string;
     });
-    get(path: string, params?: QueryParams, headers?: Record<string, string>): Promise<APIResponse>;
-    getAsJson<T>(url: string, params?: QueryParams, headers?: Record<string, string>): Promise<T>;
+    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<GraphQLResponse>;
-    getRefs(): Promise<Ref[]>;
+    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?: QueryParams): Promise<SearchResponse>;
+    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?: QueryParams): Promise<SearchResponse>;
+    searchByID(id: string, filters?: SearchQueryParams): Promise<ContentApiSearchResponse>;
     /** Retrieve a single document or undefined if not found. */
-    getDocumentByID(id: string, filters?: QueryParams): Promise<Document | undefined>;
+    getDocumentByID(id: string, filters?: SearchQueryParams): Promise<ContentApiDocument | undefined>;
 }
 export {};

package/dist/clients/contentApi.js

@@ -4,34 +4,17 @@ 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;
-import { request } from "@playwright/test";
-class ContentApiClient {
+import { AuthenticatedApiClient } from "./apiClient.js";
+class ContentApiClient extends 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
@@ -41,18 +24,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, 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 __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 },
@@ -65,10 +46,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() {
@@ -93,7 +74,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
     });
@@ -118,17 +99,6 @@ class ContentApiClient {
     }
   }
 }
-_version = new WeakMap();
-_accessToken = new WeakMap();
-_context = new WeakSet();
-context_fn = function() {
-  return request.newContext({
-    baseURL: this.baseURL,
-    // reset any Authorization header set globally with Playwright
-    // didn't find a way to delete it
-    extraHTTPHeaders: { Authorization: "" }
-  });
-};
 export {
   ContentApiClient
 };

package/dist/clients/contentApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"contentApi.js","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":[],"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,SAAO,QAAQ,WAAW;AAAA,IACzB,SAAS,KAAK;AAAA;AAAA;AAAA,IAGd,kBAAkB,EAAE,eAAe,GAAI;AAAA,EAAA,CACvC;AACF;"}
+{"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: 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 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":";;;;;;;AAuFM,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;"}

package/dist/clients/coreApi.cjs

@@ -1,44 +1,49 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const axios = require("axios");
 const log = require("../utils/log.cjs");
-const createCoreApiClient = (baseURL, authClient) => {
-  const client = axios.create({
-    baseURL,
-    validateStatus: () => true
-    // Don't throw on 4XX errors
-  });
-  client.interceptors.request.use(async (config) => {
-    const auth = "Authorization";
-    if (!config.headers[auth]) {
-      const token = await authClient.getToken();
-      config.headers[auth] = `Bearer ${token}`;
-    }
-    return config;
-  });
-  async function getLanguages() {
+const apiClient = require("./apiClient.cjs");
+class CoreApiClient extends apiClient.AuthenticatedApiClient {
+  /**
+   * @example To instantiate the class:
+   *
+   * ```js
+   * new CoreApiClient("https://my-repo.prismic.io", {
+   * 	authToken: "my-secret-token",
+   * });
+   * ```
+   *
+   * @param baseURL - the api base URL like https://my-repo.prismic.io
+   * @param config - Optional configuration
+   *
+   *   - {@link config.authToken}: Api token generated from the auth service or a
+   *       function to fetch it when it's needed.
+   */
+  constructor(baseURL, config) {
+    super(baseURL, config);
+  }
+  async getLanguages() {
     const profiler = log.logger.startTimer();
-    const result = await client.get("core/repository");
-    if (200 !== result.status || !result.data.languages) {
-      log.logHttpResponse(result);
+    const context = await this.getContext();
+    const result = await context.get("core/repository");
+    if (200 !== result.status() || !(await result.json()).languages) {
+      await log.logPlaywrightApiResponse(result);
       throw new Error("Could not get languages from the core api.");
     }
     profiler.done({ message: "retrieved languages configuration" });
-    return result.data.languages;
+    return (await result.json()).languages;
   }
-  async function publishDraft(documentId) {
-    const result = await client.patch(`core/documents/${documentId}/draft`, {
-      status: "published"
+  async publishDraft(documentId) {
+    const context = await this.getContext();
+    const result = await context.patch(`core/documents/${documentId}/draft`, {
+      data: {
+        status: "published"
+      }
     });
-    if (204 !== result.status) {
-      log.logHttpResponse(result);
+    if (204 !== result.status()) {
+      await log.logPlaywrightApiResponse(result);
       throw new Error(`Could not publish document with id ${documentId}`);
     }
   }
-  return {
-    getLanguages,
-    publishDraft
-  };
-};
-exports.createCoreApiClient = createCoreApiClient;
+}
+exports.CoreApiClient = CoreApiClient;
 //# sourceMappingURL=coreApi.cjs.map

package/dist/clients/coreApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"coreApi.cjs","sources":["../../../src/clients/coreApi.ts"],"sourcesContent":["import axios, { AxiosInstance } from \"axios\";\n\nimport { logHttpResponse, logger } from \"../utils/log\";\n\nimport { AuthenticationClient } from \"./authenticationApi\";\n\ntype Language = {\n\tid: string;\n\tname: string;\n\tis_master: boolean;\n};\n\nexport type CoreClient = {\n\tgetLanguages(): Promise<Language[]>;\n\tpublishDraft(documentId: string): Promise<void>;\n};\n\n/** Client for interacting with the core API */\nexport const createCoreApiClient = (\n\tbaseURL: string,\n\tauthClient: AuthenticationClient,\n): CoreClient => {\n\tconst client: AxiosInstance = axios.create({\n\t\tbaseURL,\n\t\tvalidateStatus: () => true, // Don't throw on 4XX errors\n\t});\n\n\t// Add an interceptor to authenticate requests\n\tclient.interceptors.request.use(async (config) => {\n\t\tconst auth = \"Authorization\";\n\t\tif (!config.headers[auth]) {\n\t\t\tconst token = await authClient.getToken();\n\t\t\tconfig.headers[auth] = `Bearer ${token}`;\n\t\t}\n\n\t\treturn config;\n\t});\n\n\tasync function getLanguages(): Promise<Language[]> {\n\t\tconst profiler = logger.startTimer();\n\t\tconst result = await client.get<{ languages: Language[] }>(\n\t\t\t\"core/repository\",\n\t\t);\n\n\t\tif (200 !== result.status || !result.data.languages) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\"Could not get languages from the core api.\");\n\t\t}\n\n\t\tprofiler.done({ message: \"retrieved languages configuration\" });\n\n\t\treturn result.data.languages;\n\t}\n\n\tasync function publishDraft(documentId: string): Promise<void> {\n\t\tconst result = await client.patch(`core/documents/${documentId}/draft`, {\n\t\t\tstatus: \"published\",\n\t\t});\n\n\t\tif (204 !== result.status) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(`Could not publish document with id ${documentId}`);\n\t\t}\n\t}\n\n\treturn {\n\t\tgetLanguages,\n\t\tpublishDraft,\n\t};\n};\n"],"names":["logger","logHttpResponse"],"mappings":";;;;AAkBa,MAAA,sBAAsB,CAClC,SACA,eACe;AACT,QAAA,SAAwB,MAAM,OAAO;AAAA,IAC1C;AAAA,IACA,gBAAgB,MAAM;AAAA;AAAA,EAAA,CACtB;AAGD,SAAO,aAAa,QAAQ,IAAI,OAAO,WAAU;AAChD,UAAM,OAAO;AACb,QAAI,CAAC,OAAO,QAAQ,IAAI,GAAG;AACpB,YAAA,QAAQ,MAAM,WAAW;AAC/B,aAAO,QAAQ,IAAI,IAAI,UAAU,KAAK;AAAA,IACvC;AAEO,WAAA;AAAA,EAAA,CACP;AAED,iBAAe,eAAY;AACpB,UAAA,WAAWA,WAAO;AACxB,UAAM,SAAS,MAAM,OAAO,IAC3B,iBAAiB;AAGlB,QAAI,QAAQ,OAAO,UAAU,CAAC,OAAO,KAAK,WAAW;AACpDC,UAAA,gBAAgB,MAAM;AAChB,YAAA,IAAI,MAAM,4CAA4C;AAAA,IAC7D;AAEA,aAAS,KAAK,EAAE,SAAS,oCAAqC,CAAA;AAE9D,WAAO,OAAO,KAAK;AAAA,EACpB;AAEA,iBAAe,aAAa,YAAkB;AAC7C,UAAM,SAAS,MAAM,OAAO,MAAM,kBAAkB,UAAU,UAAU;AAAA,MACvE,QAAQ;AAAA,IAAA,CACR;AAEG,QAAA,QAAQ,OAAO,QAAQ;AAC1BA,UAAA,gBAAgB,MAAM;AACtB,YAAM,IAAI,MAAM,sCAAsC,UAAU,EAAE;AAAA,IACnE;AAAA,EACD;AAEO,SAAA;AAAA,IACN;AAAA,IACA;AAAA,EAAA;AAEF;;"}
+{"version":3,"file":"coreApi.cjs","sources":["../../../src/clients/coreApi.ts"],"sourcesContent":["import { logPlaywrightApiResponse, logger } from \"../utils/log\";\n\nimport { AuthServerToken, AuthenticatedApiClient } from \"./apiClient\";\n\ntype Language = {\n\tid: string;\n\tname: string;\n\tis_master: boolean;\n};\n\nexport type CoreClient = {\n\tgetLanguages(): Promise<Language[]>;\n\tpublishDraft(documentId: string): Promise<void>;\n};\n\nexport class CoreApiClient extends AuthenticatedApiClient {\n\t/**\n\t * @example To instantiate the class:\n\t *\n\t * ```js\n\t * new CoreApiClient(\"https://my-repo.prismic.io\", {\n\t * \tauthToken: \"my-secret-token\",\n\t * });\n\t * ```\n\t *\n\t * @param baseURL - the api base URL like https://my-repo.prismic.io\n\t * @param config - Optional configuration\n\t *\n\t *   - {@link config.authToken}: Api token generated from the auth service or a\n\t *       function to fetch it when it's needed.\n\t */\n\tconstructor(baseURL: string, config: AuthServerToken) {\n\t\tsuper(baseURL, config);\n\t}\n\n\tasync getLanguages(): Promise<Language[]> {\n\t\tconst profiler = logger.startTimer();\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(\"core/repository\");\n\n\t\tif (200 !== result.status() || !(await result.json()).languages) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not get languages from the core api.\");\n\t\t}\n\n\t\tprofiler.done({ message: \"retrieved languages configuration\" });\n\n\t\treturn (await result.json()).languages;\n\t}\n\n\tasync publishDraft(documentId: string): Promise<void> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.patch(`core/documents/${documentId}/draft`, {\n\t\t\tdata: {\n\t\t\t\tstatus: \"published\",\n\t\t\t},\n\t\t});\n\n\t\tif (204 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(`Could not publish document with id ${documentId}`);\n\t\t}\n\t}\n}\n"],"names":["AuthenticatedApiClient","logger","logPlaywrightApiResponse"],"mappings":";;;;AAeM,MAAO,sBAAsBA,UAAAA,uBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBxD,YAAY,SAAiB,QAAuB;AACnD,UAAM,SAAS,MAAM;AAAA,EACtB;AAAA,EAEA,MAAM,eAAY;AACX,UAAA,WAAWC,WAAO;AAClB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,iBAAiB;AAE9C,QAAA,QAAQ,OAAO,OAAM,KAAM,EAAE,MAAM,OAAO,KAAI,GAAI,WAAW;AAChE,YAAMC,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,4CAA4C;AAAA,IAC7D;AAEA,aAAS,KAAK,EAAE,SAAS,oCAAqC,CAAA;AAEtD,YAAA,MAAM,OAAO,KAAA,GAAQ;AAAA,EAC9B;AAAA,EAEA,MAAM,aAAa,YAAkB;AAC9B,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,MAAM,kBAAkB,UAAU,UAAU;AAAA,MACxE,MAAM;AAAA,QACL,QAAQ;AAAA,MACR;AAAA,IAAA,CACD;AAEG,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMA,IAAAA,yBAAyB,MAAM;AACrC,YAAM,IAAI,MAAM,sCAAsC,UAAU,EAAE;AAAA,IACnE;AAAA,EACD;AACA;;"}

package/dist/clients/coreApi.d.ts

@@ -1,4 +1,4 @@
-import { AuthenticationClient } from "./authenticationApi";
+import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
 type Language = {
     id: string;
     name: string;
@@ -8,6 +8,24 @@ export type CoreClient = {
     getLanguages(): Promise<Language[]>;
     publishDraft(documentId: string): Promise<void>;
 };
-/** Client for interacting with the core API */
-export declare const createCoreApiClient: (baseURL: string, authClient: AuthenticationClient) => CoreClient;
+export declare class CoreApiClient extends AuthenticatedApiClient {
+    /**
+     * @example To instantiate the class:
+     *
+     * ```js
+     * new CoreApiClient("https://my-repo.prismic.io", {
+     * 	authToken: "my-secret-token",
+     * });
+     * ```
+     *
+     * @param baseURL - the api base URL like https://my-repo.prismic.io
+     * @param config - Optional configuration
+     *
+     *   - {@link config.authToken}: Api token generated from the auth service or a
+     *       function to fetch it when it's needed.
+     */
+    constructor(baseURL: string, config: AuthServerToken);
+    getLanguages(): Promise<Language[]>;
+    publishDraft(documentId: string): Promise<void>;
+}
 export {};

package/dist/clients/coreApi.js

@@ -1,44 +1,49 @@
-import axios from "axios";
-import { logger, logHttpResponse } from "../utils/log.js";
-const createCoreApiClient = (baseURL, authClient) => {
-  const client = axios.create({
-    baseURL,
-    validateStatus: () => true
-    // Don't throw on 4XX errors
-  });
-  client.interceptors.request.use(async (config) => {
-    const auth = "Authorization";
-    if (!config.headers[auth]) {
-      const token = await authClient.getToken();
-      config.headers[auth] = `Bearer ${token}`;
-    }
-    return config;
-  });
-  async function getLanguages() {
+import { logger, logPlaywrightApiResponse } from "../utils/log.js";
+import { AuthenticatedApiClient } from "./apiClient.js";
+class CoreApiClient extends AuthenticatedApiClient {
+  /**
+   * @example To instantiate the class:
+   *
+   * ```js
+   * new CoreApiClient("https://my-repo.prismic.io", {
+   * 	authToken: "my-secret-token",
+   * });
+   * ```
+   *
+   * @param baseURL - the api base URL like https://my-repo.prismic.io
+   * @param config - Optional configuration
+   *
+   *   - {@link config.authToken}: Api token generated from the auth service or a
+   *       function to fetch it when it's needed.
+   */
+  constructor(baseURL, config) {
+    super(baseURL, config);
+  }
+  async getLanguages() {
     const profiler = logger.startTimer();
-    const result = await client.get("core/repository");
-    if (200 !== result.status || !result.data.languages) {
-      logHttpResponse(result);
+    const context = await this.getContext();
+    const result = await context.get("core/repository");
+    if (200 !== result.status() || !(await result.json()).languages) {
+      await logPlaywrightApiResponse(result);
       throw new Error("Could not get languages from the core api.");
     }
     profiler.done({ message: "retrieved languages configuration" });
-    return result.data.languages;
+    return (await result.json()).languages;
   }
-  async function publishDraft(documentId) {
-    const result = await client.patch(`core/documents/${documentId}/draft`, {
-      status: "published"
+  async publishDraft(documentId) {
+    const context = await this.getContext();
+    const result = await context.patch(`core/documents/${documentId}/draft`, {
+      data: {
+        status: "published"
+      }
     });
-    if (204 !== result.status) {
-      logHttpResponse(result);
+    if (204 !== result.status()) {
+      await logPlaywrightApiResponse(result);
       throw new Error(`Could not publish document with id ${documentId}`);
     }
   }
-  return {
-    getLanguages,
-    publishDraft
-  };
-};
+}
 export {
-  createCoreApiClient
+  CoreApiClient
 };
 //# sourceMappingURL=coreApi.js.map

package/dist/clients/coreApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"coreApi.js","sources":["../../../src/clients/coreApi.ts"],"sourcesContent":["import axios, { AxiosInstance } from \"axios\";\n\nimport { logHttpResponse, logger } from \"../utils/log\";\n\nimport { AuthenticationClient } from \"./authenticationApi\";\n\ntype Language = {\n\tid: string;\n\tname: string;\n\tis_master: boolean;\n};\n\nexport type CoreClient = {\n\tgetLanguages(): Promise<Language[]>;\n\tpublishDraft(documentId: string): Promise<void>;\n};\n\n/** Client for interacting with the core API */\nexport const createCoreApiClient = (\n\tbaseURL: string,\n\tauthClient: AuthenticationClient,\n): CoreClient => {\n\tconst client: AxiosInstance = axios.create({\n\t\tbaseURL,\n\t\tvalidateStatus: () => true, // Don't throw on 4XX errors\n\t});\n\n\t// Add an interceptor to authenticate requests\n\tclient.interceptors.request.use(async (config) => {\n\t\tconst auth = \"Authorization\";\n\t\tif (!config.headers[auth]) {\n\t\t\tconst token = await authClient.getToken();\n\t\t\tconfig.headers[auth] = `Bearer ${token}`;\n\t\t}\n\n\t\treturn config;\n\t});\n\n\tasync function getLanguages(): Promise<Language[]> {\n\t\tconst profiler = logger.startTimer();\n\t\tconst result = await client.get<{ languages: Language[] }>(\n\t\t\t\"core/repository\",\n\t\t);\n\n\t\tif (200 !== result.status || !result.data.languages) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\"Could not get languages from the core api.\");\n\t\t}\n\n\t\tprofiler.done({ message: \"retrieved languages configuration\" });\n\n\t\treturn result.data.languages;\n\t}\n\n\tasync function publishDraft(documentId: string): Promise<void> {\n\t\tconst result = await client.patch(`core/documents/${documentId}/draft`, {\n\t\t\tstatus: \"published\",\n\t\t});\n\n\t\tif (204 !== result.status) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(`Could not publish document with id ${documentId}`);\n\t\t}\n\t}\n\n\treturn {\n\t\tgetLanguages,\n\t\tpublishDraft,\n\t};\n};\n"],"names":[],"mappings":";;AAkBa,MAAA,sBAAsB,CAClC,SACA,eACe;AACT,QAAA,SAAwB,MAAM,OAAO;AAAA,IAC1C;AAAA,IACA,gBAAgB,MAAM;AAAA;AAAA,EAAA,CACtB;AAGD,SAAO,aAAa,QAAQ,IAAI,OAAO,WAAU;AAChD,UAAM,OAAO;AACb,QAAI,CAAC,OAAO,QAAQ,IAAI,GAAG;AACpB,YAAA,QAAQ,MAAM,WAAW;AAC/B,aAAO,QAAQ,IAAI,IAAI,UAAU,KAAK;AAAA,IACvC;AAEO,WAAA;AAAA,EAAA,CACP;AAED,iBAAe,eAAY;AACpB,UAAA,WAAW,OAAO;AACxB,UAAM,SAAS,MAAM,OAAO,IAC3B,iBAAiB;AAGlB,QAAI,QAAQ,OAAO,UAAU,CAAC,OAAO,KAAK,WAAW;AACpD,sBAAgB,MAAM;AAChB,YAAA,IAAI,MAAM,4CAA4C;AAAA,IAC7D;AAEA,aAAS,KAAK,EAAE,SAAS,oCAAqC,CAAA;AAE9D,WAAO,OAAO,KAAK;AAAA,EACpB;AAEA,iBAAe,aAAa,YAAkB;AAC7C,UAAM,SAAS,MAAM,OAAO,MAAM,kBAAkB,UAAU,UAAU;AAAA,MACvE,QAAQ;AAAA,IAAA,CACR;AAEG,QAAA,QAAQ,OAAO,QAAQ;AAC1B,sBAAgB,MAAM;AACtB,YAAM,IAAI,MAAM,sCAAsC,UAAU,EAAE;AAAA,IACnE;AAAA,EACD;AAEO,SAAA;AAAA,IACN;AAAA,IACA;AAAA,EAAA;AAEF;"}
+{"version":3,"file":"coreApi.js","sources":["../../../src/clients/coreApi.ts"],"sourcesContent":["import { logPlaywrightApiResponse, logger } from \"../utils/log\";\n\nimport { AuthServerToken, AuthenticatedApiClient } from \"./apiClient\";\n\ntype Language = {\n\tid: string;\n\tname: string;\n\tis_master: boolean;\n};\n\nexport type CoreClient = {\n\tgetLanguages(): Promise<Language[]>;\n\tpublishDraft(documentId: string): Promise<void>;\n};\n\nexport class CoreApiClient extends AuthenticatedApiClient {\n\t/**\n\t * @example To instantiate the class:\n\t *\n\t * ```js\n\t * new CoreApiClient(\"https://my-repo.prismic.io\", {\n\t * \tauthToken: \"my-secret-token\",\n\t * });\n\t * ```\n\t *\n\t * @param baseURL - the api base URL like https://my-repo.prismic.io\n\t * @param config - Optional configuration\n\t *\n\t *   - {@link config.authToken}: Api token generated from the auth service or a\n\t *       function to fetch it when it's needed.\n\t */\n\tconstructor(baseURL: string, config: AuthServerToken) {\n\t\tsuper(baseURL, config);\n\t}\n\n\tasync getLanguages(): Promise<Language[]> {\n\t\tconst profiler = logger.startTimer();\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(\"core/repository\");\n\n\t\tif (200 !== result.status() || !(await result.json()).languages) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not get languages from the core api.\");\n\t\t}\n\n\t\tprofiler.done({ message: \"retrieved languages configuration\" });\n\n\t\treturn (await result.json()).languages;\n\t}\n\n\tasync publishDraft(documentId: string): Promise<void> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.patch(`core/documents/${documentId}/draft`, {\n\t\t\tdata: {\n\t\t\t\tstatus: \"published\",\n\t\t\t},\n\t\t});\n\n\t\tif (204 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(`Could not publish document with id ${documentId}`);\n\t\t}\n\t}\n}\n"],"names":[],"mappings":";;AAeM,MAAO,sBAAsB,uBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBxD,YAAY,SAAiB,QAAuB;AACnD,UAAM,SAAS,MAAM;AAAA,EACtB;AAAA,EAEA,MAAM,eAAY;AACX,UAAA,WAAW,OAAO;AAClB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,iBAAiB;AAE9C,QAAA,QAAQ,OAAO,OAAM,KAAM,EAAE,MAAM,OAAO,KAAI,GAAI,WAAW;AAChE,YAAM,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,4CAA4C;AAAA,IAC7D;AAEA,aAAS,KAAK,EAAE,SAAS,oCAAqC,CAAA;AAEtD,YAAA,MAAM,OAAO,KAAA,GAAQ;AAAA,EAC9B;AAAA,EAEA,MAAM,aAAa,YAAkB;AAC9B,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,MAAM,kBAAkB,UAAU,UAAU;AAAA,MACxE,MAAM;AAAA,QACL,QAAQ;AAAA,MACR;AAAA,IAAA,CACD;AAEG,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAM,yBAAyB,MAAM;AACrC,YAAM,IAAI,MAAM,sCAAsC,UAAU,EAAE;AAAA,IACnE;AAAA,EACD;AACA;"}

package/dist/clients/customTypesApi.cjs

@@ -1,46 +1,45 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const axios = require("axios");
 const isEqual = require("lodash.isequal");
 const log = require("../utils/log.cjs");
-const createCustomTypesApiClient = (baseURL, repository, authClient) => {
-  const client = axios.create({
-    baseURL,
-    validateStatus: () => true,
-    // Don't throw on 4XX errors
-    headers: {
-      repository
-    }
-  });
-  client.interceptors.request.use(async (config) => {
-    const auth = "Authorization";
-    if (!config.headers[auth]) {
-      const token = await authClient.getToken();
-      config.headers[auth] = `Bearer ${token}`;
-    }
-    return config;
-  });
-  async function upsert(endpoint, operation, data) {
+const apiClient = require("./apiClient.cjs");
+class CustomTypesApiClient extends apiClient.AuthenticatedApiClient {
+  constructor(baseURL, config) {
+    super(baseURL, config.authToken, { repository: config.repository });
+  }
+  /**
+   * Create or update a custom type or slice.
+   *
+   * @param endpoint - - The API endpoint for custom types or slices
+   *   ('customtypes' or 'slices').
+   * @param data - - The data representing the custom type or slice.
+   *
+   * @throws Error if the item status cannot be retrieved or the item cannot be
+   *   created/updated.
+   */
+  async upsert(endpoint, operation, data) {
     const profiler = log.logger.startTimer();
     const path = `${endpoint}/${operation}`;
-    const result = await client.post(path, data, { headers: {} });
-    if (![201, 204].includes(result.status)) {
-      log.logHttpResponse(result);
+    const context = await this.getContext();
+    const result = await context.post(path, { data });
+    if (!result.ok()) {
+      log.logPlaywrightApiResponse(result);
       throw new Error(`Could not ${operation} item`);
     }
     profiler.done({
       message: `called customtypes api /${path} for item with id '${data.id}'`
     });
   }
-  async function getRemoteItems(endpoint) {
-    const result = await client.get(endpoint);
-    if (![200].includes(result.status)) {
-      log.logHttpResponse(result);
+  async getRemoteItems(endpoint) {
+    const context = await this.getContext();
+    const result = await context.get(endpoint);
+    if (!result.ok()) {
+      log.logPlaywrightApiResponse(result);
       throw new Error("Could not get items status from the Custom Type api.");
     }
-    return result.data;
+    return result.json();
   }
-  async function getDifference(remoteItems, local) {
+  async getDifference(remoteItems, local) {
     const remoteItem = remoteItems.find((remote) => remote.id === local.id);
     if (!remoteItem) {
       return "insert";
@@ -50,23 +49,30 @@ const createCustomTypesApiClient = (baseURL, repository, authClient) => {
     }
     return;
   }
-  async function upsertIfChanged(itemType, localItems = []) {
-    const remoteItems = await getRemoteItems(itemType);
+  /** Create items only if they have changed compared to their remote status */
+  async upsertIfChanged(itemType, localItems = []) {
+    const remoteItems = await this.getRemoteItems(itemType);
     await Promise.all(localItems.map(async (localItem) => {
-      const operation = await getDifference(remoteItems, localItem);
-      return operation && upsert(itemType, operation, localItem);
+      const operation = await this.getDifference(remoteItems, localItem);
+      return operation && this.upsert(itemType, operation, localItem);
     }));
   }
-  async function createCustomTypes(customTypes = []) {
-    await upsertIfChanged("customtypes", customTypes);
+  /**
+   * Create Custom Types using the Custom types api.
+   *
+   * @param customTypes -
+   */
+  async createCustomTypes(customTypes = []) {
+    await this.upsertIfChanged("customtypes", customTypes);
   }
-  async function createSlices(slices = []) {
-    await upsertIfChanged("slices", slices);
+  /**
+   * Create slices using the Custom types api.
+   *
+   * @param slices -
+   */
+  async createSlices(slices = []) {
+    await this.upsertIfChanged("slices", slices);
   }
-  return {
-    createCustomTypes,
-    createSlices
-  };
-};
-exports.createCustomTypesApiClient = createCustomTypesApiClient;
+}
+exports.CustomTypesApiClient = CustomTypesApiClient;
 //# sourceMappingURL=customTypesApi.cjs.map