@bigbinary/neeto-playwright-commons 1.1.0 → 1.1.2

package/index.d.ts

@@ -1,6 +1,101 @@
 import * as _playwright_test from '@playwright/test';
-import { Page } from '@playwright/test';
-import CustomCommands from '@utils/commands';
+import { Page, APIRequestContext, Response, APIResponse, Fixtures, PlaywrightWorkerArgs, PlaywrightWorkerOptions, PlaywrightTestArgs, PlaywrightTestOptions } from '@playwright/test';
+
+interface InterceptMultipleResponsesParams {
+    responseUrl: string;
+    times: number;
+    baseUrl: string;
+}
+type GenericCallback = (...params: any[]) => Promise<unknown> | unknown;
+type InterceptMultipleResponses = (params: Partial<InterceptMultipleResponsesParams>) => Promise<Response[]>;
+interface ExecuteRecursivelyParams {
+    callback: GenericCallback;
+    condition: GenericCallback;
+    timeout: number;
+}
+type ExecuteRecursively = (params: ExecuteRecursivelyParams) => Promise<void>;
+interface VerifySuccessToastParams {
+    message: string;
+    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>;
+interface ApiRequestProps {
+    url: string;
+    headers?: BasicTypesInterface;
+    data?: Record<string, unknown>;
+    method?: typeof HTTP_METHODS[number];
+    params?: BasicTypesInterface;
+}
+type ApiRequest = (props: ApiRequestProps & Record<string, unknown>) => Promise<APIResponse | undefined>;
+interface FieldValue {
+    field: string;
+    value: string;
+}
+type VerifyFieldValue = (values: FieldValue | FieldValue[]) => Promise<void> | Promise<void[]>;
+declare class CustomCommands {
+    page: Page;
+    responses: string[];
+    request: APIRequestContext;
+    constructor(page: Page, request: APIRequestContext);
+    interceptMultipleResponses: InterceptMultipleResponses;
+    private recursiveMethod;
+    executeRecursively: ExecuteRecursively;
+    verifySuccessToast: VerifySuccessToast;
+    reloadAndWait: (requestCount: number) => Promise<void>;
+    apiRequest: ApiRequest;
+    verifyFieldValue: VerifyFieldValue;
+}
+
+interface CustomFixture {
+    neetoPlaywrightUtilities: CustomCommands;
+    page: Page;
+}
+type Commands = Fixtures<CustomFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+declare const commands: Commands;
+
+declare const stagingData: {
+    firstName: string;
+    lastName: string;
+    otp: number;
+    domain: string;
+    currentUserName: string;
+    businessName: string;
+    subdomainName: string;
+    email: string;
+};
+
+declare const i18n: {
+    options: {
+        debug: boolean;
+        fallbackLng: string;
+        resources: {
+            en: {
+                translation: Record<string, unknown>;
+            };
+        };
+    };
+    cache: boolean;
+    auto: boolean;
+};
+
+interface CreateOrganizationProps {
+    email: string;
+    businessName: string;
+    subdomainName: string;
+    firstName: string;
+    lastName: string;
+    appName: string;
+}
+declare class OrganizationPage {
+    page: Page;
+    neetoPlaywrightUtilities: CustomCommands;
+    constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+    createOrganization: ({ email, businessName, subdomainName, firstName, lastName, appName, }: CreateOrganizationProps) => Promise<void>;
+    setupOrganization: () => Promise<void>;
+    updateSubdomainIfExists: (appName: string) => Promise<void>;
+}
 
 declare const ENVIRONMENT: {
     development: string;
@@ -11,14 +106,20 @@ declare const IS_STAGING_ENV: boolean;
 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: {
+    email: string;
+    password: string;
+};
 
-declare const BASE_URL = "/api/v1";
-declare const PROFILE_PATH = "/profile";
-declare const LOGIN_PATH = "/api/v1/login";
-declare const SIGNUP_PATH = "/api/v1/signups";
-declare const SUBDOMAIN_AVAILABILITY_PATH = "/api/v1/subdomain_availability";
-declare const COUNTRIES_PATH = "/api/v1/countries";
-declare const NEETO_APPS_PATH = "/api/v1/neeto_apps";
+declare const ROUTES: {
+    neetoAuth: string;
+    profile: string;
+    login: string;
+    signup: string;
+    subdomainAvailability: string;
+    countries: string;
+    neetoAps: string;
+};
 
 declare const COMMON_SELECTORS: {
     toastMessage: string;
@@ -34,16 +135,30 @@ declare const COMMON_SELECTORS: {
 };
 
 declare const SIGNUP_SELECTORS: {
-    emailField: string;
-    signupButton: string;
-    otpInput: string;
-    organizationField: string;
-    subdomainField: string;
-    submitButton: string;
-    firstNameField: string;
-    lastNameField: string;
+    emailTextField: string;
+    firstNameTextField: string;
+    lastNameTextField: string;
+    organizationNameTextField: string;
+    organizationSubmitButton: string;
+    otpTextBox: string;
     profileSubmitButton: string;
-    subdomainInputError: string;
+    signupViaEmailButton: string;
+    submitButton: string;
+    subdomainNameTextField: string;
+    subdomainError: string;
+    tryFreeButton: string;
+};
+
+declare const LOGIN_SELECTORS: {
+    appleAuthenticationButton: string;
+    emailTextField: string;
+    googleAuthenticationButton: string;
+    githubAuthenticationButton: string;
+    loginViaEmailButton: string;
+    passwordTextField: string;
+    rememberMeCheckBox: string;
+    submitButton: string;
+    twitterAuthenticationButton: string;
 };
 
 declare const COMMON_TEXTS: {
@@ -72,32 +187,22 @@ declare const updateCredentials: UpdateCredentials;
 declare const clearCredentials: ClearCredentials;
 declare const readTranslations: () => Record<string, unknown>;
 
-declare const stagingData: {
-    firstName: string;
-    lastName: string;
-    otp: number;
-    domain: string;
-    currentUserName: string;
-    businessName: string;
-    subdomainName: string;
-    email: string;
-};
-
-interface Commands {
-    neetoPlaywrightUtilities: CustomCommands;
+interface LoginProps {
     page: Page;
+    neetoPlaywrightUtilities: CustomCommands;
 }
-declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & Commands, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions>;
+declare const loginWithoutSSO: ({ page, neetoPlaywrightUtilities, }: LoginProps) => Promise<void>;
+declare const login: ({ page, neetoPlaywrightUtilities }: LoginProps) => Promise<false | void>;
 
 interface CurrentsOverrides {
     projectId: string;
 }
 interface Overrides {
-    globalOverrides?: Record<string, any>;
-    useOverrides?: Record<string, any>;
-    projectOverrides?: Record<string, any>[];
+    globalOverrides?: Record<string, unknown>;
+    useOverrides?: Record<string, unknown>;
+    projectOverrides?: Record<string, unknown>[];
     currentsOverrides: CurrentsOverrides & Record<string, unknown>;
 }
-declare const definePlaywrightConfig: (overrides: Overrides) => any;
+declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
 
-export { BASE_URL, COMMON_SELECTORS, COMMON_TEXTS, COUNTRIES_PATH, type Commands, ENVIRONMENT, GLOBAL_TRANSLATIONS_PATTERN, IS_STAGING_ENV, LOGIN_PATH, NEETO_APPS_PATH, PROFILE_PATH, PROJECT_TRANSLATIONS_PATH, SIGNUP_PATH, SIGNUP_SELECTORS, STORAGE_STATE, SUBDOMAIN_AVAILABILITY_PATH, clearCredentials, definePlaywrightConfig, initializeCredentials, joinString, readFileSyncIfExists, readTranslations, stagingData, test, updateCredentials, writeDataToFile };
+export { 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 };