@react-navigation/core 8.0.0-alpha.26 → 8.0.0-alpha.28

package/src/useNavigationBuilder.tsx

@@ -19,7 +19,6 @@ import { ConsumedParamsContext } from './ConsumedParamsContext';
 import { deepFreeze } from './deepFreeze';
 import { Group } from './Group';
 import { isArrayEqual } from './isArrayEqual';
-import { isRecordEqual } from './isRecordEqual';
 import { NavigationBuilderContext } from './NavigationBuilderContext';
 import { NavigationHelpersContext } from './NavigationHelpersContext';
 import { NavigationMetaContext } from './NavigationMetaContext';
@@ -104,7 +103,7 @@ const getRouteConfigsFromChildren = <
   EventMap extends EventMapBase,
 >(
   children: React.ReactNode,
-  groupKey?: string,
+  groupKeys: string[] = [],
   groupOptions?: ScreenConfigWithParent<
     State,
     ScreenOptions,
@@ -147,7 +146,7 @@ const getRouteConfigsFromChildren = <
         }
 
         acc.push({
-          keys: [groupKey, child.props.navigationKey],
+          keys: [...groupKeys, child.props.navigationKey],
           options: groupOptions,
           layout: groupLayout,
           props: child.props as RouteConfig<
@@ -177,7 +176,9 @@ const getRouteConfigsFromChildren = <
         acc.push(
           ...getRouteConfigsFromChildren<State, ScreenOptions, EventMap>(
             child.props.children as React.ReactNode,
-            child.props.navigationKey,
+            child.props.navigationKey != null
+              ? [...groupKeys, child.props.navigationKey]
+              : groupKeys,
             // FIXME
             // @ts-expect-error: add validation
             child.type !== Group
@@ -285,10 +286,23 @@ const getRouteConfigsFromChildren = <
   return configs;
 };
 
-const getStateFromParams = (params: NavigatorRoute['params']) => {
+const getStateFromParams = (
+  params: NavigatorRoute['params'],
+  type: string
+): NavigationState | PartialState<NavigationState> | undefined => {
   const state = params?.state;
 
   if (isNavigationState(state)) {
+    if (state.type != null && state.type !== type) {
+      if (process.env.NODE_ENV !== 'production') {
+        console.error(
+          `The state passed in the params is for a navigator of type '${state.type}', but it was passed to a navigator of type '${type}'. This can happen if the state was meant for a different navigator. The state will be discarded.`
+        );
+      }
+
+      return undefined;
+    }
+
     return state;
   } else if (typeof params?.screen === 'string' && params?.initial !== false) {
     return {
@@ -337,7 +351,7 @@ export function useNavigationBuilder<
 
   const isNestedParamsConsumed =
     typeof route?.params === 'object' && route.params != null
-      ? consumedParams?.isConsumed(route.params)
+      ? consumedParams?.has(route.params)
       : false;
 
   const {
@@ -395,7 +409,7 @@ export function useNavigationBuilder<
     ScreenConfigWithParent<State, ScreenOptions, EventMap>
   > = {};
 
-  const routeKeyList: Record<string, React.Key | undefined> = {};
+  const routeKeyList: Record<string, (string | undefined)[]> = {};
   const routeParamList: Record<string, object | undefined> = {};
   const routeGetIdList: RouterConfigOptions['routeGetIdList'] = {};
 
@@ -409,7 +423,7 @@ export function useNavigationBuilder<
     }
 
     screens[name] = config;
-    routeKeyList[name] = config.keys.map((key) => key ?? '').join(':');
+    routeKeyList[name] = config.keys;
     routeParamList[name] = config.props.initialParams;
 
     Object.assign(routeGetIdList, { [name]: config.props.getId });
@@ -543,7 +557,7 @@ export function useNavigationBuilder<
     } else {
       const paramsForState = isNestedParamsConsumed ? undefined : route?.params;
       const stateFromParams = paramsForState
-        ? getStateFromParams(paramsForState)
+        ? getStateFromParams(paramsForState, router.type)
         : undefined;
 
       const stateBeforeInitialization = (stateFromParams ?? currentState) as
@@ -565,13 +579,21 @@ export function useNavigationBuilder<
 
       if (
         stateBeforeInitialization != null &&
+        isStateValid(stateBeforeInitialization) &&
         options.routeNamesChangeBehavior === 'lastUnhandled' &&
         doesStateHaveOnlyInvalidRoutes(stateBeforeInitialization)
       ) {
         return [stateBeforeInitialization, hydratedState, true, paramsForState];
       }
 
-      return [undefined, hydratedState, false, paramsForState];
+      return [
+        undefined,
+        hydratedState,
+        false,
+        // Current state is already initialized
+        // So params weren't used, and need to be handled later
+        isStateInitialized(currentState) ? undefined : paramsForState,
+      ];
     }
     // We explicitly don't include routeNames, route.params etc. in the dep list
     // below. We want to avoid forcing a new state to be calculated in those cases
@@ -589,6 +611,16 @@ export function useNavigationBuilder<
 
   const previousRouteKeyList = previousRouteKeyListRef.current;
 
+  // Names of the screens whose navigation key changed since the last render
+  const routeKeyChanges = Object.keys(routeKeyList).filter((name) => {
+    const current = routeKeyList[name];
+    const previous = previousRouteKeyList[name];
+
+    return (
+      current != null && previous != null && !isArrayEqual(current, previous)
+    );
+  });
+
   const [unhandledState, setUnhandledState] = React.useState<
     NavigationState | PartialState<NavigationState> | undefined
   >(stateBeforeInitialization);
@@ -616,10 +648,14 @@ export function useNavigationBuilder<
   let nextState: State = state;
   let shouldClearUnhandledState = false;
 
-  // Previously unhandled state is now valid again
-  // And current state no longer has any valid routes
-  // We should reuse the unhandled state instead of re-calculating the state
-  if (
+  if (unhandledState != null && !isStateValid(unhandledState)) {
+    // The stored unhandled state is for a different type of navigator
+    // It can't be used with this navigator, so we discard it
+    setUnhandledState(undefined);
+  } else if (
+    // Previously unhandled state is now valid again
+    // And current state no longer has any valid routes
+    // We should reuse the unhandled state instead of re-calculating the state
     unhandledState?.routes.every((r) => routeNames.includes(r.name)) &&
     state?.routes.every((r) => !routeNames.includes(r.name))
   ) {
@@ -634,18 +670,14 @@ export function useNavigationBuilder<
     );
   } else if (
     !isArrayEqual(state.routeNames, routeNames) ||
-    !isRecordEqual(routeKeyList, previousRouteKeyList)
+    routeKeyChanges.length !== 0
   ) {
     // When the list of route names change, the router should handle it to remove invalid routes
     nextState = router.getStateForRouteNamesChange(state, {
       routeNames,
       routeParamList,
       routeGetIdList,
-      routeKeyChanges: Object.keys(routeKeyList).filter(
-        (name) =>
-          name in previousRouteKeyList &&
-          routeKeyList[name] !== previousRouteKeyList[name]
-      ),
+      routeKeyChanges,
     });
   }
 
@@ -653,21 +685,24 @@ export function useNavigationBuilder<
 
   if (route?.params && !didConsumeNestedParams) {
     let action: CommonActions.Action | undefined;
-    const stateFromParams = route.params.state;
 
-    if (isNavigationState(stateFromParams) && !isNestedParamsConsumed) {
+    if (isNavigationState(route.params.state) && !isNestedParamsConsumed) {
       didConsumeNestedParams = true;
 
-      if (
-        options.routeNamesChangeBehavior === 'lastUnhandled' &&
-        doesStateHaveOnlyInvalidRoutes(stateFromParams)
-      ) {
-        if (stateFromParams !== unhandledState) {
-          setUnhandledState(stateFromParams);
+      const stateFromParams = getStateFromParams(route.params, router.type);
+
+      if (stateFromParams != null) {
+        if (
+          options.routeNamesChangeBehavior === 'lastUnhandled' &&
+          doesStateHaveOnlyInvalidRoutes(stateFromParams)
+        ) {
+          if (stateFromParams !== unhandledState) {
+            setUnhandledState(stateFromParams);
+          }
+        } else {
+          // If the route was updated with new state, we should reset to it
+          action = CommonActions.reset(stateFromParams);
         }
-      } else {
-        // If the route was updated with new state, we should reset to it
-        action = CommonActions.reset(stateFromParams);
       }
     } else if (
       typeof route.params.screen === 'string' &&
@@ -680,7 +715,7 @@ export function useNavigationBuilder<
         options.routeNamesChangeBehavior === 'lastUnhandled' &&
         !routeNames.includes(route.params.screen)
       ) {
-        const state = getStateFromParams(route.params);
+        const state = getStateFromParams(route.params, router.type);
 
         if (state != null && !deepEqual(state, unhandledState)) {
           setUnhandledState(state);
@@ -709,6 +744,18 @@ export function useNavigationBuilder<
         })
       : null;
 
+    if (
+      process.env.NODE_ENV !== 'production' &&
+      action != null &&
+      updatedState === null
+    ) {
+      const names = routeNames.map((name) => `'${name}'`).join(', ');
+
+      console.error(
+        `The 'state' or 'screen' passed in the params couldn't be applied to the navigator with the screens: ${names}. This can happen if the params contain names of screens that don't exist in the navigator. The navigation specified in the params will be ignored.`
+      );
+    }
+
     nextState =
       updatedState !== null
         ? router.getRehydratedState(updatedState, {
@@ -719,18 +766,16 @@ export function useNavigationBuilder<
         : nextState;
   }
 
-  const setConsumedParams = consumedParams?.setConsumed;
-
   React.useEffect(() => {
     if (
-      setConsumedParams &&
+      consumedParams &&
       didConsumeNestedParams &&
       typeof route?.params === 'object' &&
       route.params != null
     ) {
-      setConsumedParams(route.params);
+      consumedParams.set(route.params, true);
     }
-  }, [didConsumeNestedParams, route?.params, setConsumedParams]);
+  }, [consumedParams, didConsumeNestedParams, route?.params]);
 
   const shouldUpdate = state !== nextState;
 

package/src/useOnAction.tsx

@@ -1,16 +1,14 @@
 import type {
   NavigationAction,
-  NavigationRoute,
   NavigationState,
-  ParamListBase,
-  PartialRoute,
   PartialState,
   Router,
   RouterConfigOptions,
 } from '@react-navigation/routers';
 import * as React from 'react';
 
-import { getLoaderForState } from './DataLoading';
+import { ConsumedParamsContext } from './ConsumedParamsContext';
+import { getLoaderForStateChange } from './DataLoading';
 import {
   type ChildActionListener,
   type ChildBeforeRemoveListener,
@@ -32,40 +30,6 @@ type Options<State extends NavigationState> = {
   emitter: NavigationEventEmitter<EventMapCore<any>>;
 };
 
-type MaybePartialRoute =
-  | NavigationRoute<ParamListBase, string>
-  | PartialRoute<NavigationRoute<ParamListBase, string>>;
-
-const didFocusedRouteChange = (
-  currentState: NavigationState | PartialState<NavigationState>,
-  nextState: NavigationState | PartialState<NavigationState>
-) => {
-  let currentFocusedRoute: MaybePartialRoute | undefined =
-    currentState.routes[currentState.index ?? 0];
-
-  let nextFocusedRoute: MaybePartialRoute | undefined =
-    nextState.routes[nextState.index ?? 0];
-
-  let changed = currentFocusedRoute?.key !== nextFocusedRoute?.key;
-
-  while (
-    !changed &&
-    currentFocusedRoute?.state != null &&
-    nextFocusedRoute?.state != null &&
-    currentFocusedRoute.state !== nextFocusedRoute.state
-  ) {
-    currentFocusedRoute =
-      currentFocusedRoute.state.routes[currentFocusedRoute.state.index ?? 0];
-
-    nextFocusedRoute =
-      nextFocusedRoute.state.routes[nextFocusedRoute.state.index ?? 0];
-
-    changed = currentFocusedRoute?.key !== nextFocusedRoute?.key;
-  }
-
-  return changed;
-};
-
 /**
  * Hook to handle actions for a navigator, including state updates and bubbling.
  *
@@ -90,9 +54,11 @@ export function useOnAction<State extends NavigationState>({
     onRouteFocus: onRouteFocusParent,
     addListener: addListenerParent,
     onDispatchAction,
+    flushUpdates,
   } = React.use(NavigationBuilderContext);
 
   const tree = React.use(StaticTreeContext);
+  const consumedParams = React.use(ConsumedParamsContext);
 
   const routerConfigOptionsRef =
     React.useRef<RouterConfigOptions>(routerConfigOptions);
@@ -106,6 +72,11 @@ export function useOnAction<State extends NavigationState>({
       action: NavigationAction,
       visitedNavigators: Set<string> = new Set<string>()
     ) => {
+      // Apply any pending state updates scheduled during render before handling the action
+      // Otherwise the action will be handled with an outdated state,
+      // and the pending updates will overwrite the changes from the action
+      flushUpdates();
+
       const state = getState();
 
       // Since actions can bubble both up and down, they could come to the same navigator again
@@ -128,6 +99,17 @@ export function useOnAction<State extends NavigationState>({
         result =
           result === null && action.target === state.key ? state : result;
 
+        if (result !== null && result.stale !== false) {
+          // Some actions (e.g. `RESET`) may return a stale state from the router
+          // We rehydrate it before storing so the stored state is always usable
+          // Otherwise anything reading the state before the next render
+          // (e.g. another dispatch immediately after) would get an outdated state
+          result = router.getRehydratedState(
+            result,
+            routerConfigOptionsRef.current
+          );
+        }
+
         if (result !== null) {
           if (state !== result) {
             const isPrevented = shouldPreventRemove(
@@ -144,10 +126,22 @@ export function useOnAction<State extends NavigationState>({
               return true;
             }
 
+            if (getState() !== state) {
+              // Listeners for 'beforeRemove' may dispatch actions that change the state
+              // Then the result we have is outdated and would overwrite those changes
+              // So we handle the action again to calculate the result with the latest state
+              return onAction(action, new Set<string>());
+            }
+
             onDispatchAction(action, false);
 
-            if (tree && didFocusedRouteChange(state, result)) {
-              const loader = getLoaderForState(tree, result);
+            if (tree) {
+              const loader = getLoaderForStateChange(
+                tree,
+                result,
+                state,
+                consumedParams
+              );
 
               loader?.();
             }
@@ -194,7 +188,9 @@ export function useOnAction<State extends NavigationState>({
     [
       actionListeners,
       beforeRemoveListeners,
+      consumedParams,
       emitter,
+      flushUpdates,
       getState,
       key,
       onActionParent,

package/src/useOnPreventRemove.tsx

@@ -39,9 +39,10 @@ export const shouldPreventRemove = (
       .filter(([, route]) => route.key != null)
   );
 
-  const visitedRouteKeys: Set<string> =
-    // @ts-expect-error: add this property to mark that we've already emitted this action
-    action[VISITED_ROUTE_KEYS] ?? new Set<string>();
+  const visitedRouteKeys =
+    VISITED_ROUTE_KEYS in action && action[VISITED_ROUTE_KEYS] instanceof Set
+      ? action[VISITED_ROUTE_KEYS]
+      : new Set<string>();
 
   const beforeRemoveAction = {
     ...action,

package/src/useRouteCache.tsx

@@ -41,10 +41,7 @@ export function useRouteCache<State extends NavigationState>(
       // FIXME: since the state is updated with mutation, the route object cannot be frozen
       // As a workaround, loop through the object and make the properties readonly
       // Only needed once per proxy - skip if we're reusing a previously-frozen one
-      for (const key in proxy) {
-        // @ts-expect-error: this is fine since we are looping through the object
-        const value = proxy[key];
-
+      for (const [key, value] of Object.entries(proxy)) {
         Object.defineProperty(proxy, key, {
           enumerable: true,
           configurable: true,

package/src/useSyncState.tsx

@@ -26,9 +26,10 @@ const createStore = <T,>(getInitialState: () => T) => {
 
   const setState = (newState: T) => {
     state = deepFreeze(newState);
-    didUpdate = true;
 
-    if (!isBatching) {
+    if (isBatching) {
+      didUpdate = true;
+    } else {
       listeners.forEach((listener) => listener());
     }
   };

package/src/utilities.tsx

@@ -26,6 +26,25 @@ export type NoExcessObject<Provided, Allowed> = Record<
   never
 >;
 
+/**
+ * Check an object captured as a generic type against an allowed type,
+ * e.g. an object returned from a callback isn't checked for excess properties.
+ */
+export type NoExcessCallbackReturn<
+  Provided extends {},
+  Allowed extends {},
+> = Allowed & Provided & NoExcessObject<Provided, Allowed>;
+
+/**
+ * Apply excess property checking to a value,
+ * or to the return value if the value is a function.
+ */
+export type NoExcessValue<Provided, Allowed extends {}> = Provided extends (
+  ...args: never[]
+) => infer Return
+  ? (...args: never[]) => Allowed & NoExcessObject<Return, Allowed>
+  : NoExcessObject<Provided, Allowed>;
+
 /**
  * We get a union type when using keyof, but we want an intersection instead.
  * https://stackoverflow.com/a/50375286/1665026