@prismicio/e2e-tests-utils 1.0.0-alpha.1

package/dist/managers/repository.cjs

@@ -0,0 +1,187 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const log = require("../utils/log.cjs");
+class RepositoryManager {
+  constructor(name, wroomClient, customTypesApiClient) {
+    __publicField(this, "name");
+    __publicField(this, "wroomClient");
+    __publicField(this, "customTypesApiClient");
+    this.name = name;
+    this.wroomClient = wroomClient;
+    this.customTypesApiClient = customTypesApiClient;
+  }
+  async configure(config) {
+    if (config.locales) {
+      await this.createLocales(config.locales);
+    }
+    if (config.customLocale) {
+      await this.createCustomLocale(config.customLocale);
+    }
+    if (config.defaultLocale) {
+      await this.setDefaultLocale(config.defaultLocale);
+    }
+    if (config.slices) {
+      await this.createSlices(config.slices);
+    }
+    if (config.customTypes) {
+      await this.createCustomTypes(config.customTypes);
+    }
+    if (config.preview) {
+      await this.createPreview(config.preview);
+    }
+  }
+  /** @returns the repository base url, like https://my-repo.prismic.io */
+  getBaseURL() {
+    const url = new URL(this.wroomClient.getBaseURL());
+    url.hostname = `${this.name}.${url.hostname}`;
+    return url.toString();
+  }
+  /**
+   * Set additional standard locales for a repository in Wroom, does not fail if
+   * the locales already exist.
+   *
+   * @param locales - An array of all locales to be added to the repository.
+   *
+   * @throws Error if setting the locales fails.
+   */
+  async createLocales(locales) {
+    const profiler = log.logger.startTimer();
+    const response = await this.wroomClient.post(this.name, "app/settings/multilanguages", { languages: locales });
+    const { data, status } = response;
+    const success = status === 200 || status === 400 && data.includes("already existing languages");
+    if (!success) {
+      log.logHttpResponse(response);
+      throw new Error(`Could not add locales ${locales.join(", ")}`);
+    }
+    profiler.done({ message: `standard locales '${locales}' set` });
+  }
+  /**
+   * Set additional custom locale for a repository in Wroom, does not fail if
+   * the locales already exist.
+   *
+   * @param locale - The locale to be added to the repository.
+   *
+   * @throws Error if setting the locale fails.
+   */
+  async createCustomLocale(locale) {
+    const profiler = log.logger.startTimer();
+    const response = await this.wroomClient.post(this.name, "app/settings/multilanguages/custom", locale);
+    const { data, status } = response;
+    const success = status === 200 || status === 400 && data.includes("code is already used");
+    if (!success) {
+      log.logHttpResponse(response);
+      throw new Error(`Could not create custom locale ${locale}`);
+    }
+    profiler.done({
+      message: `custom locale ${JSON.stringify(locale)} created`
+    });
+  }
+  failIfNot200(response, msg) {
+    if (response.status !== 200) {
+      log.logHttpResponse(response);
+      throw new Error(msg);
+    }
+  }
+  /**
+   * Delete a locale from a repository.
+   *
+   * @param locale - locale to remove from the repository configuration.
+   *
+   * @throws Error if deleting the locale fails.
+   */
+  async deleteLocale(locale) {
+    const profiler = log.logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `app/settings/multilanguages/${locale}/delete`);
+    this.failIfNot200(response, `Could not delete locale ${locale}`);
+    profiler.done({ message: `locale '${locale}' deleted` });
+  }
+  /**
+   * Set the default (master) locale for a repository in Wroom, the locale needs
+   * to exist for the repository.
+   *
+   * @param locale - The locale to be set as the default.
+   *
+   * @throws Error if setting the default locale fails.
+   */
+  async setDefaultLocale(locale) {
+    const profiler = log.logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `/app/settings/multilanguages/${locale}/defineAsMaster`);
+    this.failIfNot200(response, `Could not set default locale to ${locale}`);
+    profiler.done({ message: `default locale set to '${locale}'` });
+  }
+  /**
+   * Creates a release.
+   *
+   * @param label - The label for the release.
+   *
+   * @returns A Promise that resolves when the release is created.
+   */
+  async createRelease(label) {
+    const profiler = log.logger.startTimer();
+    const response = await this.wroomClient.post(this.name, "./app/releases", {
+      label
+    });
+    this.failIfNot200(response, `Could not create release ${label}`);
+    profiler.done({ message: `release '${label}' created` });
+    return response.data;
+  }
+  /**
+   * Deletes a repository release.
+   *
+   * @param repository - The name of the repository.
+   * @param id - The ID of the release to be deleted.
+   */
+  async deleteRelease(id) {
+    const profiler = log.logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `./app/releases/${id}/delete`, {});
+    this.failIfNot200(response, `Could not delete release with id ${id}`);
+    profiler.done({ message: `release '${id}' deleted` });
+  }
+  /**
+   * Creates a preview for a repository.
+   *
+   * @param data - The data for creating the preview.
+   */
+  async createPreview(data) {
+    const profiler = log.logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `./previews/new`, data);
+    this.failIfNot200(response, `Could not create preview ${data.name}`);
+    profiler.done({ message: `preview '${data.name}' created` });
+    return response.data;
+  }
+  /**
+   * Deletes a preview from a repository.
+   *
+   * @param id - The ID of the preview to be deleted.
+   */
+  async deletePreview(id) {
+    const profiler = log.logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `./previews/delete/${id}`, {});
+    this.failIfNot200(response, `Could not delete preview with id${id}`);
+    profiler.done({ message: `preview '${id}' deleted` });
+  }
+  /**
+   * Create Custom Types using the Custom types api.
+   *
+   * @param customTypes -
+   */
+  async createCustomTypes(customTypes) {
+    await this.customTypesApiClient.createCustomTypes(customTypes);
+  }
+  /**
+   * Create slices using the Custom types api.
+   *
+   * @param slices -
+   */
+  async createSlices(slices) {
+    await this.customTypesApiClient.createSlices(slices);
+  }
+}
+exports.RepositoryManager = RepositoryManager;
+//# sourceMappingURL=repository.cjs.map

package/dist/managers/repository.cjs.map

@@ -0,0 +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 { CustomTypesClient } from \"../clients/customTypesApi\";\nimport { WroomClient } from \"../clients/wroom\";\nimport { logHttpResponse, logger } from \"../utils/log\";\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 wroomClient: WroomClient,\n\t\tprivate readonly customTypesApiClient: CustomTypesClient,\n\t) {}\n\n\tasync configure(config: RepositoryConfig): Promise<void> {\n\t\tif (config.locales) {\n\t\t\tawait this.createLocales(config.locales);\n\t\t}\n\n\t\tif (config.customLocale) {\n\t\t\tawait this.createCustomLocale(config.customLocale);\n\t\t}\n\n\t\tif (config.defaultLocale) {\n\t\t\tawait this.setDefaultLocale(config.defaultLocale);\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\tconst url = new URL(this.wroomClient.getBaseURL());\n\t\turl.hostname = `${this.name}.${url.hostname}`;\n\n\t\treturn url.toString();\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: `standard locales '${locales}' set` });\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 && (data as string).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}/defineAsMaster`,\n\t\t);\n\n\t\tthis.failIfNot200(response, `Could not set default locale to ${locale}`);\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\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","logHttpResponse"],"mappings":";;;;;;;;;MAYa,kBAAiB;AAAA,EAC7B,YACU,MACQ,aACA,sBAAuC;AAF/C;AACQ;AACA;AAFR,SAAI,OAAJ;AACQ,SAAW,cAAX;AACA,SAAoB,uBAApB;AAAA,EACf;AAAA,EAEH,MAAM,UAAU,QAAwB;AACvC,QAAI,OAAO,SAAS;AACb,YAAA,KAAK,cAAc,OAAO,OAAO;AAAA,IACvC;AAED,QAAI,OAAO,cAAc;AAClB,YAAA,KAAK,mBAAmB,OAAO,YAAY;AAAA,IACjD;AAED,QAAI,OAAO,eAAe;AACnB,YAAA,KAAK,iBAAiB,OAAO,aAAa;AAAA,IAChD;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,UAAM,MAAM,IAAI,IAAI,KAAK,YAAY,YAAY;AACjD,QAAI,WAAW,GAAG,KAAK,IAAI,IAAI,IAAI,QAAQ;AAE3C,WAAO,IAAI;EACZ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,cAAc,SAAiB;AAC9B,UAAA,WAAWA,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;AACbC,UAAA,gBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,yBAAyB,QAAQ,KAAK,IAAI,CAAC,EAAE;AAAA,IAC7D;AACD,aAAS,KAAK,EAAE,SAAS,qBAAqB,OAAO,SAAS;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,mBAAmB,QAAoB;AACtC,UAAA,WAAWD,WAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,sCACA,MAAM;AAGD,UAAA,EAAE,MAAM,OAAW,IAAA;AACzB,UAAM,UACL,WAAW,OACV,WAAW,OAAQ,KAAgB,SAAS,sBAAsB;AACpE,QAAI,CAAC,SAAS;AACbC,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,WAAWD,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,iBAAiB;AAGxD,SAAK,aAAa,UAAU,mCAAmC,MAAM,EAAE;AACvE,aAAS,KAAK,EAAE,SAAS,0BAA0B,MAAM,KAAK;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,cAAc,OAAa;AAC1B,UAAA,WAAWA,WAAO;AAExB,UAAM,WAAW,MAAM,KAAK,YAAY,KAAK,KAAK,MAAM,kBAAkB;AAAA,MACzE;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,kBAAkB,EAAE,WACpB,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,kBACA,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,qBAAqB,EAAE,IACvB,CAAE,CAAA;AAGH,SAAK,aAAa,UAAU,mCAAmC,EAAE,EAAE;AACnE,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;AACA;;"}

package/dist/managers/repository.d.ts

@@ -0,0 +1,114 @@
+import { CustomType, SharedSlice } from "@prismicio/types-internal/lib/customtypes";
+import { CustomTypesClient } from "../clients/customTypesApi";
+import { WroomClient } from "../clients/wroom";
+/** Utility to manage test data for a Prismic repository */
+export declare class RepositoryManager {
+    readonly name: string;
+    private readonly wroomClient;
+    private readonly customTypesApiClient;
+    constructor(name: string, wroomClient: WroomClient, customTypesApiClient: CustomTypesClient);
+    configure(config: RepositoryConfig): Promise<void>;
+    /** @returns the repository base url, like https://my-repo.prismic.io */
+    getBaseURL(): string;
+    /**
+     * Set additional standard locales for a repository in Wroom, does not fail if
+     * the locales already exist.
+     *
+     * @param locales - An array of all locales to be added to the repository.
+     *
+     * @throws Error if setting the locales fails.
+     */
+    createLocales(locales: string[]): Promise<void>;
+    /**
+     * Set additional custom locale for a repository in Wroom, does not fail if
+     * the locales already exist.
+     *
+     * @param locale - The locale to be added to the repository.
+     *
+     * @throws Error if setting the locale fails.
+     */
+    createCustomLocale(locale: CustomLocale): Promise<void>;
+    private failIfNot200;
+    /**
+     * Delete a locale from a repository.
+     *
+     * @param locale - locale to remove from the repository configuration.
+     *
+     * @throws Error if deleting the locale fails.
+     */
+    deleteLocale(locale: string): Promise<void>;
+    /**
+     * Set the default (master) locale for a repository in Wroom, the locale needs
+     * to exist for the repository.
+     *
+     * @param locale - The locale to be set as the default.
+     *
+     * @throws Error if setting the default locale fails.
+     */
+    setDefaultLocale(locale: string): Promise<void>;
+    /**
+     * Creates a release.
+     *
+     * @param label - The label for the release.
+     *
+     * @returns A Promise that resolves when the release is created.
+     */
+    createRelease(label: string): Promise<{
+        id: string;
+    }>;
+    /**
+     * Deletes a repository release.
+     *
+     * @param repository - The name of the repository.
+     * @param id - The ID of the release to be deleted.
+     */
+    deleteRelease(id: string): Promise<void>;
+    /**
+     * Creates a preview for a repository.
+     *
+     * @param data - The data for creating the preview.
+     */
+    createPreview(data: Preview): Promise<void>;
+    /**
+     * Deletes a preview from a repository.
+     *
+     * @param id - The ID of the preview to be deleted.
+     */
+    deletePreview(id: string): Promise<void>;
+    /**
+     * 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>;
+}
+export type RepositoryConfig = {
+    customLocale?: CustomLocale;
+    locales?: string[];
+    defaultLocale?: string;
+    slices?: SharedSlice[];
+    customTypes?: CustomType[];
+    preview?: Preview;
+};
+export type Preview = {
+    name: string;
+    websiteURL: string;
+    resolverPath: string;
+};
+export type CustomLocale = {
+    lang: {
+        label: string;
+        id: string;
+        useStandardAnalyzer?: boolean;
+    };
+    region: {
+        label: string;
+        id: string;
+    };
+};

package/dist/managers/repository.js

@@ -0,0 +1,187 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+import { logger, logHttpResponse } from "../utils/log.js";
+class RepositoryManager {
+  constructor(name, wroomClient, customTypesApiClient) {
+    __publicField(this, "name");
+    __publicField(this, "wroomClient");
+    __publicField(this, "customTypesApiClient");
+    this.name = name;
+    this.wroomClient = wroomClient;
+    this.customTypesApiClient = customTypesApiClient;
+  }
+  async configure(config) {
+    if (config.locales) {
+      await this.createLocales(config.locales);
+    }
+    if (config.customLocale) {
+      await this.createCustomLocale(config.customLocale);
+    }
+    if (config.defaultLocale) {
+      await this.setDefaultLocale(config.defaultLocale);
+    }
+    if (config.slices) {
+      await this.createSlices(config.slices);
+    }
+    if (config.customTypes) {
+      await this.createCustomTypes(config.customTypes);
+    }
+    if (config.preview) {
+      await this.createPreview(config.preview);
+    }
+  }
+  /** @returns the repository base url, like https://my-repo.prismic.io */
+  getBaseURL() {
+    const url = new URL(this.wroomClient.getBaseURL());
+    url.hostname = `${this.name}.${url.hostname}`;
+    return url.toString();
+  }
+  /**
+   * Set additional standard locales for a repository in Wroom, does not fail if
+   * the locales already exist.
+   *
+   * @param locales - An array of all locales to be added to the repository.
+   *
+   * @throws Error if setting the locales fails.
+   */
+  async createLocales(locales) {
+    const profiler = logger.startTimer();
+    const response = await this.wroomClient.post(this.name, "app/settings/multilanguages", { languages: locales });
+    const { data, status } = response;
+    const success = status === 200 || status === 400 && data.includes("already existing languages");
+    if (!success) {
+      logHttpResponse(response);
+      throw new Error(`Could not add locales ${locales.join(", ")}`);
+    }
+    profiler.done({ message: `standard locales '${locales}' set` });
+  }
+  /**
+   * Set additional custom locale for a repository in Wroom, does not fail if
+   * the locales already exist.
+   *
+   * @param locale - The locale to be added to the repository.
+   *
+   * @throws Error if setting the locale fails.
+   */
+  async createCustomLocale(locale) {
+    const profiler = logger.startTimer();
+    const response = await this.wroomClient.post(this.name, "app/settings/multilanguages/custom", locale);
+    const { data, status } = response;
+    const success = status === 200 || status === 400 && data.includes("code is already used");
+    if (!success) {
+      logHttpResponse(response);
+      throw new Error(`Could not create custom locale ${locale}`);
+    }
+    profiler.done({
+      message: `custom locale ${JSON.stringify(locale)} created`
+    });
+  }
+  failIfNot200(response, msg) {
+    if (response.status !== 200) {
+      logHttpResponse(response);
+      throw new Error(msg);
+    }
+  }
+  /**
+   * Delete a locale from a repository.
+   *
+   * @param locale - locale to remove from the repository configuration.
+   *
+   * @throws Error if deleting the locale fails.
+   */
+  async deleteLocale(locale) {
+    const profiler = logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `app/settings/multilanguages/${locale}/delete`);
+    this.failIfNot200(response, `Could not delete locale ${locale}`);
+    profiler.done({ message: `locale '${locale}' deleted` });
+  }
+  /**
+   * Set the default (master) locale for a repository in Wroom, the locale needs
+   * to exist for the repository.
+   *
+   * @param locale - The locale to be set as the default.
+   *
+   * @throws Error if setting the default locale fails.
+   */
+  async setDefaultLocale(locale) {
+    const profiler = logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `/app/settings/multilanguages/${locale}/defineAsMaster`);
+    this.failIfNot200(response, `Could not set default locale to ${locale}`);
+    profiler.done({ message: `default locale set to '${locale}'` });
+  }
+  /**
+   * Creates a release.
+   *
+   * @param label - The label for the release.
+   *
+   * @returns A Promise that resolves when the release is created.
+   */
+  async createRelease(label) {
+    const profiler = logger.startTimer();
+    const response = await this.wroomClient.post(this.name, "./app/releases", {
+      label
+    });
+    this.failIfNot200(response, `Could not create release ${label}`);
+    profiler.done({ message: `release '${label}' created` });
+    return response.data;
+  }
+  /**
+   * Deletes a repository release.
+   *
+   * @param repository - The name of the repository.
+   * @param id - The ID of the release to be deleted.
+   */
+  async deleteRelease(id) {
+    const profiler = logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `./app/releases/${id}/delete`, {});
+    this.failIfNot200(response, `Could not delete release with id ${id}`);
+    profiler.done({ message: `release '${id}' deleted` });
+  }
+  /**
+   * Creates a preview for a repository.
+   *
+   * @param data - The data for creating the preview.
+   */
+  async createPreview(data) {
+    const profiler = logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `./previews/new`, data);
+    this.failIfNot200(response, `Could not create preview ${data.name}`);
+    profiler.done({ message: `preview '${data.name}' created` });
+    return response.data;
+  }
+  /**
+   * Deletes a preview from a repository.
+   *
+   * @param id - The ID of the preview to be deleted.
+   */
+  async deletePreview(id) {
+    const profiler = logger.startTimer();
+    const response = await this.wroomClient.post(this.name, `./previews/delete/${id}`, {});
+    this.failIfNot200(response, `Could not delete preview with id${id}`);
+    profiler.done({ message: `preview '${id}' deleted` });
+  }
+  /**
+   * Create Custom Types using the Custom types api.
+   *
+   * @param customTypes -
+   */
+  async createCustomTypes(customTypes) {
+    await this.customTypesApiClient.createCustomTypes(customTypes);
+  }
+  /**
+   * Create slices using the Custom types api.
+   *
+   * @param slices -
+   */
+  async createSlices(slices) {
+    await this.customTypesApiClient.createSlices(slices);
+  }
+}
+export {
+  RepositoryManager
+};
+//# sourceMappingURL=repository.js.map

package/dist/managers/repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.js","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 { CustomTypesClient } from \"../clients/customTypesApi\";\nimport { WroomClient } from \"../clients/wroom\";\nimport { logHttpResponse, logger } from \"../utils/log\";\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 wroomClient: WroomClient,\n\t\tprivate readonly customTypesApiClient: CustomTypesClient,\n\t) {}\n\n\tasync configure(config: RepositoryConfig): Promise<void> {\n\t\tif (config.locales) {\n\t\t\tawait this.createLocales(config.locales);\n\t\t}\n\n\t\tif (config.customLocale) {\n\t\t\tawait this.createCustomLocale(config.customLocale);\n\t\t}\n\n\t\tif (config.defaultLocale) {\n\t\t\tawait this.setDefaultLocale(config.defaultLocale);\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\tconst url = new URL(this.wroomClient.getBaseURL());\n\t\turl.hostname = `${this.name}.${url.hostname}`;\n\n\t\treturn url.toString();\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: `standard locales '${locales}' set` });\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 && (data as string).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}/defineAsMaster`,\n\t\t);\n\n\t\tthis.failIfNot200(response, `Could not set default locale to ${locale}`);\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\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":[],"mappings":";;;;;;;MAYa,kBAAiB;AAAA,EAC7B,YACU,MACQ,aACA,sBAAuC;AAF/C;AACQ;AACA;AAFR,SAAI,OAAJ;AACQ,SAAW,cAAX;AACA,SAAoB,uBAApB;AAAA,EACf;AAAA,EAEH,MAAM,UAAU,QAAwB;AACvC,QAAI,OAAO,SAAS;AACb,YAAA,KAAK,cAAc,OAAO,OAAO;AAAA,IACvC;AAED,QAAI,OAAO,cAAc;AAClB,YAAA,KAAK,mBAAmB,OAAO,YAAY;AAAA,IACjD;AAED,QAAI,OAAO,eAAe;AACnB,YAAA,KAAK,iBAAiB,OAAO,aAAa;AAAA,IAChD;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,UAAM,MAAM,IAAI,IAAI,KAAK,YAAY,YAAY;AACjD,QAAI,WAAW,GAAG,KAAK,IAAI,IAAI,IAAI,QAAQ;AAE3C,WAAO,IAAI;EACZ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,cAAc,SAAiB;AAC9B,UAAA,WAAW,OAAO;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;AACb,sBAAgB,QAAQ;AACxB,YAAM,IAAI,MAAM,yBAAyB,QAAQ,KAAK,IAAI,CAAC,EAAE;AAAA,IAC7D;AACD,aAAS,KAAK,EAAE,SAAS,qBAAqB,OAAO,SAAS;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,mBAAmB,QAAoB;AACtC,UAAA,WAAW,OAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,sCACA,MAAM;AAGD,UAAA,EAAE,MAAM,OAAW,IAAA;AACzB,UAAM,UACL,WAAW,OACV,WAAW,OAAQ,KAAgB,SAAS,sBAAsB;AACpE,QAAI,CAAC,SAAS;AACb,sBAAgB,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;AAC5B,sBAAgB,QAAQ;AAClB,YAAA,IAAI,MAAM,GAAG;AAAA,IACnB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,aAAa,QAAc;AAC1B,UAAA,WAAW,OAAO;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,WAAW,OAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,gCAAgC,MAAM,iBAAiB;AAGxD,SAAK,aAAa,UAAU,mCAAmC,MAAM,EAAE;AACvE,aAAS,KAAK,EAAE,SAAS,0BAA0B,MAAM,KAAK;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,cAAc,OAAa;AAC1B,UAAA,WAAW,OAAO;AAExB,UAAM,WAAW,MAAM,KAAK,YAAY,KAAK,KAAK,MAAM,kBAAkB;AAAA,MACzE;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,WAAW,OAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,kBAAkB,EAAE,WACpB,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,WAAW,OAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,kBACA,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,WAAW,OAAO;AAElB,UAAA,WAAW,MAAM,KAAK,YAAY,KACvC,KAAK,MACL,qBAAqB,EAAE,IACvB,CAAE,CAAA;AAGH,SAAK,aAAa,UAAU,mCAAmC,EAAE,EAAE;AACnE,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;AACA;"}

package/dist/types.d.ts

@@ -0,0 +1,4 @@
+export type Credentials = {
+    email: string;
+    password: string;
+};

package/dist/utils/cookies.cjs

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const extractCookie = (cookies, cookieName) => {
+  const regex = new RegExp(`${cookieName}=([^;]+)`, "i");
+  if (typeof cookies === "string") {
+    const match = cookies.match(regex);
+    return match ? match[1] : void 0;
+  }
+  if (cookies instanceof Array) {
+    for (const cookie of cookies) {
+      const match = cookie.match(regex);
+      if (match) {
+        return match[1];
+      }
+    }
+  }
+  return void 0;
+};
+exports.extractCookie = extractCookie;
+//# sourceMappingURL=cookies.cjs.map

package/dist/utils/cookies.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cookies.cjs","sources":["../../../src/utils/cookies.ts"],"sourcesContent":["import { AxiosHeaderValue } from \"axios\";\n\n/**\n * Extract the value of a specific cookie from Axios cookies.\n *\n * @param cookies - Axios cookies, can be a string or an array\n * @param cookieName - The name of the cookie to extract.\n */\nexport const extractCookie = (\n\tcookies: AxiosHeaderValue | undefined,\n\tcookieName: string,\n): string | undefined => {\n\tconst regex = new RegExp(`${cookieName}=([^;]+)`, \"i\"); // 'i' flag for case-insensitivity\n\n\tif (typeof cookies === \"string\") {\n\t\tconst match = cookies.match(regex);\n\n\t\treturn match ? match[1] : undefined;\n\t}\n\tif (cookies instanceof Array) {\n\t\tfor (const cookie of cookies) {\n\t\t\tconst match = cookie.match(regex);\n\t\t\tif (match) {\n\t\t\t\treturn match[1];\n\t\t\t}\n\t\t}\n\t}\n\n\treturn undefined;\n};\n"],"names":[],"mappings":";;AAQa,MAAA,gBAAgB,CAC5B,SACA,eACuB;AACvB,QAAM,QAAQ,IAAI,OAAO,GAAG,UAAU,YAAY,GAAG;AAEjD,MAAA,OAAO,YAAY,UAAU;AAC1B,UAAA,QAAQ,QAAQ,MAAM,KAAK;AAE1B,WAAA,QAAQ,MAAM,CAAC,IAAI;AAAA,EAC1B;AACD,MAAI,mBAAmB,OAAO;AAC7B,eAAW,UAAU,SAAS;AACvB,YAAA,QAAQ,OAAO,MAAM,KAAK;AAChC,UAAI,OAAO;AACV,eAAO,MAAM,CAAC;AAAA,MACd;AAAA,IACD;AAAA,EACD;AAEM,SAAA;AACR;;"}

package/dist/utils/cookies.d.ts

@@ -0,0 +1,8 @@
+import { AxiosHeaderValue } from "axios";
+/**
+ * Extract the value of a specific cookie from Axios cookies.
+ *
+ * @param cookies - Axios cookies, can be a string or an array
+ * @param cookieName - The name of the cookie to extract.
+ */
+export declare const extractCookie: (cookies: AxiosHeaderValue | undefined, cookieName: string) => string | undefined;

package/dist/utils/cookies.js

@@ -0,0 +1,20 @@
+const extractCookie = (cookies, cookieName) => {
+  const regex = new RegExp(`${cookieName}=([^;]+)`, "i");
+  if (typeof cookies === "string") {
+    const match = cookies.match(regex);
+    return match ? match[1] : void 0;
+  }
+  if (cookies instanceof Array) {
+    for (const cookie of cookies) {
+      const match = cookie.match(regex);
+      if (match) {
+        return match[1];
+      }
+    }
+  }
+  return void 0;
+};
+export {
+  extractCookie
+};
+//# sourceMappingURL=cookies.js.map

package/dist/utils/cookies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cookies.js","sources":["../../../src/utils/cookies.ts"],"sourcesContent":["import { AxiosHeaderValue } from \"axios\";\n\n/**\n * Extract the value of a specific cookie from Axios cookies.\n *\n * @param cookies - Axios cookies, can be a string or an array\n * @param cookieName - The name of the cookie to extract.\n */\nexport const extractCookie = (\n\tcookies: AxiosHeaderValue | undefined,\n\tcookieName: string,\n): string | undefined => {\n\tconst regex = new RegExp(`${cookieName}=([^;]+)`, \"i\"); // 'i' flag for case-insensitivity\n\n\tif (typeof cookies === \"string\") {\n\t\tconst match = cookies.match(regex);\n\n\t\treturn match ? match[1] : undefined;\n\t}\n\tif (cookies instanceof Array) {\n\t\tfor (const cookie of cookies) {\n\t\t\tconst match = cookie.match(regex);\n\t\t\tif (match) {\n\t\t\t\treturn match[1];\n\t\t\t}\n\t\t}\n\t}\n\n\treturn undefined;\n};\n"],"names":[],"mappings":"AAQa,MAAA,gBAAgB,CAC5B,SACA,eACuB;AACvB,QAAM,QAAQ,IAAI,OAAO,GAAG,UAAU,YAAY,GAAG;AAEjD,MAAA,OAAO,YAAY,UAAU;AAC1B,UAAA,QAAQ,QAAQ,MAAM,KAAK;AAE1B,WAAA,QAAQ,MAAM,CAAC,IAAI;AAAA,EAC1B;AACD,MAAI,mBAAmB,OAAO;AAC7B,eAAW,UAAU,SAAS;AACvB,YAAA,QAAQ,OAAO,MAAM,KAAK;AAChC,UAAI,OAAO;AACV,eAAO,MAAM,CAAC;AAAA,MACd;AAAA,IACD;AAAA,EACD;AAEM,SAAA;AACR;"}

package/dist/utils/envVariableManager.cjs

@@ -0,0 +1,36 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+class EnvVariableManager {
+  constructor(variableName) {
+    __publicField(this, "variableName");
+    this.variableName = variableName;
+  }
+  /** add a string and persist it in the environment variable */
+  add(value) {
+    const existingValues = this.getAll();
+    existingValues.push(value);
+    this.setAll(existingValues);
+  }
+  /** remove a string from the environment variable */
+  remove(value) {
+    const existingValues = this.getAll();
+    const updatedValues = existingValues.filter((item) => item !== value);
+    this.setAll(updatedValues);
+  }
+  /** return all items stored in the environment variable */
+  getAll() {
+    const value = process.env[this.variableName] || "[]";
+    return JSON.parse(value);
+  }
+  setAll(values) {
+    process.env[this.variableName] = JSON.stringify(values);
+  }
+}
+exports.EnvVariableManager = EnvVariableManager;
+//# sourceMappingURL=envVariableManager.cjs.map

package/dist/utils/envVariableManager.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"envVariableManager.cjs","sources":["../../../src/utils/envVariableManager.ts"],"sourcesContent":["/**\n * Manage a list of strings within an environment variable. This is useful to\n * share data across different test phases (setup, teardown, test execution) as\n * most test frameworks run these in independent states\n */\nexport class EnvVariableManager {\n\tconstructor(private variableName: string) {}\n\n\t/** add a string and persist it in the environment variable */\n\tadd(value: string): void {\n\t\tconst existingValues = this.getAll();\n\t\texistingValues.push(value);\n\n\t\tthis.setAll(existingValues);\n\t}\n\n\t/** remove a string from the environment variable */\n\tremove(value: string): void {\n\t\tconst existingValues = this.getAll();\n\t\tconst updatedValues = existingValues.filter((item) => item !== value);\n\n\t\tthis.setAll(updatedValues);\n\t}\n\n\t/** return all items stored in the environment variable */\n\tgetAll(): string[] {\n\t\tconst value = process.env[this.variableName] || \"[]\";\n\n\t\treturn JSON.parse(value);\n\t}\n\n\tprivate setAll(values: string[]): void {\n\t\tprocess.env[this.variableName] = JSON.stringify(values);\n\t}\n}\n"],"names":[],"mappings":";;;;;;;;MAKa,mBAAkB;AAAA,EAC9B,YAAoB,cAAoB;AAApB;AAAA,SAAY,eAAZ;AAAA,EAAuB;AAAA;AAAA,EAG3C,IAAI,OAAa;AACV,UAAA,iBAAiB,KAAK;AAC5B,mBAAe,KAAK,KAAK;AAEzB,SAAK,OAAO,cAAc;AAAA,EAC3B;AAAA;AAAA,EAGA,OAAO,OAAa;AACb,UAAA,iBAAiB,KAAK;AAC5B,UAAM,gBAAgB,eAAe,OAAO,CAAC,SAAS,SAAS,KAAK;AAEpE,SAAK,OAAO,aAAa;AAAA,EAC1B;AAAA;AAAA,EAGA,SAAM;AACL,UAAM,QAAQ,QAAQ,IAAI,KAAK,YAAY,KAAK;AAEzC,WAAA,KAAK,MAAM,KAAK;AAAA,EACxB;AAAA,EAEQ,OAAO,QAAgB;AAC9B,YAAQ,IAAI,KAAK,YAAY,IAAI,KAAK,UAAU,MAAM;AAAA,EACvD;AACA;;"}

package/dist/utils/envVariableManager.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Manage a list of strings within an environment variable. This is useful to
+ * share data across different test phases (setup, teardown, test execution) as
+ * most test frameworks run these in independent states
+ */
+export declare class EnvVariableManager {
+    private variableName;
+    constructor(variableName: string);
+    /** add a string and persist it in the environment variable */
+    add(value: string): void;
+    /** remove a string from the environment variable */
+    remove(value: string): void;
+    /** return all items stored in the environment variable */
+    getAll(): string[];
+    private setAll;
+}