@prismicio/e2e-tests-utils 1.18.0 → 1.19.0

package/dist/managers/repository.cjs

@@ -1,618 +1,531 @@
-"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_log = require("../utils/log.cjs");
+const require_urls = require("../utils/urls.cjs");
+const require_contentApi = require("../clients/contentApi.cjs");
+let _playwright_test = require("@playwright/test");
+//#region src/managers/repository.ts
+/** Utility to manage test data for a Prismic repository */
+var RepositoryManager = class {
+	name;
+	coreApiClient;
+	authApiClient;
+	wroomClient;
+	customTypesApiClient;
+	migrationApiClient;
+	assetApiClient;
+	manageV2Client;
+	integrationFieldsClient;
+	constructor(name, coreApiClient, authApiClient, wroomClient, customTypesApiClient, migrationApiClient, assetApiClient, manageV2Client, integrationFieldsClient) {
+		this.name = name;
+		this.coreApiClient = coreApiClient;
+		this.authApiClient = authApiClient;
+		this.wroomClient = wroomClient;
+		this.customTypesApiClient = customTypesApiClient;
+		this.migrationApiClient = migrationApiClient;
+		this.assetApiClient = assetApiClient;
+		this.manageV2Client = manageV2Client;
+		this.integrationFieldsClient = integrationFieldsClient;
+	}
+	async configure(config) {
+		if (config.defaultLocale || config.locales || config.customLocale) {
+			const languages = await this.coreApiClient.getLanguages();
+			let updateDefaultLocaleAtTheEnd = false;
+			if (config.defaultLocale) {
+				const master = languages.find(({ is_master }) => is_master === true);
+				if (!master) await this.setDefaultLocale(config.defaultLocale, "create");
+				else if (master.id !== config.defaultLocale) updateDefaultLocaleAtTheEnd = true;
+			}
+			if (config.locales) {
+				const localesToAdd = config.locales.filter((id) => !languages.some((language) => language.id === id));
+				if (localesToAdd.length > 0) await this.createLocales(localesToAdd);
+			}
+			if (config.customLocale) {
+				if (!languages.find(({ id }) => id === config.customLocale?.lang.id)) await this.createCustomLocale(config.customLocale);
+			}
+			if (config.defaultLocale && updateDefaultLocaleAtTheEnd) await this.setDefaultLocale(config.defaultLocale, "update");
+		}
+		if (config.slices) await this.createSlices(config.slices);
+		if (config.customTypes) await this.createCustomTypes(config.customTypes);
+		if (config.preview) await this.createPreview(config.preview);
+		if (config.simulatorURL) await this.setSimulatorURL(config.simulatorURL);
+		if (config.rolePerLocal) await this.toggleRolePerLocal(true);
+		if (config.customRoles) await this.toggleCustomRoles(true);
+		if (config.integrationFields) {
+			await this.toggleIntegrationFields(true);
+			await this.setupIntegrationFields(config.integrationFields);
+		}
+	}
+	/** @returns The repository base url, like https://my-repo.prismic.io */
+	getBaseURL() {
+		return require_urls.getRepositoryUrl(this.wroomClient.getBaseURL(), this.name);
+	}
+	/** @returns The repository base cdn url, like https://my-repo.cdn.prismic.io */
+	getBaseCdnURL() {
+		return require_urls.getRepositoryUrl(this.wroomClient.getBaseURL(), `${this.name}.cdn`);
+	}
+	/**
+	* @returns A Content Type api client configured to target the repository CDN url. Uses Playwright
+	*   for requests so if your project uses Playwright too, any network request will be present in
+	*   Playwright test reports.
+	*/
+	getContentApiClient(config) {
+		return new require_contentApi.ContentApiClient(this.getBaseCdnURL(), config);
+	}
+	/**
+	* @returns An instance of the Migration api client, see
+	*   https://prismic.io/docs/migration-api-technical-reference
+	*/
+	getMigrationApiClient() {
+		if (!this.migrationApiClient) throw "No client found for the migration api. Did you provide a migration api url in the configuration?";
+		return this.migrationApiClient;
+	}
+	/**
+	* @returns An instance of the Asset api client, see
+	*   https://prismic.io/docs/asset-api-technical-reference
+	*/
+	getAssetApiClient() {
+		return this.assetApiClient;
+	}
+	/** @returns The Wroom commit hash deployed on the current repository */
+	async getDeployedVersion() {
+		return (await this.wroomClient.get(this.name, "underground/834b34f16f451e00f268dd5c8c81d16e3c020275")).data.version;
+	}
+	/**
+	* Set additional standard locales for a repository in Wroom, does not fail if the locales already
+	* exist.
+	*
+	* @param locales - An array of all locales to be added to the repository.
+	* @throws Error if setting the locales fails.
+	*/
+	async createLocales(locales) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, "app/settings/multilanguages", { languages: locales });
+		const { data, status } = response;
+		if (!(status === 200 || status === 400 && data.includes("already existing languages"))) {
+			require_log.logHttpResponse(response);
+			throw new Error(`Could not add locales ${locales.join(", ")}`);
+		}
+		profiler.done({ message: `locales '${locales}' created` });
+	}
+	/**
+	* Set additional custom locale for a repository in Wroom, does not fail if the locales already
+	* exist.
+	*
+	* @param locale - The locale to be added to the repository.
+	* @throws Error if setting the locale fails.
+	*/
+	async createCustomLocale(locale) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, "app/settings/multilanguages/custom", locale);
+		const { data, status } = response;
+		if (!(status === 200 || status === 400 && JSON.stringify(data).includes("code is already used"))) {
+			require_log.logHttpResponse(response);
+			throw new Error(`Could not create custom locale ${locale}`);
+		}
+		profiler.done({ message: `custom locale ${JSON.stringify(locale)} created` });
+	}
+	failIfNot200(response, msg) {
+		if (response.status !== 200) {
+			require_log.logHttpResponse(response);
+			throw new Error(msg);
+		}
+	}
+	/**
+	* Delete a locale from a repository.
+	*
+	* @param locale - Locale to remove from the repository configuration.
+	* @throws Error if deleting the locale fails.
+	*/
+	async deleteLocale(locale) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, `app/settings/multilanguages/${locale}/delete`);
+		this.failIfNot200(response, `Could not delete locale ${locale}`);
+		profiler.done({ message: `locale '${locale}' deleted` });
+	}
+	/**
+	* Create or update the default (master) locale for a repository in Wroom, the locale needs to
+	* exist in the repository.
+	*
+	* @param locale - The locale to be set as the default.
+	* @param endpoint - "createMasterLang" to create it, "defineAsMaster" to update it.
+	* @throws Error if setting the default locale fails.
+	*/
+	async setDefaultLocale(locale, action) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, `/app/settings/multilanguages/${locale}/${{
+			create: "createMasterLang",
+			update: "defineAsMaster"
+		}[action]}`);
+		const { data, status } = response;
+		if (!(status === 200 || status === 400 && JSON.stringify(data).includes("Unable to set as master language"))) {
+			require_log.logHttpResponse(response);
+			throw new Error(`Could not set default locale to ${locale}`);
+		}
+		profiler.done({ message: `default locale set to '${locale}'` });
+	}
+	/**
+	* Retrieves documents.
+	*
+	* @param args - Configure which documents are retrieved.
+	* @returns A paginated set of documents.
+	*/
+	async getDocuments(args) {
+		return this.coreApiClient.getDocuments(args);
+	}
+	/**
+	* Creates a release.
+	*
+	* @param label - The label for the release.
+	* @returns A Promise that resolves when the release is created.
+	*/
+	async createRelease(label) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, "app/releases", { label });
+		this.failIfNot200(response, `Could not create release ${label}`);
+		profiler.done({ message: `release '${label}' created` });
+		return response.data;
+	}
+	/**
+	* Retrieves the migration release.
+	*
+	* @returns The migration relese metadata.
+	*/
+	async getMigrationRelease() {
+		const migrationRelease = (await this.coreApiClient.getReleases()).find((release) => release.migration);
+		if (!migrationRelease) throw new Error(`The repository does not have a migration release`);
+		return migrationRelease;
+	}
+	/**
+	* Publishes a release.
+	*
+	* @param id - The ID of the release.
+	* @returns A Promise that resolves when the release is published and a new master ref is
+	*   available.
+	*/
+	async publishRelease(id) {
+		const profiler = require_log.logger.startTimer();
+		const contentApi = this.getContentApiClient();
+		const masterRef = await contentApi.getMasterRef();
+		await this.coreApiClient.publishRelease(id);
+		await _playwright_test.expect.poll(async () => contentApi.getMasterRef(), {
+			timeout: 1e4,
+			message: "Waiting for new master ref to be available"
+		}).not.toBe(masterRef);
+		profiler.done({ message: `release '${id}' published and new master ref available` });
+	}
+	/**
+	* Deletes a repository release.
+	*
+	* @param id - The ID of the release to be deleted.
+	*/
+	async deleteRelease(id) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, `app/releases/${id}/delete`, {});
+		this.failIfNot200(response, `Could not delete release with id ${id}`);
+		profiler.done({ message: `release '${id}' deleted` });
+	}
+	/**
+	* Creates a preview for a repository.
+	*
+	* @param data - The data for creating the preview.
+	*/
+	async createPreview(data) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, `previews/new`, data);
+		this.failIfNot200(response, `Could not create preview ${data.name}`);
+		profiler.done({ message: `preview '${data.name}' created` });
+		return response.data;
+	}
+	/**
+	* Set the simulator URL (table of slices) for a repository.
+	*
+	* @param data - The simulator URL to set.
+	*/
+	async setSimulatorURL(simulatorURL) {
+		const profiler = require_log.logger.startTimer();
+		const repository = await this.coreApiClient.getRepository();
+		await this.coreApiClient.updateRepository({
+			...repository,
+			simulator_url: simulatorURL
+		});
+		profiler.done({ message: `simulator preview '${simulatorURL}' created` });
+	}
+	/**
+	* Deletes a preview from a repository.
+	*
+	* @param id - The ID of the preview to be deleted.
+	*/
+	async deletePreview(id) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, `previews/delete/${id}`, {});
+		this.failIfNot200(response, `Could not delete preview with id ${id}`);
+		profiler.done({ message: `preview '${id}' deleted` });
+	}
+	/**
+	* Create a webhook.
+	*
+	* @returns A Promise that resolves with the webhook id.
+	*/
+	async createWebhook(name, url, secret, triggers, active) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, "app/settings/webhooks/create", {
+			name,
+			url,
+			secret,
+			active: active ? "on" : "off",
+			...triggers
+		});
+		this.failIfNot200(response, `Could not create webhook ${name}`);
+		profiler.done({ message: `webhook '${name}' created` });
+		return response.data.created;
+	}
+	/**
+	* Deletes a webhook.
+	*
+	* @param id - The webhook ID.
+	*/
+	async deleteWebhook(id) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.wroomClient.post(this.name, `app/settings/webhooks/${id}/delete`, {});
+		this.failIfNot200(response, `Could not delete webhook with id ${id}`);
+		profiler.done({ message: `webhook '${id}' deleted` });
+	}
+	/**
+	* Create Custom Types using the Custom types api.
+	*
+	* @param customTypes
+	*/
+	async createCustomTypes(customTypes) {
+		await this.customTypesApiClient.createCustomTypes(customTypes);
+	}
+	async deleteCustomType(customTypeId) {
+		await this.customTypesApiClient.deleteCustomType(customTypeId);
+	}
+	/**
+	* Create slices using the Custom types api.
+	*
+	* @param slices
+	*/
+	async createSlices(slices) {
+		await this.customTypesApiClient.createSlices(slices);
+	}
+	/**
+	* Create an access token to query private items of the Content api.
+	*
+	* @param appName - Mandatory authorized application name
+	* @param tokenScope - Access token scope. Use "master" to when your content api is fully private
+	*   or "master+releases" to access private releases
+	*/
+	async createContentAPIToken(appName, tokenScope = "master") {
+		const profiler = require_log.logger.startTimer();
+		const existingApps = await this.wroomClient.get(this.name, "settings/security/contentapi");
+		this.failIfNot200(existingApps, `Could not get status of existing applications to generate a content api token`);
+		let app = existingApps.data.find(({ name, wroom_auths }) => {
+			return name === appName && wroom_auths.length > 0;
+		});
+		if (!app) {
+			const response = await this.wroomClient.post(this.name, "settings/security/oauthapp", { app_name: appName });
+			this.failIfNot200(response, `Could not create content api app ${appName}`);
+			app = response.data;
+		}
+		let tokenInfo = app.wroom_auths.find(({ scope }) => scope === tokenScope);
+		if (!tokenInfo) {
+			const response = await this.wroomClient.post(this.name, "settings/security/authorizations", {
+				app: app.id,
+				scope: tokenScope
+			});
+			this.failIfNot200(response, `Could not create content api access token for app ${appName} with scope ${tokenScope}`);
+			tokenInfo = response.data;
+		}
+		profiler.done({ message: `content api access token for app '${appName}' created` });
+		if (!tokenInfo?.token) throw `Could not create content api access token for app ${appName} with scope ${tokenScope}`;
+		return tokenInfo.token;
+	}
+	/** Create a permanent access token to authenticate to Prismic public apis. */
+	async createPermanentAccessToken() {
+		const profiler = require_log.logger.startTimer();
+		const token = await this.authApiClient.getMachine2MachineToken(this.name);
+		profiler.done({ message: `machine2machine token created` });
+		return token;
+	}
+	/**
+	* Toggle the Role per Locale workflow
+	*
+	* @param enabled - The feature new status
+	*/
+	async toggleRolePerLocal(enabled) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.manageV2Client.toggleRolePerLocal({
+			repository: this.name,
+			enabled
+		});
+		this.failIfNot200(response, `Could not ${enabled ? "enable" : "disable"} Role per local for ${this.name}`);
+		profiler.done({ message: `Role per local ${enabled ? "enabled" : "disabled"}` });
+	}
+	/**
+	* Toggle the Custom Roles workflow
+	*
+	* @param enabled - The feature new status
+	*/
+	async toggleCustomRoles(enabled) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.manageV2Client.toggleCustomRoles({
+			repository: this.name,
+			enabled
+		});
+		this.failIfNot200(response, `Could not ${enabled ? "enable" : "disable"} Custom Roles for ${this.name}`);
+		profiler.done({ message: `Custom Roles ${enabled ? "enabled" : "disabled"}` });
+	}
+	/**
+	* Toggle the Integration Fields feature
+	*
+	* @param enabled - The feature new status
+	*/
+	async toggleIntegrationFields(enabled) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.manageV2Client.toggleIntegrationFields({
+			repository: this.name,
+			enabled
+		});
+		this.failIfNot200(response, `Could not ${enabled ? "enable" : "disable"} Integration Fields for ${this.name}`);
+		profiler.done({ message: `Integration Fields ${enabled ? "enabled" : "disabled"}` });
+	}
+	/**
+	* Change the Repository Plan
+	*
+	* @param {string} newPlanId - The Id of the new Plan to apply
+	*/
+	async changePlan(newPlanId) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.manageV2Client.changePlan({
+			repository: this.name,
+			newPlanId,
+			bypassManualBilling: true
+		});
+		this.failIfNot200(response, "Could not change the Repository Plan");
+		profiler.done({ message: `Repository Plan changed to ${newPlanId}` });
+	}
+	/**
+	* Add a new user to the repository
+	*
+	* @param {string} email - The email of the user
+	*/
+	async addUser(email) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.manageV2Client.addUserToRepository({
+			repository: this.name,
+			email
+		});
+		const { data, status } = response;
+		if (!(status === 200 || status === 409 && JSON.stringify(data).includes("already a member of the repo"))) {
+			require_log.logHttpResponse(response);
+			throw new Error(`Could not add a new user ${email} to the repository`);
+		}
+		profiler.done({ message: `User ${email} was added to the repository` });
+	}
+	/**
+	* Remove a user from the repository
+	*
+	* @param {string} email - The email of the user
+	*/
+	async removeUser(email) {
+		const profiler = require_log.logger.startTimer();
+		const response = await this.manageV2Client.removeUserFromRepository({
+			repository: this.name,
+			email
+		});
+		this.failIfNot200(response, `Could not remove the user ${email} from the repository`);
+		profiler.done({ message: `User ${email} was removed from the repository` });
+	}
+	/**
+	* Update the role of a user in a repository
+	*
+	* @param {string} email - The email of the user
+	* @param {string | Record<string, string>} role - The new Role of the user, either a string for
+	*   basic workflow or an object such as `{ "lang_id": "Writer" }`
+	*
+	*   Example of roles are
+	*
+	*   - Administrator
+	*   - Writer
+	*   - Contributor
+	*   - Manager (publisher)
+	*/
+	async updateUserRole(email, role) {
+		const profiler = require_log.logger.startTimer();
+		const response = typeof role === "string" ? await this.wroomClient.updateRole(this.name, email, role) : await this.wroomClient.updateRolePerLocal(this.name, email, role);
+		this.failIfNot200(response, `Could not update the ${typeof role === "string" ? "role" : "rolePerLocal"} of the user ${email}`);
+		profiler.done({ message: `Updated User's ${typeof role === "string" ? "role" : "rolePerLocal"} for user ${email}` });
+	}
+	/**
+	* Creates a document using the core api. If the Core api format is too specific, use the
+	* migration api client to create a document with the MigrationApiClient. See the
+	* `getMigrationApiClient()` method.
+	*
+	* @example
+	* 	To create a document by converting it from the Page Builder to
+	* 	Core api format
+	*
+	* 	```js
+	* 	import { DocumentLegacy, UIDContentType } from '@prismicio/types-internal/lib/content';
+	*
+	* 	const document = {
+	* 	title: 'A new document',
+	* 	custom_type_id: 'home-page',
+	* 	locale: 'en-gb',
+	* 	integration_field_ids: [],
+	* 	tags: [],
+	* 	data: DocumentLegacy.encode({
+	* 	uid: {
+	* 	__TYPE__: UIDContentType,
+	* 	value: 'home-page',
+	* 	},
+	* 	})
+	* 	}
+	* 	await repository.createDocument(document, 'published');
+	* 	* ```
+	* 	```
+	*
+	* 	@returns
+	*
+	* 	@param document - in the core api format.
+	*
+	* 	@param status - status of the document, if published, the function will
+	* 	wait for a new content api master ref to be created
+	*/
+	async createDocument(document, status) {
+		const profiler = require_log.logger.startTimer();
+		const result = await this.coreApiClient.createDraft(document);
+		let message = `Document created with id '${result.id}'`;
+		if (status === "published") {
+			const contentApi = this.getContentApiClient();
+			const masterRef = await contentApi.getMasterRef();
+			await this.coreApiClient.publishDraft(result.id);
+			await _playwright_test.expect.poll(async () => contentApi.getMasterRef(), {
+				timeout: 1e4,
+				message: "Waiting for new master ref to be available"
+			}).not.toBe(masterRef);
+			message += ", status 'published' and new master ref available";
+		}
+		profiler.done({ message });
+		return result;
+	}
+	/**
+	* Retrieves data for a specific document version.
+	*
+	* @param versionId - The document's version ID.
+	* @returns The document's version data.
+	*/
+	async getDocumentData(versionId) {
+		return await this.coreApiClient.getDocumentData(versionId);
+	}
+	async setupIntegrationFields(integrationFields) {
+		const profiler = require_log.logger.startTimer();
+		if (!this.integrationFieldsClient) throw new Error("Integration Fields client not found. Did you provide a integration fields api url in the configuration?");
+		await this.integrationFieldsClient.setupIntegrationFields(integrationFields);
+		profiler.done({ message: `Integration Fields setup` });
+	}
 };
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const test = require("@playwright/test");
-const contentApi = require("../clients/contentApi.cjs");
-const log = require("../utils/log.cjs");
-const urls = require("../utils/urls.cjs");
-class RepositoryManager {
-  constructor(name, coreApiClient, authApiClient, wroomClient, customTypesApiClient, migrationApiClient, assetApiClient, manageV2Client, integrationFieldsClient) {
-    __publicField(this, "name");
-    __publicField(this, "coreApiClient");
-    __publicField(this, "authApiClient");
-    __publicField(this, "wroomClient");
-    __publicField(this, "customTypesApiClient");
-    __publicField(this, "migrationApiClient");
-    __publicField(this, "assetApiClient");
-    __publicField(this, "manageV2Client");
-    __publicField(this, "integrationFieldsClient");
-    this.name = name;
-    this.coreApiClient = coreApiClient;
-    this.authApiClient = authApiClient;
-    this.wroomClient = wroomClient;
-    this.customTypesApiClient = customTypesApiClient;
-    this.migrationApiClient = migrationApiClient;
-    this.assetApiClient = assetApiClient;
-    this.manageV2Client = manageV2Client;
-    this.integrationFieldsClient = integrationFieldsClient;
-  }
-  async configure(config) {
-    const hasLangConfig = config.defaultLocale || config.locales || config.customLocale;
-    if (hasLangConfig) {
-      const languages = await this.coreApiClient.getLanguages();
-      let updateDefaultLocaleAtTheEnd = false;
-      if (config.defaultLocale) {
-        const master = languages.find(({ is_master }) => is_master === true);
-        if (!master) {
-          await this.setDefaultLocale(config.defaultLocale, "create");
-        } else if (master.id !== config.defaultLocale) {
-          updateDefaultLocaleAtTheEnd = true;
-        }
-      }
-      if (config.locales) {
-        const localesToAdd = config.locales.filter((id) => !languages.some((language) => language.id === id));
-        if (localesToAdd.length > 0) {
-          await this.createLocales(localesToAdd);
-        }
-      }
-      if (config.customLocale) {
-        if (!languages.find(({ id }) => {
-          var _a;
-          return id === ((_a = config.customLocale) == null ? void 0 : _a.lang.id);
-        })) {
-          await this.createCustomLocale(config.customLocale);
-        }
-      }
-      if (config.defaultLocale && updateDefaultLocaleAtTheEnd) {
-        await this.setDefaultLocale(config.defaultLocale, "update");
-      }
-    }
-    if (config.slices) {
-      await this.createSlices(config.slices);
-    }
-    if (config.customTypes) {
-      await this.createCustomTypes(config.customTypes);
-    }
-    if (config.preview) {
-      await this.createPreview(config.preview);
-    }
-    if (config.simulatorURL) {
-      await this.setSimulatorURL(config.simulatorURL);
-    }
-    if (config.rolePerLocal) {
-      await this.toggleRolePerLocal(true);
-    }
-    if (config.customRoles) {
-      await this.toggleCustomRoles(true);
-    }
-    if (config.integrationFields) {
-      await this.toggleIntegrationFields(true);
-      await this.setupIntegrationFields(config.integrationFields);
-    }
-  }
-  /** @returns the repository base url, like https://my-repo.prismic.io */
-  getBaseURL() {
-    return urls.getRepositoryUrl(this.wroomClient.getBaseURL(), this.name);
-  }
-  /** @returns the repository base cdn url, like https://my-repo.cdn.prismic.io */
-  getBaseCdnURL() {
-    return urls.getRepositoryUrl(this.wroomClient.getBaseURL(), `${this.name}.cdn`);
-  }
-  /**
-   * @returns a Content Type api client configured to target the repository CDN
-   *   url. Uses Playwright for requests so if your project uses Playwright too,
-   *   any network request will be present in Playwright test reports.
-   */
-  getContentApiClient(config) {
-    return new contentApi.ContentApiClient(this.getBaseCdnURL(), config);
-  }
-  /**
-   * @returns an instance of the Migration api client, see
-   *   https://prismic.io/docs/migration-api-technical-reference
-   */
-  getMigrationApiClient() {
-    if (!this.migrationApiClient) {
-      throw "No client found for the migration api. Did you provide a migration api url in the configuration?";
-    }
-    return this.migrationApiClient;
-  }
-  /**
-   * @returns an instance of the Asset api client, see
-   *   https://prismic.io/docs/asset-api-technical-reference
-   */
-  getAssetApiClient() {
-    return this.assetApiClient;
-  }
-  /** @returns the Wroom commit hash deployed on the current repository */
-  async getDeployedVersion() {
-    const response = await this.wroomClient.get(this.name, "underground/834b34f16f451e00f268dd5c8c81d16e3c020275");
-    return response.data.version;
-  }
-  /**
-   * Set additional standard locales for a repository in Wroom, does not fail if
-   * the locales already exist.
-   *
-   * @param locales - An array of all locales to be added to the repository.
-   *
-   * @throws Error if setting the locales fails.
-   */
-  async createLocales(locales) {
-    const profiler = log.logger.startTimer();
-    const response = await this.wroomClient.post(this.name, "app/settings/multilanguages", { languages: locales });
-    const { data, status } = response;
-    const success = status === 200 || status === 400 && data.includes("already existing languages");
-    if (!success) {
-      log.logHttpResponse(response);
-      throw new Error(`Could not add locales ${locales.join(", ")}`);
-    }
-    profiler.done({ message: `locales '${locales}' created` });
-  }
-  /**
-   * Set additional custom locale for a repository in Wroom, does not fail if
-   * the locales already exist.
-   *
-   * @param locale - The locale to be added to the repository.
-   *
-   * @throws Error if setting the locale fails.
-   */
-  async createCustomLocale(locale) {
-    const profiler = log.logger.startTimer();
-    const response = await this.wroomClient.post(this.name, "app/settings/multilanguages/custom", locale);
-    const { data, status } = response;
-    const success = status === 200 || status === 400 && JSON.stringify(data).includes("code is already used");
-    if (!success) {
-      log.logHttpResponse(response);
-      throw new Error(`Could not create custom locale ${locale}`);
-    }
-    profiler.done({
-      message: `custom locale ${JSON.stringify(locale)} created`
-    });
-  }
-  failIfNot200(response, msg) {
-    if (response.status !== 200) {
-      log.logHttpResponse(response);
-      throw new Error(msg);
-    }
-  }
-  /**
-   * Delete a locale from a repository.
-   *
-   * @param locale - locale to remove from the repository configuration.
-   *
-   * @throws Error if deleting the locale fails.
-   */
-  async deleteLocale(locale) {
-    const profiler = log.logger.startTimer();
-    const response = await this.wroomClient.post(this.name, `app/settings/multilanguages/${locale}/delete`);
-    this.failIfNot200(response, `Could not delete locale ${locale}`);
-    profiler.done({ message: `locale '${locale}' deleted` });
-  }
-  /**
-   * Create or update the default (master) locale for a repository in Wroom, the
-   * locale needs to exist in the repository.
-   *
-   * @param locale - The locale to be set as the default.
-   * @param endpoint - "createMasterLang" to create it, "defineAsMaster" to
-   *   update it.
-   *
-   * @throws Error if setting the default locale fails.
-   */
-  async setDefaultLocale(locale, action) {
-    const profiler = log.logger.startTimer();
-    const endpoint = {
-      create: "createMasterLang",
-      update: "defineAsMaster"
-    };
-    const response = await this.wroomClient.post(this.name, `/app/settings/multilanguages/${locale}/${endpoint[action]}`);
-    const { data, status } = response;
-    const success = status === 200 || status === 400 && // returns 400 if master lang is already set
-    JSON.stringify(data).includes("Unable to set as master language");
-    if (!success) {
-      log.logHttpResponse(response);
-      throw new Error(`Could not set default locale to ${locale}`);
-    }
-    profiler.done({ message: `default locale set to '${locale}'` });
-  }
-  /**
-   * Retrieves documents.
-   *
-   * @param args - Configure which documents are retrieved.
-   *
-   * @returns A paginated set of documents.
-   */
-  async getDocuments(args) {
-    return this.coreApiClient.getDocuments(args);
-  }
-  /**
-   * Creates a release.
-   *
-   * @param label - The label for the release.
-   *
-   * @returns A Promise that resolves when the release is created.
-   */
-  async createRelease(label) {
-    const profiler = log.logger.startTimer();
-    const response = await this.wroomClient.post(this.name, "app/releases", {
-      label
-    });
-    this.failIfNot200(response, `Could not create release ${label}`);
-    profiler.done({ message: `release '${label}' created` });
-    return response.data;
-  }
-  /**
-   * Retrieves the migration release.
-   *
-   * @returns The migration relese metadata.
-   */
-  async getMigrationRelease() {
-    const releases = await this.coreApiClient.getReleases();
-    const migrationRelease = releases.find((release) => release.migration);
-    if (!migrationRelease) {
-      throw new Error(`The repository does not have a migration release`);
-    }
-    return migrationRelease;
-  }
-  /**
-   * Publishes a release.
-   *
-   * @param id - The ID of the release.
-   *
-   * @returns A Promise that resolves when the release is published and a new
-   *   master ref is available.
-   */
-  async publishRelease(id) {
-    const profiler = log.logger.startTimer();
-    const contentApi2 = this.getContentApiClient();
-    const masterRef = await contentApi2.getMasterRef();
-    await this.coreApiClient.publishRelease(id);
-    await test.expect.poll(async () => contentApi2.getMasterRef(), {
-      timeout: 1e4,
-      message: "Waiting for new master ref to be available"
-    }).not.toBe(masterRef);
-    profiler.done({
-      message: `release '${id}' published and new master ref available`
-    });
-  }
-  /**
-   * Deletes a repository release.
-   *
-   * @param id - The ID of the release to be deleted.
-   */
-  async deleteRelease(id) {
-    const profiler = log.logger.startTimer();
-    const response = await this.wroomClient.post(this.name, `app/releases/${id}/delete`, {});
-    this.failIfNot200(response, `Could not delete release with id ${id}`);
-    profiler.done({ message: `release '${id}' deleted` });
-  }
-  /**
-   * Creates a preview for a repository.
-   *
-   * @param data - The data for creating the preview.
-   */
-  async createPreview(data) {
-    const profiler = log.logger.startTimer();
-    const response = await this.wroomClient.post(this.name, `previews/new`, data);
-    this.failIfNot200(response, `Could not create preview ${data.name}`);
-    profiler.done({ message: `preview '${data.name}' created` });
-    return response.data;
-  }
-  /**
-   * Set the simulator URL (table of slices) for a repository.
-   *
-   * @param data - The simulator URL to set.
-   */
-  async setSimulatorURL(simulatorURL) {
-    const profiler = log.logger.startTimer();
-    const repository = await this.coreApiClient.getRepository();
-    await this.coreApiClient.updateRepository({
-      ...repository,
-      simulator_url: simulatorURL
-    });
-    profiler.done({
-      message: `simulator preview '${simulatorURL}' created`
-    });
-  }
-  /**
-   * Deletes a preview from a repository.
-   *
-   * @param id - The ID of the preview to be deleted.
-   */
-  async deletePreview(id) {
-    const profiler = log.logger.startTimer();
-    const response = await this.wroomClient.post(this.name, `previews/delete/${id}`, {});
-    this.failIfNot200(response, `Could not delete preview with id ${id}`);
-    profiler.done({ message: `preview '${id}' deleted` });
-  }
-  /**
-   * Create a webhook.
-   *
-   * @returns A Promise that resolves with the webhook id.
-   */
-  async createWebhook(name, url, secret, triggers, active) {
-    const profiler = log.logger.startTimer();
-    const response = await this.wroomClient.post(this.name, "app/settings/webhooks/create", {
-      name,
-      url,
-      secret,
-      active: active ? "on" : "off",
-      ...triggers
-    });
-    this.failIfNot200(response, `Could not create webhook ${name}`);
-    profiler.done({ message: `webhook '${name}' created` });
-    return response.data.created;
-  }
-  /**
-   * Deletes a webhook.
-   *
-   * @param id - The webhook ID.
-   */
-  async deleteWebhook(id) {
-    const profiler = log.logger.startTimer();
-    const response = await this.wroomClient.post(this.name, `app/settings/webhooks/${id}/delete`, {});
-    this.failIfNot200(response, `Could not delete webhook with id ${id}`);
-    profiler.done({ message: `webhook '${id}' deleted` });
-  }
-  /**
-   * Create Custom Types using the Custom types api.
-   *
-   * @param customTypes -
-   */
-  async createCustomTypes(customTypes) {
-    await this.customTypesApiClient.createCustomTypes(customTypes);
-  }
-  async deleteCustomType(customTypeId) {
-    await this.customTypesApiClient.deleteCustomType(customTypeId);
-  }
-  /**
-   * Create slices using the Custom types api.
-   *
-   * @param slices -
-   */
-  async createSlices(slices) {
-    await this.customTypesApiClient.createSlices(slices);
-  }
-  /**
-   * Create an access token to query private items of the Content api.
-   *
-   * @param appName - mandatory authorized application name
-   * @param tokenScope - access token scope. Use "master" to when your content
-   *   api is fully private or "master+releases" to access private releases
-   */
-  async createContentAPIToken(appName, tokenScope = "master") {
-    const profiler = log.logger.startTimer();
-    const existingApps = await this.wroomClient.get(this.name, "settings/security/contentapi");
-    this.failIfNot200(existingApps, `Could not get status of existing applications to generate a content api token`);
-    let app = existingApps.data.find(({ name, wroom_auths }) => {
-      return name === appName && wroom_auths.length > 0;
-    });
-    if (!app) {
-      const response = await this.wroomClient.post(this.name, "settings/security/oauthapp", {
-        app_name: appName
-      });
-      this.failIfNot200(response, `Could not create content api app ${appName}`);
-      app = response.data;
-    }
-    let tokenInfo = app.wroom_auths.find(({ scope }) => scope === tokenScope);
-    if (!tokenInfo) {
-      const response = await this.wroomClient.post(this.name, "settings/security/authorizations", {
-        app: app.id,
-        scope: tokenScope
-      });
-      this.failIfNot200(response, `Could not create content api access token for app ${appName} with scope ${tokenScope}`);
-      tokenInfo = response.data;
-    }
-    profiler.done({
-      message: `content api access token for app '${appName}' created`
-    });
-    if (!(tokenInfo == null ? void 0 : tokenInfo.token)) {
-      throw `Could not create content api access token for app ${appName} with scope ${tokenScope}`;
-    }
-    return tokenInfo.token;
-  }
-  /** Create a permanent access token to authenticate to Prismic public apis. */
-  async createPermanentAccessToken() {
-    const profiler = log.logger.startTimer();
-    const token = await this.authApiClient.getMachine2MachineToken(this.name);
-    profiler.done({
-      message: `machine2machine token created`
-    });
-    return token;
-  }
-  /**
-   * Toggle the Role per Locale workflow
-   *
-   * @param enabled - The feature new status
-   */
-  async toggleRolePerLocal(enabled) {
-    const profiler = log.logger.startTimer();
-    const response = await this.manageV2Client.toggleRolePerLocal({
-      repository: this.name,
-      enabled
-    });
-    this.failIfNot200(response, `Could not ${enabled ? "enable" : "disable"} Role per local for ${this.name}`);
-    profiler.done({
-      message: `Role per local ${enabled ? "enabled" : "disabled"}`
-    });
-  }
-  /**
-   * Toggle the Custom Roles workflow
-   *
-   * @param enabled - The feature new status
-   */
-  async toggleCustomRoles(enabled) {
-    const profiler = log.logger.startTimer();
-    const response = await this.manageV2Client.toggleCustomRoles({
-      repository: this.name,
-      enabled
-    });
-    this.failIfNot200(response, `Could not ${enabled ? "enable" : "disable"} Custom Roles for ${this.name}`);
-    profiler.done({
-      message: `Custom Roles ${enabled ? "enabled" : "disabled"}`
-    });
-  }
-  /**
-   * Toggle the Integration Fields feature
-   *
-   * @param enabled - The feature new status
-   */
-  async toggleIntegrationFields(enabled) {
-    const profiler = log.logger.startTimer();
-    const response = await this.manageV2Client.toggleIntegrationFields({
-      repository: this.name,
-      enabled
-    });
-    this.failIfNot200(response, `Could not ${enabled ? "enable" : "disable"} Integration Fields for ${this.name}`);
-    profiler.done({
-      message: `Integration Fields ${enabled ? "enabled" : "disabled"}`
-    });
-  }
-  /**
-   * Change the Repository Plan
-   *
-   * @param {string} newPlanId - The Id of the new Plan to apply
-   */
-  async changePlan(newPlanId) {
-    const profiler = log.logger.startTimer();
-    const response = await this.manageV2Client.changePlan({
-      repository: this.name,
-      newPlanId,
-      bypassManualBilling: true
-      // For now the library does not support Stripe features
-    });
-    this.failIfNot200(response, "Could not change the Repository Plan");
-    profiler.done({
-      message: `Repository Plan changed to ${newPlanId}`
-    });
-  }
-  /**
-   * Add a new user to the repository
-   *
-   * @param {string} email - The email of the user
-   */
-  async addUser(email) {
-    const profiler = log.logger.startTimer();
-    const response = await this.manageV2Client.addUserToRepository({
-      repository: this.name,
-      email
-    });
-    const { data, status } = response;
-    const success = status === 200 || status === 409 && JSON.stringify(data).includes("already a member of the repo");
-    if (!success) {
-      log.logHttpResponse(response);
-      throw new Error(`Could not add a new user ${email} to the repository`);
-    }
-    profiler.done({
-      message: `User ${email} was added to the repository`
-    });
-  }
-  /**
-   * Remove a user from the repository
-   *
-   * @param {string} email - The email of the user
-   */
-  async removeUser(email) {
-    const profiler = log.logger.startTimer();
-    const response = await this.manageV2Client.removeUserFromRepository({
-      repository: this.name,
-      email
-    });
-    this.failIfNot200(response, `Could not remove the user ${email} from the repository`);
-    profiler.done({
-      message: `User ${email} was removed from the repository`
-    });
-  }
-  /**
-   * Update the role of a user in a repository
-   *
-   * @param {string} email - The email of the user
-   * @param {string | Record<string, string>} role - The new Role of the user,
-   *   either a string for basic workflow or an object such as `{ "lang_id":
-   *   "Writer" }`
-   *
-   *   Example of roles are
-   *
-   *   - Administrator
-   *   - Writer
-   *   - Contributor
-   *   - Manager (publisher)
-   */
-  async updateUserRole(email, role) {
-    const profiler = log.logger.startTimer();
-    const response = typeof role === "string" ? await this.wroomClient.updateRole(this.name, email, role) : await this.wroomClient.updateRolePerLocal(this.name, email, role);
-    this.failIfNot200(response, `Could not update the ${typeof role === "string" ? "role" : "rolePerLocal"} of the user ${email}`);
-    profiler.done({
-      message: `Updated User's ${typeof role === "string" ? "role" : "rolePerLocal"} for user ${email}`
-    });
-  }
-  /**
-   * Creates a document using the core api. If the Core api format is too
-   * specific, use the migration api client to create a document with the
-   * MigrationApiClient. See the `getMigrationApiClient()` method.
-   *
-   * @example To create a document by converting it from the Page Builder to
-   * Core api format
-   *
-   * ```js
-   * import { DocumentLegacy, UIDContentType } from '@prismicio/types-internal/lib/content';
-   *
-   * const document = {
-   *   title: 'A new document',
-   *   custom_type_id: 'home-page',
-   *   locale: 'en-gb',
-   *   integration_field_ids: [],
-   *   tags: [],
-   *   data: DocumentLegacy.encode({
-   *     uid: {
-   *       __TYPE__: UIDContentType,
-   *       value: 'home-page',
-   *     },
-   *   })
-   *   }
-   *   await repository.createDocument(document, 'published');
-   * 	 * ```
-   * ```
-   *
-   * @returns
-   *
-   * @param document - in the core api format.
-   *
-   * @param status - status of the document, if published, the function will
-   * wait for a new content api master ref to be created
-   */
-  async createDocument(document, status) {
-    const profiler = log.logger.startTimer();
-    const result = await this.coreApiClient.createDraft(document);
-    let message = `Document created with id '${result.id}'`;
-    if (status === "published") {
-      const contentApi2 = this.getContentApiClient();
-      const masterRef = await contentApi2.getMasterRef();
-      await this.coreApiClient.publishDraft(result.id);
-      await test.expect.poll(async () => contentApi2.getMasterRef(), {
-        timeout: 1e4,
-        message: "Waiting for new master ref to be available"
-      }).not.toBe(masterRef);
-      message += ", status 'published' and new master ref available";
-    }
-    profiler.done({
-      message
-    });
-    return result;
-  }
-  /**
-   * Retrieves data for a specific document version.
-   *
-   * @param versionId - The document's version ID.
-   *
-   * @returns The document's version data.
-   */
-  async getDocumentData(versionId) {
-    return await this.coreApiClient.getDocumentData(versionId);
-  }
-  async setupIntegrationFields(integrationFields) {
-    const profiler = log.logger.startTimer();
-    if (!this.integrationFieldsClient) {
-      throw new Error("Integration Fields client not found. Did you provide a integration fields api url in the configuration?");
-    }
-    await this.integrationFieldsClient.setupIntegrationFields(integrationFields);
-    profiler.done({
-      message: `Integration Fields setup`
-    });
-  }
-}
+//#endregion
 exports.RepositoryManager = RepositoryManager;
-//# sourceMappingURL=repository.cjs.map
+
+//# sourceMappingURL=repository.cjs.map