Add navigation helpers

src/components/DeeplinkWrapper/index.website.tsx

@@ -1,9 +1,9 @@
 import {Str} from 'expensify-common';
 import {useEffect, useRef, useState} from 'react';
 import * as Browser from '@libs/Browser';
+import {shouldPreventDeeplinkPrompt} from '@libs/Navigation/helpers';
 import Navigation from '@libs/Navigation/Navigation';
 import navigationRef from '@libs/Navigation/navigationRef';
-import shouldPreventDeeplinkPrompt from '@libs/Navigation/shouldPreventDeeplinkPrompt';
 import * as App from '@userActions/App';
 import * as Link from '@userActions/Link';
 import * as Session from '@userActions/Session';

src/components/HTMLEngineProvider/HTMLRenderers/MentionReportRenderer/index.tsx

@@ -10,7 +10,7 @@ import Text from '@components/Text';
 import useCurrentReportID from '@hooks/useCurrentReportID';
 import useStyleUtils from '@hooks/useStyleUtils';
 import useThemeStyles from '@hooks/useThemeStyles';
-import isSearchTopmostFullScreenRoute from '@libs/Navigation/isSearchTopmostFullScreenRoute';
+import isSearchTopmostFullScreenRoute from '@libs/Navigation/helpers/isSearchTopmostFullScreenRoute';
 import Navigation from '@navigation/Navigation';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';

src/components/Lottie/index.tsx

@@ -9,7 +9,7 @@ import useAppState from '@hooks/useAppState';
 import useNetwork from '@hooks/useNetwork';
 import useThemeStyles from '@hooks/useThemeStyles';
 import * as Browser from '@libs/Browser';
-import isSideModalNavigator from '@libs/Navigation/isSideModalNavigator';
+import isSideModalNavigator from '@libs/Navigation/helpers/isSideModalNavigator';
 import CONST from '@src/CONST';
 import {useSplashScreenStateContext} from '@src/SplashScreenStateContext';
 

src/components/MoneyReportHeader.tsx

@@ -9,7 +9,7 @@ import useTheme from '@hooks/useTheme';
 import useThemeStyles from '@hooks/useThemeStyles';
 import {getCurrentUserAccountID} from '@libs/actions/Report';
 import * as CurrencyUtils from '@libs/CurrencyUtils';
-import isReportOpenInRHP from '@libs/Navigation/isReportOpenInRHP';
+import isReportOpenInRHP from '@libs/Navigation/helpers/isReportOpenInRHP';
 import Navigation, {navigationRef} from '@libs/Navigation/Navigation';
 import * as PolicyUtils from '@libs/PolicyUtils';
 import * as ReportActionsUtils from '@libs/ReportActionsUtils';

src/components/MoneyRequestHeader.tsx

@@ -7,7 +7,7 @@ import useLocalize from '@hooks/useLocalize';
 import useResponsiveLayout from '@hooks/useResponsiveLayout';
 import useTheme from '@hooks/useTheme';
 import useThemeStyles from '@hooks/useThemeStyles';
-import isReportOpenInRHP from '@libs/Navigation/isReportOpenInRHP';
+import isReportOpenInRHP from '@libs/Navigation/helpers/isReportOpenInRHP';
 import Navigation, {navigationRef} from '@libs/Navigation/Navigation';
 import * as PolicyUtils from '@libs/PolicyUtils';
 import * as ReportActionsUtils from '@libs/ReportActionsUtils';

src/components/PromotedActionsBar.tsx

@@ -5,7 +5,7 @@ import useTheme from '@hooks/useTheme';
 import useThemeStyles from '@hooks/useThemeStyles';
 import * as HeaderUtils from '@libs/HeaderUtils';
 import * as Localize from '@libs/Localize';
-import isSearchTopmostFullScreenRoute from '@libs/Navigation/isSearchTopmostFullScreenRoute';
+import isSearchTopmostFullScreenRoute from '@libs/Navigation/helpers/isSearchTopmostFullScreenRoute';
 import Navigation from '@libs/Navigation/Navigation';
 import * as ReportUtils from '@libs/ReportUtils';
 import * as ReportActions from '@userActions/Report';

src/components/Search/index.tsx

@@ -21,7 +21,7 @@ import * as SearchActions from '@libs/actions/Search';
 import * as DeviceCapabilities from '@libs/DeviceCapabilities';
 import Log from '@libs/Log';
 import memoize from '@libs/memoize';
-import isSearchTopmostFullScreenRoute from '@libs/Navigation/isSearchTopmostFullScreenRoute';
+import isSearchTopmostFullScreenRoute from '@libs/Navigation/helpers/isSearchTopmostFullScreenRoute';
 import * as ReportUtils from '@libs/ReportUtils';
 import * as SearchQueryUtils from '@libs/SearchQueryUtils';
 import * as SearchUIUtils from '@libs/SearchUIUtils';

src/libs/Navigation/AppNavigator/AuthScreens.tsx

@@ -24,9 +24,9 @@ import KeyboardShortcut from '@libs/KeyboardShortcut';
 import Log from '@libs/Log';
 import getCurrentUrl from '@libs/Navigation/currentUrl';
 import getOnboardingModalScreenOptions from '@libs/Navigation/getOnboardingModalScreenOptions';
+import {shouldOpenOnAdminRoom} from '@libs/Navigation/helpers';
 import SIDEBAR_TO_SPLIT from '@libs/Navigation/linkingConfig/RELATIONS/SIDEBAR_TO_SPLIT';
 import Navigation from '@libs/Navigation/Navigation';
-import shouldOpenOnAdminRoom from '@libs/Navigation/shouldOpenOnAdminRoom';
 import type {AuthScreensParamList} from '@libs/Navigation/types';
 import NetworkConnection from '@libs/NetworkConnection';
 import onyxSubscribe from '@libs/onyxSubscribe';

src/libs/Navigation/AppNavigator/Navigators/ReportsSplitNavigator.tsx

@@ -5,7 +5,7 @@ import usePermissions from '@hooks/usePermissions';
 import createSplitStackNavigator from '@libs/Navigation/AppNavigator/createSplitStackNavigator';
 import FreezeWrapper from '@libs/Navigation/AppNavigator/FreezeWrapper';
 import getCurrentUrl from '@libs/Navigation/currentUrl';
-import shouldOpenOnAdminRoom from '@libs/Navigation/shouldOpenOnAdminRoom';
+import shouldOpenOnAdminRoom from '@libs/Navigation/helpers/shouldOpenOnAdminRoom';
 import type {ReportsSplitNavigatorParamList} from '@libs/Navigation/types';
 import * as ReportUtils from '@libs/ReportUtils';
 import CONST from '@src/CONST';

src/libs/Navigation/AppNavigator/createCustomStackNavigator/CustomRouter.ts

@@ -3,7 +3,7 @@ import {findFocusedRoute, StackRouter} from '@react-navigation/native';
 import type {ParamListBase} from '@react-navigation/routers';
 import useActiveWorkspace from '@hooks/useActiveWorkspace';
 import * as Localize from '@libs/Localize';
-import isSideModalNavigator from '@libs/Navigation/isSideModalNavigator';
+import isSideModalNavigator from '@libs/Navigation/helpers/isSideModalNavigator';
 import {isOnboardingFlowName} from '@libs/NavigationUtils';
 import * as Welcome from '@userActions/Welcome';
 import CONST from '@src/CONST';
@@ -69,7 +69,7 @@ function CustomRouter(options: ResponsiveStackNavigatorRouterOptions) {
             }
 
             if (isDismissModalAction(action)) {
-                return GetStateForActionHandlers.handleDismissModalAction(state, action, configOptions, stackRouter);
+                return GetStateForActionHandlers.handleDismissModalAction(state, configOptions, stackRouter);
             }
 
             if (isPushAction(action)) {

src/libs/Navigation/AppNavigator/createCustomStackNavigator/GetStateForActionHandlers.ts

@@ -2,12 +2,12 @@ import type {CommonActions, RouterConfigOptions, StackActionType, StackNavigatio
 import {StackActions} from '@react-navigation/native';
 import type {ParamListBase, Router} from '@react-navigation/routers';
 import Log from '@libs/Log';
-import getPolicyIDFromState from '@libs/Navigation/getPolicyIDFromState';
+import getPolicyIDFromState from '@libs/Navigation/helpers/getPolicyIDFromState';
 import type {RootStackParamList, State} from '@libs/Navigation/types';
 import * as SearchQueryUtils from '@libs/SearchQueryUtils';
 import NAVIGATORS from '@src/NAVIGATORS';
 import SCREENS from '@src/SCREENS';
-import type {DismissModalActionType, PushActionType, SwitchPolicyIdActionType} from './types';
+import type {PushActionType, SwitchPolicyIdActionType} from './types';
 
 const MODAL_ROUTES_TO_DISMISS: string[] = [
     NAVIGATORS.WORKSPACE_SPLIT_NAVIGATOR,
@@ -137,7 +137,6 @@ function handlePushSearchPageAction(
 
 function handleDismissModalAction(
     state: StackNavigationState<ParamListBase>,
-    action: DismissModalActionType,
     configOptions: RouterConfigOptions,
     stackRouter: Router<StackNavigationState<ParamListBase>, CommonActions.Action | StackActionType>,
 ) {

src/libs/Navigation/AppNavigator/createSplitStackNavigator/SplitStackRouter.ts

@@ -2,7 +2,7 @@ import type {CommonActions, ParamListBase, PartialState, RouterConfigOptions, St
 import {StackActions, StackRouter} from '@react-navigation/native';
 import pick from 'lodash/pick';
 import getIsNarrowLayout from '@libs/getIsNarrowLayout';
-import getParamsFromRoute from '@libs/Navigation/linkingConfig/getParamsFromRoute';
+import {getParamsFromRoute} from '@libs/Navigation/helpers';
 import navigationRef from '@libs/Navigation/navigationRef';
 import SCREENS from '@src/SCREENS';
 import type {SplitStackNavigatorRouterOptions} from './types';

src/libs/Navigation/Navigation.ts

@@ -20,18 +20,20 @@ import ROUTES, {HYBRID_APP_ROUTES} from '@src/ROUTES';
 import SCREENS, {PROTECTED_SCREENS} from '@src/SCREENS';
 import type {Report} from '@src/types/onyx';
 import {isEmptyObject} from '@src/types/utils/EmptyObject';
-import originalCloseRHPFlow from './closeRHPFlow';
-import getPolicyIDFromState from './getPolicyIDFromState';
-import getStateFromPath from './getStateFromPath';
-import getTopmostReportParam from './getTopmostReportParam';
-import isReportOpenInRHP from './isReportOpenInRHP';
+import {
+    createSplitNavigator,
+    getPolicyIDFromState,
+    getStateFromPath,
+    getTopmostReportParam,
+    isReportOpenInRHP,
+    closeRHPFlow as originalCloseRHPFlow,
+    setNavigationActionToMicrotaskQueue,
+} from './helpers';
 import linkingConfig from './linkingConfig';
-import createSplitNavigator from './linkingConfig/createSplitNavigator';
 import RELATIONS from './linkingConfig/RELATIONS';
 import linkTo from './linkTo';
 import getMinimalAction from './linkTo/getMinimalAction';
 import navigationRef from './navigationRef';
-import setNavigationActionToMicrotaskQueue from './setNavigationActionToMicrotaskQueue';
 import type {NavigationPartialRoute, NavigationStateRoute, RootStackParamList, State} from './types';
 
 function getSidebarScreenParams(splitNavigatorRoute: NavigationStateRoute) {

src/libs/Navigation/NavigationRoot.tsx

@@ -22,9 +22,8 @@ import type {Route} from '@src/ROUTES';
 import ROUTES from '@src/ROUTES';
 import AppNavigator from './AppNavigator';
 import {cleanPreservedSplitNavigatorStates} from './AppNavigator/createSplitStackNavigator/usePreserveSplitNavigatorState';
+import {customGetPathFromState, getAdaptedStateFromPath} from './helpers';
 import linkingConfig from './linkingConfig';
-import customGetPathFromState from './linkingConfig/customGetPathFromState';
-import getAdaptedStateFromPath from './linkingConfig/getAdaptedStateFromPath';
 import Navigation, {navigationRef} from './Navigation';
 import setupCustomAndroidBackHandler from './setupCustomAndroidBackHandler';
 

src/libs/Navigation/closeRHPFlow.ts → src/libs/Navigation/helpers/closeRHPFlow.ts

@@ -1,8 +1,8 @@
 import type {NavigationContainerRef} from '@react-navigation/native';
 import {StackActions} from '@react-navigation/native';
 import Log from '@libs/Log';
+import type {RootStackParamList} from '@libs/Navigation/types';
 import NAVIGATORS from '@src/NAVIGATORS';
-import type {RootStackParamList} from './types';
 
 /**
  * Closes the last RHP flow, if there is only one, closes the entire RHP.

src/libs/Navigation/linkingConfig/createSplitNavigator.ts → src/libs/Navigation/helpers/createSplitNavigator.ts

@@ -1,6 +1,6 @@
 import type {NavigationState, PartialState} from '@react-navigation/native';
+import LHN_TO_SPLIT_NAVIGATOR_NAME from '@libs/Navigation/linkingConfig/RELATIONS/LHN_TO_SPLIT_NAVIGATOR_MAPPING';
 import type {NavigationPartialRoute, SplitNavigatorByLHN, SplitNavigatorLHNScreen, SplitNavigatorParamListType} from '@libs/Navigation/types';
-import LHN_TO_SPLIT_NAVIGATOR_NAME from './RELATIONS/LHN_TO_SPLIT_NAVIGATOR_MAPPING';
 
 type ExtractRouteType<T extends SplitNavigatorLHNScreen> = Extract<keyof SplitNavigatorParamListType[(typeof LHN_TO_SPLIT_NAVIGATOR_NAME)[T]], string>;
 
@@ -25,4 +25,5 @@ function createSplitNavigator<T extends SplitNavigatorLHNScreen>(
         params: splitNavigatorParams,
     };
 }
+
 export default createSplitNavigator;

src/libs/Navigation/extractPolicyIDFromQuery.ts → src/libs/Navigation/helpers/extractPolicyIDFromQuery.ts

@@ -1,5 +1,5 @@
+import type {NavigationPartialRoute} from '@libs/Navigation/types';
 import * as SearchQueryUtils from '@libs/SearchQueryUtils';
-import type {NavigationPartialRoute} from './types';
 
 function extractPolicyIDFromQuery(route?: NavigationPartialRoute<string>) {
     if (!route?.params) {

src/libs/Navigation/linkingConfig/getAdaptedStateFromPath.ts → src/libs/Navigation/helpers/getAdaptedStateFromPath.ts

@@ -2,18 +2,18 @@ import type {NavigationState, PartialState, Route} from '@react-navigation/nativ
 import {findFocusedRoute, getStateFromPath} from '@react-navigation/native';
 import pick from 'lodash/pick';
 import {isAnonymousUser} from '@libs/actions/Session';
+import config from '@libs/Navigation/linkingConfig/config';
+import RELATIONS from '@libs/Navigation/linkingConfig/RELATIONS';
 import type {NavigationPartialRoute, RootStackParamList} from '@libs/Navigation/types';
 import {isFullScreenName} from '@libs/NavigationUtils';
 import {extractPolicyIDFromPath, getPathWithoutPolicyID} from '@libs/PolicyUtils';
 import * as ReportConnection from '@libs/ReportConnection';
-import extractPolicyIDFromQuery from '@navigation/extractPolicyIDFromQuery';
 import NAVIGATORS from '@src/NAVIGATORS';
 import ONYXKEYS from '@src/ONYXKEYS';
 import SCREENS from '@src/SCREENS';
-import config from './config';
 import createSplitNavigator from './createSplitNavigator';
+import extractPolicyIDFromQuery from './extractPolicyIDFromQuery';
 import getParamsFromRoute from './getParamsFromRoute';
-import RELATIONS from './RELATIONS';
 import replacePathInNestedState from './replacePathInNestedState';
 
 type GetAdaptedStateReturnType = {

src/libs/Navigation/linkingConfig/getParamsFromRoute.ts → src/libs/Navigation/helpers/getParamsFromRoute.ts

@@ -1,5 +1,5 @@
+import {normalizedConfigs} from '@libs/Navigation/linkingConfig/config';
 import type {Screen} from '@src/SCREENS';
-import {normalizedConfigs} from './config';
 
 function getParamsFromRoute(screenName: string): string[] {
     const routeConfig = normalizedConfigs[screenName as Screen];

src/libs/Navigation/getPolicyIDFromState.ts → src/libs/Navigation/helpers/getPolicyIDFromState.ts

@@ -1,7 +1,7 @@
+import type {NavigationPartialRoute, RootStackParamList, State} from '@libs/Navigation/types';
 import NAVIGATORS from '@src/NAVIGATORS';
 import SCREENS from '@src/SCREENS';
 import extractPolicyIDFromQuery from './extractPolicyIDFromQuery';
-import type {NavigationPartialRoute, RootStackParamList, State} from './types';
 
 /**
  * returns policyID value if one exists in navigation state

src/libs/Navigation/getStateFromPath.ts → src/libs/Navigation/helpers/getStateFromPath.ts

@@ -1,7 +1,7 @@
 import type {NavigationState, PartialState} from '@react-navigation/native';
 import {getStateFromPath as RNGetStateFromPath} from '@react-navigation/native';
+import linkingConfig from '@libs/Navigation/linkingConfig';
 import type {Route} from '@src/ROUTES';
-import linkingConfig from './linkingConfig';
 
 /**
  * @param path - The path to parse

src/libs/Navigation/getTopmostReportParam.ts → src/libs/Navigation/helpers/getTopmostReportParam.ts

@@ -1,7 +1,7 @@
 import type {NavigationState, PartialState} from '@react-navigation/native';
+import type {RootStackParamList} from '@libs/Navigation/types';
 import NAVIGATORS from '@src/NAVIGATORS';
 import SCREENS from '@src/SCREENS';
-import type {RootStackParamList} from './types';
 
 // This function is in a separate file than Navigation.ts to avoid cyclic dependency.
 

src/libs/Navigation/helpers/index.ts

@@ -0,0 +1,21 @@
+export * from './createNormalizedConfigs';
+export {default as customGetPathFromState} from './customGetPathFromState';
+export {default as getOnboardingAdaptedState} from './getOnboardingAdaptedState';
+export {default as getParamsFromRoute} from './getParamsFromRoute';
+export {default as normalizePath} from './normalizePath';
+export {default as replacePathInNestedState} from './replacePathInNestedState';
+export {default as createNormalizedConfigs} from './createNormalizedConfigs';
+export {default as createSplitNavigator} from './createSplitNavigator';
+export {default as getAdaptedStateFromPath} from './getAdaptedStateFromPath';
+export {default as extractPolicyIDFromQuery} from './extractPolicyIDFromQuery';
+export {default as closeRHPFlow} from './closeRHPFlow';
+export {default as getPolicyIDFromState} from './getPolicyIDFromState';
+export {default as getStateFromPath} from './getStateFromPath';
+export {default as getTopmostReportParam} from './getTopmostReportParam';
+export {default as getTopmostRouteName} from './getTopmostRouteName';
+export {default as isReportOpenInRHP} from './isReportOpenInRHP';
+export {default as isSearchTopmostFullScreenRoute} from './isSearchTopmostFullScreenRoute';
+export {default as isSideModalNavigator} from './isSideModalNavigator';
+export {default as setNavigationActionToMicrotaskQueue} from './setNavigationActionToMicrotaskQueue';
+export {default as shouldOpenOnAdminRoom} from './shouldOpenOnAdminRoom';
+export {default as shouldPreventDeeplinkPrompt} from './shouldPreventDeeplinkPrompt';

src/libs/Navigation/isSearchTopmostFullScreenRoute.ts → src/libs/Navigation/helpers/isSearchTopmostFullScreenRoute.ts

@@ -1,7 +1,7 @@
+import {navigationRef} from '@libs/Navigation/Navigation';
+import type {RootStackParamList, State} from '@libs/Navigation/types';
 import {isFullScreenName} from '@libs/NavigationUtils';
 import SCREENS from '@src/SCREENS';
-import {navigationRef} from './Navigation';
-import type {RootStackParamList, State} from './types';
 
 const isSearchTopmostFullScreenRoute = (): boolean => {
     const rootState = navigationRef.getRootState() as State<RootStackParamList>;

src/libs/Navigation/shouldOpenOnAdminRoom.ts → src/libs/Navigation/helpers/shouldOpenOnAdminRoom.ts

@@ -1,4 +1,4 @@
-import getCurrentUrl from './currentUrl';
+import getCurrentUrl from '@libs/Navigation/currentUrl';
 
 export default function shouldOpenOnAdminRoom() {
     const url = getCurrentUrl();

src/libs/Navigation/linkTo/index.ts

@@ -1,11 +1,10 @@
 import {getActionFromState} from '@react-navigation/core';
 import type {NavigationContainerRef, NavigationState, PartialState, StackActionType} from '@react-navigation/native';
 import {findFocusedRoute, StackActions} from '@react-navigation/native';
-import {getMatchingFullScreenRoute, isFullScreenName} from '@libs/Navigation/linkingConfig/getAdaptedStateFromPath';
-import normalizePath from '@libs/Navigation/linkingConfig/normalizePath';
+import {getStateFromPath, normalizePath} from '@libs/Navigation/helpers';
+import {getMatchingFullScreenRoute, isFullScreenName} from '@libs/Navigation/helpers/getAdaptedStateFromPath';
 import {shallowCompare} from '@libs/ObjectUtils';
 import {extractPolicyIDFromPath, getPathWithoutPolicyID} from '@libs/PolicyUtils';
-import getStateFromPath from '@navigation/getStateFromPath';
 import linkingConfig from '@navigation/linkingConfig';
 import type {NavigationPartialRoute, ReportsSplitNavigatorParamList, RootStackParamList, StackNavigationAction} from '@navigation/types';
 import CONST from '@src/CONST';

src/libs/Navigation/linkingConfig/config.ts

@@ -1,11 +1,11 @@
 import type {LinkingOptions} from '@react-navigation/native';
+import {createNormalizedConfigs} from '@libs/Navigation/helpers';
+import type {RouteConfig} from '@libs/Navigation/helpers';
 import type {RootStackParamList} from '@navigation/types';
 import NAVIGATORS from '@src/NAVIGATORS';
 import ROUTES from '@src/ROUTES';
 import type {Screen} from '@src/SCREENS';
 import SCREENS from '@src/SCREENS';
-import type {RouteConfig} from './createNormalizedConfigs';
-import createNormalizedConfigs from './createNormalizedConfigs';
 
 // Moved to a separate file to avoid cyclic dependencies.
 const config: LinkingOptions<RootStackParamList>['config'] = {

src/libs/Navigation/linkingConfig/index.ts

@@ -1,9 +1,9 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import type {LinkingOptions} from '@react-navigation/native';
+import {customGetPathFromState} from '@libs/Navigation/helpers';
+import getAdaptedStateFromPath from '@libs/Navigation/helpers/getAdaptedStateFromPath';
 import type {RootStackParamList} from '@navigation/types';
 import config from './config';
-import customGetPathFromState from './customGetPathFromState';
-import getAdaptedStateFromPath from './getAdaptedStateFromPath';
 import prefixes from './prefixes';
 
 const linkingConfig: LinkingOptions<RootStackParamList> = {

src/libs/ReportActionComposeFocusManager.ts

@@ -2,8 +2,8 @@ import React from 'react';
 import type {MutableRefObject} from 'react';
 import type {TextInput} from 'react-native';
 import SCREENS from '@src/SCREENS';
-import getTopmostRouteName from './Navigation/getTopmostRouteName';
-import isReportOpenInRHP from './Navigation/isReportOpenInRHP';
+import getTopmostRouteName from './Navigation/helpers/getTopmostRouteName';
+import isReportOpenInRHP from './Navigation/helpers/isReportOpenInRHP';
 import navigationRef from './Navigation/navigationRef';
 
 type FocusCallback = (shouldFocusForNonBlurInputOnTapOutside?: boolean) => void;

src/libs/actions/IOU.ts

@@ -38,7 +38,7 @@ import GoogleTagManager from '@libs/GoogleTagManager';
 import * as IOUUtils from '@libs/IOUUtils';
 import * as LocalePhoneNumber from '@libs/LocalePhoneNumber';
 import * as Localize from '@libs/Localize';
-import isSearchTopmostFullScreenRoute from '@libs/Navigation/isSearchTopmostFullScreenRoute';
+import isSearchTopmostFullScreenRoute from '@libs/Navigation/helpers/isSearchTopmostFullScreenRoute';
 import Navigation from '@libs/Navigation/Navigation';
 import * as NextStepUtils from '@libs/NextStepUtils';
 import {rand64} from '@libs/NumberUtils';