@prismicio/e2e-tests-utils 2.0.0-alpha.2 → 2.0.0-alpha.5

package/dist/utils/envVariableManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"envVariableManager.js","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,EAAA;AAAA;AAAA,EAGpB,IAAI,OAAa;AACV,UAAA,iBAAiB,KAAK;AAC5B,mBAAe,KAAK,KAAK;AAEzB,SAAK,OAAO,cAAc;AAAA,EAAA;AAAA;AAAA,EAI3B,OAAO,OAAa;AACb,UAAA,iBAAiB,KAAK;AAC5B,UAAM,gBAAgB,eAAe,OAAO,CAAC,SAAS,SAAS,KAAK;AAEpE,SAAK,OAAO,aAAa;AAAA,EAAA;AAAA;AAAA,EAI1B,SAAM;AACL,UAAM,QAAQ,QAAQ,IAAI,KAAK,YAAY,KAAK;AAEzC,WAAA,KAAK,MAAM,KAAK;AAAA,EAAA;AAAA,EAGhB,OAAO,QAAgB;AAC9B,YAAQ,IAAI,KAAK,YAAY,IAAI,KAAK,UAAU,MAAM;AAAA,EAAA;AAEvD;"}
+{"version":3,"file":"envVariableManager.js","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/log.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"log.cjs","sources":["../../../src/utils/log.ts"],"sourcesContent":["import { APIResponse } from \"@playwright/test\";\nimport { AxiosResponse } from \"axios\";\nimport { createLogger, format, transports } from \"winston\";\n\nexport const logHttpResponse = (response: AxiosResponse): void => {\n\tconst { status, data } = response;\n\tconst { baseURL = \"\", url = \"\" } = response.config;\n\t// make sure the url always shows baseURL + path.\n\t// Depending on how the AxiosInstance was called, the url already contains the baseURL\n\tconst fullUrl = url.startsWith(\"http\") ? url : `${baseURL}/${url}`;\n\n\tlogger.info(\n\t\t`Call to ${fullUrl} failed, received [${status}] ${JSON.stringify(data)}`,\n\t);\n};\n\nexport const logPlaywrightApiResponse = async (\n\tresponse: APIResponse,\n): Promise<void> => {\n\tlogger.info(\n\t\t`Call to ${response.url()} failed, received [${response.status()}] ${JSON.stringify(\n\t\t\tawait response.text(),\n\t\t)}`,\n\t);\n};\n\nconst { combine, printf } = format;\n\nconst customFormat = printf(({ message, durationMs }) => {\n\tconst baseMsg = `[test data] ${message}`;\n\tif (durationMs) {\n\t\treturn `${baseMsg} in ${durationMs}ms`;\n\t}\n\n\treturn baseMsg;\n});\n\nexport const logger = createLogger({\n\tsilent: process.env[\"prismic_e2e_tests_utils_silent\"] === \"true\",\n\tlevel: process.env[\"prismic_e2e_tests_utils_log_level\"] || \"info\",\n\tformat: combine(customFormat),\n\ttransports: [new transports.Console()],\n});\n"],"names":["format","createLogger","transports"],"mappings":";;;AAIa,MAAA,kBAAkB,CAAC,aAAiC;AAC1D,QAAA,EAAE,QAAQ,KAAA,IAAS;AACzB,QAAM,EAAE,UAAU,IAAI,MAAM,GAAA,IAAO,SAAS;AAGtC,QAAA,UAAU,IAAI,WAAW,MAAM,IAAI,MAAM,GAAG,OAAO,IAAI,GAAG;AAEzD,SAAA,KACN,WAAW,OAAO,sBAAsB,MAAM,KAAK,KAAK,UAAU,IAAI,CAAC,EAAE;AAE3E;AAEa,MAAA,2BAA2B,OACvC,aACkB;AAClB,SAAO,KACN,WAAW,SAAS,IAAK,CAAA,sBAAsB,SAAS,OAAA,CAAQ,KAAK,KAAK,UACzE,MAAM,SAAS,KAAM,CAAA,CACrB,EAAE;AAEL;AAEA,MAAM,EAAE,SAAS,OAAA,IAAWA,QAAA;AAE5B,MAAM,eAAe,OAAO,CAAC,EAAE,SAAS,iBAAgB;AACjD,QAAA,UAAU,eAAe,OAAO;AACtC,MAAI,YAAY;AACR,WAAA,GAAG,OAAO,OAAO,UAAU;AAAA,EAAA;AAG5B,SAAA;AACR,CAAC;AAEM,MAAM,SAASC,QAAAA,aAAa;AAAA,EAClC,QAAQ,QAAQ,IAAI,gCAAgC,MAAM;AAAA,EAC1D,OAAO,QAAQ,IAAI,mCAAmC,KAAK;AAAA,EAC3D,QAAQ,QAAQ,YAAY;AAAA,EAC5B,YAAY,CAAC,IAAIC,QAAA,WAAW,QAAS,CAAA;AACrC,CAAA;;;;"}
+{"version":3,"file":"log.cjs","sources":["../../../src/utils/log.ts"],"sourcesContent":["import { APIResponse } from \"@playwright/test\";\nimport { AxiosResponse } from \"axios\";\nimport { createLogger, format, transports } from \"winston\";\n\nexport const logHttpResponse = (response: AxiosResponse): void => {\n\tconst { status, data } = response;\n\tconst { baseURL = \"\", url = \"\" } = response.config;\n\t// make sure the url always shows baseURL + path.\n\t// Depending on how the AxiosInstance was called, the url already contains the baseURL\n\tconst fullUrl = url.startsWith(\"http\") ? url : `${baseURL}/${url}`;\n\n\tlogger.info(\n\t\t`Call to ${fullUrl} failed, received [${status}] ${JSON.stringify(data)}`,\n\t);\n};\n\nexport const logPlaywrightApiResponse = async (\n\tresponse: APIResponse,\n): Promise<void> => {\n\tlogger.info(\n\t\t`Call to ${response.url()} failed, received [${response.status()}] ${JSON.stringify(\n\t\t\tawait response.text(),\n\t\t)}`,\n\t);\n};\n\nconst { combine, printf } = format;\n\nconst customFormat = printf(({ message, durationMs }) => {\n\tconst baseMsg = `[test data] ${message}`;\n\tif (durationMs) {\n\t\treturn `${baseMsg} in ${durationMs}ms`;\n\t}\n\n\treturn baseMsg;\n});\n\nexport const logger = createLogger({\n\tsilent: process.env[\"prismic_e2e_tests_utils_silent\"] === \"true\",\n\tlevel: process.env[\"prismic_e2e_tests_utils_log_level\"] || \"info\",\n\tformat: combine(customFormat),\n\ttransports: [new transports.Console()],\n});\n"],"names":["format","createLogger","transports"],"mappings":";;;AAIa,MAAA,kBAAkB,CAAC,aAAiC;AAC1D,QAAA,EAAE,QAAQ,KAAS,IAAA;AACzB,QAAM,EAAE,UAAU,IAAI,MAAM,OAAO,SAAS;AAGtC,QAAA,UAAU,IAAI,WAAW,MAAM,IAAI,MAAM,GAAG,OAAO,IAAI,GAAG;AAEzD,SAAA,KACN,WAAW,OAAO,sBAAsB,MAAM,KAAK,KAAK,UAAU,IAAI,CAAC,EAAE;AAE3E;AAEa,MAAA,2BAA2B,OACvC,aACkB;AAClB,SAAO,KACN,WAAW,SAAS,IAAK,CAAA,sBAAsB,SAAS,OAAQ,CAAA,KAAK,KAAK,UACzE,MAAM,SAAS,KAAM,CAAA,CACrB,EAAE;AAEL;AAEA,MAAM,EAAE,SAAS,OAAW,IAAAA;AAE5B,MAAM,eAAe,OAAO,CAAC,EAAE,SAAS,iBAAgB;AACjD,QAAA,UAAU,eAAe,OAAO;AACtC,MAAI,YAAY;AACR,WAAA,GAAG,OAAO,OAAO,UAAU;AAAA,EACnC;AAEO,SAAA;AACR,CAAC;AAEM,MAAM,SAASC,QAAAA,aAAa;AAAA,EAClC,QAAQ,QAAQ,IAAI,gCAAgC,MAAM;AAAA,EAC1D,OAAO,QAAQ,IAAI,mCAAmC,KAAK;AAAA,EAC3D,QAAQ,QAAQ,YAAY;AAAA,EAC5B,YAAY,CAAC,IAAIC,mBAAW,SAAS;AACrC,CAAA;;;;"}

package/dist/utils/log.js

@@ -1,4 +1,4 @@
-import { format, createLogger, transports } from "winston";
+import { createLogger, transports, format } from "winston";
 const logHttpResponse = (response) => {
   const { status, data } = response;
   const { baseURL = "", url = "" } = response.config;

package/dist/utils/log.js.map

@@ -1 +1 @@
-{"version":3,"file":"log.js","sources":["../../../src/utils/log.ts"],"sourcesContent":["import { APIResponse } from \"@playwright/test\";\nimport { AxiosResponse } from \"axios\";\nimport { createLogger, format, transports } from \"winston\";\n\nexport const logHttpResponse = (response: AxiosResponse): void => {\n\tconst { status, data } = response;\n\tconst { baseURL = \"\", url = \"\" } = response.config;\n\t// make sure the url always shows baseURL + path.\n\t// Depending on how the AxiosInstance was called, the url already contains the baseURL\n\tconst fullUrl = url.startsWith(\"http\") ? url : `${baseURL}/${url}`;\n\n\tlogger.info(\n\t\t`Call to ${fullUrl} failed, received [${status}] ${JSON.stringify(data)}`,\n\t);\n};\n\nexport const logPlaywrightApiResponse = async (\n\tresponse: APIResponse,\n): Promise<void> => {\n\tlogger.info(\n\t\t`Call to ${response.url()} failed, received [${response.status()}] ${JSON.stringify(\n\t\t\tawait response.text(),\n\t\t)}`,\n\t);\n};\n\nconst { combine, printf } = format;\n\nconst customFormat = printf(({ message, durationMs }) => {\n\tconst baseMsg = `[test data] ${message}`;\n\tif (durationMs) {\n\t\treturn `${baseMsg} in ${durationMs}ms`;\n\t}\n\n\treturn baseMsg;\n});\n\nexport const logger = createLogger({\n\tsilent: process.env[\"prismic_e2e_tests_utils_silent\"] === \"true\",\n\tlevel: process.env[\"prismic_e2e_tests_utils_log_level\"] || \"info\",\n\tformat: combine(customFormat),\n\ttransports: [new transports.Console()],\n});\n"],"names":[],"mappings":";AAIa,MAAA,kBAAkB,CAAC,aAAiC;AAC1D,QAAA,EAAE,QAAQ,KAAA,IAAS;AACzB,QAAM,EAAE,UAAU,IAAI,MAAM,GAAA,IAAO,SAAS;AAGtC,QAAA,UAAU,IAAI,WAAW,MAAM,IAAI,MAAM,GAAG,OAAO,IAAI,GAAG;AAEzD,SAAA,KACN,WAAW,OAAO,sBAAsB,MAAM,KAAK,KAAK,UAAU,IAAI,CAAC,EAAE;AAE3E;AAEa,MAAA,2BAA2B,OACvC,aACkB;AAClB,SAAO,KACN,WAAW,SAAS,IAAK,CAAA,sBAAsB,SAAS,OAAA,CAAQ,KAAK,KAAK,UACzE,MAAM,SAAS,KAAM,CAAA,CACrB,EAAE;AAEL;AAEA,MAAM,EAAE,SAAS,OAAA,IAAW;AAE5B,MAAM,eAAe,OAAO,CAAC,EAAE,SAAS,iBAAgB;AACjD,QAAA,UAAU,eAAe,OAAO;AACtC,MAAI,YAAY;AACR,WAAA,GAAG,OAAO,OAAO,UAAU;AAAA,EAAA;AAG5B,SAAA;AACR,CAAC;AAEM,MAAM,SAAS,aAAa;AAAA,EAClC,QAAQ,QAAQ,IAAI,gCAAgC,MAAM;AAAA,EAC1D,OAAO,QAAQ,IAAI,mCAAmC,KAAK;AAAA,EAC3D,QAAQ,QAAQ,YAAY;AAAA,EAC5B,YAAY,CAAC,IAAI,WAAW,QAAS,CAAA;AACrC,CAAA;"}
+{"version":3,"file":"log.js","sources":["../../../src/utils/log.ts"],"sourcesContent":["import { APIResponse } from \"@playwright/test\";\nimport { AxiosResponse } from \"axios\";\nimport { createLogger, format, transports } from \"winston\";\n\nexport const logHttpResponse = (response: AxiosResponse): void => {\n\tconst { status, data } = response;\n\tconst { baseURL = \"\", url = \"\" } = response.config;\n\t// make sure the url always shows baseURL + path.\n\t// Depending on how the AxiosInstance was called, the url already contains the baseURL\n\tconst fullUrl = url.startsWith(\"http\") ? url : `${baseURL}/${url}`;\n\n\tlogger.info(\n\t\t`Call to ${fullUrl} failed, received [${status}] ${JSON.stringify(data)}`,\n\t);\n};\n\nexport const logPlaywrightApiResponse = async (\n\tresponse: APIResponse,\n): Promise<void> => {\n\tlogger.info(\n\t\t`Call to ${response.url()} failed, received [${response.status()}] ${JSON.stringify(\n\t\t\tawait response.text(),\n\t\t)}`,\n\t);\n};\n\nconst { combine, printf } = format;\n\nconst customFormat = printf(({ message, durationMs }) => {\n\tconst baseMsg = `[test data] ${message}`;\n\tif (durationMs) {\n\t\treturn `${baseMsg} in ${durationMs}ms`;\n\t}\n\n\treturn baseMsg;\n});\n\nexport const logger = createLogger({\n\tsilent: process.env[\"prismic_e2e_tests_utils_silent\"] === \"true\",\n\tlevel: process.env[\"prismic_e2e_tests_utils_log_level\"] || \"info\",\n\tformat: combine(customFormat),\n\ttransports: [new transports.Console()],\n});\n"],"names":[],"mappings":";AAIa,MAAA,kBAAkB,CAAC,aAAiC;AAC1D,QAAA,EAAE,QAAQ,KAAS,IAAA;AACzB,QAAM,EAAE,UAAU,IAAI,MAAM,OAAO,SAAS;AAGtC,QAAA,UAAU,IAAI,WAAW,MAAM,IAAI,MAAM,GAAG,OAAO,IAAI,GAAG;AAEzD,SAAA,KACN,WAAW,OAAO,sBAAsB,MAAM,KAAK,KAAK,UAAU,IAAI,CAAC,EAAE;AAE3E;AAEa,MAAA,2BAA2B,OACvC,aACkB;AAClB,SAAO,KACN,WAAW,SAAS,IAAK,CAAA,sBAAsB,SAAS,OAAQ,CAAA,KAAK,KAAK,UACzE,MAAM,SAAS,KAAM,CAAA,CACrB,EAAE;AAEL;AAEA,MAAM,EAAE,SAAS,OAAW,IAAA;AAE5B,MAAM,eAAe,OAAO,CAAC,EAAE,SAAS,iBAAgB;AACjD,QAAA,UAAU,eAAe,OAAO;AACtC,MAAI,YAAY;AACR,WAAA,GAAG,OAAO,OAAO,UAAU;AAAA,EACnC;AAEO,SAAA;AACR,CAAC;AAEM,MAAM,SAAS,aAAa;AAAA,EAClC,QAAQ,QAAQ,IAAI,gCAAgC,MAAM;AAAA,EAC1D,OAAO,QAAQ,IAAI,mCAAmC,KAAK;AAAA,EAC3D,QAAQ,QAAQ,YAAY;AAAA,EAC5B,YAAY,CAAC,IAAI,WAAW,SAAS;AACrC,CAAA;"}

package/dist/utils/urls.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"urls.cjs","sources":["../../../src/utils/urls.ts"],"sourcesContent":["/**\n * Build a repository base url from the prismic base url\n *\n * @param baseUrl - prismic base url like prismic.io\n * @param repository - the repository name\n *\n * @returns the repository url like https://my-repo.prismic.io\n */\nexport function getRepositoryUrl(baseUrl: string, repository: string): string {\n\tconst url = new URL(baseUrl);\n\turl.hostname = `${repository}.${url.hostname}`;\n\n\treturn url.toString();\n}\n\n/**\n * Prevent issues when building urls using `URL` that contain sub path without\n * trailing slashes.\n *\n * @returns the original url with a trailing slash, if needed.\n */\nexport function appendTrailingSlash(url: string): string {\n\tif (!url.endsWith(\"/\")) {\n\t\treturn url + \"/\";\n\t}\n\n\treturn url;\n}\n"],"names":[],"mappings":";;AAQgB,SAAA,iBAAiB,SAAiB,YAAkB;AAC7D,QAAA,MAAM,IAAI,IAAI,OAAO;AAC3B,MAAI,WAAW,GAAG,UAAU,IAAI,IAAI,QAAQ;AAE5C,SAAO,IAAI,SAAQ;AACpB;AAQM,SAAU,oBAAoB,KAAW;AAC9C,MAAI,CAAC,IAAI,SAAS,GAAG,GAAG;AACvB,WAAO,MAAM;AAAA,EAAA;AAGP,SAAA;AACR;;;"}
+{"version":3,"file":"urls.cjs","sources":["../../../src/utils/urls.ts"],"sourcesContent":["/**\n * Build a repository base url from the prismic base url\n *\n * @param baseUrl - prismic base url like prismic.io\n * @param repository - the repository name\n *\n * @returns the repository url like https://my-repo.prismic.io\n */\nexport function getRepositoryUrl(baseUrl: string, repository: string): string {\n\tconst url = new URL(baseUrl);\n\turl.hostname = `${repository}.${url.hostname}`;\n\n\treturn url.toString();\n}\n\n/**\n * Prevent issues when building urls using `URL` that contain sub path without\n * trailing slashes.\n *\n * @returns the original url with a trailing slash, if needed.\n */\nexport function appendTrailingSlash(url: string): string {\n\tif (!url.endsWith(\"/\")) {\n\t\treturn url + \"/\";\n\t}\n\n\treturn url;\n}\n"],"names":[],"mappings":";;AAQgB,SAAA,iBAAiB,SAAiB,YAAkB;AAC7D,QAAA,MAAM,IAAI,IAAI,OAAO;AAC3B,MAAI,WAAW,GAAG,UAAU,IAAI,IAAI,QAAQ;AAE5C,SAAO,IAAI;AACZ;AAQM,SAAU,oBAAoB,KAAW;AAC9C,MAAI,CAAC,IAAI,SAAS,GAAG,GAAG;AACvB,WAAO,MAAM;AAAA,EACd;AAEO,SAAA;AACR;;;"}

package/dist/utils/urls.js.map

@@ -1 +1 @@
-{"version":3,"file":"urls.js","sources":["../../../src/utils/urls.ts"],"sourcesContent":["/**\n * Build a repository base url from the prismic base url\n *\n * @param baseUrl - prismic base url like prismic.io\n * @param repository - the repository name\n *\n * @returns the repository url like https://my-repo.prismic.io\n */\nexport function getRepositoryUrl(baseUrl: string, repository: string): string {\n\tconst url = new URL(baseUrl);\n\turl.hostname = `${repository}.${url.hostname}`;\n\n\treturn url.toString();\n}\n\n/**\n * Prevent issues when building urls using `URL` that contain sub path without\n * trailing slashes.\n *\n * @returns the original url with a trailing slash, if needed.\n */\nexport function appendTrailingSlash(url: string): string {\n\tif (!url.endsWith(\"/\")) {\n\t\treturn url + \"/\";\n\t}\n\n\treturn url;\n}\n"],"names":[],"mappings":"AAQgB,SAAA,iBAAiB,SAAiB,YAAkB;AAC7D,QAAA,MAAM,IAAI,IAAI,OAAO;AAC3B,MAAI,WAAW,GAAG,UAAU,IAAI,IAAI,QAAQ;AAE5C,SAAO,IAAI,SAAQ;AACpB;AAQM,SAAU,oBAAoB,KAAW;AAC9C,MAAI,CAAC,IAAI,SAAS,GAAG,GAAG;AACvB,WAAO,MAAM;AAAA,EAAA;AAGP,SAAA;AACR;"}
+{"version":3,"file":"urls.js","sources":["../../../src/utils/urls.ts"],"sourcesContent":["/**\n * Build a repository base url from the prismic base url\n *\n * @param baseUrl - prismic base url like prismic.io\n * @param repository - the repository name\n *\n * @returns the repository url like https://my-repo.prismic.io\n */\nexport function getRepositoryUrl(baseUrl: string, repository: string): string {\n\tconst url = new URL(baseUrl);\n\turl.hostname = `${repository}.${url.hostname}`;\n\n\treturn url.toString();\n}\n\n/**\n * Prevent issues when building urls using `URL` that contain sub path without\n * trailing slashes.\n *\n * @returns the original url with a trailing slash, if needed.\n */\nexport function appendTrailingSlash(url: string): string {\n\tif (!url.endsWith(\"/\")) {\n\t\treturn url + \"/\";\n\t}\n\n\treturn url;\n}\n"],"names":[],"mappings":"AAQgB,SAAA,iBAAiB,SAAiB,YAAkB;AAC7D,QAAA,MAAM,IAAI,IAAI,OAAO;AAC3B,MAAI,WAAW,GAAG,UAAU,IAAI,IAAI,QAAQ;AAE5C,SAAO,IAAI;AACZ;AAQM,SAAU,oBAAoB,KAAW;AAC9C,MAAI,CAAC,IAAI,SAAS,GAAG,GAAG;AACvB,WAAO,MAAM;AAAA,EACd;AAEO,SAAA;AACR;"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/e2e-tests-utils",
-	"version": "2.0.0-alpha.2",
+	"version": "2.0.0-alpha.5",
 	"description": "A collection of utilities for to manage Prismic test data",
 	"keywords": [
 		"typescript",

package/src/clients/authenticationApi.ts

@@ -2,6 +2,7 @@ import { APIRequestContext, request } from "@playwright/test";
 
 import { AuthConfig } from "../types";
 
+import { login as authenticateWithLambda } from "../utils/authentication";
 import { logPlaywrightApiResponse, logger } from "../utils/log";
 
 /** Client for interacting with the authentication service to manage tokens */
@@ -27,17 +28,13 @@ export class AuthenticationApiClient {
 	private async login(): Promise<string> {
 		const profiler = logger.startTimer();
 
-		const context = await this.getContext();
-		const result = await context.post("login", {
-			data: {
-				email: this.auth.email,
-				password: this.auth.password,
-			},
-		});
+		const { token } = await authenticateWithLambda(
+			this.baseURL,
+			this.auth.email,
+			this.auth.password,
+		);
 
-		const token = await result.text();
-		if (!result.ok() || !token) {
-			logPlaywrightApiResponse(result);
+		if (!token) {
 			throw new Error("Authentication failed, no token received.");
 		}
 

package/src/clients/manageV2.ts

@@ -47,9 +47,8 @@ export class ManageV2Client {
 	 * The function generates a JWT token using the provided configuration
 	 * parameters.
 	 *
-	 * @param {ManageV2Config} config - The `config` parameter in the
-	 *   `generateToken` function is of type `ManageV2Config`. It contains the
-	 *   following properties:
+	 * @param config - The `config` parameter in the `generateToken` function is
+	 *   of type `ManageV2Config`. It contains the following properties:
 	 *
 	 * @returns A JSON Web Token (JWT) is being returned by the `generateToken`
 	 *   function. The token is signed using the provided `config.secret` with the
@@ -97,8 +96,8 @@ export class ManageV2Client {
 	}
 
 	/**
-	 * The function `toggleRolePerLocal` enable or disable the role per local
-	 * feature
+	 * The function `toggleRolePerLocal` enables or disables the RolesPerLocale
+	 * workflow
 	 *
 	 * @param repository - The Repository name
 	 * @param enabled - The feature new status
@@ -113,6 +112,23 @@ export class ManageV2Client {
 		},
 	);
 
+	/**
+	 * The function `toggleCustomRoles` enables or disables the CustomRoles
+	 * workflow
+	 *
+	 * @param repository - The Repository name
+	 * @param enabled - The feature new status
+	 */
+	toggleCustomRoles = this.assertTokenExist(
+		(params: { repository: string; enabled: boolean }) => {
+			return this.client.post("/repository/toggleCustomRoles", {
+				domain: params.repository,
+				enabled: params.enabled,
+				author: ManageV2StaticAuthor,
+			});
+		},
+	);
+
 	/**
 	 * The function `changePlan` changes the plan of a repository the database
 	 *

package/src/clients/wroom.ts

@@ -2,8 +2,8 @@ import axios, { AxiosInstance, AxiosResponse } from "axios";
 
 import { AuthConfig } from "../types";
 
+import { login } from "../utils/authentication";
 import { extractCookie } from "../utils/cookies";
-import { logHttpResponse, logger } from "../utils/log";
 import { getRepositoryUrl } from "../utils/urls";
 
 /**
@@ -97,9 +97,9 @@ export class WroomClient {
 	/**
 	 * Update the role of a user in the repository
 	 *
-	 * @param {string} repository - The repository name
-	 * @param {string} email - The email of the user
-	 * @param {string} role - The new role to be given
+	 * @param repository - The repository name
+	 * @param email - The email of the user
+	 * @param role - The new role to be given
 	 *
 	 * @returns The Axios Reponse
 	 */
@@ -117,9 +117,9 @@ export class WroomClient {
 	/**
 	 * Update the role of a user in the repository
 	 *
-	 * @param {string} repository - The repository name
-	 * @param {string} email - The email of the user
-	 * @param {string} rolePerLocal - The role per local object
+	 * @param repository - The repository name
+	 * @param email - The email of the user
+	 * @param rolePerLocal - The role per local object
 	 *
 	 * @returns The Axios Reponse
 	 */
@@ -140,17 +140,14 @@ export class WroomClient {
 	 * @throws Error if the login to Wroom fails.
 	 */
 	private async login(): Promise<void> {
-		const profiler = logger.startTimer();
-		const response = await this.client.post<string>("/authentication/signin", {
-			email: this.auth.email,
-			password: this.auth.password,
-		});
-
-		if (response.status !== 200) {
-			logHttpResponse(response);
-			throw new Error("Could not login to Prismic, check your credentials");
+		const { cookies } = await login(
+			this.getBaseURL(),
+			this.auth.email,
+			this.auth.password,
+		);
+		if (cookies && extractCookie(cookies, "prismic-auth")) {
+			this.client.defaults.headers["Cookie"] = cookies;
 		}
 		this.loggedIn = true;
-		profiler.done({ message: "logged in to Prismic" });
 	}
 }

package/src/managers/repositories.ts

@@ -137,7 +137,7 @@ export class RepositoriesManager {
 			"authentication/newrepository",
 			{
 				domain: repositoryName,
-				framework: "vue",
+				framework: "next",
 				plan: "personal",
 				isAnnual: "false",
 				role: "developer",

package/src/managers/repository.ts

@@ -87,6 +87,10 @@ export class RepositoryManager {
 		if (config.rolePerLocal) {
 			await this.toggleRolePerLocal(true);
 		}
+
+		if (config.customRoles) {
+			await this.toggleCustomRoles(true);
+		}
 	}
 
 	/** @returns the repository base url, like https://my-repo.prismic.io */
@@ -497,7 +501,7 @@ export class RepositoryManager {
 	}
 
 	/**
-	 * Toggle the Role per local feature
+	 * Toggle the Role per Locale workflow
 	 *
 	 * @param enabled - The feature new status
 	 */
@@ -520,10 +524,34 @@ export class RepositoryManager {
 		});
 	}
 
+	/**
+	 * Toggle the Custom Roles workflow
+	 *
+	 * @param enabled - The feature new status
+	 */
+	async toggleCustomRoles(enabled: boolean): Promise<void> {
+		const profiler = logger.startTimer();
+
+		const response = await this.manageV2Client.toggleCustomRoles({
+			repository: this.name,
+			enabled: enabled,
+		});
+
+		this.failIfNot200(
+			response,
+			`Could not ${enabled ? "enable" : "disable"} Custom Roles for ${
+				this.name
+			}`,
+		);
+		profiler.done({
+			message: `Custom Roles ${enabled ? "enabled" : "disabled"}`,
+		});
+	}
+
 	/**
 	 * Change the Repository Plan
 	 *
-	 * @param {string} newPlanId - The Id of the new Plan to apply
+	 * @param newPlanId - The Id of the new Plan to apply
 	 */
 	async changePlan(newPlanId: string): Promise<void> {
 		const profiler = logger.startTimer();
@@ -543,7 +571,7 @@ export class RepositoryManager {
 	/**
 	 * Add a new user to the repository
 	 *
-	 * @param {string} email - The email of the user
+	 * @param email - The email of the user
 	 */
 	async addUser(email: string): Promise<void> {
 		const profiler = logger.startTimer();
@@ -570,7 +598,7 @@ export class RepositoryManager {
 	/**
 	 * Remove a user from the repository
 	 *
-	 * @param {string} email - The email of the user
+	 * @param email - The email of the user
 	 */
 	async removeUser(email: string): Promise<void> {
 		const profiler = logger.startTimer();
@@ -592,10 +620,9 @@ export class RepositoryManager {
 	/**
 	 * Update the role of a user in a repository
 	 *
-	 * @param {string} email - The email of the user
-	 * @param {string | Record<string, string>} role - The new Role of the user,
-	 *   either a string for basic workflow or an object such as `{ "lang_id":
-	 *   "Writer" }`
+	 * @param email - The email of the user
+	 * @param role - The new Role of the user, either a string for basic workflow
+	 *   or an object such as `{ "lang_id": "Writer" }`
 	 *
 	 *   Example of roles are
 	 *
@@ -699,6 +726,7 @@ export type RepositoryConfig = {
 	customTypes?: CustomType[];
 	preview?: Preview;
 	rolePerLocal?: boolean;
+	customRoles?: boolean;
 };
 
 export type Preview = {

package/src/utils/authentication.ts

@@ -0,0 +1,51 @@
+import axios from "axios";
+
+import { logHttpResponse, logger } from "./log";
+
+export async function login(
+	baseUrl: string,
+	email: string,
+	password: string,
+): Promise<{ token: string; cookies: string[] | undefined }> {
+	const profiler = logger.startTimer();
+
+	const payload = {
+		email,
+		password,
+	};
+
+	const url = transformUrl(baseUrl, "auth.internal");
+
+	const response = await axios.post<{ access_token: string }>(url, payload, {
+		headers: {
+			"User-Agent": "prismic-cli/prismic-e2e-tests-utils",
+			Authorization:
+				"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NDE3ODQ5NDEsImF1ZCI6ImF1dGgwLWFjdGlvbnMiLCJpc3MiOiJwcmlzbWljLmlvIn0.1UPoVMXJSTWtsyNzK5XYftK_mW0ScVuXwCK69nsyf5c",
+		},
+	});
+
+	if (response.status !== 200) {
+		logHttpResponse(response);
+		throw new Error("Could not obtain OAuth token, check your credentials");
+	}
+
+	profiler.done({ message: "logged in via OAuth" });
+	const token = response.data.access_token;
+
+	return { token, cookies: response.headers["set-cookie"] };
+}
+
+function transformUrl(baseUrl: string, subdomainPrefix: string): string {
+	try {
+		const url = new URL(baseUrl);
+		const domainParts = url.hostname.split(".");
+
+		// Insert the custom subdomain prefix before the existing hostname
+		const transformedHostname = `${subdomainPrefix}.${domainParts.join(".")}`;
+
+		// Construct the new URL with the modified hostname
+		return `${url.protocol}//${transformedHostname}`;
+	} catch (error) {
+		throw new Error(`Invalid URL: ${baseUrl}`);
+	}
+}