@bigbinary/neeto-playwright-commons 1.1.3 → 1.2.0

package/index.d.ts

@@ -19,13 +19,13 @@ interface VerifySuccessToastParams {
     closeAfterVerification: boolean;
 }
 type VerifySuccessToast = (params: VerifySuccessToastParams) => Promise<void>;
-declare const HTTP_METHODS: readonly ["get", "post", "put", "delete", "GET", "POST", "PUT", "DELETE"];
 type BasicTypesInterface = Record<string, number | string | boolean>;
+type HttpMethods = "get" | "post" | "put" | "delete";
 interface ApiRequestProps {
     url: string;
     headers?: BasicTypesInterface;
     data?: Record<string, unknown>;
-    method?: typeof HTTP_METHODS[number];
+    method?: HttpMethods;
     params?: BasicTypesInterface;
 }
 type ApiRequest = (props: ApiRequestProps & Record<string, unknown>) => Promise<APIResponse | undefined>;
@@ -55,7 +55,7 @@ interface CustomFixture {
 type Commands = Fixtures<CustomFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 declare const commands: Commands;
 
-declare const stagingData: {
+declare const generateStagingData: (product?: string) => {
     firstName: string;
     lastName: string;
     otp: number;
@@ -93,7 +93,7 @@ declare class OrganizationPage {
     neetoPlaywrightUtilities: CustomCommands;
     constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
     createOrganization: ({ email, businessName, subdomainName, firstName, lastName, appName, }: CreateOrganizationProps) => Promise<void>;
-    setupOrganization: () => Promise<void>;
+    setupOrganization: (product: string) => Promise<void>;
     updateSubdomainIfExists: (appName: string) => Promise<void>;
 }
 
@@ -107,6 +107,7 @@ declare const STORAGE_STATE = "./e2e/auth/user.json";
 declare const GLOBAL_TRANSLATIONS_PATTERN = "../node_modules/@bigbinary/**/translations/en.json";
 declare const PROJECT_TRANSLATIONS_PATH = "../app/javascript/src/translations/en.json";
 declare const CREDENTIALS: {
+    name: string;
     email: string;
     password: string;
 };
@@ -166,7 +167,7 @@ declare const COMMON_TEXTS: {
     edit: string;
 };
 
-declare const initializeCredentials: () => void;
+declare const initializeCredentials: (product: string) => void;
 
 interface KeyValue {
     key: string;
@@ -191,9 +192,10 @@ declare const readTranslations: () => Record<string, unknown>;
 interface LoginProps {
     page: Page;
     neetoPlaywrightUtilities: CustomCommands;
+    loginPath: string;
 }
-declare const loginWithoutSSO: ({ page, neetoPlaywrightUtilities, }: LoginProps) => Promise<void>;
-declare const login: ({ page, neetoPlaywrightUtilities }: LoginProps) => Promise<false | void>;
+declare const loginWithoutSSO: ({ page, neetoPlaywrightUtilities, loginPath, }: LoginProps) => Promise<void>;
+declare const login: ({ page, neetoPlaywrightUtilities, loginPath, }: LoginProps) => Promise<false | void>;
 
 interface CurrentsOverrides {
     projectId: string;
@@ -206,4 +208,4 @@ interface Overrides {
 }
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
 
-export { BASE_URL, COMMON_SELECTORS, COMMON_TEXTS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, IS_STAGING_ENV, LOGIN_SELECTORS, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, clearCredentials, commands, definePlaywrightConfig, i18n, initializeCredentials, joinString, login, loginWithoutSSO, readFileSyncIfExists, readTranslations, stagingData, updateCredentials, writeDataToFile };
+export { BASE_URL, COMMON_SELECTORS, COMMON_TEXTS, CREDENTIALS, CustomCommands, type CustomFixture, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, IS_STAGING_ENV, LOGIN_SELECTORS, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, clearCredentials, commands, definePlaywrightConfig, generateStagingData, i18n, initializeCredentials, joinString, login, loginWithoutSSO, readFileSyncIfExists, readTranslations, updateCredentials, writeDataToFile };

package/index.js

@@ -1,4 +1,5 @@
 import { expect, defineConfig, devices } from '@playwright/test';
+import dayjs from 'dayjs';
 import * as require$$0 from 'fs';
 import require$$0__default from 'fs';
 import require$$2 from 'os';
@@ -6,8 +7,7 @@ import require$$0$1 from 'path';
 import require$$0$2 from 'util';
 import require$$0$3 from 'stream';
 import require$$0$4 from 'events';
-import { mergeDeepLeft } from 'ramda';
-import dayjs from 'dayjs';
+import { mergeDeepLeft, mergeAll } from 'ramda';
 import require$$3 from 'crypto';
 
 const COMMON_SELECTORS = {
@@ -23,6 +23,115 @@ const COMMON_SELECTORS = {
     subheaderText: "subheader-left",
 };
 
+class CustomCommands {
+    constructor(page, request) {
+        this.interceptMultipleResponses = ({ responseUrl = "", times = 1, baseUrl, }) => Promise.all([...new Array(times)].map(() => this.page.waitForResponse((response) => {
+            var _a, _b, _c;
+            if (response.request().resourceType() === "xhr" &&
+                response.status() === 200 &&
+                response.url().includes(responseUrl) &&
+                response
+                    .url()
+                    .startsWith((_a = baseUrl !== null && baseUrl !== void 0 ? baseUrl : process.env.BASE_URL) !== null && _a !== void 0 ? _a : "") &&
+                !this.responses.includes((_b = response.headers()) === null || _b === void 0 ? void 0 : _b["x-request-id"])) {
+                this.responses.push((_c = response.headers()) === null || _c === void 0 ? void 0 : _c["x-request-id"]);
+                return true;
+            }
+            return false;
+        }, { timeout: 10000 })));
+        this.recursiveMethod = async (callback, condition, timeout, startTime) => {
+            if (Date.now() - timeout >= startTime) {
+                return false;
+            }
+            else if (await condition()) {
+                return await callback();
+            }
+            return await this.recursiveMethod(callback, condition, timeout, startTime);
+        };
+        this.executeRecursively = async ({ callback, condition, timeout = 5000, }) => {
+            const startTime = Date.now();
+            await this.recursiveMethod(callback, condition, timeout, startTime);
+        };
+        this.verifySuccessToast = async ({ message, closeAfterVerification = true, }) => {
+            if (message) {
+                await expect(this.page.getByTestId(COMMON_SELECTORS.toastMessage)).toHaveValue(message);
+            }
+            else {
+                await expect(this.page.locator(COMMON_SELECTORS.toastIcon)).toHaveValue("👍");
+                closeAfterVerification &&
+                    (await this.page
+                        .getByTestId(COMMON_SELECTORS.toastCloseButton)
+                        .click());
+            }
+        };
+        this.reloadAndWait = async (requestCount) => {
+            const reloadRequests = this.interceptMultipleResponses({
+                times: requestCount,
+            });
+            await this.page.reload();
+            await reloadRequests;
+        };
+        this.apiRequest = async ({ url, headers: additionalHeaders, body: data, method = "get", params = {}, ...otherOptions }) => {
+            const csrfToken = await this.page
+                .locator("[name='csrf-token']")
+                .getAttribute("content");
+            const requestOptions = {
+                headers: {
+                    ...additionalHeaders,
+                    "accept-encoding": "gzip",
+                    "x-csrf-token": csrfToken !== null && csrfToken !== void 0 ? csrfToken : "",
+                },
+                data,
+                params,
+                ...otherOptions,
+            };
+            const httpMethodsHandlers = {
+                get: () => this.request.get(url, requestOptions),
+                post: () => this.request.post(url, requestOptions),
+                put: () => this.request.put(url, requestOptions),
+                delete: () => this.request.delete(url, requestOptions),
+            };
+            return await httpMethodsHandlers[method]();
+        };
+        this.verifyFieldValue = values => {
+            const verifyEachFieldValue = ({ field, value, }) => expect(this.page.getByTestId(field)).toHaveValue(value);
+            return Array.isArray(values)
+                ? Promise.all(values.map(value => verifyEachFieldValue(value)))
+                : verifyEachFieldValue(values);
+        };
+        this.page = page;
+        this.responses = [];
+        this.request = request;
+    }
+}
+
+const commands = {
+    neetoPlaywrightUtilities: async ({ page, request }, use) => {
+        const commands = new CustomCommands(page, request);
+        await use(commands);
+    },
+    page: async ({ page }, use) => {
+        await page.goto("/");
+        await page.waitForLoadState();
+        await use(page);
+    },
+};
+
+const ENVIRONMENT = {
+    development: "development",
+    staging: "staging",
+    review: "review",
+};
+const IS_STAGING_ENV = process.env.TEST_ENV === "staging";
+const STORAGE_STATE = "./e2e/auth/user.json";
+const GLOBAL_TRANSLATIONS_PATTERN = "../node_modules/@bigbinary/**/translations/en.json";
+const PROJECT_TRANSLATIONS_PATH = "../app/javascript/src/translations/en.json";
+const CREDENTIALS = {
+    name: "Oliver Smith",
+    email: "oliver@example.com",
+    password: "welcome",
+};
+
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 var tasks = {};
@@ -6721,17 +6830,6 @@ function assertPatternsInput(input) {
 }
 var out = FastGlob;
 
-const ENVIRONMENT = {
-    development: "development",
-    staging: "staging",
-    review: "review",
-};
-const IS_STAGING_ENV = process.env.TEST_ENV === "staging";
-const STORAGE_STATE = "./e2e/auth/user.json";
-const GLOBAL_TRANSLATIONS_PATTERN = "../node_modules/@bigbinary/**/translations/en.json";
-const PROJECT_TRANSLATIONS_PATH = "../app/javascript/src/translations/en.json";
-const CREDENTIALS = { email: "oliver@example.com", password: "welcome" };
-
 const joinString = (string1, string2, string3 = "", separator = " ") => {
     if (string3 === "") {
         return string1 + separator + string2;
@@ -6777,112 +6875,26 @@ const readTranslations = () => {
     return translations;
 };
 
-class CustomCommands {
-    constructor(page, request) {
-        this.interceptMultipleResponses = ({ responseUrl = "", times = 1, baseUrl, }) => Promise.all([...new Array(times)].map(() => this.page.waitForResponse(response => {
-            var _a, _b, _c;
-            if (response.request().resourceType() === "xhr" &&
-                response.status() === 200 &&
-                response.url().includes(responseUrl) &&
-                response
-                    .url()
-                    .startsWith((_a = baseUrl !== null && baseUrl !== void 0 ? baseUrl : process.env.BASE_URL) !== null && _a !== void 0 ? _a : "") &&
-                !this.responses.includes((_b = response.headers()) === null || _b === void 0 ? void 0 : _b["x-request-id"])) {
-                this.responses.push((_c = response.headers()) === null || _c === void 0 ? void 0 : _c["x-request-id"]);
-                return true;
-            }
-            return false;
-        }, { timeout: 10000 })));
-        this.recursiveMethod = async (callback, condition, timeout, startTime) => {
-            if (Date.now() - timeout >= startTime) {
-                return false;
-            }
-            else if (await condition()) {
-                return await callback();
-            }
-            return await this.recursiveMethod(callback, condition, timeout, startTime);
-        };
-        this.executeRecursively = async ({ callback, condition, timeout = 5000, }) => {
-            const startTime = Date.now();
-            await this.recursiveMethod(callback, condition, timeout, startTime);
-        };
-        this.verifySuccessToast = async ({ message, closeAfterVerification = true, }) => {
-            if (message) {
-                await expect(this.page.getByTestId(COMMON_SELECTORS.toastMessage)).toHaveValue(message);
-            }
-            else {
-                await expect(this.page.locator(COMMON_SELECTORS.toastIcon)).toHaveValue("👍");
-                closeAfterVerification &&
-                    (await this.page
-                        .getByTestId(COMMON_SELECTORS.toastCloseButton)
-                        .click());
-            }
-        };
-        this.reloadAndWait = async (requestCount) => {
-            const reloadRequests = this.interceptMultipleResponses({
-                times: requestCount,
-            });
-            await this.page.reload();
-            await reloadRequests;
-        };
-        this.apiRequest = async ({ url, headers: additionalHeaders, body: data, method = "get", params = {}, ...otherOptions }) => {
-            const { headers } = readFileSyncIfExists();
-            const requestOptions = {
-                headers: { ...headers, ...additionalHeaders, "accept-encoding": "gzip" },
-                data,
-                params,
-                ...otherOptions,
-            };
-            const httpMethodsHandlers = {
-                get: () => this.request.get(url, requestOptions),
-                post: () => this.request.post(url, requestOptions),
-                put: () => this.request.put(url, requestOptions),
-                delete: () => this.request.delete(url, requestOptions),
-            };
-            return await httpMethodsHandlers[method.toLowerCase()]();
-        };
-        this.verifyFieldValue = values => {
-            const verifyEachFieldValue = ({ field, value, }) => expect(this.page.getByTestId(field)).toHaveValue(value);
-            return Array.isArray(values)
-                ? Promise.all(values.map(value => verifyEachFieldValue(value)))
-                : verifyEachFieldValue(values);
-        };
-        this.page = page;
-        this.responses = [];
-        this.request = request;
-    }
-}
-
-const commands = {
-    neetoPlaywrightUtilities: async ({ page, request }, use) => {
-        const commands = new CustomCommands(page, request);
-        await use(commands);
-    },
-    page: async ({ page }, use) => {
-        await page.goto("/");
-        await page.waitForLoadState();
-        await use(page);
-    },
-};
-
-const timestamp = dayjs().format("YYYYMMDDHH");
-const firstName = "André";
-const lastName = "O'Reilly";
-const stagingOrganization = `cypresstest-invoice-${timestamp}`;
-const otpBypassKey = process.env.OTP_BYPASS_KEY;
-const stagingData = {
-    firstName,
-    lastName,
-    otp: 111111,
-    domain: "neetoinvoice.net",
-    currentUserName: IS_STAGING_ENV
-        ? joinString(firstName, lastName)
-        : "Oliver Smith",
-    businessName: stagingOrganization,
-    subdomainName: IS_STAGING_ENV ? stagingOrganization : "spinkart",
-    email: IS_STAGING_ENV
-        ? `cypresstest${otpBypassKey}+invoice+${timestamp}-playwright@bigbinary.com`
-        : "oliver@example.com",
+const generateStagingData = (product = "invoice") => {
+    const timestamp = dayjs().format("YYYYMMDDHH");
+    const firstName = "André";
+    const lastName = "O'Reilly";
+    const otpBypassKey = process.env.OTP_BYPASS_KEY;
+    const stagingOrganization = `cypresstest-${product}-${timestamp}`;
+    return {
+        firstName,
+        lastName,
+        otp: 111111,
+        domain: `neeto${product}.net`,
+        currentUserName: IS_STAGING_ENV
+            ? joinString(firstName, lastName)
+            : CREDENTIALS.name,
+        businessName: stagingOrganization,
+        subdomainName: IS_STAGING_ENV ? stagingOrganization : "spinkart",
+        email: IS_STAGING_ENV
+            ? `cypresstest${otpBypassKey}+${product}+${timestamp}-playwright@bigbinary.com`
+            : "oliver@example.com",
+    };
 };
 
 const i18n = {
@@ -6987,10 +6999,9 @@ class OrganizationPage {
             await this.page.getByTestId(SIGNUP_SELECTORS.profileSubmitButton).click();
             await submitProfile;
         };
-        this.setupOrganization = async () => {
+        this.setupOrganization = async (product) => {
             if (!IS_STAGING_ENV)
                 return;
-            let headers = {};
             const { user } = readFileSyncIfExists();
             await this.createOrganization({
                 businessName: user.businessName,
@@ -6998,20 +7009,15 @@ class OrganizationPage {
                 firstName: user.firstName,
                 lastName: user.lastName,
                 subdomainName: user.subdomainName,
-                appName: "neetoInvoice",
-            });
-            await this.page.route(`**${ROUTES.neetoApps}`, async (route) => {
-                headers = await route.request().allHeaders();
-                await route.continue();
+                appName: `neeto${product}`,
             });
             await expect(this.page.locator(COMMON_SELECTORS.spinner)).toBeHidden();
             const userCredentials = readFileSyncIfExists();
             await this.page.context().storageState({ path: STORAGE_STATE });
-            const mergedCredentials = {
-                ...readFileSyncIfExists(),
-                ...userCredentials,
-                headers,
-            };
+            const mergedCredentials = mergeAll([
+                readFileSyncIfExists(),
+                userCredentials,
+            ]);
             writeDataToFile(JSON.stringify(mergedCredentials, null, 2));
         };
         this.updateSubdomainIfExists = async (appName) => {
@@ -7065,8 +7071,9 @@ const LOGIN_SELECTORS = {
 
 const COMMON_TEXTS = { edit: "Edit" };
 
-const initializeCredentials = () => {
+const initializeCredentials = (product) => {
     const { user } = readFileSyncIfExists();
+    const stagingData = generateStagingData(product);
     const newState = {
         ...user,
         businessName: (user === null || user === void 0 ? void 0 : user.businessName) || stagingData.businessName,
@@ -7084,10 +7091,9 @@ const initializeCredentials = () => {
     }
 };
 
-const loginWithoutSSO = async ({ page, neetoPlaywrightUtilities, }) => {
+const loginWithoutSSO = async ({ page, neetoPlaywrightUtilities, loginPath = "/", }) => {
     var _a;
-    await page.goto((_a = process.env.BASE_URL) !== null && _a !== void 0 ? _a : "");
-    let headers = {};
+    await page.goto((_a = `${process.env.BASE_URL}${loginPath}`) !== null && _a !== void 0 ? _a : "");
     await page.getByTestId("login-email-text-field").fill(CREDENTIALS.email);
     await page
         .getByTestId("login-password-text-field")
@@ -7097,23 +7103,16 @@ const loginWithoutSSO = async ({ page, neetoPlaywrightUtilities, }) => {
     });
     await page.getByTestId(LOGIN_SELECTORS.submitButton).click();
     await login;
-    await page.route(`**${BASE_URL}/**`, async (route) => {
-        headers = await route.request().allHeaders();
-        await route.continue();
-    });
     const userCredentials = readFileSyncIfExists();
     await page.context().storageState({ path: STORAGE_STATE });
-    //eslint-disable-next-line
-    await page.waitForTimeout(5000); // There is a delay in headers being set from the route.
-    const mergedCredentials = {
-        ...readFileSyncIfExists(),
-        ...userCredentials,
-        headers,
-    };
+    const mergedCredentials = mergeAll([
+        readFileSyncIfExists(),
+        userCredentials,
+    ]);
     writeDataToFile(JSON.stringify(mergedCredentials, null, 2));
 };
-const login = async ({ page, neetoPlaywrightUtilities }) => !IS_STAGING_ENV &&
-    (await loginWithoutSSO({ page, neetoPlaywrightUtilities }));
+const login = async ({ page, neetoPlaywrightUtilities, loginPath, }) => !IS_STAGING_ENV &&
+    (await loginWithoutSSO({ page, neetoPlaywrightUtilities, loginPath }));
 
 var main$1 = {exports: {}};
 
@@ -7563,5 +7562,5 @@ const definePlaywrightConfig = (overrides) => {
     });
 };
 
-export { BASE_URL, COMMON_SELECTORS, COMMON_TEXTS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, IS_STAGING_ENV, LOGIN_SELECTORS, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, clearCredentials, commands, definePlaywrightConfig, i18n, initializeCredentials, joinString, login, loginWithoutSSO, readFileSyncIfExists, readTranslations, stagingData, updateCredentials, writeDataToFile };
+export { BASE_URL, COMMON_SELECTORS, COMMON_TEXTS, CREDENTIALS, CustomCommands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, IS_STAGING_ENV, LOGIN_SELECTORS, OrganizationPage, PROJECT_TRANSLATIONS_PATH, ROUTES, SIGNUP_SELECTORS, STORAGE_STATE, clearCredentials, commands, definePlaywrightConfig, generateStagingData, i18n, initializeCredentials, joinString, login, loginWithoutSSO, readFileSyncIfExists, readTranslations, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map