import type { NavigationState, ParamListBase } from '@react-navigation/routers'; import * as React from 'react'; import { isValidElementType } from 'react-is'; import type { DefaultNavigatorOptions, EventMapBase, NavigationListBase, NavigatorScreenParams, NavigatorTypeBagBase, PathConfig, RouteConfigComponent, RouteConfigProps, RouteGroupConfig, } from './types'; import { useRoute } from './useRoute'; /** * Flatten a type to remove all type alias names, unions etc. * This will show a plain object when hovering over the type. */ type FlatType = { [K in keyof T]: T[K] } & {}; /** * keyof T doesn't work for union types. We can use distributive conditional types instead. * https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#distributive-conditional-types */ type KeysOf = T extends {} ? keyof T : never; /** * We get a union type when using keyof, but we want an intersection instead. * https://stackoverflow.com/a/50375286/1665026 */ type UnionToIntersection = (U extends any ? (k: U) => void : never) extends ( k: infer I ) => void ? I : never; type UnknownToUndefined = unknown extends T ? undefined : T; type ParamsForScreenComponent = T extends { screen: React.ComponentType<{ route: { params: infer P } }>; } ? P : T extends React.ComponentType<{ route: { params: infer P } }> ? P : undefined; type ParamsForScreen = T extends { screen: StaticNavigation } ? NavigatorScreenParams> | undefined : T extends StaticNavigation ? NavigatorScreenParams> | undefined : UnknownToUndefined>; type ParamListForScreens = { [Key in KeysOf]: ParamsForScreen; }; type ParamListForGroups< Groups extends | Readonly<{ [key: string]: { screens: StaticConfigScreens< ParamListBase, NavigationState, {}, EventMapBase, any >; }; }> | undefined, > = Groups extends { [key: string]: { screens: StaticConfigScreens< ParamListBase, NavigationState, {}, EventMapBase, any >; }; } ? ParamListForScreens> : {}; type StaticRouteConfig< ParamList extends ParamListBase, RouteName extends keyof ParamList, State extends NavigationState, ScreenOptions extends {}, EventMap extends EventMapBase, Navigation, > = RouteConfigProps< ParamList, RouteName, State, ScreenOptions, EventMap, Navigation > & RouteConfigComponent; export type StaticConfigScreens< ParamList extends ParamListBase, State extends NavigationState, ScreenOptions extends {}, EventMap extends EventMapBase, NavigationList extends NavigationListBase, > = { [RouteName in keyof ParamList]: | React.ComponentType | StaticNavigation | (Omit< StaticRouteConfig< ParamList, RouteName, State, ScreenOptions, EventMap, NavigationList[RouteName] >, 'name' | 'component' | 'getComponent' | 'children' > & { /** * Callback to determine whether the screen should be rendered or not. * This can be useful for conditional rendering of screens, * e.g. - if you want to render a different screen for logged in users. * * You can use a custom hook to use custom logic to determine the return value. * * @example * ```js * if: useIsLoggedIn * ``` */ if?: () => boolean; /** * Linking config for the screen. * This can be a string to specify the path, or an object with more options. * * @example * ```js * linking: { * path: 'profile/:id', * exact: true, * }, * ``` */ linking?: PathConfig | string; /** * Static navigation config or Component to render for the screen. */ screen: StaticNavigation | React.ComponentType; }); }; export type StaticConfigGroup< ParamList extends ParamListBase, State extends NavigationState, ScreenOptions extends {}, EventMap extends EventMapBase, NavigationList extends NavigationListBase, > = Omit< RouteGroupConfig, 'screens' | 'children' > & { /** * Callback to determine whether the screens in the group should be rendered or not. * This can be useful for conditional rendering of group of screens. */ if?: () => boolean; /** * Static navigation config or Component to render for the screen. */ screens: StaticConfigScreens< ParamList, State, ScreenOptions, EventMap, NavigationList >; }; export type StaticConfig = StaticConfigInternal< Bag['ParamList'], Bag['NavigatorID'], Bag['State'], Bag['ScreenOptions'], Bag['EventMap'], Bag['NavigationList'], Bag['Navigator'] >; type StaticConfigInternal< ParamList extends ParamListBase, NavigatorID extends string | undefined, State extends NavigationState, ScreenOptions extends {}, EventMap extends EventMapBase, NavigationList extends NavigationListBase, Navigator extends React.ComponentType, > = Omit< Omit< React.ComponentProps, keyof DefaultNavigatorOptions< ParamListBase, string | undefined, NavigationState, {}, EventMapBase, NavigationList[keyof ParamList] > > & DefaultNavigatorOptions< ParamList, NavigatorID, State, ScreenOptions, EventMap, NavigationList[keyof ParamList] >, 'screens' | 'children' > & ( | { /** * Screens to render in the navigator and their configuration. */ screens: StaticConfigScreens< ParamList, State, ScreenOptions, EventMap, NavigationList >; /** * Groups of screens to render in the navigator and their configuration. */ groups?: { [key: string]: StaticConfigGroup< ParamList, State, ScreenOptions, EventMap, NavigationList >; }; } | { /** * Screens to render in the navigator and their configuration. */ screens?: StaticConfigScreens< ParamList, State, ScreenOptions, EventMap, NavigationList >; /** * Groups of screens to render in the navigator and their configuration. */ groups: { [key: string]: StaticConfigGroup< ParamList, State, ScreenOptions, EventMap, NavigationList >; }; } ); /** * Props for a screen component which is rendered by a static navigator. * Takes the route params as a generic argument. */ export type StaticScreenProps | undefined> = { route: { params: T; }; }; /** * Infer the param list from the static navigation config. */ export type StaticParamList< T extends { readonly config: { readonly screens?: Record; readonly groups?: { [key: string]: { screens: Record; }; }; }; }, > = FlatType< ParamListForScreens & ParamListForGroups >; export type StaticNavigation = { Navigator: React.ComponentType; Group: React.ComponentType; Screen: React.ComponentType; config: StaticConfig; }; const MemoizedScreen = React.memo( >({ component }: { component: T }) => { const route = useRoute(); const children = React.createElement(component, { route }); return children; } ); MemoizedScreen.displayName = 'Memo(Screen)'; const getItemsFromScreens = ( Screen: React.ComponentType, screens: StaticConfigScreens ) => { return Object.entries(screens).map(([name, item]) => { let component: React.ComponentType | undefined; let props: {} = {}; let useIf: (() => boolean) | undefined; let isNavigator = false; if ('screen' in item) { const { screen, if: _if, ...rest } = item; useIf = _if; props = rest; if (isValidElementType(screen)) { component = screen; } else if ('config' in screen) { isNavigator = true; component = createComponentForStaticNavigation( screen, `${name}Navigator` ); } } else if (isValidElementType(item)) { component = item; } else if ('config' in item) { isNavigator = true; component = createComponentForStaticNavigation(item, `${name}Navigator`); } if (component == null) { throw new Error( `Couldn't find a 'screen' property for the screen '${name}'. This can happen if you passed 'undefined'. You likely forgot to export your component from the file it's defined in, or mixed up default import and named import when importing.` ); } const element = isNavigator ? ( React.createElement(component, {}) ) : ( ); return () => { const shouldRender = useIf == null || useIf(); if (!shouldRender) { return null; } return ( {() => element} ); }; }); }; /** * Create a component that renders a navigator based on the static configuration. * * @param tree Static navigation config. * @param displayName Name of the component to be displayed in React DevTools. * @returns A component which renders the navigator. */ export function createComponentForStaticNavigation( tree: StaticNavigation, displayName: string ): React.ComponentType<{}> { const { Navigator, Group, Screen, config } = tree; const { screens, groups, ...rest } = config; if (screens == null && groups == null) { throw new Error( "Couldn't find a 'screens' or 'groups' property. Make sure to define your screens under a 'screens' property in the configuration." ); } const items: (() => React.JSX.Element | null)[] = []; // Loop through the config to find screens and groups // So we add the screens and groups in the same order as they are defined for (const key in config) { if (key === 'screens' && screens) { items.push(...getItemsFromScreens(Screen, screens)); } if (key === 'groups' && groups) { items.push( ...Object.entries(groups).map(([key, { if: useIf, ...group }]) => { const groupItems = getItemsFromScreens(Screen, group.screens); return () => { // Call unconditionally since screen configs may contain `useIf` hooks const children = groupItems.map((item) => item()); const shouldRender = useIf == null || useIf(); if (!shouldRender) { return null; } return ( {children} ); }; }) ); } } const NavigatorComponent = () => { const children = items.map((item) => item()); return {children}; }; NavigatorComponent.displayName = displayName; return NavigatorComponent; } type TreeForPathConfig = { config: { initialRouteName?: string; screens?: StaticConfigScreens< ParamListBase, NavigationState, {}, EventMapBase, Record >; groups?: { [key: string]: { screens: StaticConfigScreens< ParamListBase, NavigationState, {}, EventMapBase, Record >; }; }; }; }; /** * Create a path config object from a static navigation config for deep linking. * * @param tree Static navigation config. * @param options Additional options from `linking.config`. * @param auto Whether to automatically generate paths for leaf screens. * @returns Path config object to use in linking config. * * @example * ```js * const config = { * screens: { * Home: { * screens: createPathConfigForStaticNavigation(HomeTabs), * }, * }, * }; * ``` */ export function createPathConfigForStaticNavigation( tree: TreeForPathConfig, options?: { initialRouteName?: string; }, auto?: boolean ) { let initialScreenHasPath: boolean = false; let initialScreenConfig: PathConfig | undefined; const createPathConfigForTree = ( t: TreeForPathConfig, o: { initialRouteName?: string } | undefined, // If a screen is a leaf node, but inside a screen with path, // It should not be used for initial detection skipInitialDetection: boolean ) => { const createPathConfigForScreens = ( screens: StaticConfigScreens< ParamListBase, NavigationState, {}, EventMapBase, Record >, initialRouteName: string | undefined ) => { return Object.fromEntries( Object.entries(screens) // Re-order to move the initial route to the front // This way we can detect the initial route correctly .sort(([a], [b]) => { if (a === initialRouteName) { return -1; } if (b === initialRouteName) { return 1; } return 0; }) .map(([key, item]) => { const screenConfig: PathConfig = {}; if ('linking' in item) { if (typeof item.linking === 'string') { screenConfig.path = item.linking; } else { Object.assign(screenConfig, item.linking); } if (typeof screenConfig.path === 'string') { screenConfig.path = screenConfig.path .replace(/^\//, '') // Remove extra leading slash .replace(/\/$/, ''); // Remove extra trailing slash } } let screens; const skipInitialDetectionInChild = skipInitialDetection || (screenConfig.path != null && screenConfig.path !== ''); if ('config' in item) { screens = createPathConfigForTree( item, undefined, skipInitialDetectionInChild ); } else if ( 'screen' in item && 'config' in item.screen && (item.screen.config.screens || item.screen.config.groups) ) { screens = createPathConfigForTree( item.screen, undefined, skipInitialDetectionInChild ); } if (screens) { screenConfig.screens = screens; } if ( auto && !screenConfig.screens && // Skip generating path for screens that specify linking config as `undefined` or `null` explicitly !('linking' in item && item.linking == null) ) { if (screenConfig.path != null) { if (!skipInitialDetection) { if (key === initialRouteName && screenConfig.path != null) { initialScreenHasPath = true; } else if (screenConfig.path === '') { // We encounter a leaf screen with empty path, // Clear the initial screen config as it's not needed anymore initialScreenConfig = undefined; } } } else { if (!skipInitialDetection && initialScreenConfig == null) { initialScreenConfig = screenConfig; } screenConfig.path = key .replace(/([A-Z]+)/g, '-$1') .replace(/^-/, '') .toLowerCase(); } } return [key, screenConfig] as const; }) .filter(([, screen]) => Object.keys(screen).length > 0) ); }; const screens = {}; // Loop through the config to find screens and groups // So we add the screens and groups in the same order as they are defined for (const key in t.config) { if (key === 'screens' && t.config.screens) { Object.assign( screens, createPathConfigForScreens( t.config.screens, o?.initialRouteName ?? t.config.initialRouteName ) ); } if (key === 'groups' && t.config.groups) { Object.entries(t.config.groups).forEach(([, group]) => { Object.assign( screens, createPathConfigForScreens( group.screens, o?.initialRouteName ?? t.config.initialRouteName ) ); }); } } if (Object.keys(screens).length === 0) { return undefined; } return screens; }; const screens = createPathConfigForTree(tree, options, false); if (auto && initialScreenConfig && !initialScreenHasPath) { initialScreenConfig.path = ''; } return screens; }