@bigbinary/neeto-commons-frontend 2.0.30 → 2.0.31

package/cypress-utils.d.ts

@@ -0,0 +1,275 @@
+// selecotrs ------------------------------------------------
+
+type CommonSelectors = {
+  alertTitle: string;
+  alertModalSubmitButton: string;
+  checkbox: string;
+  checkboxLabel: string;
+  dropdownContainer: string;
+  dropdownIcon: string;
+  heading: string;
+  paneBody: string;
+  paneHeader: string;
+  selectOption: string;
+  toastMessage: string;
+  toastCloseButton: string;
+  windowAlert: string;
+};
+
+type MemberSelectors = {
+  addMember: string;
+  admin: string;
+  agent: string;
+  agents: string;
+  activeMembersHeading: string;
+  accountActivatedToastMessage: string;
+  activateMember: string;
+  activateMemberAlertMessage: string;
+  deactivateAccountToastMessage: string;
+  deactivateMember: string;
+  deactivateMemberAlertMessage: string;
+  editMember: string;
+  memberAddedMessage: string;
+  members: string;
+  newHeading: string;
+  updatedMemberRole: string;
+};
+
+type LoginSelectors = {
+  appleAuthenticationButton: string;
+  emailTextField: string;
+  googleAuthenticationButton: string;
+  githubAuthenticationButton: string;
+  loginViaEmailButton: string;
+  otpField: string;
+  passwordTextField: string;
+  rememberMeCheckBox: string;
+  submitButton: string;
+  twitterAuthenticationButton: string;
+};
+
+type ProfileSelectors = {
+  logoutLink: string;
+  profileOptionsContainer: string;
+};
+
+type SignUpSelectors = {
+  emailTextField: string;
+  firstNameTextField: string;
+  lastNameTextField: string;
+  organizationNameTextField: string;
+  organizationSubmitButton: string;
+  otpTextBox: string;
+  profileSubmitButton: string;
+  signupViaEmailButton: string;
+  submitButton: string;
+  subdomainNameTextField: string;
+};
+
+// texts ------------------------------------------------
+type CommonTexts = {
+  activate: string;
+  block: string;
+  copiedToClipboard: string;
+  crossSiteScript: string;
+  deactivate: string;
+  delete: string;
+  delete1: string;
+  edit: string;
+  invalidEmailMessage: string;
+  invalidSearchInput: string;
+  logout: string;
+  new: string;
+  takeAction: string;
+  unblock: string;
+};
+
+type MemberText = {
+  addMember: string;
+  admin: string;
+  agent: string;
+  agents: string;
+  activeMembersHeading: string;
+  accountActivatedToastMessage: string;
+  activateMember: string;
+  activateMemberAlertMessage: string;
+  addMemberToProducts: string;
+  deactivateAccountToastMessage: string;
+  deactivateMember: string;
+  deactivateMemberAlertMessage: string;
+  editMember: string;
+  inviteMessage: string;
+  memberAddedMessage: string;
+  members: string;
+  newHeading: string;
+  updatedMemberRole: string;
+};
+
+type SignUpTexts = {
+  email: string;
+  profile: string;
+  tryItFree: string;
+};
+
+type Environment = {
+  development: string;
+  staging: string;
+};
+
+// utils ------------------------------------------------
+
+// Utils: auth
+
+function verifySSOLoginPage(): Void;
+
+function logout(homeUrl: string): Void;
+
+// Utils: date
+
+function currentDate(): String;
+
+function futureDate(numberOfDays: number = 1): String;
+
+function pastDate(numberOfDays: number = 1): String;
+
+// Utils: common
+export function dataCy(dataCyId: string): String;
+
+export function setListCount(countSelector: string, alias: string): Void;
+
+export function verifyListCount(countSelector: string, count: number): String;
+
+export function getUrl(path: string): String;
+
+export function getTestTitle(): String;
+
+export function initializeCredentials(props: {
+  businessName: string;
+  currentUserName: string;
+  email: string;
+  firstName: string;
+  lastName: string;
+  domain: string;
+  subdomainName: string;
+  skipSetup: boolean;
+}): String;
+
+// Utils: organization
+
+export function createOrganization(props: {
+  baseUrl: string;
+  businessName: string;
+  email: string;
+  firstName: string;
+  lastName: string;
+  subdomainName: string;
+}): Void;
+
+// Utils: validation
+
+function verifyCrossSiteScript(
+  inputSelector: string,
+  submitSelector: string
+): Void;
+
+// Utils: members
+
+function addMemberViaRequest(props: {
+  email: string;
+  role: string;
+  requestCount: number;
+  appName: string;
+}): Void;
+
+function addMemberViaUI(email: string, role: string = "Agent"): Void;
+
+function activateMember(props: {
+  email: string;
+  skipSearchRequest: boolean;
+}): Void;
+
+function activateMemberViaRequest(email: string, requestCount: number): Void;
+
+function checkColumnCheckBox(fieldSelector: string): Void;
+
+function deactivateMember(props: {
+  email: string;
+  skipSearchRequest: boolean;
+}): Void;
+
+function deactivateMemberViaRequest(email: string, requestCount: number): Void;
+
+function editMember(props: {
+  email: string;
+  role: string;
+  skipSearchRequest: boolean;
+}): Void;
+
+function interceptMemberApi(alias: string, times: number = 1): Void;
+
+function navigateToMembersPage(waitForRequest: boolean = true): Void;
+
+function navigateToNewMemberPanel(waitForRequest: boolean = true): Void;
+
+function unCheckColumnCheckBox(fieldSelector: string): Void;
+
+function verifyActivatedMember(props: {
+  email: string;
+  skipFetchRequest: boolean;
+  skipSearchRequest: boolean;
+}): Void;
+
+function verifyActivateAlert(props: {
+  email: string;
+  skipSearchRequest: boolean;
+}): Void;
+
+function verifyDeactivatedMember(props: {
+  email: string;
+  skipFetchRequest: boolean;
+  skipSearchRequest: boolean;
+}): Void;
+
+function verifyMemberDetails(props: {
+  email: string;
+  role: string;
+  skipSearchRequest: boolean;
+}): Void;
+
+// exporting all utils
+
+export const authUtils = { verifySSOLoginPage, logout };
+export const dateUtils = { currentDate, futureDate, pastDate };
+export const memberUtils = {
+  addMemberViaRequest,
+  addMemberViaUI,
+  activateMember,
+  checkColumnCheckBox,
+  deactivateMember,
+  deactivateMemberViaRequest,
+  editMember,
+  interceptMemberApi,
+  navigateToMembersPage,
+  navigateToNewMemberPanel,
+  unCheckColumnCheckBox,
+  verifyActivatedMember,
+  verifyActivateAlert,
+  verifyDeactivatedMember,
+  verifyMemberDetails,
+};
+
+// exporting all selectors
+
+export declare const commonSelectors: CommonSelectors;
+export declare const memberSelectors: MemberSelectors;
+export declare const loginSelectors: LoginSelectors;
+export declare const profileSelectors: ProfileSelectors;
+export declare const signUpSelectors: SignUpSelectors;
+
+// exporting all texts
+
+export declare const commonTexts: CommonTexts;
+export declare const memberTexts: MemberText;
+export declare const signUpTexts: SignUpTexts;
+export declare const environment: Environment;
+export declare const isStagingEnv: Boolean;