@prismicio/e2e-tests-utils 1.18.0 → 1.19.0-canary.d349d21

package/dist/managers/repository.d.ts

@@ -1,312 +1,341 @@
-import { CustomType, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
-import { IntegrationFieldConfig } from "../types";
-import { AssetApiClient } from "../clients/assetApi";
-import { AuthenticationApiClient } from "../clients/authenticationApi";
-import { ContentApiClient } from "../clients/contentApi";
-import { CoreApiClient, CoreApiDocumentCreationPayload, CoreApiDocumentCreationResponse, CoreApiDocumentData, CoreApiDocumentsPayload, CoreApiDocumentsResponse, Release } from "../clients/coreApi";
-import { CustomTypesApiClient } from "../clients/customTypesApi";
-import { IntegrationFieldsClient } from "../clients/integrationFields";
-import { ManageV2Client } from "../clients/manageV2";
-import { MigrationApiClient } from "../clients/migrationApi";
-import { WroomClient } from "../clients/wroom";
+import { IntegrationFieldConfig } from "../types.js";
+import { AssetApiClient } from "../clients/assetApi.js";
+import { AuthenticationApiClient } from "../clients/authenticationApi.js";
+import { ContentApiClient } from "../clients/contentApi.js";
+import { CoreApiClient, CoreApiDocumentCreationPayload, CoreApiDocumentCreationResponse, CoreApiDocumentData, CoreApiDocumentUpdatePayload, CoreApiDocumentsPayload, CoreApiDocumentsResponse, Release } from "../clients/coreApi.js";
+import { CustomTypesApiClient } from "../clients/customTypesApi.js";
+import { WroomClient } from "../clients/wroom.js";
+import { IntegrationFieldsClient } from "../clients/integrationFields.js";
+import { ManageV2Client } from "../clients/manageV2.js";
+import { MigrationApiClient } from "../clients/migrationApi.js";
+import { DynamicCustomTypeModel, SharedSliceModel } from "@prismicio/types-internal";
+
+//#region src/managers/repository.d.ts
 /** Utility to manage test data for a Prismic repository */
-export declare class RepositoryManager {
-    readonly name: string;
-    private readonly coreApiClient;
-    private readonly authApiClient;
-    private readonly wroomClient;
-    private readonly customTypesApiClient;
-    private readonly migrationApiClient;
-    private readonly assetApiClient;
-    private readonly manageV2Client;
-    private readonly integrationFieldsClient;
-    constructor(name: string, coreApiClient: CoreApiClient, authApiClient: AuthenticationApiClient, wroomClient: WroomClient, customTypesApiClient: CustomTypesApiClient, migrationApiClient: MigrationApiClient | undefined, assetApiClient: AssetApiClient, manageV2Client: ManageV2Client, integrationFieldsClient: IntegrationFieldsClient | undefined);
-    configure(config: RepositoryConfig): Promise<void>;
-    /** @returns the repository base url, like https://my-repo.prismic.io */
-    getBaseURL(): string;
-    /** @returns the repository base cdn url, like https://my-repo.cdn.prismic.io */
-    getBaseCdnURL(): string;
-    /**
-     * @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?: {
-        version?: "v1" | "v2";
-        accessToken?: string;
-    }): ContentApiClient;
-    /**
-     * @returns an instance of the Migration api client, see
-     *   https://prismic.io/docs/migration-api-technical-reference
-     */
-    getMigrationApiClient(): MigrationApiClient;
-    /**
-     * @returns an instance of the Asset api client, see
-     *   https://prismic.io/docs/asset-api-technical-reference
-     */
-    getAssetApiClient(): AssetApiClient;
-    /** @returns the Wroom commit hash deployed on the current repository */
-    getDeployedVersion(): Promise<string | undefined>;
-    /**
-     * 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.
-     */
-    createLocales(locales: string[]): Promise<void>;
-    /**
-     * 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.
-     */
-    createCustomLocale(locale: CustomLocale): Promise<void>;
-    private failIfNot200;
-    /**
-     * Delete a locale from a repository.
-     *
-     * @param locale - locale to remove from the repository configuration.
-     *
-     * @throws Error if deleting the locale fails.
-     */
-    deleteLocale(locale: string): Promise<void>;
-    /**
-     * 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.
-     */
-    setDefaultLocale(locale: string, action: "create" | "update"): Promise<void>;
-    /**
-     * Retrieves documents.
-     *
-     * @param args - Configure which documents are retrieved.
-     *
-     * @returns A paginated set of documents.
-     */
-    getDocuments(args: CoreApiDocumentsPayload): Promise<CoreApiDocumentsResponse>;
-    /**
-     * Creates a release.
-     *
-     * @param label - The label for the release.
-     *
-     * @returns A Promise that resolves when the release is created.
-     */
-    createRelease(label: string): Promise<{
-        id: string;
-    }>;
-    /**
-     * Retrieves the migration release.
-     *
-     * @returns The migration relese metadata.
-     */
-    getMigrationRelease(): Promise<Release>;
-    /**
-     * 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.
-     */
-    publishRelease(id: string): Promise<void>;
-    /**
-     * Deletes a repository release.
-     *
-     * @param id - The ID of the release to be deleted.
-     */
-    deleteRelease(id: string): Promise<void>;
-    /**
-     * Creates a preview for a repository.
-     *
-     * @param data - The data for creating the preview.
-     */
-    createPreview(data: Preview): Promise<void>;
-    /**
-     * Set the simulator URL (table of slices) for a repository.
-     *
-     * @param data - The simulator URL to set.
-     */
-    setSimulatorURL(simulatorURL: string): Promise<void>;
-    /**
-     * Deletes a preview from a repository.
-     *
-     * @param id - The ID of the preview to be deleted.
-     */
-    deletePreview(id: string): Promise<void>;
-    /**
-     * Create a webhook.
-     *
-     * @returns A Promise that resolves with the webhook id.
-     */
-    createWebhook(name: string, url: string, secret: string, triggers: {
-        documentsPublished?: boolean;
-        documentsUnpublished?: boolean;
-        releasesCreated?: boolean;
-        releasesUpdated?: boolean;
-        tagsCreated?: boolean;
-        tagsDeleted?: boolean;
-    }, active: boolean): Promise<string>;
-    /**
-     * Deletes a webhook.
-     *
-     * @param id - The webhook ID.
-     */
-    deleteWebhook(id: string): Promise<void>;
-    /**
-     * Create Custom Types using the Custom types api.
-     *
-     * @param customTypes -
-     */
-    createCustomTypes(customTypes: CustomType[]): Promise<void>;
-    deleteCustomType(customTypeId: string): Promise<void>;
-    /**
-     * Create slices using the Custom types api.
-     *
-     * @param slices -
-     */
-    createSlices(slices: SharedSlice[]): Promise<void>;
-    /**
-     * 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
-     */
-    createContentAPIToken(appName: string, tokenScope?: "master" | "master+releases"): Promise<string>;
-    /** Create a permanent access token to authenticate to Prismic public apis. */
-    createPermanentAccessToken(): Promise<string>;
-    /**
-     * Toggle the Role per Locale workflow
-     *
-     * @param enabled - The feature new status
-     */
-    toggleRolePerLocal(enabled: boolean): Promise<void>;
-    /**
-     * Toggle the Custom Roles workflow
-     *
-     * @param enabled - The feature new status
-     */
-    toggleCustomRoles(enabled: boolean): Promise<void>;
-    /**
-     * Toggle the Integration Fields feature
-     *
-     * @param enabled - The feature new status
-     */
-    toggleIntegrationFields(enabled: boolean): Promise<void>;
-    /**
-     * Change the Repository Plan
-     *
-     * @param {string} newPlanId - The Id of the new Plan to apply
-     */
-    changePlan(newPlanId: string): Promise<void>;
-    /**
-     * Add a new user to the repository
-     *
-     * @param {string} email - The email of the user
-     */
-    addUser(email: string): Promise<void>;
-    /**
-     * Remove a user from the repository
-     *
-     * @param {string} email - The email of the user
-     */
-    removeUser(email: string): Promise<void>;
-    /**
-     * 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)
-     */
-    updateUserRole(email: string, role: string | Record<string, string>): Promise<void>;
-    /**
-     * 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
-     */
-    createDocument(document: CoreApiDocumentCreationPayload, status: "draft" | "published"): Promise<CoreApiDocumentCreationResponse>;
-    /**
-     * Retrieves data for a specific document version.
-     *
-     * @param versionId - The document's version ID.
-     *
-     * @returns The document's version data.
-     */
-    getDocumentData(versionId: string): Promise<CoreApiDocumentData>;
-    setupIntegrationFields(integrationFields: IntegrationFieldConfig[]): Promise<void>;
+declare class RepositoryManager {
+  readonly name: string;
+  private readonly coreApiClient;
+  private readonly authApiClient;
+  private readonly wroomClient;
+  private readonly customTypesApiClient;
+  private readonly migrationApiClient;
+  private readonly assetApiClient;
+  private readonly manageV2Client;
+  private readonly integrationFieldsClient;
+  constructor(name: string, coreApiClient: CoreApiClient, authApiClient: AuthenticationApiClient, wroomClient: WroomClient, customTypesApiClient: CustomTypesApiClient, migrationApiClient: MigrationApiClient | undefined, assetApiClient: AssetApiClient, manageV2Client: ManageV2Client, integrationFieldsClient: IntegrationFieldsClient | undefined);
+  configure(config: RepositoryConfig): Promise<void>;
+  /** @returns The repository base url, like https://my-repo.prismic.io */
+  getBaseURL(): string;
+  /** @returns The repository base cdn url, like https://my-repo.cdn.prismic.io */
+  getBaseCdnURL(): string;
+  /**
+   * @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?: {
+    version?: "v1" | "v2";
+    accessToken?: string;
+  }): ContentApiClient;
+  /**
+   * @returns An instance of the Migration api client, see
+   *   https://prismic.io/docs/migration-api-technical-reference
+   */
+  getMigrationApiClient(): MigrationApiClient;
+  /**
+   * @returns An instance of the Asset api client, see
+   *   https://prismic.io/docs/asset-api-technical-reference
+   */
+  getAssetApiClient(): AssetApiClient;
+  /** @returns The Wroom commit hash deployed on the current repository */
+  getDeployedVersion(): Promise<string | undefined>;
+  /**
+   * 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.
+   */
+  createLocales(locales: string[]): Promise<void>;
+  /**
+   * 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.
+   */
+  createCustomLocale(locale: CustomLocale): Promise<void>;
+  private failIfNot200;
+  /**
+   * Delete a locale from a repository.
+   *
+   * @param locale - Locale to remove from the repository configuration.
+   * @throws Error if deleting the locale fails.
+   */
+  deleteLocale(locale: string): Promise<void>;
+  /**
+   * 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.
+   */
+  setDefaultLocale(locale: string, action: "create" | "update"): Promise<void>;
+  /**
+   * Retrieves documents.
+   *
+   * @param args - Configure which documents are retrieved.
+   * @returns A paginated set of documents.
+   */
+  getDocuments(args: CoreApiDocumentsPayload): Promise<CoreApiDocumentsResponse>;
+  /**
+   * Creates a release.
+   *
+   * @param label - The label for the release.
+   * @returns A Promise that resolves when the release is created.
+   */
+  createRelease(label: string): Promise<{
+    id: string;
+  }>;
+  /**
+   * Retrieves the migration release.
+   *
+   * @returns The migration relese metadata.
+   */
+  getMigrationRelease(): Promise<Release>;
+  /**
+   * 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.
+   */
+  publishRelease(id: string): Promise<void>;
+  /**
+   * Deletes a repository release.
+   *
+   * @param id - The ID of the release to be deleted.
+   */
+  deleteRelease(id: string): Promise<void>;
+  /**
+   * Creates a preview for a repository.
+   *
+   * @param data - The data for creating the preview.
+   */
+  createPreview(data: Preview): Promise<void>;
+  /**
+   * Set the simulator URL (table of slices) for a repository.
+   *
+   * @param data - The simulator URL to set.
+   */
+  setSimulatorURL(simulatorURL: string): Promise<void>;
+  /**
+   * Deletes a preview from a repository.
+   *
+   * @param id - The ID of the preview to be deleted.
+   */
+  deletePreview(id: string): Promise<void>;
+  /**
+   * Create a webhook.
+   *
+   * @returns A Promise that resolves with the webhook id.
+   */
+  createWebhook(name: string, url: string, secret: string, triggers: {
+    documentsPublished?: boolean;
+    documentsUnpublished?: boolean;
+    releasesCreated?: boolean;
+    releasesUpdated?: boolean;
+    tagsCreated?: boolean;
+    tagsDeleted?: boolean;
+  }, active: boolean): Promise<string>;
+  /**
+   * Deletes a webhook.
+   *
+   * @param id - The webhook ID.
+   */
+  deleteWebhook(id: string): Promise<void>;
+  /**
+   * Create Custom Types using the Custom types api.
+   *
+   * @param customTypes
+   */
+  createCustomTypes(customTypes: DynamicCustomTypeModel[]): Promise<void>;
+  deleteCustomType(customTypeId: string): Promise<void>;
+  /**
+   * Create slices using the Custom types api.
+   *
+   * @param slices
+   */
+  createSlices(slices: SharedSliceModel[]): Promise<void>;
+  /**
+   * 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
+   */
+  createContentAPIToken(appName: string, tokenScope?: "master" | "master+releases"): Promise<string>;
+  /** Create a permanent access token to authenticate to Prismic public apis. */
+  createPermanentAccessToken(): Promise<string>;
+  /**
+   * Toggle the Role per Locale workflow
+   *
+   * @param enabled - The feature new status
+   */
+  toggleRolePerLocal(enabled: boolean): Promise<void>;
+  /**
+   * Toggle the Custom Roles workflow
+   *
+   * @param enabled - The feature new status
+   */
+  toggleCustomRoles(enabled: boolean): Promise<void>;
+  /**
+   * Toggle the Integration Fields feature
+   *
+   * @param enabled - The feature new status
+   */
+  toggleIntegrationFields(enabled: boolean): Promise<void>;
+  /**
+   * Change the Repository Plan
+   *
+   * @param {string} newPlanId - The Id of the new Plan to apply
+   */
+  changePlan(newPlanId: string): Promise<void>;
+  /**
+   * Add a new user to the repository
+   *
+   * @param {string} email - The email of the user
+   */
+  addUser(email: string): Promise<void>;
+  /**
+   * Remove a user from the repository
+   *
+   * @param {string} email - The email of the user
+   */
+  removeUser(email: string): Promise<void>;
+  /**
+   * 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)
+   */
+  updateUserRole(email: string, role: string | Record<string, string>): Promise<void>;
+  /**
+   * 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
+   */
+  createDocument(document: CoreApiDocumentCreationPayload, status: "draft" | "published"): Promise<CoreApiDocumentCreationResponse>;
+  /**
+   * Updates an existing document using the core api by creating a new draft version on top of the
+   * given base version. If the status is published, the function will, unless disabled, wait for a
+   * new content api master ref to be created.
+   *
+   * @param documentId - The id of the document to update.
+   * @param data - The new version payload in the core api format.
+   * @param baseVersionId - The id of the version the draft is created from.
+   * @param status - Status of the new version, if published, the function will wait for a new
+   *   content api master ref to be created.
+   * @param options - Additional options.
+   * @param options.skipMasterRefWait - When publishing, skip waiting for a new content api master
+   *   ref to be available (default false). Set to true to return without waiting for the
+   *   projection.
+   * @returns The updated document, including the new version's id. When publishing, the document is
+   *   retrieved again after publication so that the returned versions reflect the published state.
+   */
+  updateDocument(documentId: string, data: CoreApiDocumentUpdatePayload, baseVersionId: string, status: "draft" | "published", options?: {
+    skipMasterRefWait?: boolean;
+  }): Promise<CoreApiDocumentCreationResponse>;
+  /**
+   * Unpublishes (archives) a live document using the core api. Unless disabled, waits for a new
+   * content api master ref to be available.
+   *
+   * @param documentId - The id of the document to unpublish.
+   * @param options - Additional options.
+   * @param options.skipMasterRefWait - Skip waiting for a new content api master ref to be
+   *   available (default false). Set to true to return without waiting for the projection.
+   */
+  unpublishDocument(documentId: string, options?: {
+    skipMasterRefWait?: boolean;
+  }): Promise<void>;
+  /**
+   * Retrieves data for a specific document version.
+   *
+   * @param versionId - The document's version ID.
+   * @returns The document's version data.
+   */
+  getDocumentData(versionId: string): Promise<CoreApiDocumentData>;
+  setupIntegrationFields(integrationFields: IntegrationFieldConfig[]): Promise<void>;
+  private waitForNewMasterRef;
 }
-export type RepositoryConfig = {
-    customLocale?: CustomLocale;
-    locales?: string[];
-    defaultLocale?: string;
-    slices?: SharedSlice[];
-    customTypes?: CustomType[];
-    preview?: Preview;
-    simulatorURL?: string;
-    rolePerLocal?: boolean;
-    customRoles?: boolean;
-    integrationFields?: IntegrationFieldConfig[];
+type RepositoryConfig = {
+  customLocale?: CustomLocale;
+  locales?: string[];
+  defaultLocale?: string;
+  slices?: SharedSliceModel[];
+  customTypes?: DynamicCustomTypeModel[];
+  preview?: Preview;
+  simulatorURL?: string;
+  rolePerLocal?: boolean;
+  customRoles?: boolean;
+  integrationFields?: IntegrationFieldConfig[];
 };
-export type Preview = {
-    name: string;
-    websiteURL: string;
-    resolverPath: string;
+type Preview = {
+  name: string;
+  websiteURL: string;
+  resolverPath: string;
 };
-export type CustomLocale = {
-    lang: {
-        label: string;
-        id: string;
-        useStandardAnalyzer?: boolean;
-    };
-    region: {
-        label: string;
-        id: string;
-    };
+type CustomLocale = {
+  lang: {
+    label: string;
+    id: string;
+    useStandardAnalyzer?: boolean;
+  };
+  region: {
+    label: string;
+    id: string;
+  };
 };
+//#endregion
+export { CustomLocale, Preview, RepositoryConfig, RepositoryManager };
+//# sourceMappingURL=repository.d.ts.map