@prismicio/e2e-tests-utils 1.2.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/clients/authenticationApi.cjs +21 -2
- package/dist/clients/authenticationApi.cjs.map +1 -1
- package/dist/clients/authenticationApi.d.ts +3 -2
- package/dist/clients/authenticationApi.js +22 -3
- package/dist/clients/authenticationApi.js.map +1 -1
- package/dist/clients/contentApi.cjs +141 -0
- package/dist/clients/contentApi.cjs.map +1 -0
- package/dist/clients/contentApi.d.ts +106 -0
- package/dist/clients/contentApi.js +141 -0
- package/dist/clients/contentApi.js.map +1 -0
- package/dist/clients/coreApi.cjs +12 -2
- package/dist/clients/coreApi.cjs.map +1 -1
- package/dist/clients/coreApi.d.ts +1 -0
- package/dist/clients/coreApi.js +12 -2
- package/dist/clients/coreApi.js.map +1 -1
- package/dist/clients/customTypesApi.cjs +1 -0
- package/dist/clients/customTypesApi.cjs.map +1 -1
- package/dist/clients/customTypesApi.js +1 -0
- package/dist/clients/customTypesApi.js.map +1 -1
- package/dist/clients/manageV2.cjs +145 -0
- package/dist/clients/manageV2.cjs.map +1 -0
- package/dist/clients/manageV2.d.ts +91 -0
- package/dist/clients/manageV2.js +145 -0
- package/dist/clients/manageV2.js.map +1 -0
- package/dist/clients/migrationApi.cjs +36 -0
- package/dist/clients/migrationApi.cjs.map +1 -0
- package/dist/clients/migrationApi.d.ts +20 -0
- package/dist/clients/migrationApi.js +36 -0
- package/dist/clients/migrationApi.js.map +1 -0
- package/dist/clients/wroom.cjs +28 -0
- package/dist/clients/wroom.cjs.map +1 -1
- package/dist/clients/wroom.d.ts +22 -2
- package/dist/clients/wroom.js +28 -0
- package/dist/clients/wroom.js.map +1 -1
- package/dist/index.cjs +4 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -1
- package/dist/managers/repositories.cjs +25 -18
- package/dist/managers/repositories.cjs.map +1 -1
- package/dist/managers/repositories.d.ts +12 -22
- package/dist/managers/repositories.js +25 -18
- package/dist/managers/repositories.js.map +1 -1
- package/dist/managers/repository.cjs +184 -41
- package/dist/managers/repository.cjs.map +1 -1
- package/dist/managers/repository.d.ts +77 -22
- package/dist/managers/repository.js +184 -41
- package/dist/managers/repository.js.map +1 -1
- package/dist/types.d.ts +20 -1
- package/dist/utils/cookies.cjs.map +1 -1
- package/dist/utils/cookies.js.map +1 -1
- package/dist/utils/log.cjs.map +1 -1
- package/dist/utils/log.js.map +1 -1
- package/package.json +9 -2
- package/src/clients/authenticationApi.ts +33 -4
- package/src/clients/contentApi.ts +235 -0
- package/src/clients/coreApi.ts +14 -1
- package/src/clients/manageV2.ts +178 -0
- package/src/clients/migrationApi.ts +69 -0
- package/src/clients/wroom.ts +42 -2
- package/src/index.ts +2 -0
- package/src/managers/repositories.ts +46 -37
- package/src/managers/repository.ts +263 -70
- package/src/types.ts +29 -1
|
@@ -6,18 +6,26 @@ var __publicField = (obj, key, value) => {
|
|
|
6
6
|
return value;
|
|
7
7
|
};
|
|
8
8
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
9
|
+
const test = require("@playwright/test");
|
|
10
|
+
const contentApi = require("../clients/contentApi.cjs");
|
|
9
11
|
const log = require("../utils/log.cjs");
|
|
10
12
|
const urls = require("../utils/urls.cjs");
|
|
11
13
|
class RepositoryManager {
|
|
12
|
-
constructor(name, coreApiClient, wroomClient, customTypesApiClient) {
|
|
14
|
+
constructor(name, coreApiClient, authApiClient, wroomClient, customTypesApiClient, migrationApiClient, manageV2Client) {
|
|
13
15
|
__publicField(this, "name");
|
|
14
16
|
__publicField(this, "coreApiClient");
|
|
17
|
+
__publicField(this, "authApiClient");
|
|
15
18
|
__publicField(this, "wroomClient");
|
|
16
19
|
__publicField(this, "customTypesApiClient");
|
|
20
|
+
__publicField(this, "migrationApiClient");
|
|
21
|
+
__publicField(this, "manageV2Client");
|
|
17
22
|
this.name = name;
|
|
18
23
|
this.coreApiClient = coreApiClient;
|
|
24
|
+
this.authApiClient = authApiClient;
|
|
19
25
|
this.wroomClient = wroomClient;
|
|
20
26
|
this.customTypesApiClient = customTypesApiClient;
|
|
27
|
+
this.migrationApiClient = migrationApiClient;
|
|
28
|
+
this.manageV2Client = manageV2Client;
|
|
21
29
|
}
|
|
22
30
|
async configure(config) {
|
|
23
31
|
const hasLangConfig = config.defaultLocale || config.locales || config.customLocale;
|
|
@@ -55,11 +63,26 @@ class RepositoryManager {
|
|
|
55
63
|
if (config.preview) {
|
|
56
64
|
await this.createPreview(config.preview);
|
|
57
65
|
}
|
|
66
|
+
if (config.rolePerLocal) {
|
|
67
|
+
await this.toggleRolePerLocal(true);
|
|
68
|
+
}
|
|
58
69
|
}
|
|
59
70
|
/** @returns the repository base url, like https://my-repo.prismic.io */
|
|
60
71
|
getBaseURL() {
|
|
61
72
|
return urls.getRepositoryUrl(this.wroomClient.getBaseURL(), this.name);
|
|
62
73
|
}
|
|
74
|
+
/** @returns the repository base cdn url, like https://my-repo.cdn.prismic.io */
|
|
75
|
+
getBaseCdnURL() {
|
|
76
|
+
return urls.getRepositoryUrl(this.wroomClient.getBaseURL(), `${this.name}.cdn`);
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* @returns a Content Type api client configured to target the repository CDN
|
|
80
|
+
* url. Uses Playwright for requests so if your project uses Playwright too,
|
|
81
|
+
* any network request will be present in Playwright test reports.
|
|
82
|
+
*/
|
|
83
|
+
getContentApiClient(config) {
|
|
84
|
+
return new contentApi.ContentApiClient(this.getBaseCdnURL(), config);
|
|
85
|
+
}
|
|
63
86
|
/**
|
|
64
87
|
* Set additional standard locales for a repository in Wroom, does not fail if
|
|
65
88
|
* the locales already exist.
|
|
@@ -190,35 +213,6 @@ class RepositoryManager {
|
|
|
190
213
|
this.failIfNot200(response, `Could not delete preview with id ${id}`);
|
|
191
214
|
profiler.done({ message: `preview '${id}' deleted` });
|
|
192
215
|
}
|
|
193
|
-
/**
|
|
194
|
-
* Create a webhook.
|
|
195
|
-
*
|
|
196
|
-
* @returns A Promise that resolves with the webhook id.
|
|
197
|
-
*/
|
|
198
|
-
async createWebhook(name, url, secret, triggers, active) {
|
|
199
|
-
const profiler = log.logger.startTimer();
|
|
200
|
-
const response = await this.wroomClient.post(this.name, "app/settings/webhooks/create", {
|
|
201
|
-
name,
|
|
202
|
-
url,
|
|
203
|
-
secret,
|
|
204
|
-
active: active ? "on" : "off",
|
|
205
|
-
...triggers
|
|
206
|
-
});
|
|
207
|
-
this.failIfNot200(response, `Could not create webhook ${name}`);
|
|
208
|
-
profiler.done({ message: `webhook '${name}' created` });
|
|
209
|
-
return response.data.created;
|
|
210
|
-
}
|
|
211
|
-
/**
|
|
212
|
-
* Deletes a webhook.
|
|
213
|
-
*
|
|
214
|
-
* @param id - The webhook ID.
|
|
215
|
-
*/
|
|
216
|
-
async deleteWebhook(id) {
|
|
217
|
-
const profiler = log.logger.startTimer();
|
|
218
|
-
const response = await this.wroomClient.post(this.name, `app/settings/webhooks/${id}/delete`, {});
|
|
219
|
-
this.failIfNot200(response, `Could not delete webhook with id ${id}`);
|
|
220
|
-
profiler.done({ message: `webhook '${id}' deleted` });
|
|
221
|
-
}
|
|
222
216
|
/**
|
|
223
217
|
* Create Custom Types using the Custom types api.
|
|
224
218
|
*
|
|
@@ -236,28 +230,177 @@ class RepositoryManager {
|
|
|
236
230
|
await this.customTypesApiClient.createSlices(slices);
|
|
237
231
|
}
|
|
238
232
|
/**
|
|
239
|
-
* Create
|
|
233
|
+
* Create an access token to query private items of the Content api.
|
|
240
234
|
*
|
|
241
235
|
* @param appName - mandatory authorized application name
|
|
236
|
+
* @param tokenScope - access token scope. Use "master" to when your content
|
|
237
|
+
* api is fully private or "master+releases" to access private releases
|
|
242
238
|
*/
|
|
243
|
-
async
|
|
239
|
+
async createContentAPIToken(appName, tokenScope = "master") {
|
|
244
240
|
const profiler = log.logger.startTimer();
|
|
245
241
|
const existingApps = await this.wroomClient.get(this.name, "settings/security/contentapi");
|
|
246
|
-
this.failIfNot200(existingApps, `Could not get status of existing applications to generate a
|
|
247
|
-
|
|
242
|
+
this.failIfNot200(existingApps, `Could not get status of existing applications to generate a content api token`);
|
|
243
|
+
let app = existingApps.data.find(({ name, wroom_auths }) => {
|
|
248
244
|
return name === appName && wroom_auths.length > 0;
|
|
249
245
|
});
|
|
250
|
-
if (
|
|
251
|
-
|
|
246
|
+
if (!app) {
|
|
247
|
+
const response = await this.wroomClient.post(this.name, "settings/security/oauthapp", {
|
|
248
|
+
app_name: appName
|
|
249
|
+
});
|
|
250
|
+
this.failIfNot200(response, `Could not create content api app ${appName}`);
|
|
251
|
+
app = response.data;
|
|
252
|
+
}
|
|
253
|
+
let tokenInfo = app.wroom_auths.find(({ scope }) => scope === tokenScope);
|
|
254
|
+
if (!tokenInfo) {
|
|
255
|
+
const response = await this.wroomClient.post(this.name, "settings/security/authorizations", {
|
|
256
|
+
app: app.id,
|
|
257
|
+
scope: tokenScope
|
|
258
|
+
});
|
|
259
|
+
this.failIfNot200(response, `Could not create content api access token for app ${appName} with scope ${tokenScope}`);
|
|
260
|
+
tokenInfo = response.data;
|
|
261
|
+
}
|
|
262
|
+
profiler.done({
|
|
263
|
+
message: `content api access token for app '${appName}' created`
|
|
264
|
+
});
|
|
265
|
+
if (!(tokenInfo == null ? void 0 : tokenInfo.token)) {
|
|
266
|
+
throw `Could not create content api access token for app ${appName} with scope ${tokenScope}`;
|
|
267
|
+
}
|
|
268
|
+
return tokenInfo.token;
|
|
269
|
+
}
|
|
270
|
+
/** Create a permanent access token to authenticate to Prismic public apis. */
|
|
271
|
+
async createPermanentAccessToken() {
|
|
272
|
+
const profiler = log.logger.startTimer();
|
|
273
|
+
const token = await this.authApiClient.getMachine2MachineToken(this.name);
|
|
274
|
+
profiler.done({
|
|
275
|
+
message: `machine2machine token created`
|
|
276
|
+
});
|
|
277
|
+
return token;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* Toggle the Role per local feature
|
|
281
|
+
*
|
|
282
|
+
* @param enabled - The feature new status
|
|
283
|
+
*/
|
|
284
|
+
async toggleRolePerLocal(enabled) {
|
|
285
|
+
const profiler = log.logger.startTimer();
|
|
286
|
+
const response = await this.manageV2Client.toggleRolePerLocal({
|
|
287
|
+
repository: this.name,
|
|
288
|
+
enabled
|
|
289
|
+
});
|
|
290
|
+
this.failIfNot200(response, `Could not ${enabled ? "enable" : "disable"} Role per local for ${this.name}`);
|
|
291
|
+
profiler.done({
|
|
292
|
+
message: `Role per local ${enabled ? "enabled" : "disabled"}`
|
|
293
|
+
});
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* Change the Repository Plan
|
|
297
|
+
*
|
|
298
|
+
* @param {string} newPlanId - The Id of the new Plan to apply
|
|
299
|
+
*/
|
|
300
|
+
async changePlan(newPlanId) {
|
|
301
|
+
const profiler = log.logger.startTimer();
|
|
302
|
+
const response = await this.manageV2Client.changePlan({
|
|
303
|
+
repository: this.name,
|
|
304
|
+
newPlanId,
|
|
305
|
+
bypassManualBilling: true
|
|
306
|
+
// For now the library does not support Stripe features
|
|
307
|
+
});
|
|
308
|
+
this.failIfNot200(response, "Could not change the Repository Plan");
|
|
309
|
+
profiler.done({
|
|
310
|
+
message: `Repository Plan changed to ${newPlanId}`
|
|
311
|
+
});
|
|
312
|
+
}
|
|
313
|
+
/**
|
|
314
|
+
* Add a new user to the repository
|
|
315
|
+
*
|
|
316
|
+
* @param {string} email - The email of the user
|
|
317
|
+
*/
|
|
318
|
+
async addUser(email) {
|
|
319
|
+
const profiler = log.logger.startTimer();
|
|
320
|
+
const response = await this.manageV2Client.addUserToRepository({
|
|
321
|
+
repository: this.name,
|
|
322
|
+
email
|
|
323
|
+
});
|
|
324
|
+
const { data, status } = response;
|
|
325
|
+
const success = status === 200 || status === 409 && JSON.stringify(data).includes("already a member of the repo");
|
|
326
|
+
if (!success) {
|
|
327
|
+
log.logHttpResponse(response);
|
|
328
|
+
throw new Error(`Could not add a new user ${email} to the repository`);
|
|
252
329
|
}
|
|
253
|
-
|
|
254
|
-
|
|
330
|
+
profiler.done({
|
|
331
|
+
message: `User ${email} was added to the repository`
|
|
332
|
+
});
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
* Remove a user from the repository
|
|
336
|
+
*
|
|
337
|
+
* @param {string} email - The email of the user
|
|
338
|
+
*/
|
|
339
|
+
async removeUser(email) {
|
|
340
|
+
const profiler = log.logger.startTimer();
|
|
341
|
+
const response = await this.manageV2Client.removeUserFromRepository({
|
|
342
|
+
repository: this.name,
|
|
343
|
+
email
|
|
255
344
|
});
|
|
256
|
-
this.failIfNot200(response, `Could not
|
|
345
|
+
this.failIfNot200(response, `Could not remove the user ${email} from the repository`);
|
|
346
|
+
profiler.done({
|
|
347
|
+
message: `User ${email} was removed from the repository`
|
|
348
|
+
});
|
|
349
|
+
}
|
|
350
|
+
/**
|
|
351
|
+
* Update the role of a user in a repository
|
|
352
|
+
*
|
|
353
|
+
* @param {string} email - The email of the user
|
|
354
|
+
* @param {string | Record<string, string>} role - The new Role of the user,
|
|
355
|
+
* either a string for basic workflow or an object such as `{ "lang_id":
|
|
356
|
+
* "Writer" }`
|
|
357
|
+
*
|
|
358
|
+
* Example of roles are
|
|
359
|
+
*
|
|
360
|
+
* - Administrator
|
|
361
|
+
* - Writer
|
|
362
|
+
* - Contributor
|
|
363
|
+
* - Manager (publisher)
|
|
364
|
+
*/
|
|
365
|
+
async updateUserRole(email, role) {
|
|
366
|
+
const profiler = log.logger.startTimer();
|
|
367
|
+
const response = typeof role === "string" ? await this.wroomClient.updateRole(this.name, email, role) : await this.wroomClient.updateRolePerLocal(this.name, email, role);
|
|
368
|
+
this.failIfNot200(response, `Could not update the ${typeof role === "string" ? "role" : "rolePerLocal"} of the user ${email}`);
|
|
369
|
+
profiler.done({
|
|
370
|
+
message: `Updated User's ${typeof role === "string" ? "role" : "rolePerLocal"} for user ${email}`
|
|
371
|
+
});
|
|
372
|
+
}
|
|
373
|
+
/**
|
|
374
|
+
* Creates a document using the migration api, see
|
|
375
|
+
* https://prismic.io/docs/migration-api-technical-reference
|
|
376
|
+
*
|
|
377
|
+
* @param {DocumentPayload} document - in the migration api format
|
|
378
|
+
* @param {string} status - status of the document, if published, the function
|
|
379
|
+
* will wait for a new content api master ref to be created
|
|
380
|
+
*
|
|
381
|
+
* @returns
|
|
382
|
+
*/
|
|
383
|
+
async createDocument(document, status) {
|
|
384
|
+
if (!this.migrationApiClient) {
|
|
385
|
+
throw "No client found for the migration api. Did you provide a migration api url in your configuration?";
|
|
386
|
+
}
|
|
387
|
+
const profiler = log.logger.startTimer();
|
|
388
|
+
const result = await this.migrationApiClient.createDocument(document);
|
|
389
|
+
let message = `Document created with id '${result.id}'`;
|
|
390
|
+
if (status === "published") {
|
|
391
|
+
const contentApi2 = this.getContentApiClient();
|
|
392
|
+
const masterRef = await contentApi2.getMasterRef();
|
|
393
|
+
await this.coreApiClient.publishDraft(result.id);
|
|
394
|
+
await test.expect.poll(async () => contentApi2.getMasterRef(), {
|
|
395
|
+
timeout: 1e4,
|
|
396
|
+
message: "Waiting for new master ref to be available"
|
|
397
|
+
}).not.toBe(masterRef);
|
|
398
|
+
message += ", status 'published' and new master ref available";
|
|
399
|
+
}
|
|
257
400
|
profiler.done({
|
|
258
|
-
message
|
|
401
|
+
message
|
|
259
402
|
});
|
|
260
|
-
return
|
|
403
|
+
return result;
|
|
261
404
|
}
|
|
262
405
|
}
|
|
263
406
|
exports.RepositoryManager = RepositoryManager;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"repository.cjs","sources":["../../../src/managers/repository.ts"],"sourcesContent":["import { AxiosResponse } from \"axios\";\n\nimport {\n\tCustomType,\n\tSharedSlice,\n} from \"@prismicio/types-internal/lib/customtypes\";\n\nimport type { CoreClient } from \"../clients/coreApi\";\nimport { CustomTypesClient } from \"../clients/customTypesApi\";\nimport { WroomClient } from \"../clients/wroom\";\nimport { logHttpResponse, logger } from \"../utils/log\";\nimport { getRepositoryUrl } from \"../utils/urls\";\n\n/** Utility to manage test data for a Prismic repository */\nexport class RepositoryManager {\n\tconstructor(\n\t\treadonly name: string,\n\t\tprivate readonly coreApiClient: CoreClient,\n\t\tprivate readonly wroomClient: WroomClient,\n\t\tprivate readonly customTypesApiClient: CustomTypesClient,\n\t) {}\n\n\tasync configure(config: RepositoryConfig): Promise<void> {\n\t\tconst hasLangConfig =\n\t\t\tconfig.defaultLocale || config.locales || config.customLocale;\n\t\tif (hasLangConfig) {\n\t\t\tconst languages = await this.coreApiClient.getLanguages();\n\n\t\t\t// default locale must be set first\n\t\t\tif (config.defaultLocale) {\n\t\t\t\tconst master = languages.find(({ is_master }) => is_master === true);\n\t\t\t\tif (!master) {\n\t\t\t\t\tawait this.setDefaultLocale(config.defaultLocale);\n\t\t\t\t} else if (master.id !== config.defaultLocale) {\n\t\t\t\t\tlogger.warn(\n\t\t\t\t\t\t`Master locale is already set to '${master.id}', cannot update it to '${config.defaultLocale}'`,\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (config.locales) {\n\t\t\t\tconst localesToAdd = config.locales.filter(\n\t\t\t\t\t(id) => !languages.some((language) => language.id === id),\n\t\t\t\t);\n\t\t\t\tif (localesToAdd.length > 0) {\n\t\t\t\t\tawait this.createLocales(localesToAdd);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (config.customLocale) {\n\t\t\t\tif (!languages.find(({ id }) => id === config.customLocale?.lang.id)) {\n\t\t\t\t\tawait this.createCustomLocale(config.customLocale);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif (config.slices) {\n\t\t\tawait this.createSlices(config.slices);\n\t\t}\n\n\t\tif (config.customTypes) {\n\t\t\tawait this.createCustomTypes(config.customTypes);\n\t\t}\n\n\t\tif (config.preview) {\n\t\t\tawait this.createPreview(config.preview);\n\t\t}\n\t}\n\t/** @returns the repository base url, like https://my-repo.prismic.io */\n\tgetBaseURL(): string {\n\t\treturn getRepositoryUrl(this.wroomClient.getBaseURL(), this.name);\n\t}\n\n\t/**\n\t * Set additional standard locales for a repository in Wroom, does not fail if\n\t * the locales already exist.\n\t *\n\t * @param locales - An array of all locales to be added to the repository.\n\t *\n\t * @throws Error if setting the locales fails.\n\t */\n\tasync createLocales(locales: string[]): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t\"app/settings/multilanguages\",\n\t\t\t{ languages: locales },\n\t\t);\n\n\t\tconst { data, status } = response;\n\t\tconst success =\n\t\t\tstatus === 200 ||\n\t\t\t(status === 400 &&\n\t\t\t\t(data as string).includes(\"already existing languages\"));\n\t\tif (!success) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(`Could not add locales ${locales.join(\", \")}`);\n\t\t}\n\t\tprofiler.done({ message: `locales '${locales}' created` });\n\t}\n\n\t/**\n\t * Set additional custom locale for a repository in Wroom, does not fail if\n\t * the locales already exist.\n\t *\n\t * @param locale - The locale to be added to the repository.\n\t *\n\t * @throws Error if setting the locale fails.\n\t */\n\tasync createCustomLocale(locale: CustomLocale): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t\"app/settings/multilanguages/custom\",\n\t\t\tlocale,\n\t\t);\n\n\t\tconst { data, status } = response;\n\t\tconst success =\n\t\t\tstatus === 200 ||\n\t\t\t(status === 400 && JSON.stringify(data).includes(\"code is already used\"));\n\t\tif (!success) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(`Could not create custom locale ${locale}`);\n\t\t}\n\t\tprofiler.done({\n\t\t\tmessage: `custom locale ${JSON.stringify(locale)} created`,\n\t\t});\n\t}\n\n\tprivate failIfNot200(response: AxiosResponse, msg: string) {\n\t\tif (response.status !== 200) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(msg);\n\t\t}\n\t}\n\n\t/**\n\t * Delete a locale from a repository.\n\t *\n\t * @param locale - locale to remove from the repository configuration.\n\t *\n\t * @throws Error if deleting the locale fails.\n\t */\n\tasync deleteLocale(locale: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`app/settings/multilanguages/${locale}/delete`,\n\t\t);\n\t\tthis.failIfNot200(response, `Could not delete locale ${locale}`);\n\t\tprofiler.done({ message: `locale '${locale}' deleted` });\n\t}\n\n\t/**\n\t * Set the default (master) locale for a repository in Wroom, the locale needs\n\t * to exist for the repository.\n\t *\n\t * @param locale - The locale to be set as the default.\n\t *\n\t * @throws Error if setting the default locale fails.\n\t */\n\tasync setDefaultLocale(locale: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`/app/settings/multilanguages/${locale}/createMasterLang`,\n\t\t);\n\n\t\tconst { data, status } = response;\n\t\tconst success =\n\t\t\tstatus === 200 ||\n\t\t\t(status === 400 &&\n\t\t\t\t// returns 400 if master lang is already set\n\t\t\t\tJSON.stringify(data).includes(\"Unable to set as master language\"));\n\t\tif (!success) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(`Could not set default locale to ${locale}`);\n\t\t}\n\t\tprofiler.done({ message: `default locale set to '${locale}'` });\n\t}\n\n\t/**\n\t * Creates a release.\n\t *\n\t * @param label - The label for the release.\n\t *\n\t * @returns A Promise that resolves when the release is created.\n\t */\n\tasync createRelease(label: string): Promise<{ id: string }> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(this.name, \"app/releases\", {\n\t\t\tlabel,\n\t\t});\n\t\tthis.failIfNot200(response, `Could not create release ${label}`);\n\t\tprofiler.done({ message: `release '${label}' created` });\n\n\t\treturn response.data;\n\t}\n\n\t/**\n\t * Deletes a repository release.\n\t *\n\t * @param repository - The name of the repository.\n\t * @param id - The ID of the release to be deleted.\n\t */\n\tasync deleteRelease(id: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`app/releases/${id}/delete`,\n\t\t\t{},\n\t\t);\n\n\t\tthis.failIfNot200(response, `Could not delete release with id ${id}`);\n\t\tprofiler.done({ message: `release '${id}' deleted` });\n\t}\n\n\t/**\n\t * Creates a preview for a repository.\n\t *\n\t * @param data - The data for creating the preview.\n\t */\n\tasync createPreview(data: Preview): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`previews/new`,\n\t\t\tdata,\n\t\t);\n\n\t\tthis.failIfNot200(response, `Could not create preview ${data.name}`);\n\t\tprofiler.done({ message: `preview '${data.name}' created` });\n\n\t\treturn response.data;\n\t}\n\n\t/**\n\t * Deletes a preview from a repository.\n\t *\n\t * @param id - The ID of the preview to be deleted.\n\t */\n\tasync deletePreview(id: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`previews/delete/${id}`,\n\t\t\t{},\n\t\t);\n\n\t\tthis.failIfNot200(response, `Could not delete preview with id ${id}`);\n\t\tprofiler.done({ message: `preview '${id}' deleted` });\n\t}\n\n\t/**\n\t * Create a webhook.\n\t *\n\t * @returns A Promise that resolves with the webhook id.\n\t */\n\tasync createWebhook(\n\t\tname: string,\n\t\turl: string,\n\t\tsecret: string,\n\t\ttriggers: {\n\t\t\tdocumentsPublished?: boolean;\n\t\t\tdocumentsUnpublished?: boolean;\n\t\t\treleasesCreated?: boolean;\n\t\t\treleasesUpdated?: boolean;\n\t\t\ttagsCreated?: boolean;\n\t\t\ttagsDeleted?: boolean;\n\t\t},\n\t\tactive: boolean,\n\t): Promise<string> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t\"app/settings/webhooks/create\",\n\t\t\t{\n\t\t\t\tname,\n\t\t\t\turl,\n\t\t\t\tsecret,\n\t\t\t\tactive: active ? \"on\" : \"off\",\n\t\t\t\t...triggers,\n\t\t\t},\n\t\t);\n\t\tthis.failIfNot200(response, `Could not create webhook ${name}`);\n\t\tprofiler.done({ message: `webhook '${name}' created` });\n\n\t\treturn response.data.created;\n\t}\n\n\t/**\n\t * Deletes a webhook.\n\t *\n\t * @param id - The webhook ID.\n\t */\n\tasync deleteWebhook(id: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`app/settings/webhooks/${id}/delete`,\n\t\t\t{},\n\t\t);\n\n\t\tthis.failIfNot200(response, `Could not delete webhook with id ${id}`);\n\t\tprofiler.done({ message: `webhook '${id}' deleted` });\n\t}\n\n\t/**\n\t * Create Custom Types using the Custom types api.\n\t *\n\t * @param customTypes -\n\t */\n\tasync createCustomTypes(customTypes: CustomType[]): Promise<void> {\n\t\tawait this.customTypesApiClient.createCustomTypes(customTypes);\n\t}\n\n\t/**\n\t * Create slices using the Custom types api.\n\t *\n\t * @param slices -\n\t */\n\tasync createSlices(slices: SharedSlice[]): Promise<void> {\n\t\tawait this.customTypesApiClient.createSlices(slices);\n\t}\n\n\t/**\n\t * Create a permanent access token along with an application name\n\t *\n\t * @param appName - mandatory authorized application name\n\t */\n\tasync createPermanentAccessToken(appName: string): Promise<string> {\n\t\tconst profiler = logger.startTimer();\n\t\ttype AuthorizedAppResponse = {\n\t\t\tname: string;\n\t\t\twroom_auths: { token: string }[];\n\t\t};\n\t\tconst existingApps: AxiosResponse<AuthorizedAppResponse[]> =\n\t\t\tawait this.wroomClient.get(this.name, \"settings/security/contentapi\");\n\n\t\tthis.failIfNot200(\n\t\t\texistingApps,\n\t\t\t`Could not get status of existing applications to generate a permanent token`,\n\t\t);\n\t\tconst existingApp = existingApps.data.find(({ name, wroom_auths }) => {\n\t\t\treturn name === appName && wroom_auths.length > 0;\n\t\t});\n\t\tif (existingApp) {\n\t\t\treturn existingApp.wroom_auths[0].token;\n\t\t}\n\t\tconst response: AxiosResponse<AuthorizedAppResponse> =\n\t\t\tawait this.wroomClient.post(this.name, \"settings/security/oauthapp\", {\n\t\t\t\tapp_name: appName,\n\t\t\t});\n\n\t\tthis.failIfNot200(\n\t\t\tresponse,\n\t\t\t`Could not create permanent access token for app name ${appName}`,\n\t\t);\n\t\tprofiler.done({\n\t\t\tmessage: `permanent access token for app name '${appName}' created`,\n\t\t});\n\n\t\t// only return the generated token since there is no need to access more\n\t\treturn response.data.wroom_auths[0].token;\n\t}\n}\n\nexport type RepositoryConfig = {\n\tcustomLocale?: CustomLocale;\n\tlocales?: string[];\n\tdefaultLocale?: string;\n\tslices?: SharedSlice[];\n\tcustomTypes?: CustomType[];\n\tpreview?: Preview;\n};\n\nexport type Preview = {\n\tname: string;\n\twebsiteURL: string;\n\tresolverPath: string;\n};\n\nexport type CustomLocale = {\n\tlang: {\n\t\tlabel: string;\n\t\tid: string;\n\t\tuseStandardAnalyzer?: boolean;\n\t};\n\tregion: {\n\t\tlabel: string;\n\t\tid: string;\n\t};\n};\n"],"names":["logger","getRepositoryUrl","logHttpResponse"],"mappings":";;;;;;;;;;MAca,kBAAiB;AAAA,EAC7B,YACU,MACQ,eACA,aACA,sBAAuC;AAH/C;AACQ;AACA;AACA;AAHR,SAAI,OAAJ;AACQ,SAAa,gBAAb;AACA,SAAW,cAAX;AACA,SAAoB,uBAApB;AAAA,EACf;AAAA,EAEH,MAAM,UAAU,QAAwB;AACvC,UAAM,gBACL,OAAO,iBAAiB,OAAO,WAAW,OAAO;AAClD,QAAI,eAAe;AAClB,YAAM,YAAY,MAAM,KAAK,cAAc,aAAY;AAGvD,UAAI,OAAO,eAAe;AACnB,cAAA,SAAS,UAAU,KAAK,CAAC,EAAE,gBAAgB,cAAc,IAAI;AACnE,YAAI,CAAC,QAAQ;AACN,gBAAA,KAAK,iBAAiB,OAAO,aAAa;AAAA,QACtC,WAAA,OAAO,OAAO,OAAO,eAAe;AAC9CA,cAAAA,OAAO,KACN,oCAAoC,OAAO,EAAE,2BAA2B,OAAO,aAAa,GAAG;AAAA,QAEhG;AAAA,MACD;AAED,UAAI,OAAO,SAAS;AACnB,cAAM,eAAe,OAAO,QAAQ,OACnC,CAAC,OAAO,CAAC,UAAU,KAAK,CAAC,aAAa,SAAS,OAAO,EAAE,CAAC;AAEtD,YAAA,aAAa,SAAS,GAAG;AACtB,gBAAA,KAAK,cAAc,YAAY;AAAA,QACrC;AAAA,MACD;AAED,UAAI,OAAO,cAAc;AACxB,YAAI,CAAC,UAAU,KAAK,CAAC,EAAE,GAAA;;AAAS,0BAAO,YAAO,iBAAP,mBAAqB,KAAK;AAAA,SAAE,GAAG;AAC/D,gBAAA,KAAK,mBAAmB,OAAO,YAAY;AAAA,QACjD;AAAA,MACD;AAAA,IACD;AAED,QAAI,OAAO,QAAQ;AACZ,YAAA,KAAK,aAAa,OAAO,MAAM;AAAA,IACrC;AAED,QAAI,OAAO,aAAa;AACjB,YAAA,KAAK,kBAAkB,OAAO,WAAW;AAAA,IAC/C;AAED,QAAI,OAAO,SAAS;AACb,YAAA,KAAK,cAAc,OAAO,OAAO;AAAA,IACvC;AAAA,EACF;AAAA;AAAA,EAEA,aAAU;AACT,WAAOC,KAAAA,iBAAiB,KAAK,YAAY,WAAU,GAAI,KAAK,IAAI;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,cAAc,SAAiB;AAC9B,UAAA,WAAWD,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,+BACA,EAAE,WAAW,QAAS,CAAA;AAGjB,UAAA,EAAE,MAAM,OAAW,IAAA;AACzB,UAAM,UACL,WAAW,OACV,WAAW,OACV,KAAgB,SAAS,4BAA4B;AACxD,QAAI,CAAC,SAAS;AACbE,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,yBAAyB,QAAQ,KAAK,IAAI,CAAC,EAAE;AAAA,IAC7D;AACD,aAAS,KAAK,EAAE,SAAS,YAAY,OAAO,aAAa;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,mBAAmB,QAAoB;AACtC,UAAA,WAAWF,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,sCACA,MAAM;AAGD,UAAA,EAAE,MAAM,OAAW,IAAA;AACnB,UAAA,UACL,WAAW,OACV,WAAW,OAAO,KAAK,UAAU,IAAI,EAAE,SAAS,sBAAsB;AACxE,QAAI,CAAC,SAAS;AACbE,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,kCAAkC,MAAM,EAAE;AAAA,IAC1D;AACD,aAAS,KAAK;AAAA,MACb,SAAS,iBAAiB,KAAK,UAAU,MAAM,CAAC;AAAA,IAAA,CAChD;AAAA,EACF;AAAA,EAEQ,aAAa,UAAyB,KAAW;AACpD,QAAA,SAAS,WAAW,KAAK;AAC5BA,UAAA,gBAAgB,QAAQ;AAClB,YAAA,IAAI,MAAM,GAAG;AAAA,IACnB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,aAAa,QAAc;AAC1B,UAAA,WAAWF,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,+BAA+B,MAAM,SAAS;AAE/C,SAAK,aAAa,UAAU,2BAA2B,MAAM,EAAE;AAC/D,aAAS,KAAK,EAAE,SAAS,WAAW,MAAM,aAAa;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,iBAAiB,QAAc;AAC9B,UAAA,WAAWA,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,gCAAgC,MAAM,mBAAmB;AAGpD,UAAA,EAAE,MAAM,OAAW,IAAA;AACnB,UAAA,UACL,WAAW,OACV,WAAW;AAAA,IAEX,KAAK,UAAU,IAAI,EAAE,SAAS,kCAAkC;AAClE,QAAI,CAAC,SAAS;AACbE,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,mCAAmC,MAAM,EAAE;AAAA,IAC3D;AACD,aAAS,KAAK,EAAE,SAAS,0BAA0B,MAAM,KAAK;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,cAAc,OAAa;AAC1B,UAAA,WAAWF,WAAO;AAExB,UAAM,WAAW,MAAM,KAAK,YAAY,KAAK,KAAK,MAAM,gBAAgB;AAAA,MACvE;AAAA,IAAA,CACA;AACD,SAAK,aAAa,UAAU,4BAA4B,KAAK,EAAE;AAC/D,aAAS,KAAK,EAAE,SAAS,YAAY,KAAK,aAAa;AAEvD,WAAO,SAAS;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,cAAc,IAAU;AACvB,UAAA,WAAWA,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,gBAAgB,EAAE,WAClB,CAAE,CAAA;AAGH,SAAK,aAAa,UAAU,oCAAoC,EAAE,EAAE;AACpE,aAAS,KAAK,EAAE,SAAS,YAAY,EAAE,aAAa;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAc,MAAa;AAC1B,UAAA,WAAWA,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,gBACA,IAAI;AAGL,SAAK,aAAa,UAAU,4BAA4B,KAAK,IAAI,EAAE;AACnE,aAAS,KAAK,EAAE,SAAS,YAAY,KAAK,IAAI,aAAa;AAE3D,WAAO,SAAS;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAc,IAAU;AACvB,UAAA,WAAWA,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,mBAAmB,EAAE,IACrB,CAAE,CAAA;AAGH,SAAK,aAAa,UAAU,oCAAoC,EAAE,EAAE;AACpE,aAAS,KAAK,EAAE,SAAS,YAAY,EAAE,aAAa;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cACL,MACA,KACA,QACA,UAQA,QAAe;AAET,UAAA,WAAWA,WAAO;AAExB,UAAM,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,gCACA;AAAA,MACC;AAAA,MACA;AAAA,MACA;AAAA,MACA,QAAQ,SAAS,OAAO;AAAA,MACxB,GAAG;AAAA,IAAA,CACH;AAEF,SAAK,aAAa,UAAU,4BAA4B,IAAI,EAAE;AAC9D,aAAS,KAAK,EAAE,SAAS,YAAY,IAAI,aAAa;AAEtD,WAAO,SAAS,KAAK;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAc,IAAU;AACvB,UAAA,WAAWA,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,yBAAyB,EAAE,WAC3B,CAAE,CAAA;AAGH,SAAK,aAAa,UAAU,oCAAoC,EAAE,EAAE;AACpE,aAAS,KAAK,EAAE,SAAS,YAAY,EAAE,aAAa;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,kBAAkB,aAAyB;AAC1C,UAAA,KAAK,qBAAqB,kBAAkB,WAAW;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAAa,QAAqB;AACjC,UAAA,KAAK,qBAAqB,aAAa,MAAM;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,2BAA2B,SAAe;AACzC,UAAA,WAAWA,WAAO;AAKxB,UAAM,eACL,MAAM,KAAK,YAAY,IAAI,KAAK,MAAM,8BAA8B;AAEhE,SAAA,aACJ,cACA,6EAA6E;AAExE,UAAA,cAAc,aAAa,KAAK,KAAK,CAAC,EAAE,MAAM,kBAAiB;AAC7D,aAAA,SAAS,WAAW,YAAY,SAAS;AAAA,IAAA,CAChD;AACD,QAAI,aAAa;AACT,aAAA,YAAY,YAAY,CAAC,EAAE;AAAA,IAClC;AACD,UAAM,WACL,MAAM,KAAK,YAAY,KAAK,KAAK,MAAM,8BAA8B;AAAA,MACpE,UAAU;AAAA,IAAA,CACV;AAEF,SAAK,aACJ,UACA,wDAAwD,OAAO,EAAE;AAElE,aAAS,KAAK;AAAA,MACb,SAAS,wCAAwC,OAAO;AAAA,IAAA,CACxD;AAGD,WAAO,SAAS,KAAK,YAAY,CAAC,EAAE;AAAA,EACrC;AACA;;"}
|
|
1
|
+
{"version":3,"file":"repository.cjs","sources":["../../../src/managers/repository.ts"],"sourcesContent":["import { expect } from \"@playwright/test\";\nimport { AxiosResponse } from \"axios\";\n\nimport {\n\tCustomType,\n\tSharedSlice,\n} from \"@prismicio/types-internal/lib/customtypes\";\n\nimport type { AuthenticationClient } from \"../clients/authenticationApi\";\nimport { ContentApiClient } from \"../clients/contentApi\";\nimport type { CoreClient } from \"../clients/coreApi\";\nimport { CustomTypesClient } from \"../clients/customTypesApi\";\nimport { ManageV2Client } from \"../clients/manageV2\";\nimport {\n\tDocumentPayload,\n\tDocumentResponse,\n\tMigrationClient,\n} from \"../clients/migrationApi\";\nimport { WroomClient } from \"../clients/wroom\";\nimport { logHttpResponse, logger } from \"../utils/log\";\nimport { getRepositoryUrl } from \"../utils/urls\";\n\n/** Utility to manage test data for a Prismic repository */\nexport class RepositoryManager {\n\tconstructor(\n\t\treadonly name: string,\n\t\tprivate readonly coreApiClient: CoreClient,\n\t\tprivate readonly authApiClient: AuthenticationClient,\n\t\tprivate readonly wroomClient: WroomClient,\n\t\tprivate readonly customTypesApiClient: CustomTypesClient,\n\t\tprivate readonly migrationApiClient: MigrationClient | undefined,\n\t\tprivate readonly manageV2Client: ManageV2Client,\n\t) {}\n\n\tasync configure(config: RepositoryConfig): Promise<void> {\n\t\tconst hasLangConfig =\n\t\t\tconfig.defaultLocale || config.locales || config.customLocale;\n\t\tif (hasLangConfig) {\n\t\t\tconst languages = await this.coreApiClient.getLanguages();\n\n\t\t\t// default locale must be set first\n\t\t\tif (config.defaultLocale) {\n\t\t\t\tconst master = languages.find(({ is_master }) => is_master === true);\n\t\t\t\tif (!master) {\n\t\t\t\t\tawait this.setDefaultLocale(config.defaultLocale);\n\t\t\t\t} else if (master.id !== config.defaultLocale) {\n\t\t\t\t\tlogger.warn(\n\t\t\t\t\t\t`Master locale is already set to '${master.id}', cannot update it to '${config.defaultLocale}'`,\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (config.locales) {\n\t\t\t\tconst localesToAdd = config.locales.filter(\n\t\t\t\t\t(id) => !languages.some((language) => language.id === id),\n\t\t\t\t);\n\t\t\t\tif (localesToAdd.length > 0) {\n\t\t\t\t\tawait this.createLocales(localesToAdd);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (config.customLocale) {\n\t\t\t\tif (!languages.find(({ id }) => id === config.customLocale?.lang.id)) {\n\t\t\t\t\tawait this.createCustomLocale(config.customLocale);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif (config.slices) {\n\t\t\tawait this.createSlices(config.slices);\n\t\t}\n\n\t\tif (config.customTypes) {\n\t\t\tawait this.createCustomTypes(config.customTypes);\n\t\t}\n\n\t\tif (config.preview) {\n\t\t\tawait this.createPreview(config.preview);\n\t\t}\n\n\t\tif (config.rolePerLocal) {\n\t\t\tawait this.toggleRolePerLocal(true);\n\t\t}\n\t}\n\n\t/** @returns the repository base url, like https://my-repo.prismic.io */\n\tgetBaseURL(): string {\n\t\treturn getRepositoryUrl(this.wroomClient.getBaseURL(), this.name);\n\t}\n\n\t/** @returns the repository base cdn url, like https://my-repo.cdn.prismic.io */\n\tgetBaseCdnURL(): string {\n\t\treturn getRepositoryUrl(this.wroomClient.getBaseURL(), `${this.name}.cdn`);\n\t}\n\n\t/**\n\t * @returns a Content Type api client configured to target the repository CDN\n\t * url. Uses Playwright for requests so if your project uses Playwright too,\n\t * any network request will be present in Playwright test reports.\n\t */\n\tgetContentApiClient(config?: {\n\t\tversion?: \"v1\" | \"v2\";\n\t\taccessToken?: string;\n\t}): ContentApiClient {\n\t\treturn new ContentApiClient(this.getBaseCdnURL(), config);\n\t}\n\n\t/**\n\t * Set additional standard locales for a repository in Wroom, does not fail if\n\t * the locales already exist.\n\t *\n\t * @param locales - An array of all locales to be added to the repository.\n\t *\n\t * @throws Error if setting the locales fails.\n\t */\n\tasync createLocales(locales: string[]): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t\"app/settings/multilanguages\",\n\t\t\t{ languages: locales },\n\t\t);\n\n\t\tconst { data, status } = response;\n\t\tconst success =\n\t\t\tstatus === 200 ||\n\t\t\t(status === 400 &&\n\t\t\t\t(data as string).includes(\"already existing languages\"));\n\t\tif (!success) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(`Could not add locales ${locales.join(\", \")}`);\n\t\t}\n\t\tprofiler.done({ message: `locales '${locales}' created` });\n\t}\n\n\t/**\n\t * Set additional custom locale for a repository in Wroom, does not fail if\n\t * the locales already exist.\n\t *\n\t * @param locale - The locale to be added to the repository.\n\t *\n\t * @throws Error if setting the locale fails.\n\t */\n\tasync createCustomLocale(locale: CustomLocale): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t\"app/settings/multilanguages/custom\",\n\t\t\tlocale,\n\t\t);\n\n\t\tconst { data, status } = response;\n\t\tconst success =\n\t\t\tstatus === 200 ||\n\t\t\t(status === 400 && JSON.stringify(data).includes(\"code is already used\"));\n\t\tif (!success) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(`Could not create custom locale ${locale}`);\n\t\t}\n\t\tprofiler.done({\n\t\t\tmessage: `custom locale ${JSON.stringify(locale)} created`,\n\t\t});\n\t}\n\n\tprivate failIfNot200(response: AxiosResponse, msg: string) {\n\t\tif (response.status !== 200) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(msg);\n\t\t}\n\t}\n\n\t/**\n\t * Delete a locale from a repository.\n\t *\n\t * @param locale - locale to remove from the repository configuration.\n\t *\n\t * @throws Error if deleting the locale fails.\n\t */\n\tasync deleteLocale(locale: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`app/settings/multilanguages/${locale}/delete`,\n\t\t);\n\t\tthis.failIfNot200(response, `Could not delete locale ${locale}`);\n\t\tprofiler.done({ message: `locale '${locale}' deleted` });\n\t}\n\n\t/**\n\t * Set the default (master) locale for a repository in Wroom, the locale needs\n\t * to exist for the repository.\n\t *\n\t * @param locale - The locale to be set as the default.\n\t *\n\t * @throws Error if setting the default locale fails.\n\t */\n\tasync setDefaultLocale(locale: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`/app/settings/multilanguages/${locale}/createMasterLang`,\n\t\t);\n\n\t\tconst { data, status } = response;\n\t\tconst success =\n\t\t\tstatus === 200 ||\n\t\t\t(status === 400 &&\n\t\t\t\t// returns 400 if master lang is already set\n\t\t\t\tJSON.stringify(data).includes(\"Unable to set as master language\"));\n\t\tif (!success) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(`Could not set default locale to ${locale}`);\n\t\t}\n\t\tprofiler.done({ message: `default locale set to '${locale}'` });\n\t}\n\n\t/**\n\t * Creates a release.\n\t *\n\t * @param label - The label for the release.\n\t *\n\t * @returns A Promise that resolves when the release is created.\n\t */\n\tasync createRelease(label: string): Promise<{ id: string }> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(this.name, \"app/releases\", {\n\t\t\tlabel,\n\t\t});\n\t\tthis.failIfNot200(response, `Could not create release ${label}`);\n\t\tprofiler.done({ message: `release '${label}' created` });\n\n\t\treturn response.data;\n\t}\n\n\t/**\n\t * Deletes a repository release.\n\t *\n\t * @param repository - The name of the repository.\n\t * @param id - The ID of the release to be deleted.\n\t */\n\tasync deleteRelease(id: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`app/releases/${id}/delete`,\n\t\t\t{},\n\t\t);\n\n\t\tthis.failIfNot200(response, `Could not delete release with id ${id}`);\n\t\tprofiler.done({ message: `release '${id}' deleted` });\n\t}\n\n\t/**\n\t * Creates a preview for a repository.\n\t *\n\t * @param data - The data for creating the preview.\n\t */\n\tasync createPreview(data: Preview): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`previews/new`,\n\t\t\tdata,\n\t\t);\n\n\t\tthis.failIfNot200(response, `Could not create preview ${data.name}`);\n\t\tprofiler.done({ message: `preview '${data.name}' created` });\n\n\t\treturn response.data;\n\t}\n\n\t/**\n\t * Deletes a preview from a repository.\n\t *\n\t * @param id - The ID of the preview to be deleted.\n\t */\n\tasync deletePreview(id: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tthis.name,\n\t\t\t`previews/delete/${id}`,\n\t\t\t{},\n\t\t);\n\n\t\tthis.failIfNot200(response, `Could not delete preview with id ${id}`);\n\t\tprofiler.done({ message: `preview '${id}' deleted` });\n\t}\n\n\t/**\n\t * Create Custom Types using the Custom types api.\n\t *\n\t * @param customTypes -\n\t */\n\tasync createCustomTypes(customTypes: CustomType[]): Promise<void> {\n\t\tawait this.customTypesApiClient.createCustomTypes(customTypes);\n\t}\n\n\t/**\n\t * Create slices using the Custom types api.\n\t *\n\t * @param slices -\n\t */\n\tasync createSlices(slices: SharedSlice[]): Promise<void> {\n\t\tawait this.customTypesApiClient.createSlices(slices);\n\t}\n\n\t/**\n\t * Create an access token to query private items of the Content api.\n\t *\n\t * @param appName - mandatory authorized application name\n\t * @param tokenScope - access token scope. Use \"master\" to when your content\n\t * api is fully private or \"master+releases\" to access private releases\n\t */\n\tasync createContentAPIToken(\n\t\tappName: string,\n\t\ttokenScope: \"master\" | \"master+releases\" = \"master\",\n\t): Promise<string> {\n\t\tconst profiler = logger.startTimer();\n\t\ttype AuthorizedAppResponse = {\n\t\t\tid: string;\n\t\t\tname: string;\n\t\t\twroom_auths: { token: string; scope: \"master\" | \"master+releases\" }[];\n\t\t};\n\t\tconst existingApps: AxiosResponse<AuthorizedAppResponse[]> =\n\t\t\tawait this.wroomClient.get(this.name, \"settings/security/contentapi\");\n\n\t\tthis.failIfNot200(\n\t\t\texistingApps,\n\t\t\t`Could not get status of existing applications to generate a content api token`,\n\t\t);\n\t\tlet app = existingApps.data.find(({ name, wroom_auths }) => {\n\t\t\treturn name === appName && wroom_auths.length > 0;\n\t\t});\n\n\t\tif (!app) {\n\t\t\tconst response: AxiosResponse<AuthorizedAppResponse> =\n\t\t\t\tawait this.wroomClient.post(this.name, \"settings/security/oauthapp\", {\n\t\t\t\t\tapp_name: appName,\n\t\t\t\t});\n\n\t\t\tthis.failIfNot200(\n\t\t\t\tresponse,\n\t\t\t\t`Could not create content api app ${appName}`,\n\t\t\t);\n\t\t\tapp = response.data;\n\t\t}\n\n\t\tlet tokenInfo = app.wroom_auths.find(({ scope }) => scope === tokenScope);\n\t\tif (!tokenInfo) {\n\t\t\tconst response = await this.wroomClient.post(\n\t\t\t\tthis.name,\n\t\t\t\t\"settings/security/authorizations\",\n\t\t\t\t{\n\t\t\t\t\tapp: app.id,\n\t\t\t\t\tscope: tokenScope,\n\t\t\t\t},\n\t\t\t);\n\t\t\tthis.failIfNot200(\n\t\t\t\tresponse,\n\t\t\t\t`Could not create content api access token for app ${appName} with scope ${tokenScope}`,\n\t\t\t);\n\t\t\ttokenInfo = response.data;\n\t\t}\n\n\t\tprofiler.done({\n\t\t\tmessage: `content api access token for app '${appName}' created`,\n\t\t});\n\n\t\tif (!tokenInfo?.token) {\n\t\t\tthrow `Could not create content api access token for app ${appName} with scope ${tokenScope}`;\n\t\t}\n\n\t\treturn tokenInfo.token;\n\t}\n\n\t/** Create a permanent access token to authenticate to Prismic public apis. */\n\tasync createPermanentAccessToken(): Promise<string> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst token = await this.authApiClient.getMachine2MachineToken(this.name);\n\n\t\tprofiler.done({\n\t\t\tmessage: `machine2machine token created`,\n\t\t});\n\n\t\treturn token;\n\t}\n\n\t/**\n\t * Toggle the Role per local feature\n\t *\n\t * @param enabled - The feature new status\n\t */\n\tasync toggleRolePerLocal(enabled: boolean): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.manageV2Client.toggleRolePerLocal({\n\t\t\trepository: this.name,\n\t\t\tenabled: enabled,\n\t\t});\n\n\t\tthis.failIfNot200(\n\t\t\tresponse,\n\t\t\t`Could not ${enabled ? \"enable\" : \"disable\"} Role per local for ${\n\t\t\t\tthis.name\n\t\t\t}`,\n\t\t);\n\t\tprofiler.done({\n\t\t\tmessage: `Role per local ${enabled ? \"enabled\" : \"disabled\"}`,\n\t\t});\n\t}\n\n\t/**\n\t * Change the Repository Plan\n\t *\n\t * @param {string} newPlanId - The Id of the new Plan to apply\n\t */\n\tasync changePlan(newPlanId: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.manageV2Client.changePlan({\n\t\t\trepository: this.name,\n\t\t\tnewPlanId: newPlanId,\n\t\t\tbypassManualBilling: true, // For now the library does not support Stripe features\n\t\t});\n\n\t\tthis.failIfNot200(response, \"Could not change the Repository Plan\");\n\t\tprofiler.done({\n\t\t\tmessage: `Repository Plan changed to ${newPlanId}`,\n\t\t});\n\t}\n\n\t/**\n\t * Add a new user to the repository\n\t *\n\t * @param {string} email - The email of the user\n\t */\n\tasync addUser(email: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.manageV2Client.addUserToRepository({\n\t\t\trepository: this.name,\n\t\t\temail: email,\n\t\t});\n\n\t\tconst { data, status } = response;\n\t\tconst success =\n\t\t\tstatus === 200 ||\n\t\t\t(status === 409 &&\n\t\t\t\tJSON.stringify(data).includes(\"already a member of the repo\"));\n\t\tif (!success) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(`Could not add a new user ${email} to the repository`);\n\t\t}\n\t\tprofiler.done({\n\t\t\tmessage: `User ${email} was added to the repository`,\n\t\t});\n\t}\n\n\t/**\n\t * Remove a user from the repository\n\t *\n\t * @param {string} email - The email of the user\n\t */\n\tasync removeUser(email: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response = await this.manageV2Client.removeUserFromRepository({\n\t\t\trepository: this.name,\n\t\t\temail: email,\n\t\t});\n\n\t\tthis.failIfNot200(\n\t\t\tresponse,\n\t\t\t`Could not remove the user ${email} from the repository`,\n\t\t);\n\t\tprofiler.done({\n\t\t\tmessage: `User ${email} was removed from the repository`,\n\t\t});\n\t}\n\n\t/**\n\t * Update the role of a user in a repository\n\t *\n\t * @param {string} email - The email of the user\n\t * @param {string | Record<string, string>} role - The new Role of the user,\n\t * either a string for basic workflow or an object such as `{ \"lang_id\":\n\t * \"Writer\" }`\n\t *\n\t * Example of roles are\n\t *\n\t * - Administrator\n\t * - Writer\n\t * - Contributor\n\t * - Manager (publisher)\n\t */\n\tasync updateUserRole(\n\t\temail: string,\n\t\trole: string | Record<string, string>,\n\t): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst response =\n\t\t\ttypeof role === \"string\"\n\t\t\t\t? await this.wroomClient.updateRole(this.name, email, role)\n\t\t\t\t: await this.wroomClient.updateRolePerLocal(this.name, email, role);\n\n\t\tthis.failIfNot200(\n\t\t\tresponse,\n\t\t\t`Could not update the ${\n\t\t\t\ttypeof role === \"string\" ? \"role\" : \"rolePerLocal\"\n\t\t\t} of the user ${email}`,\n\t\t);\n\t\tprofiler.done({\n\t\t\tmessage: `Updated User's ${\n\t\t\t\ttypeof role === \"string\" ? \"role\" : \"rolePerLocal\"\n\t\t\t} for user ${email}`,\n\t\t});\n\t}\n\n\t/**\n\t * Creates a document using the migration api, see\n\t * https://prismic.io/docs/migration-api-technical-reference\n\t *\n\t * @param {DocumentPayload} document - in the migration api format\n\t * @param {string} status - status of the document, if published, the function\n\t * will wait for a new content api master ref to be created\n\t *\n\t * @returns\n\t */\n\tasync createDocument(\n\t\tdocument: DocumentPayload,\n\t\tstatus: \"draft\" | \"published\",\n\t): Promise<DocumentResponse> {\n\t\tif (!this.migrationApiClient) {\n\t\t\tthrow \"No client found for the migration api. Did you provide a migration api url in your configuration?\";\n\t\t}\n\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst result = await this.migrationApiClient.createDocument(document);\n\t\tlet message = `Document created with id '${result.id}'`;\n\t\tif (status === \"published\") {\n\t\t\tconst contentApi = this.getContentApiClient();\n\t\t\tconst masterRef = await contentApi.getMasterRef();\n\t\t\tawait this.coreApiClient.publishDraft(result.id);\n\t\t\tawait expect\n\t\t\t\t.poll(async () => contentApi.getMasterRef(), {\n\t\t\t\t\ttimeout: 10_000,\n\t\t\t\t\tmessage: \"Waiting for new master ref to be available\",\n\t\t\t\t})\n\t\t\t\t.not.toBe(masterRef);\n\t\t\tmessage += \", status 'published' and new master ref available\";\n\t\t}\n\t\tprofiler.done({\n\t\t\tmessage,\n\t\t});\n\n\t\treturn result;\n\t}\n}\n\nexport type RepositoryConfig = {\n\tcustomLocale?: CustomLocale;\n\tlocales?: string[];\n\tdefaultLocale?: string;\n\tslices?: SharedSlice[];\n\tcustomTypes?: CustomType[];\n\tpreview?: Preview;\n\trolePerLocal?: boolean;\n};\n\nexport type Preview = {\n\tname: string;\n\twebsiteURL: string;\n\tresolverPath: string;\n};\n\nexport type CustomLocale = {\n\tlang: {\n\t\tlabel: string;\n\t\tid: string;\n\t\tuseStandardAnalyzer?: boolean;\n\t};\n\tregion: {\n\t\tlabel: string;\n\t\tid: string;\n\t};\n};\n"],"names":["logger","getRepositoryUrl","ContentApiClient","logHttpResponse","contentApi","expect"],"mappings":";;;;;;;;;;;;MAuBa,kBAAiB;AAAA,EAC7B,YACU,MACQ,eACA,eACA,aACA,sBACA,oBACA,gBAA8B;AANtC;AACQ;AACA;AACA;AACA;AACA;AACA;AANR,SAAI,OAAJ;AACQ,SAAa,gBAAb;AACA,SAAa,gBAAb;AACA,SAAW,cAAX;AACA,SAAoB,uBAApB;AACA,SAAkB,qBAAlB;AACA,SAAc,iBAAd;AAAA,EACf;AAAA,EAEH,MAAM,UAAU,QAAwB;AACvC,UAAM,gBACL,OAAO,iBAAiB,OAAO,WAAW,OAAO;AAClD,QAAI,eAAe;AAClB,YAAM,YAAY,MAAM,KAAK,cAAc,aAAY;AAGvD,UAAI,OAAO,eAAe;AACnB,cAAA,SAAS,UAAU,KAAK,CAAC,EAAE,gBAAgB,cAAc,IAAI;AACnE,YAAI,CAAC,QAAQ;AACN,gBAAA,KAAK,iBAAiB,OAAO,aAAa;AAAA,QACtC,WAAA,OAAO,OAAO,OAAO,eAAe;AAC9CA,cAAAA,OAAO,KACN,oCAAoC,OAAO,EAAE,2BAA2B,OAAO,aAAa,GAAG;AAAA,QAEjG;AAAA,MACD;AAEA,UAAI,OAAO,SAAS;AACnB,cAAM,eAAe,OAAO,QAAQ,OACnC,CAAC,OAAO,CAAC,UAAU,KAAK,CAAC,aAAa,SAAS,OAAO,EAAE,CAAC;AAEtD,YAAA,aAAa,SAAS,GAAG;AACtB,gBAAA,KAAK,cAAc,YAAY;AAAA,QACtC;AAAA,MACD;AAEA,UAAI,OAAO,cAAc;AACxB,YAAI,CAAC,UAAU,KAAK,CAAC,EAAE,GAAA;;AAAS,0BAAO,YAAO,iBAAP,mBAAqB,KAAK;AAAA,SAAE,GAAG;AAC/D,gBAAA,KAAK,mBAAmB,OAAO,YAAY;AAAA,QAClD;AAAA,MACD;AAAA,IACD;AAEA,QAAI,OAAO,QAAQ;AACZ,YAAA,KAAK,aAAa,OAAO,MAAM;AAAA,IACtC;AAEA,QAAI,OAAO,aAAa;AACjB,YAAA,KAAK,kBAAkB,OAAO,WAAW;AAAA,IAChD;AAEA,QAAI,OAAO,SAAS;AACb,YAAA,KAAK,cAAc,OAAO,OAAO;AAAA,IACxC;AAEA,QAAI,OAAO,cAAc;AAClB,YAAA,KAAK,mBAAmB,IAAI;AAAA,IACnC;AAAA,EACD;AAAA;AAAA,EAGA,aAAU;AACT,WAAOC,KAAAA,iBAAiB,KAAK,YAAY,WAAU,GAAI,KAAK,IAAI;AAAA,EACjE;AAAA;AAAA,EAGA,gBAAa;AACL,WAAAA,KAAA,iBAAiB,KAAK,YAAY,WAAA,GAAc,GAAG,KAAK,IAAI,MAAM;AAAA,EAC1E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,oBAAoB,QAGnB;AACA,WAAO,IAAIC,WAAAA,iBAAiB,KAAK,iBAAiB,MAAM;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,cAAc,SAAiB;AAC9B,UAAA,WAAWF,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,+BACA,EAAE,WAAW,QAAS,CAAA;AAGjB,UAAA,EAAE,MAAM,OAAW,IAAA;AACzB,UAAM,UACL,WAAW,OACV,WAAW,OACV,KAAgB,SAAS,4BAA4B;AACxD,QAAI,CAAC,SAAS;AACbG,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,yBAAyB,QAAQ,KAAK,IAAI,CAAC,EAAE;AAAA,IAC9D;AACA,aAAS,KAAK,EAAE,SAAS,YAAY,OAAO,aAAa;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,mBAAmB,QAAoB;AACtC,UAAA,WAAWH,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,sCACA,MAAM;AAGD,UAAA,EAAE,MAAM,OAAW,IAAA;AACnB,UAAA,UACL,WAAW,OACV,WAAW,OAAO,KAAK,UAAU,IAAI,EAAE,SAAS,sBAAsB;AACxE,QAAI,CAAC,SAAS;AACbG,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,kCAAkC,MAAM,EAAE;AAAA,IAC3D;AACA,aAAS,KAAK;AAAA,MACb,SAAS,iBAAiB,KAAK,UAAU,MAAM,CAAC;AAAA,IAAA,CAChD;AAAA,EACF;AAAA,EAEQ,aAAa,UAAyB,KAAW;AACpD,QAAA,SAAS,WAAW,KAAK;AAC5BA,UAAA,gBAAgB,QAAQ;AAClB,YAAA,IAAI,MAAM,GAAG;AAAA,IACpB;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,aAAa,QAAc;AAC1B,UAAA,WAAWH,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,+BAA+B,MAAM,SAAS;AAE/C,SAAK,aAAa,UAAU,2BAA2B,MAAM,EAAE;AAC/D,aAAS,KAAK,EAAE,SAAS,WAAW,MAAM,aAAa;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,iBAAiB,QAAc;AAC9B,UAAA,WAAWA,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,gCAAgC,MAAM,mBAAmB;AAGpD,UAAA,EAAE,MAAM,OAAW,IAAA;AACnB,UAAA,UACL,WAAW,OACV,WAAW;AAAA,IAEX,KAAK,UAAU,IAAI,EAAE,SAAS,kCAAkC;AAClE,QAAI,CAAC,SAAS;AACbG,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,mCAAmC,MAAM,EAAE;AAAA,IAC5D;AACA,aAAS,KAAK,EAAE,SAAS,0BAA0B,MAAM,KAAK;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,cAAc,OAAa;AAC1B,UAAA,WAAWH,WAAO;AAExB,UAAM,WAAW,MAAM,KAAK,YAAY,KAAK,KAAK,MAAM,gBAAgB;AAAA,MACvE;AAAA,IAAA,CACA;AACD,SAAK,aAAa,UAAU,4BAA4B,KAAK,EAAE;AAC/D,aAAS,KAAK,EAAE,SAAS,YAAY,KAAK,aAAa;AAEvD,WAAO,SAAS;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,cAAc,IAAU;AACvB,UAAA,WAAWA,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,gBAAgB,EAAE,WAClB,CAAE,CAAA;AAGH,SAAK,aAAa,UAAU,oCAAoC,EAAE,EAAE;AACpE,aAAS,KAAK,EAAE,SAAS,YAAY,EAAE,aAAa;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAc,MAAa;AAC1B,UAAA,WAAWA,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,gBACA,IAAI;AAGL,SAAK,aAAa,UAAU,4BAA4B,KAAK,IAAI,EAAE;AACnE,aAAS,KAAK,EAAE,SAAS,YAAY,KAAK,IAAI,aAAa;AAE3D,WAAO,SAAS;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAc,IAAU;AACvB,UAAA,WAAWA,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,mBAAmB,EAAE,IACrB,CAAE,CAAA;AAGH,SAAK,aAAa,UAAU,oCAAoC,EAAE,EAAE;AACpE,aAAS,KAAK,EAAE,SAAS,YAAY,EAAE,aAAa;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,kBAAkB,aAAyB;AAC1C,UAAA,KAAK,qBAAqB,kBAAkB,WAAW;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAAa,QAAqB;AACjC,UAAA,KAAK,qBAAqB,aAAa,MAAM;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,sBACL,SACA,aAA2C,UAAQ;AAE7C,UAAA,WAAWA,WAAO;AAMxB,UAAM,eACL,MAAM,KAAK,YAAY,IAAI,KAAK,MAAM,8BAA8B;AAEhE,SAAA,aACJ,cACA,+EAA+E;AAE5E,QAAA,MAAM,aAAa,KAAK,KAAK,CAAC,EAAE,MAAM,kBAAiB;AACnD,aAAA,SAAS,WAAW,YAAY,SAAS;AAAA,IAAA,CAChD;AAED,QAAI,CAAC,KAAK;AACT,YAAM,WACL,MAAM,KAAK,YAAY,KAAK,KAAK,MAAM,8BAA8B;AAAA,QACpE,UAAU;AAAA,MAAA,CACV;AAEF,WAAK,aACJ,UACA,oCAAoC,OAAO,EAAE;AAE9C,YAAM,SAAS;AAAA,IAChB;AAEI,QAAA,YAAY,IAAI,YAAY,KAAK,CAAC,EAAE,MAAY,MAAA,UAAU,UAAU;AACxE,QAAI,CAAC,WAAW;AACf,YAAM,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,oCACA;AAAA,QACC,KAAK,IAAI;AAAA,QACT,OAAO;AAAA,MAAA,CACP;AAEF,WAAK,aACJ,UACA,qDAAqD,OAAO,eAAe,UAAU,EAAE;AAExF,kBAAY,SAAS;AAAA,IACtB;AAEA,aAAS,KAAK;AAAA,MACb,SAAS,qCAAqC,OAAO;AAAA,IAAA,CACrD;AAEG,QAAA,EAAC,uCAAW,QAAO;AAChB,YAAA,qDAAqD,OAAO,eAAe,UAAU;AAAA,IAC5F;AAEA,WAAO,UAAU;AAAA,EAClB;AAAA;AAAA,EAGA,MAAM,6BAA0B;AACzB,UAAA,WAAWA,WAAO;AAExB,UAAM,QAAQ,MAAM,KAAK,cAAc,wBAAwB,KAAK,IAAI;AAExE,aAAS,KAAK;AAAA,MACb,SAAS;AAAA,IAAA,CACT;AAEM,WAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,mBAAmB,SAAgB;AAClC,UAAA,WAAWA,WAAO;AAExB,UAAM,WAAW,MAAM,KAAK,eAAe,mBAAmB;AAAA,MAC7D,YAAY,KAAK;AAAA,MACjB;AAAA,IAAA,CACA;AAEI,SAAA,aACJ,UACA,aAAa,UAAU,WAAW,SAAS,uBAC1C,KAAK,IACN,EAAE;AAEH,aAAS,KAAK;AAAA,MACb,SAAS,kBAAkB,UAAU,YAAY,UAAU;AAAA,IAAA,CAC3D;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,WAAW,WAAiB;AAC3B,UAAA,WAAWA,WAAO;AAExB,UAAM,WAAW,MAAM,KAAK,eAAe,WAAW;AAAA,MACrD,YAAY,KAAK;AAAA,MACjB;AAAA,MACA,qBAAqB;AAAA;AAAA,IAAA,CACrB;AAEI,SAAA,aAAa,UAAU,sCAAsC;AAClE,aAAS,KAAK;AAAA,MACb,SAAS,8BAA8B,SAAS;AAAA,IAAA,CAChD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,QAAQ,OAAa;AACpB,UAAA,WAAWA,WAAO;AAExB,UAAM,WAAW,MAAM,KAAK,eAAe,oBAAoB;AAAA,MAC9D,YAAY,KAAK;AAAA,MACjB;AAAA,IAAA,CACA;AAEK,UAAA,EAAE,MAAM,OAAW,IAAA;AACnB,UAAA,UACL,WAAW,OACV,WAAW,OACX,KAAK,UAAU,IAAI,EAAE,SAAS,8BAA8B;AAC9D,QAAI,CAAC,SAAS;AACbG,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,4BAA4B,KAAK,oBAAoB;AAAA,IACtE;AACA,aAAS,KAAK;AAAA,MACb,SAAS,QAAQ,KAAK;AAAA,IAAA,CACtB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,WAAW,OAAa;AACvB,UAAA,WAAWH,WAAO;AAExB,UAAM,WAAW,MAAM,KAAK,eAAe,yBAAyB;AAAA,MACnE,YAAY,KAAK;AAAA,MACjB;AAAA,IAAA,CACA;AAED,SAAK,aACJ,UACA,6BAA6B,KAAK,sBAAsB;AAEzD,aAAS,KAAK;AAAA,MACb,SAAS,QAAQ,KAAK;AAAA,IAAA,CACtB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,MAAM,eACL,OACA,MAAqC;AAE/B,UAAA,WAAWA,WAAO;AAElB,UAAA,WACL,OAAO,SAAS,WACb,MAAM,KAAK,YAAY,WAAW,KAAK,MAAM,OAAO,IAAI,IACxD,MAAM,KAAK,YAAY,mBAAmB,KAAK,MAAM,OAAO,IAAI;AAE/D,SAAA,aACJ,UACA,wBACC,OAAO,SAAS,WAAW,SAAS,cACrC,gBAAgB,KAAK,EAAE;AAExB,aAAS,KAAK;AAAA,MACb,SAAS,kBACR,OAAO,SAAS,WAAW,SAAS,cACrC,aAAa,KAAK;AAAA,IAAA,CAClB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,eACL,UACA,QAA6B;AAEzB,QAAA,CAAC,KAAK,oBAAoB;AACvB,YAAA;AAAA,IACP;AAEM,UAAA,WAAWA,WAAO;AAExB,UAAM,SAAS,MAAM,KAAK,mBAAmB,eAAe,QAAQ;AAChE,QAAA,UAAU,6BAA6B,OAAO,EAAE;AACpD,QAAI,WAAW,aAAa;AACrB,YAAAI,cAAa,KAAK;AAClB,YAAA,YAAY,MAAMA,YAAW;AACnC,YAAM,KAAK,cAAc,aAAa,OAAO,EAAE;AAC/C,YAAMC,KACJ,OAAA,KAAK,YAAYD,YAAW,gBAAgB;AAAA,QAC5C,SAAS;AAAA,QACT,SAAS;AAAA,MACT,CAAA,EACA,IAAI,KAAK,SAAS;AACT,iBAAA;AAAA,IACZ;AACA,aAAS,KAAK;AAAA,MACb;AAAA,IAAA,CACA;AAEM,WAAA;AAAA,EACR;AACA;;"}
|
|
@@ -1,17 +1,35 @@
|
|
|
1
1
|
import { CustomType, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
|
|
2
|
+
import type { AuthenticationClient } from "../clients/authenticationApi";
|
|
3
|
+
import { ContentApiClient } from "../clients/contentApi";
|
|
2
4
|
import type { CoreClient } from "../clients/coreApi";
|
|
3
5
|
import { CustomTypesClient } from "../clients/customTypesApi";
|
|
6
|
+
import { ManageV2Client } from "../clients/manageV2";
|
|
7
|
+
import { DocumentPayload, DocumentResponse, MigrationClient } from "../clients/migrationApi";
|
|
4
8
|
import { WroomClient } from "../clients/wroom";
|
|
5
9
|
/** Utility to manage test data for a Prismic repository */
|
|
6
10
|
export declare class RepositoryManager {
|
|
7
11
|
readonly name: string;
|
|
8
12
|
private readonly coreApiClient;
|
|
13
|
+
private readonly authApiClient;
|
|
9
14
|
private readonly wroomClient;
|
|
10
15
|
private readonly customTypesApiClient;
|
|
11
|
-
|
|
16
|
+
private readonly migrationApiClient;
|
|
17
|
+
private readonly manageV2Client;
|
|
18
|
+
constructor(name: string, coreApiClient: CoreClient, authApiClient: AuthenticationClient, wroomClient: WroomClient, customTypesApiClient: CustomTypesClient, migrationApiClient: MigrationClient | undefined, manageV2Client: ManageV2Client);
|
|
12
19
|
configure(config: RepositoryConfig): Promise<void>;
|
|
13
20
|
/** @returns the repository base url, like https://my-repo.prismic.io */
|
|
14
21
|
getBaseURL(): string;
|
|
22
|
+
/** @returns the repository base cdn url, like https://my-repo.cdn.prismic.io */
|
|
23
|
+
getBaseCdnURL(): string;
|
|
24
|
+
/**
|
|
25
|
+
* @returns a Content Type api client configured to target the repository CDN
|
|
26
|
+
* url. Uses Playwright for requests so if your project uses Playwright too,
|
|
27
|
+
* any network request will be present in Playwright test reports.
|
|
28
|
+
*/
|
|
29
|
+
getContentApiClient(config?: {
|
|
30
|
+
version?: "v1" | "v2";
|
|
31
|
+
accessToken?: string;
|
|
32
|
+
}): ContentApiClient;
|
|
15
33
|
/**
|
|
16
34
|
* Set additional standard locales for a repository in Wroom, does not fail if
|
|
17
35
|
* the locales already exist.
|
|
@@ -77,25 +95,6 @@ export declare class RepositoryManager {
|
|
|
77
95
|
* @param id - The ID of the preview to be deleted.
|
|
78
96
|
*/
|
|
79
97
|
deletePreview(id: string): Promise<void>;
|
|
80
|
-
/**
|
|
81
|
-
* Create a webhook.
|
|
82
|
-
*
|
|
83
|
-
* @returns A Promise that resolves with the webhook id.
|
|
84
|
-
*/
|
|
85
|
-
createWebhook(name: string, url: string, secret: string, triggers: {
|
|
86
|
-
documentsPublished?: boolean;
|
|
87
|
-
documentsUnpublished?: boolean;
|
|
88
|
-
releasesCreated?: boolean;
|
|
89
|
-
releasesUpdated?: boolean;
|
|
90
|
-
tagsCreated?: boolean;
|
|
91
|
-
tagsDeleted?: boolean;
|
|
92
|
-
}, active: boolean): Promise<string>;
|
|
93
|
-
/**
|
|
94
|
-
* Deletes a webhook.
|
|
95
|
-
*
|
|
96
|
-
* @param id - The webhook ID.
|
|
97
|
-
*/
|
|
98
|
-
deleteWebhook(id: string): Promise<void>;
|
|
99
98
|
/**
|
|
100
99
|
* Create Custom Types using the Custom types api.
|
|
101
100
|
*
|
|
@@ -109,11 +108,66 @@ export declare class RepositoryManager {
|
|
|
109
108
|
*/
|
|
110
109
|
createSlices(slices: SharedSlice[]): Promise<void>;
|
|
111
110
|
/**
|
|
112
|
-
* Create
|
|
111
|
+
* Create an access token to query private items of the Content api.
|
|
113
112
|
*
|
|
114
113
|
* @param appName - mandatory authorized application name
|
|
114
|
+
* @param tokenScope - access token scope. Use "master" to when your content
|
|
115
|
+
* api is fully private or "master+releases" to access private releases
|
|
116
|
+
*/
|
|
117
|
+
createContentAPIToken(appName: string, tokenScope?: "master" | "master+releases"): Promise<string>;
|
|
118
|
+
/** Create a permanent access token to authenticate to Prismic public apis. */
|
|
119
|
+
createPermanentAccessToken(): Promise<string>;
|
|
120
|
+
/**
|
|
121
|
+
* Toggle the Role per local feature
|
|
122
|
+
*
|
|
123
|
+
* @param enabled - The feature new status
|
|
124
|
+
*/
|
|
125
|
+
toggleRolePerLocal(enabled: boolean): Promise<void>;
|
|
126
|
+
/**
|
|
127
|
+
* Change the Repository Plan
|
|
128
|
+
*
|
|
129
|
+
* @param {string} newPlanId - The Id of the new Plan to apply
|
|
130
|
+
*/
|
|
131
|
+
changePlan(newPlanId: string): Promise<void>;
|
|
132
|
+
/**
|
|
133
|
+
* Add a new user to the repository
|
|
134
|
+
*
|
|
135
|
+
* @param {string} email - The email of the user
|
|
136
|
+
*/
|
|
137
|
+
addUser(email: string): Promise<void>;
|
|
138
|
+
/**
|
|
139
|
+
* Remove a user from the repository
|
|
140
|
+
*
|
|
141
|
+
* @param {string} email - The email of the user
|
|
142
|
+
*/
|
|
143
|
+
removeUser(email: string): Promise<void>;
|
|
144
|
+
/**
|
|
145
|
+
* Update the role of a user in a repository
|
|
146
|
+
*
|
|
147
|
+
* @param {string} email - The email of the user
|
|
148
|
+
* @param {string | Record<string, string>} role - The new Role of the user,
|
|
149
|
+
* either a string for basic workflow or an object such as `{ "lang_id":
|
|
150
|
+
* "Writer" }`
|
|
151
|
+
*
|
|
152
|
+
* Example of roles are
|
|
153
|
+
*
|
|
154
|
+
* - Administrator
|
|
155
|
+
* - Writer
|
|
156
|
+
* - Contributor
|
|
157
|
+
* - Manager (publisher)
|
|
158
|
+
*/
|
|
159
|
+
updateUserRole(email: string, role: string | Record<string, string>): Promise<void>;
|
|
160
|
+
/**
|
|
161
|
+
* Creates a document using the migration api, see
|
|
162
|
+
* https://prismic.io/docs/migration-api-technical-reference
|
|
163
|
+
*
|
|
164
|
+
* @param {DocumentPayload} document - in the migration api format
|
|
165
|
+
* @param {string} status - status of the document, if published, the function
|
|
166
|
+
* will wait for a new content api master ref to be created
|
|
167
|
+
*
|
|
168
|
+
* @returns
|
|
115
169
|
*/
|
|
116
|
-
|
|
170
|
+
createDocument(document: DocumentPayload, status: "draft" | "published"): Promise<DocumentResponse>;
|
|
117
171
|
}
|
|
118
172
|
export type RepositoryConfig = {
|
|
119
173
|
customLocale?: CustomLocale;
|
|
@@ -122,6 +176,7 @@ export type RepositoryConfig = {
|
|
|
122
176
|
slices?: SharedSlice[];
|
|
123
177
|
customTypes?: CustomType[];
|
|
124
178
|
preview?: Preview;
|
|
179
|
+
rolePerLocal?: boolean;
|
|
125
180
|
};
|
|
126
181
|
export type Preview = {
|
|
127
182
|
name: string;
|