@prismicio/e2e-tests-utils 1.11.0 → 2.0.0-alpha.0

package/src/managers/repository.ts

@@ -6,7 +6,6 @@ import {
 	SharedSlice,
 } from "@prismicio/types-internal/lib/customtypes";
 
-import { AssetApiClient } from "../clients/assetApi";
 import { AuthenticationApiClient } from "../clients/authenticationApi";
 import { ContentApiClient } from "../clients/contentApi";
 import {
@@ -30,7 +29,6 @@ export class RepositoryManager {
 		private readonly wroomClient: WroomClient,
 		private readonly customTypesApiClient: CustomTypesApiClient,
 		private readonly migrationApiClient: MigrationApiClient | undefined,
-		private readonly assetApiClient: AssetApiClient,
 		private readonly manageV2Client: ManageV2Client,
 	) {}
 
@@ -87,10 +85,6 @@ export class RepositoryManager {
 		if (config.rolePerLocal) {
 			await this.toggleRolePerLocal(true);
 		}
-
-		if (config.customRoles) {
-			await this.toggleCustomRoles(true);
-		}
 	}
 
 	/** @returns the repository base url, like https://my-repo.prismic.io */
@@ -127,14 +121,6 @@ export class RepositoryManager {
 		return this.migrationApiClient;
 	}
 
-	/**
-	 * @returns an instance of the Asset api client, see
-	 *   https://prismic.io/docs/asset-api-technical-reference
-	 */
-	getAssetApiClient(): AssetApiClient {
-		return this.assetApiClient;
-	}
-
 	/** @returns the Wroom commit hash deployed on the current repository */
 	async getDeployedVersion(): Promise<string | undefined> {
 		const response = await this.wroomClient.get(
@@ -344,62 +330,6 @@ export class RepositoryManager {
 		profiler.done({ message: `preview '${id}' deleted` });
 	}
 
-	/**
-	 * Create a webhook.
-	 *
-	 * @returns A Promise that resolves with the webhook id.
-	 */
-	async createWebhook(
-		name: string,
-		url: string,
-		secret: string,
-		triggers: {
-			documentsPublished?: boolean;
-			documentsUnpublished?: boolean;
-			releasesCreated?: boolean;
-			releasesUpdated?: boolean;
-			tagsCreated?: boolean;
-			tagsDeleted?: boolean;
-		},
-		active: boolean,
-	): Promise<string> {
-		const profiler = 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: string): Promise<void> {
-		const profiler = 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.
 	 *
@@ -501,7 +431,7 @@ export class RepositoryManager {
 	}
 
 	/**
-	 * Toggle the Role per Locale workflow
+	 * Toggle the Role per local feature
 	 *
 	 * @param enabled - The feature new status
 	 */
@@ -524,30 +454,6 @@ export class RepositoryManager {
 		});
 	}
 
-	/**
-	 * Toggle the Custom Roles workflow
-	 *
-	 * @param enabled - The feature new status
-	 */
-	async toggleCustomRoles(enabled: boolean): Promise<void> {
-		const profiler = logger.startTimer();
-
-		const response = await this.manageV2Client.toggleCustomRoles({
-			repository: this.name,
-			enabled: enabled,
-		});
-
-		this.failIfNot200(
-			response,
-			`Could not ${enabled ? "enable" : "disable"} Custom Roles for ${
-				this.name
-			}`,
-		);
-		profiler.done({
-			message: `Custom Roles ${enabled ? "enabled" : "disabled"}`,
-		});
-	}
-
 	/**
 	 * Change the Repository Plan
 	 *
@@ -727,7 +633,6 @@ export type RepositoryConfig = {
 	customTypes?: CustomType[];
 	preview?: Preview;
 	rolePerLocal?: boolean;
-	customRoles?: boolean;
 };
 
 export type Preview = {

package/src/types.ts

@@ -7,8 +7,6 @@ export type UrlConfig = {
 	authenticationApi: string;
 	/** Prismic migration api base url */
 	migrationApi?: string;
-	/** Asset api base url */
-	assetApi: string;
 };
 
 export type AuthConfig = {
@@ -29,5 +27,4 @@ export type SetupConfiguration = {
 	authConfig: AuthConfig;
 	manageV2Config?: ManageV2Config;
 	cluster?: string;
-	environment?: string;
 };

package/dist/clients/assetApi.cjs

@@ -1,48 +0,0 @@
-"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();
-  }
-}
-exports.AssetApiClient = AssetApiClient;
-//# sourceMappingURL=assetApi.cjs.map

package/dist/clients/assetApi.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"assetApi.cjs","sources":["../../../src/clients/assetApi.ts"],"sourcesContent":["import { logPlaywrightApiResponse } from \"../utils/log\";\n\nimport { AuthServerToken, AuthenticatedApiClient } from \"./apiClient\";\n\nexport interface AssetApiCreatePayload {\n\tname: string;\n\tmimeType: string;\n\tbuffer: Buffer;\n}\n\nexport interface AssetApiCreateResponse {\n\tid: string;\n\turl: string;\n\tfilename: string;\n\tsize: number;\n\twidth: number;\n\theight: number;\n\tlast_modified: number;\n\tkind: string;\n\textension: string;\n\tcreated_at: number;\n\tuploader_id: string;\n\ttags: string[];\n}\n\nexport class AssetApiClient extends AuthenticatedApiClient {\n\t/**\n\t * @example To instantiate the class:\n\t *\n\t * ```js\n\t * new AssetApiClient(\"https://asset-api.prismic.io\", {\n\t * \tauthToken: \"my-secret-token\",\n\t * \trepository: \"my-repo-name\",\n\t * });\n\t * ```\n\t *\n\t * @param baseURL - The API base URL, such as https://asset-api.prismic.io\n\t * @param config - Optional configuration\n\t *\n\t *   - {@link config.authToken}: API token generated from the auth service or a\n\t *       function to fetch it when it's needed.\n\t *   - {@link config.repository}: Repository name.\n\t */\n\tconstructor(\n\t\tbaseURL: string,\n\t\tconfig: { authToken: AuthServerToken; repository: string },\n\t) {\n\t\tsuper(baseURL, config.authToken, { repository: config.repository });\n\t}\n\n\t/**\n\t * Uploads an asset file to the server.\n\t *\n\t * @param data - The payload containing the file and filename.\n\t *\n\t * @returns The API response containing asset information.\n\t *\n\t * @throws An error if the upload fails.\n\t */\n\tasync createAsset(\n\t\tdata: AssetApiCreatePayload,\n\t): Promise<AssetApiCreateResponse> {\n\t\tconst context = await this.getContext();\n\n\t\tconst result = await context.post(\"assets\", {\n\t\t\tmultipart: { file: data },\n\t\t});\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not upload the asset with the asset API.\");\n\t\t}\n\n\t\treturn result.json();\n\t}\n}\n"],"names":["AuthenticatedApiClient","logPlaywrightApiResponse"],"mappings":";;;;AAyBM,MAAO,uBAAuBA,UAAAA,uBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBzD,YACC,SACA,QAA0D;AAE1D,UAAM,SAAS,OAAO,WAAW,EAAE,YAAY,OAAO,YAAY;AAAA,EACnE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAM,YACL,MAA2B;AAErB,UAAA,UAAU,MAAM,KAAK;AAE3B,UAAM,SAAS,MAAM,QAAQ,KAAK,UAAU;AAAA,MAC3C,WAAW,EAAE,MAAM,KAAM;AAAA,IAAA,CACzB;AAEG,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMC,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,gDAAgD;AAAA,IACjE;AAEA,WAAO,OAAO;EACf;AACA;;"}

package/dist/clients/assetApi.d.ts

@@ -1,54 +0,0 @@
-/// <reference types="node" />
-import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
-export interface AssetApiCreatePayload {
-    name: string;
-    mimeType: string;
-    buffer: Buffer;
-}
-export interface AssetApiCreateResponse {
-    id: string;
-    url: string;
-    filename: string;
-    size: number;
-    width: number;
-    height: number;
-    last_modified: number;
-    kind: string;
-    extension: string;
-    created_at: number;
-    uploader_id: string;
-    tags: string[];
-}
-export declare class AssetApiClient extends 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: string, config: {
-        authToken: AuthServerToken;
-        repository: string;
-    });
-    /**
-     * 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.
-     */
-    createAsset(data: AssetApiCreatePayload): Promise<AssetApiCreateResponse>;
-}

package/dist/clients/assetApi.js

@@ -1,48 +0,0 @@
-import { logPlaywrightApiResponse } from "../utils/log.js";
-import { AuthenticatedApiClient } from "./apiClient.js";
-class AssetApiClient extends 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 logPlaywrightApiResponse(result);
-      throw new Error("Could not upload the asset with the asset API.");
-    }
-    return result.json();
-  }
-}
-export {
-  AssetApiClient
-};
-//# sourceMappingURL=assetApi.js.map

package/dist/clients/assetApi.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"assetApi.js","sources":["../../../src/clients/assetApi.ts"],"sourcesContent":["import { logPlaywrightApiResponse } from \"../utils/log\";\n\nimport { AuthServerToken, AuthenticatedApiClient } from \"./apiClient\";\n\nexport interface AssetApiCreatePayload {\n\tname: string;\n\tmimeType: string;\n\tbuffer: Buffer;\n}\n\nexport interface AssetApiCreateResponse {\n\tid: string;\n\turl: string;\n\tfilename: string;\n\tsize: number;\n\twidth: number;\n\theight: number;\n\tlast_modified: number;\n\tkind: string;\n\textension: string;\n\tcreated_at: number;\n\tuploader_id: string;\n\ttags: string[];\n}\n\nexport class AssetApiClient extends AuthenticatedApiClient {\n\t/**\n\t * @example To instantiate the class:\n\t *\n\t * ```js\n\t * new AssetApiClient(\"https://asset-api.prismic.io\", {\n\t * \tauthToken: \"my-secret-token\",\n\t * \trepository: \"my-repo-name\",\n\t * });\n\t * ```\n\t *\n\t * @param baseURL - The API base URL, such as https://asset-api.prismic.io\n\t * @param config - Optional configuration\n\t *\n\t *   - {@link config.authToken}: API token generated from the auth service or a\n\t *       function to fetch it when it's needed.\n\t *   - {@link config.repository}: Repository name.\n\t */\n\tconstructor(\n\t\tbaseURL: string,\n\t\tconfig: { authToken: AuthServerToken; repository: string },\n\t) {\n\t\tsuper(baseURL, config.authToken, { repository: config.repository });\n\t}\n\n\t/**\n\t * Uploads an asset file to the server.\n\t *\n\t * @param data - The payload containing the file and filename.\n\t *\n\t * @returns The API response containing asset information.\n\t *\n\t * @throws An error if the upload fails.\n\t */\n\tasync createAsset(\n\t\tdata: AssetApiCreatePayload,\n\t): Promise<AssetApiCreateResponse> {\n\t\tconst context = await this.getContext();\n\n\t\tconst result = await context.post(\"assets\", {\n\t\t\tmultipart: { file: data },\n\t\t});\n\n\t\tif (200 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not upload the asset with the asset API.\");\n\t\t}\n\n\t\treturn result.json();\n\t}\n}\n"],"names":[],"mappings":";;AAyBM,MAAO,uBAAuB,uBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBzD,YACC,SACA,QAA0D;AAE1D,UAAM,SAAS,OAAO,WAAW,EAAE,YAAY,OAAO,YAAY;AAAA,EACnE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAM,YACL,MAA2B;AAErB,UAAA,UAAU,MAAM,KAAK;AAE3B,UAAM,SAAS,MAAM,QAAQ,KAAK,UAAU;AAAA,MAC3C,WAAW,EAAE,MAAM,KAAM;AAAA,IAAA,CACzB;AAEG,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAM,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,gDAAgD;AAAA,IACjE;AAEA,WAAO,OAAO;EACf;AACA;"}

package/src/clients/assetApi.ts

@@ -1,76 +0,0 @@
-import { logPlaywrightApiResponse } from "../utils/log";
-
-import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
-
-export interface AssetApiCreatePayload {
-	name: string;
-	mimeType: string;
-	buffer: Buffer;
-}
-
-export interface AssetApiCreateResponse {
-	id: string;
-	url: string;
-	filename: string;
-	size: number;
-	width: number;
-	height: number;
-	last_modified: number;
-	kind: string;
-	extension: string;
-	created_at: number;
-	uploader_id: string;
-	tags: string[];
-}
-
-export class AssetApiClient extends 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: string,
-		config: { authToken: AuthServerToken; repository: string },
-	) {
-		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: AssetApiCreatePayload,
-	): Promise<AssetApiCreateResponse> {
-		const context = await this.getContext();
-
-		const result = await context.post("assets", {
-			multipart: { file: data },
-		});
-
-		if (200 !== result.status()) {
-			await logPlaywrightApiResponse(result);
-			throw new Error("Could not upload the asset with the asset API.");
-		}
-
-		return result.json();
-	}
-}