@prismicio/e2e-tests-utils 1.17.0 → 1.18.0-canary.7615426

package/README.md

@@ -3,6 +3,7 @@
 This library comprises utility functions tailored for end-to-end tests at Prismic, with a primary focus on tasks like repository creation, configuration, and deletion.
 
 #### Purpose
+
 In the context of testing, it's essential to operate in a controlled environment where the necessary conditions are defined explicitly. To avoid redundant logic across various services for setting up test data, this library consolidates and provides the required functionalities.
 
 ## Installation
@@ -18,24 +19,24 @@ npm install --save-dev @prismicio/e2e-tests-utils
 Useful to run the tests on a clean repository with a controlled configuration, for example in a CI.
 
 ```typescript
-import { createRepositoriesManager } from "@prismicio/e2e-tests-utils";
-import type { RepositoryConfig } from "@prismicio/e2e-tests-utils";
+import { createRepositoriesManager } from "@prismicio/e2e-tests-utils"
+import type { RepositoryConfig } from "@prismicio/e2e-tests-utils"
 
 const config: RepositoryConfig = {
 	locales: ["en-gb", "fr-fr"],
 	defaultLocale: "en-gb",
 	// ... see RepositoryConfig for other options
-};
-const authConfig = { email, password };
+}
+const authConfig = { email, password }
 
-const testUtils = createRepositoriesManager({ urlConfig :"https://prismic.io", authConfig});
-const repository = await testUtils.createRepository(config);
+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
 repository.getBaseURL() // https://my-unique-repo-name.prismic.io
 
 // run your tests, delete the repository
-await testUtils.tearDown();
+await testUtils.tearDown()
 ```
 
 ### Create Custom Types
@@ -44,20 +45,17 @@ Use Custom Types and Shared slices typed from the `@prismicio/types-internal` li
 If the custom types already exists on the repository, they will be updated.
 
 ```typescript
-import { createRepositoriesManager } from "@prismicio/e2e-tests-utils";
+import { createRepositoriesManager } from "@prismicio/e2e-tests-utils"
 
-import {
-	CustomType,
-	SharedSlice,
-} from "@prismicio/types-internal/lib/customtypes";
+import { DynamicCustomTypeModel, SharedSliceModel } from "@prismicio/types-internal"
 
-const slice: SharedSlice = {
+const slice: SharedSliceModel = {
 	id: "test_slice",
 	type: "SharedSlice",
 	name: "A slice demo",
 	// ...
-};
-const customType: CustomType = {
+}
+const customType: DynamicCustomTypeModel = {
 	id: "test_ct",
 	label: "A custom type",
 	// ...
@@ -76,21 +74,21 @@ const customType: CustomType = {
 			},
 		},
 	},
-};
+}
 
 // Create them individually
-await repository.createSlices([slice]);
-await repository.createCustomTypes([customType]);
+await repository.createSlices([slice])
+await repository.createCustomTypes([customType])
 
 // Or create them via the RepositoryConfig object
-const config = { slices: [slice], customTypes: [customType] };
-await testUtils.createRepository(config);
+const config = { slices: [slice], customTypes: [customType] }
+await testUtils.createRepository(config)
 ```
 
 ### Retrieve an API token (jwt)
 
 ```typescript
-const token = await testUtils.getUserApiToken();
+const token = await testUtils.getUserApiToken()
 ```
 
 ### Get API clients
@@ -98,21 +96,20 @@ const token = await testUtils.getUserApiToken();
 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);
+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
-const repository = await testUtils.getRepositoryManager(name);
+const repository = await testUtils.getRepositoryManager(name)
 // configure multiple settings and once
-await repository.configure(settings);
+await repository.configure(settings)
 // or configure them individually
-await repository.createRelease("next release");
+await repository.createRelease("next release")
 ```
 
 ### How does the library know which endpoints urls to use under the hood (authentication server, custom types api)?

package/dist/_virtual/_rolldown/runtime.cjs

@@ -0,0 +1,23 @@
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+//#endregion
+exports.__toESM = __toESM;

package/dist/clients/apiClient.cjs

@@ -1,40 +1,40 @@
-"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;
+const require_urls = require("../utils/urls.cjs");
+let _playwright_test = require("@playwright/test");
+//#region src/clients/apiClient.ts
+/**
+* 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.
+*/
+var AuthenticatedApiClient = class {
+	baseURL;
+	token;
+	headers;
+	_context;
+	constructor(baseURL, token, headers) {
+		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 _playwright_test.request.newContext({
+				baseURL: require_urls.appendTrailingSlash(this.baseURL),
+				extraHTTPHeaders: {
+					Authorization: `Bearer ${token}`,
+					...this.headers
+				}
+			});
+		}
+		return this._context;
+	}
 };
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const test = require("@playwright/test");
-const urls = require("../utils/urls.cjs");
-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: urls.appendTrailingSlash(this.baseURL),
-        extraHTTPHeaders: {
-          Authorization: `Bearer ${token}`,
-          ...this.headers
-        }
-      });
-    }
-    return this._context;
-  }
-}
+//#endregion
 exports.AuthenticatedApiClient = AuthenticatedApiClient;
-//# sourceMappingURL=apiClient.cjs.map
+
+//# sourceMappingURL=apiClient.cjs.map

package/dist/clients/apiClient.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"apiClient.cjs","sources":["../../../src/clients/apiClient.ts"],"sourcesContent":["import { APIRequestContext, request } from \"@playwright/test\";\n\nimport { appendTrailingSlash } from \"../utils/urls\";\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: appendTrailingSlash(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","appendTrailingSlash"],"mappings":";;;;;;;;;;MAoBsB,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,SAASC,KAAAA,oBAAoB,KAAK,OAAO;AAAA,QACzC,kBAAkB;AAAA,UACjB,eAAe,UAAU,KAAK;AAAA,UAC9B,GAAG,KAAK;AAAA,QACR;AAAA,MAAA,CACD;AAAA,IACF;AAEA,WAAO,KAAK;AAAA,EACb;AACA;;"}
+{"version":3,"file":"apiClient.cjs","names":["request","appendTrailingSlash"],"sources":["../../src/clients/apiClient.ts"],"sourcesContent":["import type { APIRequestContext } from \"@playwright/test\"\nimport { request } from \"@playwright/test\"\n\nimport { appendTrailingSlash } from \"../utils/urls\"\n\n/**\n * The authentication token. Can be a string or a function that returns a promise resolving to the\n * token.\n */\nexport type AuthServerToken = string | (() => Promise<string>)\n\n/**\n * Abstract class for Prismic api clients that use the Prismic authentication server. This class\n * takes care or creating the Playwright context with the necessary authorization headers.\n *\n * This class performs requests with Playwright instead of a library like Axios which has the\n * advantage of tracing all the network details in the Playwright reports making test failures\n * investigation easier for projects that use 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/** Returns a Playwright ApiRequestContext instance with the necessary authorization headers. */\n\tprotected async getContext(): Promise<APIRequestContext> {\n\t\tif (!this._context) {\n\t\t\tconst token = typeof this.token === \"string\" ? this.token : await this.token()\n\n\t\t\tthis._context = await request.newContext({\n\t\t\t\tbaseURL: appendTrailingSlash(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"],"mappings":";;;;;;;;;;;AAmBA,IAAsB,yBAAtB,MAA6C;CAI1B;CACA;CACA;CALlB;CAEA,YACC,SACA,OACA,SACC;EAHgB,KAAA,UAAA;EACA,KAAA,QAAA;EACA,KAAA,UAAA;CACf;;CAGH,MAAgB,aAAyC;EACxD,IAAI,CAAC,KAAK,UAAU;GACnB,MAAM,QAAQ,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ,MAAM,KAAK,MAAM;GAE7E,KAAK,WAAW,MAAMA,iBAAAA,QAAQ,WAAW;IACxC,SAASC,aAAAA,oBAAoB,KAAK,OAAO;IACzC,kBAAkB;KACjB,eAAe,UAAU;KACzB,GAAG,KAAK;IACT;GACD,CAAC;EACF;EAEA,OAAO,KAAK;CACb;AACD"}

package/dist/clients/apiClient.d.cts

@@ -0,0 +1,30 @@
+import { APIRequestContext } from "@playwright/test";
+
+//#region src/clients/apiClient.d.ts
+/**
+ * The authentication token. Can be a string or a function that returns a promise resolving to the
+ * token.
+ */
+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.
+ */
+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>;
+}
+//#endregion
+export { AuthServerToken, AuthenticatedApiClient };
+//# sourceMappingURL=apiClient.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"apiClient.d.cts","names":[],"sources":["../../src/clients/apiClient.ts"],"mappings":";;;;;AASA;;KAAY,eAAA,mBAAkC,OAAO;;AAAA;AAUrD;;;;;;uBAAsB,sBAAA;EAAA,iBAIH,OAAA;EAAA,iBACA,KAAA;EAAA,iBACA,OAAA;EAAA,QALV,QAAA;cAGU,OAAA,UACA,KAAA,EAAO,eAAA,EACP,OAAA;IAAA,CAAa,GAAA;EAAA;EADN;EAAA,UAKT,UAAA,IAAc,OAAA,CAAQ,iBAAA;AAAA"}

package/dist/clients/apiClient.d.ts

@@ -1,30 +1,30 @@
 import { APIRequestContext } from "@playwright/test";
+
+//#region src/clients/apiClient.d.ts
 /**
- * The authentication token. Can be a string or a function that returns a
- * promise resolving to the token.
+ * The authentication token. Can be a string or a function that returns a promise resolving to the
+ * token.
  */
-export type AuthServerToken = string | (() => Promise<string>);
+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.
+ * 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.
+ * 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>;
+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>;
 }
+//#endregion
+export { AuthServerToken, AuthenticatedApiClient };
+//# sourceMappingURL=apiClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"apiClient.d.ts","names":[],"sources":["../../src/clients/apiClient.ts"],"mappings":";;;;;AASA;;KAAY,eAAA,mBAAkC,OAAO;;AAAA;AAUrD;;;;;;uBAAsB,sBAAA;EAAA,iBAIH,OAAA;EAAA,iBACA,KAAA;EAAA,iBACA,OAAA;EAAA,QALV,QAAA;cAGU,OAAA,UACA,KAAA,EAAO,eAAA,EACP,OAAA;IAAA,CAAa,GAAA;EAAA;EADN;EAAA,UAKT,UAAA,IAAc,OAAA,CAAQ,iBAAA;AAAA"}

package/dist/clients/apiClient.js

@@ -1,40 +1,40 @@
-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 { appendTrailingSlash } from "../utils/urls.js";
-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: appendTrailingSlash(this.baseURL),
-        extraHTTPHeaders: {
-          Authorization: `Bearer ${token}`,
-          ...this.headers
-        }
-      });
-    }
-    return this._context;
-  }
-}
-export {
-  AuthenticatedApiClient
+import { request } from "@playwright/test";
+//#region src/clients/apiClient.ts
+/**
+* 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.
+*/
+var AuthenticatedApiClient = class {
+	baseURL;
+	token;
+	headers;
+	_context;
+	constructor(baseURL, token, headers) {
+		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: appendTrailingSlash(this.baseURL),
+				extraHTTPHeaders: {
+					Authorization: `Bearer ${token}`,
+					...this.headers
+				}
+			});
+		}
+		return this._context;
+	}
 };
-//# sourceMappingURL=apiClient.js.map
+//#endregion
+export { AuthenticatedApiClient };
+
+//# sourceMappingURL=apiClient.js.map

package/dist/clients/apiClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"apiClient.js","sources":["../../../src/clients/apiClient.ts"],"sourcesContent":["import { APIRequestContext, request } from \"@playwright/test\";\n\nimport { appendTrailingSlash } from \"../utils/urls\";\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: appendTrailingSlash(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":";;;;;;;;MAoBsB,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,oBAAoB,KAAK,OAAO;AAAA,QACzC,kBAAkB;AAAA,UACjB,eAAe,UAAU,KAAK;AAAA,UAC9B,GAAG,KAAK;AAAA,QACR;AAAA,MAAA,CACD;AAAA,IACF;AAEA,WAAO,KAAK;AAAA,EACb;AACA;"}
+{"version":3,"file":"apiClient.js","names":[],"sources":["../../src/clients/apiClient.ts"],"sourcesContent":["import type { APIRequestContext } from \"@playwright/test\"\nimport { request } from \"@playwright/test\"\n\nimport { appendTrailingSlash } from \"../utils/urls\"\n\n/**\n * The authentication token. Can be a string or a function that returns a promise resolving to the\n * token.\n */\nexport type AuthServerToken = string | (() => Promise<string>)\n\n/**\n * Abstract class for Prismic api clients that use the Prismic authentication server. This class\n * takes care or creating the Playwright context with the necessary authorization headers.\n *\n * This class performs requests with Playwright instead of a library like Axios which has the\n * advantage of tracing all the network details in the Playwright reports making test failures\n * investigation easier for projects that use 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/** Returns a Playwright ApiRequestContext instance with the necessary authorization headers. */\n\tprotected async getContext(): Promise<APIRequestContext> {\n\t\tif (!this._context) {\n\t\t\tconst token = typeof this.token === \"string\" ? this.token : await this.token()\n\n\t\t\tthis._context = await request.newContext({\n\t\t\t\tbaseURL: appendTrailingSlash(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"],"mappings":";;;;;;;;;;;AAmBA,IAAsB,yBAAtB,MAA6C;CAI1B;CACA;CACA;CALlB;CAEA,YACC,SACA,OACA,SACC;EAHgB,KAAA,UAAA;EACA,KAAA,QAAA;EACA,KAAA,UAAA;CACf;;CAGH,MAAgB,aAAyC;EACxD,IAAI,CAAC,KAAK,UAAU;GACnB,MAAM,QAAQ,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ,MAAM,KAAK,MAAM;GAE7E,KAAK,WAAW,MAAM,QAAQ,WAAW;IACxC,SAAS,oBAAoB,KAAK,OAAO;IACzC,kBAAkB;KACjB,eAAe,UAAU;KACzB,GAAG,KAAK;IACT;GACD,CAAC;EACF;EAEA,OAAO,KAAK;CACb;AACD"}

package/dist/clients/assetApi.cjs

@@ -1,94 +1,82 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const log = require("../utils/log.cjs");
-const apiClient = require("./apiClient.cjs");
-class AssetApiClient extends apiClient.AuthenticatedApiClient {
-  /**
-   * @example To instantiate the class:
-   *
-   * ```js
-   * new AssetApiClient("https://asset-api.prismic.io", {
-   * 	authToken: "my-secret-token",
-   * 	repository: "my-repo-name",
-   * });
-   * ```
-   *
-   * @param baseURL - The API base URL, such as https://asset-api.prismic.io
-   * @param config - Optional configuration
-   *
-   *   - {@link config.authToken}: API token generated from the auth service or a
-   *       function to fetch it when it's needed.
-   *   - {@link config.repository}: Repository name.
-   */
-  constructor(baseURL, config) {
-    super(baseURL, config.authToken, { repository: config.repository });
-  }
-  /**
-   * Uploads an asset file to the server.
-   *
-   * @param data - The payload containing the file and filename.
-   *
-   * @returns The API response containing asset information.
-   *
-   * @throws An error if the upload fails.
-   */
-  async createAsset(data) {
-    const context = await this.getContext();
-    const result = await context.post("assets", {
-      multipart: { file: data }
-    });
-    if (200 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error("Could not upload the asset with the asset API.");
-    }
-    return result.json();
-  }
-  /**
-   * Patch an existing asset.
-   *
-   * @param args - Asset id + the payload
-   *
-   * @returns The API response containing asset information.
-   *
-   * @throws An error if the upload fails.
-   */
-  async patchAsset(args) {
-    const context = await this.getContext();
-    const { assetId, ...data } = args;
-    const result = await context.patch(`assets/${assetId}`, { data });
-    if (200 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error("Could not search the asset API.");
-    }
-    return result.json();
-  }
-  /**
-   * Searches for assets.
-   *
-   * @param params - Optional parameters to refine search results.
-   *
-   * @returns The API response containing assets.
-   */
-  async search(params) {
-    const context = await this.getContext();
-    const { ids, ...rest } = params ?? {};
-    const query = new URLSearchParams();
-    for (const [key, value] of Object.entries(rest)) {
-      if (value !== void 0) {
-        query.set(key, String(value));
-      }
-    }
-    for (const id of ids ?? []) {
-      query.append("ids", id);
-    }
-    const url = query.size ? `assets?${query}` : "assets";
-    const result = await context.get(url);
-    if (200 !== result.status()) {
-      await log.logPlaywrightApiResponse(result);
-      throw new Error("Could not search the asset API.");
-    }
-    return result.json();
-  }
-}
+const require_log = require("../utils/log.cjs");
+const require_apiClient = require("./apiClient.cjs");
+//#region src/clients/assetApi.ts
+var AssetApiClient = class extends require_apiClient.AuthenticatedApiClient {
+	/**
+	* @example
+	* 	To instantiate the class:
+	*
+	* 	```js
+	* 	new AssetApiClient("https://asset-api.prismic.io", {
+	* 	authToken: "my-secret-token",
+	* 	repository: "my-repo-name",
+	* 	});
+	* 	```
+	*
+	* @param baseURL - The API base URL, such as https://asset-api.prismic.io
+	* @param config - Optional configuration
+	*
+	*   - {@link config.authToken}: API token generated from the auth service or a function to fetch it
+	*     when it's needed.
+	*   - {@link config.repository}: Repository name.
+	*/
+	constructor(baseURL, config) {
+		super(baseURL, config.authToken, { repository: config.repository });
+	}
+	/**
+	* Uploads an asset file to the server.
+	*
+	* @param data - The payload containing the file and filename.
+	* @returns The API response containing asset information.
+	* @throws An error if the upload fails.
+	*/
+	async createAsset(data) {
+		const result = await (await this.getContext()).post("assets", { multipart: { file: data } });
+		if (200 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error("Could not upload the asset with the asset API.");
+		}
+		return result.json();
+	}
+	/**
+	* Patch an existing asset.
+	*
+	* @param args - Asset id + the payload
+	* @returns The API response containing asset information.
+	* @throws An error if the upload fails.
+	*/
+	async patchAsset(args) {
+		const context = await this.getContext();
+		const { assetId, ...data } = args;
+		const result = await context.patch(`assets/${assetId}`, { data });
+		if (200 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error("Could not search the asset API.");
+		}
+		return result.json();
+	}
+	/**
+	* Searches for assets.
+	*
+	* @param params - Optional parameters to refine search results.
+	* @returns The API response containing assets.
+	*/
+	async search(params) {
+		const context = await this.getContext();
+		const { ids, ...rest } = params ?? {};
+		const query = new URLSearchParams();
+		for (const [key, value] of Object.entries(rest)) if (value !== void 0) query.set(key, String(value));
+		for (const id of ids ?? []) query.append("ids", id);
+		const url = query.size ? `assets?${query}` : "assets";
+		const result = await context.get(url);
+		if (200 !== result.status()) {
+			await require_log.logPlaywrightApiResponse(result);
+			throw new Error("Could not search the asset API.");
+		}
+		return result.json();
+	}
+};
+//#endregion
 exports.AssetApiClient = AssetApiClient;
-//# sourceMappingURL=assetApi.cjs.map
+
+//# sourceMappingURL=assetApi.cjs.map