@prismicio/e2e-tests-utils 1.4.0-alpha.2 → 1.4.1

package/dist/clients/customTypesApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"customTypesApi.cjs","sources":["../../../src/clients/customTypesApi.ts"],"sourcesContent":["import axios, { AxiosInstance } from \"axios\";\nimport isEqual from \"lodash.isequal\";\n\nimport {\n\tCustomType,\n\tSharedSlice,\n} from \"@prismicio/types-internal/lib/customtypes\";\n\nimport { logHttpResponse, logger } from \"../utils/log\";\n\nimport { AuthenticationClient } from \"./authenticationApi\";\n\nexport type CustomTypesClient = {\n\tcreateCustomTypes(customTypes: CustomType[]): Promise<void>;\n\tcreateSlices(slices: SharedSlice[]): Promise<void>;\n};\n\n/**\n * Client for interacting with the Custom Types API to create/update custom\n * types and slices.\n */\nexport const createCustomTypesApiClient = (\n\tbaseURL: string,\n\trepository: string,\n\tauthClient: AuthenticationClient,\n): CustomTypesClient => {\n\ttype ItemType = CustomType | SharedSlice;\n\ttype ItemTypePath = \"customtypes\" | \"slices\";\n\ttype ItemOperation = \"insert\" | \"update\";\n\n\tconst client: AxiosInstance = axios.create({\n\t\tbaseURL,\n\t\tvalidateStatus: () => true, // Don't throw on 4XX errors\n\t\theaders: {\n\t\t\trepository,\n\t\t},\n\t});\n\n\t// Add an interceptor to authenticate requests\n\tclient.interceptors.request.use(async (config) => {\n\t\tconst auth = \"Authorization\";\n\t\tif (!config.headers[auth]) {\n\t\t\tconst token = await authClient.getToken();\n\t\t\tconfig.headers[auth] = `Bearer ${token}`;\n\t\t}\n\n\t\treturn config;\n\t});\n\n\t/**\n\t * Create or update a custom type or slice.\n\t *\n\t * @param endpoint - - The API endpoint for custom types or slices\n\t *   ('customtypes' or 'slices').\n\t * @param data - - The data representing the custom type or slice.\n\t *\n\t * @throws Error if the item status cannot be retrieved or the item cannot be\n\t *   created/updated.\n\t */\n\tasync function upsert(\n\t\tendpoint: ItemTypePath,\n\t\toperation: ItemOperation,\n\t\tdata: ItemType,\n\t) {\n\t\tconst profiler = logger.startTimer();\n\t\tconst path = `${endpoint}/${operation}`;\n\n\t\tconst result = await client.post(path, data, { headers: {} });\n\t\tif (![201, 204].includes(result.status)) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(`Could not ${operation} item`);\n\t\t}\n\t\tprofiler.done({\n\t\t\tmessage: `called customtypes api /${path} for item with id '${data.id}'`,\n\t\t});\n\t}\n\n\tasync function getRemoteItems(\n\t\tendpoint: ItemTypePath,\n\t): Promise<CustomType[] | SharedSlice[]> {\n\t\tconst result = await client.get(endpoint);\n\n\t\tif (![200].includes(result.status)) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\"Could not get items status from the Custom Type api.\");\n\t\t}\n\n\t\treturn result.data;\n\t}\n\n\tasync function getDifference(\n\t\tremoteItems: CustomType[] | SharedSlice[],\n\t\tlocal: ItemType,\n\t): Promise<ItemOperation | undefined> {\n\t\tconst remoteItem = remoteItems.find(\n\t\t\t(remote: CustomType | SharedSlice) => remote.id === local.id,\n\t\t);\n\t\tif (!remoteItem) {\n\t\t\treturn \"insert\";\n\t\t}\n\t\tif (!isEqual(local, remoteItem)) {\n\t\t\treturn \"update\";\n\t\t}\n\n\t\treturn;\n\t}\n\n\t/** Create items only if they have changed compared to their remote status */\n\tasync function upsertIfChanged(\n\t\titemType: ItemTypePath,\n\t\tlocalItems: ItemType[] = [],\n\t) {\n\t\tconst remoteItems = await getRemoteItems(itemType);\n\t\tawait Promise.all(\n\t\t\tlocalItems.map(async (localItem) => {\n\t\t\t\tconst operation = await getDifference(remoteItems, localItem);\n\n\t\t\t\treturn operation && upsert(itemType, operation, localItem);\n\t\t\t}),\n\t\t);\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 function createCustomTypes(customTypes: CustomType[] = []) {\n\t\tawait upsertIfChanged(\"customtypes\", 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 function createSlices(slices: SharedSlice[] = []) {\n\t\tawait upsertIfChanged(\"slices\", slices);\n\t}\n\n\treturn {\n\t\tcreateCustomTypes,\n\t\tcreateSlices,\n\t};\n};\n"],"names":["logger","logHttpResponse"],"mappings":";;;;;AAqBO,MAAM,6BAA6B,CACzC,SACA,YACA,eACsB;AAKhB,QAAA,SAAwB,MAAM,OAAO;AAAA,IAC1C;AAAA,IACA,gBAAgB,MAAM;AAAA;AAAA,IACtB,SAAS;AAAA,MACR;AAAA,IACA;AAAA,EAAA,CACD;AAGD,SAAO,aAAa,QAAQ,IAAI,OAAO,WAAU;AAChD,UAAM,OAAO;AACb,QAAI,CAAC,OAAO,QAAQ,IAAI,GAAG;AACpB,YAAA,QAAQ,MAAM,WAAW;AAC/B,aAAO,QAAQ,IAAI,IAAI,UAAU,KAAK;AAAA,IACvC;AAEO,WAAA;AAAA,EAAA,CACP;AAYc,iBAAA,OACd,UACA,WACA,MAAc;AAER,UAAA,WAAWA,WAAO;AACxB,UAAM,OAAO,GAAG,QAAQ,IAAI,SAAS;AAE/B,UAAA,SAAS,MAAM,OAAO,KAAK,MAAM,MAAM,EAAE,SAAS,CAAE,EAAA,CAAE;AACxD,QAAA,CAAC,CAAC,KAAK,GAAG,EAAE,SAAS,OAAO,MAAM,GAAG;AACxCC,UAAA,gBAAgB,MAAM;AACtB,YAAM,IAAI,MAAM,aAAa,SAAS,OAAO;AAAA,IAC9C;AACA,aAAS,KAAK;AAAA,MACb,SAAS,2BAA2B,IAAI,sBAAsB,KAAK,EAAE;AAAA,IAAA,CACrE;AAAA,EACF;AAEA,iBAAe,eACd,UAAsB;AAEtB,UAAM,SAAS,MAAM,OAAO,IAAI,QAAQ;AAExC,QAAI,CAAC,CAAC,GAAG,EAAE,SAAS,OAAO,MAAM,GAAG;AACnCA,UAAA,gBAAgB,MAAM;AAChB,YAAA,IAAI,MAAM,sDAAsD;AAAA,IACvE;AAEA,WAAO,OAAO;AAAA,EACf;AAEe,iBAAA,cACd,aACA,OAAe;AAET,UAAA,aAAa,YAAY,KAC9B,CAAC,WAAqC,OAAO,OAAO,MAAM,EAAE;AAE7D,QAAI,CAAC,YAAY;AACT,aAAA;AAAA,IACR;AACA,QAAI,CAAC,QAAQ,OAAO,UAAU,GAAG;AACzB,aAAA;AAAA,IACR;AAEA;AAAA,EACD;AAGA,iBAAe,gBACd,UACA,aAAyB,IAAE;AAErB,UAAA,cAAc,MAAM,eAAe,QAAQ;AACjD,UAAM,QAAQ,IACb,WAAW,IAAI,OAAO,cAAa;AAClC,YAAM,YAAY,MAAM,cAAc,aAAa,SAAS;AAE5D,aAAO,aAAa,OAAO,UAAU,WAAW,SAAS;AAAA,IACzD,CAAA,CAAC;AAAA,EAEJ;AAOe,iBAAA,kBAAkB,cAA4B,IAAE;AACxD,UAAA,gBAAgB,eAAe,WAAW;AAAA,EACjD;AAOe,iBAAA,aAAa,SAAwB,IAAE;AAC/C,UAAA,gBAAgB,UAAU,MAAM;AAAA,EACvC;AAEO,SAAA;AAAA,IACN;AAAA,IACA;AAAA,EAAA;AAEF;;"}
+{"version":3,"file":"customTypesApi.cjs","sources":["../../../src/clients/customTypesApi.ts"],"sourcesContent":["import isEqual from \"lodash.isequal\";\n\nimport {\n\tCustomType,\n\tSharedSlice,\n} from \"@prismicio/types-internal/lib/customtypes\";\n\nimport { logPlaywrightApiResponse, logger } from \"../utils/log\";\n\nimport { AuthServerToken, AuthenticatedApiClient } from \"./apiClient\";\n\ntype ItemType = CustomType | SharedSlice;\ntype ItemTypePath = \"customtypes\" | \"slices\";\ntype ItemOperation = \"insert\" | \"update\";\n\n/**\n * Client for interacting with the Custom Types API to create/update custom\n * types and slices.\n */\nexport class CustomTypesApiClient extends AuthenticatedApiClient {\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 * Create or update a custom type or slice.\n\t *\n\t * @param endpoint - - The API endpoint for custom types or slices\n\t *   ('customtypes' or 'slices').\n\t * @param data - - The data representing the custom type or slice.\n\t *\n\t * @throws Error if the item status cannot be retrieved or the item cannot be\n\t *   created/updated.\n\t */\n\tprivate async upsert(\n\t\tendpoint: ItemTypePath,\n\t\toperation: ItemOperation,\n\t\tdata: ItemType,\n\t) {\n\t\tconst profiler = logger.startTimer();\n\t\tconst path = `${endpoint}/${operation}`;\n\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.post(path, { data });\n\t\tif (!result.ok()) {\n\t\t\tlogPlaywrightApiResponse(result);\n\t\t\tthrow new Error(`Could not ${operation} item`);\n\t\t}\n\t\tprofiler.done({\n\t\t\tmessage: `called customtypes api /${path} for item with id '${data.id}'`,\n\t\t});\n\t}\n\n\tprivate async getRemoteItems(\n\t\tendpoint: ItemTypePath,\n\t): Promise<CustomType[] | SharedSlice[]> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(endpoint);\n\n\t\tif (!result.ok()) {\n\t\t\tlogPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not get items status from the Custom Type api.\");\n\t\t}\n\n\t\treturn result.json();\n\t}\n\n\tprivate async getDifference(\n\t\tremoteItems: CustomType[] | SharedSlice[],\n\t\tlocal: ItemType,\n\t): Promise<ItemOperation | undefined> {\n\t\tconst remoteItem = remoteItems.find(\n\t\t\t(remote: CustomType | SharedSlice) => remote.id === local.id,\n\t\t);\n\t\tif (!remoteItem) {\n\t\t\treturn \"insert\";\n\t\t}\n\t\tif (!isEqual(local, remoteItem)) {\n\t\t\treturn \"update\";\n\t\t}\n\n\t\treturn;\n\t}\n\n\t/** Create items only if they have changed compared to their remote status */\n\tprivate async upsertIfChanged(\n\t\titemType: ItemTypePath,\n\t\tlocalItems: ItemType[] = [],\n\t): Promise<void> {\n\t\tconst remoteItems = await this.getRemoteItems(itemType);\n\t\tawait Promise.all(\n\t\t\tlocalItems.map(async (localItem) => {\n\t\t\t\tconst operation = await this.getDifference(remoteItems, localItem);\n\n\t\t\t\treturn operation && this.upsert(itemType, operation, localItem);\n\t\t\t}),\n\t\t);\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.upsertIfChanged(\"customtypes\", 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.upsertIfChanged(\"slices\", slices);\n\t}\n}\n"],"names":["AuthenticatedApiClient","logger","logPlaywrightApiResponse"],"mappings":";;;;;AAmBM,MAAO,6BAA6BA,UAAAA,uBAAsB;AAAA,EAC/D,YACC,SACA,QAA0D;AAE1D,UAAM,SAAS,OAAO,WAAW,EAAE,YAAY,OAAO,YAAY;AAAA,EACnE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYQ,MAAM,OACb,UACA,WACA,MAAc;AAER,UAAA,WAAWC,WAAO;AACxB,UAAM,OAAO,GAAG,QAAQ,IAAI,SAAS;AAE/B,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,KAAK,MAAM,EAAE,MAAM;AAC5C,QAAA,CAAC,OAAO,MAAM;AACjBC,UAAA,yBAAyB,MAAM;AAC/B,YAAM,IAAI,MAAM,aAAa,SAAS,OAAO;AAAA,IAC9C;AACA,aAAS,KAAK;AAAA,MACb,SAAS,2BAA2B,IAAI,sBAAsB,KAAK,EAAE;AAAA,IAAA,CACrE;AAAA,EACF;AAAA,EAEQ,MAAM,eACb,UAAsB;AAEhB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,QAAQ;AAErC,QAAA,CAAC,OAAO,MAAM;AACjBA,UAAA,yBAAyB,MAAM;AACzB,YAAA,IAAI,MAAM,sDAAsD;AAAA,IACvE;AAEA,WAAO,OAAO;EACf;AAAA,EAEQ,MAAM,cACb,aACA,OAAe;AAET,UAAA,aAAa,YAAY,KAC9B,CAAC,WAAqC,OAAO,OAAO,MAAM,EAAE;AAE7D,QAAI,CAAC,YAAY;AACT,aAAA;AAAA,IACR;AACA,QAAI,CAAC,QAAQ,OAAO,UAAU,GAAG;AACzB,aAAA;AAAA,IACR;AAEA;AAAA,EACD;AAAA;AAAA,EAGQ,MAAM,gBACb,UACA,aAAyB,IAAE;AAE3B,UAAM,cAAc,MAAM,KAAK,eAAe,QAAQ;AACtD,UAAM,QAAQ,IACb,WAAW,IAAI,OAAO,cAAa;AAClC,YAAM,YAAY,MAAM,KAAK,cAAc,aAAa,SAAS;AAEjE,aAAO,aAAa,KAAK,OAAO,UAAU,WAAW,SAAS;AAAA,IAC9D,CAAA,CAAC;AAAA,EAEJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,kBAAkB,cAA4B,IAAE;AAC/C,UAAA,KAAK,gBAAgB,eAAe,WAAW;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAAa,SAAwB,IAAE;AACtC,UAAA,KAAK,gBAAgB,UAAU,MAAM;AAAA,EAC5C;AACA;;"}

package/dist/clients/customTypesApi.d.ts

@@ -1,11 +1,39 @@
 import { CustomType, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
-import { AuthenticationClient } from "./authenticationApi";
-export type CustomTypesClient = {
-    createCustomTypes(customTypes: CustomType[]): Promise<void>;
-    createSlices(slices: SharedSlice[]): Promise<void>;
-};
+import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
 /**
  * Client for interacting with the Custom Types API to create/update custom
  * types and slices.
  */
-export declare const createCustomTypesApiClient: (baseURL: string, repository: string, authClient: AuthenticationClient) => CustomTypesClient;
+export declare class CustomTypesApiClient extends AuthenticatedApiClient {
+    constructor(baseURL: string, config: {
+        authToken: AuthServerToken;
+        repository: string;
+    });
+    /**
+     * Create or update a custom type or slice.
+     *
+     * @param endpoint - - The API endpoint for custom types or slices
+     *   ('customtypes' or 'slices').
+     * @param data - - The data representing the custom type or slice.
+     *
+     * @throws Error if the item status cannot be retrieved or the item cannot be
+     *   created/updated.
+     */
+    private upsert;
+    private getRemoteItems;
+    private getDifference;
+    /** Create items only if they have changed compared to their remote status */
+    private upsertIfChanged;
+    /**
+     * Create Custom Types using the Custom types api.
+     *
+     * @param customTypes -
+     */
+    createCustomTypes(customTypes?: CustomType[]): Promise<void>;
+    /**
+     * Create slices using the Custom types api.
+     *
+     * @param slices -
+     */
+    createSlices(slices?: SharedSlice[]): Promise<void>;
+}

package/dist/clients/customTypesApi.js

@@ -1,44 +1,43 @@
-import axios from "axios";
 import isEqual from "lodash.isequal";
-import { logger, logHttpResponse } from "../utils/log.js";
-const createCustomTypesApiClient = (baseURL, repository, authClient) => {
-  const client = axios.create({
-    baseURL,
-    validateStatus: () => true,
-    // Don't throw on 4XX errors
-    headers: {
-      repository
-    }
-  });
-  client.interceptors.request.use(async (config) => {
-    const auth = "Authorization";
-    if (!config.headers[auth]) {
-      const token = await authClient.getToken();
-      config.headers[auth] = `Bearer ${token}`;
-    }
-    return config;
-  });
-  async function upsert(endpoint, operation, data) {
+import { logger, logPlaywrightApiResponse } from "../utils/log.js";
+import { AuthenticatedApiClient } from "./apiClient.js";
+class CustomTypesApiClient extends AuthenticatedApiClient {
+  constructor(baseURL, config) {
+    super(baseURL, config.authToken, { repository: config.repository });
+  }
+  /**
+   * Create or update a custom type or slice.
+   *
+   * @param endpoint - - The API endpoint for custom types or slices
+   *   ('customtypes' or 'slices').
+   * @param data - - The data representing the custom type or slice.
+   *
+   * @throws Error if the item status cannot be retrieved or the item cannot be
+   *   created/updated.
+   */
+  async upsert(endpoint, operation, data) {
     const profiler = logger.startTimer();
     const path = `${endpoint}/${operation}`;
-    const result = await client.post(path, data, { headers: {} });
-    if (![201, 204].includes(result.status)) {
-      logHttpResponse(result);
+    const context = await this.getContext();
+    const result = await context.post(path, { data });
+    if (!result.ok()) {
+      logPlaywrightApiResponse(result);
       throw new Error(`Could not ${operation} item`);
     }
     profiler.done({
       message: `called customtypes api /${path} for item with id '${data.id}'`
     });
   }
-  async function getRemoteItems(endpoint) {
-    const result = await client.get(endpoint);
-    if (![200].includes(result.status)) {
-      logHttpResponse(result);
+  async getRemoteItems(endpoint) {
+    const context = await this.getContext();
+    const result = await context.get(endpoint);
+    if (!result.ok()) {
+      logPlaywrightApiResponse(result);
       throw new Error("Could not get items status from the Custom Type api.");
     }
-    return result.data;
+    return result.json();
   }
-  async function getDifference(remoteItems, local) {
+  async getDifference(remoteItems, local) {
     const remoteItem = remoteItems.find((remote) => remote.id === local.id);
     if (!remoteItem) {
       return "insert";
@@ -48,25 +47,32 @@ const createCustomTypesApiClient = (baseURL, repository, authClient) => {
     }
     return;
   }
-  async function upsertIfChanged(itemType, localItems = []) {
-    const remoteItems = await getRemoteItems(itemType);
+  /** Create items only if they have changed compared to their remote status */
+  async upsertIfChanged(itemType, localItems = []) {
+    const remoteItems = await this.getRemoteItems(itemType);
     await Promise.all(localItems.map(async (localItem) => {
-      const operation = await getDifference(remoteItems, localItem);
-      return operation && upsert(itemType, operation, localItem);
+      const operation = await this.getDifference(remoteItems, localItem);
+      return operation && this.upsert(itemType, operation, localItem);
     }));
   }
-  async function createCustomTypes(customTypes = []) {
-    await upsertIfChanged("customtypes", customTypes);
+  /**
+   * Create Custom Types using the Custom types api.
+   *
+   * @param customTypes -
+   */
+  async createCustomTypes(customTypes = []) {
+    await this.upsertIfChanged("customtypes", customTypes);
   }
-  async function createSlices(slices = []) {
-    await upsertIfChanged("slices", slices);
+  /**
+   * Create slices using the Custom types api.
+   *
+   * @param slices -
+   */
+  async createSlices(slices = []) {
+    await this.upsertIfChanged("slices", slices);
   }
-  return {
-    createCustomTypes,
-    createSlices
-  };
-};
+}
 export {
-  createCustomTypesApiClient
+  CustomTypesApiClient
 };
 //# sourceMappingURL=customTypesApi.js.map

package/dist/clients/customTypesApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"customTypesApi.js","sources":["../../../src/clients/customTypesApi.ts"],"sourcesContent":["import axios, { AxiosInstance } from \"axios\";\nimport isEqual from \"lodash.isequal\";\n\nimport {\n\tCustomType,\n\tSharedSlice,\n} from \"@prismicio/types-internal/lib/customtypes\";\n\nimport { logHttpResponse, logger } from \"../utils/log\";\n\nimport { AuthenticationClient } from \"./authenticationApi\";\n\nexport type CustomTypesClient = {\n\tcreateCustomTypes(customTypes: CustomType[]): Promise<void>;\n\tcreateSlices(slices: SharedSlice[]): Promise<void>;\n};\n\n/**\n * Client for interacting with the Custom Types API to create/update custom\n * types and slices.\n */\nexport const createCustomTypesApiClient = (\n\tbaseURL: string,\n\trepository: string,\n\tauthClient: AuthenticationClient,\n): CustomTypesClient => {\n\ttype ItemType = CustomType | SharedSlice;\n\ttype ItemTypePath = \"customtypes\" | \"slices\";\n\ttype ItemOperation = \"insert\" | \"update\";\n\n\tconst client: AxiosInstance = axios.create({\n\t\tbaseURL,\n\t\tvalidateStatus: () => true, // Don't throw on 4XX errors\n\t\theaders: {\n\t\t\trepository,\n\t\t},\n\t});\n\n\t// Add an interceptor to authenticate requests\n\tclient.interceptors.request.use(async (config) => {\n\t\tconst auth = \"Authorization\";\n\t\tif (!config.headers[auth]) {\n\t\t\tconst token = await authClient.getToken();\n\t\t\tconfig.headers[auth] = `Bearer ${token}`;\n\t\t}\n\n\t\treturn config;\n\t});\n\n\t/**\n\t * Create or update a custom type or slice.\n\t *\n\t * @param endpoint - - The API endpoint for custom types or slices\n\t *   ('customtypes' or 'slices').\n\t * @param data - - The data representing the custom type or slice.\n\t *\n\t * @throws Error if the item status cannot be retrieved or the item cannot be\n\t *   created/updated.\n\t */\n\tasync function upsert(\n\t\tendpoint: ItemTypePath,\n\t\toperation: ItemOperation,\n\t\tdata: ItemType,\n\t) {\n\t\tconst profiler = logger.startTimer();\n\t\tconst path = `${endpoint}/${operation}`;\n\n\t\tconst result = await client.post(path, data, { headers: {} });\n\t\tif (![201, 204].includes(result.status)) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(`Could not ${operation} item`);\n\t\t}\n\t\tprofiler.done({\n\t\t\tmessage: `called customtypes api /${path} for item with id '${data.id}'`,\n\t\t});\n\t}\n\n\tasync function getRemoteItems(\n\t\tendpoint: ItemTypePath,\n\t): Promise<CustomType[] | SharedSlice[]> {\n\t\tconst result = await client.get(endpoint);\n\n\t\tif (![200].includes(result.status)) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\"Could not get items status from the Custom Type api.\");\n\t\t}\n\n\t\treturn result.data;\n\t}\n\n\tasync function getDifference(\n\t\tremoteItems: CustomType[] | SharedSlice[],\n\t\tlocal: ItemType,\n\t): Promise<ItemOperation | undefined> {\n\t\tconst remoteItem = remoteItems.find(\n\t\t\t(remote: CustomType | SharedSlice) => remote.id === local.id,\n\t\t);\n\t\tif (!remoteItem) {\n\t\t\treturn \"insert\";\n\t\t}\n\t\tif (!isEqual(local, remoteItem)) {\n\t\t\treturn \"update\";\n\t\t}\n\n\t\treturn;\n\t}\n\n\t/** Create items only if they have changed compared to their remote status */\n\tasync function upsertIfChanged(\n\t\titemType: ItemTypePath,\n\t\tlocalItems: ItemType[] = [],\n\t) {\n\t\tconst remoteItems = await getRemoteItems(itemType);\n\t\tawait Promise.all(\n\t\t\tlocalItems.map(async (localItem) => {\n\t\t\t\tconst operation = await getDifference(remoteItems, localItem);\n\n\t\t\t\treturn operation && upsert(itemType, operation, localItem);\n\t\t\t}),\n\t\t);\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 function createCustomTypes(customTypes: CustomType[] = []) {\n\t\tawait upsertIfChanged(\"customtypes\", 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 function createSlices(slices: SharedSlice[] = []) {\n\t\tawait upsertIfChanged(\"slices\", slices);\n\t}\n\n\treturn {\n\t\tcreateCustomTypes,\n\t\tcreateSlices,\n\t};\n};\n"],"names":[],"mappings":";;;AAqBO,MAAM,6BAA6B,CACzC,SACA,YACA,eACsB;AAKhB,QAAA,SAAwB,MAAM,OAAO;AAAA,IAC1C;AAAA,IACA,gBAAgB,MAAM;AAAA;AAAA,IACtB,SAAS;AAAA,MACR;AAAA,IACA;AAAA,EAAA,CACD;AAGD,SAAO,aAAa,QAAQ,IAAI,OAAO,WAAU;AAChD,UAAM,OAAO;AACb,QAAI,CAAC,OAAO,QAAQ,IAAI,GAAG;AACpB,YAAA,QAAQ,MAAM,WAAW;AAC/B,aAAO,QAAQ,IAAI,IAAI,UAAU,KAAK;AAAA,IACvC;AAEO,WAAA;AAAA,EAAA,CACP;AAYc,iBAAA,OACd,UACA,WACA,MAAc;AAER,UAAA,WAAW,OAAO;AACxB,UAAM,OAAO,GAAG,QAAQ,IAAI,SAAS;AAE/B,UAAA,SAAS,MAAM,OAAO,KAAK,MAAM,MAAM,EAAE,SAAS,CAAE,EAAA,CAAE;AACxD,QAAA,CAAC,CAAC,KAAK,GAAG,EAAE,SAAS,OAAO,MAAM,GAAG;AACxC,sBAAgB,MAAM;AACtB,YAAM,IAAI,MAAM,aAAa,SAAS,OAAO;AAAA,IAC9C;AACA,aAAS,KAAK;AAAA,MACb,SAAS,2BAA2B,IAAI,sBAAsB,KAAK,EAAE;AAAA,IAAA,CACrE;AAAA,EACF;AAEA,iBAAe,eACd,UAAsB;AAEtB,UAAM,SAAS,MAAM,OAAO,IAAI,QAAQ;AAExC,QAAI,CAAC,CAAC,GAAG,EAAE,SAAS,OAAO,MAAM,GAAG;AACnC,sBAAgB,MAAM;AAChB,YAAA,IAAI,MAAM,sDAAsD;AAAA,IACvE;AAEA,WAAO,OAAO;AAAA,EACf;AAEe,iBAAA,cACd,aACA,OAAe;AAET,UAAA,aAAa,YAAY,KAC9B,CAAC,WAAqC,OAAO,OAAO,MAAM,EAAE;AAE7D,QAAI,CAAC,YAAY;AACT,aAAA;AAAA,IACR;AACA,QAAI,CAAC,QAAQ,OAAO,UAAU,GAAG;AACzB,aAAA;AAAA,IACR;AAEA;AAAA,EACD;AAGA,iBAAe,gBACd,UACA,aAAyB,IAAE;AAErB,UAAA,cAAc,MAAM,eAAe,QAAQ;AACjD,UAAM,QAAQ,IACb,WAAW,IAAI,OAAO,cAAa;AAClC,YAAM,YAAY,MAAM,cAAc,aAAa,SAAS;AAE5D,aAAO,aAAa,OAAO,UAAU,WAAW,SAAS;AAAA,IACzD,CAAA,CAAC;AAAA,EAEJ;AAOe,iBAAA,kBAAkB,cAA4B,IAAE;AACxD,UAAA,gBAAgB,eAAe,WAAW;AAAA,EACjD;AAOe,iBAAA,aAAa,SAAwB,IAAE;AAC/C,UAAA,gBAAgB,UAAU,MAAM;AAAA,EACvC;AAEO,SAAA;AAAA,IACN;AAAA,IACA;AAAA,EAAA;AAEF;"}
+{"version":3,"file":"customTypesApi.js","sources":["../../../src/clients/customTypesApi.ts"],"sourcesContent":["import isEqual from \"lodash.isequal\";\n\nimport {\n\tCustomType,\n\tSharedSlice,\n} from \"@prismicio/types-internal/lib/customtypes\";\n\nimport { logPlaywrightApiResponse, logger } from \"../utils/log\";\n\nimport { AuthServerToken, AuthenticatedApiClient } from \"./apiClient\";\n\ntype ItemType = CustomType | SharedSlice;\ntype ItemTypePath = \"customtypes\" | \"slices\";\ntype ItemOperation = \"insert\" | \"update\";\n\n/**\n * Client for interacting with the Custom Types API to create/update custom\n * types and slices.\n */\nexport class CustomTypesApiClient extends AuthenticatedApiClient {\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 * Create or update a custom type or slice.\n\t *\n\t * @param endpoint - - The API endpoint for custom types or slices\n\t *   ('customtypes' or 'slices').\n\t * @param data - - The data representing the custom type or slice.\n\t *\n\t * @throws Error if the item status cannot be retrieved or the item cannot be\n\t *   created/updated.\n\t */\n\tprivate async upsert(\n\t\tendpoint: ItemTypePath,\n\t\toperation: ItemOperation,\n\t\tdata: ItemType,\n\t) {\n\t\tconst profiler = logger.startTimer();\n\t\tconst path = `${endpoint}/${operation}`;\n\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.post(path, { data });\n\t\tif (!result.ok()) {\n\t\t\tlogPlaywrightApiResponse(result);\n\t\t\tthrow new Error(`Could not ${operation} item`);\n\t\t}\n\t\tprofiler.done({\n\t\t\tmessage: `called customtypes api /${path} for item with id '${data.id}'`,\n\t\t});\n\t}\n\n\tprivate async getRemoteItems(\n\t\tendpoint: ItemTypePath,\n\t): Promise<CustomType[] | SharedSlice[]> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.get(endpoint);\n\n\t\tif (!result.ok()) {\n\t\t\tlogPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not get items status from the Custom Type api.\");\n\t\t}\n\n\t\treturn result.json();\n\t}\n\n\tprivate async getDifference(\n\t\tremoteItems: CustomType[] | SharedSlice[],\n\t\tlocal: ItemType,\n\t): Promise<ItemOperation | undefined> {\n\t\tconst remoteItem = remoteItems.find(\n\t\t\t(remote: CustomType | SharedSlice) => remote.id === local.id,\n\t\t);\n\t\tif (!remoteItem) {\n\t\t\treturn \"insert\";\n\t\t}\n\t\tif (!isEqual(local, remoteItem)) {\n\t\t\treturn \"update\";\n\t\t}\n\n\t\treturn;\n\t}\n\n\t/** Create items only if they have changed compared to their remote status */\n\tprivate async upsertIfChanged(\n\t\titemType: ItemTypePath,\n\t\tlocalItems: ItemType[] = [],\n\t): Promise<void> {\n\t\tconst remoteItems = await this.getRemoteItems(itemType);\n\t\tawait Promise.all(\n\t\t\tlocalItems.map(async (localItem) => {\n\t\t\t\tconst operation = await this.getDifference(remoteItems, localItem);\n\n\t\t\t\treturn operation && this.upsert(itemType, operation, localItem);\n\t\t\t}),\n\t\t);\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.upsertIfChanged(\"customtypes\", 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.upsertIfChanged(\"slices\", slices);\n\t}\n}\n"],"names":[],"mappings":";;;AAmBM,MAAO,6BAA6B,uBAAsB;AAAA,EAC/D,YACC,SACA,QAA0D;AAE1D,UAAM,SAAS,OAAO,WAAW,EAAE,YAAY,OAAO,YAAY;AAAA,EACnE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYQ,MAAM,OACb,UACA,WACA,MAAc;AAER,UAAA,WAAW,OAAO;AACxB,UAAM,OAAO,GAAG,QAAQ,IAAI,SAAS;AAE/B,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,KAAK,MAAM,EAAE,MAAM;AAC5C,QAAA,CAAC,OAAO,MAAM;AACjB,+BAAyB,MAAM;AAC/B,YAAM,IAAI,MAAM,aAAa,SAAS,OAAO;AAAA,IAC9C;AACA,aAAS,KAAK;AAAA,MACb,SAAS,2BAA2B,IAAI,sBAAsB,KAAK,EAAE;AAAA,IAAA,CACrE;AAAA,EACF;AAAA,EAEQ,MAAM,eACb,UAAsB;AAEhB,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,IAAI,QAAQ;AAErC,QAAA,CAAC,OAAO,MAAM;AACjB,+BAAyB,MAAM;AACzB,YAAA,IAAI,MAAM,sDAAsD;AAAA,IACvE;AAEA,WAAO,OAAO;EACf;AAAA,EAEQ,MAAM,cACb,aACA,OAAe;AAET,UAAA,aAAa,YAAY,KAC9B,CAAC,WAAqC,OAAO,OAAO,MAAM,EAAE;AAE7D,QAAI,CAAC,YAAY;AACT,aAAA;AAAA,IACR;AACA,QAAI,CAAC,QAAQ,OAAO,UAAU,GAAG;AACzB,aAAA;AAAA,IACR;AAEA;AAAA,EACD;AAAA;AAAA,EAGQ,MAAM,gBACb,UACA,aAAyB,IAAE;AAE3B,UAAM,cAAc,MAAM,KAAK,eAAe,QAAQ;AACtD,UAAM,QAAQ,IACb,WAAW,IAAI,OAAO,cAAa;AAClC,YAAM,YAAY,MAAM,KAAK,cAAc,aAAa,SAAS;AAEjE,aAAO,aAAa,KAAK,OAAO,UAAU,WAAW,SAAS;AAAA,IAC9D,CAAA,CAAC;AAAA,EAEJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,kBAAkB,cAA4B,IAAE;AAC/C,UAAA,KAAK,gBAAgB,eAAe,WAAW;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAAa,SAAwB,IAAE;AACtC,UAAA,KAAK,gBAAgB,UAAU,MAAM;AAAA,EAC5C;AACA;"}

package/dist/clients/migrationApi.cjs

@@ -1,36 +1,37 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const axios = require("axios");
 const log = require("../utils/log.cjs");
-const createMigrationApiClient = (baseURL, repository, authClient) => {
-  const client = axios.create({
-    baseURL,
-    headers: {
-      repository
-    },
-    validateStatus: () => true
-    // Don't throw on 4XX errors
-  });
-  client.interceptors.request.use(async (config) => {
-    const auth = "Authorization";
-    if (!config.headers[auth]) {
-      const token = await authClient.getToken();
-      config.headers[auth] = `Bearer ${token}`;
-    }
-    config.headers["repository"] = repository;
-    return config;
-  });
-  async function createDocument(data) {
-    const result = await client.post("/documents", data);
-    if (201 !== result.status) {
-      log.logHttpResponse(result);
+const apiClient = require("./apiClient.cjs");
+class MigrationApiClient extends apiClient.AuthenticatedApiClient {
+  /**
+   * @example To instantiate the class:
+   *
+   * ```js
+   * new MigrationApiClient("https://migration.prismic.io", {
+   * 	authToken: "my-secret-token",
+   * 	repository: "my-repo-name",
+   * });
+   * ```
+   *
+   * @param baseURL - the api base URL like https://migration.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 });
+  }
+  async createDocument(data) {
+    const context = await this.getContext();
+    const result = await context.post("documents", { data });
+    if (201 !== result.status()) {
+      await log.logPlaywrightApiResponse(result);
       throw new Error("Could not create a document with the migration api.");
     }
-    return result.data;
+    return result.json();
   }
-  return {
-    createDocument
-  };
-};
-exports.createMigrationApiClient = createMigrationApiClient;
+}
+exports.MigrationApiClient = MigrationApiClient;
 //# sourceMappingURL=migrationApi.cjs.map

package/dist/clients/migrationApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"migrationApi.cjs","sources":["../../../src/clients/migrationApi.ts"],"sourcesContent":["import axios, { AxiosInstance } from \"axios\";\n\nimport { logHttpResponse } from \"../utils/log\";\n\nimport { AuthenticationClient } from \"./authenticationApi\";\n\nexport type MigrationClient = {\n\tcreateDocument(data: DocumentPayload): Promise<DocumentResponse>;\n};\n\nexport type DocumentPayload = {\n\tuid?: string | null;\n\tlang: string;\n\ttitle: string;\n\ttags?: string[];\n\talternate_language_id?: string;\n\tdata: Record<string, unknown>;\n};\n\nexport type DocumentResponse = {\n\tid: string;\n\ttype: string;\n\tlang: string;\n\ttitle: string;\n\tuid?: string;\n};\n\nexport const createMigrationApiClient = (\n\tbaseURL: string,\n\trepository: string,\n\tauthClient: AuthenticationClient,\n): MigrationClient => {\n\tconst client: AxiosInstance = axios.create({\n\t\tbaseURL,\n\t\theaders: {\n\t\t\trepository,\n\t\t},\n\t\tvalidateStatus: () => true, // Don't throw on 4XX errors\n\t});\n\n\t// Add an interceptor to authenticate requests\n\tclient.interceptors.request.use(async (config) => {\n\t\tconst auth = \"Authorization\";\n\t\tif (!config.headers[auth]) {\n\t\t\tconst token = await authClient.getToken();\n\t\t\tconfig.headers[auth] = `Bearer ${token}`;\n\t\t}\n\t\tconfig.headers[\"repository\"] = repository;\n\n\t\treturn config;\n\t});\n\n\tasync function createDocument(\n\t\tdata: DocumentPayload,\n\t): Promise<DocumentResponse> {\n\t\tconst result = await client.post<DocumentResponse>(\"/documents\", data);\n\n\t\tif (201 !== result.status) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\"Could not create a document with the migration api.\");\n\t\t}\n\n\t\treturn result.data;\n\t}\n\n\treturn {\n\t\tcreateDocument,\n\t};\n};\n"],"names":["logHttpResponse"],"mappings":";;;;AA2BO,MAAM,2BAA2B,CACvC,SACA,YACA,eACoB;AACd,QAAA,SAAwB,MAAM,OAAO;AAAA,IAC1C;AAAA,IACA,SAAS;AAAA,MACR;AAAA,IACA;AAAA,IACD,gBAAgB,MAAM;AAAA;AAAA,EAAA,CACtB;AAGD,SAAO,aAAa,QAAQ,IAAI,OAAO,WAAU;AAChD,UAAM,OAAO;AACb,QAAI,CAAC,OAAO,QAAQ,IAAI,GAAG;AACpB,YAAA,QAAQ,MAAM,WAAW;AAC/B,aAAO,QAAQ,IAAI,IAAI,UAAU,KAAK;AAAA,IACvC;AACO,WAAA,QAAQ,YAAY,IAAI;AAExB,WAAA;AAAA,EAAA,CACP;AAED,iBAAe,eACd,MAAqB;AAErB,UAAM,SAAS,MAAM,OAAO,KAAuB,cAAc,IAAI;AAEjE,QAAA,QAAQ,OAAO,QAAQ;AAC1BA,UAAA,gBAAgB,MAAM;AAChB,YAAA,IAAI,MAAM,qDAAqD;AAAA,IACtE;AAEA,WAAO,OAAO;AAAA,EACf;AAEO,SAAA;AAAA,IACN;AAAA,EAAA;AAEF;;"}
+{"version":3,"file":"migrationApi.cjs","sources":["../../../src/clients/migrationApi.ts"],"sourcesContent":["import { logPlaywrightApiResponse } from \"../utils/log\";\n\nimport { AuthServerToken, AuthenticatedApiClient } from \"./apiClient\";\n\nexport type DocumentPayload = {\n\tuid?: string | null;\n\ttype: string;\n\tlang: string;\n\ttitle: string;\n\ttags?: string[];\n\talternate_language_id?: string;\n\tdata: Record<string, unknown>;\n\t// if true, the document will be part of the documents list instead of in the migration release\n\tinDocuments?: boolean;\n};\nexport type DocumentResponse = {\n\tid: string;\n\ttype: string;\n\tlang: string;\n\ttitle: string;\n\tuid?: string;\n};\n\nexport class MigrationApiClient extends AuthenticatedApiClient {\n\t/**\n\t * @example To instantiate the class:\n\t *\n\t * ```js\n\t * new MigrationApiClient(\"https://migration.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 like https://migration.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\tasync createDocument(data: DocumentPayload): Promise<DocumentResponse> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.post(\"documents\", { data });\n\n\t\tif (201 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not create a document with the migration api.\");\n\t\t}\n\n\t\treturn result.json();\n\t}\n}\n"],"names":["AuthenticatedApiClient","logPlaywrightApiResponse"],"mappings":";;;;AAuBM,MAAO,2BAA2BA,UAAAA,uBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkB7D,YACC,SACA,QAA0D;AAE1D,UAAM,SAAS,OAAO,WAAW,EAAE,YAAY,OAAO,YAAY;AAAA,EACnE;AAAA,EAEA,MAAM,eAAe,MAAqB;AACnC,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,KAAK,aAAa,EAAE,MAAM;AAEnD,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAMC,IAAAA,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,qDAAqD;AAAA,IACtE;AAEA,WAAO,OAAO;EACf;AACA;;"}

package/dist/clients/migrationApi.d.ts

@@ -1,14 +1,13 @@
-import { AuthenticationClient } from "./authenticationApi";
-export type MigrationClient = {
-    createDocument(data: DocumentPayload): Promise<DocumentResponse>;
-};
+import { AuthServerToken, AuthenticatedApiClient } from "./apiClient";
 export type DocumentPayload = {
     uid?: string | null;
+    type: string;
     lang: string;
     title: string;
     tags?: string[];
     alternate_language_id?: string;
     data: Record<string, unknown>;
+    inDocuments?: boolean;
 };
 export type DocumentResponse = {
     id: string;
@@ -17,4 +16,27 @@ export type DocumentResponse = {
     title: string;
     uid?: string;
 };
-export declare const createMigrationApiClient: (baseURL: string, repository: string, authClient: AuthenticationClient) => MigrationClient;
+export declare class MigrationApiClient extends AuthenticatedApiClient {
+    /**
+     * @example To instantiate the class:
+     *
+     * ```js
+     * new MigrationApiClient("https://migration.prismic.io", {
+     * 	authToken: "my-secret-token",
+     * 	repository: "my-repo-name",
+     * });
+     * ```
+     *
+     * @param baseURL - the api base URL like https://migration.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;
+    });
+    createDocument(data: DocumentPayload): Promise<DocumentResponse>;
+}

package/dist/clients/migrationApi.js

@@ -1,36 +1,37 @@
-import axios from "axios";
-import { logHttpResponse } from "../utils/log.js";
-const createMigrationApiClient = (baseURL, repository, authClient) => {
-  const client = axios.create({
-    baseURL,
-    headers: {
-      repository
-    },
-    validateStatus: () => true
-    // Don't throw on 4XX errors
-  });
-  client.interceptors.request.use(async (config) => {
-    const auth = "Authorization";
-    if (!config.headers[auth]) {
-      const token = await authClient.getToken();
-      config.headers[auth] = `Bearer ${token}`;
-    }
-    config.headers["repository"] = repository;
-    return config;
-  });
-  async function createDocument(data) {
-    const result = await client.post("/documents", data);
-    if (201 !== result.status) {
-      logHttpResponse(result);
+import { logPlaywrightApiResponse } from "../utils/log.js";
+import { AuthenticatedApiClient } from "./apiClient.js";
+class MigrationApiClient extends AuthenticatedApiClient {
+  /**
+   * @example To instantiate the class:
+   *
+   * ```js
+   * new MigrationApiClient("https://migration.prismic.io", {
+   * 	authToken: "my-secret-token",
+   * 	repository: "my-repo-name",
+   * });
+   * ```
+   *
+   * @param baseURL - the api base URL like https://migration.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 });
+  }
+  async createDocument(data) {
+    const context = await this.getContext();
+    const result = await context.post("documents", { data });
+    if (201 !== result.status()) {
+      await logPlaywrightApiResponse(result);
       throw new Error("Could not create a document with the migration api.");
     }
-    return result.data;
+    return result.json();
   }
-  return {
-    createDocument
-  };
-};
+}
 export {
-  createMigrationApiClient
+  MigrationApiClient
 };
 //# sourceMappingURL=migrationApi.js.map

package/dist/clients/migrationApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"migrationApi.js","sources":["../../../src/clients/migrationApi.ts"],"sourcesContent":["import axios, { AxiosInstance } from \"axios\";\n\nimport { logHttpResponse } from \"../utils/log\";\n\nimport { AuthenticationClient } from \"./authenticationApi\";\n\nexport type MigrationClient = {\n\tcreateDocument(data: DocumentPayload): Promise<DocumentResponse>;\n};\n\nexport type DocumentPayload = {\n\tuid?: string | null;\n\tlang: string;\n\ttitle: string;\n\ttags?: string[];\n\talternate_language_id?: string;\n\tdata: Record<string, unknown>;\n};\n\nexport type DocumentResponse = {\n\tid: string;\n\ttype: string;\n\tlang: string;\n\ttitle: string;\n\tuid?: string;\n};\n\nexport const createMigrationApiClient = (\n\tbaseURL: string,\n\trepository: string,\n\tauthClient: AuthenticationClient,\n): MigrationClient => {\n\tconst client: AxiosInstance = axios.create({\n\t\tbaseURL,\n\t\theaders: {\n\t\t\trepository,\n\t\t},\n\t\tvalidateStatus: () => true, // Don't throw on 4XX errors\n\t});\n\n\t// Add an interceptor to authenticate requests\n\tclient.interceptors.request.use(async (config) => {\n\t\tconst auth = \"Authorization\";\n\t\tif (!config.headers[auth]) {\n\t\t\tconst token = await authClient.getToken();\n\t\t\tconfig.headers[auth] = `Bearer ${token}`;\n\t\t}\n\t\tconfig.headers[\"repository\"] = repository;\n\n\t\treturn config;\n\t});\n\n\tasync function createDocument(\n\t\tdata: DocumentPayload,\n\t): Promise<DocumentResponse> {\n\t\tconst result = await client.post<DocumentResponse>(\"/documents\", data);\n\n\t\tif (201 !== result.status) {\n\t\t\tlogHttpResponse(result);\n\t\t\tthrow new Error(\"Could not create a document with the migration api.\");\n\t\t}\n\n\t\treturn result.data;\n\t}\n\n\treturn {\n\t\tcreateDocument,\n\t};\n};\n"],"names":[],"mappings":";;AA2BO,MAAM,2BAA2B,CACvC,SACA,YACA,eACoB;AACd,QAAA,SAAwB,MAAM,OAAO;AAAA,IAC1C;AAAA,IACA,SAAS;AAAA,MACR;AAAA,IACA;AAAA,IACD,gBAAgB,MAAM;AAAA;AAAA,EAAA,CACtB;AAGD,SAAO,aAAa,QAAQ,IAAI,OAAO,WAAU;AAChD,UAAM,OAAO;AACb,QAAI,CAAC,OAAO,QAAQ,IAAI,GAAG;AACpB,YAAA,QAAQ,MAAM,WAAW;AAC/B,aAAO,QAAQ,IAAI,IAAI,UAAU,KAAK;AAAA,IACvC;AACO,WAAA,QAAQ,YAAY,IAAI;AAExB,WAAA;AAAA,EAAA,CACP;AAED,iBAAe,eACd,MAAqB;AAErB,UAAM,SAAS,MAAM,OAAO,KAAuB,cAAc,IAAI;AAEjE,QAAA,QAAQ,OAAO,QAAQ;AAC1B,sBAAgB,MAAM;AAChB,YAAA,IAAI,MAAM,qDAAqD;AAAA,IACtE;AAEA,WAAO,OAAO;AAAA,EACf;AAEO,SAAA;AAAA,IACN;AAAA,EAAA;AAEF;"}
+{"version":3,"file":"migrationApi.js","sources":["../../../src/clients/migrationApi.ts"],"sourcesContent":["import { logPlaywrightApiResponse } from \"../utils/log\";\n\nimport { AuthServerToken, AuthenticatedApiClient } from \"./apiClient\";\n\nexport type DocumentPayload = {\n\tuid?: string | null;\n\ttype: string;\n\tlang: string;\n\ttitle: string;\n\ttags?: string[];\n\talternate_language_id?: string;\n\tdata: Record<string, unknown>;\n\t// if true, the document will be part of the documents list instead of in the migration release\n\tinDocuments?: boolean;\n};\nexport type DocumentResponse = {\n\tid: string;\n\ttype: string;\n\tlang: string;\n\ttitle: string;\n\tuid?: string;\n};\n\nexport class MigrationApiClient extends AuthenticatedApiClient {\n\t/**\n\t * @example To instantiate the class:\n\t *\n\t * ```js\n\t * new MigrationApiClient(\"https://migration.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 like https://migration.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\tasync createDocument(data: DocumentPayload): Promise<DocumentResponse> {\n\t\tconst context = await this.getContext();\n\t\tconst result = await context.post(\"documents\", { data });\n\n\t\tif (201 !== result.status()) {\n\t\t\tawait logPlaywrightApiResponse(result);\n\t\t\tthrow new Error(\"Could not create a document with the migration api.\");\n\t\t}\n\n\t\treturn result.json();\n\t}\n}\n"],"names":[],"mappings":";;AAuBM,MAAO,2BAA2B,uBAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkB7D,YACC,SACA,QAA0D;AAE1D,UAAM,SAAS,OAAO,WAAW,EAAE,YAAY,OAAO,YAAY;AAAA,EACnE;AAAA,EAEA,MAAM,eAAe,MAAqB;AACnC,UAAA,UAAU,MAAM,KAAK;AAC3B,UAAM,SAAS,MAAM,QAAQ,KAAK,aAAa,EAAE,MAAM;AAEnD,QAAA,QAAQ,OAAO,UAAU;AAC5B,YAAM,yBAAyB,MAAM;AAC/B,YAAA,IAAI,MAAM,qDAAqD;AAAA,IACtE;AAEA,WAAO,OAAO;EACf;AACA;"}

package/dist/index.cjs

@@ -8,5 +8,5 @@ exports.RepositoriesManager = repositories.RepositoriesManager;
 exports.createRepositoriesManager = repositories.createRepositoriesManager;
 exports.RepositoryManager = repository.RepositoryManager;
 exports.ContentApiClient = contentApi.ContentApiClient;
-exports.createMigrationApiClient = migrationApi.createMigrationApiClient;
+exports.MigrationApiClient = migrationApi.MigrationApiClient;
 //# sourceMappingURL=index.cjs.map

package/dist/index.js

@@ -1,12 +1,12 @@
 import { RepositoriesManager, createRepositoriesManager } from "./managers/repositories.js";
 import { RepositoryManager } from "./managers/repository.js";
 import { ContentApiClient } from "./clients/contentApi.js";
-import { createMigrationApiClient } from "./clients/migrationApi.js";
+import { MigrationApiClient } from "./clients/migrationApi.js";
 export {
   ContentApiClient,
+  MigrationApiClient,
   RepositoriesManager,
   RepositoryManager,
-  createMigrationApiClient,
   createRepositoriesManager
 };
 //# sourceMappingURL=index.js.map

package/dist/managers/repositories.cjs

@@ -42,7 +42,7 @@ class RepositoriesManager {
       urlConfig: typeof configuration.urlConfig === "string" ? this.inferUrls(configuration.urlConfig) : configuration.urlConfig
     };
     this.wroomClient = new wroom.WroomClient(this.config.urlConfig.baseURL, this.config.authConfig);
-    this.authClient = authenticationApi.createAuthenticationApiClient(this.config.urlConfig.authenticationApi, this.config.authConfig);
+    this.authClient = new authenticationApi.AuthenticationApiClient(this.config.urlConfig.authenticationApi, this.config.authConfig);
     this.manageV2Client = new manageV2.ManageV2Client(this.config.urlConfig.baseURL, this.config.manageV2Config);
   }
   /**
@@ -90,8 +90,11 @@ class RepositoriesManager {
       throw new Error(`Could not create repository ${repositoryName}`);
     }
     this.repositories.add(repositoryName);
-    profiler.done({ message: `created repository '${repositoryName}'` });
     const repository2 = this.getRepositoryManager(repositoryName);
+    const version = await repository2.getDeployedVersion();
+    profiler.done({
+      message: `created repository '${repositoryName}', Wroom version is "${version}"`
+    });
     await repository2.configure(config);
     return repository2;
   }
@@ -132,15 +135,22 @@ class RepositoriesManager {
   /**
    * Return a repository utilities object for a repository.
    *
-   * @param name - The name of the repository.
+   * @param repository - The name of the repository.
    */
-  getRepositoryManager(name) {
+  getRepositoryManager(repository$1) {
     const { urlConfig } = this.config;
-    const customTypeClient = customTypesApi.createCustomTypesApiClient(urlConfig.customTypesApi, name, this.authClient);
-    const coreApiUrl = urls.getRepositoryUrl(urlConfig.baseURL, name);
-    const coreApiClient = coreApi.createCoreApiClient(coreApiUrl, this.authClient);
-    const migrationApiClient = urlConfig.migrationApi ? migrationApi.createMigrationApiClient(urlConfig.migrationApi, name, this.authClient) : void 0;
-    return new repository.RepositoryManager(name, coreApiClient, this.authClient, this.wroomClient, customTypeClient, migrationApiClient, this.manageV2Client);
+    const authToken = () => this.authClient.getToken();
+    const customTypeClient = new customTypesApi.CustomTypesApiClient(urlConfig.customTypesApi, {
+      authToken,
+      repository: repository$1
+    });
+    const coreApiUrl = urls.getRepositoryUrl(urlConfig.baseURL, repository$1);
+    const coreApiClient = new coreApi.CoreApiClient(coreApiUrl, authToken);
+    const migrationApiClient = urlConfig.migrationApi ? new migrationApi.MigrationApiClient(urlConfig.migrationApi, {
+      authToken,
+      repository: repository$1
+    }) : void 0;
+    return new repository.RepositoryManager(repository$1, coreApiClient, this.authClient, this.wroomClient, customTypeClient, migrationApiClient, this.manageV2Client);
   }
 }
 exports.RepositoriesManager = RepositoriesManager;

package/dist/managers/repositories.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"repositories.cjs","sources":["../../../src/managers/repositories.ts"],"sourcesContent":["import { SetupConfiguration, UrlConfig } from \"../types\";\n\nimport {\n\tAuthenticationClient,\n\tcreateAuthenticationApiClient,\n} from \"../clients/authenticationApi\";\nimport { createCoreApiClient } from \"../clients/coreApi\";\nimport { createCustomTypesApiClient } from \"../clients/customTypesApi\";\nimport { ManageV2Client } from \"../clients/manageV2\";\nimport { createMigrationApiClient } from \"../clients/migrationApi\";\nimport { WroomClient } from \"../clients/wroom\";\nimport { EnvVariableManager } from \"../utils/envVariableManager\";\nimport { logHttpResponse, logger } from \"../utils/log\";\nimport { randomString } from \"../utils/random\";\nimport { getRepositoryUrl } from \"../utils/urls\";\n\nimport { RepositoryConfig, RepositoryManager } from \"./repository\";\n\n/**\n * Factory method to create a RepositoriesManager to manage repositories test\n * data.\n *\n * @param configuration - Global object containing the different configurations\n *   required to setup the RepositoriesManager.\n *\n *       - {@link configuration.urlConfig}: Configuration around the API's URLs management.\n *       - {@link configuration.authConfig}: Configuration around the authentication of a user.\n *       - {@link configuration.manageV2Config}: Optional Configuration used to make calls to ManageV2.\n *\n * @returns An instance of {@link RepositoriesManager} to manage test data.\n */\nexport const createRepositoriesManager = (\n\tconfiguration: SetupConfiguration,\n): RepositoriesManager => {\n\treturn new RepositoriesManager(configuration);\n};\n\n/** Utility object to manage Prismic test data */\nexport class RepositoriesManager {\n\tprivate readonly config: Omit<SetupConfiguration, \"urlConfig\"> & {\n\t\turlConfig: UrlConfig;\n\t};\n\tprivate readonly wroomClient: WroomClient;\n\tprivate readonly authClient: AuthenticationClient;\n\tprivate readonly manageV2Client: ManageV2Client;\n\t/**\n\t * helper to keep track of repositories across independent test phases (setup,\n\t * teardown)\n\t */\n\tprivate readonly repositories = new EnvVariableManager(\n\t\t\"_PRISMIC_E2E_TESTS_REPOS\",\n\t);\n\n\t/**\n\t * @param configuration - Global object containing the different configuration\n\t *   required to setup the different clients.\n\t * @param credentials - Authentication credentials (email and password)\n\t */\n\tconstructor(configuration: SetupConfiguration) {\n\t\tthis.config = {\n\t\t\t...configuration,\n\t\t\t// When a string is provided, treat it as the 'base' property\n\t\t\turlConfig:\n\t\t\t\ttypeof configuration.urlConfig === \"string\"\n\t\t\t\t\t? this.inferUrls(configuration.urlConfig)\n\t\t\t\t\t: configuration.urlConfig,\n\t\t};\n\n\t\tthis.wroomClient = new WroomClient(\n\t\t\tthis.config.urlConfig.baseURL,\n\t\t\tthis.config.authConfig,\n\t\t);\n\t\tthis.authClient = createAuthenticationApiClient(\n\t\t\tthis.config.urlConfig.authenticationApi,\n\t\t\tthis.config.authConfig,\n\t\t);\n\t\tthis.manageV2Client = new ManageV2Client(\n\t\t\tthis.config.urlConfig.baseURL,\n\t\t\tthis.config.manageV2Config,\n\t\t);\n\t}\n\n\t/**\n\t * If the baseURL is prismic.io, assume the other services have the format\n\t * <name>.prismic.io\n\t */\n\tprivate inferUrls(baseURL: string): UrlConfig {\n\t\tconst url = new URL(baseURL);\n\t\tconst protocol = url.protocol.slice(0, -1); // Remove the trailing colon from the protocol\n\n\t\treturn {\n\t\t\tbaseURL: baseURL,\n\t\t\tauthenticationApi: `${protocol}://auth.${url.hostname}`,\n\t\t\tcustomTypesApi: `${protocol}://customtypes.${url.hostname}`,\n\t\t\tmigrationApi: `${protocol}://migration.${url.hostname}`,\n\t\t};\n\t}\n\n\t/**\n\t * Generate a user token from the authentication service.\n\t *\n\t * @returns a JWT token\n\t */\n\tasync getUserApiToken(): Promise<string> {\n\t\treturn this.authClient.getToken();\n\t}\n\n\t/**\n\t * Create a new repository in Wroom.\n\t *\n\t * @param repositoryName - The name of the repository.\n\t *\n\t * @throws Error if the repository creation fails.\n\t */\n\tasync createRepository(\n\t\tconfig: {\n\t\t\tprefix?: string;\n\t\t} & RepositoryConfig = {},\n\t): Promise<RepositoryManager> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst { prefix = \"e2e-tests\" } = config;\n\t\tconst repositoryName = `${prefix}-${randomString()}`;\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tnull,\n\t\t\t\"authentication/newrepository\",\n\t\t\t{\n\t\t\t\tdomain: repositoryName,\n\t\t\t\tframework: \"vue\",\n\t\t\t\tplan: \"personal\",\n\t\t\t\tisAnnual: \"false\",\n\t\t\t\trole: \"developer\",\n\t\t\t},\n\t\t);\n\t\tif (response.status !== 200) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(`Could not create repository ${repositoryName}`);\n\t\t}\n\t\tthis.repositories.add(repositoryName);\n\n\t\tprofiler.done({ message: `created repository '${repositoryName}'` });\n\n\t\tconst repository = this.getRepositoryManager(repositoryName);\n\t\tawait repository.configure(config);\n\n\t\treturn repository;\n\t}\n\n\t/**\n\t * Delete a repository from Wroom.\n\t *\n\t * @param repository - The name of the repository.\n\t *\n\t * @throws Error if the repository deletion fails.\n\t */\n\tasync deleteRepository(repository: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst post = async () =>\n\t\t\tthis.wroomClient.post(repository, \"app/settings/delete\", {\n\t\t\t\tconfirm: repository,\n\t\t\t\tpassword: this.config.authConfig.password,\n\t\t\t});\n\t\tconst response = await post();\n\t\tif (response.status !== 200) {\n\t\t\t// sometimes the deletion returns 500 but actually succeeds\n\t\t\t// we run the query again and check the repo is actually deleted (404)\n\t\t\tconst retry = await post();\n\t\t\tif (retry.status !== 404) {\n\t\t\t\tlogHttpResponse(response);\n\t\t\t\tthrow new Error(`Could not delete repository ${repository}`);\n\t\t\t}\n\t\t}\n\t\tthis.repositories.remove(repository);\n\t\tprofiler.done({ message: `deleted repository '${repository}'` });\n\t}\n\n\t/**\n\t * Cleanup test data. For example, it deletes repositories created using\n\t * createRepository()\n\t */\n\tasync tearDown(): Promise<void> {\n\t\tconst repositories = this.repositories.getAll();\n\t\tfor (const repository of repositories) {\n\t\t\tawait this.deleteRepository(repository);\n\t\t}\n\t}\n\n\t/**\n\t * Return a repository utilities object for a repository.\n\t *\n\t * @param name - The name of the repository.\n\t */\n\tgetRepositoryManager(name: string): RepositoryManager {\n\t\tconst { urlConfig } = this.config;\n\t\tconst customTypeClient = createCustomTypesApiClient(\n\t\t\turlConfig.customTypesApi,\n\t\t\tname,\n\t\t\tthis.authClient,\n\t\t);\n\t\tconst coreApiUrl = getRepositoryUrl(urlConfig.baseURL, name);\n\t\tconst coreApiClient = createCoreApiClient(coreApiUrl, this.authClient);\n\t\tconst migrationApiClient = urlConfig.migrationApi\n\t\t\t? createMigrationApiClient(urlConfig.migrationApi, name, this.authClient)\n\t\t\t: undefined;\n\n\t\treturn new RepositoryManager(\n\t\t\tname,\n\t\t\tcoreApiClient,\n\t\t\tthis.authClient,\n\t\t\tthis.wroomClient,\n\t\t\tcustomTypeClient,\n\t\t\tmigrationApiClient,\n\t\t\tthis.manageV2Client,\n\t\t);\n\t}\n}\n"],"names":["EnvVariableManager","WroomClient","createAuthenticationApiClient","ManageV2Client","logger","randomString","logHttpResponse","repository","createCustomTypesApiClient","getRepositoryUrl","createCoreApiClient","createMigrationApiClient","RepositoryManager"],"mappings":";;;;;;;;;;;;;;;;;;;AA+Ba,MAAA,4BAA4B,CACxC,kBACwB;AACjB,SAAA,IAAI,oBAAoB,aAAa;AAC7C;MAGa,oBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB/B,YAAY,eAAiC;AAnB5B;AAGA;AACA;AACA;AAKA;AAAA;AAAA;AAAA;AAAA,wCAAe,IAAIA,sCACnC,0BAA0B;AAS1B,SAAK,SAAS;AAAA,MACb,GAAG;AAAA;AAAA,MAEH,WACC,OAAO,cAAc,cAAc,WAChC,KAAK,UAAU,cAAc,SAAS,IACtC,cAAc;AAAA,IAAA;AAGd,SAAA,cAAc,IAAIC,MACtB,YAAA,KAAK,OAAO,UAAU,SACtB,KAAK,OAAO,UAAU;AAElB,SAAA,aAAaC,gDACjB,KAAK,OAAO,UAAU,mBACtB,KAAK,OAAO,UAAU;AAElB,SAAA,iBAAiB,IAAIC,SACzB,eAAA,KAAK,OAAO,UAAU,SACtB,KAAK,OAAO,cAAc;AAAA,EAE5B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,UAAU,SAAe;AAC1B,UAAA,MAAM,IAAI,IAAI,OAAO;AAC3B,UAAM,WAAW,IAAI,SAAS,MAAM,GAAG,EAAE;AAElC,WAAA;AAAA,MACN;AAAA,MACA,mBAAmB,GAAG,QAAQ,WAAW,IAAI,QAAQ;AAAA,MACrD,gBAAgB,GAAG,QAAQ,kBAAkB,IAAI,QAAQ;AAAA,MACzD,cAAc,GAAG,QAAQ,gBAAgB,IAAI,QAAQ;AAAA,IAAA;AAAA,EAEvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,kBAAe;AACb,WAAA,KAAK,WAAW;EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,iBACL,SAEuB,IAAE;AAEnB,UAAA,WAAWC,WAAO;AAElB,UAAA,EAAE,SAAS,YAAgB,IAAA;AACjC,UAAM,iBAAiB,GAAG,MAAM,IAAIC,OAAAA,aAAc,CAAA;AAElD,UAAM,WAAW,MAAM,KAAK,YAAY,KACvC,MACA,gCACA;AAAA,MACC,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,MAAM;AAAA,MACN,UAAU;AAAA,MACV,MAAM;AAAA,IAAA,CACN;AAEE,QAAA,SAAS,WAAW,KAAK;AAC5BC,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,+BAA+B,cAAc,EAAE;AAAA,IAChE;AACK,SAAA,aAAa,IAAI,cAAc;AAEpC,aAAS,KAAK,EAAE,SAAS,uBAAuB,cAAc,KAAK;AAE7D,UAAAC,cAAa,KAAK,qBAAqB,cAAc;AACrD,UAAAA,YAAW,UAAU,MAAM;AAE1B,WAAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,iBAAiBA,aAAkB;AAClC,UAAA,WAAWH,WAAO;AAExB,UAAM,OAAO,YACZ,KAAK,YAAY,KAAKG,aAAY,uBAAuB;AAAA,MACxD,SAASA;AAAA,MACT,UAAU,KAAK,OAAO,WAAW;AAAA,IAAA,CACjC;AACI,UAAA,WAAW,MAAM;AACnB,QAAA,SAAS,WAAW,KAAK;AAGtB,YAAA,QAAQ,MAAM;AAChB,UAAA,MAAM,WAAW,KAAK;AACzBD,YAAA,gBAAgB,QAAQ;AACxB,cAAM,IAAI,MAAM,+BAA+BC,WAAU,EAAE;AAAA,MAC5D;AAAA,IACD;AACK,SAAA,aAAa,OAAOA,WAAU;AACnC,aAAS,KAAK,EAAE,SAAS,uBAAuBA,WAAU,KAAK;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,WAAQ;AACP,UAAA,eAAe,KAAK,aAAa;AACvC,eAAWA,eAAc,cAAc;AAChC,YAAA,KAAK,iBAAiBA,WAAU;AAAA,IACvC;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,qBAAqB,MAAY;AAC1B,UAAA,EAAE,UAAS,IAAK,KAAK;AAC3B,UAAM,mBAAmBC,eAAAA,2BACxB,UAAU,gBACV,MACA,KAAK,UAAU;AAEhB,UAAM,aAAaC,KAAA,iBAAiB,UAAU,SAAS,IAAI;AAC3D,UAAM,gBAAgBC,QAAA,oBAAoB,YAAY,KAAK,UAAU;AAC/D,UAAA,qBAAqB,UAAU,eAClCC,aAAA,yBAAyB,UAAU,cAAc,MAAM,KAAK,UAAU,IACtE;AAEI,WAAA,IAAIC,WAAAA,kBACV,MACA,eACA,KAAK,YACL,KAAK,aACL,kBACA,oBACA,KAAK,cAAc;AAAA,EAErB;AACA;;;"}
+{"version":3,"file":"repositories.cjs","sources":["../../../src/managers/repositories.ts"],"sourcesContent":["import { SetupConfiguration, UrlConfig } from \"../types\";\n\nimport { AuthenticationApiClient } from \"../clients/authenticationApi\";\nimport { CoreApiClient } from \"../clients/coreApi\";\nimport { CustomTypesApiClient } from \"../clients/customTypesApi\";\nimport { ManageV2Client } from \"../clients/manageV2\";\nimport { MigrationApiClient } from \"../clients/migrationApi\";\nimport { WroomClient } from \"../clients/wroom\";\nimport { EnvVariableManager } from \"../utils/envVariableManager\";\nimport { logHttpResponse, logger } from \"../utils/log\";\nimport { randomString } from \"../utils/random\";\nimport { getRepositoryUrl } from \"../utils/urls\";\n\nimport { RepositoryConfig, RepositoryManager } from \"./repository\";\n\n/**\n * Factory method to create a RepositoriesManager to manage repositories test\n * data.\n *\n * @param configuration - Global object containing the different configurations\n *   required to setup the RepositoriesManager.\n *\n *       - {@link configuration.urlConfig}: Configuration around the API's URLs management.\n *       - {@link configuration.authConfig}: Configuration around the authentication of a user.\n *       - {@link configuration.manageV2Config}: Optional Configuration used to make calls to ManageV2.\n *\n * @returns An instance of {@link RepositoriesManager} to manage test data.\n */\nexport const createRepositoriesManager = (\n\tconfiguration: SetupConfiguration,\n): RepositoriesManager => {\n\treturn new RepositoriesManager(configuration);\n};\n\n/** Utility object to manage Prismic test data */\nexport class RepositoriesManager {\n\tprivate readonly config: Omit<SetupConfiguration, \"urlConfig\"> & {\n\t\turlConfig: UrlConfig;\n\t};\n\tprivate readonly wroomClient: WroomClient;\n\tprivate readonly authClient: AuthenticationApiClient;\n\tprivate readonly manageV2Client: ManageV2Client;\n\t/**\n\t * helper to keep track of repositories across independent test phases (setup,\n\t * teardown)\n\t */\n\tprivate readonly repositories = new EnvVariableManager(\n\t\t\"_PRISMIC_E2E_TESTS_REPOS\",\n\t);\n\n\t/**\n\t * @param configuration - Global object containing the different configuration\n\t *   required to setup the different clients.\n\t * @param credentials - Authentication credentials (email and password)\n\t */\n\tconstructor(configuration: SetupConfiguration) {\n\t\tthis.config = {\n\t\t\t...configuration,\n\t\t\t// When a string is provided, treat it as the 'base' property\n\t\t\turlConfig:\n\t\t\t\ttypeof configuration.urlConfig === \"string\"\n\t\t\t\t\t? this.inferUrls(configuration.urlConfig)\n\t\t\t\t\t: configuration.urlConfig,\n\t\t};\n\n\t\tthis.wroomClient = new WroomClient(\n\t\t\tthis.config.urlConfig.baseURL,\n\t\t\tthis.config.authConfig,\n\t\t);\n\t\tthis.authClient = new AuthenticationApiClient(\n\t\t\tthis.config.urlConfig.authenticationApi,\n\t\t\tthis.config.authConfig,\n\t\t);\n\t\tthis.manageV2Client = new ManageV2Client(\n\t\t\tthis.config.urlConfig.baseURL,\n\t\t\tthis.config.manageV2Config,\n\t\t);\n\t}\n\n\t/**\n\t * If the baseURL is prismic.io, assume the other services have the format\n\t * <name>.prismic.io\n\t */\n\tprivate inferUrls(baseURL: string): UrlConfig {\n\t\tconst url = new URL(baseURL);\n\t\tconst protocol = url.protocol.slice(0, -1); // Remove the trailing colon from the protocol\n\n\t\treturn {\n\t\t\tbaseURL: baseURL,\n\t\t\tauthenticationApi: `${protocol}://auth.${url.hostname}`,\n\t\t\tcustomTypesApi: `${protocol}://customtypes.${url.hostname}`,\n\t\t\tmigrationApi: `${protocol}://migration.${url.hostname}`,\n\t\t};\n\t}\n\n\t/**\n\t * Generate a user token from the authentication service.\n\t *\n\t * @returns a JWT token\n\t */\n\tasync getUserApiToken(): Promise<string> {\n\t\treturn this.authClient.getToken();\n\t}\n\n\t/**\n\t * Create a new repository in Wroom.\n\t *\n\t * @param repositoryName - The name of the repository.\n\t *\n\t * @throws Error if the repository creation fails.\n\t */\n\tasync createRepository(\n\t\tconfig: {\n\t\t\tprefix?: string;\n\t\t} & RepositoryConfig = {},\n\t): Promise<RepositoryManager> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst { prefix = \"e2e-tests\" } = config;\n\t\tconst repositoryName = `${prefix}-${randomString()}`;\n\n\t\tconst response = await this.wroomClient.post(\n\t\t\tnull,\n\t\t\t\"authentication/newrepository\",\n\t\t\t{\n\t\t\t\tdomain: repositoryName,\n\t\t\t\tframework: \"vue\",\n\t\t\t\tplan: \"personal\",\n\t\t\t\tisAnnual: \"false\",\n\t\t\t\trole: \"developer\",\n\t\t\t},\n\t\t);\n\t\tif (response.status !== 200) {\n\t\t\tlogHttpResponse(response);\n\t\t\tthrow new Error(`Could not create repository ${repositoryName}`);\n\t\t}\n\t\tthis.repositories.add(repositoryName);\n\n\t\tconst repository = this.getRepositoryManager(repositoryName);\n\t\tconst version = await repository.getDeployedVersion();\n\n\t\tprofiler.done({\n\t\t\tmessage: `created repository '${repositoryName}', Wroom version is \"${version}\"`,\n\t\t});\n\t\tawait repository.configure(config);\n\n\t\treturn repository;\n\t}\n\n\t/**\n\t * Delete a repository from Wroom.\n\t *\n\t * @param repository - The name of the repository.\n\t *\n\t * @throws Error if the repository deletion fails.\n\t */\n\tasync deleteRepository(repository: string): Promise<void> {\n\t\tconst profiler = logger.startTimer();\n\n\t\tconst post = async () =>\n\t\t\tthis.wroomClient.post(repository, \"app/settings/delete\", {\n\t\t\t\tconfirm: repository,\n\t\t\t\tpassword: this.config.authConfig.password,\n\t\t\t});\n\t\tconst response = await post();\n\t\tif (response.status !== 200) {\n\t\t\t// sometimes the deletion returns 500 but actually succeeds\n\t\t\t// we run the query again and check the repo is actually deleted (404)\n\t\t\tconst retry = await post();\n\t\t\tif (retry.status !== 404) {\n\t\t\t\tlogHttpResponse(response);\n\t\t\t\tthrow new Error(`Could not delete repository ${repository}`);\n\t\t\t}\n\t\t}\n\t\tthis.repositories.remove(repository);\n\t\tprofiler.done({ message: `deleted repository '${repository}'` });\n\t}\n\n\t/**\n\t * Cleanup test data. For example, it deletes repositories created using\n\t * createRepository()\n\t */\n\tasync tearDown(): Promise<void> {\n\t\tconst repositories = this.repositories.getAll();\n\t\tfor (const repository of repositories) {\n\t\t\tawait this.deleteRepository(repository);\n\t\t}\n\t}\n\n\t/**\n\t * Return a repository utilities object for a repository.\n\t *\n\t * @param repository - The name of the repository.\n\t */\n\tgetRepositoryManager(repository: string): RepositoryManager {\n\t\tconst { urlConfig } = this.config;\n\t\tconst authToken = () => this.authClient.getToken();\n\t\tconst customTypeClient = new CustomTypesApiClient(\n\t\t\turlConfig.customTypesApi,\n\t\t\t{\n\t\t\t\tauthToken,\n\t\t\t\trepository,\n\t\t\t},\n\t\t);\n\t\tconst coreApiUrl = getRepositoryUrl(urlConfig.baseURL, repository);\n\t\tconst coreApiClient = new CoreApiClient(coreApiUrl, authToken);\n\t\tconst migrationApiClient = urlConfig.migrationApi\n\t\t\t? new MigrationApiClient(urlConfig.migrationApi, {\n\t\t\t\t\tauthToken,\n\t\t\t\t\trepository,\n\t\t\t\t})\n\t\t\t: undefined;\n\n\t\treturn new RepositoryManager(\n\t\t\trepository,\n\t\t\tcoreApiClient,\n\t\t\tthis.authClient,\n\t\t\tthis.wroomClient,\n\t\t\tcustomTypeClient,\n\t\t\tmigrationApiClient,\n\t\t\tthis.manageV2Client,\n\t\t);\n\t}\n}\n"],"names":["EnvVariableManager","WroomClient","AuthenticationApiClient","ManageV2Client","logger","randomString","logHttpResponse","repository","CustomTypesApiClient","getRepositoryUrl","CoreApiClient","MigrationApiClient","RepositoryManager"],"mappings":";;;;;;;;;;;;;;;;;;;AA4Ba,MAAA,4BAA4B,CACxC,kBACwB;AACjB,SAAA,IAAI,oBAAoB,aAAa;AAC7C;MAGa,oBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB/B,YAAY,eAAiC;AAnB5B;AAGA;AACA;AACA;AAKA;AAAA;AAAA;AAAA;AAAA,wCAAe,IAAIA,sCACnC,0BAA0B;AAS1B,SAAK,SAAS;AAAA,MACb,GAAG;AAAA;AAAA,MAEH,WACC,OAAO,cAAc,cAAc,WAChC,KAAK,UAAU,cAAc,SAAS,IACtC,cAAc;AAAA,IAAA;AAGd,SAAA,cAAc,IAAIC,MACtB,YAAA,KAAK,OAAO,UAAU,SACtB,KAAK,OAAO,UAAU;AAElB,SAAA,aAAa,IAAIC,kBACrB,wBAAA,KAAK,OAAO,UAAU,mBACtB,KAAK,OAAO,UAAU;AAElB,SAAA,iBAAiB,IAAIC,SACzB,eAAA,KAAK,OAAO,UAAU,SACtB,KAAK,OAAO,cAAc;AAAA,EAE5B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,UAAU,SAAe;AAC1B,UAAA,MAAM,IAAI,IAAI,OAAO;AAC3B,UAAM,WAAW,IAAI,SAAS,MAAM,GAAG,EAAE;AAElC,WAAA;AAAA,MACN;AAAA,MACA,mBAAmB,GAAG,QAAQ,WAAW,IAAI,QAAQ;AAAA,MACrD,gBAAgB,GAAG,QAAQ,kBAAkB,IAAI,QAAQ;AAAA,MACzD,cAAc,GAAG,QAAQ,gBAAgB,IAAI,QAAQ;AAAA,IAAA;AAAA,EAEvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,kBAAe;AACb,WAAA,KAAK,WAAW;EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,iBACL,SAEuB,IAAE;AAEnB,UAAA,WAAWC,WAAO;AAElB,UAAA,EAAE,SAAS,YAAgB,IAAA;AACjC,UAAM,iBAAiB,GAAG,MAAM,IAAIC,OAAAA,aAAc,CAAA;AAElD,UAAM,WAAW,MAAM,KAAK,YAAY,KACvC,MACA,gCACA;AAAA,MACC,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,MAAM;AAAA,MACN,UAAU;AAAA,MACV,MAAM;AAAA,IAAA,CACN;AAEE,QAAA,SAAS,WAAW,KAAK;AAC5BC,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,+BAA+B,cAAc,EAAE;AAAA,IAChE;AACK,SAAA,aAAa,IAAI,cAAc;AAE9B,UAAAC,cAAa,KAAK,qBAAqB,cAAc;AACrD,UAAA,UAAU,MAAMA,YAAW;AAEjC,aAAS,KAAK;AAAA,MACb,SAAS,uBAAuB,cAAc,wBAAwB,OAAO;AAAA,IAAA,CAC7E;AACK,UAAAA,YAAW,UAAU,MAAM;AAE1B,WAAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,iBAAiBA,aAAkB;AAClC,UAAA,WAAWH,WAAO;AAExB,UAAM,OAAO,YACZ,KAAK,YAAY,KAAKG,aAAY,uBAAuB;AAAA,MACxD,SAASA;AAAA,MACT,UAAU,KAAK,OAAO,WAAW;AAAA,IAAA,CACjC;AACI,UAAA,WAAW,MAAM;AACnB,QAAA,SAAS,WAAW,KAAK;AAGtB,YAAA,QAAQ,MAAM;AAChB,UAAA,MAAM,WAAW,KAAK;AACzBD,YAAA,gBAAgB,QAAQ;AACxB,cAAM,IAAI,MAAM,+BAA+BC,WAAU,EAAE;AAAA,MAC5D;AAAA,IACD;AACK,SAAA,aAAa,OAAOA,WAAU;AACnC,aAAS,KAAK,EAAE,SAAS,uBAAuBA,WAAU,KAAK;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,WAAQ;AACP,UAAA,eAAe,KAAK,aAAa;AACvC,eAAWA,eAAc,cAAc;AAChC,YAAA,KAAK,iBAAiBA,WAAU;AAAA,IACvC;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,qBAAqBA,cAAkB;AAChC,UAAA,EAAE,UAAS,IAAK,KAAK;AAC3B,UAAM,YAAY,MAAM,KAAK,WAAW,SAAQ;AAChD,UAAM,mBAAmB,IAAIC,oCAC5B,UAAU,gBACV;AAAA,MACC;AAAA,MAAA,YACAD;AAAAA,IAAA,CACA;AAEF,UAAM,aAAaE,KAAA,iBAAiB,UAAU,SAASF,YAAU;AACjE,UAAM,gBAAgB,IAAIG,QAAAA,cAAc,YAAY,SAAS;AAC7D,UAAM,qBAAqB,UAAU,eAClC,IAAIC,aAAA,mBAAmB,UAAU,cAAc;AAAA,MAC/C;AAAA,MAAA,YACAJ;AAAAA,IAAA,CACA,IACA;AAEI,WAAA,IAAIK,WAAAA,kBACVL,cACA,eACA,KAAK,YACL,KAAK,aACL,kBACA,oBACA,KAAK,cAAc;AAAA,EAErB;AACA;;;"}

package/dist/managers/repositories.d.ts

@@ -68,7 +68,7 @@ export declare class RepositoriesManager {
     /**
      * Return a repository utilities object for a repository.
      *
-     * @param name - The name of the repository.
+     * @param repository - The name of the repository.
      */
-    getRepositoryManager(name: string): RepositoryManager;
+    getRepositoryManager(repository: string): RepositoryManager;
 }