diff --git a/src/components/HeaderWithBackButton/index.tsx b/src/components/HeaderWithBackButton/index.tsx index 199f6a268fe6..21fc96dcef71 100755 --- a/src/components/HeaderWithBackButton/index.tsx +++ b/src/components/HeaderWithBackButton/index.tsx @@ -103,6 +103,7 @@ function HeaderWithBackButton({ const middleContent = useMemo(() => { if (progressBarPercentage) { + const progressBarLabel = stepCounter ? `${translate('common.progressBarLabel')}, ${translate('stepCounter', stepCounter)}` : undefined; return ( <> {/* Reserves as much space for the middleContent as possible */} @@ -110,8 +111,17 @@ function HeaderWithBackButton({ {/* Uses absolute positioning so that it's always centered instead of being affected by the presence or absence of back/close buttons to the left/right of it */} - - + + diff --git a/src/hooks/useOnboardingStepCounter.ts b/src/hooks/useOnboardingStepCounter.ts new file mode 100644 index 000000000000..7858adb94fba --- /dev/null +++ b/src/hooks/useOnboardingStepCounter.ts @@ -0,0 +1,20 @@ +import {getOnboardingStepCounter} from '@libs/getOnboardingStepCounter'; +import type {OnboardingScreen, OnboardingStepResult} from '@libs/getOnboardingStepCounter'; +import ONYXKEYS from '@src/ONYXKEYS'; +import useOnyx from './useOnyx'; + +function useOnboardingStepCounter(page: OnboardingScreen): OnboardingStepResult | undefined { + const [onboarding] = useOnyx(ONYXKEYS.NVP_ONBOARDING); + const [purposeSelected] = useOnyx(ONYXKEYS.ONBOARDING_PURPOSE_SELECTED); + const [account] = useOnyx(ONYXKEYS.ACCOUNT); + + return getOnboardingStepCounter(page, { + signupQualifier: onboarding?.signupQualifier, + isFromPublicDomain: account?.isFromPublicDomain, + hasAccessibleDomainPolicies: account?.hasAccessibleDomainPolicies, + purposeSelected: purposeSelected ?? undefined, + isMergeAccountStepSkipped: onboarding?.isMergeAccountStepSkipped, + }); +} + +export default useOnboardingStepCounter; diff --git a/src/languages/de.ts b/src/languages/de.ts index b622da7e22e0..65aa2f6fa5a4 100644 --- a/src/languages/de.ts +++ b/src/languages/de.ts @@ -260,6 +260,7 @@ const translations: TranslationDeepObject = { conjunctionTo: 'bis', genericErrorMessage: 'Ups ... etwas ist schiefgelaufen und Ihre Anfrage konnte nicht abgeschlossen werden. Bitte versuchen Sie es später noch einmal.', percentage: 'Prozentsatz', + progressBarLabel: 'Onboarding-Fortschritt', converted: 'Umgewandelt', error: { invalidAmount: 'Ungültiger Betrag', diff --git a/src/languages/en.ts b/src/languages/en.ts index c75c38ebe405..94bfed8093e8 100644 --- a/src/languages/en.ts +++ b/src/languages/en.ts @@ -263,6 +263,7 @@ const translations = { conjunctionTo: 'to', genericErrorMessage: 'Oops... something went wrong and your request could not be completed. Please try again later.', percentage: 'Percentage', + progressBarLabel: 'Onboarding progress', converted: 'Converted', error: { invalidAmount: 'Invalid amount', diff --git a/src/languages/es.ts b/src/languages/es.ts index 9e390308d06f..fa655bb1efad 100644 --- a/src/languages/es.ts +++ b/src/languages/es.ts @@ -166,6 +166,7 @@ const translations: TranslationDeepObject = { conjunctionTo: 'a', genericErrorMessage: 'Ups... algo no ha ido bien y la acción no se ha podido completar. Por favor, inténtalo más tarde.', percentage: 'Porcentaje', + progressBarLabel: 'Progreso de incorporación', converted: 'Convertido', error: { invalidAmount: 'Importe no válido', diff --git a/src/languages/fr.ts b/src/languages/fr.ts index ea7ca3d26c7e..f789bf445287 100644 --- a/src/languages/fr.ts +++ b/src/languages/fr.ts @@ -260,6 +260,7 @@ const translations: TranslationDeepObject = { conjunctionTo: 'à', genericErrorMessage: 'Oups... une erreur s’est produite et votre requête n’a pas pu être effectuée. Veuillez réessayer plus tard.', percentage: 'Pourcentage', + progressBarLabel: "Progression de l'intégration", converted: 'Converti', error: { invalidAmount: 'Montant invalide', diff --git a/src/languages/it.ts b/src/languages/it.ts index e101563e73a4..f2ac94b01f67 100644 --- a/src/languages/it.ts +++ b/src/languages/it.ts @@ -260,6 +260,7 @@ const translations: TranslationDeepObject = { conjunctionTo: 'a', genericErrorMessage: 'Ops... qualcosa è andato storto e la tua richiesta non può essere completata. Riprova più tardi.', percentage: 'Percentuale', + progressBarLabel: 'Progresso onboarding', converted: 'Convertito', error: { invalidAmount: 'Importo non valido', diff --git a/src/languages/ja.ts b/src/languages/ja.ts index 33c0e0c85867..ba33be19699a 100644 --- a/src/languages/ja.ts +++ b/src/languages/ja.ts @@ -260,6 +260,7 @@ const translations: TranslationDeepObject = { conjunctionTo: '宛先', genericErrorMessage: 'おっと…問題が発生したため、リクエストを完了できませんでした。時間をおいてもう一度お試しください。', percentage: 'パーセンテージ', + progressBarLabel: 'オンボーディング進捗', converted: '変換済み', error: { invalidAmount: '金額が無効です', diff --git a/src/languages/nl.ts b/src/languages/nl.ts index afc5fcd8eb90..db94a906a6ca 100644 --- a/src/languages/nl.ts +++ b/src/languages/nl.ts @@ -260,6 +260,7 @@ const translations: TranslationDeepObject = { conjunctionTo: 'naar', genericErrorMessage: 'Oeps... er is iets misgegaan en je verzoek kon niet worden voltooid. Probeer het later opnieuw.', percentage: 'Percentage', + progressBarLabel: 'Voortgang onboarding', converted: 'Geconverteerd', error: { invalidAmount: 'Ongeldig bedrag', diff --git a/src/languages/pl.ts b/src/languages/pl.ts index f599403fbbfd..98711f2d2672 100644 --- a/src/languages/pl.ts +++ b/src/languages/pl.ts @@ -260,6 +260,7 @@ const translations: TranslationDeepObject = { conjunctionTo: 'do', genericErrorMessage: 'Ups... coś poszło nie tak i Twoje żądanie nie mogło zostać zrealizowane. Spróbuj ponownie później.', percentage: 'Procent', + progressBarLabel: 'Postęp wdrożenia', converted: 'Przekonwertowano', error: { invalidAmount: 'Nieprawidłowa kwota', diff --git a/src/languages/pt-BR.ts b/src/languages/pt-BR.ts index 37a71eca1c38..86079e8807b9 100644 --- a/src/languages/pt-BR.ts +++ b/src/languages/pt-BR.ts @@ -260,6 +260,7 @@ const translations: TranslationDeepObject = { conjunctionTo: 'para', genericErrorMessage: 'Ops... algo deu errado e sua solicitação não pôde ser concluída. Tente novamente mais tarde.', percentage: 'Porcentagem', + progressBarLabel: 'Progresso da integração', converted: 'Convertido', error: { invalidAmount: 'Valor inválido', diff --git a/src/languages/zh-hans.ts b/src/languages/zh-hans.ts index 8f83764a425e..c5d7ac606af5 100644 --- a/src/languages/zh-hans.ts +++ b/src/languages/zh-hans.ts @@ -260,6 +260,7 @@ const translations: TranslationDeepObject = { conjunctionTo: '至', genericErrorMessage: '哎呀……出现问题,无法完成您的请求。请稍后重试。', percentage: '百分比', + progressBarLabel: '入门进度', converted: '已转换', error: { invalidAmount: '金额无效', diff --git a/src/libs/getOnboardingStepCounter.ts b/src/libs/getOnboardingStepCounter.ts new file mode 100644 index 000000000000..eae621e09bd8 --- /dev/null +++ b/src/libs/getOnboardingStepCounter.ts @@ -0,0 +1,136 @@ +import type {ValueOf} from 'type-fest'; +import CONST from '@src/CONST'; +import type {StepCounterParams} from '@src/languages/params'; +import SCREENS from '@src/SCREENS'; + +type OnboardingScreen = ValueOf; + +type OnboardingFlowContext = { + signupQualifier?: ValueOf; + isFromPublicDomain?: boolean; + hasAccessibleDomainPolicies?: boolean; + purposeSelected?: ValueOf; + isMergeAccountStepSkipped?: boolean; +}; + +type OnboardingStepResult = { + stepCounter: StepCounterParams; + progressBarPercentage: number; +}; + +const {ONBOARDING} = SCREENS; +const {ONBOARDING_CHOICES, ONBOARDING_SIGNUP_QUALIFIERS} = CONST; + +const screenResolution: Record = { + [ONBOARDING.WORK_EMAIL]: ONBOARDING.WORK_EMAIL, + [ONBOARDING.WORK_EMAIL_VALIDATION]: ONBOARDING.WORK_EMAIL_VALIDATION, + [ONBOARDING.PRIVATE_DOMAIN]: ONBOARDING.PRIVATE_DOMAIN, + [ONBOARDING.PERSONAL_DETAILS]: ONBOARDING.PERSONAL_DETAILS, + [ONBOARDING.WORKSPACES]: ONBOARDING.WORKSPACES, + [ONBOARDING.PURPOSE]: ONBOARDING.PURPOSE, + [ONBOARDING.EMPLOYEES]: ONBOARDING.EMPLOYEES, + [ONBOARDING.ACCOUNTING]: ONBOARDING.ACCOUNTING, + [ONBOARDING.INTERESTED_FEATURES]: ONBOARDING.INTERESTED_FEATURES, + [ONBOARDING.WORKSPACE_OPTIONAL]: ONBOARDING.WORKSPACE_OPTIONAL, + [ONBOARDING.WORKSPACE_CONFIRMATION]: ONBOARDING.WORKSPACE_OPTIONAL, + [ONBOARDING.WORKSPACE_CURRENCY]: ONBOARDING.WORKSPACE_OPTIONAL, + [ONBOARDING.WORKSPACE_INVITE]: ONBOARDING.WORKSPACE_OPTIONAL, +}; + +// Screens that follow PURPOSE. For private domain users, PERSONAL_DETAILS is filtered out. +const purposeSuffixes = { + [ONBOARDING_CHOICES.MANAGE_TEAM]: [ONBOARDING.EMPLOYEES, ONBOARDING.ACCOUNTING, ONBOARDING.INTERESTED_FEATURES], + [ONBOARDING_CHOICES.PERSONAL_SPEND]: [ONBOARDING.PERSONAL_DETAILS, ONBOARDING.WORKSPACE_OPTIONAL], + [ONBOARDING_CHOICES.TRACK_WORKSPACE]: [ONBOARDING.PERSONAL_DETAILS, ONBOARDING.WORKSPACE_OPTIONAL], + [ONBOARDING_CHOICES.EMPLOYER]: [ONBOARDING.PERSONAL_DETAILS], + [ONBOARDING_CHOICES.CHAT_SPLIT]: [ONBOARDING.PERSONAL_DETAILS], + [ONBOARDING_CHOICES.LOOKING_AROUND]: [ONBOARDING.PERSONAL_DETAILS], + [ONBOARDING_CHOICES.ADMIN]: [ONBOARDING.PERSONAL_DETAILS], + [ONBOARDING_CHOICES.SUBMIT]: [ONBOARDING.PERSONAL_DETAILS], + [ONBOARDING_CHOICES.TEST_DRIVE_RECEIVER]: [ONBOARDING.PERSONAL_DETAILS], +} satisfies Record, OnboardingScreen[]>; + +// VSB/SMB have fixed suffixes; individual (null) is handled via purposeSuffixes. +const qualifierSuffixes = { + [ONBOARDING_SIGNUP_QUALIFIERS.VSB]: [ONBOARDING.ACCOUNTING, ONBOARDING.INTERESTED_FEATURES], + [ONBOARDING_SIGNUP_QUALIFIERS.SMB]: [ONBOARDING.EMPLOYEES, ONBOARDING.ACCOUNTING, ONBOARDING.INTERESTED_FEATURES], + [ONBOARDING_SIGNUP_QUALIFIERS.INDIVIDUAL]: null, +} satisfies Record, OnboardingScreen[] | null>; + +const maxSuffixLength = Math.max(...Object.values(purposeSuffixes).map((s) => s.length)); +const maxPrivateSuffixLength = Math.max(...Object.values(purposeSuffixes).map((s) => s.filter((p) => p !== ONBOARDING.PERSONAL_DETAILS).length)); + +function getResolvedPage(page: OnboardingScreen, context: OnboardingFlowContext): OnboardingScreen { + // In public domain flows, PRIVATE_DOMAIN is used as a variant of WORK_EMAIL_VALIDATION + if (page === ONBOARDING.PRIVATE_DOMAIN && context.isFromPublicDomain) { + return ONBOARDING.WORK_EMAIL_VALIDATION; + } + return screenResolution[page]; +} + +function getDomainPrefix(context: OnboardingFlowContext): OnboardingScreen[] { + if (context.isFromPublicDomain) { + if (context.isMergeAccountStepSkipped === false) { + return [ONBOARDING.WORK_EMAIL, ONBOARDING.WORK_EMAIL_VALIDATION, ONBOARDING.WORKSPACES]; + } + // User skipped the work email step — they never see WORK_EMAIL_VALIDATION + if (context.isMergeAccountStepSkipped === true) { + return [ONBOARDING.WORK_EMAIL]; + } + return [ONBOARDING.WORK_EMAIL, ONBOARDING.WORK_EMAIL_VALIDATION]; + } + if (context.hasAccessibleDomainPolicies) { + return [ONBOARDING.PERSONAL_DETAILS, ONBOARDING.PRIVATE_DOMAIN, ONBOARDING.WORKSPACES]; + } + return []; +} + +function getOnboardingFlow(context: OnboardingFlowContext): OnboardingScreen[] | undefined { + const prefix = getDomainPrefix(context); + const isPrivateDomain = !context.isFromPublicDomain && !!context.hasAccessibleDomainPolicies; + + const qualifierSuffix = context.signupQualifier ? qualifierSuffixes[context.signupQualifier] : null; + if (qualifierSuffix) { + return [...prefix, ...qualifierSuffix]; + } + + if (!context.purposeSelected) { + return undefined; + } + + const suffix = purposeSuffixes[context.purposeSelected]; + const adjustedSuffix = isPrivateDomain ? suffix.filter((s) => s !== ONBOARDING.PERSONAL_DETAILS) : suffix; + return [...prefix, ONBOARDING.PURPOSE, ...adjustedSuffix]; +} + +function getOnboardingStepCounter(page: OnboardingScreen, context: OnboardingFlowContext): OnboardingStepResult | undefined { + const resolvedPage = getResolvedPage(page, context); + const flow = getOnboardingFlow(context); + + if (!flow) { + const prefix = getDomainPrefix(context); + const knownScreens = [...prefix, ONBOARDING.PURPOSE]; + const index = knownScreens.indexOf(resolvedPage); + if (index === -1) { + return undefined; + } + const isPrivateDomain = !context.isFromPublicDomain && !!context.hasAccessibleDomainPolicies; + const maxFlowLength = prefix.length + 1 + (isPrivateDomain ? maxPrivateSuffixLength : maxSuffixLength); + return { + stepCounter: {step: index + 1}, + progressBarPercentage: Math.round(((index + 1) / maxFlowLength) * 100), + }; + } + + const index = flow.indexOf(resolvedPage); + if (index === -1) { + return undefined; + } + return { + stepCounter: {step: index + 1, total: flow.length}, + progressBarPercentage: Math.round(((index + 1) / flow.length) * 100), + }; +} + +export {getOnboardingFlow, getOnboardingStepCounter}; +export type {OnboardingFlowContext, OnboardingScreen, OnboardingStepResult}; diff --git a/src/pages/OnboardingAccounting/BaseOnboardingAccounting.tsx b/src/pages/OnboardingAccounting/BaseOnboardingAccounting.tsx index 4aab4f29d16c..410b2d01a907 100644 --- a/src/pages/OnboardingAccounting/BaseOnboardingAccounting.tsx +++ b/src/pages/OnboardingAccounting/BaseOnboardingAccounting.tsx @@ -13,6 +13,7 @@ import type {ListItem} from '@components/SelectionListWithSections/types'; import Text from '@components/Text'; import {useMemoizedLazyExpensifyIcons} from '@hooks/useLazyAsset'; import useLocalize from '@hooks/useLocalize'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; import useStyleUtils from '@hooks/useStyleUtils'; @@ -27,6 +28,7 @@ import CONST from '@src/CONST'; import type {TranslationPaths} from '@src/languages/types'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import type IconAsset from '@src/types/utils/IconAsset'; import type {BaseOnboardingAccountingProps} from './types'; @@ -107,6 +109,7 @@ function BaseOnboardingAccounting({shouldUseNativeStyles, route}: BaseOnboarding const [allPolicies] = useOnyx(ONYXKEYS.COLLECTION.POLICY); const [session] = useOnyx(ONYXKEYS.SESSION); const [onboardingUserReportedIntegration] = useOnyx(ONYXKEYS.ONBOARDING_USER_REPORTED_INTEGRATION); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.ACCOUNTING); const [userReportedIntegration, setUserReportedIntegration] = useState(onboardingUserReportedIntegration ?? undefined); const [error, setError] = useState(''); @@ -243,7 +246,8 @@ function BaseOnboardingAccounting({shouldUseNativeStyles, route}: BaseOnboarding > Navigation.goBack(ROUTES.ONBOARDING_EMPLOYEES.getRoute())} shouldDisplayHelpButton={false} /> diff --git a/src/pages/OnboardingEmployees/BaseOnboardingEmployees.tsx b/src/pages/OnboardingEmployees/BaseOnboardingEmployees.tsx index 028aadb0d8f7..0b2ab2e579f3 100644 --- a/src/pages/OnboardingEmployees/BaseOnboardingEmployees.tsx +++ b/src/pages/OnboardingEmployees/BaseOnboardingEmployees.tsx @@ -8,6 +8,7 @@ import RadioListItem from '@components/SelectionList/ListItem/RadioListItem'; import type {ListItem} from '@components/SelectionList/types'; import Text from '@components/Text'; import useLocalize from '@hooks/useLocalize'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; import useThemeStyles from '@hooks/useThemeStyles'; @@ -17,6 +18,7 @@ import {setOnboardingCompanySize} from '@userActions/Welcome'; import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import type {BaseOnboardingEmployeesProps} from './types'; type OnboardingListItem = ListItem & { @@ -26,9 +28,9 @@ function BaseOnboardingEmployees({shouldUseNativeStyles, route}: BaseOnboardingE const styles = useThemeStyles(); const {translate} = useLocalize(); const [onboardingCompanySize] = useOnyx(ONYXKEYS.ONBOARDING_COMPANY_SIZE); - const [onboardingPurposeSelected] = useOnyx(ONYXKEYS.ONBOARDING_PURPOSE_SELECTED); const {onboardingIsMediumOrLargerScreenWidth} = useResponsiveLayout(); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.EMPLOYEES); const [selectedCompanySize, setSelectedCompanySize] = useState(onboardingCompanySize); const [error, setError] = useState(''); @@ -80,7 +82,8 @@ function BaseOnboardingEmployees({shouldUseNativeStyles, route}: BaseOnboardingE > { Navigation.goBack(ROUTES.ONBOARDING_PURPOSE.getRoute()); }} diff --git a/src/pages/OnboardingInterestedFeatures/BaseOnboardingInterestedFeatures.tsx b/src/pages/OnboardingInterestedFeatures/BaseOnboardingInterestedFeatures.tsx index ce83035e1cb9..b12fe452f76b 100644 --- a/src/pages/OnboardingInterestedFeatures/BaseOnboardingInterestedFeatures.tsx +++ b/src/pages/OnboardingInterestedFeatures/BaseOnboardingInterestedFeatures.tsx @@ -18,6 +18,7 @@ import {useMemoizedLazyIllustrations} from '@hooks/useLazyAsset'; import useLocalize from '@hooks/useLocalize'; import useNetwork from '@hooks/useNetwork'; import useOnboardingMessages from '@hooks/useOnboardingMessages'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import usePermissions from '@hooks/usePermissions'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; @@ -33,6 +34,7 @@ import CONST from '@src/CONST'; import type {TranslationPaths} from '@src/languages/types'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import type {OnboardingRHPVariant} from '@src/types/onyx'; import type {BaseOnboardingInterestedFeaturesProps, Feature, SectionObject} from './types'; @@ -46,6 +48,7 @@ function BaseOnboardingInterestedFeatures({shouldUseNativeStyles}: BaseOnboardin // eslint-disable-next-line rulesdir/prefer-shouldUseNarrowLayout-instead-of-isSmallScreenWidth const {onboardingIsMediumOrLargerScreenWidth, isSmallScreenWidth} = useResponsiveLayout(); const [onboardingPurposeSelected] = useOnyx(ONYXKEYS.ONBOARDING_PURPOSE_SELECTED); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.INTERESTED_FEATURES); const [onboardingPolicyID] = useOnyx(ONYXKEYS.ONBOARDING_POLICY_ID); const currentUserPersonalDetails = useCurrentUserPersonalDetails(); const [allPolicies] = useOnyx(ONYXKEYS.COLLECTION.POLICY); @@ -385,7 +388,8 @@ function BaseOnboardingInterestedFeatures({shouldUseNativeStyles}: BaseOnboardin > Navigation.goBack(ROUTES.ONBOARDING_ACCOUNTING.getRoute())} shouldDisplayHelpButton={false} /> diff --git a/src/pages/OnboardingPersonalDetails/BaseOnboardingPersonalDetails.tsx b/src/pages/OnboardingPersonalDetails/BaseOnboardingPersonalDetails.tsx index baa2010f44b6..c88e5cd533ce 100644 --- a/src/pages/OnboardingPersonalDetails/BaseOnboardingPersonalDetails.tsx +++ b/src/pages/OnboardingPersonalDetails/BaseOnboardingPersonalDetails.tsx @@ -13,6 +13,7 @@ import useArchivedReportsIdSet from '@hooks/useArchivedReportsIdSet'; import useAutoFocusInput from '@hooks/useAutoFocusInput'; import useLocalize from '@hooks/useLocalize'; import useOnboardingMessages from '@hooks/useOnboardingMessages'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import usePermissions from '@hooks/usePermissions'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; @@ -30,6 +31,7 @@ import {setOnboardingAdminsChatReportID, setOnboardingErrorMessage, setOnboardin import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import INPUT_IDS from '@src/types/form/DisplayNameForm'; import type {BaseOnboardingPersonalDetailsProps} from './types'; @@ -60,6 +62,7 @@ function BaseOnboardingPersonalDetails({currentUserPersonalDetails, shouldUseNat const {inputCallbackRef} = useAutoFocusInput(); const [shouldValidateOnChange, setShouldValidateOnChange] = useState(false); const {isBetaEnabled} = usePermissions(); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.PERSONAL_DETAILS); const isPrivateDomainAndHasAccessiblePolicies = !account?.isFromPublicDomain && !!account?.hasAccessibleDomainPolicies; const isValidated = isCurrentUserValidated(loginList, session?.email); @@ -200,7 +203,8 @@ function BaseOnboardingPersonalDetails({currentUserPersonalDetails, shouldUseNat > { // Based on the `handleSubmit` function to reverse where to return if (isPrivateDomainAndHasAccessiblePolicies) { diff --git a/src/pages/OnboardingPrivateDomain/BaseOnboardingPrivateDomain.tsx b/src/pages/OnboardingPrivateDomain/BaseOnboardingPrivateDomain.tsx index 7ed861dcc56f..7a264ecb7038 100644 --- a/src/pages/OnboardingPrivateDomain/BaseOnboardingPrivateDomain.tsx +++ b/src/pages/OnboardingPrivateDomain/BaseOnboardingPrivateDomain.tsx @@ -6,6 +6,7 @@ import ScrollView from '@components/ScrollView'; import Text from '@components/Text'; import ValidateCodeForm from '@components/ValidateCodeActionModal/ValidateCodeForm'; import useLocalize from '@hooks/useLocalize'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; import useThemeStyles from '@hooks/useThemeStyles'; @@ -18,6 +19,7 @@ import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; import type {Route} from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import type {BaseOnboardingPrivateDomainProps} from './types'; function BaseOnboardingPrivateDomain({shouldUseNativeStyles, route}: BaseOnboardingPrivateDomainProps) { @@ -32,6 +34,7 @@ function BaseOnboardingPrivateDomain({shouldUseNativeStyles, route}: BaseOnboard const joinablePoliciesLength = Object.keys(joinablePolicies ?? {}).length; const {onboardingIsMediumOrLargerScreenWidth} = useResponsiveLayout(); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.PRIVATE_DOMAIN); const email = session?.email ?? ''; const domain = email.split('@').at(1) ?? ''; @@ -83,7 +86,8 @@ function BaseOnboardingPrivateDomain({shouldUseNativeStyles, route}: BaseOnboard > diff --git a/src/pages/OnboardingPurpose/BaseOnboardingPurpose.tsx b/src/pages/OnboardingPurpose/BaseOnboardingPurpose.tsx index c28a41296c79..7e020a21e90b 100644 --- a/src/pages/OnboardingPurpose/BaseOnboardingPurpose.tsx +++ b/src/pages/OnboardingPurpose/BaseOnboardingPurpose.tsx @@ -12,6 +12,7 @@ import Text from '@components/Text'; import {useMemoizedLazyIllustrations} from '@hooks/useLazyAsset'; import useLocalize from '@hooks/useLocalize'; import useOnboardingMessages from '@hooks/useOnboardingMessages'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; import useTheme from '@hooks/useTheme'; @@ -25,6 +26,7 @@ import {setOnboardingErrorMessage, setOnboardingPurposeSelected} from '@userActi import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import type {OnboardingPurpose} from '@src/types/onyx'; import getEmptyArray from '@src/types/utils/getEmptyArray'; import isLoadingOnyxValue from '@src/types/utils/isLoadingOnyxValue'; @@ -56,6 +58,7 @@ function BaseOnboardingPurpose({shouldUseNativeStyles, shouldEnableMaxHeight, ro [illustrations.Abacus, illustrations.Binoculars, illustrations.ReceiptUpload, illustrations.PiggyBank, illustrations.SplitBill], ); const {onboardingIsMediumOrLargerScreenWidth} = useResponsiveLayout(); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.PURPOSE); const [account] = useOnyx(ONYXKEYS.ACCOUNT); const {onboardingMessages} = useOnboardingMessages(); @@ -145,7 +148,8 @@ function BaseOnboardingPurpose({shouldUseNativeStyles, shouldEnableMaxHeight, ro diff --git a/src/pages/OnboardingWorkEmail/BaseOnboardingWorkEmail.tsx b/src/pages/OnboardingWorkEmail/BaseOnboardingWorkEmail.tsx index 7ab7216a90e1..836e0c98d987 100644 --- a/src/pages/OnboardingWorkEmail/BaseOnboardingWorkEmail.tsx +++ b/src/pages/OnboardingWorkEmail/BaseOnboardingWorkEmail.tsx @@ -18,6 +18,7 @@ import useAutoFocusInput from '@hooks/useAutoFocusInput'; import {useMemoizedLazyIllustrations} from '@hooks/useLazyAsset'; import useLocalize from '@hooks/useLocalize'; import useNetwork from '@hooks/useNetwork'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; import useThemeStyles from '@hooks/useThemeStyles'; @@ -32,6 +33,7 @@ import type {TranslationPaths} from '@src/languages/types'; import Log from '@src/libs/Log'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import INPUT_IDS from '@src/types/form/OnboardingWorkEmailForm'; import type IconAsset from '@src/types/utils/IconAsset'; import type {BaseOnboardingWorkEmailProps} from './types'; @@ -60,6 +62,7 @@ function BaseOnboardingWorkEmail({shouldUseNativeStyles}: BaseOnboardingWorkEmai const ICON_SIZE = 48; const operatingSystem = getOperatingSystem(); const isFocused = useIsFocused(); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.WORK_EMAIL); useEffect(() => { setOnboardingErrorMessage(null); @@ -151,7 +154,8 @@ function BaseOnboardingWorkEmail({shouldUseNativeStyles}: BaseOnboardingWorkEmai style={[styles.defaultModalContainer, shouldUseNativeStyles && styles.pt8]} > diff --git a/src/pages/OnboardingWorkEmailValidation/BaseOnboardingWorkEmailValidation.tsx b/src/pages/OnboardingWorkEmailValidation/BaseOnboardingWorkEmailValidation.tsx index 240a37eeaae8..ebfbc3929f19 100644 --- a/src/pages/OnboardingWorkEmailValidation/BaseOnboardingWorkEmailValidation.tsx +++ b/src/pages/OnboardingWorkEmailValidation/BaseOnboardingWorkEmailValidation.tsx @@ -7,6 +7,7 @@ import ScreenWrapper from '@components/ScreenWrapper'; import Text from '@components/Text'; import ValidateCodeForm from '@components/ValidateCodeActionModal/ValidateCodeForm'; import useLocalize from '@hooks/useLocalize'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; import useThemeStyles from '@hooks/useThemeStyles'; @@ -19,6 +20,7 @@ import {resendValidateCode} from '@userActions/User'; import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import type {BaseOnboardingWorkEmailValidationProps} from './types'; function BaseOnboardingWorkEmailValidation({shouldUseNativeStyles}: BaseOnboardingWorkEmailValidationProps) { @@ -37,6 +39,7 @@ function BaseOnboardingWorkEmailValidation({shouldUseNativeStyles}: BaseOnboardi const [onboardingErrorMessage] = useOnyx(ONYXKEYS.ONBOARDING_ERROR_MESSAGE_TRANSLATION_KEY); const isValidateCodeFormSubmitting = AccountUtils.isValidateCodeFormSubmitting(account); const isFocused = useIsFocused(); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.WORK_EMAIL_VALIDATION); useEffect(() => { if (onboardingValues?.isMergeAccountStepCompleted === undefined) { @@ -87,7 +90,8 @@ function BaseOnboardingWorkEmailValidation({shouldUseNativeStyles}: BaseOnboardi > { updateOnboardingValuesAndNavigation(onboardingValues); }} diff --git a/src/pages/OnboardingWorkspaceConfirmation/BaseOnboardingWorkspaceConfirmation.tsx b/src/pages/OnboardingWorkspaceConfirmation/BaseOnboardingWorkspaceConfirmation.tsx index 7131da9dbee7..798122fee708 100644 --- a/src/pages/OnboardingWorkspaceConfirmation/BaseOnboardingWorkspaceConfirmation.tsx +++ b/src/pages/OnboardingWorkspaceConfirmation/BaseOnboardingWorkspaceConfirmation.tsx @@ -12,6 +12,7 @@ import TextInput from '@components/TextInput'; import useAutoFocusInput from '@hooks/useAutoFocusInput'; import useCurrentUserPersonalDetails from '@hooks/useCurrentUserPersonalDetails'; import useLocalize from '@hooks/useLocalize'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; import useThemeStyles from '@hooks/useThemeStyles'; @@ -26,6 +27,7 @@ import {setOnboardingAdminsChatReportID, setOnboardingErrorMessage, setOnboardin import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import INPUT_IDS from '@src/types/form/WorkspaceConfirmationForm'; import isLoadingOnyxValue from '@src/types/utils/isLoadingOnyxValue'; import OnboardingCurrencyPicker from './OnboardingCurrencyPicker'; @@ -45,6 +47,7 @@ function BaseOnboardingWorkspaceConfirmation({shouldUseNativeStyles}: BaseOnboar const [isSelfTourViewed] = useOnyx(ONYXKEYS.NVP_ONBOARDING, {selector: hasSeenTourSelector}); const {inputCallbackRef} = useAutoFocusInput(); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.WORKSPACE_CONFIRMATION); const [draftValues, draftValuesMetadata] = useOnyx(ONYXKEYS.FORMS.ONBOARDING_WORKSPACE_DETAILS_FORM_DRAFT); const [session, sessionMetadata] = useOnyx(ONYXKEYS.SESSION); @@ -143,7 +146,8 @@ function BaseOnboardingWorkspaceConfirmation({shouldUseNativeStyles}: BaseOnboar style={[styles.defaultModalContainer, shouldUseNativeStyles && styles.pt8]} > diff --git a/src/pages/OnboardingWorkspaceInvite/BaseOnboardingWorkspaceInvite.tsx b/src/pages/OnboardingWorkspaceInvite/BaseOnboardingWorkspaceInvite.tsx index 4d868424c6fc..36d21d0b45a8 100644 --- a/src/pages/OnboardingWorkspaceInvite/BaseOnboardingWorkspaceInvite.tsx +++ b/src/pages/OnboardingWorkspaceInvite/BaseOnboardingWorkspaceInvite.tsx @@ -13,6 +13,7 @@ import useArchivedReportsIdSet from '@hooks/useArchivedReportsIdSet'; import useCurrentUserPersonalDetails from '@hooks/useCurrentUserPersonalDetails'; import useLocalize from '@hooks/useLocalize'; import useOnboardingMessages from '@hooks/useOnboardingMessages'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import usePermissions from '@hooks/usePermissions'; import usePolicy from '@hooks/usePolicy'; @@ -34,6 +35,7 @@ import {completeOnboarding as completeOnboardingReport} from '@userActions/Repor import {setOnboardingAdminsChatReportID, setOnboardingPolicyID} from '@userActions/Welcome'; import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; +import SCREENS from '@src/SCREENS'; import type {InvitedEmailsToAccountIDs} from '@src/types/onyx'; import type {BaseOnboardingWorkspaceInviteProps} from './types'; @@ -53,6 +55,7 @@ function BaseOnboardingWorkspaceInvite({shouldUseNativeStyles}: BaseOnboardingWo // We need to use isSmallScreenWidth, see navigateAfterOnboarding function comment // eslint-disable-next-line rulesdir/prefer-shouldUseNarrowLayout-instead-of-isSmallScreenWidth const {onboardingIsMediumOrLargerScreenWidth, isSmallScreenWidth} = useResponsiveLayout(); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.WORKSPACE_INVITE); const [didScreenTransitionEnd, setDidScreenTransitionEnd] = useState(false); const [isSearchingForReports] = useOnyx(ONYXKEYS.IS_SEARCHING_FOR_REPORTS, {initWithStoredValues: false}); const [countryCode = CONST.DEFAULT_COUNTRY_CODE] = useOnyx(ONYXKEYS.COUNTRY_CODE); @@ -232,7 +235,8 @@ function BaseOnboardingWorkspaceInvite({shouldUseNativeStyles}: BaseOnboardingWo onEntryTransitionEnd={() => setDidScreenTransitionEnd(true)} > diff --git a/src/pages/OnboardingWorkspaceOptional/BaseOnboardingWorkspaceOptional.tsx b/src/pages/OnboardingWorkspaceOptional/BaseOnboardingWorkspaceOptional.tsx index b4f4cad2b52b..0f96f198acdc 100644 --- a/src/pages/OnboardingWorkspaceOptional/BaseOnboardingWorkspaceOptional.tsx +++ b/src/pages/OnboardingWorkspaceOptional/BaseOnboardingWorkspaceOptional.tsx @@ -13,6 +13,7 @@ import useHasTeam2025Pricing from '@hooks/useHasTeam2025Pricing'; import {useMemoizedLazyIllustrations} from '@hooks/useLazyAsset'; import useLocalize from '@hooks/useLocalize'; import useOnboardingMessages from '@hooks/useOnboardingMessages'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import usePermissions from '@hooks/usePermissions'; import usePreferredCurrency from '@hooks/usePreferredCurrency'; @@ -31,6 +32,7 @@ import CONST from '@src/CONST'; import type {TranslationPaths} from '@src/languages/types'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import type {OnboardingPurpose} from '@src/types/onyx'; import type IconAsset from '@src/types/utils/IconAsset'; import type {BaseOnboardingWorkspaceOptionalProps} from './types'; @@ -57,6 +59,7 @@ function BaseOnboardingWorkspaceOptional({shouldUseNativeStyles}: BaseOnboarding const [activePolicyID] = useOnyx(ONYXKEYS.NVP_ACTIVE_POLICY_ID); const [isSelfTourViewed] = useOnyx(ONYXKEYS.NVP_ONBOARDING, {selector: hasSeenTourSelector}); const {isRestrictedPolicyCreation} = usePreferredPolicy(); + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.WORKSPACE_OPTIONAL); // When we merge public email with work email, we now want to navigate to the // concierge chat report of the new work email and not the last accessed report. const mergedAccountConciergeReportID = !onboardingValues?.shouldRedirectToClassicAfterMerge && onboardingValues?.shouldValidate ? conciergeChatReportID : undefined; @@ -202,7 +205,8 @@ function BaseOnboardingWorkspaceOptional({shouldUseNativeStyles}: BaseOnboarding style={[styles.defaultModalContainer, shouldUseNativeStyles && styles.pt8]} > diff --git a/src/pages/OnboardingWorkspaces/BaseOnboardingWorkspaces.tsx b/src/pages/OnboardingWorkspaces/BaseOnboardingWorkspaces.tsx index 4a816ba01091..958bd693f309 100644 --- a/src/pages/OnboardingWorkspaces/BaseOnboardingWorkspaces.tsx +++ b/src/pages/OnboardingWorkspaces/BaseOnboardingWorkspaces.tsx @@ -13,6 +13,7 @@ import {useMemoizedLazyExpensifyIcons} from '@hooks/useLazyAsset'; import useLocalize from '@hooks/useLocalize'; import useNetwork from '@hooks/useNetwork'; import useOnboardingMessages from '@hooks/useOnboardingMessages'; +import useOnboardingStepCounter from '@hooks/useOnboardingStepCounter'; import useOnyx from '@hooks/useOnyx'; import usePermissions from '@hooks/usePermissions'; import useResponsiveLayout from '@hooks/useResponsiveLayout'; @@ -28,6 +29,7 @@ import {setOnboardingAdminsChatReportID, setOnboardingPolicyID} from '@userActio import CONST from '@src/CONST'; import ONYXKEYS from '@src/ONYXKEYS'; import ROUTES from '@src/ROUTES'; +import SCREENS from '@src/SCREENS'; import type {JoinablePolicy} from '@src/types/onyx/JoinablePolicies'; import type {BaseOnboardingWorkspacesProps} from './types'; @@ -64,6 +66,7 @@ function BaseOnboardingWorkspaces({route, shouldUseNativeStyles}: BaseOnboarding const [onboardingValues] = useOnyx(ONYXKEYS.NVP_ONBOARDING); const isVsb = onboardingValues?.signupQualifier === CONST.ONBOARDING_SIGNUP_QUALIFIERS.VSB; const isSmb = onboardingValues?.signupQualifier === CONST.ONBOARDING_SIGNUP_QUALIFIERS.SMB; + const onboardingStep = useOnboardingStepCounter(SCREENS.ONBOARDING.WORKSPACES); const handleJoinWorkspace = (policy: JoinablePolicy) => { if (policy.automaticJoiningEnabled) { @@ -156,7 +159,8 @@ function BaseOnboardingWorkspaces({route, shouldUseNativeStyles}: BaseOnboarding > Navigation.goBack()} shouldDisplayHelpButton={false} /> diff --git a/src/styles/index.ts b/src/styles/index.ts index 5240a468d953..4615d19cba52 100644 --- a/src/styles/index.ts +++ b/src/styles/index.ts @@ -5010,7 +5010,7 @@ const staticStyles = (theme: ThemeColors) => headerProgressBarContainer: { position: 'absolute', width: '100%', - zIndex: -1, + pointerEvents: 'none', }, headerProgressBar: { diff --git a/tests/unit/getOnboardingStepCounterTest.ts b/tests/unit/getOnboardingStepCounterTest.ts new file mode 100644 index 000000000000..0c263793e090 --- /dev/null +++ b/tests/unit/getOnboardingStepCounterTest.ts @@ -0,0 +1,422 @@ +import CONST from '@src/CONST'; +import {getOnboardingFlow, getOnboardingStepCounter} from '@src/libs/getOnboardingStepCounter'; +import type {OnboardingFlowContext, OnboardingScreen} from '@src/libs/getOnboardingStepCounter'; +import SCREENS from '@src/SCREENS'; + +const O = SCREENS.ONBOARDING; +const {ONBOARDING_CHOICES, ONBOARDING_SIGNUP_QUALIFIERS} = CONST; + +describe('getOnboardingFlow', () => { + it('returns [ACCOUNTING, INTERESTED_FEATURES] for VSB without domain context', () => { + expect(getOnboardingFlow({signupQualifier: 'vsb'})).toEqual([O.ACCOUNTING, O.INTERESTED_FEATURES]); + }); + + it('returns [EMPLOYEES, ACCOUNTING, INTERESTED_FEATURES] for SMB without domain context', () => { + expect(getOnboardingFlow({signupQualifier: 'smb'})).toEqual([O.EMPLOYEES, O.ACCOUNTING, O.INTERESTED_FEATURES]); + }); + + it('returns [PURPOSE, EMPLOYEES, ACCOUNTING, INTERESTED_FEATURES] for individual + MANAGE_TEAM', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM})).toEqual([O.PURPOSE, O.EMPLOYEES, O.ACCOUNTING, O.INTERESTED_FEATURES]); + }); + + it('returns [PURPOSE, PERSONAL_DETAILS, WORKSPACE_OPTIONAL] for individual + PERSONAL_SPEND', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', purposeSelected: ONBOARDING_CHOICES.PERSONAL_SPEND})).toEqual([O.PURPOSE, O.PERSONAL_DETAILS, O.WORKSPACE_OPTIONAL]); + }); + + it('returns [PURPOSE, PERSONAL_DETAILS] for individual + EMPLOYER', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', purposeSelected: ONBOARDING_CHOICES.EMPLOYER})).toEqual([O.PURPOSE, O.PERSONAL_DETAILS]); + }); + + it('returns undefined for individual without purposeSelected', () => { + expect(getOnboardingFlow({signupQualifier: 'individual'})).toBeUndefined(); + }); + + it('returns [WORK_EMAIL, WORK_EMAIL_VALIDATION, ACCOUNTING, INTERESTED_FEATURES] for public + VSB', () => { + expect(getOnboardingFlow({signupQualifier: 'vsb', isFromPublicDomain: true})).toEqual([O.WORK_EMAIL, O.WORK_EMAIL_VALIDATION, O.ACCOUNTING, O.INTERESTED_FEATURES]); + }); + + it('returns [WORK_EMAIL, WORK_EMAIL_VALIDATION, EMPLOYEES, ACCOUNTING, INTERESTED_FEATURES] for public + SMB', () => { + expect(getOnboardingFlow({signupQualifier: 'smb', isFromPublicDomain: true})).toEqual([O.WORK_EMAIL, O.WORK_EMAIL_VALIDATION, O.EMPLOYEES, O.ACCOUNTING, O.INTERESTED_FEATURES]); + }); + + it('returns 6-step flow for public + individual + MANAGE_TEAM', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', isFromPublicDomain: true, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM})).toEqual([ + O.WORK_EMAIL, + O.WORK_EMAIL_VALIDATION, + O.PURPOSE, + O.EMPLOYEES, + O.ACCOUNTING, + O.INTERESTED_FEATURES, + ]); + }); + + it('returns 5-step flow for public + individual + PERSONAL_SPEND', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', isFromPublicDomain: true, purposeSelected: ONBOARDING_CHOICES.PERSONAL_SPEND})).toEqual([ + O.WORK_EMAIL, + O.WORK_EMAIL_VALIDATION, + O.PURPOSE, + O.PERSONAL_DETAILS, + O.WORKSPACE_OPTIONAL, + ]); + }); + + it('returns 4-step flow for public + individual + LOOKING_AROUND', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', isFromPublicDomain: true, purposeSelected: ONBOARDING_CHOICES.LOOKING_AROUND})).toEqual([ + O.WORK_EMAIL, + O.WORK_EMAIL_VALIDATION, + O.PURPOSE, + O.PERSONAL_DETAILS, + ]); + }); + + it('returns 5-step flow for public + merge + VSB', () => { + expect(getOnboardingFlow({signupQualifier: 'vsb', isFromPublicDomain: true, isMergeAccountStepSkipped: false})).toEqual([ + O.WORK_EMAIL, + O.WORK_EMAIL_VALIDATION, + O.WORKSPACES, + O.ACCOUNTING, + O.INTERESTED_FEATURES, + ]); + }); + + it('returns 7-step flow for public + merge + individual + MANAGE_TEAM', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: false, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM})).toEqual([ + O.WORK_EMAIL, + O.WORK_EMAIL_VALIDATION, + O.WORKSPACES, + O.PURPOSE, + O.EMPLOYEES, + O.ACCOUNTING, + O.INTERESTED_FEATURES, + ]); + }); + + it('returns 6-step flow for public + merge + individual + PERSONAL_SPEND', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: false, purposeSelected: ONBOARDING_CHOICES.PERSONAL_SPEND})).toEqual([ + O.WORK_EMAIL, + O.WORK_EMAIL_VALIDATION, + O.WORKSPACES, + O.PURPOSE, + O.PERSONAL_DETAILS, + O.WORKSPACE_OPTIONAL, + ]); + }); + + it('returns 4-step flow for public + skipped + individual + PERSONAL_SPEND', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: true, purposeSelected: ONBOARDING_CHOICES.PERSONAL_SPEND})).toEqual([ + O.WORK_EMAIL, + O.PURPOSE, + O.PERSONAL_DETAILS, + O.WORKSPACE_OPTIONAL, + ]); + }); + + it('returns 5-step flow for public + skipped + individual + MANAGE_TEAM', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: true, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM})).toEqual([ + O.WORK_EMAIL, + O.PURPOSE, + O.EMPLOYEES, + O.ACCOUNTING, + O.INTERESTED_FEATURES, + ]); + }); + + it('returns 5-step flow for private domain + VSB', () => { + expect(getOnboardingFlow({signupQualifier: 'vsb', hasAccessibleDomainPolicies: true})).toEqual([ + O.PERSONAL_DETAILS, + O.PRIVATE_DOMAIN, + O.WORKSPACES, + O.ACCOUNTING, + O.INTERESTED_FEATURES, + ]); + }); + + it('returns 6-step flow for private domain + SMB', () => { + expect(getOnboardingFlow({signupQualifier: 'smb', hasAccessibleDomainPolicies: true})).toEqual([ + O.PERSONAL_DETAILS, + O.PRIVATE_DOMAIN, + O.WORKSPACES, + O.EMPLOYEES, + O.ACCOUNTING, + O.INTERESTED_FEATURES, + ]); + }); + + it('returns 7-step flow for private domain + individual + MANAGE_TEAM', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', hasAccessibleDomainPolicies: true, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM})).toEqual([ + O.PERSONAL_DETAILS, + O.PRIVATE_DOMAIN, + O.WORKSPACES, + O.PURPOSE, + O.EMPLOYEES, + O.ACCOUNTING, + O.INTERESTED_FEATURES, + ]); + }); + + it('returns 5-step flow for private domain + individual + PERSONAL_SPEND', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', hasAccessibleDomainPolicies: true, purposeSelected: ONBOARDING_CHOICES.PERSONAL_SPEND})).toEqual([ + O.PERSONAL_DETAILS, + O.PRIVATE_DOMAIN, + O.WORKSPACES, + O.PURPOSE, + O.WORKSPACE_OPTIONAL, + ]); + }); + + it('returns 4-step flow for private domain + individual + EMPLOYER', () => { + expect(getOnboardingFlow({signupQualifier: 'individual', hasAccessibleDomainPolicies: true, purposeSelected: ONBOARDING_CHOICES.EMPLOYER})).toEqual([ + O.PERSONAL_DETAILS, + O.PRIVATE_DOMAIN, + O.WORKSPACES, + O.PURPOSE, + ]); + }); +}); + +describe('getOnboardingStepCounter', () => { + it('returns correct step/total/percentage for each page in VSB flow', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'vsb'}; + expect(getOnboardingStepCounter(O.ACCOUNTING, ctx)).toEqual({stepCounter: {step: 1, total: 2}, progressBarPercentage: 50}); + expect(getOnboardingStepCounter(O.INTERESTED_FEATURES, ctx)).toEqual({stepCounter: {step: 2, total: 2}, progressBarPercentage: 100}); + }); + + it('returns correct step/total/percentage for each page in SMB flow', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'smb'}; + expect(getOnboardingStepCounter(O.EMPLOYEES, ctx)).toEqual({stepCounter: {step: 1, total: 3}, progressBarPercentage: 33}); + expect(getOnboardingStepCounter(O.ACCOUNTING, ctx)).toEqual({stepCounter: {step: 2, total: 3}, progressBarPercentage: 67}); + expect(getOnboardingStepCounter(O.INTERESTED_FEATURES, ctx)).toEqual({stepCounter: {step: 3, total: 3}, progressBarPercentage: 100}); + }); + + it('returns correct step/total/percentage for individual + MANAGE_TEAM', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM}; + expect(getOnboardingStepCounter(O.PURPOSE, ctx)).toEqual({stepCounter: {step: 1, total: 4}, progressBarPercentage: 25}); + expect(getOnboardingStepCounter(O.EMPLOYEES, ctx)).toEqual({stepCounter: {step: 2, total: 4}, progressBarPercentage: 50}); + expect(getOnboardingStepCounter(O.ACCOUNTING, ctx)).toEqual({stepCounter: {step: 3, total: 4}, progressBarPercentage: 75}); + expect(getOnboardingStepCounter(O.INTERESTED_FEATURES, ctx)).toEqual({stepCounter: {step: 4, total: 4}, progressBarPercentage: 100}); + }); + + it('returns correct step/total/percentage for individual + PERSONAL_SPEND', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', purposeSelected: ONBOARDING_CHOICES.PERSONAL_SPEND}; + expect(getOnboardingStepCounter(O.PURPOSE, ctx)).toEqual({stepCounter: {step: 1, total: 3}, progressBarPercentage: 33}); + expect(getOnboardingStepCounter(O.PERSONAL_DETAILS, ctx)).toEqual({stepCounter: {step: 2, total: 3}, progressBarPercentage: 67}); + expect(getOnboardingStepCounter(O.WORKSPACE_OPTIONAL, ctx)).toEqual({stepCounter: {step: 3, total: 3}, progressBarPercentage: 100}); + }); + + it('returns correct step/total/percentage for individual + other purpose', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', purposeSelected: ONBOARDING_CHOICES.EMPLOYER}; + expect(getOnboardingStepCounter(O.PURPOSE, ctx)).toEqual({stepCounter: {step: 1, total: 2}, progressBarPercentage: 50}); + expect(getOnboardingStepCounter(O.PERSONAL_DETAILS, ctx)).toEqual({stepCounter: {step: 2, total: 2}, progressBarPercentage: 100}); + }); + + it('returns correct step/total/percentage for public + individual + MANAGE_TEAM', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', isFromPublicDomain: true, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM}; + expect(getOnboardingStepCounter(O.WORK_EMAIL, ctx)).toEqual({stepCounter: {step: 1, total: 6}, progressBarPercentage: 17}); + expect(getOnboardingStepCounter(O.WORK_EMAIL_VALIDATION, ctx)).toEqual({stepCounter: {step: 2, total: 6}, progressBarPercentage: 33}); + expect(getOnboardingStepCounter(O.PURPOSE, ctx)).toEqual({stepCounter: {step: 3, total: 6}, progressBarPercentage: 50}); + expect(getOnboardingStepCounter(O.EMPLOYEES, ctx)).toEqual({stepCounter: {step: 4, total: 6}, progressBarPercentage: 67}); + expect(getOnboardingStepCounter(O.ACCOUNTING, ctx)).toEqual({stepCounter: {step: 5, total: 6}, progressBarPercentage: 83}); + expect(getOnboardingStepCounter(O.INTERESTED_FEATURES, ctx)).toEqual({stepCounter: {step: 6, total: 6}, progressBarPercentage: 100}); + }); + + it('returns correct step/total/percentage for public + merge + individual + MANAGE_TEAM', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: false, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM}; + expect(getOnboardingStepCounter(O.WORK_EMAIL, ctx)).toEqual({stepCounter: {step: 1, total: 7}, progressBarPercentage: 14}); + expect(getOnboardingStepCounter(O.WORK_EMAIL_VALIDATION, ctx)).toEqual({stepCounter: {step: 2, total: 7}, progressBarPercentage: 29}); + expect(getOnboardingStepCounter(O.WORKSPACES, ctx)).toEqual({stepCounter: {step: 3, total: 7}, progressBarPercentage: 43}); + expect(getOnboardingStepCounter(O.PURPOSE, ctx)).toEqual({stepCounter: {step: 4, total: 7}, progressBarPercentage: 57}); + expect(getOnboardingStepCounter(O.EMPLOYEES, ctx)).toEqual({stepCounter: {step: 5, total: 7}, progressBarPercentage: 71}); + expect(getOnboardingStepCounter(O.ACCOUNTING, ctx)).toEqual({stepCounter: {step: 6, total: 7}, progressBarPercentage: 86}); + expect(getOnboardingStepCounter(O.INTERESTED_FEATURES, ctx)).toEqual({stepCounter: {step: 7, total: 7}, progressBarPercentage: 100}); + }); + + it('returns correct step/total/percentage for public + skipped + individual + MANAGE_TEAM (no gaps)', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: true, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM}; + expect(getOnboardingStepCounter(O.WORK_EMAIL, ctx)).toEqual({stepCounter: {step: 1, total: 5}, progressBarPercentage: 20}); + expect(getOnboardingStepCounter(O.PURPOSE, ctx)).toEqual({stepCounter: {step: 2, total: 5}, progressBarPercentage: 40}); + expect(getOnboardingStepCounter(O.EMPLOYEES, ctx)).toEqual({stepCounter: {step: 3, total: 5}, progressBarPercentage: 60}); + expect(getOnboardingStepCounter(O.ACCOUNTING, ctx)).toEqual({stepCounter: {step: 4, total: 5}, progressBarPercentage: 80}); + expect(getOnboardingStepCounter(O.INTERESTED_FEATURES, ctx)).toEqual({stepCounter: {step: 5, total: 5}, progressBarPercentage: 100}); + }); + + it('returns correct step/total/percentage for public + skipped + individual + PERSONAL_SPEND (no gaps)', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: true, purposeSelected: ONBOARDING_CHOICES.PERSONAL_SPEND}; + expect(getOnboardingStepCounter(O.WORK_EMAIL, ctx)).toEqual({stepCounter: {step: 1, total: 4}, progressBarPercentage: 25}); + expect(getOnboardingStepCounter(O.PURPOSE, ctx)).toEqual({stepCounter: {step: 2, total: 4}, progressBarPercentage: 50}); + expect(getOnboardingStepCounter(O.PERSONAL_DETAILS, ctx)).toEqual({stepCounter: {step: 3, total: 4}, progressBarPercentage: 75}); + expect(getOnboardingStepCounter(O.WORKSPACE_OPTIONAL, ctx)).toEqual({stepCounter: {step: 4, total: 4}, progressBarPercentage: 100}); + }); + + it('returns correct step/total/percentage for private domain + individual + MANAGE_TEAM (7-step flow)', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', hasAccessibleDomainPolicies: true, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM}; + expect(getOnboardingStepCounter(O.PERSONAL_DETAILS, ctx)).toEqual({stepCounter: {step: 1, total: 7}, progressBarPercentage: 14}); + expect(getOnboardingStepCounter(O.PRIVATE_DOMAIN, ctx)).toEqual({stepCounter: {step: 2, total: 7}, progressBarPercentage: 29}); + expect(getOnboardingStepCounter(O.WORKSPACES, ctx)).toEqual({stepCounter: {step: 3, total: 7}, progressBarPercentage: 43}); + expect(getOnboardingStepCounter(O.PURPOSE, ctx)).toEqual({stepCounter: {step: 4, total: 7}, progressBarPercentage: 57}); + expect(getOnboardingStepCounter(O.EMPLOYEES, ctx)).toEqual({stepCounter: {step: 5, total: 7}, progressBarPercentage: 71}); + expect(getOnboardingStepCounter(O.ACCOUNTING, ctx)).toEqual({stepCounter: {step: 6, total: 7}, progressBarPercentage: 86}); + expect(getOnboardingStepCounter(O.INTERESTED_FEATURES, ctx)).toEqual({stepCounter: {step: 7, total: 7}, progressBarPercentage: 100}); + }); + + describe('sub-page mappings', () => { + it.each([ + {label: 'WORKSPACE_CONFIRMATION', page: O.WORKSPACE_CONFIRMATION}, + {label: 'WORKSPACE_CURRENCY', page: O.WORKSPACE_CURRENCY}, + {label: 'WORKSPACE_INVITE', page: O.WORKSPACE_INVITE}, + ])('$label maps to the same step as WORKSPACE_OPTIONAL', ({page}) => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', purposeSelected: ONBOARDING_CHOICES.PERSONAL_SPEND}; + expect(getOnboardingStepCounter(page, ctx)).toEqual(getOnboardingStepCounter(O.WORKSPACE_OPTIONAL, ctx)); + }); + + it('PRIVATE_DOMAIN resolves to WORK_EMAIL_VALIDATION step in public domain flows', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: false, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM}; + expect(getOnboardingStepCounter(O.PRIVATE_DOMAIN, ctx)).toEqual(getOnboardingStepCounter(O.WORK_EMAIL_VALIDATION, ctx)); + }); + + it('PRIVATE_DOMAIN is its own step in private domain flows', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'vsb', hasAccessibleDomainPolicies: true}; + expect(getOnboardingStepCounter(O.PRIVATE_DOMAIN, ctx)).toBeDefined(); + expect(getOnboardingStepCounter(O.WORK_EMAIL_VALIDATION, ctx)).toBeUndefined(); + }); + }); + + describe('indeterminate flow (no purposeSelected)', () => { + const domainVariants: Array<{ + label: string; + ctx: OnboardingFlowContext; + expectedPurposeStep: number; + expectedPurposePct: number; + prefixPages: Array<{page: OnboardingScreen; step: number; pct: number}>; + }> = [ + { + label: 'no-domain', + ctx: {signupQualifier: 'individual'}, + expectedPurposeStep: 1, + expectedPurposePct: 25, + prefixPages: [], + }, + { + label: 'public', + ctx: {signupQualifier: 'individual', isFromPublicDomain: true}, + expectedPurposeStep: 3, + expectedPurposePct: 50, + prefixPages: [ + {page: O.WORK_EMAIL, step: 1, pct: 17}, + {page: O.WORK_EMAIL_VALIDATION, step: 2, pct: 33}, + ], + }, + { + label: 'public-skipped', + ctx: {signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: true}, + expectedPurposeStep: 2, + expectedPurposePct: 40, + prefixPages: [{page: O.WORK_EMAIL, step: 1, pct: 20}], + }, + { + label: 'public-merge', + ctx: {signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: false}, + expectedPurposeStep: 4, + expectedPurposePct: 57, + prefixPages: [ + {page: O.WORK_EMAIL, step: 1, pct: 14}, + {page: O.WORK_EMAIL_VALIDATION, step: 2, pct: 29}, + {page: O.WORKSPACES, step: 3, pct: 43}, + ], + }, + { + label: 'private', + ctx: {signupQualifier: 'individual', hasAccessibleDomainPolicies: true}, + expectedPurposeStep: 4, + expectedPurposePct: 57, + prefixPages: [ + {page: O.PERSONAL_DETAILS, step: 1, pct: 14}, + {page: O.PRIVATE_DOMAIN, step: 2, pct: 29}, + {page: O.WORKSPACES, step: 3, pct: 43}, + ], + }, + ]; + + it.each(domainVariants)('$label: PURPOSE returns step $expectedPurposeStep without total', ({ctx, expectedPurposeStep, expectedPurposePct}) => { + const result = getOnboardingStepCounter(O.PURPOSE, ctx); + expect(result).toEqual({stepCounter: {step: expectedPurposeStep}, progressBarPercentage: expectedPurposePct}); + }); + + it.each(domainVariants)('$label: prefix pages return correct steps without total', ({ctx, prefixPages}) => { + for (const {page, step, pct} of prefixPages) { + const result = getOnboardingStepCounter(page, ctx); + expect(result).toEqual({stepCounter: {step}, progressBarPercentage: pct}); + } + }); + + it('PRIVATE_DOMAIN resolves to WORK_EMAIL_VALIDATION step in indeterminate public merge flow', () => { + const ctx: OnboardingFlowContext = {signupQualifier: 'individual', isFromPublicDomain: true, isMergeAccountStepSkipped: false}; + expect(getOnboardingStepCounter(O.PRIVATE_DOMAIN, ctx)).toEqual(getOnboardingStepCounter(O.WORK_EMAIL_VALIDATION, ctx)); + }); + }); + + describe('indeterminate percentages never exceed the next page after purpose selection', () => { + const domainVariants: Array<{label: string; ctx: Partial}> = [ + {label: 'no-domain', ctx: {}}, + {label: 'public', ctx: {isFromPublicDomain: true}}, + {label: 'public-skipped', ctx: {isFromPublicDomain: true, isMergeAccountStepSkipped: true}}, + {label: 'public-merge', ctx: {isFromPublicDomain: true, isMergeAccountStepSkipped: false}}, + {label: 'private', ctx: {hasAccessibleDomainPolicies: true}}, + ]; + + it.each(domainVariants)('$label: PURPOSE indeterminate % ≤ min next-page % across all purposes', ({ctx}) => { + const indeterminateCtx: OnboardingFlowContext = {signupQualifier: 'individual', ...ctx}; + const purposeResult = getOnboardingStepCounter(O.PURPOSE, indeterminateCtx); + expect(purposeResult).toBeDefined(); + + for (const purpose of Object.values(ONBOARDING_CHOICES)) { + const flow = getOnboardingFlow({...indeterminateCtx, purposeSelected: purpose}); + if (!flow) { + continue; + } + const purposeIndex = flow.indexOf(O.PURPOSE); + if (purposeIndex === -1 || purposeIndex >= flow.length - 1) { + continue; + } + const nextPage = flow.at(purposeIndex + 1); + if (!nextPage) { + continue; + } + const nextResult = getOnboardingStepCounter(nextPage, {...indeterminateCtx, purposeSelected: purpose}); + expect(nextResult).toBeDefined(); + expect(nextResult?.progressBarPercentage).toBeGreaterThanOrEqual(purposeResult?.progressBarPercentage ?? 0); + } + }); + }); + + it('returns undefined for a page that is not in the flow', () => { + expect(getOnboardingStepCounter(O.PURPOSE, {signupQualifier: 'vsb'})).toBeUndefined(); + }); + + describe('every purpose/qualifier combination produces a defined flow', () => { + const domainVariants: OnboardingFlowContext[] = [ + {}, + {isFromPublicDomain: true}, + {isFromPublicDomain: true, isMergeAccountStepSkipped: true}, + {isFromPublicDomain: true, isMergeAccountStepSkipped: false}, + {hasAccessibleDomainPolicies: true}, + ]; + + it.each(Object.values(ONBOARDING_CHOICES))('individual + %s returns a defined flow across all domain variants', (purpose) => { + for (const domain of domainVariants) { + const flow = getOnboardingFlow({signupQualifier: 'individual', purposeSelected: purpose, ...domain}); + expect(flow).toBeDefined(); + expect(flow?.length).toBeGreaterThanOrEqual(1); + } + }); + + it.each(Object.values(ONBOARDING_SIGNUP_QUALIFIERS))('%s qualifier returns a defined flow across all domain variants', (qualifier) => { + for (const domain of domainVariants) { + if (qualifier === 'individual') { + expect(getOnboardingFlow({signupQualifier: qualifier, purposeSelected: ONBOARDING_CHOICES.MANAGE_TEAM, ...domain})).toBeDefined(); + } else { + expect(getOnboardingFlow({signupQualifier: qualifier, ...domain})).toBeDefined(); + } + } + }); + }); +});